npm - @ms-cloudpack/esm-stub-utilities - Versions diffs - 0.6.10 → 0.6.11 - Mend

@ms-cloudpack/esm-stub-utilities 0.6.10 → 0.6.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/lib/runInSandbox.js CHANGED Viewed

@@ -37,15 +37,17 @@ function findSandboxRoot(filePath) {
     const root = path.parse(filePath).root;
     let dir = path.dirname(filePath);
     if (!sandboxRoots[dir]) {
-        // try to find a git root first
+        // Try to find a git root first
         while (dir !== root && !fs.existsSync(path.join(dir, '.git'))) {
             dir = path.dirname(dir);
         }
         if (dir === root) {
-            // fallback: package root
-            dir = findPackageRoot(filePath);
+            // Fallback: package root. Note that in the case of running cloudpack bundle inside a
+            // dependency package folder under node_modules, we need to find the actual package root
+            // (rather than the root of the dep) because that's where other modules are installed.
+            dir = findPackageRoot(filePath, true /* excludeNodeModules */);
             if (!dir) {
-                // final fallback: parent directory
+                // Final fallback: parent directory
                 dir = path.dirname(filePath);
             }
         }

package/lib/runInSandbox.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"runInSandbox.js","sourceRoot":"","sources":["../src/runInSandbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvC,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,8BAA8B,CAAC,CAAC;AAEzF,uDAAuD;AACvD,wFAAwF;AACxF,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAC9E,gGAAgG;AAChG,MAAM,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AAExH,sCAAsC;AACtC,MAAM,GAAG,GAA2B,EAAE,CAAC;AAEvC,6CAA6C;AAC7C,MAAM,YAAY,GAA2B,EAAE,CAAC;AAChD,mEAAmE;AACnE,IAAI,oBAAoB,GAAG,EAAE,CAAC;AAE9B,iDAAiD;AACjD,MAAM,UAAU,mBAAmB;IACjC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,kCAAkC;AAClC,MAAM,UAAU,cAAc;IAC5B,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAC,QAAgB;IACvC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;IACvC,IAAI,GAAG,GAAuB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAErD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;QACtB,+BAA+B;QAC/B,OAAO,GAAG,KAAK,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE;YAC7D,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;SACzB;QAED,IAAI,GAAG,KAAK,IAAI,EAAE;YAChB,yBAAyB;YACzB,GAAG,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,EAAE;gBACR,mCAAmC;gBACnC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;aAC9B;SACF;QAED,YAAY,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;KACzB;IAED,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,WAAW,CAAC,MAAc,EAAE,GAAY,EAAE,WAAmB;IACpE,MAAM,OAAO,GAAI,GAAa,CAAC,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;IACtD,MAAM,KAAK,GAAI,GAAa,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC1D,mGAAmG;IACnG,MAAM,SAAS,GAAI,GAAa,CAAC,IAAI,CAAC;IAEtC,MAAM,UAAU,GAAG,CAAC,SAAS,MAAM,GAAG,EAAE,OAAO,CAAC,CAAC;IAEjD,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,YAAY,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE;QACxF,UAAU,CAAC,IAAI,CACb,EAAE,EACF,kGAAkG;YAChG,yFAAyF,EAC3F,kCAAkC,WAAW,EAAE,EAC/C,+BAA+B,oBAAoB,EAAE,CACtD,CAAC;QAEF,8CAA8C;QAC9C,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACjG,IAAI,UAAU,CAAC,MAAM,EAAE;YACrB,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,0CAA0C,EAAE,GAAG,UAAU,CAAC,CAAC;SAChF;KACF;SAAM,IAAI,SAAS,KAAK,WAAW,EAAE;QACpC,UAAU,CAAC,IAAI,CACb,EAAE,EACF,yFAAyF;YACvF,yFAAyF;YACzF,8DAA8D,CACjE,CAAC;KACH;SAAM,IACL,SAAS,KAAK,aAAa;QAC3B,CAAC,oCAAoC,CAAC,IAAI,CAAC,OAAO,CAAC;YACjD,OAAO,CAAC,QAAQ,CAAC,4CAA4C,CAAC,CAAC,EACjE;QACA,UAAU,CAAC,IAAI,CACb,EAAE,EACF,kGAAkG;YAChG,mGAAmG,CACtG,CAAC;KACH;IAED,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,iBAAiB,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;KAC3D;IAED,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,iGAAiG;AACjG,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,SAAiB;IAClD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,yCAAyC,GAAG,SAAS,CAAC,CAAC;KACxE;IAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,SAAS,CAAC,CAAC;KAC5D;IAED,sFAAsF;IACtF,mDAAmD;IACnD,MAAM,WAAW,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IAE/C,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;QACrB,IAAI,CAAC,oBAAoB,EAAE;YACzB,oBAAoB,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;SAClD;QAED,OAAO,CAAC,KAAK,CAAC,2CAA2C,GAAG,WAAW,CAAC,CAAC;QAEzE,IAAI;YACF,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,MAAM,CAAC;gBAC5B,yEAAyE;gBACzE,OAAO,EAAE,KAAK;gBACd,kGAAkG;gBAClG,gBAAgB,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;gBAC/B,gCAAgC;gBAChC,OAAO,EAAE,UAAU;gBACnB,OAAO,EAAE;oBACP,+DAA+D;oBAC/D,IAAI,EAAE,CAAC,oBAAoB,EAAE,WAAW,CAAC;oBACzC,uFAAuF;oBACvF,OAAO,EAAE,SAAS;oBAClB,2BAA2B;oBAC3B,OAAO,EAAE,eAAe;oBACxB,yDAAyD;oBACzD,QAAQ,EAAE,IAAI;oBACd,qDAAqD;oBACrD,MAAM,EAAE,CAAC,eAAe,CAAC;oBACzB,0DAA0D;oBAC1D,IAAI,EAAE;wBACJ,GAAG,YAAY;wBACf,4DAA4D;wBAC5D,UAAU,EAAE;4BACV,WAAW,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE;yBACvC;wBACD,GAAG,EAAE;4BACH,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK;yBACpB;wBACD,EAAE,EAAE;4BACF,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK;yBACvB;qBACF;iBACF;gBACD,GAAG,EAAE;oBACH,8CAA8C;oBAC9C,YAAY,EAAE,CAAC;iBAChB;aACF,CAAC,CAAC;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,WAAW,CAAC,4BAA4B,WAAW,uBAAuB,SAAS,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;SAC3G;KACF;IAED,MAAM,OAAO,GAAG,CAAC,GAAY,EAAE,EAAE;QAC/B,WAAW,CAAC,WAAW,SAAS,8BAA8B,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;IACpF,CAAC,CAAC;IACF,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAEzC,IAAI;QACF,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACnD,OAAO,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAY,CAAC;KAC1E;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,CAAC,GAAG,CAAC,CAAC;KACd;YAAS;QACR,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;KAC3C;AACH,CAAC","sourcesContent":["import fs from 'fs';\nimport path from 'path';\nimport { builtinModules } from 'module';\nimport { fileURLToPath } from 'url';\nimport { NodeVM, VMError } from 'vm2';\nimport { findPackageRoot } from '@ms-cloudpack/path-utilities';\n\nconst filename = fileURLToPath(import.meta.url);\nconst dirname = path.dirname(filename);\nconst browserEnvSetup = path.join(path.dirname(dirname), 'browserEnvironment/index.cjs');\n\n/** Allow the sandbox to load these built-in modules /\n// ('events' and 'stream' export classes which other things extend and can't be proxied)\nconst allowedBuiltins = ['buffer', 'events', 'path', 'stream', 'url', 'util'];\n/* Empty mocks of all built-in modules that aren't allowed (to ensure that requires succeed) /\nconst mockBuiltins = Object.fromEntries(builtinModules.filter((m) => !allowedBuiltins.includes(m)).map((m) => [m, {}]));\n\n/* Mapping from sandbox root to VM /\nconst vms: Record<string, NodeVM> = {};\n\n/* Mapping from directory to sandbox root /\nconst sandboxRoots: Record<string, string> = {};\n/* Sandbox root for this file and other cloudpack-related files /\nlet cloudpackSandboxRoot = '';\n\n/* Reset `vms` and `sandboxRoots` for testing /\nexport function _clearSandboxCaches() {\n Object.keys(vms).forEach((k) => delete vms[k]);\n Object.keys(sandboxRoots).forEach((k) => delete sandboxRoots[k]);\n}\n\n/* Get `vms` state for testing /\nexport function _getSandboxVms() {\n return vms;\n}\n\n/\n Try to figure out a root directory where the sandbox should be allowed to require files from.\n * This prefers the git root if found, falling back to package root or parent directory.\n \n (This is very likely overly permissive and might be good to restrict in the future.)\n /\nfunction findSandboxRoot(filePath: string) {\n const root = path.parse(filePath).root;\n let dir: string \| undefined = path.dirname(filePath);\n\n if (!sandboxRoots[dir]) {\n // try to find a git root first\n while (dir !== root && !fs.existsSync(path.join(dir, '.git'))) {\n dir = path.dirname(dir);\n }\n\n if (dir === root) {\n // fallback: package root\n dir = findPackageRoot(filePath);\n if (!dir) {\n // final fallback: parent directory\n dir = path.dirname(filePath);\n }\n }\n\n sandboxRoots[dir] = dir;\n }\n\n return sandboxRoots[dir];\n}\n\nfunction handleError(action: string, err: unknown, sandboxRoot: string) {\n const message = (err as Error).message \|\| String(err);\n const stack = (err as Error).stack?.split(/\\r?\\n/g) \|\| [];\n // instanceof checks don't work with errors from code run within the sandbox, but name is preserved\n const errorName = (err as Error).name;\n\n const newMessage = [`Error ${action}:`, message];\n\n if (stack.length && err instanceof VMError && err.message.includes('Cannot find module')) {\n newMessage.push(\n '',\n 'Ensure that this file exists on disk. If it exists, this may be a bug with the choice of `root` ' +\n '(allowed parent directories) settings in @ms-cloudpack/esm-stub-utilities runInSandbox.',\n `- Root for file being stubbed: ${sandboxRoot}`,\n `- Root for cloudpack files: ${cloudpackSandboxRoot}`,\n );\n\n // Find the actual line which caused the error\n const errorLines = stack.filter((line) => line.trim().startsWith('at') && !line.includes('vm2'));\n if (errorLines.length) {\n newMessage.push('', 'Code that may have required this module:', ...errorLines);\n }\n } else if (errorName === 'TypeError') {\n newMessage.push(\n '',\n 'If the code was referencing a built-in global or a property of a Node built-in module, ' +\n 'this error may be caused by a missing mock or other issue with the sandbox environment ' +\n 'configured in @ms-cloudpack/esm-stub-utilities runInSandbox.',\n );\n } else if (\n errorName === 'SyntaxError' &&\n (/Unexpected token '(import\|export)'/.test(message) \|\|\n message.includes(`'import' and 'export' may appear only with`))\n ) {\n newMessage.push(\n '',\n \"It appears you're trying to load an ES module, which is not currently supported in the sandbox. \" +\n 'If this module is loaded at startup within a CommonJS file, please file an issue with cloudpack. ',\n );\n }\n\n if (stack.length) {\n newMessage.push('', 'Original stack:', ...stack.slice(1));\n }\n\n throw new Error(newMessage.join('\\n'));\n}\n\n/\n Run a CommonJS file within a sandboxed environment.\n * @param entryPath - Path to a CommonJS file to run in a sandbox (does not work with ESM files)\n * @returns The module's exports\n */\n// eslint-disable-next-line @typescript-eslint/require-await -- using async to catch async errors\nexport async function runInSandbox(entryPath: string) {\n if (!path.isAbsolute(entryPath)) {\n throw new Error('Entry path must be absolute. Received: ' + entryPath);\n }\n\n if (!fs.existsSync(entryPath)) {\n throw new Error('Entry path does not exist: ' + entryPath);\n }\n\n // Allow code in the sandbox to require files under the requested file's package root,\n // or under its directory if it's not in a package.\n const sandboxRoot = findSandboxRoot(entryPath);\n\n if (!vms[sandboxRoot]) {\n if (!cloudpackSandboxRoot) {\n cloudpackSandboxRoot = findSandboxRoot(filename);\n }\n\n console.debug('esm-stub-utilities: Creating sandbox for ' + sandboxRoot);\n\n try {\n vms[sandboxRoot] = new NodeVM({\n // disable console logging instead of passing through to the host console\n console: 'off',\n // look for these import extensions (mjs is not included because this doesn't support loading ESM)\n sourceExtensions: ['js', 'cjs'],\n // use a commonjs module wrapper\n wrapper: 'commonjs',\n require: {\n // allow local and dependency modules to be required under here\n root: [cloudpackSandboxRoot, sandboxRoot],\n // load, compile, and require modules in the sandbox (instead of requiring in the host)\n context: 'sandbox',\n // allowed built-in modules\n builtin: allowedBuiltins,\n // allow loading \"external\" modules under the given roots\n external: true,\n // simulate the browser at startup (can throw errors)\n import: [browserEnvSetup],\n // mock these modules so they can be successfully required\n mock: {\n ...mockBuiltins,\n // some modules reference these built-ins during their setup\n perf_hooks: {\n performance: { now: () => Date.now() },\n },\n tty: {\n isatty: () => false,\n },\n vm: {\n isContext: () => false,\n },\n },\n },\n env: {\n // prevent debug from accessing process.stderr\n DEBUG_COLORS: 0,\n },\n });\n } catch (err) {\n handleError(`initializing sandbox for ${sandboxRoot} (to create stub of ${entryPath})`, err, sandboxRoot);\n }\n }\n\n const onError = (err: unknown) => {\n handleError(`running ${entryPath} in sandbox (to create stub)`, err, sandboxRoot);\n };\n process.on('uncaughtException', onError);\n\n try {\n const cjsFile = fs.readFileSync(entryPath, 'utf8');\n return vms[sandboxRoot].run(cjsFile, { filename: entryPath }) as unknown;\n } catch (err) {\n onError(err);\n } finally {\n process.off('uncaughtException', onError);\n }\n}\n"]}
1	+ {"version":3,"file":"runInSandbox.js","sourceRoot":"","sources":["../src/runInSandbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvC,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,8BAA8B,CAAC,CAAC;AAEzF,uDAAuD;AACvD,wFAAwF;AACxF,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAC9E,gGAAgG;AAChG,MAAM,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AAExH,sCAAsC;AACtC,MAAM,GAAG,GAA2B,EAAE,CAAC;AAEvC,6CAA6C;AAC7C,MAAM,YAAY,GAA2B,EAAE,CAAC;AAChD,mEAAmE;AACnE,IAAI,oBAAoB,GAAG,EAAE,CAAC;AAE9B,iDAAiD;AACjD,MAAM,UAAU,mBAAmB;IACjC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,kCAAkC;AAClC,MAAM,UAAU,cAAc;IAC5B,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAC,QAAgB;IACvC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;IACvC,IAAI,GAAG,GAAuB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAErD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;QACtB,+BAA+B;QAC/B,OAAO,GAAG,KAAK,IAAI,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,EAAE;YAC7D,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;SACzB;QAED,IAAI,GAAG,KAAK,IAAI,EAAE;YAChB,qFAAqF;YACrF,wFAAwF;YACxF,sFAAsF;YACtF,GAAG,GAAG,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAC/D,IAAI,CAAC,GAAG,EAAE;gBACR,mCAAmC;gBACnC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;aAC9B;SACF;QAED,YAAY,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;KACzB;IAED,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,WAAW,CAAC,MAAc,EAAE,GAAY,EAAE,WAAmB;IACpE,MAAM,OAAO,GAAI,GAAa,CAAC,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;IACtD,MAAM,KAAK,GAAI,GAAa,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC1D,mGAAmG;IACnG,MAAM,SAAS,GAAI,GAAa,CAAC,IAAI,CAAC;IAEtC,MAAM,UAAU,GAAG,CAAC,SAAS,MAAM,GAAG,EAAE,OAAO,CAAC,CAAC;IAEjD,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,YAAY,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE;QACxF,UAAU,CAAC,IAAI,CACb,EAAE,EACF,kGAAkG;YAChG,yFAAyF,EAC3F,kCAAkC,WAAW,EAAE,EAC/C,+BAA+B,oBAAoB,EAAE,CACtD,CAAC;QAEF,8CAA8C;QAC9C,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACjG,IAAI,UAAU,CAAC,MAAM,EAAE;YACrB,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,0CAA0C,EAAE,GAAG,UAAU,CAAC,CAAC;SAChF;KACF;SAAM,IAAI,SAAS,KAAK,WAAW,EAAE;QACpC,UAAU,CAAC,IAAI,CACb,EAAE,EACF,yFAAyF;YACvF,yFAAyF;YACzF,8DAA8D,CACjE,CAAC;KACH;SAAM,IACL,SAAS,KAAK,aAAa;QAC3B,CAAC,oCAAoC,CAAC,IAAI,CAAC,OAAO,CAAC;YACjD,OAAO,CAAC,QAAQ,CAAC,4CAA4C,CAAC,CAAC,EACjE;QACA,UAAU,CAAC,IAAI,CACb,EAAE,EACF,kGAAkG;YAChG,mGAAmG,CACtG,CAAC;KACH;IAED,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,iBAAiB,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;KAC3D;IAED,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,iGAAiG;AACjG,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,SAAiB;IAClD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,yCAAyC,GAAG,SAAS,CAAC,CAAC;KACxE;IAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,SAAS,CAAC,CAAC;KAC5D;IAED,sFAAsF;IACtF,mDAAmD;IACnD,MAAM,WAAW,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IAE/C,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;QACrB,IAAI,CAAC,oBAAoB,EAAE;YACzB,oBAAoB,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;SAClD;QAED,OAAO,CAAC,KAAK,CAAC,2CAA2C,GAAG,WAAW,CAAC,CAAC;QAEzE,IAAI;YACF,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,MAAM,CAAC;gBAC5B,yEAAyE;gBACzE,OAAO,EAAE,KAAK;gBACd,kGAAkG;gBAClG,gBAAgB,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;gBAC/B,gCAAgC;gBAChC,OAAO,EAAE,UAAU;gBACnB,OAAO,EAAE;oBACP,+DAA+D;oBAC/D,IAAI,EAAE,CAAC,oBAAoB,EAAE,WAAW,CAAC;oBACzC,uFAAuF;oBACvF,OAAO,EAAE,SAAS;oBAClB,2BAA2B;oBAC3B,OAAO,EAAE,eAAe;oBACxB,yDAAyD;oBACzD,QAAQ,EAAE,IAAI;oBACd,qDAAqD;oBACrD,MAAM,EAAE,CAAC,eAAe,CAAC;oBACzB,0DAA0D;oBAC1D,IAAI,EAAE;wBACJ,GAAG,YAAY;wBACf,4DAA4D;wBAC5D,UAAU,EAAE;4BACV,WAAW,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE;yBACvC;wBACD,GAAG,EAAE;4BACH,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK;yBACpB;wBACD,EAAE,EAAE;4BACF,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK;yBACvB;qBACF;iBACF;gBACD,GAAG,EAAE;oBACH,8CAA8C;oBAC9C,YAAY,EAAE,CAAC;iBAChB;aACF,CAAC,CAAC;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,WAAW,CAAC,4BAA4B,WAAW,uBAAuB,SAAS,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;SAC3G;KACF;IAED,MAAM,OAAO,GAAG,CAAC,GAAY,EAAE,EAAE;QAC/B,WAAW,CAAC,WAAW,SAAS,8BAA8B,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;IACpF,CAAC,CAAC;IACF,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAEzC,IAAI;QACF,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACnD,OAAO,GAAG,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAY,CAAC;KAC1E;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,CAAC,GAAG,CAAC,CAAC;KACd;YAAS;QACR,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;KAC3C;AACH,CAAC","sourcesContent":["import fs from 'fs';\nimport path from 'path';\nimport { builtinModules } from 'module';\nimport { fileURLToPath } from 'url';\nimport { NodeVM, VMError } from 'vm2';\nimport { findPackageRoot } from '@ms-cloudpack/path-utilities';\n\nconst filename = fileURLToPath(import.meta.url);\nconst dirname = path.dirname(filename);\nconst browserEnvSetup = path.join(path.dirname(dirname), 'browserEnvironment/index.cjs');\n\n/** Allow the sandbox to load these built-in modules /\n// ('events' and 'stream' export classes which other things extend and can't be proxied)\nconst allowedBuiltins = ['buffer', 'events', 'path', 'stream', 'url', 'util'];\n/* Empty mocks of all built-in modules that aren't allowed (to ensure that requires succeed) /\nconst mockBuiltins = Object.fromEntries(builtinModules.filter((m) => !allowedBuiltins.includes(m)).map((m) => [m, {}]));\n\n/* Mapping from sandbox root to VM /\nconst vms: Record<string, NodeVM> = {};\n\n/* Mapping from directory to sandbox root /\nconst sandboxRoots: Record<string, string> = {};\n/* Sandbox root for this file and other cloudpack-related files /\nlet cloudpackSandboxRoot = '';\n\n/* Reset `vms` and `sandboxRoots` for testing /\nexport function _clearSandboxCaches() {\n Object.keys(vms).forEach((k) => delete vms[k]);\n Object.keys(sandboxRoots).forEach((k) => delete sandboxRoots[k]);\n}\n\n/* Get `vms` state for testing /\nexport function _getSandboxVms() {\n return vms;\n}\n\n/\n Try to figure out a root directory where the sandbox should be allowed to require files from.\n * This prefers the git root if found, falling back to package root or parent directory.\n \n (This is very likely overly permissive and might be good to restrict in the future.)\n /\nfunction findSandboxRoot(filePath: string) {\n const root = path.parse(filePath).root;\n let dir: string \| undefined = path.dirname(filePath);\n\n if (!sandboxRoots[dir]) {\n // Try to find a git root first\n while (dir !== root && !fs.existsSync(path.join(dir, '.git'))) {\n dir = path.dirname(dir);\n }\n\n if (dir === root) {\n // Fallback: package root. Note that in the case of running cloudpack bundle inside a\n // dependency package folder under node_modules, we need to find the actual package root\n // (rather than the root of the dep) because that's where other modules are installed.\n dir = findPackageRoot(filePath, true / excludeNodeModules /);\n if (!dir) {\n // Final fallback: parent directory\n dir = path.dirname(filePath);\n }\n }\n\n sandboxRoots[dir] = dir;\n }\n\n return sandboxRoots[dir];\n}\n\nfunction handleError(action: string, err: unknown, sandboxRoot: string) {\n const message = (err as Error).message \|\| String(err);\n const stack = (err as Error).stack?.split(/\\r?\\n/g) \|\| [];\n // instanceof checks don't work with errors from code run within the sandbox, but name is preserved\n const errorName = (err as Error).name;\n\n const newMessage = [`Error ${action}:`, message];\n\n if (stack.length && err instanceof VMError && err.message.includes('Cannot find module')) {\n newMessage.push(\n '',\n 'Ensure that this file exists on disk. If it exists, this may be a bug with the choice of `root` ' +\n '(allowed parent directories) settings in @ms-cloudpack/esm-stub-utilities runInSandbox.',\n `- Root for file being stubbed: ${sandboxRoot}`,\n `- Root for cloudpack files: ${cloudpackSandboxRoot}`,\n );\n\n // Find the actual line which caused the error\n const errorLines = stack.filter((line) => line.trim().startsWith('at') && !line.includes('vm2'));\n if (errorLines.length) {\n newMessage.push('', 'Code that may have required this module:', ...errorLines);\n }\n } else if (errorName === 'TypeError') {\n newMessage.push(\n '',\n 'If the code was referencing a built-in global or a property of a Node built-in module, ' +\n 'this error may be caused by a missing mock or other issue with the sandbox environment ' +\n 'configured in @ms-cloudpack/esm-stub-utilities runInSandbox.',\n );\n } else if (\n errorName === 'SyntaxError' &&\n (/Unexpected token '(import\|export)'/.test(message) \|\|\n message.includes(`'import' and 'export' may appear only with`))\n ) {\n newMessage.push(\n '',\n \"It appears you're trying to load an ES module, which is not currently supported in the sandbox. \" +\n 'If this module is loaded at startup within a CommonJS file, please file an issue with cloudpack. ',\n );\n }\n\n if (stack.length) {\n newMessage.push('', 'Original stack:', ...stack.slice(1));\n }\n\n throw new Error(newMessage.join('\\n'));\n}\n\n/\n Run a CommonJS file within a sandboxed environment.\n * @param entryPath - Path to a CommonJS file to run in a sandbox (does not work with ESM files)\n * @returns The module's exports\n */\n// eslint-disable-next-line @typescript-eslint/require-await -- using async to catch async errors\nexport async function runInSandbox(entryPath: string) {\n if (!path.isAbsolute(entryPath)) {\n throw new Error('Entry path must be absolute. Received: ' + entryPath);\n }\n\n if (!fs.existsSync(entryPath)) {\n throw new Error('Entry path does not exist: ' + entryPath);\n }\n\n // Allow code in the sandbox to require files under the requested file's package root,\n // or under its directory if it's not in a package.\n const sandboxRoot = findSandboxRoot(entryPath);\n\n if (!vms[sandboxRoot]) {\n if (!cloudpackSandboxRoot) {\n cloudpackSandboxRoot = findSandboxRoot(filename);\n }\n\n console.debug('esm-stub-utilities: Creating sandbox for ' + sandboxRoot);\n\n try {\n vms[sandboxRoot] = new NodeVM({\n // disable console logging instead of passing through to the host console\n console: 'off',\n // look for these import extensions (mjs is not included because this doesn't support loading ESM)\n sourceExtensions: ['js', 'cjs'],\n // use a commonjs module wrapper\n wrapper: 'commonjs',\n require: {\n // allow local and dependency modules to be required under here\n root: [cloudpackSandboxRoot, sandboxRoot],\n // load, compile, and require modules in the sandbox (instead of requiring in the host)\n context: 'sandbox',\n // allowed built-in modules\n builtin: allowedBuiltins,\n // allow loading \"external\" modules under the given roots\n external: true,\n // simulate the browser at startup (can throw errors)\n import: [browserEnvSetup],\n // mock these modules so they can be successfully required\n mock: {\n ...mockBuiltins,\n // some modules reference these built-ins during their setup\n perf_hooks: {\n performance: { now: () => Date.now() },\n },\n tty: {\n isatty: () => false,\n },\n vm: {\n isContext: () => false,\n },\n },\n },\n env: {\n // prevent debug from accessing process.stderr\n DEBUG_COLORS: 0,\n },\n });\n } catch (err) {\n handleError(`initializing sandbox for ${sandboxRoot} (to create stub of ${entryPath})`, err, sandboxRoot);\n }\n }\n\n const onError = (err: unknown) => {\n handleError(`running ${entryPath} in sandbox (to create stub)`, err, sandboxRoot);\n };\n process.on('uncaughtException', onError);\n\n try {\n const cjsFile = fs.readFileSync(entryPath, 'utf8');\n return vms[sandboxRoot].run(cjsFile, { filename: entryPath }) as unknown;\n } catch (err) {\n onError(err);\n } finally {\n process.off('uncaughtException', onError);\n }\n}\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/esm-stub-utilities",
-  "version": "0.6.10",
+  "version": "0.6.11",
   "description": "Generates ESM stubs for CommonJS entry files.",
   "license": "MIT",
   "type": "module",
@@ -14,7 +14,7 @@
   },
   "dependencies": {
     "@ms-cloudpack/json-utilities": "^0.0.6",
-    "@ms-cloudpack/path-utilities": "^2.1.2",
+    "@ms-cloudpack/path-utilities": "^2.2.0",
     "@ms-cloudpack/path-string-parsing": "^1.0.1",
     "atob": "^2.1.2",
     "btoa": "^1.2.1",