feat: migrate source-zendesk-support to scopes object array#74394
Conversation
Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
Note 📝 PR Converted to Draft More info...Thank you for creating this PR. As a policy to protect our engineers' time, Airbyte requires all PRs to be created first in draft status. Your PR has been automatically converted to draft status in respect for this policy. As soon as your PR is ready for formal review, you can proceed to convert the PR to "ready for review" status by clicking the "Ready for review" button at the bottom of the PR page. To skip draft status in future PRs, please include |
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. 💡 Show Tips and TricksPR Slash CommandsAirbyte Maintainers (that's you!) can execute the following slash commands on your PR:
📚 Show Repo GuidanceHelpful Resources
|
|
|
/bump-version |
Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
|
/publish-connectors-prerelease |
|
|
/bump-version
|
Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
|
Deploy preview for airbyte-docs ready! ✅ Preview Built with commit 60fcd20. |
…pport Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
|
Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
|
/publish-connectors-prerelease |
Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
|
/publish-connectors-prerelease |
|
/ai-canary-prerelease
|
🐤 Canary Prerelease Testing: StartingStarting canary prerelease testing for Steps in progress:
Session: https://app.devin.ai/sessions/3e0193c4761c487ebc7135703951c3f3 |
|
Canary Prerelease: Deployment StatusConnector: Breaking Change Evaluation
Deployment Summary
All 8 connections successfully pinned to For full customer details, see the linked private issue. |
Canary Monitoring Update (T+55min, 18:50 UTC)Connector:
Summary: 17 syncs observed, 16 succeeded, 1 currently running, 0 failures. Success rate: 100% (of completed syncs). Two connections (Customer-E-US-1, Customer-F-US-1) have not synced yet since pinning — these appear to be on longer sync schedules. Will continue monitoring. Overall status: ✅ HEALTHY Next update in ~1 hour. Minimum monitoring period: 2 hours total. |
Canary Monitoring Update (T+95min, 19:30 UTC)Connector:
Summary: 26 syncs observed, 23 succeeded, 3 currently running, 0 failures. Success rate: 100% (of completed syncs). 7 of 8 connections have now synced successfully on the prerelease version. Customer-E-US-1 remains idle (likely on a daily or longer schedule). Overall status: HEALTHY Approaching the 2-hour minimum monitoring threshold. Final report to follow shortly. |
Canary Prerelease: Final ReportConnector: SummaryThe prerelease version Detailed Results
Aggregate: 26 syncs observed, 24 completed successfully, 2 in progress, 0 failures. Canary VerdictOverall Status: PASS ✅ The prerelease performed well across all canary connections. No new error patterns, no failures, and no performance degradation observed. Recommend proceeding to formal release. Next steps:
For full customer details, see the linked private issue. |
Canary Handoff: Pinned Connections (for manual cleanup if needed)If this session expires before the PR is merged, the following connections are pinned to
Connector definition ID: A 3-day reminder has been scheduled to check PR status and trigger unpinning. Full connection details (workspace IDs, actor IDs) are available in the Devin session. |
|
|
||
| import MigrationGuide from '@site/static/_migration_guides_upgrade_guide.md'; | ||
|
|
||
| ## Upgrading to 5.2.0 |
There was a problem hiding this comment.
Devin why did you remove this?
There was a problem hiding this comment.
This wasn't me — it was the canary prerelease Devin session (commit 8a246fcf2bf from session). That session also bumped the version from 5.1.8 → 5.2.1, unpinned the CDK pre-release to stable 7.13.0, and removed this migration guide section.
Would you like me to revert that commit?
…igration guide Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
|
Fixed — reverted canary session changes:
|
Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
…e-Release Checks The 5.2.0 entry in the migration guide is not a breaking change but uses the '## Upgrading to X.X.X' heading format reserved for breaking changes. This causes the Pre-Release Checks CI to fail because it validates that migration guide headings match exactly the breakingChanges entries in metadata.yaml (which only lists 1.0.0-5.0.0). The 5.2.0 heading was introduced to master via PR #74789 but was never registered as a breaking change in metadata.yaml. Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
Co-Authored-By: aldo.gonzalez@airbyte.io <aldo.gonzalez@airbyte.io>
…artbeat-timeout Resolve merge conflict in changelog, bump version to 5.2.2 since 5.2.1 was taken by PR #74394. Co-Authored-By: suisui.xia <suisui.xia@airbyte.io>
Canary Prerelease: Cleanup CompleteConnector: All 8 canary connections have been successfully unpinned from
No issues encountered during cleanup. Canary prerelease workflow is now fully complete. |
What
Migrate
source-zendesk-supportOAuth configuration from ascopestring to ascopesarray of objects, as part of the scopes object array rollout.Related:
How
scope: readwithscopes: [{ scope: read }]and updated{{scope_param}}→{{scopes_param}}in bothconsent_urlandaccess_token_url.7.10.2.post5.dev22788068227which includes the protocol model override that preservesscopesfields throughserpyco_rsdeserialization.Review guide
source-zendesk-support/manifest.yaml— scope → scopes migration + template variable update in both OAuth URLssource-zendesk-support/metadata.yaml— CDK pre-release base image pinKey things to verify:
{{scopes_param}}appears in bothconsent_urlandaccess_token_url(Zendesk requires scope in token exchange)User Impact
No user-facing impact yet — requires platform changes (#18705) to be deployed before the new scopes format is active in production. Base image is pinned to a CDK pre-release for local testing.
Can this PR be safely reverted and rolled back?
Link to Devin Session
Requested by: Aldo Gonzalez (@aldogonzalez8)