@devdogsuga/devtools 0.1.4 → 0.1.5

package/README.md

@@ -26,11 +26,11 @@ default, in both `pnpm devtools` and `devtools-ci`:
   naming the subcommand that threw (e.g. `db reset`, `deploy platform`).
   Nothing about a successful run is ever sent.
 - **When**: every run, unless `DEVTOOLS_TELEMETRY=0` is set (per-machine or
-  per-job opt-out) — or `DEVTOOLS_SENTRY_DSN` is unset, which is the state of
-  local development until an operator configures one and the state of every
-  environment until the devtools Sentry project exists at all (see the
-  committed placeholder in `src/telemetry.ts`). Either condition means no
-  `Sentry.init()` call happens: no network request, no console output.
+  per-job opt-out) — or the build has no DSN. The DSN is baked in when
+  Backstage's `publish.yaml` builds the package, from the repo's
+  `DEVTOOLS_SENTRY_DSN` Actions variable, so only published builds report;
+  local builds and `pnpm pack:local` tarballs don't. Either condition means
+  no `Sentry.init()` call happens: no network request, no console output.
 - **What's scrubbed**: this CLI touches local `.env` files, so every event
   passes through
   `@devdogsuga/telemetry`'s shared scrubbers before it leaves the process —

package/dist/build-info.json

@@ -0,0 +1,3 @@
+{
+  "sentryDsn": ""
+}

package/dist/telemetry.d.ts

@@ -1,3 +1,5 @@
+/** The run-time `DEVTOOLS_SENTRY_DSN` if set, else the baked one. */
+export declare function resolveDevtoolsDsn(env: NodeJS.ProcessEnv, baked: string): string;
 /**
  * `'ci'` in every GitHub Actions job (`CI` is set by the runner itself,
  * before any workflow-authored env), `'local'` on a contributor's machine.

package/dist/telemetry.js

@@ -7,29 +7,44 @@
  *
  * ## Reporting is on by default
  *
- * Every other `*_SENTRY_DSN` in this workspace is optional-and-empty until
- * an org exists to receive it (see `@devdogsuga/telemetry`'s no-op-without-
- * DSN contract). `DEVTOOLS_SENTRY_DSN` follows the same contract — empty
- * means `buildSentryOptions` returns `undefined` and `Sentry.init` never
- * runs — but the DEFAULT here is reporting ON once a DSN exists, unlike a
- * feature a contributor opts into. `DEVTOOLS_TELEMETRY=0` is the one escape
- * hatch, checked before `Sentry.init` and before every capture call, so it
- * also works as a kill switch after init already ran (a long-lived `pnpm
- * devtools` menu session, for instance).
+ * Every other `*_SENTRY_DSN` in this org is optional-and-empty until
+ * configured (see `@devdogsuga/telemetry`'s no-op-without-DSN contract), and
+ * so is this one — empty means `buildSentryOptions` returns `undefined` and
+ * `Sentry.init` never runs — but the DEFAULT here is reporting ON once a DSN
+ * exists, unlike a feature a contributor opts into. `DEVTOOLS_TELEMETRY=0` is
+ * the one escape hatch, checked before `Sentry.init` and before every capture
+ * call, so it also works as a kill switch after init already ran (a
+ * long-lived `pnpm devtools` menu session, for instance).
  *
- * `PLACEHOLDER_DEVTOOLS_SENTRY_DSN` is committed empty on purpose: the
- * devtools Sentry project does not exist yet. Once it does, either replace
- * this constant with the real ingest DSN or — preferably — set
- * `DEVTOOLS_SENTRY_DSN` in the environment, which always wins over the
- * placeholder. Either way, an empty result here is indistinguishable from
- * "not configured": no init, no network call, no console spam, which is the
- * whole point of shipping this file before the org is onboarded.
+ * ## Where the DSN comes from
+ *
+ * Baked in at build time, not read from the consumer's environment: devtools
+ * runs on contributors' machines, where no `.env` could be relied on to carry
+ * it. `scripts/write-build-info.mjs` writes `dist/build-info.json` from the
+ * build's `DEVTOOLS_SENTRY_DSN`, which Backstage's `publish.yaml` sets from
+ * the repo's Actions variable of the same name. Every other build bakes ""
+ * and reports nothing. `DEVTOOLS_SENTRY_DSN` in the run-time environment still
+ * wins, for pointing a local build at a test project.
  */
+import { readFileSync } from "node:fs";
 import * as Sentry from "@sentry/node";
 import { buildSentryOptions } from "@devdogsuga/telemetry";
-// ⚠️ PLACEHOLDER — see this file's header. Leave empty until the devtools
-// Sentry project exists.
-const PLACEHOLDER_DEVTOOLS_SENTRY_DSN = "";
+import { ownVersion } from "./repo/preflight.js";
+/** The DSN baked into this build, or "" if there is none (a source run under
+ * tsx, or a build made without `DEVTOOLS_SENTRY_DSN`). */
+function bakedSentryDsn() {
+    try {
+        const info = JSON.parse(readFileSync(new URL("./build-info.json", import.meta.url), "utf8"));
+        return typeof info.sentryDsn === "string" ? info.sentryDsn : "";
+    }
+    catch {
+        return "";
+    }
+}
+/** The run-time `DEVTOOLS_SENTRY_DSN` if set, else the baked one. */
+export function resolveDevtoolsDsn(env, baked) {
+    return env.DEVTOOLS_SENTRY_DSN || baked;
+}
 let initialized = false;
 /**
  * `'ci'` in every GitHub Actions job (`CI` is set by the runner itself,
@@ -63,12 +78,13 @@ export function initDevtoolsTelemetry(command) {
     initialized = true;
     if (!devtoolsTelemetryEnabled())
         return;
-    const dsn = process.env.DEVTOOLS_SENTRY_DSN || PLACEHOLDER_DEVTOOLS_SENTRY_DSN;
     const options = buildSentryOptions({
         service: "devtools",
         environment: devtoolsEnvironment(),
-        dsn,
-        release: process.env.SENTRY_RELEASE,
+        dsn: resolveDevtoolsDsn(process.env, bakedSentryDsn()),
+        // The published version, so an issue names the release it came from; a
+        // dlx run has no SENTRY_RELEASE of its own.
+        release: `devtools@${ownVersion()}`,
     });
     if (!options)
         return;

package/env.ts

@@ -121,25 +121,10 @@ declare({
       secrecy: "public",
       commented: true,
     }),
-    // Same contract as the four apps' *_SENTRY_DSN (see
-    // `@devdogsuga/telemetry`'s no-op-without-DSN guarantee): optional,
-    // empty means `src/telemetry.ts` never calls `Sentry.init`. Committed
-    // as a `PLACEHOLDER_DEVTOOLS_SENTRY_DSN` constant in that file until the
-    // devtools Sentry project exists; this variable, when set, always wins
-    // over that placeholder. `scope: "environment"` because the CI job that
-    // reports as `environment: "ci"` needs the same value a contributor's
-    // machine (`environment: "local"`) does -- there is no per-deploy-tier
-    // split the way `DEPLOY_ENV` has, only per-target routing.
-    DEVTOOLS_SENTRY_DSN: define(z.string().url().optional(), {
-      doc:
-        "Sentry ingest DSN for the devtools project. Optional -- empty " +
-        "skips Sentry.init entirely, which is the state before the org is " +
-        "onboarded and the state of local development. See " +
-        "src/telemetry.ts.",
-      scope: "environment",
-      secrecy: "public",
-    }),
-    // Reporting is ON by default once DEVTOOLS_SENTRY_DSN is set -- unlike
+    // No DEVTOOLS_SENTRY_DSN here: the DSN is baked in at publish time, not
+    // configured by the consumer (see src/telemetry.ts).
+    //
+    // Reporting is ON by default in a published build -- unlike
     // every other telemetry surface in this workspace, which a consumer
     // opts INTO by configuring a DSN, this one an operator opts OUT of.
     // `"0"` is the one recognized value; anything else, including unset,
@@ -149,8 +134,7 @@ declare({
     DEVTOOLS_TELEMETRY: define(z.string().optional(), {
       doc:
         'Set to "0" to opt out of devtools\' Sentry error reporting (on by ' +
-        "default whenever DEVTOOLS_SENTRY_DSN is configured). See " +
-        "src/telemetry.ts.",
+        "default in published builds). See src/telemetry.ts.",
       scope: "developer",
       secrecy: "public",
     }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devdogsuga/devtools",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "private": false,
   "type": "module",
   "description": "Contributor CLI for a DevDogsUGA checkout: database, env, images, emails, cron, deploy. Ships built JS; run via `pnpm dlx @devdogsuga/devtools` (or the `devtools`/`devtools-ci` bins once installed) from inside a DevDogsUGA clone.",
@@ -62,13 +62,13 @@
     "@vitest/coverage-v8": "^4.1.11",
     "react": "^19.2.8",
     "vitest": "^4.1.11",
+    "@devdogsuga/brand": "0.1.1",
     "@devdogsuga/config": "0.1.1",
     "@devdogsuga/env": "0.1.1",
-    "@devdogsuga/db": "0.1.1",
-    "@devdogsuga/brand": "0.1.1"
+    "@devdogsuga/db": "0.1.1"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && node scripts/write-build-info.mjs",
     "cli": "node ./bin/devtools.mjs",
     "ci": "node ./dist/ci.js",
     "ci:env": "node ./bin/devtools-ci.mjs",