@spotlightjs/spotlight 4.2.0 → 4.4.0

package/README.md

@@ -1,5 +1,5 @@
 # `@spotlightjs/spotlight`
 
-This package combines the Overlay from `@spotlightjs/overlay` and the sidecar from `@spotlightjs/sidecar`.
+This package combines the UI from `@spotlightjs/overlay` and the sidecar from `@spotlightjs/sidecar`.
 
-This means, you only need to install one package and you get everything required for Spotlight. Neat!
+This is the package to use for Spotlight.

package/bin/instrument.js

@@ -1,12 +1,72 @@
-import { init } from "@sentry/node";
+import { consoleLoggingIntegration, getClient, init } from "@sentry/node";
+import { parseCLIArgs } from "@spotlightjs/sidecar/cli";
+import { DEFAULT_PORT } from "@spotlightjs/sidecar/constants";
 
-init({
+// Parse CLI arguments to determine the port this Spotlight instance will use
+const { port: instancePort } = parseCLIArgs();
+
+// Check if SENTRY_SPOTLIGHT points to this instance
+const spotlightEnv = process.env.SENTRY_SPOTLIGHT;
+let disableSpotlight = false;
+
+// Note: If port is set to 0 (dynamic port assignment), we cannot detect the actual port
+// before starting the server, so we cannot prevent the feedback loop in that case.
+// The server will be assigned a port by the OS after it starts, and if SENTRY_SPOTLIGHT
+// happens to point to that same port, a feedback loop may occur.
+if (spotlightEnv && instancePort !== 0) {
+  let targetPort;
+  let targetHost;
+
+  // SENTRY_SPOTLIGHT can be:
+  // 1. A full URL like "http://localhost:8969"
+  // 2. A truthy value (true, t, y, yes, on, 1) which means use the default URL
+  const TRUTHY_ENV_VALUES = new Set(["true", "t", "y", "yes", "on", "1"]);
+  const isTruthy = TRUTHY_ENV_VALUES.has(spotlightEnv.toLowerCase());
+
+  if (isTruthy) {
+    // Use default Spotlight URL
+    targetHost = "localhost";
+    targetPort = DEFAULT_PORT;
+  } else {
+    // Try to parse as URL
+    try {
+      const spotlightUrl = new URL(spotlightEnv);
+      targetHost = spotlightUrl.hostname;
+      targetPort = spotlightUrl.port ? Number(spotlightUrl.port) : spotlightUrl.protocol === "https:" ? 443 : 80;
+    } catch (_err) {
+      // If we can't parse it, we can't determine if it's a feedback loop, so do nothing
+      targetPort = null;
+    }
+  }
+
+  // Only disable if we successfully determined the target and it matches our instance
+  if (targetPort !== null && targetPort !== undefined) {
+    const isLocalhost = targetHost === "localhost" || targetHost === "127.0.0.1" || targetHost === "::1";
+
+    if (isLocalhost && targetPort === instancePort) {
+      disableSpotlight = true;
+      console.warn(
+        `⚠️  [Spotlight] SENTRY_SPOTLIGHT is set to ${spotlightEnv} which points to this Spotlight instance (port ${instancePort}). Disabling Spotlight integration to prevent feedback loop.`,
+      );
+    }
+  }
+}
+
+const sentry = init({
   dsn: "https://51bcd92dba1128934afd1c5726c84442@o1.ingest.us.sentry.io/4508404727283713",
   environment: process.env.NODE_ENV || "development",
   release: `spotlight@${process.env.npm_package_version}`,
   debug: Boolean(process.env.SENTRY_DEBUG),
 
   tracesSampleRate: 1,
+  enableLogs: true,
+  ...(disableSpotlight && { spotlight: false }),
+
+  integrations: [
+    consoleLoggingIntegration({
+      levels: ["log", "info", "warn", "error", "debug"],
+    }),
+  ],
 
   beforeSendTransaction: event => {
     event.server_name = undefined; // Server name might contain PII
@@ -37,3 +97,11 @@ init({
     return event;
   },
 });
+
+function shutdown() {
+  sentry.close();
+}
+
+process.on("SIGINT", shutdown);
+process.on("SIGTERM", shutdown);
+// process.on("beforeExit", shutdown);

package/bin/run.js

@@ -3,9 +3,8 @@ import { readFileSync } from "node:fs";
 import Module from "node:module";
 import { join } from "node:path";
 import { fileURLToPath } from "node:url";
-import { inflateRawSync } from "node:zlib";
 import { setContext, startSpan } from "@sentry/node";
-import { parseCLIArgs, setupSidecar } from "@spotlightjs/sidecar";
+import { main } from "@spotlightjs/sidecar/cli";
 import "./instrument.js";
 const require = Module.createRequire(import.meta.url);
 let sea = null;
@@ -21,134 +20,44 @@ const homeDir = process.env.HOME || process.env.USERPROFILE;
 setContext("CLI", {
   sea: sea.isSea(),
   // TODO: Be less naive with path obscuring
-  argv: process.argv.map((arg) => arg.replace(homeDir, "~")),
+  argv: process.argv.map(arg => arg.replace(homeDir, "~")),
 });
 
 const withTracing =
   (fn, spanArgs = {}) =>
   (...args) =>
-    startSpan({ name: fn.name, attributes: { args }, ...spanArgs }, () =>
-      fn(...args)
-    );
+    startSpan({ name: fn.name, attributes: { args }, ...spanArgs }, () => fn(...args));
 
 const readAsset = withTracing(
   sea.isSea()
-    ? (name) => Buffer.from(sea.getRawAsset(name))
+    ? name => Buffer.from(sea.getRawAsset(name))
     : (() => {
-        const ASSET_DIR = join(
-          fileURLToPath(import.meta.url),
-          "../../dist/overlay/"
-        );
+        const ASSET_DIR = join(fileURLToPath(import.meta.url), "../../dist/overlay/");
 
-        return (name) => readFileSync(join(ASSET_DIR, name));
+        return name => readFileSync(join(ASSET_DIR, name));
       })(),
-  { name: "readAsset", op: "cli.asset.read" }
+  { name: "readAsset", op: "cli.asset.read" },
 );
 
 startSpan({ name: "Spotlight CLI", op: "cli" }, async () => {
-  startSpan({ name: "ASCII Art", op: "cli.art.ascii" }, () => {
-    const MAX_COLS = process.stderr.columns;
-    if (!process.stderr.isTTY || MAX_COLS < 35) return;
-    let stderrBuffer = "";
-
-    const data = startSpan(
-      { name: "Inflate ASCII Art Data", op: "cli.art.ascii.inflate" },
-      () =>
-        Uint8Array.from(
-          inflateRawSync(
-            Buffer.from(
-              "bY7LCgMxFEK9L5MwDDSL9P//1DJMKGXowoUcUaFZOk8dU2Op9+qZVkYQoFsaEqA6PZxxma1AoMG+TiONTgcfAd741YxxVf8gCzCgWcYB7OSj9sjW7t2/eKxKAxkIYv8NqL3FpVY25CmjrBSuDw==",
-              "base64"
-            )
-          )
-        )
-    );
-    const E = "\x1b[";
-    const C = `${E}38;5;`;
-    const M_COL = `${C}96m`;
-    const F_COL = `${C}61m`;
-    const BOLD = `${E}1m`;
-    const RESET = `${E}0m`;
-    const NL = `${RESET}\n`;
-    let factor = 0.22;
-    let c = 0;
-    let col = 0;
-    let line = 0;
-    let lim = 26;
-    let r = 0;
-    for (let p of data) {
-      if (p === 255) {
-        stderrBuffer += NL;
-        c = col = 0;
-        if (line++ === 5) {
-          factor = factor / -3;
-        }
-        lim = Math.round(lim * (1 + factor));
-        r = Math.round(Math.random() * 18);
-      } else {
-        while (p-- >= 0 && col < MAX_COLS) {
-          if (col < lim - 1) {
-            stderrBuffer += M_COL;
-          } else if (col === lim - 1) {
-            stderrBuffer += F_COL;
-          } else if (col === lim + r) {
-            stderrBuffer += `${RESET}${BOLD}`;
-          }
-          stderrBuffer += c ? (col >= 35 ? "#" : "s") : " ";
-          col++;
-        }
-        c = !c;
-      }
-    }
-    stderrBuffer += NL;
-    process.stderr.write(stderrBuffer);
-  });
-
-  await startSpan(
-    { name: "Setup Sidecar", op: "cli.setup.sidecar" },
-    async () => {
-      const args = parseCLIArgs();
-      if (args.help) {
-        console.log(`
-Usage: spotlight [options]
-
-Options:
-  -p, --port <port>    Port to listen on (default: 8969)
-  --stdio-mcp          Enable MCP stdio transport
-  -d, --debug          Enable debug logging
-  -h, --help           Show this help message
-
-Examples:
-  spotlight                    # Start on default port 8969
-  spotlight --port 3000        # Start on port 3000
-  spotlight -p 3000 -d         # Start on port 3000 with debug logging
-`);
-        process.exit(0);
+  await startSpan({ name: "Setup Sidecar", op: "cli.setup.sidecar" }, async () => {
+    const MANIFEST_NAME = "manifest.json";
+    const ENTRY_POINT_NAME = "src/index.html";
+    const filesToServe = Object.create(null);
+
+    startSpan({ name: "Setup Server Assets", op: "cli.setup.sidecar.assets" }, () => {
+      // Following the guide here: https://vite.dev/guide/backend-integration.html
+      const manifest = JSON.parse(readAsset(MANIFEST_NAME));
+      filesToServe[ENTRY_POINT_NAME] = readAsset(ENTRY_POINT_NAME);
+      const entries = Object.values(manifest);
+      for (const entry of entries) {
+        filesToServe[entry.file] = readAsset(entry.file);
       }
-      const MANIFEST_NAME = "manifest.json";
-      const ENTRY_POINT_NAME = "src/index.html";
-      const basePath = process.cwd();
-      const filesToServe = Object.create(null);
+    });
 
-      startSpan(
-        { name: "Setup Server Assets", op: "cli.setup.sidecar.assets" },
-        () => {
-          // Following the guide here: https://vite.dev/guide/backend-integration.html
-          const manifest = JSON.parse(readAsset(MANIFEST_NAME));
-          filesToServe[ENTRY_POINT_NAME] = readAsset(ENTRY_POINT_NAME);
-          const entries = Object.values(manifest);
-          for (const entry of entries) {
-            filesToServe[entry.file] = readAsset(entry.file);
-          }
-        }
-      );
-
-      await setupSidecar({
-        ...args,
-        basePath,
-        filesToServe,
-        isStandalone: true,
-      });
-    }
-  );
+    await main({
+      basePath: process.cwd(),
+      filesToServe,
+    });
+  });
 });