Fix declarative webhook generator route path#2073
Open
afurm wants to merge 1 commit intoShopify:mainfrom
Open
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.
What this PR does
Fixes #1977.
This updates the
shopify_app:add_declarative_webhookgenerator so the generated Rails route matches the configured webhook--path.Previously, running:
could add only the basename route under an existing
namespace :webhooks, which meant apps using the default/apiroute scope served/api/webhooks/product_updateinstead of/webhooks/product_update. Shopify then posted to the configured/webhooks/product_updatepath, which could fall through toShopifyApp::WebhooksControllerand raiseShopifyAPI::Errors::NoWebhookHandler.The generator now creates an explicit route for the configured path and inserts it before the root-mounted ShopifyApp engine.
Reviewer's guide to testing
Things to focus on
mount ShopifyApp::Engine, at: "/".Checklist
Before submitting the PR, please consider if any of the following are needed:
CHANGELOG.mdif the changes would impact usersREADME.md, if appropriate./docs, if necessary