[low-code]: Evaluate backoff strategies at runtime #18053

girarda · 2022-10-17T13:43:43Z

What

Evaluate the backoff strategies at runtime
Fixes Low-code SDK: Error when adding backoff strategy #17939

How

Pass options and config to all backoff strategies and evaluate their parameters at runtime
Fix bug in factory: we can't pass options parameter if the field is a primitive

🚨 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

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.

girarda · 2022-10-17T13:44:04Z

...ources/declarative/requesters/error_handlers/backoff_strategies/constant_backoff_strategy.py

@@ -19,7 +21,14 @@ class ConstantBackoffStrategy(BackoffStrategy, JsonSchemaMixin):
        backoff_time_in_seconds (float): time to backoff before retrying a retryable request.
    """

-    backoff_time_in_seconds: float
+    backoff_time_in_seconds: Union[float, InterpolatedString, str]
+    options: InitVar[Mapping[str, Any]]


add options and config parameters

girarda · 2022-10-17T13:44:13Z

...ources/declarative/requesters/error_handlers/backoff_strategies/constant_backoff_strategy.py

+
+    def __post_init__(self, options: Mapping[str, Any]):
+        if not isinstance(self.backoff_time_in_seconds, InterpolatedString):
+            self.backoff_time_in_seconds = str(self.backoff_time_in_seconds)


convert to string if needed

girarda · 2022-10-17T13:44:19Z

...ources/declarative/requesters/error_handlers/backoff_strategies/constant_backoff_strategy.py


    def backoff(self, response: requests.Response, attempt_count: int) -> Optional[float]:
-        return self.backoff_time_in_seconds
+        return self.backoff_time_in_seconds.eval(self.config)


eval at runtime

girarda · 2022-10-17T14:27:23Z

airbyte-cdk/python/airbyte_cdk/sources/declarative/parsers/factory.py

@@ -229,14 +229,17 @@ def _create_subcomponent(self, key, definition, kwargs, config, parent_class, in
                options = kwargs.get(OPTIONS_STR, {})
                try:
                    # enums can't accept options
-                    if issubclass(expected_type, enum.Enum):
+                    if issubclass(expected_type, enum.Enum) or self.isBuiltinTypes(definition):


we can't pass the options parameter if the expected_type is an int, float, or bool

girarda · 2022-10-17T14:28:57Z

airbyte-cdk/python/unit_tests/sources/declarative/test_factory.py

    request_options_provider:
      request_parameters:
        a_parameter: "something_here"
      request_headers:
        header: header_value
+    {error_handler}


make sure we can instantiate all types of backoff strategies

brianjlai · 2022-10-17T20:35:50Z

airbyte-cdk/python/airbyte_cdk/sources/declarative/parsers/factory.py

                        return expected_type(definition)
                    else:
                        return expected_type(definition, options=options)
                except Exception as e:
                    raise Exception(f"failed to instantiate type {expected_type}. {e}")
        return definition

+    def isBuiltinTypes(self, obj):


snake case instead?

brianjlai · 2022-10-18T06:43:05Z

...ts/sources/declarative/requesters/error_handlers/backoff_strategies/test_constant_backoff.py

-        ("test_exponential_backoff", 1, BACKOFF_TIME),
-        ("test_exponential_backoff", 2, BACKOFF_TIME),
+        ("test_constant_backoff_first_attempt", 1, BACKOFF_TIME, BACKOFF_TIME),
+        ("test_constant_backoff_second_attempt", 2, BACKOFF_TIME, BACKOFF_TIME),


Can we also add a test for a float? Right now eval() would end up casting these to ints

@brianjlai are you referring to the backoff time or the attempt count? I added tests for both.

backoff time is a float -> backoff time is evaluated as a float

attempt count is a float -> the value is actually never used. Python auto casts it to int. Do you think we should be stricter and fail if we pass a float instead of an int?

i just meant for backoff time, we were using the constants for BACKOFF_TIME which were ints, so just adding a true float. I was messing around with things and using the constants eval would come back as int, figured we should just test a float returned too just in case. But I see you added it already so all good!

girarda added 2 commits October 17, 2022 06:18

pass options to wait time from header

da45217

fix constant backoff

6aa1b52

github-actions bot added the CDK Connector Development Kit label Oct 17, 2022

girarda commented Oct 17, 2022

View reviewed changes

girarda added 8 commits October 17, 2022 06:48

parameterize test

b5efdfa

fix tests

d654001

missing unit tests

7b61f1d

eval header at runtime

3a0efed

eval regex at runtime

72f749b

evaluate min_wait at runtime

0093b08

eval factor at runtime

4aa4b25

missing unit tests

7598e01

girarda changed the title ~~Alex/fix backoff strategies~~ [low-code]: Propagate options and config to backoff strategies Oct 17, 2022

girarda changed the title ~~[low-code]: Propagate options and config to backoff strategies~~ [low-code]: Evaluate backoff strategies at runtime Oct 17, 2022

girarda commented Oct 17, 2022

View reviewed changes

remove debug print

9e90ff5

girarda commented Oct 17, 2022

View reviewed changes

girarda requested a review from brianjlai October 17, 2022 14:29

girarda marked this pull request as ready for review October 17, 2022 14:30

girarda requested a review from a team as a code owner October 17, 2022 14:30

brianjlai approved these changes Oct 18, 2022

View reviewed changes

girarda added 3 commits October 18, 2022 08:20

rename

2e7ce39

Add tests

f20d1db

Add tests

de519ca

brianjlai mentioned this pull request Oct 18, 2022

Low-code SDK: Error when adding backoff strategy #17939

Closed

girarda added 3 commits October 26, 2022 19:32

merge

0a0db98

Merge branch 'master' into alex/fix_backoff_strategies

0efe44b

Update docs

dcc4da3

github-actions bot added the area/documentation Improvements or additions to documentation label Nov 4, 2022

Merge branch 'master' into alex/fix_backoff_strategies

4de6ea3

girarda merged commit 605fb92 into master Nov 4, 2022

girarda deleted the alex/fix_backoff_strategies branch November 4, 2022 01:50

Xabilahu mentioned this pull request Nov 4, 2022

🎉 New Source: GNews [low-code CDK] #18808

Merged

37 tasks

github-actions bot mentioned this pull request Nov 15, 2022

Bump helm chart version reference to 0.40.43 #19453

Closed

octavia-squidington-iii mentioned this pull request Nov 18, 2022

Bump Airbyte version from 0.40.18 to 0.40.19 #19579

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[low-code]: Evaluate backoff strategies at runtime #18053

[low-code]: Evaluate backoff strategies at runtime #18053

girarda commented Oct 17, 2022 •

edited

Loading

girarda Oct 17, 2022

girarda Oct 17, 2022

girarda Oct 17, 2022

girarda Oct 17, 2022

girarda Oct 17, 2022

brianjlai Oct 17, 2022

brianjlai Oct 18, 2022

girarda Oct 18, 2022

brianjlai Oct 18, 2022

[low-code]: Evaluate backoff strategies at runtime #18053

[low-code]: Evaluate backoff strategies at runtime #18053

Conversation

girarda commented Oct 17, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

girarda commented Oct 17, 2022 •

edited

Loading