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

Update the createWithCache docs to warn about caching errors #2373

Merged
merged 2 commits into from
Jul 29, 2024

Conversation

blittle
Copy link
Contributor

@blittle blittle commented Jul 26, 2024

WHY are these changes introduced?

In the createWithCache callback, if the user does not throw when a 3p request fails, the result will be cached. This PR adds a warning to the docs.

HOW to test your changes?

Guide changes - https://shopify-dev.shopify-dev-68tf.bret-little.us.spin.dev/docs/storefronts/headless/hydrogen/data-fetching/third-party#step-1-create-a-new-third-party-api-client
Reference docs changes - https://shopify-dev.shopify-dev-68tf.bret-little.us.spin.dev/docs/api/hydrogen/2024-07/utilities/caching/createwithcache

Post-merge steps

Checklist

  • I've read the Contributing Guidelines
  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've added a changeset if this PR contains user-facing or noteworthy changes
  • I've added tests to cover my changes
  • I've added or updated the documentation

Copy link
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset.
If the changes are user-facing and should cause a version bump, run npm run changeset add to track your changes and include them in the next release CHANGELOG.
If you are making simple updates to examples or documentation, you do not need to add a changeset.

Copy link
Contributor

shopify bot commented Jul 26, 2024

Oxygen deployed a preview of your bl-fix-3p-docs branch. Details:

Storefront Status Preview link Deployment details Last update (UTC)
third-party-queries-caching ✅ Successful (Logs) Preview deployment Inspect deployment July 26, 2024 9:03 PM
metaobjects ✅ Successful (Logs) Preview deployment Inspect deployment July 26, 2024 9:03 PM
classic-remix ✅ Successful (Logs) Preview deployment Inspect deployment July 26, 2024 9:03 PM
optimistic-cart-ui ✅ Successful (Logs) Preview deployment Inspect deployment July 26, 2024 9:03 PM
Skeleton (skeleton.hydrogen.shop) ✅ Successful (Logs) Preview deployment Inspect deployment July 26, 2024 9:03 PM
custom-cart-method ✅ Successful (Logs) Preview deployment Inspect deployment July 26, 2024 9:03 PM

Learn more about Hydrogen's GitHub integration.

@blittle blittle merged commit 6e057af into main Jul 29, 2024
13 checks passed
@blittle blittle deleted the bl-fix-3p-docs branch July 29, 2024 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants