[low-code-connectors] Replace JelloExtractor with DpathExtractor #15514

girarda · 2022-08-10T15:47:20Z

What

Replace JelloExtractor with DpathExtractor which has a simple contract.

How

Create RecordExtractor interface, which JelloExtractor implements
Create DpathExtractor which implements RecordExtractor and uses dpath.util.get to extract records from the decoded response
If the field pointer is empty, then the full response body is returned

Testing

Follow up items

Test the connector configs
Update template
Update docs and tutorial
Delete JelloExtractor

🚨 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-08-10T15:47:59Z

airbyte-cdk/python/unit_tests/sources/declarative/extractors/test_record_selector.py

+            "_",
+            None,
+            [],
+            [],


the returned value is [{}] without the fix

sherifnada

could you document this behavior in the record selector docs section and docstrings?

on your PR description note: maybe dpath is really the way to go and we're making this too complicated for ourselves. It seems the contract might more easily just be:

either there is a single JSON returned from the response, in which case wrap it in []
there are many responses returned, in which case point to an array field containing that data

like we discussed though i'd rather wrap up the CDK work for the week and call that change a follow up

airbyte-cdk/python/airbyte_cdk/sources/declarative/extractors/jello.py

airbyte-cdk/python/airbyte_cdk/sources/declarative/extractors/record_selector.py

…jello.py Co-authored-by: Sherif A. Nada <[email protected]>

…record_selector.py Co-authored-by: Sherif A. Nada <[email protected]>

girarda · 2022-08-11T15:15:56Z

airbyte-cdk/python/airbyte_cdk/sources/declarative/extractors/jello.py

 from airbyte_cdk.sources.declarative.interpolation.interpolated_string import InterpolatedString
 from airbyte_cdk.sources.declarative.types import Config, Record
 from dataclasses_jsonschema import JsonSchemaMixin
 from jello import lib as jello_lib


 @dataclass
-class JelloExtractor(JsonSchemaMixin):
+class JelloExtractor(RecordExtractor, JsonSchemaMixin):


We can delete this class in a follow up PR

sherifnada

LGTM but Why not make dpath the default?

sherifnada · 2022-08-11T17:29:55Z

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

@@ -50,11 +52,12 @@
    InterpolatedString: InterpolatedString,
    MinMaxDatetime: MinMaxDatetime,
    Paginator: NoPagination,
+    ParentStreamConfig: ParentStreamConfig,
+    RecordExtractor: JelloExtractor,


should this be the Dpath one instead?

girarda · 2022-08-11T18:22:06Z

/publish-cdk dry-run=false

girarda · 2022-08-11T19:21:08Z

/publish-cdk dry-run=false

girarda · 2022-08-11T19:22:19Z

/publish-cdk dry-run=false

🕑 https://github.com/airbytehq/airbyte/actions/runs/2842300489
✅ https://github.com/airbytehq/airbyte/actions/runs/2842300489

Handle extracting no records from root

42af817

github-actions bot added the CDK Connector Development Kit label Aug 10, 2022

girarda commented Aug 10, 2022

View reviewed changes

handle missing keys

52d28fe

girarda changed the title ~~Handle extracting no records from root~~ 🐛 [low-code-connectors] Handle records with unexpected shape Aug 11, 2022

Merge branch 'master' into alex/selectNoRecords

7975a89

girarda marked this pull request as ready for review August 11, 2022 02:35

girarda requested a review from a team as a code owner August 11, 2022 02:35

girarda requested a review from sherifnada August 11, 2022 02:35

sherifnada suggested changes Aug 11, 2022

View reviewed changes

airbyte-cdk/python/airbyte_cdk/sources/declarative/extractors/jello.py Outdated Show resolved Hide resolved

airbyte-cdk/python/airbyte_cdk/sources/declarative/extractors/record_selector.py Outdated Show resolved Hide resolved

girarda marked this pull request as draft August 11, 2022 14:16

girarda and others added 10 commits August 11, 2022 07:16

record extractor interface

b582e87

dpath extractor

1b34c19

docstring

3dadc32

handle extract root array

5e9d9fa

Update airbyte-cdk/python/airbyte_cdk/sources/declarative/extractors/…

d5f6450

…jello.py Co-authored-by: Sherif A. Nada <[email protected]>

Update airbyte-cdk/python/airbyte_cdk/sources/declarative/extractors/…

7e49e45

…record_selector.py Co-authored-by: Sherif A. Nada <[email protected]>

update docstring

ded52e8

respect extractor interface

49ddfef

edge case handling

9c50a75

document

6683d5e

girarda commented Aug 11, 2022

View reviewed changes

girarda marked this pull request as ready for review August 11, 2022 15:16

girarda requested a review from sherifnada August 11, 2022 15:16

girarda mentioned this pull request Aug 11, 2022

migrate greenhouse to config-based cdk #15344

Merged

37 tasks

Merge branch 'master' into alex/selectNoRecords

1de1c75

sherifnada approved these changes Aug 11, 2022

View reviewed changes

girarda added 3 commits August 11, 2022 11:15

use dpath by default

c7568ee

delete jello extractor

ac5d141

bump cdk version

3a3884b

girarda added 2 commits August 11, 2022 11:18

delete jello dependency

c046dfb

Update reference docs templates

e1666da

girarda changed the title ~~🐛 [low-code-connectors] Handle records with unexpected shape~~ 🐛 [low-code-connectors] Replace JelloExtractor with DpathExtractor Aug 11, 2022

girarda changed the title ~~🐛 [low-code-connectors] Replace JelloExtractor with DpathExtractor~~ [low-code-connectors] Replace JelloExtractor with DpathExtractor Aug 11, 2022

update template

b8ba658

girarda merged commit 6332fd6 into master Aug 11, 2022

girarda deleted the alex/selectNoRecords branch August 11, 2022 19:34

octavia-squidington-iii mentioned this pull request Aug 19, 2022

Bump Airbyte version from 0.40.0-alpha to 0.40.1-alpha #15775

Closed

evantahler mentioned this pull request Aug 22, 2022

Bump Airbyte version from 0.40.0-alpha to 0.40.1 #15857

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[low-code-connectors] Replace JelloExtractor with DpathExtractor #15514

[low-code-connectors] Replace JelloExtractor with DpathExtractor #15514

girarda commented Aug 10, 2022 •

edited

Loading

girarda Aug 10, 2022 •

edited

Loading

sherifnada left a comment

girarda Aug 11, 2022

sherifnada left a comment

sherifnada Aug 11, 2022

girarda Aug 11, 2022

girarda commented Aug 11, 2022

girarda commented Aug 11, 2022

girarda commented Aug 11, 2022 •

edited by github-actions bot

Loading

[low-code-connectors] Replace JelloExtractor with DpathExtractor #15514

[low-code-connectors] Replace JelloExtractor with DpathExtractor #15514

Conversation

girarda commented Aug 10, 2022 • edited Loading

What

How

Testing

Recommended reading order

Follow up items

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

girarda Aug 10, 2022 • edited Loading

Choose a reason for hiding this comment

sherifnada left a comment

Choose a reason for hiding this comment

girarda Aug 11, 2022

Choose a reason for hiding this comment

sherifnada left a comment

Choose a reason for hiding this comment

sherifnada Aug 11, 2022

Choose a reason for hiding this comment

girarda Aug 11, 2022

Choose a reason for hiding this comment

girarda commented Aug 11, 2022

girarda commented Aug 11, 2022

girarda commented Aug 11, 2022 • edited by github-actions bot Loading

girarda commented Aug 10, 2022 •

edited

Loading

girarda Aug 10, 2022 •

edited

Loading

girarda commented Aug 11, 2022 •

edited by github-actions bot

Loading