Fix circular issues with dist/blessed

Author: jdalton

.config/rollup.base.config.mjs

@@ -6,6 +6,7 @@ import commonjsPlugin from '@rollup/plugin-commonjs'
 import jsonPlugin from '@rollup/plugin-json'
 import { nodeResolve } from '@rollup/plugin-node-resolve'
 import replacePlugin from '@rollup/plugin-replace'
+import MagicString from 'magic-string'
 import { readPackageUpSync } from 'read-package-up'
 import rangesIntersect from 'semver/ranges/intersects.js'
 import { purgePolyfills } from 'unplugin-purge-polyfills'
@@ -16,6 +17,7 @@ import {
   readPackageJsonSync
 } from '@socketsecurity/registry/lib/packages'
 import { isRelative } from '@socketsecurity/registry/lib/path'
+import { escapeRegExp } from '@socketsecurity/registry/lib/regexps'
 import { spawnSync } from '@socketsecurity/registry/lib/spawn'
 
 import constants from '../scripts/constants.js'
@@ -53,12 +55,13 @@ const {
   VITEST
 } = constants
 
+export const EXTERNAL_PACKAGES = ['blessed']
+
 export const INLINED_PACKAGES = [
   '@babel/runtime',
-  // 'blessed' package dependencies.
+  // 'blessed-contrib' package dependencies.
   'ansi-escapes',
   'ansi-regex',
-  'blessed',
   'blessed-contrib',
   'bresenham',
   'buffers',
@@ -98,6 +101,7 @@ const checkRequireAssignmentRegExp = new RegExp(
   requireAssignmentsRegExp.source,
   ''
 )
+
 const checkSocketInteropUseRegExp = new RegExp(`\\b${SOCKET_INTEROP}\\b`)
 
 const danglingRequiresRegExp = /^\s*require\(["'].+?["']\);?\r?\n/gm
@@ -106,8 +110,11 @@ const firstUseStrictRegExp = /'use strict';?/
 
 const requireTinyColorsRegExp = /require\(["']tiny-colors["']\)/g
 
+const requireBlessedAssignmentRegExp =
+  /(?<=var +)[$\w]+(?= *= *require\(["']blessed["']\))/
+
 const requireUrlAssignmentRegExp =
-  /(?<=var +)[$\w]+(?= *= *require\('node:url'\))/
+  /(?<=var +)[$\w]+(?= *= *require\(["']node:url["']\))/
 
 const splitUrlRequiresRegExp = /require\(["']u["']\s*\+\s*["']rl["']\)/g
 
@@ -217,7 +224,11 @@ export default function baseConfig(extendConfig = {}) {
       }
       const id = normalizeId(id_)
       const name = getPackageName(id)
-      if (pkgOverrides[name] || isBlessedPackageName(name)) {
+      if (
+        pkgOverrides[name] ||
+        isBlessedPackageName(name) ||
+        EXTERNAL_PACKAGES.includes(name)
+      ) {
         return true
       }
       if (
@@ -404,13 +415,47 @@ export default function baseConfig(extendConfig = {}) {
         find: danglingRequiresRegExp,
         replace: ''
       }),
+      // Replace hoisted requires of ./dist/blessed modules with lazily loaded
+      // variants.
+      {
+        name: 'modify-blessed-requires',
+        renderChunk(code) {
+          const s = new MagicString(code)
+          const varName = requireBlessedAssignmentRegExp.exec(code)?.[0]
+          if (varName) {
+            const varNameAssignmentRegExp = new RegExp(
+              `var\\s+${escapeRegExp(varName)}\\s*=.+`,
+              'g'
+            )
+            let match
+            while ((match = varNameAssignmentRegExp.exec(code)) !== null) {
+              s.overwrite(match.index, match.index + match[0].length, '')
+            }
+            const varNameRegExp = new RegExp(
+              `(?<!var\\s+)\\b${escapeRegExp(varName)}\\b`,
+              'g'
+            )
+            while ((match = varNameRegExp.exec(code)) !== null) {
+              s.overwrite(
+                match.index,
+                match.index + match[0].length,
+                "require('../blessed/lib/blessed')"
+              )
+            }
+          }
+          return {
+            code: s.toString(),
+            map: s.generateMap()
+          }
+        }
+      },
       commonjsPlugin({
         defaultIsModuleExports: true,
         extensions: ['.cjs', '.js', '.ts', `.ts${ROLLUP_ENTRY_SUFFIX}`],
         ignoreDynamicRequires: true,
         ignoreGlobal: true,
         ignoreTryCatch: true,
-        strictRequires: 'auto'
+        strictRequires: true
       }),
       // Wrap require calls with SOCKET_INTEROP helper.
       socketModifyPlugin({

.config/rollup.dist.config.mjs

@@ -16,9 +16,11 @@ import {
 import { isRelative } from '@socketsecurity/registry/lib/path'
 import { naturalCompare } from '@socketsecurity/registry/lib/sorts'
 
-import baseConfig, { INLINED_PACKAGES } from './rollup.base.config.mjs'
+import baseConfig, {
+  EXTERNAL_PACKAGES,
+  INLINED_PACKAGES
+} from './rollup.base.config.mjs'
 import constants from '../scripts/constants.js'
-import socketModifyPlugin from '../scripts/rollup/socket-modify-plugin.js'
 import {
   getPackageName,
   getPackageNameEnd,
@@ -66,9 +68,6 @@ const VENDOR_JS = `${VENDOR}.js`
 const distModuleSyncPath = path.join(rootDistPath, MODULE_SYNC)
 const distRequirePath = path.join(rootDistPath, REQUIRE)
 
-const injectBlessedTermInfoRegExp = /__dirname\s*\+\s*["']\/..\/usr\//g
-const requireBlessedWidgetsRegExp = /require\s*\(\s*["'].\/widgets\//g
-
 const sharedInputs = {
   cli: `${rootSrcPath}/cli.ts`,
   [CONSTANTS]: `${rootSrcPath}/constants.ts`,
@@ -100,16 +99,6 @@ const sharedPlugins = [
       },
       {}
     )
-  }),
-  // Replace 'blessed' this.injectTerminfo calls to point to ./dist/blessed/usr.
-  socketModifyPlugin({
-    find: injectBlessedTermInfoRegExp,
-    replace: "__dirname + '/../blessed/usr/"
-  }),
-  // Replace require calls for 'blessed' widgets to point to ./dist/blessed/lib/widgets.
-  socketModifyPlugin({
-    find: requireBlessedWidgetsRegExp,
-    replace: "require('../blessed/lib/widgets/"
   })
 ]
 
@@ -402,6 +391,9 @@ export default () => {
       }
       const id = normalizeId(id_)
       const name = getPackageName(id)
+      if (EXTERNAL_PACKAGES.includes(name)) {
+        return true
+      }
       if (
         INLINED_PACKAGES.includes(name) ||
         // Inline local src/ modules.

.config/rollup.test.config.mjs

@@ -3,15 +3,39 @@ import replacePlugin from '@rollup/plugin-replace'
 import { isValidPackageName } from '@socketsecurity/registry/lib/packages'
 import { isRelative } from '@socketsecurity/registry/lib/path'
 
-import baseConfig, { INLINED_PACKAGES } from './rollup.base.config.mjs'
+import baseConfig, {
+  EXTERNAL_PACKAGES,
+  INLINED_PACKAGES
+} from './rollup.base.config.mjs'
 import constants from '../scripts/constants.js'
 import {
   getPackageName,
+  getPackageNameEnd,
   isBuiltin,
-  normalizeId
+  normalizeId,
+  resolveId
 } from '../scripts/utils/packages.js'
 
-const { INLINED_SOCKET_CLI_TEST_DIST_BUILD, ROLLUP_EXTERNAL_SUFFIX } = constants
+const {
+  INLINED_SOCKET_CLI_TEST_DIST_BUILD,
+  ROLLUP_EXTERNAL_SUFFIX,
+  SLASH_NODE_MODULES_SLASH
+} = constants
+
+function isAncestorsExternal(id) {
+  let currNmIndex = id.indexOf(SLASH_NODE_MODULES_SLASH)
+  while (currNmIndex !== -1) {
+    const nextNmIndex = id.indexOf(SLASH_NODE_MODULES_SLASH, currNmIndex + 1)
+    const nameStart = currNmIndex + SLASH_NODE_MODULES_SLASH.length
+    const nameEnd = getPackageNameEnd(id, nameStart)
+    const name = id.slice(nameStart, nameEnd)
+    if (INLINED_PACKAGES.includes(name)) {
+      return false
+    }
+    currNmIndex = nextNmIndex
+  }
+  return true
+}
 
 export default () => {
   // Lazily access constants.rootSrcPath
@@ -36,12 +60,15 @@ export default () => {
     // Lazily access constants.SUPPORTS_SYNC_ESM
     ...(constants.SUPPORTS_SYNC_ESM
       ? {
-          external(id_) {
+          external(id_, parentId_) {
             if (id_.endsWith(ROLLUP_EXTERNAL_SUFFIX) || isBuiltin(id_)) {
               return true
             }
             const id = normalizeId(id_)
             const name = getPackageName(id)
+            if (EXTERNAL_PACKAGES.includes(name)) {
+              return true
+            }
             if (
               INLINED_PACKAGES.includes(name) ||
               id.startsWith(rootSrcPath) ||
@@ -52,6 +79,14 @@ export default () => {
             ) {
               return false
             }
+            const parentId = parentId_ ? resolveId(parentId_) : undefined
+            if (parentId && !isAncestorsExternal(parentId)) {
+              return false
+            }
+            const resolvedId = resolveId(id, parentId)
+            if (!isAncestorsExternal(resolvedId)) {
+              return false
+            }
             return true
           }
         }