[Feature] Add filter field support to webhook handlers#3197
Open
vsmityukh wants to merge 5 commits intoShopify:mainfrom
Open
[Feature] Add filter field support to webhook handlers#3197vsmityukh wants to merge 5 commits intoShopify:mainfrom
filter field support to webhook handlers#3197vsmityukh wants to merge 5 commits intoShopify:mainfrom
Conversation
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.
[Feature] Add
filterfield support to webhook handlersWHY are these changes introduced?
Shopify's GraphQL Admin API supports a
filterparameter on webhooksubscriptions (
WebhookSubscriptionInput.filter) that limits whichpayloads get delivered based on a filter expression (e.g.
"title:shoes").The library already supports analogous fields —
includeFieldsandmetafieldNamespaces— butfilterwas never wired up, making itimpossible to use this API capability through the SDK.
WHAT is this pull request doing?
Adds
filter?: stringsupport to webhook handlers, following the exactsame pattern as
includeFieldsandmetafieldNamespaces:types.ts: Addedfilter?: stringtoBaseWebhookHandler(inheritedby all three delivery methods) and to
WebhookCheckResponseNode(the shapereturned by Shopify when listing existing subscriptions)
register.ts:TEMPLATE_GET_HANDLERSnow queries thefilterfield from ShopifybuildHandlerFromNodereadsfilterfrom the existing subscription nodeareHandlerFieldsEqualcomparesfilterwhen deciding whether an updateis needed
buildMutationserializesfilterinto the GraphQL mutation params__tests__/responses.ts: AddedwebhookCheckResponseWithFilterfixture__tests__/register.test.ts: Three new test cases:filterin a create mutation when the handler has it setdocs/reference/webhooks/addHandlers.md: Documented the newfilterparameter with a link to the Shopify API reference
Type of change
Checklist
pnpm changesetto create a draft changelog entry (do NOT update theCHANGELOG.mdfiles manually)