Merge pull request #1 from emmaling27/emma

Convex Destination Connector (internal review)

airbyte-config/init/src/main/resources/seed/destination_definitions.yaml

@@ -100,6 +100,13 @@
   documentationUrl: https://docs.airbyte.com/integrations/destinations/r2
   icon: cloudflare-r2.svg
   releaseStage: alpha
+- name: Convex
+  destinationDefinitionId: 3eb4d99c-11fa-4561-a259-fc88e0c2f8f4
+  dockerRepository: airbyte/destination-convex
+  dockerImageTag: dev
+  documentationUrl: https://docs.airbyte.io/integrations/sources/convex
+  icon: convex.svg
+  releaseStage: alpha
 - name: Databricks Lakehouse
   destinationDefinitionId: 072d5540-f236-4294-ba7c-ade8fd918496
   dockerRepository: airbyte/destination-databricks

airbyte-config/init/src/main/resources/seed/destination_specs.yaml

@@ -1575,6 +1575,34 @@
     supported_destination_sync_modes:
     - "overwrite"
     - "append"
+- dockerImage: "airbyte/destination-convex:dev"
+  spec:
+    connectionSpecification:
+      $schema: "http://json-schema.org/draft-07/schema#"
+      title: "Convex"
+      type: "object"
+      required:
+      - "deployment_url"
+      - "access_key"
+      properties:
+        deployment_url:
+          type: "string"
+          title: "Deployment Url"
+          examples:
+          - "https://murky-swan-635.convex.cloud"
+          - "https://cluttered-owl-337.convex.cloud"
+        access_key:
+          type: "string"
+          title: "Access Key"
+          description: "API access key used to retrieve data from Convex."
+          airbyte_secret: true
+    supportsIncremental: true
+    supportsNormalization: false
+    supportsDBT: false
+    supported_destination_sync_modes:
+    - "overwrite"
+    - "append"
+    - "append_dedup"
 - dockerImage: "airbyte/destination-databricks:0.3.1"
   spec:
     documentationUrl: "https://docs.airbyte.com/integrations/destinations/databricks"

airbyte-integrations/connectors/destination-convex/.dockerignore

@@ -0,0 +1,5 @@
+*
+!Dockerfile
+!main.py
+!destination_convex
+!setup.py

airbyte-integrations/connectors/destination-convex/Dockerfile

@@ -0,0 +1,38 @@
+FROM python:3.9.11-alpine3.15 as base
+
+# build and load all requirements
+FROM base as builder
+WORKDIR /airbyte/integration_code
+
+# upgrade pip to the latest version
+RUN apk --no-cache upgrade \
+    && pip install --upgrade pip \
+    && apk --no-cache add tzdata build-base
+
+
+COPY setup.py ./
+# install necessary packages to a temporary folder
+RUN pip install --prefix=/install .
+
+# build a clean environment
+FROM base
+WORKDIR /airbyte/integration_code
+
+# copy all loaded and built libraries to a pure basic image
+COPY --from=builder /install /usr/local
+# add default timezone settings
+COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime
+RUN echo "Etc/UTC" > /etc/timezone
+
+# bash is installed for more convenient debugging.
+RUN apk --no-cache add bash
+
+# copy payload code only
+COPY main.py ./
+COPY destination_convex ./destination_convex
+
+ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
+ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
+
+LABEL io.airbyte.version=0.1.0
+LABEL io.airbyte.name=airbyte/destination-convex

airbyte-integrations/connectors/destination-convex/README.md

@@ -0,0 +1,157 @@
+# Convex Destination
+
+This is the repository for the Convex destination connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/destinations/convex).
+
+## Local development
+
+### Prerequisites
+
+**To iterate on this connector, make sure to complete this prerequisites section.**
+
+#### Minimum Python version required `= 3.7.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
+```
+
+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.
+
+#### Building via Gradle
+
+From the Airbyte repository root, run:
+
+```
+./gradlew :airbyte-integrations:connectors:destination-convex:build
+```
+
+#### Create credentials
+
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/destinations/convex)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `destination_convex/spec.json` file.
+Note that the `secrets` directory is gitignored by default, 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 `destination convex 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 write --config secrets/config.json --catalog integration_tests/configured_catalog.json
+```
+
+### Locally running the connector docker image
+
+#### Build
+
+First, make sure you build the latest Docker image:
+
+```
+docker build . -t airbyte/destination-convex:dev
+```
+
+You can also build the connector image via Gradle:
+
+```
+./gradlew :airbyte-integrations:connectors:destination-convex:airbyteDocker
+```
+
+When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in
+the Dockerfile.
+
+#### Run
+
+Then run any of the connector commands as follows:
+
+```
+docker run --rm airbyte/destination-convex:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-convex:dev check --config /secrets/config.json
+# messages.jsonl is a file containing line-separated JSON representing AirbyteMessages
+cat messages.jsonl | docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/destination-convex:dev write --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
+```
+
+## Testing
+
+Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named.
+First install test dependencies into your virtual environment:
+
+```
+pip install .[tests]
+```
+
+### Unit Tests
+
+To run unit tests locally, from the connector directory run:
+
+```
+python -m pytest unit_tests
+```
+
+### Integration Tests
+
+There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all destination connectors) and custom integration tests (which are specific to this connector).
+
+#### Custom Integration tests
+
+Place custom tests inside `integration_tests/` folder, then, from the connector root, run
+
+```
+python -m pytest integration_tests
+```
+
+#### Acceptance Tests
+
+Coming soon:
+
+### Using gradle to run tests
+
+All commands should be run from airbyte project root.
+To run unit tests:
+
+```
+./gradlew :airbyte-integrations:connectors:destination-convex:unitTest
+```
+
+To run acceptance and custom integration tests:
+
+```
+./gradlew :airbyte-integrations:connectors:destination-convex:integrationTest
+```
+
+## 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:
+
+- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
+- required for the testing need to go to `TEST_REQUIREMENTS` list
+
+### 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 unit and integration tests.
+1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
+1. Create a Pull Request.
+1. Pat yourself on the back for being an awesome contributor.
+1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.

airbyte-integrations/connectors/destination-convex/build.gradle

@@ -0,0 +1,8 @@
+plugins {
+    id 'airbyte-python'
+    id 'airbyte-docker'
+}
+
+airbytePython {
+    moduleDirectory 'destination_convex'
+}

airbyte-integrations/connectors/destination-convex/destination_convex/__init__.py

@@ -0,0 +1,8 @@
+#
+# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
+#
+
+
+from .destination import DestinationConvex
+
+__all__ = ["DestinationConvex"]

airbyte-integrations/connectors/destination-convex/destination_convex/client.py

@@ -0,0 +1,59 @@
+#
+# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
+#
+
+from typing import Any, List, Mapping
+
+import requests
+from destination_convex.config import ConvexConfig
+
+
+class ConvexClient:
+    def __init__(self, config: ConvexConfig, stream_metadata: Mapping[str, Any]):
+        self.deployment_url = config["deployment_url"]
+        self.access_key = config["access_key"]
+        self.stream_metadata = stream_metadata
+
+    def batch_write(self, records: List[Mapping[str, Any]]) -> requests.Response:
+        """
+        See Convex docs: https://docs.convex.dev/http-api/#post-apiairbyte_ingress
+        """
+        request_body = {"streams": self.stream_metadata, "messages": records}
+        return self._request("POST", endpoint="airbyte_ingress", json=request_body)
+
+    def delete(self, keys: List[str]) -> requests.Response:
+        """
+        See Convex docs: https://docs.convex.dev/http-api/#put-apiclear_tables
+        """
+        request_body = {"tableNames": keys}
+        return self._request("PUT", endpoint="clear_tables", json=request_body)
+
+    def add_primary_key_indexes(self, indexes: Mapping[str, List[List[str]]]) -> requests.Response:
+        """
+        See Convex docs: https://docs.convex.dev/http-api/#put-apiadd_primary_key_indexes
+        """
+        return self._request("PUT", "add_primary_key_indexes", json={"indexes": indexes})
+
+    def primary_key_indexes_ready(self, tables: List[str]) -> requests.Response:
+        """
+        See Convex docs: https://docs.convex.dev/http-api/#get-apiprimary_key_indexes_ready
+        """
+        return self._request("GET", "primary_key_indexes_ready", json={"tables": tables})
+
+    def _get_auth_headers(self) -> Mapping[str, str]:
+        return {"Authorization": f"Convex {self.access_key}"}
+
+    def _request(
+        self,
+        http_method: str,
+        endpoint: str,
+        json: Mapping[str, Any],
+    ) -> requests.Response:
+        url = f"{self.deployment_url}/api/{endpoint}"
+        headers = {"Accept": "application/json", **self._get_auth_headers()}
+
+        response = requests.request(method=http_method, url=url, headers=headers, json=json)
+
+        if response.status_code != 200:
+            raise Exception(response.json())
+        return response

airbyte-integrations/connectors/destination-convex/destination_convex/config.py

@@ -0,0 +1,13 @@
+#
+# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
+#
+
+from typing import TypedDict
+
+ConvexConfig = TypedDict(
+    "ConvexConfig",
+    {
+        "deployment_url": str,
+        "access_key": str,
+    },
+)