[Ruby CLIKIT] - Prevent from prompting for analytics in CI #3906
Conversation
This file contains 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
|
Thanks for your contribution! Depending on what you are working on, you may want to request a review from a Shopify team:
|
Coverage report
Test suite run success1649 tests passing in 766 suites. Report generated by 🧪jest coverage report action from f2abb5a |
…rors are found in CLI
jamesmengo
force-pushed
the
jmeng/tty_cli_fix
branch
from
50aaa60
to
f2abb5a
Compare
jamesmengo
added
ruby
2 tasks
|
We detected some changes at either packages/*/src or packages/cli-kit/assets/cli-ruby/** and there are no updates in the .changeset. |
jamesmengo
requested review from
karreiro,
lukeh-shopify,
alvaro-shopify,
mgmanzella,
a team and
gonzaloriestra
and removed request for
a team
lukeh-shopify
approved these changes
May 16, 2024
jamesmengo
commented
May 17, 2024
| @@ -64,6 +64,7 @@ def self.report?(context:) | |||
|
|
|||
| def self.report_error?(context:) | |||
| return false if Environment.development? | |||
| return false unless Environment.interactive? | |||
There was a problem hiding this comment.
For readers - Defaulting to false right now to favour simplicity - given the nature of this code (living in ruby land and out of the critical path), if we see issues with this again we should consider dropping the feature altogether
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.
WHY are these changes introduced?
shopify theme pushshows interactive "send error report" prompt even with SHOPIFY_CLI_TTY=0 #1573WHAT is this pull request doing?
This is a patch that disables prompting for Analytics when exceptions occur in non-interactive terminal environments. This only applies to commands backed by the Ruby CLI (AFAIK the
themesspace is the last area we have left to migrate), so the impact surface is quite limited.We will default to
falsein these environments so we don't opt-in users to send analytics without explicit consent.How to test your changes?
Simulate an error raised from the Theme Access API
raiseto the first line of thecreatemethod here.Run
SHOPIFY_CLI_STACKTRACE=1 SHOPIFY_CLI_TTY=0 SHOPIFY_CLI_THEME_TOKEN=<your_password> SHOPIFY_FLAG_STORE=<your_shop> pnpm shopify theme push --path <path to theme> --stable -u -t "name"The program should exit automatically rather than prompting whether you want to send analytics
Before
After - The stacktrace comes from SHOPIFY_CLI_STACKTRACE=1 and is rendered in the Before after a prompt option is selected
Measuring impact
How do we know this change was effective? Please choose one:
Checklist
devordeployhave been reflected in the internal flowchart.