-
Notifications
You must be signed in to change notification settings - Fork 3.9k
fix(init): honor RTK_TELEMETRY_DISABLED in consent prompt (#1307) #2477
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ousamabenyounes
wants to merge
2
commits into
rtk-ai:develop
Choose a base branch
from
ousamabenyounes:fix/issue-1307
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+60
−3
Open
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -456,6 +456,17 @@ pub fn save_telemetry_consent(accepted: bool) -> Result<()> { | |
| .context("Failed to save telemetry consent to config.toml") | ||
| } | ||
|
|
||
| /// Returns true when telemetry is explicitly disabled through the | ||
| /// `RTK_TELEMETRY_DISABLED` env var (value `"1"`). | ||
| /// | ||
| /// Kept as a small pure function so the consent prompt short-circuits before | ||
| /// touching stdin, and so tests can cover the opt-out path without a TTY. | ||
| /// Mirrors the check in `telemetry::maybe_ping` so both the prompt and the | ||
| /// ping honour the same env toggle. | ||
| fn telemetry_disabled_by_env() -> bool { | ||
| std::env::var("RTK_TELEMETRY_DISABLED").unwrap_or_default() == "1" | ||
| } | ||
|
|
||
| fn prompt_telemetry_consent() -> Result<()> { | ||
| use std::io::{self, BufRead, IsTerminal}; | ||
|
|
||
|
|
@@ -466,6 +477,16 @@ fn prompt_telemetry_consent() -> Result<()> { | |
| None => {} | ||
| } | ||
|
|
||
| // Explicit opt-out must short-circuit before the TTY heuristic: some | ||
| // non-interactive environments (devcontainer `postCreateCommand`, certain | ||
| // CI agents) hand rtk a pseudo-TTY, so `is_terminal()` returns true even | ||
| // though no human is available to answer — the prompt then hangs forever. | ||
| // Setting `RTK_TELEMETRY_DISABLED=1` is the documented workaround, so the | ||
| // init prompt has to honour it too, not only `telemetry::maybe_ping`. | ||
| if telemetry_disabled_by_env() { | ||
| return Ok(()); | ||
| } | ||
|
|
||
| if !io::stdin().is_terminal() { | ||
| return Ok(()); | ||
| } | ||
|
|
@@ -4221,6 +4242,42 @@ mod tests { | |
| ); | ||
| } | ||
|
|
||
| /// Regression for #1307: `RTK_TELEMETRY_DISABLED=1` must short-circuit the | ||
| /// consent prompt so `rtk init` cannot hang in non-interactive environments. | ||
| /// All cases are bundled in one test to serialize env-var mutations (env is | ||
| /// process-global and cargo runs tests in parallel). | ||
| #[test] | ||
| fn test_telemetry_disabled_by_env_honors_opt_out() { | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Those tests should go to telemetry_cmd. After that LGTM! |
||
| const VAR: &str = "RTK_TELEMETRY_DISABLED"; | ||
|
|
||
| #[allow(deprecated)] | ||
| std::env::remove_var(VAR); | ||
| assert!( | ||
| !telemetry_disabled_by_env(), | ||
| "unset env must not count as disabled" | ||
| ); | ||
|
|
||
| #[allow(deprecated)] | ||
| std::env::set_var(VAR, "1"); | ||
| assert!( | ||
| telemetry_disabled_by_env(), | ||
| "RTK_TELEMETRY_DISABLED=1 must disable the consent prompt (issue #1307)" | ||
| ); | ||
|
|
||
| // Only the exact value "1" is the opt-out, matching telemetry::maybe_ping. | ||
| for other in ["0", "true", "false", "yes", "no", ""] { | ||
| #[allow(deprecated)] | ||
| std::env::set_var(VAR, other); | ||
| assert!( | ||
| !telemetry_disabled_by_env(), | ||
| "value {other:?} must not be treated as disabled" | ||
| ); | ||
| } | ||
|
|
||
| #[allow(deprecated)] | ||
| std::env::remove_var(VAR); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_migration_removes_old_block() { | ||
| let input = format!( | ||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.