Encourage scope granting in GraphiQL

[shauns]

WHY are these changes introduced?

When a developer changes the access scopes for their app, and wants to continue to prototype and build, they almost certainly will need the merchant of their dev store -- themselves! -- to grant said access. For the app home, a refresh will do the job with declarative scopes. But lots of building now happens in GraphiQL, and this doesn't have the same behaviour.

WHAT is this pull request doing?

Firstly the token used by GraphiQL is refreshed often now, so its scopes should always be up to date with those granted by the dev store.

This PR adds a couple of helpful nudges:

• if the access scopes in the in-use app toml don't match those that GraphiQL's access token is attempting to use, this is a sign that the developer has changed them. we show a message in the top-bar of GraphiQL encouraging the dev to run shopify app deploy
• after running shopify app deploy, if the developer has changed their access scopes within their newly released app version, we show a next step about granting these new access scopes in their dev store

How to test your changes?

1. Run shopify app dev, and launch GraphiQL
2. Leaving dev running, go to your app toml, and add a new scope, save the file
3. The banner shown above should appear. If you change the scopes back, it will disappear.
4. With changed scopes, run shopify app deploy. Choose to create and release a new version
5. The confirmation message should mention going to your dev store, as per the above

Post-release steps

n/a

Measuring impact

How do we know this change was effective? Please choose one:

• [x] n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
• [ ] Existing analytics will cater for this addition
• [ ] PR includes analytics changes to measure impact

Checklist

• [x] I've considered possible cross-platform impacts (Mac, Linux, Windows)
• [x] I've considered possible documentation changes

[github-actions[bot]]

We detected some changes at either packages/*/src or packages/cli-kit/assets/cli-ruby/** and there are no updates in the .changeset. If the changes are user-facing, run "pnpm changeset add" to track your changes and include them in the next release CHANGELOG.

[github-actions[bot]]

Coverage report

St.:grey_question:	Category	Percentage	Covered / Total
🟡	Statements	72.37% (-0.26% 🔻)	7486/10344
🟡	Branches	69.11% (-0.13% 🔻)	3683/5329
🟡	Functions	71.4% (-0.23% 🔻)	1977/2769
🟡	Lines	72.72% (-0.25% 🔻)	7072/9725

Show files with reduced coverage 🔻

St.:grey_question:	File	Statements	Branches	Functions	Lines
🟡	... / app.ts	78.85% (-7.39% 🔻)	69.14% (-2.29% 🔻)	85.42% (-5.49% 🔻)	79.29% (-8.42% 🔻)
🟢	... / deploy.ts	82.93% (-3.92% 🔻)	76% (-9% 🔻)	87.5%	84.62% (-4.27% 🔻)
🟢	... / identifiers.ts	100%	80% (-20% 🔻)	100%	100%
🔴	... / server.ts	1% (-0.3% 🔻)	0%	0%	1.08% (-0.29% 🔻)
🔴	... / graphiql.tsx	50% (-10% 🔻)	16.67% (-8.33% 🔻)	0%	50% (-10% 🔻)

Test suite run success

1721 tests passing in 794 suites.

Report generated by 🧪jest coverage report action from eba437644b00a537d8fa740dec8ae87d1ded721e

[nickwesselman]

Is it possible to show a different message in GraphiQL when the granted scopes are out of sync with the deployed scopes?

[shauns]

Is it possible to show a different message in GraphiQL when the granted scopes are out of sync with the deployed scopes?

I'm not sure -- we should be able to get at https://shopify.dev/docs/api/admin-graphql/2023-10/objects/App . If requested/available scopes represent the granted and deployed scopes then maybe it's possible?

[shauns]

Is it possible to show a different message in GraphiQL when the granted scopes are out of sync with the deployed scopes?

I'm not sure -- we should be able to get at https://shopify.dev/docs/api/admin-graphql/2023-10/objects/App . If requested/available scopes represent the granted and deployed scopes then maybe it's possible?

Confirmed a comparison to requested might do it. Will look

[github-actions[bot]]

This PR seems inactive. If it's still relevant, please add a comment saying so. Otherwise, take no action. → If there's no activity within a week, then a bot will automatically close this. Thanks for helping to improve Shopify's dev tooling and experience.