Shopify / Shopify/shopify-app-template-ruby
GDPR Customers Webhook Controllers Misnamed
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 154
- Forks
- 50
- PR merge metrics
- No merged PRs in 30d
Description
The webhook routes use plural customers to match the webhook topic
post "/customers_data_request", to: "customers_data_request#receive"
post "/customers_redact", to: "customers_redact#receive"
The existing jobs also use plural customers. However, the controller classes are singular CustomerDataRequestController and CustomerRedactController and they both call singular CustomerDataRequestJob and CustomerRedactJob.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the two webhook route declarations for customers_data_request and customers_redact, then trace their controller and job references. Compare the plural route and job naming with the singular controller class names; the work is done when the related webhook references follow one consistent naming scheme.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, backend
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100