✨Source MailerLite: Correct schemas, Migrate with poetry, Make Connec…

…tor Compatible with Builder (#38342)

Co-authored-by: Alexandre Girard <[email protected]>

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

@@ -1,78 +1,103 @@
 # Mailerlite Source
 
 This is the repository for the Mailerlite configuration based source connector.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/mailerlite).
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/mailerlite).
 
 ## Local development
 
-#### Create credentials
+### Prerequisites
 
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/mailerlite)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_mailerlite/spec.yaml` file.
+* Python (`^3.9`)
+* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
+
+
+
+### 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/mailerlite)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_mailerlite/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 mailerlite test creds`
-and place them into `secrets/config.json`.
 
-### Locally running the connector docker image
+### Locally running the connector
 
-#### Build
+```
+poetry run source-mailerlite spec
+poetry run source-mailerlite check --config secrets/config.json
+poetry run source-mailerlite discover --config secrets/config.json
+poetry run source-mailerlite read --config secrets/config.json --catalog integration_tests/configured_catalog.json
+```
 
-**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
+### Running tests
 
-```bash
-airbyte-ci connectors --name=source-mailerlite build
-```
+To run tests locally, from the connector directory run:
 
-An image will be built with the tag `airbyte/source-mailerlite:dev`.
+```
+poetry run pytest tests
+```
 
-**Via `docker build`:**
+### 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
-docker build -t airbyte/source-mailerlite:dev .
+airbyte-ci connectors --name=source-mailerlite build
 ```
 
-#### Run
+An image will be available on your host with the tag `airbyte/source-mailerlite:dev`.
 
-Then run any of the connector commands as follows:
 
+### Running as a docker container
+
+Then run any of the connector commands as follows:
 ```
 docker run --rm airbyte/source-mailerlite:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-mailerlite:dev check --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-mailerlite:dev discover --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-mailerlite:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
 ```
 
-## Testing
+### Running our 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-mailerlite test
 ```
 
 ### Customizing 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.
+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
+### 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.
-We split dependencies between two groups, dependencies that are:
+All of your dependencies should be managed via Poetry. 
+To add a new dependency, run:
+```bash
+poetry add <package-name>
+```
 
-- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
-- required for the testing need to go to `TEST_REQUIREMENTS` list
+Please commit the changes to `pyproject.toml` and `poetry.lock` files.
 
-### Publishing a new version of the connector
+## 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-mailerlite test`
-2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).
+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)): 
+    - 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 the connector documentation and its changelog is up to date (`docs/integrations/sources/mailerlite.md`).
+4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/mailerlite.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.
 7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
+8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

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

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

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

@@ -1,28 +1,31 @@
 # 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-mailerlite:dev
-tests:
+acceptance_tests:
   spec:
-    - spec_path: "source_mailerlite/spec.yaml"
+    tests:
+      - spec_path: "source_mailerlite/spec.yaml"
   connection:
-    - config_path: "secrets/config.json"
-      status: "succeed"
-    - config_path: "integration_tests/invalid_config.json"
-      status: "failed"
+    tests:
+      - config_path: "secrets/config.json"
+        status: "succeed"
+      - config_path: "integration_tests/invalid_config.json"
+        status: "failed"
   discovery:
-    - config_path: "secrets/config.json"
+    tests:
+      - config_path: "secrets/config.json"
+        backward_compatibility_tests_config:
+          disable_for_version: 0.1.0 # The forms_popup and forms_promotion has schema changes from strings to booleans
   basic_read:
-    - config_path: "secrets/config.json"
-      configured_catalog_path: "integration_tests/configured_catalog.json"
-      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.jsonl"
-  #        exact_order: no
-  # incremental: # TODO if your connector does not implement incremental sync, remove this block
-  #   - config_path: "secrets/config.json"
-  #     configured_catalog_path: "integration_tests/configured_catalog.json"
-  #     future_state_path: "integration_tests/abnormal_state.json"
+    tests:
+      - config_path: "secrets/config.json"
+        configured_catalog_path: "integration_tests/configured_catalog.json"
+        empty_streams:
+          - name: "campaigns"
+            bypass_reason: "No data in sandbox account"
   full_refresh:
-    - config_path: "secrets/config.json"
-      configured_catalog_path: "integration_tests/configured_catalog.json"
+    tests:
+      - config_path: "secrets/config.json"
+        configured_catalog_path: "integration_tests/configured_catalog.json"
+  incremental:
+    bypass_reason: "This connector does not implement incremental sync"

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

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

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

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

airbyte-integrations/connectors/source-mailerlite/main.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
 #
 
 from source_mailerlite.run import run

airbyte-integrations/connectors/source-mailerlite/metadata.yaml

@@ -1,13 +1,32 @@
 data:
+  allowedHosts:
+    hosts:
+      - connect.mailerlite.com
+  connectorBuildOptions:
+    # Please update to the latest version of the connector base image.
+    # https://hub.docker.com/r/airbyte/python-connector-base
+    # Please use the full address with sha256 hash to guarantee build reproducibility.
+    baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
   connectorSubtype: api
   connectorType: source
   definitionId: dc3b9003-2432-4e93-a7f4-4620b0f14674
-  dockerImageTag: 0.1.0
+  dockerImageTag: 1.0.0
   dockerRepository: airbyte/source-mailerlite
   githubIssueLabel: source-mailerlite
   icon: mailerlite.svg
   license: MIT
   name: MailerLite
+  releases:
+    breakingChanges:
+      1.0.0:
+        upgradeDeadline: "2024-06-30"
+        message:
+          "The version migrates the MailerLite connector to the be compatible with the connector builder.
+          Important:
+          The forms_popup stream schema from API has a breaking change to schema['properties']['settings']['properties']['schedule'],
+          field to contain booleans instead of strings,
+          The forms_promotion stream schema from API has a breaking change to schema['properties']['double_optin'], schema['properties']['settings']['properties']['schedule']
+          fields to contain booleans instead of strings"
   remoteRegistries:
     pypi:
       enabled: true
@@ -17,6 +36,7 @@ data:
       enabled: false
     oss:
       enabled: true
+  releaseDate: 2022-10-25
   releaseStage: alpha
   documentationUrl: https://docs.airbyte.com/integrations/sources/mailerlite
   tags: