Repository navigation
Cache the Admin API version list in store execute - #9050
Open
hasandenizuk wants to merge 1 commit into
Open
hasandenizuk wants to merge 1 commit into
hasandenizuk wants to merge 1 commit into
Conversation
store execute looked up the store's API versions on every call. The list only changes when Shopify releases a new version, so cache it per store and token for a day. A requested version missing from the cached list is checked against a fresh list before it is rejected.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Every
shopify store executecall sends aStoreExecutePublicApiVersionsquery before the user's own request, to pick or validate the API version. The version list only changes when Shopify releases a new API version, but scripts that run manystore executecalls pay this extra round trip (about 0.25 s) on every call.WHAT is this pull request doing?
fetchPublicApiVersionsnow passescacheOptions: {cacheTTL: {hours: 24}}tographqlRequest, so the version list is cached for a day. cli-kit's cache key already includes the store URL and a hash of the token, and only successful responses are stored. If a user passes--versionwith a version that is not in the cached list (for example one released today), the version is checked against a fresh, uncached list before the "Invalid API version" error is shown. Includes unit tests and a patch changeset.How to manually test your changes?
Run
shopify store execute --store <store> --query '{ shop { id } }' --verbosetwice. Before: both runs send theStoreExecutePublicApiVersionsrequest. After: the second run does not.Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset add