@ms-cloudpack/esm-stub-utilities 0.13.12 → 0.13.14

package/lib/worker/workerEntry.js

@@ -6,6 +6,7 @@ import { initializeWorker } from '@ms-cloudpack/worker-pool';
 await initBrowserEnvironment();
 // TODO should the globals be marked as readonly if possible?
 const initialGlobalProperties = getGlobalProperties();
+// eslint-disable-next-line no-restricted-properties -- exit handling for a worker
 const processExit = process.exit.bind(process);
 // Then initialize the worker with the appropriate listeners and api dictionary.
 initializeWorker({
@@ -15,11 +16,13 @@ initializeWorker({
     beforeEach: () => {
         // Override process.exit calls to throw rather than exit the process, in case we load some
         // CJS code that calls process.exit. This gives an actual call stack for debugging.
+        // eslint-disable-next-line no-restricted-properties
         process.exit = (code) => {
             throw new Error(`process.exit called with code ${code}`);
         };
     },
     afterEach: () => {
+        // eslint-disable-next-line no-restricted-properties
         process.exit = processExit;
         cleanUpGlobals(initialGlobalProperties);
     },

package/lib/worker/workerEntry.js.map

@@ -1 +1 @@
-{"version":3,"file":"workerEntry.js","sourceRoot":"","sources":["../../src/worker/workerEntry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D,4CAA4C;AAC5C,MAAM,sBAAsB,EAAE,CAAC;AAE/B,6DAA6D;AAC7D,MAAM,uBAAuB,GAAG,mBAAmB,EAAE,CAAC;AAEtD,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAE/C,gFAAgF;AAChF,gBAAgB,CAAC;IACf,OAAO,EAAE;QACP,aAAa;KACd;IACD,UAAU,EAAE,GAAG,EAAE;QACf,0FAA0F;QAC1F,mFAAmF;QACnF,OAAO,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,iCAAiC,IAAI,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC;IACJ,CAAC;IACD,SAAS,EAAE,GAAG,EAAE;QACd,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC;QAC3B,cAAc,CAAC,uBAAuB,CAAC,CAAC;IAC1C,CAAC;IACD,4FAA4F;IAC5F,+DAA+D;IAC/D,OAAO,EAAE,EAAE,GAAG,IAAI;CACnB,CAAC,CAAC","sourcesContent":["import { initBrowserEnvironment } from './initBrowserEnvironment.js';\nimport { cleanUpGlobals, getGlobalProperties } from './globals.js';\nimport { writeESMStubs } from '../writeESMStubs.js';\nimport { initializeWorker } from '@ms-cloudpack/worker-pool';\n\n// Load any environmental side effects here.\nawait initBrowserEnvironment();\n\n// TODO should the globals be marked as readonly if possible?\nconst initialGlobalProperties = getGlobalProperties();\n\nconst processExit = process.exit.bind(process);\n\n// Then initialize the worker with the appropriate listeners and api dictionary.\ninitializeWorker({\n  methods: {\n    writeESMStubs,\n  },\n  beforeEach: () => {\n    // Override process.exit calls to throw rather than exit the process, in case we load some\n    // CJS code that calls process.exit. This gives an actual call stack for debugging.\n    process.exit = (code) => {\n      throw new Error(`process.exit called with code ${code}`);\n    };\n  },\n  afterEach: () => {\n    process.exit = processExit;\n    cleanUpGlobals(initialGlobalProperties);\n  },\n  // Stop the worker after 30s. This is much longer than should usually be necessary, but it's\n  // good to be conservative here in case of resource contention.\n  timeout: 30 * 1000,\n});\n"]}
+{"version":3,"file":"workerEntry.js","sourceRoot":"","sources":["../../src/worker/workerEntry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D,4CAA4C;AAC5C,MAAM,sBAAsB,EAAE,CAAC;AAE/B,6DAA6D;AAC7D,MAAM,uBAAuB,GAAG,mBAAmB,EAAE,CAAC;AAEtD,kFAAkF;AAClF,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAE/C,gFAAgF;AAChF,gBAAgB,CAAC;IACf,OAAO,EAAE;QACP,aAAa;KACd;IACD,UAAU,EAAE,GAAG,EAAE;QACf,0FAA0F;QAC1F,mFAAmF;QACnF,oDAAoD;QACpD,OAAO,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,iCAAiC,IAAI,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC;IACJ,CAAC;IACD,SAAS,EAAE,GAAG,EAAE;QACd,oDAAoD;QACpD,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC;QAC3B,cAAc,CAAC,uBAAuB,CAAC,CAAC;IAC1C,CAAC;IACD,4FAA4F;IAC5F,+DAA+D;IAC/D,OAAO,EAAE,EAAE,GAAG,IAAI;CACnB,CAAC,CAAC","sourcesContent":["import { initBrowserEnvironment } from './initBrowserEnvironment.js';\nimport { cleanUpGlobals, getGlobalProperties } from './globals.js';\nimport { writeESMStubs } from '../writeESMStubs.js';\nimport { initializeWorker } from '@ms-cloudpack/worker-pool';\n\n// Load any environmental side effects here.\nawait initBrowserEnvironment();\n\n// TODO should the globals be marked as readonly if possible?\nconst initialGlobalProperties = getGlobalProperties();\n\n// eslint-disable-next-line no-restricted-properties -- exit handling for a worker\nconst processExit = process.exit.bind(process);\n\n// Then initialize the worker with the appropriate listeners and api dictionary.\ninitializeWorker({\n  methods: {\n    writeESMStubs,\n  },\n  beforeEach: () => {\n    // Override process.exit calls to throw rather than exit the process, in case we load some\n    // CJS code that calls process.exit. This gives an actual call stack for debugging.\n    // eslint-disable-next-line no-restricted-properties\n    process.exit = (code) => {\n      throw new Error(`process.exit called with code ${code}`);\n    };\n  },\n  afterEach: () => {\n    // eslint-disable-next-line no-restricted-properties\n    process.exit = processExit;\n    cleanUpGlobals(initialGlobalProperties);\n  },\n  // Stop the worker after 30s. This is much longer than should usually be necessary, but it's\n  // good to be conservative here in case of resource contention.\n  timeout: 30 * 1000,\n});\n"]}

package/lib/writeESMStubsInWorker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writeESMStubsInWorker.d.ts","sourceRoot":"","sources":["../src/writeESMStubsInWorker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAI1E;;GAEG;AAGH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,oBAAoB,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GACtD,OAAO,CAAC,mBAAmB,CAAC,CAiC9B;AAED,wBAAsB,qBAAqB,kBAG1C"}
+{"version":3,"file":"writeESMStubsInWorker.d.ts","sourceRoot":"","sources":["../src/writeESMStubsInWorker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAI1E;;GAEG;AAGH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,oBAAoB,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GACtD,OAAO,CAAC,mBAAmB,CAAC,CA6C9B;AAED,wBAAsB,qBAAqB,kBAG1C"}

package/lib/writeESMStubsInWorker.js

@@ -6,19 +6,35 @@ let workerPool;
 // This is tested in bundler-rollup/src/writeESMStubsInWorker.test.ts so we can
 // use the compiled version of the workerEntry file.
 export async function writeESMStubsInWorker(options) {
-    const { maxWorkers = 5, ...stubOptions } = options;
+    // Trim the options to only the necessary ones for the worker to reduce what's serialized
+    // (a larger BundleOptions object was likely passed in)
+    const onlyStubOptions = {
+        inputPath: options.inputPath,
+        entries: options.entries,
+        forceCJS: options.forceCJS,
+    };
     workerPool ??= new WorkerPool({
         name: 'ESM stub generation',
         parentPath: import.meta.url,
         entryPath: './worker/workerEntry',
-        maxWorkers,
+        maxWorkers: options.maxWorkers || 5,
+        // Stop inactive workers after 5 minutes. This is intended to prevent one possible cause of
+        // OOM crashes if cloudpack start is left running for a long time (though it's much more likely
+        // that the issue is caused by servers or file watchers). The timeout is conservative because
+        // the fake browser environment has nontrivial startup time, so killing workers too quickly
+        // could slow down rebuilds.
+        inactiveTimeout: 5 * 60 * 1000,
+        // Most stubs seem to stay well under this size, and Node appears to be decent about freeing
+        // memory after writeESMStubs finishes, but this will catch anything giant or leaky.
+        // (This is only checked after task completion, so a package exceeding it will still be stubbed.)
+        maxHeapSize: 500 * 1024 * 1024,
+        // console.warn if a stub takes longer than this
+        warnAboveTime: process.env.CI ? 4000 : 2000,
     });
-    const startTime = Date.now();
-    console.info(`Starting ESM stub generation for ${options.inputPath}`);
     try {
         return await workerPool.execute({
             method: 'writeESMStubs',
-            args: [stubOptions],
+            args: [onlyStubOptions],
         });
     }
     catch (err) {
@@ -33,9 +49,6 @@ export async function writeESMStubsInWorker(options) {
             ],
         };
     }
-    finally {
-        console.info(`Finished ESM stub generation for ${options.inputPath} in ${((Date.now() - startTime) / 1000).toFixed(3)}s`);
-    }
 }
 export async function disposeStubWorkerPool() {
     await workerPool?.dispose();

package/lib/writeESMStubsInWorker.js.map

@@ -1 +1 @@
-{"version":3,"file":"writeESMStubsInWorker.js","sourceRoot":"","sources":["../src/writeESMStubsInWorker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAIvD,IAAI,UAAkC,CAAC;AAEvC;;GAEG;AACH,+EAA+E;AAC/E,oDAAoD;AACpD,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,OAAuD;IAEvD,MAAM,EAAE,UAAU,GAAG,CAAC,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;IAEnD,UAAU,KAAK,IAAI,UAAU,CAAC;QAC5B,IAAI,EAAE,qBAAqB;QAC3B,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;QAC3B,SAAS,EAAE,sBAAsB;QACjC,UAAU;KACX,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,OAAO,CAAC,IAAI,CAAC,oCAAoC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACtE,IAAI,CAAC;QACH,OAAO,MAAM,UAAU,CAAC,OAAO,CAAsB;YACnD,MAAM,EAAE,eAAe;YACvB,IAAI,EAAE,CAAC,WAAW,CAAC;SACpB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO;YACL,UAAU,EAAE,EAAE;YACd,MAAM,EAAE;gBACN;oBACE,MAAM,EAAE,qBAAqB;oBAC7B,mEAAmE;oBACnE,IAAI,EAAG,GAAa,EAAE,KAAK,IAAK,GAAa,EAAE,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC;iBACtE;aACF;SACF,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,OAAO,CAAC,IAAI,CACV,oCAAoC,OAAO,CAAC,SAAS,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAC5G,CAAC;IACJ,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACzC,MAAM,UAAU,EAAE,OAAO,EAAE,CAAC;IAC5B,UAAU,GAAG,SAAS,CAAC;AACzB,CAAC","sourcesContent":["import { WorkerPool } from '@ms-cloudpack/worker-pool';\nimport type { WriteESMStubsOptions } from './types/WriteESMStubsOptions.js';\nimport type { WriteESMStubsResult } from './types/WriteESMStubsResult.js';\n\nlet workerPool: WorkerPool | undefined;\n\n/**\n * Write ESM stubs using a worker pool.\n */\n// This is tested in bundler-rollup/src/writeESMStubsInWorker.test.ts so we can\n// use the compiled version of the workerEntry file.\nexport async function writeESMStubsInWorker(\n  options: WriteESMStubsOptions & { maxWorkers?: number },\n): Promise<WriteESMStubsResult> {\n  const { maxWorkers = 5, ...stubOptions } = options;\n\n  workerPool ??= new WorkerPool({\n    name: 'ESM stub generation',\n    parentPath: import.meta.url,\n    entryPath: './worker/workerEntry',\n    maxWorkers,\n  });\n\n  const startTime = Date.now();\n  console.info(`Starting ESM stub generation for ${options.inputPath}`);\n  try {\n    return await workerPool.execute<WriteESMStubsResult>({\n      method: 'writeESMStubs',\n      args: [stubOptions],\n    });\n  } catch (err) {\n    return {\n      newEntries: {},\n      errors: [\n        {\n          source: 'ESM stub generation',\n          // note: err won't be an instance of Error because of serialization\n          text: (err as Error)?.stack || (err as Error)?.message || String(err),\n        },\n      ],\n    };\n  } finally {\n    console.info(\n      `Finished ESM stub generation for ${options.inputPath} in ${((Date.now() - startTime) / 1000).toFixed(3)}s`,\n    );\n  }\n}\n\nexport async function disposeStubWorkerPool() {\n  await workerPool?.dispose();\n  workerPool = undefined;\n}\n"]}
+{"version":3,"file":"writeESMStubsInWorker.js","sourceRoot":"","sources":["../src/writeESMStubsInWorker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAIvD,IAAI,UAAkC,CAAC;AAEvC;;GAEG;AACH,+EAA+E;AAC/E,oDAAoD;AACpD,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,OAAuD;IAEvD,yFAAyF;IACzF,uDAAuD;IACvD,MAAM,eAAe,GAAyB;QAC5C,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;KAC3B,CAAC;IAEF,UAAU,KAAK,IAAI,UAAU,CAAC;QAC5B,IAAI,EAAE,qBAAqB;QAC3B,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;QAC3B,SAAS,EAAE,sBAAsB;QACjC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,CAAC;QACnC,2FAA2F;QAC3F,+FAA+F;QAC/F,6FAA6F;QAC7F,2FAA2F;QAC3F,4BAA4B;QAC5B,eAAe,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI;QAC9B,4FAA4F;QAC5F,oFAAoF;QACpF,iGAAiG;QACjG,WAAW,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI;QAC9B,gDAAgD;QAChD,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;KAC5C,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,OAAO,MAAM,UAAU,CAAC,OAAO,CAAsB;YACnD,MAAM,EAAE,eAAe;YACvB,IAAI,EAAE,CAAC,eAAe,CAAC;SACxB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO;YACL,UAAU,EAAE,EAAE;YACd,MAAM,EAAE;gBACN;oBACE,MAAM,EAAE,qBAAqB;oBAC7B,mEAAmE;oBACnE,IAAI,EAAG,GAAa,EAAE,KAAK,IAAK,GAAa,EAAE,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC;iBACtE;aACF;SACF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACzC,MAAM,UAAU,EAAE,OAAO,EAAE,CAAC;IAC5B,UAAU,GAAG,SAAS,CAAC;AACzB,CAAC","sourcesContent":["import { WorkerPool } from '@ms-cloudpack/worker-pool';\nimport type { WriteESMStubsOptions } from './types/WriteESMStubsOptions.js';\nimport type { WriteESMStubsResult } from './types/WriteESMStubsResult.js';\n\nlet workerPool: WorkerPool | undefined;\n\n/**\n * Write ESM stubs using a worker pool.\n */\n// This is tested in bundler-rollup/src/writeESMStubsInWorker.test.ts so we can\n// use the compiled version of the workerEntry file.\nexport async function writeESMStubsInWorker(\n  options: WriteESMStubsOptions & { maxWorkers?: number },\n): Promise<WriteESMStubsResult> {\n  // Trim the options to only the necessary ones for the worker to reduce what's serialized\n  // (a larger BundleOptions object was likely passed in)\n  const onlyStubOptions: WriteESMStubsOptions = {\n    inputPath: options.inputPath,\n    entries: options.entries,\n    forceCJS: options.forceCJS,\n  };\n\n  workerPool ??= new WorkerPool({\n    name: 'ESM stub generation',\n    parentPath: import.meta.url,\n    entryPath: './worker/workerEntry',\n    maxWorkers: options.maxWorkers || 5,\n    // Stop inactive workers after 5 minutes. This is intended to prevent one possible cause of\n    // OOM crashes if cloudpack start is left running for a long time (though it's much more likely\n    // that the issue is caused by servers or file watchers). The timeout is conservative because\n    // the fake browser environment has nontrivial startup time, so killing workers too quickly\n    // could slow down rebuilds.\n    inactiveTimeout: 5 * 60 * 1000,\n    // Most stubs seem to stay well under this size, and Node appears to be decent about freeing\n    // memory after writeESMStubs finishes, but this will catch anything giant or leaky.\n    // (This is only checked after task completion, so a package exceeding it will still be stubbed.)\n    maxHeapSize: 500 * 1024 * 1024,\n    // console.warn if a stub takes longer than this\n    warnAboveTime: process.env.CI ? 4000 : 2000,\n  });\n\n  try {\n    return await workerPool.execute<WriteESMStubsResult>({\n      method: 'writeESMStubs',\n      args: [onlyStubOptions],\n    });\n  } catch (err) {\n    return {\n      newEntries: {},\n      errors: [\n        {\n          source: 'ESM stub generation',\n          // note: err won't be an instance of Error because of serialization\n          text: (err as Error)?.stack || (err as Error)?.message || String(err),\n        },\n      ],\n    };\n  }\n}\n\nexport async function disposeStubWorkerPool() {\n  await workerPool?.dispose();\n  workerPool = undefined;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/esm-stub-utilities",
-  "version": "0.13.12",
+  "version": "0.13.14",
   "description": "Generates ESM stubs for CommonJS entry files.",
   "license": "MIT",
   "type": "module",
@@ -16,9 +16,9 @@
   "dependencies": {
     "@ms-cloudpack/common-types": "^0.23.3",
     "@ms-cloudpack/json-utilities": "^0.1.8",
-    "@ms-cloudpack/package-utilities": "^10.2.8",
+    "@ms-cloudpack/package-utilities": "^10.2.10",
     "@ms-cloudpack/path-string-parsing": "^1.2.4",
-    "@ms-cloudpack/worker-pool": "^0.2.0",
+    "@ms-cloudpack/worker-pool": "^0.3.0",
     "jsdom": "^24.0.0",
     "jsdom-global": "^3.0.2",
     "regenerator-runtime": "^0.14.1"