Add Scopes Update Webhook to Remix Template

allenchazhoor commented 4 weeks ago

WHY are these changes introduced?

Implements Shopify Remix template - Subscribe to the webhook event(s) sent when scopes are updated

This adds the scopes-update webhook to the remix template, to allow the app to be notified and update its local database accordingly when a change in access scopes is made.

WHAT is this pull request doing?

https://github.com/user-attachments/assets/6237fb5c-daf1-4fa7-8310-cdd5318ed349

Test this PR

shopify app init --template=https://github.com/Shopify/shopify-app-template-remix#add-scopes-update-webhook

Follow the instructions here to setup a optional scopes application with scopes revoke capabilities after scaffolding. https://docs.google.com/spreadsheets/d/152j0NUJ-LjGKhgbQ73x_vPvcLJMRlcv7Dsip40dO5yE/edit?gid=1453682373#gid=1453682373

Alter the scopes as you see fit and check that the dev.sqlite file is being adjusted accordingly

Checklist

[x] I have made changes to the README.md file and other related documentation, if applicable
[x] I have added an entry to CHANGELOG.md
[ ] I'm aware I need to create a new release when this PR is merged

lizkenyon commented 3 weeks ago

Hey @allenchazhoor and @RyanDJLee 👋

I would like to learn more about your thoughts on the expected usage of Apps using optional scopes. Will this be something that most public apps can use? Or just a subset?

RyanDJLee commented 3 weeks ago

Hey @allenchazhoor and @RyanDJLee 👋

I would like to learn more about your thoughts on the expected usage of Apps using optional scopes. Will this be something that most public apps can use? Or just a subset?

Just re-posting @byrichardpowell summary from our call today

The webhook is useful for public apps AND partner custom apps.
The webhook is mainly so that the scopes column in the partners database is never wrong.
If the scopes column in the partners database is wrong, that's probably ok, and the app would probably recover.
The webhook doesn't represent a scaling issue, since the webhook is only called when the merchant accesses the app, which may be never.

zzooeeyy commented 3 weeks ago

Hey @allenchazhoor and @RyanDJLee 👋

I would like to learn more about your thoughts on the expected usage of Apps using optional scopes. Will this be something that most public apps can use? Or just a subset?

I'd also like to share that this change is necessary to resolve issues like these:

Shopify / shopify-app-template-remix