[Feature]: Add Logging for Shopify GraphQL Admin API Deprecated Reason #2272
+239
−3
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
|
Just signed the CLA, but can't rerun the workflow. If someone would be able to retrigger it please 🙏 |
lizkenyon
reviewed
Mar 26, 2025
packages/api-clients/graphql-client/src/graphql-client/tests/http-fetch.test.ts
Outdated
Show resolved
Hide resolved
packages/api-clients/graphql-client/src/graphql-client/http-fetch.ts
Outdated
Show resolved
Hide resolved
* Add log and log type for deprecation reason/notice * Add documentation covering the new log type * Allow the logging of any deprecation reason from Shopify GraphQL Admin API requests to allow apps to allow monitoring
jordanfinners
force-pushed
the
feature/log-deprecation-notice
branch
from
f29f111 to
b05d09b
Compare
jordanfinners
changed the title
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?
Currently any deprecation reason / notices won't be logged, and you can't get visibility of them apart from via the Partner Dashboard. This works okay for public apps, but not for custom apps using this library.
Especially with the introduction of the actual deprecated fields in the header, this would be really useful information for app developers
WHAT is this pull request doing?
Extending the existing logger to include a type for logging the graphql deprecation reason / notice.
Type of change
Checklist
pnpm changesetto create a draft changelog entry (do NOT update theCHANGELOG.mdfiles manually)