Improve logs when an authentication error happens - Githubissues

Shopify / shopify-cli

Shopify CLI helps you build against the Shopify platform faster.

https://shopify.dev/tools/cli

Other

1.01k stars 201 forks source link

Improve logs when an authentication error happens #2695

Closed karreiro closed 2 years ago

karreiro commented 2 years ago

WHY are these changes introduced?

We've been noticing that the following error is happening with a higher frequency:

You can't use Shopify CLI with development stores if you only have Partner staff member access. If you want to use Shopify CLI to work on a development store, then you should be the store owner or create a staff account on the store.

Thus, this PR introduces a new debug log to provide better instrumentation and help us un understanding the root cause of a possible bug.

WHAT is this pull request doing?

This PR logs the the body of the API error.

How to test your changes?

Add a new user at your store in Settings > Users and permissions screen
Run shopify-dev logout
Run shopify-dev login -s <your_store>
Use the new user at the login
Run shopify-dev theme list
Notice it works
Suspend the new user at Settings > Users and permissions (in the user screen)
Run DEBUG=1 shopify-dev theme list
Notice that new the error is logged

Post-release steps

None.

Update checklist

[x] I've added a CHANGELOG entry for this PR (if the change is public-facing) - It's not a public-facing change
[x] I've considered possible cross-platform impacts (Mac, Linux, Windows).
[x] I've left the version number as is (we'll handle incrementing this when releasing).
[x] I've included any post-release steps in the section above (if needed).