nylorun 0.4.0-beta → 0.6.0-beta

package/dist/stack/studio-login.js

@@ -1,15 +1,16 @@
 import { STACK_CLIENT_HOST } from "./host-files.js";
-/** Studio's origin as the CLI opens it: always `localhost` (the cookie's host). */
+/** Studio's published origin: always `localhost` (the cookie's host). */
 export function studioOrigin(port) {
     return `http://${STACK_CLIENT_HOST}:${port}`;
 }
 /**
  * Ask the Studio container for a single-use login token with the admin key
- * (`POST /_studio/login-tokens`, Studio §6) and return the URL to open.
+ * (`POST /_studio/login-tokens`, Studio §6) on `origin` (its published port, or
+ * the proxy's `http://<name>.localhost:<port>`) and return the URL to open there.
  * Accepts `{ loginUrl }`, `{ url }` or `{ token }` in the response.
  */
 export async function mintStudioLogin(input) {
-    const origin = studioOrigin(input.studioPort);
+    const { origin } = input;
     const response = await input.fetch(`${origin}/_studio/login-tokens`, {
         method: "POST",
         headers: {
@@ -27,7 +28,7 @@ export async function mintStudioLogin(input) {
     for (const field of ["loginUrl", "url"]) {
         const value = body[field];
         if (typeof value === "string" && value !== "") {
-            // A relative URL is resolved against the published origin.
+            // A relative URL is resolved against the origin it was minted on.
             return new URL(value, origin).toString();
         }
     }

package/dist/stack/versions.d.ts

@@ -3,7 +3,7 @@ export type PinnedImage = "runtime" | "studio";
 /**
  * The version this CLI release pins for an image, from `cli/package.json`
  * `nylorun.runtime` or `nylorun.studio`: the tag of `ghcr.io/nylorun/<name>`
- * the stack runs unless `NYLORUN_RUNTIME_IMAGE` / `NYLORUN_STUDIO_IMAGE`
+ * a local Tenant runs unless `NYLORUN_RUNTIME_IMAGE` / `NYLORUN_STUDIO_IMAGE`
  * overrides it. The release tooling writes both pins.
  */
 export declare function pinnedVersion(name: PinnedImage): string;

package/dist/stack/versions.js

@@ -9,7 +9,7 @@ function cliPackageJsonPath() {
 /**
  * The version this CLI release pins for an image, from `cli/package.json`
  * `nylorun.runtime` or `nylorun.studio`: the tag of `ghcr.io/nylorun/<name>`
- * the stack runs unless `NYLORUN_RUNTIME_IMAGE` / `NYLORUN_STUDIO_IMAGE`
+ * a local Tenant runs unless `NYLORUN_RUNTIME_IMAGE` / `NYLORUN_STUDIO_IMAGE`
  * overrides it. The release tooling writes both pins.
  */
 export function pinnedVersion(name) {

package/dist/telemetry.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Studio's anonymous usage analytics. Studio's dashboard reports page views,
+ * with every id replaced by `:id`, to this Google Analytics property unless the
+ * developer opted out. `nylorun start` decides and passes the id to the
+ * Studio container (`NYLORUN_STUDIO_ANALYTICS_ID`); Studio never decides itself.
+ */
+export declare const STUDIO_ANALYTICS_ID = "G-K6RPDFH6Q6";
+/** `~/.nylorun/telemetry.json`: the developer's choice, for every Tenant on the machine. */
+export interface TelemetryFile {
+    format: 1;
+    /** False after `nylorun telemetry disable`; absent until a choice is made. */
+    enabled?: boolean;
+    /** When `nylorun start` showed the notice (ISO time); it is shown once. */
+    noticeShown?: string;
+}
+export type TelemetryDecision = Readonly<{
+    enabled: boolean;
+    reason: string;
+}>;
+export declare const TELEMETRY_NOTICE: string;
+export declare function telemetryPath(nylorunRoot: string): string;
+export declare function readTelemetry(nylorunRoot: string): Promise<TelemetryFile>;
+export declare function writeTelemetry(nylorunRoot: string, file: TelemetryFile): Promise<void>;
+/** On unless the environment or the developer's choice turns it off. */
+export declare function telemetryDecision(env: Readonly<Record<string, string | undefined>>, file: TelemetryFile): TelemetryDecision;
+/** `nylorun telemetry [status|enable|disable]`. */
+export declare function telemetryCommand(args: readonly string[], context: {
+    nylorunRoot: string;
+    env: Readonly<Record<string, string | undefined>>;
+    out(line: string): void;
+}): Promise<number>;

package/dist/telemetry.js

@@ -0,0 +1,79 @@
+import { randomBytes } from "node:crypto";
+import { mkdir, readFile, rename, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+import { CliError } from "./errors.js";
+/**
+ * Studio's anonymous usage analytics. Studio's dashboard reports page views,
+ * with every id replaced by `:id`, to this Google Analytics property unless the
+ * developer opted out. `nylorun start` decides and passes the id to the
+ * Studio container (`NYLORUN_STUDIO_ANALYTICS_ID`); Studio never decides itself.
+ */
+export const STUDIO_ANALYTICS_ID = "G-K6RPDFH6Q6";
+export const TELEMETRY_NOTICE = [
+    "Studio collects anonymous usage data: which pages are opened, with every",
+    "Tenant, agent and session id removed. Nothing you send to agents is collected.",
+    'Turn it off with "nylorun telemetry disable" or NYLORUN_TELEMETRY_DISABLED=1.',
+    "Learn more: https://github.com/nylorun/agents/blob/main/nylorun/README.md#telemetry",
+].join("\n");
+export function telemetryPath(nylorunRoot) {
+    return join(nylorunRoot, "telemetry.json");
+}
+export async function readTelemetry(nylorunRoot) {
+    try {
+        const parsed = JSON.parse(await readFile(telemetryPath(nylorunRoot), "utf8"));
+        if (parsed && typeof parsed === "object") {
+            const { enabled, noticeShown } = parsed;
+            return {
+                format: 1,
+                ...(typeof enabled === "boolean" ? { enabled } : {}),
+                ...(typeof noticeShown === "string" ? { noticeShown } : {}),
+            };
+        }
+    }
+    catch {
+        /* missing or unreadable: no choice yet */
+    }
+    return { format: 1 };
+}
+export async function writeTelemetry(nylorunRoot, file) {
+    await mkdir(nylorunRoot, { recursive: true });
+    const path = telemetryPath(nylorunRoot);
+    const temporary = `${path}.${randomBytes(8).toString("hex")}.tmp`;
+    await writeFile(temporary, `${JSON.stringify(file, null, 2)}\n`);
+    await rename(temporary, path);
+}
+/** An environment flag is set unless it is empty, `0`, `false` or `no`. */
+function flag(value) {
+    const trimmed = value?.trim() ?? "";
+    return trimmed !== "" && !/^(0|false|no)$/i.test(trimmed);
+}
+/** On unless the environment or the developer's choice turns it off. */
+export function telemetryDecision(env, file) {
+    if (flag(env.NYLORUN_TELEMETRY_DISABLED))
+        return { enabled: false, reason: "NYLORUN_TELEMETRY_DISABLED is set" };
+    if (flag(env.DO_NOT_TRACK))
+        return { enabled: false, reason: "DO_NOT_TRACK is set" };
+    if (flag(env.CI))
+        return { enabled: false, reason: "CI is set" };
+    if (file.enabled === false)
+        return { enabled: false, reason: 'turned off with "nylorun telemetry disable"' };
+    return { enabled: true, reason: "on by default" };
+}
+const USAGE = "Usage: nylorun telemetry [status|enable|disable]";
+/** `nylorun telemetry [status|enable|disable]`. */
+export async function telemetryCommand(args, context) {
+    const [action = "status", ...rest] = args;
+    if (rest.length || !["status", "enable", "disable"].includes(action))
+        throw new CliError(USAGE, 2);
+    const file = await readTelemetry(context.nylorunRoot);
+    if (action !== "status") {
+        const enabled = action === "enable";
+        await writeTelemetry(context.nylorunRoot, { ...file, enabled });
+        context.out(`Studio telemetry ${enabled ? "enabled" : "disabled"}. Running Tenants pick this up on the next "nylorun start".`);
+    }
+    const decision = telemetryDecision(context.env, await readTelemetry(context.nylorunRoot));
+    context.out(`Studio telemetry is ${decision.enabled ? "on" : "off"} (${decision.reason}).`);
+    if (action === "status")
+        context.out(TELEMETRY_NOTICE);
+    return 0;
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "nylorun",
-  "version": "0.4.0-beta",
+  "version": "0.6.0-beta",
   "type": "module",
   "license": "Apache-2.0",
-  "description": "Set up and run the local Nylorun stack (Runtime and Studio) with Docker Compose",
+  "description": "Set up and run local Nylorun Tenants (Runtime and Studio) with Docker Compose",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nylorun/agents.git",
@@ -30,7 +30,7 @@
     "prepack": "npm run build"
   },
   "dependencies": {
-    "@nylorun/core": "0.10.0-beta"
+    "@nylorun/core": "0.11.0-beta"
   },
   "devDependencies": {
     "typescript": "npm:@typescript/typescript6@^6.0.2",
@@ -41,7 +41,7 @@
     "nylorun": "dist/cli.js"
   },
   "nylorun": {
-    "runtime": "0.15.0-beta",
-    "studio": "0.15.0-beta"
+    "runtime": "0.15.2-beta",
+    "studio": "0.17.0-beta"
   }
 }