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 Zendesk Support: fix pagination for incremetal export streams #33680

Merged

Conversation

roman-yermilov-gl
Copy link
Contributor

@roman-yermilov-gl roman-yermilov-gl commented Dec 20, 2023

What

Oncall issue: https://github.com/airbytehq/oncall/issues/3706
There are multiple problems with pagination which affect descendants of the SourceZendeskIncrementalExportStream especially Organizations and Articles.

Organizations`s pagination mechanizm is based on end_of_stream flag and start_date/end_date params. For this stream start_date were never replaced by end_date (because next_page_token updates only cursor) so we infinitely requesting 1st page

Articles use start_date/end_date params but there is no end_of_stream indiactor in response. Instead of this we can understand when pagination comes to the end by empty next_page field. We did not take into account absence of the end_of_stream indicator for this particular stream and always stopped reading at 1st page

Other descendants (Users, Tickets, TicketComments) use start_date as an initial param and then rely on next page cursor value provided by API. These streams were not affected because of design features which is a random luck

How

Upgraded the machanism of how we prepare request for getting next page. The best way to do this is to use url from next_page field which comes in response. The url contains all required properties provided in request as well as updated next page token. Using this we can support all the types of pagination in one place and avoid problems listed before at the same time

Copy link

vercel bot commented Dec 20, 2023

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

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Dec 20, 2023 11:13pm

Copy link
Contributor

github-actions bot commented Dec 20, 2023

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.

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Dec 20, 2023
@roman-yermilov-gl roman-yermilov-gl changed the title Source Zendesk Support: fix pagination for incremetal export streams 🐛Source Zendesk Support: fix pagination for incremetal export streams Dec 20, 2023
@roman-yermilov-gl roman-yermilov-gl marked this pull request as ready for review December 20, 2023 16:31
@octavia-squidington-iv octavia-squidington-iv requested a review from a team December 20, 2023 16:33
@roman-yermilov-gl roman-yermilov-gl merged commit 01e3bbe into master Jan 8, 2024
26 checks passed
@roman-yermilov-gl roman-yermilov-gl deleted the ryermilov/source-zendesk-support-fix-pagination branch January 8, 2024 14:22
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 2024
jatinyadav-cc pushed a commit to ollionorg/datapipes-airbyte that referenced this pull request Feb 26, 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 connectors/source/zendesk-support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants