Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🎉 Source Pinterest: Added backoff strategy for rate-limit errors #16161

Merged
merged 6 commits into from
Sep 6, 2022

Conversation

lgomezm
Copy link
Contributor

@lgomezm lgomezm commented Aug 31, 2022

What

  • When facing rate limit errors, the Pinterest source connector just logs them.
  • Syncs stop after these errors occur.

How

  • Retries rate limit errors (by not overriding HttpStream.should_retry method).
  • Adds backoff strategy to retry rate limit errors.

I could not find documentation about the actual header to use to get how long it should wait to retry, but could reproduce the rate limit error to verify it:
Screen Shot 2022-08-31 at 12 23 52 AM

Recommended reading order

  1. source.py
  2. test_streams.py

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

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.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

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.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped by running the /publish command described here
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

Tests

Unit Screen Shot 2022-08-31 at 1 21 33 AM Screen Shot 2022-08-31 at 1 21 48 AM
Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@github-actions github-actions bot added the area/connectors Connector related issues label Aug 31, 2022
@lgomezm lgomezm changed the title Lgomez/pinterest backoff strategy 🎉 Source Pinterest: Added backoff strategy for rate-limit errors Aug 31, 2022
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Sep 6, 2022
@bazarnov
Copy link
Collaborator

bazarnov commented Sep 6, 2022

Unit Tests are passed confirmation:

Screenshot 2022-09-06 at 16 38 45

@bazarnov
Copy link
Collaborator

bazarnov commented Sep 6, 2022

/publish connector=connectors/source-pinterest run-tests=false

Publishing without SAT tests, due to run-out Rate Limits for Pinterest Trial Account (our test account).

🕑 Publishing the following connectors:
connectors/source-pinterest
https://github.com/airbytehq/airbyte/actions/runs/3000652582


Connector Did it publish? Were definitions generated?
connectors/source-pinterest

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

@bazarnov bazarnov self-requested a review September 6, 2022 14:05
@bazarnov
Copy link
Collaborator

bazarnov commented Sep 6, 2022

@lgomezm
Thank you for your contribution, we've extended of what you've already done and covered with unit_tests!

@bazarnov bazarnov merged commit 5001474 into master Sep 6, 2022
@bazarnov bazarnov deleted the lgomez/pinterest-backoff-strategy branch September 6, 2022 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/pinterest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 Source Pinterest: no backoff strategy when rate limit is exceeded.
4 participants