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

[low-code connectors] Get parent stream's full slice #15631

Merged
merged 5 commits into from
Aug 18, 2022

Conversation

girarda
Copy link
Contributor

@girarda girarda commented Aug 13, 2022

What

The substream slicer currently sets the slice's parent_slice field to the value of the slice field in the parent stream's slice.
This is wrong as there are no guarantees that the parent stream slices have a slice field.
The Substream slicer should instead store the fill parent slice in the parent_slice field.

Example of what this will look like:

{"type": "DEBUG", "message": "Processing stream slice", "data": {"slice": "{'parent_id': 19214950003, 'parent_slice': {'start_time': '2020-01-01T00:00:00.000000+0000', 'end_time': '2022-08-17T22:15:45.977826+0000'}}"}}

I noticed this issue while trying to add incremental support to the greenhouse connector. Nothing in production is currently affected.

How

  • Set the parent_slice to the full parent slice instead of only its "slice" field
  • Update tests

Recommended reading order

  1. airbyte-cdk/python/airbyte_cdk/sources/declarative/stream_slicers/substream_slicer.py
  2. airbyte-cdk/python/unit_tests/sources/declarative/stream_slicers/test_substream_slicer.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.

@github-actions github-actions bot added the CDK Connector Development Kit label Aug 13, 2022
@girarda girarda changed the title [low-code connectors] always access parent stream using full_refresh mode alex/wip Aug 13, 2022
@@ -127,7 +127,7 @@ def stream_slices(self, sync_mode: SyncMode, stream_state: StreamState) -> Itera
stream_state_field = parent_stream_config.stream_slice_field
for parent_stream_slice in parent_stream.stream_slices(sync_mode=sync_mode, cursor_field=None, stream_state=stream_state):
empty_parent_slice = True
parent_slice = parent_stream_slice.get("slice")
parent_slice = parent_stream_slice
Copy link
Contributor Author

@girarda girarda Aug 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is a problem for sub-resources with an incremental parent stream.
this bug sneaked in during the stream slicer refactor because the parent stream slices have a "slice" field in the tests https://github.com/airbytehq/airbyte/pull/15631/files#diff-e46344fad49c4a5f8e385cf45a805d7117107c4b0e1b806720a7416cf397e853L16-L17

@girarda girarda changed the title alex/wip [low-code connectors] Get parent stream's full slice Aug 17, 2022
@girarda girarda requested a review from brianjlai August 17, 2022 22:33
Copy link
Contributor

@brianjlai brianjlai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm. thanks for adding some tweaking the tests to cover this now!

@girarda
Copy link
Contributor Author

girarda commented Aug 18, 2022

/publish-cdk dry-run=false

🕑 https://github.com/airbytehq/airbyte/actions/runs/2879225027
https://github.com/airbytehq/airbyte/actions/runs/2879225027

@girarda girarda marked this pull request as ready for review August 18, 2022 17:23
@girarda girarda requested a review from a team August 18, 2022 17:23
@girarda girarda merged commit 313ac11 into master Aug 18, 2022
@girarda girarda deleted the alex/fixSubstreamIncremental branch August 18, 2022 17:24
rodireich pushed a commit that referenced this pull request Aug 25, 2022
* always access parent stream using full_refresh mode

* Update test

* fix substream slicer

* bump
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CDK Connector Development Kit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants