Alex/configurable retrier

[girarda]

What

• Implement configurable retrier which describes what requests to retry and how long to backoff if necessary

How

• set raise_on_http_errors to false to bypass the default error handling

• retrier's should_retry method returns a ResponseStatus, which describes whether a request was success, and if it failed, whether it should be fatal, ignored, or retried. if retried, it'll include how long to retry

• when determining if a request must be retried, the default retrier will apply an HttpResponseFilter on the response to determine whether it should be retried or ignored

• HttpResponseFilters can match responses based off the HTTP code, by looking for a substring in the error message, or by applying an arbitrary boolean interpolation

• If a request must be retried, the retrier will call its backoff strategies to get the backoff time. if a backoff strategy returns None, then the retrier will ask the next one

• The retrier always default to an exponential backoff strategy if non of its strategy resolved to a backoff time

• ChainRetrier will chain sequentially ask its retriers the status of a response and assume an error is fatal if none of them decides it should be ignored or retried

• the max_retries and factor properties were removed from the retriever and requester as they are not used anymore - declarative streams should always return a ResponseStatus with the desired backoff time

existing backoff strategies include

• static constant
• extract how long to wait from response header
  * extract time to retry from response header
• exponential backoff

Recommended reading order

1. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/retriers/retrier.py
2. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/retriers/http_response_filter.py
3. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/retriers/default_retrier.py
4. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/retriers/backoff_strategy.py
5. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/retriers/backoff_strategies/constant_backoff_strategy.py
6. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/retriers/backoff_strategies/exponential_backoff_strategy.py
7. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/retriers/backoff_strategies/wait_time_from_header_backoff_strategy.py
8. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/retriers/backoff_strategies/wait_until_time_from_header_backoff_strategy.py
9. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/retriers/chain_retrier.py
10. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/requester.py
11. airbyte-cdk/python/airbyte_cdk/sources/declarative/requesters/http_requester.py
12. airbyte-cdk/python/airbyte_cdk/sources/declarative/parsers/yaml_parser.py
13. airbyte-cdk/python/airbyte_cdk/sources/declarative/parsers/factory.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

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

[brianjlai]

This is amazing! The most complex addition to the low code CDK yet!

[sherifnada]

Looks great! nicely done