bunfig: apply telemetry = false in every command that reads the file

docs/runtime/bunfig.mdx

@@ -18,7 +18,7 @@ To configure Bun's package manager globally, you can also create a `.bunfig.toml
 
 When `XDG_CONFIG_HOME` is set to an absolute path, Bun reads the file there and not the one in `$HOME`.
 
-Only package manager commands (`bun install`, `bun add`, `bun remove`, `bun update`, `bun pm`, `bunx`, and so on) read the global file. If Bun finds both a global and a local `bunfig`, it loads both; keys set in the local file override the same keys in the global file. CLI flags override `bunfig` settings where applicable.
+Only package manager commands (`bun install`, `bun add`, `bun remove`, `bun update`, `bun pm`, `bunx`, and so on) read the global file. If Bun finds both a global and a local `bunfig`, it loads both; keys set in the local file override the same keys in the global file. The exception is [`telemetry`](#telemetry): `telemetry = false` in either file counts. CLI flags override `bunfig` settings where applicable.
 
 Like npm, Bun skips any of these files that it can't read.
 
@@ -111,14 +111,27 @@ Bun supports the following loaders:
 
 ### `telemetry`
 
-The `telemetry` field enables or disables analytics. By default, telemetry is enabled. This setting is equivalent to the `DO_NOT_TRACK` environment variable.
+Set `telemetry = false` to turn off analytics. By default, telemetry is enabled.
 
 We do not currently collect telemetry; this setting only controls anonymous crash reports. We plan to collect information like which Bun APIs are used most or how long `bun build` takes.
 
 ```toml title="bunfig.toml" icon="settings"
 telemetry = false
 ```
 
+A command applies `telemetry = false` from the `bunfig.toml` files it reads, for its own process. `bun <file>`, `bun run`, `bun test` and `bun build` read the one in the working directory, or the `--config` file. Package manager commands read the project's file and the global `.bunfig.toml` (see [Global vs. local](#global-vs-local)). A `bun` process that a script or a test starts reads its own `bunfig.toml`.
+
+The setting does not reach:
+
+- `bun <file>`, `bun run`, `bun test` and `bun build` in another directory, such as a workspace package below the project root
+- those same commands when the key is only in the global `.bunfig.toml`
+- `bunx` and `bun exec`
+- an executable built with `bun build --compile`, which reads `bunfig.toml` only from the directory it is started in
+
+For these, set [`DO_NOT_TRACK=1`](/runtime/environment-variables) in the environment that starts Bun, for example `DO_NOT_TRACK=1 bun test`. Bun does not read `DO_NOT_TRACK` from `.env` files.
+
+`telemetry = true` does not turn the uploads back on. It overrides neither `DO_NOT_TRACK=1` nor, for package manager commands, `telemetry = false` in the global `.bunfig.toml`.
+
 ### `env`
 
 Configure automatic `.env` file loading. Bun loads `.env` files by default. To disable this behavior:

src/analytics/lib.rs

@@ -1,5 +1,5 @@
 use core::fmt;
-use core::sync::atomic::{AtomicU8, AtomicUsize, Ordering};
+use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
 use std::sync::OnceLock;
 
 use bun_core::env_var;
@@ -11,64 +11,21 @@ use bun_core::slice_to_nul;
 
 // ──────────────────────────────────────────────────────────────────────────
 
-/// Enables analytics. This is used by:
-/// - crash_handler's `report` function to anonymously report crashes
-///
-/// Since this field can be `Unknown`, it makes more sense to call `is_enabled`
-/// instead of processing this field directly.
-#[repr(u8)]
-#[derive(Copy, Clone, PartialEq, Eq)]
-pub enum TriState {
-    Yes = 0,
-    No = 1,
-    Unknown = 2,
-}
-
-impl TriState {
-    #[inline]
-    const fn from_u8(v: u8) -> Self {
-        match v {
-            0 => TriState::Yes,
-            1 => TriState::No,
-            _ => TriState::Unknown,
-        }
-    }
-}
-
-static ENABLED: AtomicU8 = AtomicU8::new(TriState::Unknown as u8);
+static CONFIG_OPT_OUT: AtomicBool = AtomicBool::new(false);
 
-fn enabled() -> TriState {
-    TriState::from_u8(ENABLED.load(Ordering::Relaxed))
-}
-pub fn set_enabled(v: TriState) {
-    ENABLED.store(v as u8, Ordering::Relaxed);
+/// For a `telemetry` in a bunfig that is not `true`. Nothing clears it: no config turns reporting back on.
+#[inline]
+pub fn opt_out_by_config() {
+    CONFIG_OPT_OUT.store(true, Ordering::Relaxed);
 }
 
+/// Whether the crash handler may upload a report. Any one opt-out is enough to say no.
 pub fn is_enabled() -> bool {
-    match enabled() {
-        TriState::Yes => !env_var::DO_NOT_TRACK.get().unwrap_or(false),
-        TriState::No => false,
-        TriState::Unknown => {
-            let detected = 'detect: {
-                // `env_var::*.get()` returns `Option<ValueType>` even when a
-                // default exists; `DO_NOT_TRACK` has `default: false`, hence
-                // `.unwrap_or(false)`.
-                if env_var::DO_NOT_TRACK.get().unwrap_or(false) {
-                    break 'detect TriState::No;
-                }
-                if env_var::HYPERFINE_RANDOMIZED_ENVIRONMENT_OFFSET
-                    .get()
-                    .is_some()
-                {
-                    break 'detect TriState::No;
-                }
-                TriState::Yes
-            };
-            set_enabled(detected);
-            debug_assert!(matches!(enabled(), TriState::Yes | TriState::No));
-            enabled() == TriState::Yes
-        }
-    }
+    !CONFIG_OPT_OUT.load(Ordering::Relaxed)
+        && !env_var::DO_NOT_TRACK.get().unwrap_or(false)
+        && env_var::HYPERFINE_RANDOMIZED_ENVIRONMENT_OFFSET
+            .get()
+            .is_none()
 }
 
 // ──────────────────────────────────────────────────────────────────────────

src/bunfig/arguments.rs

@@ -389,7 +389,7 @@ pub enum Above {
 
 /// For `bun lint` and `bun fmt`, which have not found all that is for them in the working directory: has `tool` read the
 /// bunfig.toml of each directory above it, from the nearest, for as long as it wants the next. It is called with the file and
-/// its path from the working directory. Nothing else in these files counts.
+/// its path from the working directory. Nothing else in these files counts, but a `telemetry` that turns crash reports off.
 pub fn load_config_above_for_tool(
     cmd: CommandTag,
     ctx: Context<'_>,

src/bunfig/bunfig.rs

@@ -405,6 +405,15 @@ impl<'a> Parser<'a, '_> {
             self.add_error(json.loc, b"bunfig expects an object { } at the root")?;
         }
 
+        // Read before anything in the file can fail: nothing but `true` leaves crash reports on.
+        let telemetry = match self.counts {
+            Counts::Everything | Counts::OnlyForTheTool => json.get(b"telemetry"),
+            Counts::OnlyInstall => None,
+        };
+        if telemetry.is_some_and(|expr| expr.as_bool() != Some(true)) {
+            bun_analytics::opt_out_by_config();
+        }
+
         if self.counts == Counts::OnlyForTheTool {
             return self.read_for_tool(&json);
         }
@@ -453,13 +462,8 @@ impl<'a> Parser<'a, '_> {
                 self.load_preload(&expr)?;
             }
 
-            if let Some(expr) = json.get(b"telemetry") {
+            if let Some(expr) = telemetry {
                 self.expect(&expr, ExprTag::EBoolean)?;
-                bun_analytics::set_enabled(if expr.as_bool().expect("infallible: type checked") {
-                    bun_analytics::TriState::Yes
-                } else {
-                    bun_analytics::TriState::No
-                });
             }
         }
 

src/runtime/api/crash_handler_jsc.bind.ts

@@ -13,6 +13,7 @@ export const FeatureData = b.dictionary({
 export const crashHandler = b.namespace({
   getMachOImageZeroOffset: { returns: b.f64.optional, length: 1 },
   getFeatureData: { returns: FeatureData, length: 1 },
+  isAnalyticsEnabled: { returns: b.bool },
   segfault: { length: 1 },
   segfaultHoldingThreadSuspendLock: { length: 1 },
   segfaultInDll: { length: 1 },

src/runtime/api/crash_handler_jsc.rs

@@ -259,3 +259,7 @@ pub(crate) fn get_feature_data() -> FeatureData {
         generated_at: bun_core::time::milli_timestamp().max(0) as u64,
     }
 }
+
+pub(crate) fn is_analytics_enabled() -> bool {
+    analytics::is_enabled()
+}

src/runtime/cli/lint_command.rs

@@ -158,7 +158,8 @@ fn run_script(script: &Script) -> Result<Vec<u8>, Vec<u8>> {
         Script::NOT_INHERITED
             .iter()
             .for_each(|name| variables.remove(name));
-        true
+        // The program reads no bunfig.toml, so a `telemetry = false` of this process goes with it in the environment.
+        bun_analytics::is_enabled() || variables.put(b"DO_NOT_TRACK", b"1").is_ok()
     };
     match run_to_end(argv, script.cwd, &adapt, &input)? {
         result if result.is_ok() => Ok(result.stdout),