@spotlightjs/spotlight 2.6.3 → 2.8.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spotlightjs/spotlight",
   "description": "Spotlight - Sentry for development. Containing the overlay and the sidecar.",
-  "version": "2.6.3",
+  "version": "2.8.0",
   "license": "Apache-2.0",
   "type": "module",
   "files": [
@@ -32,15 +32,17 @@
     }
   },
   "dependencies": {
+    "@sentry/node": "^8.42.0",
     "import-meta-resolve": "^4.1.0",
     "macho-unsign": "^2.0.6",
     "portable-executable-signature": "^2.0.6",
     "postject": "1.0.0-alpha.6",
-    "@spotlightjs/overlay": "2.7.1",
-    "@spotlightjs/sidecar": "1.9.1"
+    "@spotlightjs/overlay": "2.8.1",
+    "@spotlightjs/sidecar": "1.9.3"
   },
   "devDependencies": {
     "@types/node": "^18.19.55",
+    "esbuild": "^0.24.0",
     "typescript": "^5.6.2",
     "vite": "^5.4.11",
     "@spotlightjs/tsconfig": "1.0.1"
@@ -54,7 +56,7 @@
   "scripts": {
     "start": "./bin/run.js",
     "dev": "vite build --watch",
-    "build": "vite build && vite build --config vite.overlay.config.ts && vite build --config vite.binary.config.ts && ./bin/build.js && tsc",
+    "build": "vite build && vite build --config vite.overlay.config.ts && ./build.js && tsc",
     "build:watch": "vite build --watch",
     "yalc:publish": "yalc publish --push --sig --private",
     "clean": "rimraf dist"

package/bin/build.js

@@ -1,144 +0,0 @@
-#!/usr/bin/env node
-import { execFile as execFileCb } from 'node:child_process';
-import { createWriteStream } from 'node:fs';
-import { copyFile, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-import { Readable } from 'node:stream';
-import { finished } from 'node:stream/promises';
-import { promisify } from 'node:util';
-
-import { unsign } from 'macho-unsign';
-import { signatureSet } from 'portable-executable-signature';
-import { inject } from 'postject';
-
-const execFile = promisify(execFileCb);
-
-const DIST_DIR = './dist';
-const ASSETS_DIR = join(DIST_DIR, 'overlay');
-const MANIFEST_NAME = 'manifest.json';
-const MANIFEST_PATH = join(ASSETS_DIR, MANIFEST_NAME);
-const ENTRY_POINT_NAME = 'src/index.html';
-const SEA_CONFIG_PATH = join(DIST_DIR, 'sea-config.json');
-const SPOTLIGHT_BLOB_PATH = join(DIST_DIR, 'spotlight.blob');
-const NODE_VERSION = '22.11.0';
-const PLATFORMS = (process.env.BUILD_PLATFORMS || `${process.platform}-${process.arch}`).split(',').map(p => p.trim());
-const manifest = JSON.parse(await readFile(MANIFEST_PATH));
-const seaConfig = {
-  main: join(DIST_DIR, 'spotlight.cjs'),
-  output: SPOTLIGHT_BLOB_PATH,
-  disableExperimentalSEAWarning: true,
-  useSnapshot: false,
-  useCodeCache: false, // We do cross-compiling so disable this
-  assets: {
-    [MANIFEST_NAME]: MANIFEST_PATH,
-    [ENTRY_POINT_NAME]: join(ASSETS_DIR, ENTRY_POINT_NAME),
-    ...Object.fromEntries(Object.values(manifest).map(entry => [entry.file, join(ASSETS_DIR, entry.file)])),
-  },
-};
-
-async function run(cmd, ...args) {
-  let output;
-  try {
-    output = await execFile(cmd, args, { encoding: 'utf8' });
-  } catch (err) {
-    console.error(`Failed to \`run ${cmd} ${args.join(' ')}\``);
-    console.error(err.stdout);
-    console.error(err.stderr);
-    process.exit(err.code);
-  }
-  if (output.stdout.trim()) {
-    console.log(output.stdout);
-  } else {
-    console.log(`> ${[cmd, ...args].join(' ')}`);
-  }
-  return output.stdout;
-}
-
-async function getNodeBinary(platform, targetPath = DIST_DIR) {
-  const suffix = platform.startsWith('win') ? 'zip' : 'tar.xz';
-  const remoteArchiveName = `node-v${NODE_VERSION}-${platform}.${suffix}`;
-  const url = `https://nodejs.org/dist/v${NODE_VERSION}/${remoteArchiveName}`;
-  const resp = await fetch(url);
-  if (!resp.ok) throw new Error(`Failed to fetch ${url}`);
-  const tmpDir = await mkdtemp(join(tmpdir(), remoteArchiveName));
-  const stream = createWriteStream(join(tmpDir, remoteArchiveName));
-  await finished(Readable.fromWeb(resp.body).pipe(stream));
-  let sourceFile;
-  let targetFile;
-  if (platform.startsWith('win')) {
-    await run('unzip', '-qq', stream.path, '-d', tmpDir);
-    sourceFile = join(tmpDir, `node-v${NODE_VERSION}-${platform}`, 'node.exe');
-    targetFile = join(targetPath, `spotlight-${platform}.exe`);
-    const data = await readFile(sourceFile);
-    const unsigned = signatureSet(data, null);
-    await writeFile(targetFile, Buffer.from(unsigned));
-    console.log('Signature removed from Win PE binary', targetFile);
-  } else {
-    await run('tar', '-xf', stream.path, '-C', tmpDir);
-    sourceFile = join(tmpDir, `node-v${NODE_VERSION}-${platform}`, 'bin', 'node');
-    targetFile = join(targetPath, `spotlight-${platform}`);
-  }
-
-  if (platform.startsWith('darwin')) {
-    const unsigned = unsign(await readFile(sourceFile));
-    await writeFile(targetFile, Buffer.from(unsigned));
-    console.log('Signature removed from macOS binary', targetFile);
-  } else {
-    await copyFile(sourceFile, targetFile);
-  }
-
-  await rm(tmpDir, { recursive: true });
-  return targetFile;
-}
-
-await writeFile(SEA_CONFIG_PATH, JSON.stringify(seaConfig));
-await run(process.execPath, '--experimental-sea-config', SEA_CONFIG_PATH);
-await Promise.all(
-  PLATFORMS.map(async platform => {
-    const nodeBinary = await getNodeBinary(platform);
-    console.log('Injecting spotlight blob into node executable...');
-    await inject(nodeBinary, 'NODE_SEA_BLOB', await readFile(SPOTLIGHT_BLOB_PATH), {
-      sentinelFuse: 'NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2',
-      machoSegmentName: platform.startsWith('darwin') ? 'NODE_SEA' : undefined,
-    });
-    console.log('Created executable', nodeBinary);
-    await run('chmod', '+x', nodeBinary);
-    if (platform.startsWith('darwin')) {
-      const { APPLE_TEAM_ID, APPLE_CERT_PATH, APPLE_CERT_PASSWORD, APPLE_API_KEY_PATH } = process.env;
-      if (!APPLE_TEAM_ID || !APPLE_CERT_PATH || !APPLE_CERT_PASSWORD) {
-        console.warn(
-          "Missing required environment variables for macOS signing, you won't be able to use this binary until you sign it yourself.",
-        );
-        console.info({ APPLE_TEAM_ID, APPLE_CERT_PATH, APPLE_CERT_PASSWORD });
-        return;
-      }
-      console.log(`Signing ${nodeBinary}...`);
-      await run(
-        'rcodesign',
-        'sign',
-        '--team-name',
-        APPLE_TEAM_ID,
-        '--p12-file',
-        APPLE_CERT_PATH,
-        '--p12-password',
-        APPLE_CERT_PASSWORD,
-        '--for-notarization',
-        '-e',
-        join(import.meta.dirname, 'entitlements.plist'),
-        nodeBinary,
-      );
-      if (!APPLE_API_KEY_PATH) {
-        console.warn(
-          "Missing required environment variable for macOS notarization, you won't be able to notarize this binary which will annoy people trying to run it.",
-        );
-        console.info({ APPLE_API_KEY_PATH });
-        return;
-      }
-      const zipFile = `${nodeBinary}.zip`;
-      await run('zip', zipFile, nodeBinary);
-      await run('rcodesign', 'notary-submit', '--api-key-file', APPLE_API_KEY_PATH, '--wait', zipFile);
-      await rm(zipFile);
-    }
-  }),
-);

package/bin/entitlements.plist

@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<!-- This file should be the same as https://github.com/nodejs/node/blob/main/tools/osx-entitlements.plist -->
-<plist version="1.0">
-<dict>
-    <key>com.apple.security.cs.allow-jit</key>
-    <true/>
-    <key>com.apple.security.cs.allow-unsigned-executable-memory</key>
-    <true/>
-    <key>com.apple.security.cs.disable-executable-page-protection</key>
-    <true/>
-    <key>com.apple.security.cs.allow-dyld-environment-variables</key>
-    <true/>
-    <key>com.apple.security.cs.disable-library-validation</key>
-    <true/>
-    <key>com.apple.security.get-task-allow</key>
-    <true/>
-</dict>
-</plist>

package/dist/sea-config.json

@@ -1 +0,0 @@
-{"main":"dist/spotlight.cjs","output":"dist/spotlight.blob","disableExperimentalSEAWarning":true,"useSnapshot":false,"useCodeCache":false,"assets":{"manifest.json":"dist/overlay/manifest.json","src/index.html":"dist/overlay/src/index.html","assets/main.js":"dist/overlay/assets/main.js"}}