chore: request is now mandatory prop createWithCache (2024.10) #376
Conversation
WalkthroughThe changes in this pull request focus on the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
packages/hydrogen/src/weaverse-client.ts (1)
Line range hint
89-108: Consider using structured error handling for better error reportingWhile the error handling improvements are good, consider using a custom error class for better error structure and handling.
Here's a suggested implementation:
+ class WeaverseFetchError extends Error { + constructor( + public status: number, + public statusText: string, + message: string, + cause?: unknown + ) { + super(`${status} ${statusText}: ${message}`, { cause }); + this.name = 'WeaverseFetchError'; + } + } if (!response.ok) { let error = await response.text() let { status, statusText } = response - throw new Error(`${status} ${statusText} ${error}`, { cause: error }) + throw new WeaverseFetchError(status, statusText, error) }This would make it easier to:
- Handle specific error cases
- Provide consistent error structure
- Enable better error reporting and monitoring
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
packages/hydrogen/src/weaverse-client.ts(1 hunks)
🔇 Additional comments (1)
packages/hydrogen/src/weaverse-client.ts (1)
60-60: LGTM: Properly adds mandatory request prop to createWithCache
The change correctly addresses the Hydrogen 2024.10 breaking change by adding the required request parameter to createWithCache.
Let's verify that all instances of createWithCache in the codebase include the request parameter:
✅ Verification successful
✅ All createWithCache calls include the required request parameter
The verification confirms that there is only one instance of createWithCache in the codebase, and it correctly includes the request parameter along with other required props (cache, waitUntil). This implementation aligns with Hydrogen 2024.10's requirements.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for any createWithCache calls that might be missing the request parameter
ast-grep --pattern 'createWithCache({ $$$, request: $_ })'
ast-grep --pattern 'createWithCache({ $$$})'
Length of output: 219
|
Hi @gmilon, Thank you for your contributions to Weaverse! We are currently updating to the latest version of Shopify Hydrogen and plan to release a new version this week. In the meantime, I will proceed with merging the pull request. If you need any assistance from our team, please feel free to reach out via the live chat! Best regards! |
Fix: Update
createWithCacheto Include MandatoryrequestPropSummary
This PR resolves a compatibility issue with the latest Hydrogen version (2024.10). Due to a breaking change, users are unable to update to version 2024.10 without encountering an error related to
createWithCache.Issue
When users attempt to upgrade using:
they encounter the following error:
Root Cause
In the previous version,
requestwas an optional prop forcreateWithCache. As of version 2024.10,requesthas become mandatory during initialization. This change affects how we instantiatecreateWithCache, as omittingrequestwill cause the function to throw aTypeError.For additional details on this breaking change, refer to the release notes:
Hydrogen Release Notes (2024.10.0).
Solution
This PR updates the instantiation of
createWithCacheto include therequestprop, ensuring compatibility with Hydrogen version 2024.10.Testing
createWithCachefunctions correctly with therequestprop included.Summary by CodeRabbit
New Features
Bug Fixes