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

fix: (source-shopify) - deprecate an old ProductGraphQL and CustomerSavedSearch streams from the stream catalog #51037

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

bazarnov
Copy link
Collaborator

What

Original Slack thread: https://airbytehq-team.slack.com/archives/C02U9R3AF37/p1736286359890149

We would need to deprecate the ProductGraphQL and CustomerSavedSearch streams completely, since these are using the old deprecated api version (2023-07 and 2022-01 respectively) which are not supported anymore. Moreover, Shopify demands us to stop making API calls using these API versions and move to the 2024-04 at least, which we effectively do by far for all other streams.

How

  • removed references and mentions for ProductGraphQL stream from the source
  • removed references and mentions for CustomerSavedSearch stream from the source

User Impact

This is considered as Breaking change:

  • for those who use the ProductsGraphQL stream - use the Products stream instead (it covers all the fields of an old deprecated stream)
  • for those who use the CustomerSaverSearch there is no alternative at the moment, but there is a chance to re-implement this stream again using GraphQL BULK, once there is a demand from the Customer perspective

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

@bazarnov bazarnov added connectors/source/shopify breaking-change Don't merge me unless you are ready. labels Jan 10, 2025
@bazarnov bazarnov self-assigned this Jan 10, 2025
Copy link

vercel bot commented Jan 10, 2025

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

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 12, 2025 6:00pm

@octavia-squidington-iii octavia-squidington-iii added the area/connectors Connector related issues label Jan 10, 2025
@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Jan 10, 2025
@bazarnov bazarnov requested review from maxi297 and a team January 10, 2025 15:26
@bazarnov bazarnov marked this pull request as ready for review January 10, 2025 15:57
@bazarnov bazarnov requested review from DanyloGL and agarctfi January 10, 2025 15:57
Copy link
Contributor

@maxi297 maxi297 left a comment

Choose a reason for hiding this comment

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

LGTM! Just a couple of small comments. Let's wait for @katmarkham to review this

docs/integrations/sources/shopify-migrations.md Outdated Show resolved Hide resolved
docs/integrations/sources/shopify-migrations.md Outdated Show resolved Hide resolved
@octavia-squidington-iv octavia-squidington-iv requested a review from a team January 10, 2025 20:12
tybernstein
tybernstein previously approved these changes Jan 10, 2025
@tybernstein tybernstein self-requested a review January 10, 2025 20:36
Copy link
Contributor

@tybernstein tybernstein left a comment

Choose a reason for hiding this comment

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

The Migration guide looks good to me with the updates.

@tybernstein tybernstein dismissed their stale review January 10, 2025 20:38

Meant to only approve migration guide, code review still needed

@octavia-squidington-iv octavia-squidington-iv requested a review from a team January 10, 2025 20:39
- `Products Graph QL`
- `Customer Saved Search`

To replace the old `Products Graph QL` use the `Products` instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

don't we have a chart somewhere for this type of change?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not sure I'm aware of any at the moment. I'd appreciate sharing one.

docs/integrations/sources/shopify-migrations.md Outdated Show resolved Hide resolved
docs/integrations/sources/shopify-migrations.md Outdated Show resolved Hide resolved
@octavia-squidington-iv octavia-squidington-iv requested a review from a team January 12, 2025 17:20
@bazarnov
Copy link
Collaborator Author

bazarnov commented Jan 12, 2025

/approve-regression-tests

Check job output.

✅ Approving regression tests

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 breaking-change Don't merge me unless you are ready. connectors/source/shopify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants