Send the telemetry event with the CLI token

Delivery now takes its token from cli_token: MAPBOX_CLI_TOKEN, else the
user's login for the run's profile, else the bundled token. This replaces
the telemetry-only MAPBOX_CLI_TELEMETRY_TOKEN.

Author: zmofei

CHANGELOG.md

@@ -256,9 +256,10 @@ that may never merge. They are not releases and are not listed here.
   `mapbox config list` now reports a second key, `history`.
 
 - Each run sends one `cli.command` telemetry event to Mapbox, from a
-  background process the command doesn't wait for. A build from source sends
-  nothing and appends it to `~/.mapbox/.telemetry/<date>.jsonl` instead,
-  kept for 7 days. It never touches stdout, the exit code or how long a
+  background process the command doesn't wait for, with your `mapbox auth
+  login` token or, when you're logged out, one built into the CLI. A build
+  from source has no built-in token, so logged out it appends the event to
+  `~/.mapbox/.telemetry/<date>.jsonl` instead, kept for 7 days. It never touches stdout, the exit code or how long a
   command takes, so a script sees no difference; a CI job does find a
   `.mapbox/.telemetry` directory it didn't before. `MAPBOX_CLI_NO_TELEMETRY=1`
   turns it off.

README.md

@@ -291,9 +291,11 @@ size, and for a JSON body only the field names the API defines), how it
 ended, and how long it took — never a token, a file path or free text you
 typed. It carries a random ID that is replaced on the first run a day after
 it was created. It is sent in the background, so a command never waits for
-it, and dropped if it can't be delivered. A build from source sends nothing
-and keeps the event in `~/.mapbox/.telemetry/<date>.jsonl` (kept for 7 days)
-instead. `MAPBOX_CLI_NO_TELEMETRY=1` turns it off.
+it, and dropped if it can't be delivered. It is sent with your
+`mapbox auth login` token when you're logged in, and with a token built into
+the CLI otherwise. A build from source has no built-in token, so when you're
+logged out it keeps the event in `~/.mapbox/.telemetry/<date>.jsonl` (kept
+for 7 days) instead. `MAPBOX_CLI_NO_TELEMETRY=1` turns it off.
 
 ### Diagnostics and settings
 

src/cli_token.rs

@@ -35,8 +35,6 @@ pub(crate) enum Source {
 
 /// The token a background request should carry, or `None` when there is
 /// nothing to send it with.
-// The first caller is telemetry delivery, which lands separately.
-#[allow(dead_code)]
 pub(crate) fn for_background(profile: Option<&str>) -> Option<String> {
     let override_token = std::env::var("MAPBOX_CLI_TOKEN").ok();
     // Read-only: a background request must not be what creates or
@@ -77,7 +75,6 @@ fn choose(
     usable(bundled).map(|token| (Source::Bundled, token.to_owned()))
 }
 
-#[allow(dead_code)]
 fn now_secs() -> u64 {
     std::time::SystemTime::now()
         .duration_since(std::time::UNIX_EPOCH)

src/telemetry_event.rs

@@ -308,7 +308,8 @@ pub(crate) fn deliver(record: &Record) {
     }
     let event = build(record);
     if let Ok(line) = serde_json::to_string(&event) {
-        telemetry_sink::deliver(&line);
+        let profile = record.options.as_ref().and_then(|o| o.profile.as_deref());
+        telemetry_sink::deliver(&line, profile);
     }
 }
 

src/telemetry_sink.rs

@@ -6,9 +6,10 @@
 //! delivery change — a new endpoint, batching — happen without touching them.
 //!
 //! [`deliver`] is the one place that picks the [`Sink`]. [`HttpSink`] sends
-//! the event to Mapbox Events when this build has somewhere to send it — a
-//! token compiled in, or [`URL_ENV`]. Otherwise [`FileSink`] keeps it on this
-//! machine, which is what `cargo build` and `cargo test` get.
+//! the event to Mapbox Events when there is a token to send it with — from
+//! [`crate::cli_token`] — or a [`URL_ENV`]. Otherwise [`FileSink`] keeps it
+//! on this machine, which is what `cargo test` and a logged-out source build
+//! get.
 //!
 //! It also owns the directory, `~/.mapbox/.telemetry` (or under
 //! `$MAPBOX_CONFIG_DIR`), written only once the config directory exists,
@@ -25,6 +26,7 @@ use reqwest::header::{CONTENT_TYPE, USER_AGENT};
 use serde_json::json;
 
 use crate::auth;
+use crate::cli_token;
 use crate::dated_jsonl;
 use crate::http;
 use crate::telemetry;
@@ -48,19 +50,14 @@ const _: () = assert!(
     "telemetry_sink::ENDPOINT is still staging; switch it to PRODUCTION_ENDPOINT before a production release"
 );
 
-/// The CLI's own `pk.` token for Mapbox Events, compiled into release
-/// builds. Never the user's: the event must not be tied to their account.
-const TOKEN: Option<&str> = option_env!("MAPBOX_CLI_TELEMETRY_TOKEN");
-
 /// Set by [`HttpSink`] on the child it spawns, and read by [`is_send_child`]
 /// at the top of `main` — a mode of this binary rather than a hidden
 /// subcommand, for the reason `update_check` gives.
 const SEND_ENV: &str = "MAPBOX_INTERNAL_TELEMETRY_SEND";
 
-/// The full URL to send to, token included, overriding [`ENDPOINT`] and
-/// [`TOKEN`]. The parent hands it to the child; it is also the seam
-/// `tests/telemetry_events.rs` points at a loopback server, and how a
-/// development build sends to staging without a compiled-in token.
+/// The full URL to send to, token included, overriding [`ENDPOINT`] and the
+/// token. The parent hands it to the child; it is also the seam
+/// `tests/telemetry_events.rs` points at a loopback server.
 const URL_ENV: &str = "MAPBOX_INTERNAL_TELEMETRY_URL";
 
 /// Turns on the delivery log: one line when an event is handed to the child
@@ -151,19 +148,20 @@ impl Sink for HttpSink {
 }
 
 /// Hands `line` to [`HttpSink`] when there is a URL to send to, and to
-/// [`FileSink`] otherwise.
-pub(crate) fn deliver(line: &str) {
-    match send_url() {
+/// [`FileSink`] otherwise. `profile` is the run's `--profile`, whose login
+/// [`crate::cli_token`] may send with.
+pub(crate) fn deliver(line: &str, profile: Option<&str>) {
+    match send_url(profile) {
         Some(url) => HttpSink { url }.deliver(line),
         None => FileSink.deliver(line),
     }
 }
 
-fn send_url() -> Option<String> {
+fn send_url(profile: Option<&str>) -> Option<String> {
     if let Some(url) = from_environment(URL_ENV) {
         return Some(url);
     }
-    TOKEN.map(|token| format!("{ENDPOINT}?access_token={token}"))
+    cli_token::for_background(profile).map(|token| format!("{ENDPOINT}?access_token={token}"))
 }
 
 /// Whether this process is the sender rather than a command.

tests/telemetry_events.rs

@@ -45,6 +45,7 @@ fn command(home: &Path) -> Command {
         .env_remove("MAPBOX_OUTPUT")
         .env_remove("MAPBOX_CLI_NO_TELEMETRY")
         .env_remove("MAPBOX_INTERNAL_TELEMETRY_URL")
+        .env_remove("MAPBOX_CLI_TOKEN")
         .env_remove("MAPBOX_INTERNAL_TELEMETRY_SEND")
         .env_remove("MAPBOX_INTERNAL_TELEMETRY_LOG")
         .env("MAPBOX_NO_UPDATE_CHECK", "1")