This repository has been archived by the owner on Apr 11, 2024. It is now read-only.
Add SDK headers to SF API client #649
Merged
Conversation
This file contains 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
paulomarg
force-pushed
the
add_storefront_client_headers
branch
from
93d1df0
to
5f63649
Compare
cquemin
reviewed
Dec 21, 2022
| JSON = 'application/json', // eslint-disable-line @shopify/typescript/prefer-pascal-case-enums | ||
| GraphQL = 'application/graphql', // eslint-disable-line @shopify/typescript/prefer-pascal-case-enums | ||
| URLEncoded = 'application/x-www-form-urlencoded', // eslint-disable-line @shopify/typescript/prefer-pascal-case-enums | ||
| JSON = 'application/json', |
There was a problem hiding this comment.
Are they no Javascript constant we could use instead of defining them ourselves? I know it would not add much value but I am just cautious redefining things manually as it always open the door to a future mistake
There was a problem hiding this comment.
Unfortunately no, we use @shopify/network for those shared constants. It has pre-defined values for the header names (which we use here), but not for the MIME types :(
There was a problem hiding this comment.
Ah ok I understand worth raising an issue there or even a PR no ? Or do you think thats not the right place for this sort of constant?
cquemin
approved these changes
Dec 22, 2022
melissaluu
reviewed
Jan 3, 2023
paulomarg
force-pushed
the
add_storefront_client_headers
branch
from
899747f
to
7a98b53
Compare
melissaluu
approved these changes
Jan 3, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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?
The Storefront API has been updated to allow a few headers to improve how we track requests to it, and our client should start complying with it.
WHAT is this pull request doing?
Making the override method where we set the headers for the GraphQL client more generic, so that it takes any number of headers, and setting the new headers in the SF API client.
Type of change
Considering this a patch from the perspective of it being a fix for tracking, rather than adding new features for users of this library.
Checklist