[Refactor] Share deliveryMethodInstructions between webhook flags and prompts - #8716
Draft
github-actions[bot] wants to merge 1 commit into
Draft
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
… prompts The function was duplicated byte-for-byte in trigger-flags.ts and prompts/webhook/trigger.ts. Export the service copy and import it in the prompt, which already imports from the same module. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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?
deliveryMethodInstructionsexists twice, byte-for-byte identical: once inpackages/app/src/cli/services/webhook/trigger-flags.tsand once inpackages/app/src/cli/prompts/webhook/trigger.ts. Both copies produce the address-format hints shown when a webhook address doesn't match its delivery method, so the hint text for HTTP, Google Pub/Sub, and Amazon EventBridge has to be kept in sync by hand across two files.WHAT is this pull request doing?
Export the copy in
trigger-flags.tsand delete the one inprompts/webhook/trigger.ts, which already importsDELIVERY_METHODandisAddressAllowedForDeliveryMethodfrom that module. The service file is the right home: it ownsDELIVERY_METHODand is the other caller, viavalidateAddressMethod.The surviving function is unchanged apart from the
exportkeyword and a JSDoc block matching the other exported functions in that file. Both call sites — theAbortErrorhints fromvalidateAddressMethodanddeliveryMethodInstructionsAsStringused byaddressPromptand the command's flag help — get the same strings in the same order as before.How to manually test your changes?
The command should fail with "Can't deliver your webhook payload to this address using 'google-pub-sub'" and the Pub/Sub address hint.
pnpm shopify app webhook trigger --helpshould still list the hints for all three delivery methods.Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset add