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 Orb: Fix bug to enrich multiple events with the same event_id #17761

Conversation

anushree-agrawal
Copy link
Contributor

@anushree-agrawal anushree-agrawal commented Oct 7, 2022

What

Fixes a bug where we assumed there would only be a single ledger entry for a given event_id. This isn't true when we have a single event that causes deductions from multiple credit blocks, which results in 2 or more ledger entries.

How

We allow a list of event_id -> ledger entry mappings now, instead of a single event_id -> entry

Recommended reading order

  1. source.python

🚨 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.
No breaking changes

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.
image
image

Integration

Put your integration tests output here.
image

Acceptance

Put your acceptance tests output here.
image

@github-actions github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Oct 7, 2022
@ChristopheDuong
Copy link
Contributor

ChristopheDuong commented Oct 10, 2022

/test connector=connectors/source-orb

🕑 connectors/source-orb https://github.com/airbytehq/airbyte/actions/runs/3220645118
✅ connectors/source-orb https://github.com/airbytehq/airbyte/actions/runs/3220645118
Python tests coverage:

Name                     Stmts   Miss  Cover
--------------------------------------------
source_orb/__init__.py       2      0   100%
source_orb/source.py       196     21    89%
--------------------------------------------
TOTAL                      198     21    89%
	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          10      4    60%   15-18
	 source_acceptance_test/config.py                        83      6    93%   78-80, 84-86
	 source_acceptance_test/conftest.py                     164    164     0%   6-282
	 source_acceptance_test/plugin.py                        48     48     0%   6-104
	 source_acceptance_test/tests/test_core.py              329    111    66%   39, 50-58, 63-70, 74-75, 79-80, 164, 202-219, 228-236, 240-245, 251, 284-289, 327-334, 374-376, 379, 439-448, 477-478, 484, 487, 520-530, 543-568, 573-577
	 source_acceptance_test/tests/test_full_refresh.py       52      2    96%   34, 65
	 source_acceptance_test/tests/test_incremental.py       152     26    83%   21-23, 29-31, 36-43, 48-61, 239, 250-258
	 source_acceptance_test/utils/asserts.py                 37      2    95%   57-58
	 source_acceptance_test/utils/common.py                  77     17    78%   15-16, 24-30, 47-54, 64, 67
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/connector_runner.py       112     50    55%   23-26, 32, 36, 39-67, 70-72, 75-77, 80-82, 85-87, 90-92, 95-113, 147-149
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1358    466    66%

Build Passed

Test summary info:

All Passed

@zzztimbo
Copy link
Contributor

zzztimbo commented Oct 10, 2022

/publish connector=connectors/source-orb

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


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

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

@zzztimbo
Copy link
Contributor

zzztimbo commented Oct 10, 2022

/publish connector=connectors/source-orb

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


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

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

@ChristopheDuong
Copy link
Contributor

I'm going to merge this and publish in another PR instead

@ChristopheDuong ChristopheDuong merged commit bec1ecf into airbytehq:master Oct 11, 2022
@zzztimbo
Copy link
Contributor

zzztimbo commented Oct 11, 2022

/publish connector=connectors/source-orb

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


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

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

@sajarin sajarin added internal and removed bounty labels Oct 13, 2022
jhammarstedt pushed a commit to jhammarstedt/airbyte that referenced this pull request Oct 31, 2022
…id` (airbytehq#17761)

* Update source Orb to handle multiple events with the same event_id

* Documentation

* Update documentation
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 community connectors/source/orb internal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants