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 stream TicketMetricEvents #28612

Conversation

artem1205
Copy link
Collaborator

What

Resolve https://github.com/airbytehq/oncall/issues/2561

How

Keep start_time in request parameters for stream TicketMetricEvents

Recommended reading order

  1. streams.py

🚨 User Impact 🚨

no breaking changes

Pre-merge Actions

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

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.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 24, 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.

@artem1205 artem1205 marked this pull request as ready for review July 24, 2023 13:41
@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Jul 24, 2023
@artem1205 artem1205 self-assigned this Jul 24, 2023
@octavia-squidington-iii
Copy link
Collaborator

source-zendesk-support test report (commit ddf6b1f7db) - ❌

⏲️ Total pipeline duration: 15mn15s

Step Result
Validate airbyte-integrations/connectors/source-zendesk-support/metadata.yaml
Connector version semver check
Connector version increment check
QA checks
Code format checks
Connector package install
Build source-zendesk-support docker image for platform linux/x86_64
Unit tests
Acceptance tests

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-zendesk-support test

@octavia-squidington-iii
Copy link
Collaborator

source-zendesk-support test report (commit 4cf8113655) - ❌

⏲️ Total pipeline duration: 12mn34s

Step Result
Validate airbyte-integrations/connectors/source-zendesk-support/metadata.yaml
Connector version semver check
Connector version increment check
QA checks
Code format checks
Connector package install
Build source-zendesk-support docker image for platform linux/x86_64
Unit tests
Acceptance tests

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-zendesk-support test

@octavia-squidington-iii
Copy link
Collaborator

source-zendesk-support test report (commit a093ef0eb0) - ✅

⏲️ Total pipeline duration: 12mn27s

Step Result
Validate airbyte-integrations/connectors/source-zendesk-support/metadata.yaml
Connector version semver check
Connector version increment check
QA checks
Code format checks
Connector package install
Build source-zendesk-support docker image for platform linux/x86_64
Unit tests
Acceptance tests

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-zendesk-support test

@@ -614,6 +614,20 @@ class TicketMetricEvents(CursorPaginationZendeskSupportStream):
def path(self, **kwargs):
return "incremental/ticket_metric_events"

def request_params(
Copy link
Contributor

Choose a reason for hiding this comment

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

@artem1205 ideally we would have some test coverage for this. Is there a reason it's not covered by integration tests?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

All those stream use the same pagination mechanism implemented in CursorPaginationZendeskSupportStream, and raise Error if start_date IS IN the request_params. But yep, i'll make another test for this particular stream.

Copy link
Contributor

Choose a reason for hiding this comment

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

Okay thanks. It seems that there probably wasn't test coverage for the other streams too, since there wasn't a test failure that alerted us to the issue before the code was merged. So I think it's definitely worthwhile to add it.

@octavia-squidington-iii
Copy link
Collaborator

source-zendesk-support test report (commit 600ca7022a) - ✅

⏲️ Total pipeline duration: 15mn21s

Step Result
Validate airbyte-integrations/connectors/source-zendesk-support/metadata.yaml
Connector version semver check
QA checks
Code format checks
Connector package install
Build source-zendesk-support docker image for platform linux/x86_64
Unit tests
Acceptance tests

🔗 View the logs here

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=source-zendesk-support test

@artem1205 artem1205 merged commit 66b428b into master Jul 25, 2023
22 checks passed
@artem1205 artem1205 deleted the artem1205/source-zendesk-support-fix-pagination-TicketMetricEvents branch July 25, 2023 14:06
@nazifishrak
Copy link

After the update we are getting this error

{"error":"ParameterMissing","description":"Parameter start_time is required"}

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

5 participants