Skip to content

Conversation

@arshk123
Copy link
Contributor

@arshk123 arshk123 commented Feb 8, 2024

What

Orb's event search API is moving to require a timestamp boundary alongside the event_id to improve the performance of the endpoint. This PR updates the Airbyte connector to pass in the timestamp bounds derived from the ledger_entry.created_at field.

How

We now use the created_at timestamp in the ledger_entry to determine the start and end bounds for the event search query.

Recommended reading order

  1. source.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?
No breaking changes

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added
CleanShot 2024-02-07 at 23 04 29@2x CleanShot 2024-02-07 at 23 05 24@2x

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.
Updating the Python CDK

Airbyter

Before merging:

  • Pull Request description explains what problem it is solving
  • Code change is unit tested
  • Build and my-py check pass
  • Smoke test the change on at least one affected connector
    • On Github: Run this workflow, passing --use-local-cdk --name=source-<connector> as options
    • Locally: airbyte-ci connectors --use-local-cdk --name=source-<connector> test
  • PR is reviewed and approved

After merging:

  • Publish the CDK
    • The CDK does not follow proper semantic versioning. Choose minor if this the change has significant user impact or is a breaking change. Choose patch otherwise.
    • Write a thoughtful changelog message so we know what was updated.
  • Merge the platform PR that was auto-created for updating the Connector Builder's CDK version
    • This step is optional if the change does not affect the connector builder or declarative connectors.
@vercel
Copy link

vercel bot commented Feb 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ❌ Failed (Inspect) Feb 20, 2024 6:27am
@github-actions
Copy link
Contributor

github-actions bot commented Feb 8, 2024

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@arshk123 arshk123 changed the title Source Orb: update enrich ledger entry with event stream to pass timeframe bounds ✨ Source Orb: update enrich ledger entry with event stream to pass timeframe bounds Feb 8, 2024
@CLAassistant
Copy link

CLAassistant commented Feb 8, 2024

CLA assistant check
All committers have signed the CLA.

@arshk123 arshk123 changed the title ✨ Source Orb: update enrich ledger entry with event stream to pass timeframe bounds 🐛 Source Orb: update enrich ledger entry with event stream to pass timeframe bounds Feb 8, 2024
@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Feb 8, 2024
Copy link
Contributor

@girarda girarda left a comment

Choose a reason for hiding this comment

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

the change seems fine and pretty straightforward.

Tagging @marcosmarxm since you're more familiar than I am with how we review and test community connectors. Would you mind taking a look?

@arshk123
Copy link
Contributor Author

👋 Hi @marcosmarxm, just wanted to bump this PR in your inbox, we'd love to get this reviewed and merged to unblock a downstream API change we're scheduled to make, and want to make sure that the Airbyte connector works as expected after the change!

@arshk123
Copy link
Contributor Author

arshk123 commented Mar 5, 2024

Hi @marcosmarxm, would you be able to take a look at this PR or is there somebody else we should reach out to? We'd like to get this shipped so that we can move forward with the downstream changes to our API. We were hoping to finish up the API changes before the start of this month, but now we'd just like to finish them up ASAP.

Please let us know what we can do to help the process move faster

@marcosmarxm
Copy link
Contributor

Working to get this merged asap @arshk123

@marcosmarxm
Copy link
Contributor

Sorry the delay folks its merged by #35897

@marcosmarxm marcosmarxm closed this Mar 8, 2024
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

6 participants