@spotlightjs/spotlight 2.6.3 → 2.8.0

package/bin/instrument.js

@@ -0,0 +1,38 @@
+import { init } from '@sentry/node';
+
+init({
+  dsn: 'https://51bcd92dba1128934afd1c5726c84442@o1.ingest.us.sentry.io/4508404727283713',
+  environment: process.env.NODE_ENV || 'development',
+  release: process.env.npm_package_version,
+  debug: Boolean(process.env.SENTRY_DEBUG),
+
+  tracesSampleRate: 1,
+
+  beforeSendTransaction: event => {
+    event.server_name = undefined; // Server name might contain PII
+    return event;
+  },
+
+  beforeSend: event => {
+    const exceptions = event.exception?.values;
+    if (!exceptions) {
+      return event;
+    }
+    for (const exception of exceptions) {
+      if (!exception.stacktrace) {
+        continue;
+      }
+
+      for (const frame of exception.stacktrace.frames) {
+        if (!frame.filename) {
+          continue;
+        }
+
+        frame.filename = frame.filename?.replace(process.env.HOME, '~');
+      }
+    }
+
+    event.server_name = undefined; // Server name might contain PII
+    return event;
+  },
+});

package/bin/run.js

@@ -1,10 +1,12 @@
 #!/usr/bin/env node
+import { setContext, startSpan } from '@sentry/node';
 import { setupSidecar } from '@spotlightjs/sidecar';
-import { inflateRawSync } from 'node:zlib';
 import { readFileSync } from 'node:fs';
+import Module from 'node:module';
 import { join } from 'node:path';
 import { fileURLToPath } from 'node:url';
-import Module from 'node:module';
+import { inflateRawSync } from 'node:zlib';
+import './instrument.js';
 const require = Module.createRequire(import.meta.url);
 let sea = null;
 try {
@@ -15,75 +17,102 @@ try {
   sea = { isSea: () => false };
 }
 
-const readAsset = sea.isSea()
-  ? name => Buffer.from(sea.getRawAsset(name))
-  : (() => {
-      const ASSET_DIR = join(fileURLToPath(import.meta.url), '../../dist/overlay/');
+setContext('CLI', {
+  sea: sea.isSea(),
+  // TODO: Be less naive with path obscuring
+  argv: process.argv.map(arg => arg.replace(process.env.HOME, '~')),
+});
+
+const withTracing =
+  (fn, spanArgs = {}) =>
+  (...args) =>
+    startSpan({ name: fn.name, attributes: { args }, ...spanArgs }, () => fn(...args));
+
+const readAsset = withTracing(
+  sea.isSea()
+    ? name => Buffer.from(sea.getRawAsset(name))
+    : (() => {
+        const ASSET_DIR = join(fileURLToPath(import.meta.url), '../../dist/overlay/');
+
+        return name => readFileSync(join(ASSET_DIR, name));
+      })(),
+  { name: 'readAsset', op: 'cli.asset.read' },
+);
 
-      return name => readFileSync(join(ASSET_DIR, name));
-    })();
+startSpan({ name: 'Spotlight CLI', op: 'cli' }, () => {
+  startSpan({ name: 'ASCII Art', op: 'cli.art.ascii' }, () => {
+    const MAX_COLS = process.stdout.columns;
+    if (!process.stdout.isTTY || MAX_COLS < 35) return;
+    let stdoutBuffer = '';
 
-const MAX_COLS = process.stdout.columns;
-if (process.stdout.isTTY && MAX_COLS > 34) {
-  const data = Uint8Array.from(
-    inflateRawSync(
-      Buffer.from(
-        'bY7LCgMxFEK9L5MwDDSL9P//1DJMKGXowoUcUaFZOk8dU2Op9+qZVkYQoFsaEqA6PZxxma1AoMG+TiONTgcfAd741YxxVf8gCzCgWcYB7OSj9sjW7t2/eKxKAxkIYv8NqL3FpVY25CmjrBSuDw==',
-        'base64',
+    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) {
-      process.stdout.write(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) {
-          process.stdout.write(M_COL);
-        } else if (col === lim - 1) {
-          process.stdout.write(F_COL);
-        } else if (col === lim + r) {
-          process.stdout.write(`${RESET}${BOLD}`);
+    );
+    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) {
+        stdoutBuffer += 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) {
+            stdoutBuffer += M_COL;
+          } else if (col === lim - 1) {
+            stdoutBuffer += F_COL;
+          } else if (col === lim + r) {
+            stdoutBuffer += `${RESET}${BOLD}`;
+          }
+          stdoutBuffer += c ? (col >= 35 ? '#' : 's') : ' ';
+          col++;
         }
-        process.stdout.write(c ? (col >= 35 ? '#' : 's') : ' ');
-        col++;
+        c = !c;
       }
-      c = !c;
     }
-  }
-  process.stdout.write(NL);
-}
+    stdoutBuffer += NL;
+    process.stdout.write(stdoutBuffer);
+  });
 
-const port = process.argv.length >= 3 ? Number(process.argv[2]) : undefined;
-const MANIFEST_NAME = 'manifest.json';
-const ENTRY_POINT_NAME = 'src/index.html';
-const basePath = process.cwd();
-const filesToServe = Object.create(null);
+  startSpan({ name: 'Setup Sidecar', op: 'cli.setup.sidecar' }, () => {
+    const port = process.argv.length >= 3 ? Number(process.argv[2]) : undefined;
+    const MANIFEST_NAME = 'manifest.json';
+    const ENTRY_POINT_NAME = 'src/index.html';
+    const basePath = process.cwd();
+    const filesToServe = Object.create(null);
 
-// 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);
-}
-setupSidecar({ port, basePath, filesToServe });
+    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);
+      }
+    });
+
+    setupSidecar({ port, basePath, filesToServe });
+  });
+});