Lazily access new lazy properties

Author: jdalton

.dep-stats.json

@@ -6,7 +6,7 @@
     "@socketregistry/hyrious__bun.lockb": "1.0.6",
     "@socketregistry/yocto-spinner": "^1.0.2",
     "@socketsecurity/config": "^2.1.3",
-    "@socketsecurity/registry": "^1.0.55",
+    "@socketsecurity/registry": "^1.0.56",
     "@socketsecurity/sdk": "^1.3.0",
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.11.0",

package-lock.json

@@ -61,7 +61,7 @@
     "@socketregistry/hyrious__bun.lockb": "1.0.6",
     "@socketregistry/yocto-spinner": "^1.0.2",
     "@socketsecurity/config": "^2.1.3",
-    "@socketsecurity/registry": "^1.0.55",
+    "@socketsecurity/registry": "^1.0.56",
     "@socketsecurity/sdk": "^1.3.0",
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.11.0",

package.json

@@ -4,40 +4,70 @@ const path = require('node:path')
 
 const registryConstants = require('@socketsecurity/registry/lib/constants')
 const {
-  kInternalsSymbol,
   PACKAGE_JSON,
+  kInternalsSymbol,
   [kInternalsSymbol]: { createConstantsObject }
 } = registryConstants
 
 const ROLLUP_ENTRY_SUFFIX = '?commonjs-entry'
 const ROLLUP_EXTERNAL_SUFFIX = '?commonjs-external'
 const SLASH_NODE_MODULES_SLASH = '/node_modules/'
 
-const rootPath = path.resolve(__dirname, '..')
-const rootConfigPath = path.join(rootPath, '.config')
-const rootDistPath = path.join(rootPath, 'dist')
-const rootPackageJsonPath = path.join(rootPath, PACKAGE_JSON)
-const rootSrcPath = path.join(rootPath, 'src')
+const lazyBabelConfigPath = () =>
+  // Lazily access constants.rootConfigPath.
+  path.join(constants.rootConfigPath, 'babel.config.js')
+
+const lazyDepStatsPath = () =>
+  // Lazily access constants.rootPath.
+  path.join(constants.rootPath, '.dep-stats.json')
+
+const lazyRootConfigPath = () =>
+  // Lazily access constants.rootPath.
+  path.join(constants.rootPath, '.config')
+
+const lazyRootDistPath = () =>
+  // Lazily access constants.rootPath.
+  path.join(constants.rootPath, 'dist')
+
+const lazyRootPackageJsonPath = () =>
+  // Lazily access constants.rootPath.
+  path.join(constants.rootPath, PACKAGE_JSON)
+
+const lazyRootPath = () => path.resolve(__dirname, '..')
+
+const lazyRootSrcPath = () =>
+  // Lazily access constants.rootPath.
+  path.join(constants.rootPath, 'src')
 
-const babelConfigPath = path.join(rootConfigPath, 'babel.config.js')
-const depStatsPath = path.join(rootPath, '.dep-stats.json')
-const tsconfigPath = path.join(rootConfigPath, 'tsconfig.rollup.json')
+const lazyTsconfigPath = () =>
+  // Lazily access constants.rootConfigPath.
+  path.join(constants.rootConfigPath, 'tsconfig.rollup.json')
 
 const constants = createConstantsObject(
   {
     ROLLUP_ENTRY_SUFFIX,
     ROLLUP_EXTERNAL_SUFFIX,
     SLASH_NODE_MODULES_SLASH,
-    babelConfigPath,
-    depStatsPath,
-    rootConfigPath,
-    rootDistPath,
-    rootPackageJsonPath,
-    rootPath,
-    rootSrcPath,
-    tsconfigPath
+    babelConfigPath: undefined,
+    depStatsPath: undefined,
+    rootConfigPath: undefined,
+    rootDistPath: undefined,
+    rootPackageJsonPath: undefined,
+    rootPath: undefined,
+    rootSrcPath: undefined,
+    tsconfigPath: undefined
   },
   {
+    getters: {
+      babelConfigPath: lazyBabelConfigPath,
+      depStatsPath: lazyDepStatsPath,
+      rootConfigPath: lazyRootConfigPath,
+      rootDistPath: lazyRootDistPath,
+      rootPackageJsonPath: lazyRootPackageJsonPath,
+      rootPath: lazyRootPath,
+      rootSrcPath: lazyRootSrcPath,
+      tsconfigPath: lazyTsconfigPath
+    },
     mixin: registryConstants
   }
 )

scripts/constants.js

@@ -28,8 +28,8 @@ type Constants = {
 } & typeof registryConstants
 
 const {
-  kInternalsSymbol,
   PACKAGE_JSON,
+  kInternalsSymbol,
   [kInternalsSymbol as unknown as 'Symbol(kInternalsSymbol)']: {
     createConstantsObject
   }
@@ -41,52 +41,87 @@ const NPM_REGISTRY_URL = 'https://registry.npmjs.org'
 const SOCKET_CLI_ISSUES_URL = 'https://github.com/SocketDev/socket-cli/issues'
 const UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE =
   'UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE'
-const ENV: Constants['ENV'] = Object.freeze({
-  ...registryConstants.ENV,
-  // Flag set by the optimize command to bypass the packagesHaveRiskyIssues check.
-  [UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE]: envAsBoolean(
-    process.env[UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE]
-  )
-})
-
-const rootPath = path.resolve(realpathSync(__dirname), '..')
-const rootDistPath = path.join(rootPath, 'dist')
-const rootBinPath = path.join(rootPath, 'bin')
-const rootPkgJsonPath = path.join(rootPath, PACKAGE_JSON)
-const nmBinPath = path.join(rootPath, 'node_modules/.bin')
-const cdxgenBinPath = path.join(nmBinPath, 'cdxgen')
-const shadowBinPath = path.join(rootPath, 'shadow-bin')
-const synpBinPath = path.join(nmBinPath, 'synp')
 
 const LAZY_DIST_TYPE = () =>
   registryConstants.SUPPORTS_NODE_REQUIRE_MODULE ? 'module-sync' : 'require'
 
-const lazyDistPath = () => path.join(rootDistPath, constants.DIST_TYPE)
+const LAZY_ENV = () =>
+  Object.freeze({
+    // Lazily access registryConstants.ENV.
+    ...registryConstants.ENV,
+    // Flag set by the optimize command to bypass the packagesHaveRiskyIssues check.
+    [UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE]: envAsBoolean(
+      process.env[UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE]
+    )
+  })
+
+const lazyCdxgenBinPath = () =>
+  // Lazily access constants.nmBinPath.
+  path.join(constants.nmBinPath, 'cdxgen')
+
+const lazyDistPath = () =>
+  // Lazily access constants.rootDistPath and constants.DIST_TYPE.
+  path.join(constants.rootDistPath, constants.DIST_TYPE)
+
+const lazyNmBinPath = () =>
+  // Lazily access constants.rootPath.
+  path.join(constants.rootPath, 'node_modules/.bin')
+
+const lazyRootBinPath = () =>
+  // Lazily access constants.rootPath.
+  path.join(constants.rootPath, 'bin')
+
+const lazyRootDistPath = () =>
+  // Lazily access constants.rootPath.
+  path.join(constants.rootPath, 'dist')
+
+const lazyRootPath = () => path.resolve(realpathSync(__dirname), '..')
+
+const lazyRootPkgJsonPath = () =>
+  // Lazily access constants.rootPath.
+  path.join(constants.rootPath, PACKAGE_JSON)
+
+const lazyShadowBinPath = () =>
+  // Lazily access constants.rootPath.
+  path.join(constants.rootPath, 'shadow-bin')
+
+const lazySynpBinPath = () =>
+  // Lazily access constants.nmBinPath.
+  path.join(constants.nmBinPath, 'synp')
 
 const constants = <Constants>createConstantsObject(
   {
     API_V0_URL,
     BABEL_RUNTIME,
-    ENV,
+    ENV: undefined,
     // Lazily defined values are initialized as `undefined` to keep their key order.
     DIST_TYPE: undefined,
     NPM_REGISTRY_URL,
     SOCKET_CLI_ISSUES_URL,
     UPDATE_SOCKET_OVERRIDES_IN_PACKAGE_LOCK_FILE,
-    cdxgenBinPath,
+    cdxgenBinPath: undefined,
     distPath: undefined,
-    nmBinPath,
-    rootBinPath,
-    rootDistPath,
-    rootPath,
-    rootPkgJsonPath,
-    shadowBinPath,
-    synpBinPath
+    nmBinPath: undefined,
+    rootBinPath: undefined,
+    rootDistPath: undefined,
+    rootPath: undefined,
+    rootPkgJsonPath: undefined,
+    shadowBinPath: undefined,
+    synpBinPath: undefined
   },
   {
     getters: {
       DIST_TYPE: LAZY_DIST_TYPE,
-      distPath: lazyDistPath
+      ENV: LAZY_ENV,
+      distPath: lazyDistPath,
+      cdxgenBinPath: lazyCdxgenBinPath,
+      nmBinPath: lazyNmBinPath,
+      rootBinPath: lazyRootBinPath,
+      rootDistPath: lazyRootDistPath,
+      rootPath: lazyRootPath,
+      rootPkgJsonPath: lazyRootPkgJsonPath,
+      shadowBinPath: lazyShadowBinPath,
+      synpBinPath: lazySynpBinPath
     },
     mixin: registryConstants
   }

src/constants.ts

@@ -10,9 +10,8 @@ type PromiseSpawnOptions = Exclude<Parameters<typeof spawn>[2], undefined> & {
   encoding?: BufferEncoding | undefined
 }
 
-const { abortSignal, execPath, rootBinPath } = constants
+const { abortSignal } = constants
 
-const entryPath = path.join(rootBinPath, 'cli.js')
 const testPath = __dirname
 const npmFixturesPath = path.join(testPath, 'socket-npm-fixtures')
 
@@ -23,11 +22,15 @@ const spawnOpts: PromiseSpawnOptions = {
 }
 
 describe('Socket cdxgen command', async () => {
+  // Lazily access constants.rootBinPath.
+  const entryPath = path.join(constants.rootBinPath, 'cli.js')
+
   it('should forwards known commands to cdxgen', async () => {
     for (const command of ['-h', '--help']) {
       // eslint-disable-next-line no-await-in-loop
       const ret = await spawn(
-        execPath,
+        // Lazily access constants.execPath.
+        constants.execPath,
         [entryPath, 'cdxgen', command],
         spawnOpts
       )
@@ -38,15 +41,18 @@ describe('Socket cdxgen command', async () => {
     for (const command of ['-u', '--unknown']) {
       // eslint-disable-next-line no-await-in-loop
       await assert.rejects(
-        () => spawn(execPath, [entryPath, 'cdxgen', command], spawnOpts),
+        () =>
+          // Lazily access constants.execPath.
+          spawn(constants.execPath, [entryPath, 'cdxgen', command], spawnOpts),
         e => e?.['stderr']?.startsWith(`Unknown argument: ${command}`),
         'singular'
       )
     }
     await assert.rejects(
       () =>
         spawn(
-          execPath,
+          // Lazily access constants.execPath.
+          constants.execPath,
           [entryPath, 'cdxgen', '-u', '-h', '--unknown'],
           spawnOpts
         ),

test/socket-cdxgen.test.ts

@@ -8,9 +8,8 @@ const { describe, it } = require('node:test')
 const spawn = require('@npmcli/promise-spawn')
 
 const constants = require('../dist/constants.js')
-const { abortSignal, execPath, rootBinPath } = constants
+const { abortSignal } = constants
 
-const entryPath = path.join(rootBinPath, 'cli.js')
 const testPath = __dirname
 const npmFixturesPath = path.join(testPath, 'socket-npm-fixtures')
 
@@ -26,19 +25,27 @@ for (const npm of ['npm8', 'npm10']) {
   })
 
   describe(`Socket npm wrapper for ${npm}`, () => {
+    // Lazily access constants.rootBinPath.
+    const entryPath = path.join(constants.rootBinPath, 'cli.js')
+
     it('should bail on new typosquat', async () => {
       await assert.rejects(
         () =>
-          spawn(execPath, [entryPath, 'npm', 'install', 'bowserify'], {
-            cwd: path.join(npmFixturesPath, 'lacking-typosquat'),
-            encoding: 'utf8',
-            env: {
-              // Make sure we don't borrow TTY from parent.
-              SOCKET_SECURITY_TTY_IPC: undefined,
-              PATH: `${npmBinPath}:${process.env.PATH}`
-            },
-            signal: abortSignal
-          }),
+          spawn(
+            // Lazily access constants.execPath.
+            constants.execPath,
+            [entryPath, 'npm', 'install', 'bowserify'],
+            {
+              cwd: path.join(npmFixturesPath, 'lacking-typosquat'),
+              encoding: 'utf8',
+              env: {
+                // Make sure we don't borrow TTY from parent.
+                SOCKET_SECURITY_TTY_IPC: undefined,
+                PATH: `${npmBinPath}:${process.env.PATH}`
+              },
+              signal: abortSignal
+            }
+          ),
         e => e?.stderr.includes('Unable to prompt')
       )
     })