✨ Source Hubspot: improve error message during connector setup #28558

arsenlosenko · 2023-07-21T11:14:13Z

What

Define more concise error messages during connector setup, accordingly to this issue:
#28508

How

I have tried to invoke errors during check with both access token and OAuth configs and see what errors are raised if fields in configs are changed to invalid values. It boiled down to two main cases: either 401 if access token is invalid, or 400 if any of OAuth credentials are invalid. Considering that I have added handling to these two cases, if there are other errors that might be raised during connector setup, they will be presented to user as is.

In terms of unit tests, covered only the part which handles 400 errors, as the other case with HubspotInvalidAuth was already covered by other tests.

github-actions · 2023-07-21T11:14:41Z

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.
Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
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
Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
If set, you've ensured the icon is present in the platform-internal repo. (Docs)

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

Check for hidden checklists in your PR description
Toggle the github label checklist-action-run on/off to re-run the checklist CI.

octavia-squidington-iii · 2023-07-21T11:15:34Z

source-hubspot test report (commit `e1a102b54e`) - ✅

⏲️ Total pipeline duration: 5.28s

Step	Result

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

octavia-squidington-iii · 2023-07-21T11:17:04Z

source-hubspot test report (commit `abef9407fb`) - ✅

⏲️ Total pipeline duration: 2.87s

Step	Result

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

…setup-error-messages

octavia-squidington-iii · 2023-07-21T12:29:20Z

source-hubspot test report (commit `181d7a625f`) - ❌

⏲️ Total pipeline duration: 10mn20s

Step	Result
Validate airbyte-integrations/connectors/source-hubspot/metadata.yaml	✅
Connector version semver check	✅
QA checks	✅
Code format checks	❌
Connector package install	✅
Build source-hubspot docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	❌
Acceptance tests	✅

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

octavia-squidington-iii · 2023-07-21T12:53:58Z

source-hubspot test report (commit `b9ad9ce0c4`) - ✅

⏲️ Total pipeline duration: 6.45s

Step	Result

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

…setup-error-messages

octavia-squidington-iii · 2023-07-21T12:56:35Z

source-hubspot test report (commit `56e87e0e56`) - ✅

⏲️ Total pipeline duration: 18.86s

Step	Result

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

…setup-error-messages

octavia-squidington-iii · 2023-07-24T08:01:19Z

source-hubspot test report (commit `8afe40a8f0`) - ❌

⏲️ Total pipeline duration: 10mn37s

Step	Result
Validate airbyte-integrations/connectors/source-hubspot/metadata.yaml	✅
Connector version semver check	✅
QA checks	✅
Code format checks	❌
Connector package install	✅
Build source-hubspot docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	❌

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

octavia-squidington-iii · 2023-07-24T09:41:45Z

source-hubspot test report (commit `9600945894`) - ❌

⏲️ Total pipeline duration: 10mn13s

Step	Result
Validate airbyte-integrations/connectors/source-hubspot/metadata.yaml	✅
Connector version semver check	✅
QA checks	✅
Code format checks	✅
Connector package install	✅
Build source-hubspot docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	❌

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

octavia-squidington-iii · 2023-07-24T11:40:00Z

source-hubspot test report (commit `d02b5c1af8`) - ✅

⏲️ Total pipeline duration: 10mn13s

Step	Result
Validate airbyte-integrations/connectors/source-hubspot/metadata.yaml	✅
Connector version semver check	✅
QA checks	✅
Code format checks	✅
Connector package install	✅
Build source-hubspot docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

airbyte-integrations/connectors/source-hubspot/source_hubspot/source.py

octavia-squidington-iii · 2023-07-26T11:42:54Z

source-hubspot test report (commit `7945638418`) - ✅

⏲️ Total pipeline duration: 13mn13s

Step	Result
Validate airbyte-integrations/connectors/source-hubspot/metadata.yaml	✅
Connector version semver check	✅
QA checks	✅
Code format checks	✅
Connector package install	✅
Build source-hubspot docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

…setup-error-messages

octavia-squidington-iii · 2023-07-27T11:05:06Z

source-hubspot test report (commit `534b86313e`) - ✅

⏲️ Total pipeline duration: 12mn38s

Step	Result
Validate airbyte-integrations/connectors/source-hubspot/metadata.yaml	✅
Connector version semver check	✅
QA checks	✅
Code format checks	✅
Connector package install	✅
Build source-hubspot docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

octavia-squidington-iii · 2023-07-27T11:18:51Z

source-hubspot test report (commit `6fcfdf8293`) - ✅

⏲️ Total pipeline duration: 11mn37s

Step	Result
Validate airbyte-integrations/connectors/source-hubspot/metadata.yaml	✅
Connector version semver check	✅
QA checks	✅
Code format checks	✅
Connector package install	✅
Build source-hubspot docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-hubspot test

Source Hubspot: improve error message during connector setup

e1a102b

arsenlosenko self-assigned this Jul 21, 2023

octavia-squidington-iii added area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/hubspot labels Jul 21, 2023

Update changelog

abef940

arsenlosenko linked an issue Jul 21, 2023 that may be closed by this pull request

Source Hubspot: improve error messages during setup #28508

Closed

Merge branch 'master' into arsenlosenko/28508-source-hubspot-improve-…

181d7a6

…setup-error-messages

Fix import order

b9ad9ce

Merge branch 'master' into arsenlosenko/28508-source-hubspot-improve-…

56e87e0

…setup-error-messages

Merge branch 'master' into arsenlosenko/28508-source-hubspot-improve-…

8afe40a

…setup-error-messages

Fix linting errors

9600945

Update contacts expected records

d02b5c1

arsenlosenko requested review from lazebnyi and darynaishchenko July 24, 2023 11:41

darynaishchenko requested changes Jul 26, 2023

View reviewed changes

airbyte-integrations/connectors/source-hubspot/source_hubspot/source.py Outdated Show resolved Hide resolved

update error message

7945638

darynaishchenko approved these changes Jul 27, 2023

View reviewed changes

arsenlosenko added 2 commits July 27, 2023 13:50

Merge branch 'master' into arsenlosenko/28508-source-hubspot-improve-…

534b863

…setup-error-messages

Update version

6fcfdf8

arsenlosenko merged commit 277711a into master Jul 27, 2023
22 checks passed

arsenlosenko deleted the arsenlosenko/28508-source-hubspot-improve-setup-error-messages branch July 27, 2023 11:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Source Hubspot: improve error message during connector setup #28558

✨ Source Hubspot: improve error message during connector setup #28558

arsenlosenko commented Jul 21, 2023 •

edited

github-actions bot commented Jul 21, 2023 •

edited by arsenlosenko

octavia-squidington-iii commented Jul 21, 2023

octavia-squidington-iii commented Jul 21, 2023

octavia-squidington-iii commented Jul 21, 2023

octavia-squidington-iii commented Jul 21, 2023

octavia-squidington-iii commented Jul 21, 2023

octavia-squidington-iii commented Jul 24, 2023

octavia-squidington-iii commented Jul 24, 2023

octavia-squidington-iii commented Jul 24, 2023

octavia-squidington-iii commented Jul 26, 2023

octavia-squidington-iii commented Jul 27, 2023

octavia-squidington-iii commented Jul 27, 2023

✨ Source Hubspot: improve error message during connector setup #28558

✨ Source Hubspot: improve error message during connector setup #28558

Conversation

arsenlosenko commented Jul 21, 2023 • edited

What

How

github-actions bot commented Jul 21, 2023 • edited by arsenlosenko

Before Merging a Connector Pull Request

octavia-squidington-iii commented Jul 21, 2023

source-hubspot test report (commit e1a102b54e) - ✅

octavia-squidington-iii commented Jul 21, 2023

source-hubspot test report (commit abef9407fb) - ✅

octavia-squidington-iii commented Jul 21, 2023

source-hubspot test report (commit 181d7a625f) - ❌

octavia-squidington-iii commented Jul 21, 2023

source-hubspot test report (commit b9ad9ce0c4) - ✅

octavia-squidington-iii commented Jul 21, 2023

source-hubspot test report (commit 56e87e0e56) - ✅

octavia-squidington-iii commented Jul 24, 2023

source-hubspot test report (commit 8afe40a8f0) - ❌

octavia-squidington-iii commented Jul 24, 2023

source-hubspot test report (commit 9600945894) - ❌

octavia-squidington-iii commented Jul 24, 2023

source-hubspot test report (commit d02b5c1af8) - ✅

octavia-squidington-iii commented Jul 26, 2023

source-hubspot test report (commit 7945638418) - ✅

octavia-squidington-iii commented Jul 27, 2023

source-hubspot test report (commit 534b86313e) - ✅

octavia-squidington-iii commented Jul 27, 2023

source-hubspot test report (commit 6fcfdf8293) - ✅

arsenlosenko commented Jul 21, 2023 •

edited

github-actions bot commented Jul 21, 2023 •

edited by arsenlosenko

source-hubspot test report (commit `e1a102b54e`) - ✅

source-hubspot test report (commit `abef9407fb`) - ✅

source-hubspot test report (commit `181d7a625f`) - ❌

source-hubspot test report (commit `b9ad9ce0c4`) - ✅

source-hubspot test report (commit `56e87e0e56`) - ✅

source-hubspot test report (commit `8afe40a8f0`) - ❌

source-hubspot test report (commit `9600945894`) - ❌

source-hubspot test report (commit `d02b5c1af8`) - ✅

source-hubspot test report (commit `7945638418`) - ✅

source-hubspot test report (commit `534b86313e`) - ✅

source-hubspot test report (commit `6fcfdf8293`) - ✅