🎉 Source HubSpot: Set Primary keys for streams with an identifier (#1…

…1121)

* Set partition key on streams with id field

* reset to master

* Update readme with primary key

* This can be incremental

* I think this can also support incremental

* incremental streams

* incremental

* Missing comma

* Everything can be incremental

* set pk

* Add a primary key

* Add missing pk

* format

* Update doc

* Bump version

* Not everything can be incremental

* fix field

* Update pk

* Update source_specs

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

@@ -328,7 +328,7 @@
 - name: HubSpot
   sourceDefinitionId: 36c891d9-4bd9-43ac-bad2-10e12756272c
   dockerRepository: airbyte/source-hubspot
-  dockerImageTag: 0.1.46
+  dockerImageTag: 0.1.47
   documentationUrl: https://docs.airbyte.io/integrations/sources/hubspot
   icon: hubspot.svg
   sourceType: api

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

@@ -3331,7 +3331,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-hubspot:0.1.46"
+- dockerImage: "airbyte/source-hubspot:0.1.47"
   spec:
     documentationUrl: "https://docs.airbyte.io/integrations/sources/hubspot"
     connectionSpecification:

airbyte-integrations/connectors/source-hubspot/Dockerfile

@@ -34,5 +34,5 @@ COPY source_hubspot ./source_hubspot
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.1.46
+LABEL io.airbyte.version=0.1.47
 LABEL io.airbyte.name=airbyte/source-hubspot

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

@@ -1,51 +1,93 @@
 # HubSpot Source
 
-This is the repository for the HubSpot source connector, written in Python.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/hubspot).
+This is the repository for the HubSpot source connector, written in Python. For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/hubspot).
+
+## Primary keys
+
+The primary key for the following streams is `id`:
+
+- campaigns
+- companies
+- contacts
+- deals
+- email_events
+- engaments
+- engagements_calls
+- engagements_emails
+- engagements_meetings
+- engagements_notes
+- engagements_tasks
+- feedback_submissions
+- forms
+- line_items
+- marketing_emails
+- owners
+- products
+- tickets
+- ticket_pipelines
+- workflows
+- quotes
+
+The primary key for the following streams is `canonical-vid`:
+
+- contacts_list_memberships
+
+The primary key for the following streams is `pipelineId`:
+
+- deal_pipelines
+
+The following streams do not have a primary key:
+
+- contact_lists (The primary key could potentially be a composite key (portalId, listId) - https://legacydocs.hubspot.com/docs/methods/lists/get_lists)
+- form_submissions (The entities returned by this endpoint do not have an identifier field - https://legacydocs.hubspot.com/docs/methods/forms/get-submissions-for-a-form)
+- subscription_changes (The entities returned by this endpoint do not have an identified field - https://legacydocs.hubspot.com/docs/methods/email/get_subscriptions_timeline)
+- property_history (The entities returned by this endpoint do not have an identifier field - https://legacydocs.hubspot.com/docs/methods/contacts/get_contacts)
 
 ## 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:
+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.
+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:source-hubspot:build
 ```
 
 #### Create credentials
+
 **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/hubspot)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_hubspot/spec.json` file.
-Note that the `secrets` directory is gitignored by default, so there is no danger of accidentally checking in sensitive information.
-See `sample_files/sample_config.json` for a sample config file.
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_hubspot/spec.json` file. Note that the `secrets` directory is gitignored by default, so there is no danger of accidentally checking in sensitive information. See `sample_files/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 hubspot 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
@@ -54,67 +96,81 @@ python main.py read --config secrets/config.json --catalog sample_files/configur
 ```
 
 ## 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:
+
+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 source 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
-Customize `acceptance-test-config.yml` file to configure tests. See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-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.
+
+Customize `acceptance-test-config.yml` file to configure tests. See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-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.
 
 To run your integration tests with acceptance tests, from the connector root, run
+
 ```
 python -m pytest integration_tests -p integration_tests.acceptance
 ```
 
 To run your integration tests with docker
 
 ### Using gradle to run tests
-All commands should be run from airbyte project root.
-To run unit tests:
+
+All commands should be run from airbyte project root. To run unit tests:
+
 ```
 ./gradlew :airbyte-integrations:connectors:source-hubspot:unitTest
 ```
 
 To run acceptance and custom integration tests:
+
 ```
 ./gradlew :airbyte-integrations:connectors:source-hubspot:integrationTest
 ```
 
 ### Locally running the connector docker image
 
 #### Build
+
 First, make sure you build the latest Docker image:
+
 ```
 docker build . -t airbyte/source-hubspot:dev
 ```
 
 You can also build the connector image via Gradle:
+
 ```
 ./gradlew :airbyte-integrations:connectors:source-hubspot: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.
+
+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/source-hubspot:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-hubspot:dev check --config /secrets/config.json
@@ -123,15 +179,18 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/sample_files:/sample_files
 ```
 
 ### Integration Tests
+
 1. From the airbyte project root, run `./gradlew :airbyte-integrations:connectors:source-hubspot:integrationTest` to run the standard integration test suite.
-2. To run additional integration tests, place your integration tests in a new directory `integration_tests` and run them with `python -m pytest -s integration_tests`.
-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.
+2. To run additional integration tests, place your integration tests in a new directory `integration_tests` and run them with `python -m pytest -s integration_tests`. 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.
 
 ## 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.
 
 ### 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
 2. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use SemVer).
 3. Create a Pull Request