Fix blessed-contrib inlining (#464)

Author: jdalton

.config/rollup.base.config.mjs

@@ -11,6 +11,7 @@ import typescriptPlugin from '@rollup/plugin-typescript'
 import { purgePolyfills } from 'unplugin-purge-polyfills'
 
 import { readPackageJsonSync } from '@socketsecurity/registry/lib/packages'
+import { escapeRegExp } from '@socketsecurity/registry/lib/regexps'
 import { spawnSync } from '@socketsecurity/registry/lib/spawn'
 
 import constants from '../scripts/constants.js'
@@ -42,7 +43,11 @@ const {
   VITEST
 } = constants
 
-export const EXTERNAL_PACKAGES = ['@socketsecurity/registry', 'blessed']
+export const EXTERNAL_PACKAGES = [
+  '@socketsecurity/registry',
+  'blessed',
+  'blessed-contrib'
+]
 
 const builtinAliases = builtinModules.reduce((o, n) => {
   o[n] = `node:${n}`
@@ -51,10 +56,6 @@ const builtinAliases = builtinModules.reduce((o, n) => {
 
 const danglingRequiresRegExp = /^\s*require\(["'].+?["']\);?\r?\n/gm
 
-// eslint-disable-next-line no-unused-vars
-const blessedRequiresRegExp =
-  /(?<=require\(["'])blessed(?:\/[^"']+)?(?=["']\))/g
-
 const requireTinyColorsRegExp = /require\(["']tiny-colors["']\)/g
 
 const requireUrlAssignmentRegExp =
@@ -101,8 +102,31 @@ export default function baseConfig(extendConfig = {}) {
   const shadowNpmInjectSrcPath = path.join(rootSrcPath, 'shadow/npm/inject.ts')
   const shadowNpmPathsSrcPath = path.join(rootSrcPath, 'shadow/npm/paths.ts')
 
-  const extendPlugins = extendConfig.plugins ?? []
-  const hasPlugin = name => !!extendPlugins.find(p => p.name === name)
+  const extendPlugins = Array.isArray(extendConfig.plugins)
+    ? extendConfig.plugins.slice()
+    : []
+  const extractedPlugins = { __proto__: null }
+  if (extendPlugins.length) {
+    for (const pluginName of [
+      'babel',
+      'commonjs',
+      'json',
+      'node-resolve',
+      'typescript',
+      'unplugin-purge-polyfills'
+    ]) {
+      for (let i = 0, { length } = extendPlugins; i < length; i += 1) {
+        const p = extendPlugins[i]
+        if (p?.name === pluginName) {
+          extractedPlugins[pluginName] = p
+          // Remove from extendPlugins array.
+          extendPlugins.splice(i, 1)
+          length -= 1
+          i -= 1
+        }
+      }
+    }
+  }
 
   const config = {
     input: {
@@ -118,10 +142,17 @@ export default function baseConfig(extendConfig = {}) {
         : {})
     },
     external(id_) {
+      const id = normalizeId(id_)
+      if (id.includes('blessed')) {
+        console.log(
+          id,
+          getPackageName(id),
+          EXTERNAL_PACKAGES.includes(getPackageName(id))
+        )
+      }
       if (id_.endsWith(ROLLUP_EXTERNAL_SUFFIX) || isBuiltin(id_)) {
         return true
       }
-      const id = normalizeId(id_)
       return (
         id.endsWith('.d.cts') ||
         id.endsWith('.d.mts') ||
@@ -142,63 +173,42 @@ export default function baseConfig(extendConfig = {}) {
     },
     ...extendConfig,
     plugins: [
-      ...(hasPlugin('node-resolve')
-        ? []
-        : [
-            nodeResolve({
-              exportConditions: ['node'],
-              extensions: ['.mjs', '.js', '.json', '.ts'],
-              preferBuiltins: true
-            })
-          ]),
-      ...(hasPlugin('json') ? [] : [jsonPlugin()]),
-      ...(hasPlugin('typescript')
-        ? []
-        : [
-            typescriptPlugin({
-              include: ['src/**/*.ts'],
-              noForceEmit: true,
-              outputToFilesystem: true,
-              // Lazily access constants.rootConfigPath.
-              tsconfig: path.join(
-                constants.rootConfigPath,
-                'tsconfig.rollup.json'
-              )
-            })
-          ]),
-      ...(hasPlugin('commonjs')
-        ? []
-        : [
-            commonjsPlugin({
-              defaultIsModuleExports: true,
-              extensions: ['.cjs', '.js'],
-              ignoreDynamicRequires: true,
-              ignoreGlobal: true,
-              ignoreTryCatch: true,
-              strictRequires: true
-            })
-          ]),
-      ...(hasPlugin('babel')
-        ? []
-        : [
-            babelPlugin({
-              babelHelpers: 'runtime',
-              babelrc: false,
-              // Lazily access constants.rootConfigPath.
-              configFile: path.join(
-                constants.rootConfigPath,
-                'babel.config.js'
-              ),
-              extensions: ['.ts', '.js', '.cjs', '.mjs']
-            })
-          ]),
-      ...(hasPlugin('unplugin-purge-polyfills')
-        ? []
-        : [
-            purgePolyfills.rollup({
-              replacements: {}
-            })
-          ]),
+      extractedPlugins['node-resolve'] ??
+        nodeResolve({
+          exportConditions: ['node'],
+          extensions: ['.mjs', '.js', '.json', '.ts'],
+          preferBuiltins: true
+        }),
+      extractedPlugins['json'] ?? jsonPlugin(),
+      extractedPlugins['typescript'] ??
+        typescriptPlugin({
+          include: ['src/**/*.ts'],
+          noForceEmit: true,
+          outputToFilesystem: true,
+          // Lazily access constants.rootConfigPath.
+          tsconfig: path.join(constants.rootConfigPath, 'tsconfig.rollup.json')
+        }),
+      extractedPlugins['commonjs'] ??
+        commonjsPlugin({
+          defaultIsModuleExports: true,
+          extensions: ['.cjs', '.js'],
+          ignoreDynamicRequires: true,
+          ignoreGlobal: true,
+          ignoreTryCatch: true,
+          strictRequires: true
+        }),
+      extractedPlugins['babel'] ??
+        babelPlugin({
+          babelHelpers: 'runtime',
+          babelrc: false,
+          // Lazily access constants.rootConfigPath.
+          configFile: path.join(constants.rootConfigPath, 'babel.config.js'),
+          extensions: ['.ts', '.js', '.cjs', '.mjs']
+        }),
+      extractedPlugins['unplugin-purge-polyfills'] ??
+        purgePolyfills.rollup({
+          replacements: {}
+        }),
       // Inline process.env values.
       replacePlugin({
         delimiters: ['(?<![\'"])\\b', '(?![\'"])'],
@@ -297,12 +307,19 @@ export default function baseConfig(extendConfig = {}) {
         find: danglingRequiresRegExp,
         replace: ''
       }),
-      // Replace require('blessed/lib/widgets/xyz') with require('../blessed/lib/widgets/xyz').
-      // socketModifyPlugin({
-      //   find: blessedRequiresRegExp,
-      //   replace: (id) => `./${id}`
-      // }),
-      ...(extendConfig.plugins ?? [])
+      // Replace requires like require('blessed/lib/widgets/screen') with
+      // require('../blessed/lib/widgets/screen').
+      ...[/*'@socketsecurity/registry',*/ 'blessed', 'blessed-contrib'].map(n => {
+        const requiresRegExp = new RegExp(
+          `(?<=require\\(["'])${escapeRegExp(n)}(?:=(?:\\/[^"']+)?["']\\))`,
+          'g'
+        )
+        return socketModifyPlugin({
+          find: requiresRegExp,
+          replace: id => `./${id}`
+        })
+      }),
+      ...extendPlugins
     ]
   }
 

.config/rollup.dist.config.mjs

@@ -1,11 +1,12 @@
 import assert from 'node:assert'
 import { existsSync, promises as fs } from 'node:fs'
+import os from 'node:os'
 import path from 'node:path'
 import util from 'node:util'
 
 import { glob as tinyGlob } from 'tinyglobby'
 
-import { readJson, writeJson } from '@socketsecurity/registry/lib/fs'
+import { readJson, remove, writeJson } from '@socketsecurity/registry/lib/fs'
 import { toSortedObject } from '@socketsecurity/registry/lib/objects'
 import {
   fetchPackageManifest,
@@ -40,38 +41,38 @@ const SENTRY_NODE = '@sentry/node'
 const SOCKET_DESCRIPTION = 'CLI tool for Socket.dev'
 const SOCKET_DESCRIPTION_WITH_SENTRY = `${SOCKET_DESCRIPTION}, includes Sentry error handling, otherwise identical to the regular \`${SOCKET_CLI_BIN_NAME}\` package`
 
-// eslint-disable-next-line no-unused-vars
-async function copyBlessedWidgets() {
-  // Copy blessed package files to dist.
-  const blessedDestPath = path.join(rootDistPath, 'blessed')
-  const blessedNmPath = path.join(rootPath, 'node_modules/blessed')
-  const folders = ['lib', 'usr', 'vendor']
-  await Promise.all(
-    folders.map(f =>
-      fs.cp(path.join(blessedNmPath, f), path.join(blessedDestPath, f), {
-        recursive: true
-      })
-    )
-  )
+async function copyInitGradle() {
+  const filepath = path.join(rootSrcPath, 'commands/manifest/init.gradle')
+  const destPath = path.join(rootDistPath, 'init.gradle')
+  await fs.copyFile(filepath, destPath)
+}
+
+async function copyPackage(pkgName) {
+  const pkgDestPath = path.join(rootDistPath, pkgName)
+  const pkgNmPath = path.join(rootPath, `node_modules/${pkgName}`)
+  // Copy entire package folder over to dist.
+  await fs.cp(pkgNmPath, pkgDestPath, { recursive: true })
   // Add 'use strict' directive to js files.
   const jsFiles = await tinyGlob(['**/*.js'], {
     absolute: true,
-    cwd: blessedDestPath
+    cwd: pkgDestPath
   })
   await Promise.all(
     jsFiles.map(async p => {
       const content = await fs.readFile(p, 'utf8')
-      await fs.writeFile(p, `'use strict'\n\n${content}`, 'utf8')
+      // Start by trimming the hashbang.
+      const hashbang = /^#!.*(?=\r?\n|$)/.exec(content)?.[0] ?? ''
+      let trimmed = content.slice(hashbang.length).trimStart()
+      // Then, trim "use strict" directive.
+      const useStrict = /^(['"])use strict\1/.exec(trimmed)?.[0] ?? ''
+      trimmed = trimmed.slice(useStrict.length).trimStart()
+      // Add back hashbang and add "use strict" directive.
+      const modded = `${hashbang}${os.EOL}${useStrict ?? "'use strict'"}${os.EOL}${trimmed}`
+      await fs.writeFile(p, modded, 'utf8')
     })
   )
 }
 
-async function copyInitGradle() {
-  const filepath = path.join(rootSrcPath, 'commands/manifest/init.gradle')
-  const destPath = path.join(rootDistPath, 'init.gradle')
-  await fs.copyFile(filepath, destPath)
-}
-
 let _sentryManifest
 async function getSentryManifest() {
   if (_sentryManifest === undefined) {
@@ -215,9 +216,93 @@ export default () =>
         async writeBundle() {
           await Promise.all([
             copyInitGradle(),
-            // copyBlessedWidgets(),
+            // copyPackage('@socketsecurity/registry'),
+            copyPackage('blessed'),
+            copyPackage('blessed-contrib'),
             updatePackageJson()
           ])
+
+          const blessedDestPath = path.join(rootDistPath, 'blessed')
+          const blessedIgnore = [
+            'lib/**',
+            'node_modules/**',
+            'usr/**',
+            'vendor/**',
+            'LICENSE*'
+          ]
+
+          const blessedContribDestPath = path.join(
+            rootDistPath,
+            'blessed-contrib'
+          )
+          const blessedContribIgnore = ['lib/**', 'node_modules/**', 'LICENSE*']
+
+          // Remove directories.
+          await Promise.all([
+            // Remove directories from 'blessed'.
+            ...(
+              await tinyGlob(['**/*'], {
+                absolute: true,
+                onlyDirectories: true,
+                cwd: blessedDestPath,
+                dot: true,
+                ignore: blessedIgnore
+              })
+            ).map(p => remove(p)),
+            // Remove directories from 'contrib'.
+            ...(
+              await tinyGlob(['**/*'], {
+                absolute: true,
+                onlyDirectories: true,
+                cwd: blessedContribDestPath,
+                dot: true,
+                ignore: blessedContribIgnore
+              })
+            ).map(p => remove(p))
+          ])
+
+          // Remove files.
+          await Promise.all([
+            // Remove files from 'blessed'.
+            ...(
+              await tinyGlob(['**/*'], {
+                absolute: true,
+                cwd: blessedDestPath,
+                dot: true,
+                ignore: blessedIgnore
+              })
+            ).map(p => remove(p)),
+            // Remove files from 'blessed-contrib'.
+            ...(
+              await tinyGlob(['**/*'], {
+                absolute: true,
+                cwd: blessedContribDestPath,
+                dot: true,
+                ignore: blessedContribIgnore
+              })
+            ).map(p => remove(p))
+          ])
+
+          await Promise.all([])
+          // Rewire 'blessed' inside 'blessed-contrib'.
+          await Promise.all([
+            ...(
+              await tinyGlob(['**/*.js'], {
+                absolute: true,
+                cwd: blessedContribDestPath,
+                ignore: ['node_modules/**']
+              })
+            ).map(async p => {
+              const relPath = path.relative(path.dirname(p), blessedDestPath)
+              const content = await fs.readFile(p, 'utf8')
+              const modded = content.replace(
+                /(?<=require\(["'])blessed(?=(?:\/[^"']+)?["']\))/g,
+                () => relPath
+              )
+              await fs.writeFile(p, modded, 'utf8')
+            })
+          ])
+
           // Update package-lock.json AFTER package.json.
           await updatePackageLockFile()
         }