✨Source HubSpot: New stream for contacts merged audit

[aballiet]

What

Airbyte HubSpot connector do not capture merges for the COMPANY, CONTACT, and DEAL objects.

Fivetran offers this feature as seen here through dedicated tables.

This PR closes #11178 for CONTACT object and provides an example to implement similar streams for other objects.

How

Describe the solution

• Use CRM Search API v3 -> filter contacts with hs_merged_object_ids is non-null.
• Use Contacts API v1 get_batch_by_vid -> to retrieve merge-audits JSON data

Recommended reading order

1. streams.py
2. schemas/contacts_merged_audit.json

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

• Community member? Grant edit access to maintainers (instructions)
• Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
• Connector version is set to 0.0.1
  • Dockerfile has version 0.0.1
• Documentation updated
  • Connector's README.md
  • Connector's bootstrap.md. See description and examples
  • docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
  • docs/integrations/README.md

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

• Create a non-forked branch based on this PR and test the below items on it
• Build is successful
• If new credentials are required for use in CI, add them to GSM. Instructions.

Updating a connector

Community member or Airbyter

• Grant edit access to maintainers (instructions)
• Unit & integration tests added

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

• Create a non-forked branch based on this PR and test the below items on it
• Build is successful
• If new credentials are required for use in CI, add them to GSM. Instructions.

Connector Generator

• Issue acceptance criteria met
• PR name follows PR naming conventions
• If adding a new generator, add it to the list of scaffold modules being tested
• The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
• Documentation which references the generator is updated as needed

[github-actions]

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

• PR name follows PR naming conventions
• Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan and you've followed all steps in the Breaking Changes Checklist
• Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
• Secrets in the connector's spec are annotated with airbyte_secret
• All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
• Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
• You, or an Airbyter, have run /test successfully on this PR - or on a non-forked branch
• You've updated the connector's metadata.yaml file (new!)

If the checklist is complete, but the CI check is failing,

1. Check for hidden checklists in your PR description

2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

[aballiet]

Hey @sajarin !

We need to update expected_records.json for this one with some merged contacts 👍

[sajarin]

/test connector=connectors/source-hubspot

🕑 connectors/source-hubspot https://github.com/airbytehq/airbyte/actions/runs/5223500875
❌ connectors/source-hubspot https://github.com/airbytehq/airbyte/actions/runs/5223500875
🐛 https://gradle.com/s/ge7q4y47vtbpo

Build Failed

Test summary info:

=========================== short test summary info ============================
ERROR test_core.py::TestBasicRead::test_read[inputs0] - Failed: High strictne...
ERROR test_incremental.py::TestIncremental::test_state_with_abnormally_large_values[inputs0]
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:100: The previous and actual specifications are identical.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/connector_acceptance_test/tests/test_core.py:695: This tests currently leads to too much failures. We need to fix the connectors at scale first.
============= 41 passed, 2 skipped, 2 errors in 396.56s (0:06:36) ==============

[sajarin]

Hey @aballiet thanks for being patient, currently the master branch for the hubspot connector is broken so trying to get that fixed before merging this in.

[sajarin]

hey @aballiet, I believe we fixed the master branch of the connector. Could you resolve the merge conflicts?

[aballiet]

hey @aballiet, I believe we fixed the master branch of the connector. Could you resolve the merge conflicts?

Done 👍

[aballiet]

Any update regarding this ? :) @sajarin

[sajarin]

sorry for the delay @aballiet I think we resolved the issue with the records, running tests in a seperate pr above

resolved

[sajarin]

Thanks for the PR @aballiet! :)