Create separate package for the sentry stuff

Author: pvdz

.config/rollup.base.config.mjs

@@ -27,6 +27,7 @@ import {
   normalizeId,
   resolveId
 } from '../scripts/utils/packages.js'
+import { envAsBoolean } from '@socketsecurity/registry/lib/env'
 
 const require = createRequire(import.meta.url)
 
@@ -45,6 +46,11 @@ const {
   tsconfigPath
 } = constants
 
+const IS_SENTRY_BUILD = envAsBoolean(process.env['SOCKET_WITH_SENTRY']);
+console.log('IS_SENTRY_BUILD:', IS_SENTRY_BUILD);
+const IS_PUBLISH = envAsBoolean(process.env['SOCKET_IS_PUBLISHED'])
+console.log('IS_PUBLISH:', IS_PUBLISH);
+
 const SOCKET_INTEROP = '_socketInterop'
 
 const constantsSrcPath = path.join(rootSrcPath, `${CONSTANTS}.ts`)
@@ -125,6 +131,33 @@ function isAncestorsExternal(id, depStats) {
   return true
 }
 
+
+function sentryAliasingPlugin() {
+  return {
+    name: 'sentry-alias-plugin',
+    order: 'post',
+    resolveId(source, importer) {
+      // By default use the noop file for crash handler.
+      // When at build-time the `SOCKET_WITH_SENTRY` flag is set, route to use
+      // the Sentry specific files instead.
+      if (source === './initialize-crash-handler') {
+        return IS_SENTRY_BUILD
+          ? `${rootSrcPath}/initialize-sentry.ts`
+          : `${rootSrcPath}/initialize-crash-handler.ts`;
+      }
+
+      if (source === './handle-crash') {
+        return IS_SENTRY_BUILD
+          ? `${rootSrcPath}/handle-crash-with-sentry.ts`
+          : `${rootSrcPath}/handle-crash.ts`;
+      }
+
+      return null;
+    }
+  };
+}
+
+
 export default function baseConfig(extendConfig = {}) {
   const depStats = {
     dependencies: { __proto__: null },
@@ -215,6 +248,7 @@ export default function baseConfig(extendConfig = {}) {
     },
     ...extendConfig,
     plugins: [
+      sentryAliasingPlugin(), // Should go real early.
       customResolver,
       jsonPlugin(),
       tsPlugin({

.config/rollup.dist.config.mjs

@@ -30,6 +30,7 @@ import {
   normalizeId
 } from '../scripts/utils/packages.js'
 import { envAsBoolean } from '@socketsecurity/registry/lib/env'
+import assert from 'node:assert'
 
 const {
   BABEL_RUNTIME,
@@ -48,6 +49,9 @@ const CONSTANTS_JS = `${CONSTANTS}.js`
 const CONSTANTS_STUB_CODE = createStubCode(`../${CONSTANTS_JS}`)
 const VENDOR_JS = `${VENDOR}.js`
 
+const IS_SENTRY_BUILD = envAsBoolean(process.env['SOCKET_WITH_SENTRY']);
+const IS_PUBLISH = envAsBoolean(process.env['SOCKET_IS_PUBLISHED'])
+
 const distConstantsPath = path.join(rootDistPath, CONSTANTS_JS)
 const distModuleSyncPath = path.join(rootDistPath, MODULE_SYNC)
 const distRequirePath = path.join(rootDistPath, REQUIRE)
@@ -112,13 +116,29 @@ function updateDepStatsSync(depStats) {
       delete depStats.dependencies[key]
     }
   }
+
+  console.log('ass:', assert)
+  assert(Object.keys(editablePkgJson?.content?.bin).join(',') === 'socket,socket-npm,socket-npx', 'If this fails, make sure to update the rollup sentry override for .bin to match the regular build!');
+  if (IS_SENTRY_BUILD) {
+    editablePkgJson.content['name'] = '@socketsecurity/socket-with-sentry'
+    editablePkgJson.content['description'] = "CLI tool for Socket.dev, includes Sentry error handling, otherwise identical to the regular `socket` package"
+    editablePkgJson.content['bin'] = {
+      "socket-with-sentry": "bin/cli.js",
+      "socket-npm-with-sentry": "bin/npm-cli.js",
+      "socket-npx-with-sentry": "bin/npx-cli.js"
+    }
+    // Add Sentry as a regular dep for this build
+    depStats.dependencies['@sentry/node'] = '9.1.0';
+  }
+
   depStats.dependencies = toSortedObject(depStats.dependencies)
   depStats.devDependencies = toSortedObject(depStats.devDependencies)
   depStats.esm = toSortedObject(depStats.esm)
   depStats.external = toSortedObject(depStats.external)
   depStats.transitives = toSortedObject(depStats.transitives)
   // Write dep stats.
   writeFileSync(depStatsPath, `${formatObject(depStats)}\n`, 'utf8')
+
   // Update dependencies with additional inlined modules.
   editablePkgJson
     .update({
@@ -128,6 +148,14 @@ function updateDepStatsSync(depStats) {
       }
     })
     .saveSync()
+
+  if (IS_SENTRY_BUILD) {
+    // Replace the name in the package lock too, just in case.
+    const lock = readFileSync('package-lock.json', 'utf8');
+    // Note: this should just replace the first occurrence, even if there are more
+    const lock2 = lock.replace('"name": "socket",', '"name": "@socketsecurity/socket-with-sentry",')
+    writeFileSync('package-lock.json', lock2)
+  }
 }
 
 function versionBanner(_chunk) {
@@ -151,8 +179,8 @@ function versionBanner(_chunk) {
     var SOCKET_CLI_PKG_JSON_VERSION = "${pkgJsonVersion}"
     var SOCKET_CLI_GIT_HASH = "${gitHash}"
     var SOCKET_CLI_BUILD_RNG = "${rng}"
-    var SOCKET_CLI_VERSION = "${pkgJsonVersion}:${gitHash}:${rng}"
-    var SOCKET_PUB = ${envAsBoolean(process.env['SOCKET_IS_PUBLISHED'])}
+    var SOCKET_PUB = ${IS_PUBLISH}
+    var SOCKET_CLI_VERSION = "${pkgJsonVersion}:${gitHash}:${rng}${IS_PUBLISH ? ':pub':''}"
   `.trim().split('\n').map(s => s.trim()).join('\n')
 }
 
@@ -241,7 +269,7 @@ export default () => {
       socketModifyPlugin({
         find: processEnvSocketIsPublishedRegExp,
         // Note: these are going to be bools in JS, not strings
-        replace: () => (envAsBoolean(process.env['SOCKET_IS_PUBLISHED']) ? 'true' : 'false')
+        replace: () => (IS_PUBLISH ? 'true' : 'false')
       }),
       // Replace `process.env.SOCKET_CLI_VERSION` with var ref that rollup
       // adds to the top of each file.

.dep-stats.json

@@ -68,7 +68,6 @@
   "external": {
     "@apideck/better-ajv-errors": "^0.3.6",
     "@npmcli/promise-spawn": "^8.0.2",
-    "@sentry/node": "9.1.0",
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.11.0",
     "browserslist": "4.24.4",

.github/workflows/provenance.yml

@@ -25,3 +25,7 @@ jobs:
       - run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - run: SOCKET_IS_PUBLISHED=1 SOCKET_WITH_SENTRY=1 npm run build:dist
+      - run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}