Source Todoist: migrate to low-code New (#32690)

Co-authored-by: Marcos Marx <[email protected]>
Co-authored-by: marcosmarxm <[email protected]>

airbyte-integrations/connectors/source-todoist/README.md

@@ -1,67 +1,83 @@
 # Todoist Source
 
-This is the repository for the Todoist source connector, written in Python.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/todoist).
+This is the repository for the Todoist configuration based source connector.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/todoist).
 
 ## Local development
 
-### Prerequisites
-**To iterate on this connector, make sure to complete this prerequisites section.**
-
-#### Minimum Python version required `= 3.9.0`
-
-#### Build & Activate Virtual Environment and install dependencies
-From this connector directory, create a virtual environment:
-```
-python -m venv .venv
-```
-
-This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
-development environment of choice. To activate it from the terminal, run:
-```
-source .venv/bin/activate
-pip install -r requirements.txt
-pip install '.[tests]'
-```
-If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
-
-Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
-used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
-If this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything
-should work as you expect.
 
 #### Create credentials
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/todoist)
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/todoist)
 to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_todoist/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 `integration_tests/sample_config.json` for a sample config file.
 
 **If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source todoist test creds`
 and place them into `secrets/config.json`.
 
-### Locally running the connector
-```
-python main.py spec
-python main.py check --config secrets/config.json
-python main.py discover --config secrets/config.json
-python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
-```
-
 ### Locally running the connector docker image
 
+#### Use `airbyte-ci` to build your connector
+The Airbyte way of building this connector is to use our `airbyte-ci` tool.
+You can follow install instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).
+Then running the following command will build your connector:
 
-#### Build
-**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
 ```bash
-airbyte-ci connectors --name=source-todoist build
+airbyte-ci connectors --name source-todoist build
+```
+Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-todoist:dev`.
+
+##### Customizing our build process
+When contributing on our connector you might need to customize the build process to add a system dependency or set an env var.
+You can customize our build process by adding a `build_customization.py` module to your connector.
+This module should contain a `pre_connector_install` and `post_connector_install` async function that will mutate the base image and the connector container respectively.
+It will be imported at runtime by our build process and the functions will be called if they exist.
+
+Here is an example of a `build_customization.py` module:
+```python
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    # Feel free to check the dagger documentation for more information on the Container object and its methods.
+    # https://dagger-io.readthedocs.io/en/sdk-python-v0.6.4/
+    from dagger import Container
+
+
+async def pre_connector_install(base_image_container: Container) -> Container:
+    return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")
+
+async def post_connector_install(connector_container: Container) -> Container:
+    return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")
 ```
 
-An image will be built with the tag `airbyte/source-todoist:dev`.
+#### Build your own connector image
+This connector is built using our dynamic built process in `airbyte-ci`.
+The base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.
+The build logic is defined using [Dagger](https://dagger.io/) [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/pipelines/builds/python_connectors.py).
+It does not rely on a Dockerfile.
 
-**Via `docker build`:**
+If you would like to patch our connector and build your own a simple approach would be to:
+
+1. Create your own Dockerfile based on the latest version of the connector image.
+```Dockerfile
+FROM airbyte/source-todoist:latest
+
+COPY . ./airbyte/integration_code
+RUN pip install ./airbyte/integration_code
+
+# The entrypoint and default env vars are already set in the base image
+# ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
+# ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
+```
+Please use this as an example. This is not optimized.
+
+2. Build your image:
 ```bash
 docker build -t airbyte/source-todoist:dev .
-```
+# Running the spec command against your patched connector
+docker run airbyte/source-todoist:dev spec
 
 #### Run
 Then run any of the connector commands as follows:
@@ -71,16 +87,15 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-todoist:dev check --co
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-todoist:dev discover --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-todoist:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
 ```
-
 ## Testing
-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-todoist test
-```
 
-### Customizing acceptance Tests
+### Acceptance Tests
 Customize `acceptance-test-config.yml` file to configure 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.
+Please run acceptance tests via [airbyte-ci](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#connectors-test-command):
+```bash
+airbyte-ci connectors --name source-todoist test
+```
 
 ## Dependency Management
 All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.

airbyte-integrations/connectors/source-todoist/__init__.py

@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#

airbyte-integrations/connectors/source-todoist/acceptance-test-config.yml

@@ -1,7 +1,6 @@
-# See [Source Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/source-acceptance-tests-reference)
+# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference)
 # for more information about how to configure these tests
 connector_image: airbyte/source-todoist:dev
-test_strictness_level: low
 acceptance_tests:
   spec:
     tests:
@@ -22,7 +21,7 @@ acceptance_tests:
         empty_streams: []
   # TODO uncomment this block to specify that the tests should assert the connector outputs the records provided in the input file a file
   #        expect_records:
-  #          path: "integration_tests/expected_records.txt"
+  #          path: "integration_tests/expected_records.jsonl"
   #          extra_fields: no
   #          exact_order: no
   #          extra_records: yes
@@ -32,7 +31,8 @@ acceptance_tests:
   #    tests:
   #      - config_path: "secrets/config.json"
   #        configured_catalog_path: "integration_tests/configured_catalog.json"
-  #        future_state_path: "integration_tests/abnormal_state.json"
+  #        future_state:
+  #          future_state_path: "integration_tests/abnormal_state.json"
   full_refresh:
     tests:
       - config_path: "secrets/config.json"

airbyte-integrations/connectors/source-todoist/integration_tests/__init__.py

@@ -1,3 +1,3 @@
 #
-# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
 #

airbyte-integrations/connectors/source-todoist/integration_tests/abnormal_state.json

@@ -1,37 +1,5 @@
 {
-  "tasks": {
-    "id": false,
-    "project_id": 10,
-    "section_id": -10,
-    "content": 10,
-    "description": true,
-    "is_completed": "not so true",
-    "labels": [true, false],
-    "parent_id": -50,
-    "order": true,
-    "priority": "10",
-    "due": true,
-    "url": 50,
-    "comment_count": "10",
-    "created_at": { "when": true },
-    "creator_id": -1,
-    "assignee_id": 20,
-    "assigner_id": 50
-  },
-  "projects": {
-    "id": {
-      "number": "2203306141"
-    },
-    "name": 50,
-    "comment_count": false,
-    "order": "1",
-    "color": 100,
-    "is_shared": [false],
-    "is_favorite": "world",
-    "parent_id": 100,
-    "is_inbox_project": [true],
-    "is_team_inbox": "false",
-    "view_style": ["list"],
-    "url": ["https://todoist.com/showProject?id=2203306141"]
+  "todo-stream-name": {
+    "todo-field-name": "todo-abnormal-value"
   }
 }

airbyte-integrations/connectors/source-todoist/integration_tests/acceptance.py

@@ -11,4 +11,6 @@
 @pytest.fixture(scope="session", autouse=True)
 def connector_setup():
     """This fixture is a placeholder for external resources that acceptance test might require."""
+    # TODO: setup test dependencies if needed. otherwise remove the TODO comments
     yield
+    # TODO: clean up test dependencies

airbyte-integrations/connectors/source-todoist/integration_tests/configured_catalog.json

@@ -1,34 +1,22 @@
 {
   "streams": [
     {
-      "cursor_field": null,
-      "destination_sync_mode": "append",
-      "primary_key": null,
       "stream": {
-        "default_cursor_field": null,
-        "json_schema": {},
         "name": "tasks",
-        "namespace": null,
-        "source_defined_cursor": null,
-        "source_defined_primary_key": [["id"]],
+        "json_schema": {},
         "supported_sync_modes": ["full_refresh"]
       },
-      "sync_mode": "full_refresh"
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
     },
     {
-      "cursor_field": null,
-      "destination_sync_mode": "append",
-      "primary_key": null,
       "stream": {
-        "default_cursor_field": null,
-        "json_schema": {},
         "name": "projects",
-        "namespace": null,
-        "source_defined_cursor": null,
-        "source_defined_primary_key": [["id"]],
+        "json_schema": {},
         "supported_sync_modes": ["full_refresh"]
       },
-      "sync_mode": "full_refresh"
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
     }
   ]
 }

airbyte-integrations/connectors/source-todoist/integration_tests/invalid_config.json

@@ -1,3 +1,3 @@
 {
-  "token": "INVALID TOKEN"
+  "token": "INVALID_API_TOKEN"
 }

airbyte-integrations/connectors/source-todoist/integration_tests/sample_config.json

@@ -1,3 +1,3 @@
 {
-  "token": "VALID TOKEN"
+  "token": "API_TOKEN"
 }