✨Source Youtube Analytics - Migrate Python CDK to Low-code CDK to Manifest-only (#42838)

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com> Co-authored-by: Natik Gadzhi <natik@respawn.io> Co-authored-by: Christo Grabowski <108154848+ChristoGrab@users.noreply.github.com> Co-authored-by: darynaishchenko <darina.ishchenko17@gmail.com> Co-authored-by: Daryna Ishchenko <80129833+darynaishchenko@users.noreply.github.com>

Author: 5 people

airbyte-integrations/connectors/source-youtube-analytics/README.md

@@ -1,89 +1,64 @@
-# Youtube-Analytics source connector
+# Youtube analytics source connector
 
+This directory contains the manifest-only connector for `source-youtube-analytics`.
+This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.
 
-This is the repository for the Youtube-Analytics source connector, written in Python.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/youtube-analytics).
+For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/youtube-analytics).
 
 ## Local development
 
-### Prerequisites
-* Python (~=3.9)
-* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
+We recommend using the Connector Builder to edit this connector.
+Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
+Then select the connector's `manifest.yaml` file to load the connector into the Builder. You're now ready to make changes to the connector!
 
+If you prefer to develop locally, you can follow the instructions below.
 
-### Installing the connector
-From this connector directory, run:
-```bash
-poetry install --with dev
-```
-
-
-### Create credentials
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/youtube-analytics)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_youtube_analytics/spec.yaml` file.
-Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
-See `sample_files/sample_config.json` for a sample config file.
-
-
-### Locally running the connector
-```
-poetry run source-youtube-analytics spec
-poetry run source-youtube-analytics check --config secrets/config.json
-poetry run source-youtube-analytics discover --config secrets/config.json
-poetry run source-youtube-analytics read --config secrets/config.json --catalog sample_files/configured_catalog.json
-```
+### Building the docker image
 
-### Running unit tests
-To run unit tests locally, from the connector directory run:
-```
-poetry run pytest unit_tests
-```
+You can build any manifest-only connector with `airbyte-ci`:
 
-### Building the docker image
 1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
 2. Run the following command to build the docker image:
+
 ```bash
 airbyte-ci connectors --name=source-youtube-analytics build
 ```
 
 An image will be available on your host with the tag `airbyte/source-youtube-analytics:dev`.
 
+### Creating credentials
+
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/youtube-analytics)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` object in the connector's `manifest.yaml` file.
+Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
 
 ### Running as a docker container
-Then run any of the connector commands as follows:
-```
+
+Then run any of the standard source connector commands:
+
+```bash
 docker run --rm airbyte/source-youtube-analytics:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-youtube-analytics:dev check --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-youtube-analytics:dev discover --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-youtube-analytics:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
 ```
 
-### Running our CI test suite
+### Running the CI test suite
+
 You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
+
 ```bash
 airbyte-ci connectors --name=source-youtube-analytics test
 ```
 
-### Customizing acceptance Tests
-Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
-If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
-
-### Dependency Management
-All of your dependencies should be managed via Poetry. 
-To add a new dependency, run:
-```bash
-poetry add <package-name>
-```
+## Publishing a new version of the connector
 
-Please commit the changes to `pyproject.toml` and `poetry.lock` files.
+If you want to contribute changes to `source-youtube-analytics`, here's how you can do that:
 
-## Publishing a new version of the connector
-You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
-1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-youtube-analytics test`
-2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)): 
+1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
+2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-youtube-analytics test`
+3. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
  - bump the `dockerImageTag` value in in `metadata.yaml`
- - bump the `version` value in `pyproject.toml`
-3. Make sure the `metadata.yaml` content is up to date.
 4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/youtube-analytics.md`).
 5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
 6. Pat yourself on the back for being an awesome contributor.

airbyte-integrations/connectors/source-youtube-analytics/acceptance-test-config.yml

@@ -4,7 +4,7 @@ connector_image: airbyte/source-youtube-analytics:dev
 acceptance_tests:
  spec:
  tests:
- - spec_path: "source_youtube_analytics/spec.json"
+ - spec_path: "manifest.yaml"
  connection:
  tests:
  - config_path: "secrets/config.json"

airbyte-integrations/connectors/source-youtube-analytics/components.py

@@ -0,0 +1,112 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+import csv
+import io
+from dataclasses import dataclass
+from typing import Any, Callable, Generator, Mapping, MutableMapping, Optional, Union
+
+import requests
+
+from airbyte_cdk import Decoder
+from airbyte_cdk.sources.declarative.migrations.state_migration import StateMigration
+from airbyte_cdk.sources.declarative.requesters.http_requester import HttpRequester
+from airbyte_cdk.sources.types import StreamSlice, StreamState
+
+
+@dataclass
+class CustomDecoder(Decoder):
+ def is_stream_response(self) -> bool:
+ return False
+
+ def decode(self, response: requests.Response) -> Generator[MutableMapping[str, Any], None, None]:
+ fp = io.StringIO(response.text)
+ reader = csv.DictReader(fp)
+ for record in reader:
+ yield record
+
+
+@dataclass
+class JobRequester(HttpRequester):
+ """
+ Sends request to create a report job if it doesn't exist yet.
+ """
+
+ JOB_NAME = "Airbyte reporting job"
+
+ def send_request(
+ self,
+ stream_state: Optional[StreamState] = None,
+ stream_slice: Optional[StreamSlice] = None,
+ next_page_token: Optional[Mapping[str, Any]] = None,
+ path: Optional[str] = None,
+ request_headers: Optional[Mapping[str, Any]] = None,
+ request_params: Optional[Mapping[str, Any]] = None,
+ request_body_data: Optional[Union[Mapping[str, Any], str]] = None,
+ request_body_json: Optional[Mapping[str, Any]] = None,
+ log_formatter: Optional[Callable[[requests.Response], Any]] = None,
+ ) -> Optional[requests.Response]:
+ response = super().send_request(
+ stream_state,
+ stream_slice,
+ next_page_token,
+ path,
+ request_headers,
+ request_params,
+ request_body_data,
+ request_body_json,
+ log_formatter,
+ )
+
+ stream_job = [r for r in response.json()["jobs"] if r["reportTypeId"] == self._parameters["report_type_id"]]
+
+ if not stream_job:
+ self._http_client.send_request(
+ http_method="post",
+ url=self._get_url(
+ path=path,
+ stream_state=stream_state,
+ stream_slice=stream_slice,
+ next_page_token=next_page_token,
+ ),
+ request_kwargs={"stream": self.stream_response},
+ headers=self._request_headers(stream_state, stream_slice, next_page_token, request_headers),
+ json={"name": self.JOB_NAME, "reportTypeId": self._parameters["report_id"]},
+ dedupe_query_params=True,
+ log_formatter=log_formatter,
+ exit_on_rate_limit=self._exit_on_rate_limit,
+ )
+ response = super().send_request(
+ stream_state,
+ stream_slice,
+ next_page_token,
+ path,
+ request_headers,
+ request_params,
+ request_body_data,
+ request_body_json,
+ log_formatter,
+ )
+
+ return response
+
+
+class ReportsStateMigration(StateMigration):
+ def should_migrate(self, stream_state: Mapping[str, Any]) -> bool:
+ return stream_state.get("state") or stream_state.get("date")
+
+ def migrate(self, stream_state: Mapping[str, Any]) -> Mapping[str, Any]:
+ if stream_state.get("date"):
+ # old format state before migration to low code
+ cursor_value = str(stream_state["date"])
+ stream_state = {
+ "state": {"date": cursor_value},
+ "parent_state": {"report": {"state": {"date": cursor_value}, "lookback_window": 0}},
+ }
+ return stream_state
+
+ cursor_value = stream_state["state"]
+ cursor_value["date"] = str(cursor_value["date"])
+ stream_state["parent_state"]["report"]["state"] = cursor_value
+ stream_state["parent_state"]["report"]["lookback_window"] = 0
+ return stream_state