@ms-cloudpack/app-server 0.20.5 → 0.20.7

package/lib/renderRoute/ssr/renderCustomScript.js

@@ -1,7 +1,5 @@
-import fsPromises from 'fs/promises';
-import { pathToFileURL } from 'url';
-import { getCustomRenderErrorResponse, getErrorResponse } from '../getErrorResponse.js';
 import { runServerEntryInWorker } from './runServerEntryInWorker.js';
+import { importAndRunScript } from './worker/importAndRunScript.js';
 /**
  * Load the default export from a JS file passed as the `renderScript` in a route,
  * and return either the result of running the function, or an error page if something fails.
@@ -10,23 +8,9 @@ export async function renderCustomScript(params,
 // only config and importMap are used in the new SSR signature, so in the future this can be:
 // PartialContext<'session', 'config' | 'importMap'>
 context) {
-    const { renderScriptPath, req, res, ...options } = params;
+    const { renderScriptPath, req, res, handleCustomRenderError, ...options } = params;
     const { session } = context;
     const { config, importMap } = session;
-    // Get the html factory function from a script default export.
-    const renderScriptUrl = pathToFileURL(renderScriptPath).toString();
-    // Note: because there isn't a way to purge the require cache, we need to add a cache breaker query param to the
-    // script path to ensure we get the latest version of the script. This could be improved by using the git hash of
-    // the file if it exists, or a hash of the content, or even the timestamp of the file.
-    // TODO: this won't work to update anything the file imports, and doesn't seem to work for serverEntry at all...
-    let cacheBreakerQueryParam = `?t=${Date.now()}`;
-    try {
-        const { mtime } = await fsPromises.stat(renderScriptPath);
-        cacheBreakerQueryParam = `?t=${mtime.getTime()}`;
-    }
-    catch {
-        /* no-op */
-    }
     const ssrOptions = {
         ...options,
         appPath: config.appPath,
@@ -41,65 +25,27 @@ context) {
             url: req.url,
         },
     };
-    const renderScriptUrlWithCacheBreaker = renderScriptUrl + cacheBreakerQueryParam;
+    // Run the function, either in a child process or directly.
+    // It's expected that either of these will return an error with appropriate context, not throw.
+    // (RenderFunctionResult is a superset of ServerEntryFunctionResult.)
+    let result;
     if (config.features?.enableSSR) {
-        return executeRenderScriptInSsrMode({
+        result = await runServerEntryInWorker({
             renderScriptPath,
-            renderScriptUrl: renderScriptUrlWithCacheBreaker,
             // TODO this should be a Node-specific import map
             importMap: ssrOptions.importMap,
-            options: ssrOptions,
-            req,
+            renderParams: ssrOptions,
         });
     }
-    // Legacy custom render mode: import and run the script directly
-    // TODO improve the naming and error messages (use getCustomRenderErrorResponse)
-    let createHtml;
-    let errorMessage;
-    try {
-        const importResult = (await import(renderScriptUrlWithCacheBreaker)).default;
-        if (typeof importResult === 'function') {
-            createHtml = importResult;
-        }
-        else {
-            errorMessage = `The render script at "${renderScriptPath}" does not export a default function.`;
-        }
-    }
-    catch (e) {
-        errorMessage = `Error importing render script at "${renderScriptUrl}":\n${e.stack || e}`;
-    }
-    if (createHtml) {
-        // Try running the script
-        try {
-            return await createHtml({ ...ssrOptions, session, req, res });
-        }
-        catch (e) {
-            errorMessage = `Error running render script at "${renderScriptPath}":\n${e.stack || e}`;
-        }
-    }
-    // Return an error page. Doing this instead of returning a default or empty response ensures that
-    // the user is aware of any configuration issues.
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- always set by now
-    return getErrorResponse({ req, message: errorMessage });
-}
-async function executeRenderScriptInSsrMode(params) {
-    const { renderScriptPath, renderScriptUrl, importMap, options } = params;
-    try {
-        return await runServerEntryInWorker({
-            renderScriptUrl,
-            importMap,
-            renderParams: options,
-        });
+    else {
+        result = await importAndRunScript(renderScriptPath, { ...ssrOptions, session, req, res });
     }
-    catch (err) {
-        // note: err might not be an instance of Error because of serialization
-        const errorMessage = err?.stack || err?.message || String(err);
-        return getCustomRenderErrorResponse({
-            req: params.req,
-            route: options.route,
-            message: `- error running script: ${errorMessage}`,
-            scriptPath: renderScriptPath,
+    if (result && typeof result === 'object' && 'error' in result) {
+        return handleCustomRenderError({
+            message: `:\n${result.error}`,
+            bundledPath: renderScriptPath,
         });
     }
+    return result;
 }
 //# sourceMappingURL=renderCustomScript.js.map

package/lib/renderRoute/ssr/renderCustomScript.js.map

@@ -1 +1 @@
-{"version":3,"file":"renderCustomScript.js","sourceRoot":"","sources":["../../../src/renderRoute/ssr/renderCustomScript.ts"],"names":[],"mappings":"AASA,OAAO,UAAU,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,OAAO,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AACxF,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAGC;AACD,6FAA6F;AAC7F,oDAAoD;AACpD,OAAiC;IAEjC,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,MAAM,CAAC;IAC1D,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAEtC,8DAA8D;IAC9D,MAAM,eAAe,GAAG,aAAa,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE,CAAC;IAEnE,gHAAgH;IAChH,iHAAiH;IACjH,sFAAsF;IACtF,gHAAgH;IAChH,IAAI,sBAAsB,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;IAChD,IAAI,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC1D,sBAAsB,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;IACnD,CAAC;IAAC,MAAM,CAAC;QACP,WAAW;IACb,CAAC;IAED,MAAM,UAAU,GAA+B;QAC7C,GAAG,OAAO;QACV,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,SAAS,EAAE,SAAS,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;QACvC,WAAW,EAAE;YACX,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,WAAW,EAAE,CAAC,CAAE,GAAG,CAAC,MAAoB,CAAC,SAAS;YAClD,WAAW,EAAE,GAAG,CAAC,WAAW;YAC5B,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,GAAG,EAAE,GAAG,CAAC,GAAG;SACb;KACF,CAAC;IAEF,MAAM,+BAA+B,GAAG,eAAe,GAAG,sBAAsB,CAAC;IAEjF,IAAI,MAAM,CAAC,QAAQ,EAAE,SAAS,EAAE,CAAC;QAC/B,OAAO,4BAA4B,CAAC;YAClC,gBAAgB;YAChB,eAAe,EAAE,+BAA+B;YAChD,iDAAiD;YACjD,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,OAAO,EAAE,UAAU;YACnB,GAAG;SACJ,CAAC,CAAC;IACL,CAAC;IAED,gEAAgE;IAChE,gFAAgF;IAChF,IAAI,UAAsC,CAAC;IAC3C,IAAI,YAAgC,CAAC;IACrC,IAAI,CAAC;QACH,MAAM,YAAY,GAAI,CAAC,MAAM,MAAM,CAAC,+BAA+B,CAAC,CAA0B,CAAC,OAAO,CAAC;QACvG,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;YACvC,UAAU,GAAG,YAAY,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,YAAY,GAAG,yBAAyB,gBAAgB,uCAAuC,CAAC;QAClG,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,YAAY,GAAG,qCAAqC,eAAe,OAAQ,CAAW,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;IACtG,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,yBAAyB;QACzB,IAAI,CAAC;YACH,OAAO,MAAM,UAAU,CAAC,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,YAAY,GAAG,mCAAmC,gBAAgB,OAAQ,CAAW,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;QACrG,CAAC;IACH,CAAC;IAED,iGAAiG;IACjG,iDAAiD;IACjD,yFAAyF;IACzF,OAAO,gBAAgB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,YAAa,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED,KAAK,UAAU,4BAA4B,CACzC,MAKC;IAED,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IACzE,IAAI,CAAC;QACH,OAAO,MAAM,sBAAsB,CAAC;YAClC,eAAe;YACf,SAAS;YACT,YAAY,EAAE,OAAO;SACtB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,uEAAuE;QACvE,MAAM,YAAY,GAAI,GAAa,EAAE,KAAK,IAAK,GAAa,EAAE,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;QACrF,OAAO,4BAA4B,CAAC;YAClC,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,OAAO,EAAE,2BAA2B,YAAY,EAAE;YAClD,UAAU,EAAE,gBAAgB;SAC7B,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["import type { Context } from '@ms-cloudpack/api-server';\nimport type {\n  ImportMap,\n  RenderFunction,\n  RenderFunctionResult,\n  RenderFunctionScript,\n  ServerEntryFunctionOptions,\n  ServerEntryFunctionResult,\n} from '@ms-cloudpack/common-types';\nimport fsPromises from 'fs/promises';\nimport type { TLSSocket } from 'tls';\nimport { pathToFileURL } from 'url';\nimport type { RenderRouteOptions } from '../../types/RenderRouteOptions.js';\nimport { getCustomRenderErrorResponse, getErrorResponse } from '../getErrorResponse.js';\nimport { runServerEntryInWorker } from './runServerEntryInWorker.js';\n\n/**\n * Load the default export from a JS file passed as the `renderScript` in a route,\n * and return either the result of running the function, or an error page if something fails.\n */\nexport async function renderCustomScript(\n  params: RenderRouteOptions & {\n    /** Full path to the render script (bundled version if relevant) */\n    renderScriptPath: string;\n  },\n  // only config and importMap are used in the new SSR signature, so in the future this can be:\n  // PartialContext<'session', 'config' | 'importMap'>\n  context: Pick<Context, 'session'>,\n): Promise<RenderFunctionResult> {\n  const { renderScriptPath, req, res, ...options } = params;\n  const { session } = context;\n  const { config, importMap } = session;\n\n  // Get the html factory function from a script default export.\n  const renderScriptUrl = pathToFileURL(renderScriptPath).toString();\n\n  // Note: because there isn't a way to purge the require cache, we need to add a cache breaker query param to the\n  // script path to ensure we get the latest version of the script. This could be improved by using the git hash of\n  // the file if it exists, or a hash of the content, or even the timestamp of the file.\n  // TODO: this won't work to update anything the file imports, and doesn't seem to work for serverEntry at all...\n  let cacheBreakerQueryParam = `?t=${Date.now()}`;\n  try {\n    const { mtime } = await fsPromises.stat(renderScriptPath);\n    cacheBreakerQueryParam = `?t=${mtime.getTime()}`;\n  } catch {\n    /* no-op */\n  }\n\n  const ssrOptions: ServerEntryFunctionOptions = {\n    ...options,\n    appPath: config.appPath,\n    importMap: importMap || { imports: {} },\n    requestInfo: {\n      headers: req.headers,\n      hostname: req.hostname,\n      isEncrypted: !!(req.socket as TLSSocket).encrypted,\n      originalUrl: req.originalUrl,\n      params: req.params,\n      query: req.query,\n      url: req.url,\n    },\n  };\n\n  const renderScriptUrlWithCacheBreaker = renderScriptUrl + cacheBreakerQueryParam;\n\n  if (config.features?.enableSSR) {\n    return executeRenderScriptInSsrMode({\n      renderScriptPath,\n      renderScriptUrl: renderScriptUrlWithCacheBreaker,\n      // TODO this should be a Node-specific import map\n      importMap: ssrOptions.importMap,\n      options: ssrOptions,\n      req,\n    });\n  }\n\n  // Legacy custom render mode: import and run the script directly\n  // TODO improve the naming and error messages (use getCustomRenderErrorResponse)\n  let createHtml: RenderFunction | undefined;\n  let errorMessage: string | undefined;\n  try {\n    const importResult = ((await import(renderScriptUrlWithCacheBreaker)) as RenderFunctionScript).default;\n    if (typeof importResult === 'function') {\n      createHtml = importResult;\n    } else {\n      errorMessage = `The render script at \"${renderScriptPath}\" does not export a default function.`;\n    }\n  } catch (e) {\n    errorMessage = `Error importing render script at \"${renderScriptUrl}\":\\n${(e as Error).stack || e}`;\n  }\n\n  if (createHtml) {\n    // Try running the script\n    try {\n      return await createHtml({ ...ssrOptions, session, req, res });\n    } catch (e) {\n      errorMessage = `Error running render script at \"${renderScriptPath}\":\\n${(e as Error).stack || e}`;\n    }\n  }\n\n  // Return an error page. Doing this instead of returning a default or empty response ensures that\n  // the user is aware of any configuration issues.\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- always set by now\n  return getErrorResponse({ req, message: errorMessage! });\n}\n\nasync function executeRenderScriptInSsrMode(\n  params: Pick<RenderRouteOptions, 'req'> & {\n    renderScriptPath: string;\n    renderScriptUrl: string;\n    importMap: ImportMap;\n    options: ServerEntryFunctionOptions;\n  },\n): Promise<ServerEntryFunctionResult> {\n  const { renderScriptPath, renderScriptUrl, importMap, options } = params;\n  try {\n    return await runServerEntryInWorker({\n      renderScriptUrl,\n      importMap,\n      renderParams: options,\n    });\n  } catch (err) {\n    // note: err might not be an instance of Error because of serialization\n    const errorMessage = (err as Error)?.stack || (err as Error)?.message || String(err);\n    return getCustomRenderErrorResponse({\n      req: params.req,\n      route: options.route,\n      message: `- error running script: ${errorMessage}`,\n      scriptPath: renderScriptPath,\n    });\n  }\n}\n"]}
+{"version":3,"file":"renderCustomScript.js","sourceRoot":"","sources":["../../../src/renderRoute/ssr/renderCustomScript.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAGpE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAIC;AACD,6FAA6F;AAC7F,oDAAoD;AACpD,OAAiC;IAEjC,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,uBAAuB,EAAE,GAAG,OAAO,EAAE,GAAG,MAAM,CAAC;IACnF,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAEtC,MAAM,UAAU,GAA+B;QAC7C,GAAG,OAAO;QACV,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,SAAS,EAAE,SAAS,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;QACvC,WAAW,EAAE;YACX,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,WAAW,EAAE,CAAC,CAAE,GAAG,CAAC,MAAoB,CAAC,SAAS;YAClD,WAAW,EAAE,GAAG,CAAC,WAAW;YAC5B,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,GAAG,EAAE,GAAG,CAAC,GAAG;SACb;KACF,CAAC;IAEF,2DAA2D;IAC3D,+FAA+F;IAC/F,qEAAqE;IACrE,IAAI,MAA6C,CAAC;IAClD,IAAI,MAAM,CAAC,QAAQ,EAAE,SAAS,EAAE,CAAC;QAC/B,MAAM,GAAG,MAAM,sBAAsB,CAAC;YACpC,gBAAgB;YAChB,iDAAiD;YACjD,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,YAAY,EAAE,UAAU;SACzB,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,MAAM,kBAAkB,CAAiB,gBAAgB,EAAE,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;QAC9D,OAAO,uBAAuB,CAAC;YAC7B,OAAO,EAAE,MAAM,MAAM,CAAC,KAAK,EAAE;YAC7B,WAAW,EAAE,gBAAgB;SAC9B,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import type { Context } from '@ms-cloudpack/api-server';\nimport type { RenderFunction, RenderFunctionResult, ServerEntryFunctionOptions } from '@ms-cloudpack/common-types';\nimport type { TLSSocket } from 'tls';\nimport type { CustomRenderErrorHandler } from '../getCustomRenderErrorHandler.js';\nimport { runServerEntryInWorker } from './runServerEntryInWorker.js';\nimport type { RenderRouteOptions } from '../../types/RenderRouteOptions.js';\nimport { importAndRunScript } from './worker/importAndRunScript.js';\nimport type { RunScriptResult } from './types/RunScriptResult.js';\n\n/**\n * Load the default export from a JS file passed as the `renderScript` in a route,\n * and return either the result of running the function, or an error page if something fails.\n */\nexport async function renderCustomScript(\n  params: RenderRouteOptions & {\n    /** Full path to the render script (bundled version if relevant) */\n    renderScriptPath: string;\n    handleCustomRenderError: CustomRenderErrorHandler;\n  },\n  // only config and importMap are used in the new SSR signature, so in the future this can be:\n  // PartialContext<'session', 'config' | 'importMap'>\n  context: Pick<Context, 'session'>,\n): Promise<RenderFunctionResult> {\n  const { renderScriptPath, req, res, handleCustomRenderError, ...options } = params;\n  const { session } = context;\n  const { config, importMap } = session;\n\n  const ssrOptions: ServerEntryFunctionOptions = {\n    ...options,\n    appPath: config.appPath,\n    importMap: importMap || { imports: {} },\n    requestInfo: {\n      headers: req.headers,\n      hostname: req.hostname,\n      isEncrypted: !!(req.socket as TLSSocket).encrypted,\n      originalUrl: req.originalUrl,\n      params: req.params,\n      query: req.query,\n      url: req.url,\n    },\n  };\n\n  // Run the function, either in a child process or directly.\n  // It's expected that either of these will return an error with appropriate context, not throw.\n  // (RenderFunctionResult is a superset of ServerEntryFunctionResult.)\n  let result: RunScriptResult<RenderFunctionResult>;\n  if (config.features?.enableSSR) {\n    result = await runServerEntryInWorker({\n      renderScriptPath,\n      // TODO this should be a Node-specific import map\n      importMap: ssrOptions.importMap,\n      renderParams: ssrOptions,\n    });\n  } else {\n    result = await importAndRunScript<RenderFunction>(renderScriptPath, { ...ssrOptions, session, req, res });\n  }\n\n  if (result && typeof result === 'object' && 'error' in result) {\n    return handleCustomRenderError({\n      message: `:\\n${result.error}`,\n      bundledPath: renderScriptPath,\n    });\n  }\n  return result;\n}\n"]}

package/lib/renderRoute/ssr/runServerEntryInWorker.d.ts

@@ -1,12 +1,13 @@
 import type { ServerEntryFunctionResult } from '@ms-cloudpack/common-types';
 import type { RunServerEntryOptions } from './types/RunServerEntryOptions.js';
+import type { RunScriptResult } from './types/RunScriptResult.js';
 /**
  * Run server entry in a child process pool. (Despite the naming, this does not use worker threads.)
- * Allows exceptions from the script to propagate.
+ *
+ * It should catch all exceptions and return them with appropriate extra text explaining the
+ * context where the error occurred (import vs run + the stack if relevant).
  */
-export declare function runServerEntryInWorker(options: RunServerEntryOptions & {
-    maxWorkers?: number;
-}): Promise<ServerEntryFunctionResult>;
+export declare function runServerEntryInWorker(options: RunServerEntryOptions): Promise<RunScriptResult<ServerEntryFunctionResult>>;
 /**
  * Dispose the server entry runner child processes.
  */

package/lib/renderRoute/ssr/runServerEntryInWorker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runServerEntryInWorker.d.ts","sourceRoot":"","sources":["../../../src/renderRoute/ssr/runServerEntryInWorker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAG5E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAM9E;;;GAGG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,qBAAqB,GAAG;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GACvD,OAAO,CAAC,yBAAyB,CAAC,CAiBpC;AAED;;GAEG;AACH,wBAAsB,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC,CAGlE"}
+{"version":3,"file":"runServerEntryInWorker.d.ts","sourceRoot":"","sources":["../../../src/renderRoute/ssr/runServerEntryInWorker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAG5E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAMlE;;;;;GAKG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,eAAe,CAAC,yBAAyB,CAAC,CAAC,CAyBrD;AAED;;GAEG;AACH,wBAAsB,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC,CAGlE"}

package/lib/renderRoute/ssr/runServerEntryInWorker.js

@@ -1,10 +1,12 @@
 import { WorkerPool } from '@ms-cloudpack/worker-pool';
 import path from 'path';
-const workerPath = path.join(import.meta.dirname, 'worker/ssrProcessEntry.js');
+const workerPath = path.join(import.meta.dirname, 'worker/ssrWorkerEntry.js');
 let workerPool;
 /**
  * Run server entry in a child process pool. (Despite the naming, this does not use worker threads.)
- * Allows exceptions from the script to propagate.
+ *
+ * It should catch all exceptions and return them with appropriate extra text explaining the
+ * context where the error occurred (import vs run + the stack if relevant).
  */
 export async function runServerEntryInWorker(options) {
     workerPool ??= new WorkerPool({
@@ -18,10 +20,19 @@ export async function runServerEntryInWorker(options) {
         // OOM crashes if cloudpack start is left running for a long time.
         inactiveTimeout: 5 * 60 * 1000,
     });
-    return workerPool.execute({
-        method: 'runServerEntry',
-        args: [options],
-    });
+    try {
+        return await workerPool.execute({
+            method: 'runServerEntry',
+            args: [options],
+        });
+    }
+    catch (err) {
+        // runServerEntry should catch errors directly from its code, so an error here might be
+        // some issue with the worker
+        return {
+            error: `Error running script in child process: ${err.stack || err}`,
+        };
+    }
 }
 /**
  * Dispose the server entry runner child processes.

package/lib/renderRoute/ssr/runServerEntryInWorker.js.map

@@ -1 +1 @@
-{"version":3,"file":"runServerEntryInWorker.js","sourceRoot":"","sources":["../../../src/renderRoute/ssr/runServerEntryInWorker.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,IAAI,MAAM,MAAM,CAAC;AAGxB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC;AAE/E,IAAI,UAAkC,CAAC;AAEvC;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAwD;IAExD,UAAU,KAAK,IAAI,UAAU,CAAC;QAC5B,UAAU,EAAE,SAAS;QACrB,IAAI,EAAE,uBAAuB;QAC7B,SAAS,EAAE,UAAU;QACrB,iFAAiF;QACjF,mEAAmE;QACnE,UAAU,EAAE,CAAC;QACb,6FAA6F;QAC7F,kEAAkE;QAClE,eAAe,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI;KAC/B,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC,OAAO,CAA4B;QACnD,MAAM,EAAE,gBAAgB;QACxB,IAAI,EAAE,CAAC,OAAO,CAAC;KAChB,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B;IAChD,MAAM,UAAU,EAAE,OAAO,EAAE,CAAC;IAC5B,UAAU,GAAG,SAAS,CAAC;AACzB,CAAC","sourcesContent":["import type { ServerEntryFunctionResult } from '@ms-cloudpack/common-types';\nimport { WorkerPool } from '@ms-cloudpack/worker-pool';\nimport path from 'path';\nimport type { RunServerEntryOptions } from './types/RunServerEntryOptions.js';\n\nconst workerPath = path.join(import.meta.dirname, 'worker/ssrProcessEntry.js');\n\nlet workerPool: WorkerPool | undefined;\n\n/**\n * Run server entry in a child process pool. (Despite the naming, this does not use worker threads.)\n * Allows exceptions from the script to propagate.\n */\nexport async function runServerEntryInWorker(\n  options: RunServerEntryOptions & { maxWorkers?: number },\n): Promise<ServerEntryFunctionResult> {\n  workerPool ??= new WorkerPool({\n    workerType: 'process',\n    name: 'serverEntry execution',\n    entryPath: workerPath,\n    // Currently we're unlikely to be server-rendering more than one thing at a time.\n    // Keep this low unless we find a case where it needs to be higher.\n    maxWorkers: 3,\n    // Stop inactive processes 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.\n    inactiveTimeout: 5 * 60 * 1000,\n  });\n\n  return workerPool.execute<ServerEntryFunctionResult>({\n    method: 'runServerEntry',\n    args: [options],\n  });\n}\n\n/**\n * Dispose the server entry runner child processes.\n */\nexport async function disposeServerEntryWorkerPool(): Promise<void> {\n  await workerPool?.dispose();\n  workerPool = undefined;\n}\n"]}
+{"version":3,"file":"runServerEntryInWorker.js","sourceRoot":"","sources":["../../../src/renderRoute/ssr/runServerEntryInWorker.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,IAAI,MAAM,MAAM,CAAC;AAIxB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;AAE9E,IAAI,UAAkC,CAAC;AAEvC;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAA8B;IAE9B,UAAU,KAAK,IAAI,UAAU,CAAC;QAC5B,UAAU,EAAE,SAAS;QACrB,IAAI,EAAE,uBAAuB;QAC7B,SAAS,EAAE,UAAU;QACrB,iFAAiF;QACjF,mEAAmE;QACnE,UAAU,EAAE,CAAC;QACb,6FAA6F;QAC7F,kEAAkE;QAClE,eAAe,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI;KAC/B,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,OAAO,MAAM,UAAU,CAAC,OAAO,CAA4B;YACzD,MAAM,EAAE,gBAAgB;YACxB,IAAI,EAAE,CAAC,OAAO,CAAC;SAChB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,uFAAuF;QACvF,6BAA6B;QAC7B,OAAO;YACL,KAAK,EAAE,0CAA2C,GAAa,CAAC,KAAK,IAAI,GAAG,EAAE;SAC/E,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B;IAChD,MAAM,UAAU,EAAE,OAAO,EAAE,CAAC;IAC5B,UAAU,GAAG,SAAS,CAAC;AACzB,CAAC","sourcesContent":["import type { ServerEntryFunctionResult } from '@ms-cloudpack/common-types';\nimport { WorkerPool } from '@ms-cloudpack/worker-pool';\nimport path from 'path';\nimport type { RunServerEntryOptions } from './types/RunServerEntryOptions.js';\nimport type { RunScriptResult } from './types/RunScriptResult.js';\n\nconst workerPath = path.join(import.meta.dirname, 'worker/ssrWorkerEntry.js');\n\nlet workerPool: WorkerPool | undefined;\n\n/**\n * Run server entry in a child process pool. (Despite the naming, this does not use worker threads.)\n *\n * It should catch all exceptions and return them with appropriate extra text explaining the\n * context where the error occurred (import vs run + the stack if relevant).\n */\nexport async function runServerEntryInWorker(\n  options: RunServerEntryOptions,\n): Promise<RunScriptResult<ServerEntryFunctionResult>> {\n  workerPool ??= new WorkerPool({\n    workerType: 'process',\n    name: 'serverEntry execution',\n    entryPath: workerPath,\n    // Currently we're unlikely to be server-rendering more than one thing at a time.\n    // Keep this low unless we find a case where it needs to be higher.\n    maxWorkers: 3,\n    // Stop inactive processes 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.\n    inactiveTimeout: 5 * 60 * 1000,\n  });\n\n  try {\n    return await workerPool.execute<ServerEntryFunctionResult>({\n      method: 'runServerEntry',\n      args: [options],\n    });\n  } catch (err) {\n    // runServerEntry should catch errors directly from its code, so an error here might be\n    // some issue with the worker\n    return {\n      error: `Error running script in child process: ${(err as Error).stack || err}`,\n    };\n  }\n}\n\n/**\n * Dispose the server entry runner child processes.\n */\nexport async function disposeServerEntryWorkerPool(): Promise<void> {\n  await workerPool?.dispose();\n  workerPool = undefined;\n}\n"]}

package/lib/renderRoute/ssr/types/RunScriptResult.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Result of `importAndRunScript` function that runs the `serverEntry` or `renderScript`.
+ */
+export type RunScriptResult<TResult> = TResult | {
+    /**
+     * Error message if there was an issue importing or running the script.
+     * This is formatted as a sentence and assumes the final version will be processed through a
+     * `CustomRenderErrorHandler` to add the route and path info.
+     */
+    error: string;
+};
+//# sourceMappingURL=RunScriptResult.d.ts.map

package/lib/renderRoute/ssr/types/RunScriptResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RunScriptResult.d.ts","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/types/RunScriptResult.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,OAAO,IAC/B,OAAO,GACP;IACE;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/lib/renderRoute/ssr/types/RunScriptResult.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=RunScriptResult.js.map

package/lib/renderRoute/ssr/types/RunScriptResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RunScriptResult.js","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/types/RunScriptResult.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Result of `importAndRunScript` function that runs the `serverEntry` or `renderScript`.\n */\nexport type RunScriptResult<TResult> =\n  | TResult\n  | {\n      /**\n       * Error message if there was an issue importing or running the script.\n       * This is formatted as a sentence and assumes the final version will be processed through a\n       * `CustomRenderErrorHandler` to add the route and path info.\n       */\n      error: string;\n    };\n"]}

package/lib/renderRoute/ssr/types/RunServerEntryOptions.d.ts

@@ -6,8 +6,8 @@ export type RunServerEntryOptions = {
      * (as of writing, it reuses the browser one)
      */
     importMap: ImportMap;
-    /** Absolute file URL for the render script (bundled if relevant) */
-    renderScriptUrl: string;
+    /** Absolute path to the render script (bundled if relevant) */
+    renderScriptPath: string;
     /** Params to pass to the user's render function */
     renderParams: ServerEntryFunctionOptions;
 };

package/lib/renderRoute/ssr/types/RunServerEntryOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RunServerEntryOptions.d.ts","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/types/RunServerEntryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAE1D,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB,oEAAoE;IACpE,eAAe,EAAE,MAAM,CAAC;IACxB,mDAAmD;IACnD,YAAY,EAAE,0BAA0B,CAAC;CAC1C,CAAC"}
+{"version":3,"file":"RunServerEntryOptions.d.ts","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/types/RunServerEntryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,4BAA4B,CAAC;AAC7E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAE1D,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;OAGG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB,+DAA+D;IAC/D,gBAAgB,EAAE,MAAM,CAAC;IACzB,mDAAmD;IACnD,YAAY,EAAE,0BAA0B,CAAC;CAC1C,CAAC"}

package/lib/renderRoute/ssr/types/RunServerEntryOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"RunServerEntryOptions.js","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/types/RunServerEntryOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { ServerEntryFunctionOptions } from '@ms-cloudpack/common-types';\nimport type { ImportMap } from '@ms-cloudpack/import-map';\n\nexport type RunServerEntryOptions = {\n  /**\n   * TODO: This should be the import map specific to the render script in Node\n   * (as of writing, it reuses the browser one)\n   */\n  importMap: ImportMap;\n  /** Absolute file URL for the render script (bundled if relevant) */\n  renderScriptUrl: string;\n  /** Params to pass to the user's render function */\n  renderParams: ServerEntryFunctionOptions;\n};\n"]}
+{"version":3,"file":"RunServerEntryOptions.js","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/types/RunServerEntryOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { ServerEntryFunctionOptions } from '@ms-cloudpack/common-types';\nimport type { ImportMap } from '@ms-cloudpack/import-map';\n\nexport type RunServerEntryOptions = {\n  /**\n   * TODO: This should be the import map specific to the render script in Node\n   * (as of writing, it reuses the browser one)\n   */\n  importMap: ImportMap;\n  /** Absolute path to the render script (bundled if relevant) */\n  renderScriptPath: string;\n  /** Params to pass to the user's render function */\n  renderParams: ServerEntryFunctionOptions;\n};\n"]}

package/lib/renderRoute/ssr/worker/importAndRunScript.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Import the `serverEntry` or `renderScript` and run the render function.
+ *
+ * It should catch all exceptions and return them with appropriate extra text explaining the
+ * context where the error occurred (import vs run + the stack if relevant).
+ *
+ * @param {string} scriptPath Absolute path to the script.
+ * @param {Parameters<F>[0]} options
+ * @returns {Promise<RunScriptResult<ReturnType<F>>>} The rendered result or an error message.
+ * @template {ServerEntryFunction | RenderFunction} F
+ */
+export function importAndRunScript<F extends ServerEntryFunction | RenderFunction>(scriptPath: string, options: Parameters<F>[0]): Promise<RunScriptResult<ReturnType<F>>>;
+import type { ServerEntryFunction } from '@ms-cloudpack/common-types';
+import type { RenderFunction } from '@ms-cloudpack/common-types';
+import type { RunScriptResult } from '../types/RunScriptResult.js';
+//# sourceMappingURL=importAndRunScript.d.ts.map

package/lib/renderRoute/ssr/worker/importAndRunScript.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"importAndRunScript.d.ts","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/worker/importAndRunScript.js"],"names":[],"mappings":"AAOA;;;;;;;;;;GAUG;AACH,mCAFoD,CAAC,SAAvC,mBAAmB,GAAG,cAAe,cAHxC,MAAM,WACN,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACd,OAAO,CAAC,gBAAgB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAyDnD;yCAvEuD,4BAA4B;oCAA5B,4BAA4B;qCAChD,6BAA6B"}

package/lib/renderRoute/ssr/worker/importAndRunScript.js

@@ -0,0 +1,70 @@
+/**
+ * @import { RenderFunction, ServerEntryFunction } from '@ms-cloudpack/common-types';
+ * @import { RunScriptResult } from '../types/RunScriptResult.js';
+ */
+import fs from 'fs';
+import { pathToFileURL } from 'url';
+/**
+ * Import the `serverEntry` or `renderScript` and run the render function.
+ *
+ * It should catch all exceptions and return them with appropriate extra text explaining the
+ * context where the error occurred (import vs run + the stack if relevant).
+ *
+ * @param {string} scriptPath Absolute path to the script.
+ * @param {Parameters<F>[0]} options
+ * @returns {Promise<RunScriptResult<ReturnType<F>>>} The rendered result or an error message.
+ * @template {ServerEntryFunction | RenderFunction} F
+ */
+export async function importAndRunScript(scriptPath, options) {
+    // Explicitly check if it exists, for a better error message.
+    if (!fs.existsSync(scriptPath)) {
+        return { error: 'File does not exist.' };
+    }
+    // Because there isn't a way to purge the require cache, we need to add a cache breaker query param to the
+    // script path to ensure we get the latest version of the script. This could be improved by using the git hash of
+    // the file if it exists, or a hash of the content, or even the timestamp of the file.
+    // TODO: this won't work to update anything the file imports, and doesn't seem to work for serverEntry at all...
+    let cacheBreakerQueryParam = `?t=${Date.now()}`;
+    try {
+        const { mtime } = fs.statSync(scriptPath);
+        cacheBreakerQueryParam = `?t=${mtime.getTime()}`;
+    }
+    catch {
+        /* no-op */
+    }
+    const scriptUrl = pathToFileURL(scriptPath).toString() + cacheBreakerQueryParam;
+    // Import the script and try to find the render function.
+    let /** @type {F | undefined} */ renderFunction;
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- misses jsdoc cast
+        const { default: defaultExport, render } = /** @type {{ default?: F | { render?: F }; render?: F; }} */ (await import(scriptUrl));
+        renderFunction =
+            typeof render === 'function'
+                ? render
+                : typeof defaultExport === 'function'
+                    ? defaultExport
+                    : // less likely case for CJS interop quirks
+                        defaultExport && typeof defaultExport.render === 'function'
+                            ? defaultExport.render
+                            : undefined;
+    }
+    catch (error) {
+        // Include the stack here because this might be an error running the script.
+        // (It shouldn't be a module not found error since we checked existence above.)
+        return { error: `Error importing script: ${ /** @type {Error} */(error).stack || error}` };
+    }
+    if (!renderFunction) {
+        return { error: 'Render function not found in script (it must be the default export or a named export "render").' };
+    }
+    // Try running the script
+    try {
+        // Type inference is getting lost for some reason
+        return /** @type {ReturnType<F>} */ (await renderFunction(/** @type {*} */ (options)));
+    }
+    catch (error) {
+        return {
+            error: `Render function threw an error:\n${ /** @type {Error} */(error).stack || error}`,
+        };
+    }
+}
+//# sourceMappingURL=importAndRunScript.js.map

package/lib/renderRoute/ssr/worker/importAndRunScript.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"importAndRunScript.js","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/worker/importAndRunScript.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,UAAU,EAAE,OAAO;IAC1D,6DAA6D;IAC7D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/B,OAAO,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC;IAC3C,CAAC;IAED,0GAA0G;IAC1G,iHAAiH;IACjH,sFAAsF;IACtF,gHAAgH;IAChH,IAAI,sBAAsB,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;IAChD,IAAI,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,sBAAsB,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;IACnD,CAAC;IAAC,MAAM,CAAC;QACP,WAAW;IACb,CAAC;IACD,MAAM,SAAS,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,GAAG,sBAAsB,CAAC;IAEhF,yDAAyD;IACzD,IAAI,4BAA4B,CAAC,cAAc,CAAC;IAChD,IAAI,CAAC;QACH,wFAAwF;QACxF,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,4DAA4D,CAAC,CACtG,MAAM,MAAM,CAAC,SAAS,CAAC,CACxB,CAAC;QACF,cAAc;YACZ,OAAO,MAAM,KAAK,UAAU;gBAC1B,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,OAAO,aAAa,KAAK,UAAU;oBACnC,CAAC,CAAC,aAAa;oBACf,CAAC,CAAC,0CAA0C;wBAC1C,aAAa,IAAI,OAAO,aAAa,CAAC,MAAM,KAAK,UAAU;4BAC3D,CAAC,CAAC,aAAa,CAAC,MAAM;4BACtB,CAAC,CAAC,SAAS,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,4EAA4E;QAC5E,+EAA+E;QAC/E,OAAO,EAAE,KAAK,EAAE,2BAA2B,CAAA,oBAAqB,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,KAAK,EAAE,EAAE,CAAC;IAC7F,CAAC;IAED,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,EAAE,KAAK,EAAE,iGAAiG,EAAE,CAAC;IACtH,CAAC;IAED,yBAAyB;IACzB,IAAI,CAAC;QACH,iDAAiD;QACjD,OAAO,4BAA4B,CAAC,CAAC,MAAM,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACzF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,KAAK,EAAE,oCAAoC,CAAA,oBAAqB,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,KAAK,EAAE;SACzF,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["/**\n * @import { RenderFunction, ServerEntryFunction } from '@ms-cloudpack/common-types';\n * @import { RunScriptResult } from '../types/RunScriptResult.js';\n */\nimport fs from 'fs';\nimport { pathToFileURL } from 'url';\n\n/**\n * Import the `serverEntry` or `renderScript` and run the render function.\n *\n * It should catch all exceptions and return them with appropriate extra text explaining the\n * context where the error occurred (import vs run + the stack if relevant).\n *\n * @param {string} scriptPath Absolute path to the script.\n * @param {Parameters<F>[0]} options\n * @returns {Promise<RunScriptResult<ReturnType<F>>>} The rendered result or an error message.\n * @template {ServerEntryFunction | RenderFunction} F\n */\nexport async function importAndRunScript(scriptPath, options) {\n  // Explicitly check if it exists, for a better error message.\n  if (!fs.existsSync(scriptPath)) {\n    return { error: 'File does not exist.' };\n  }\n\n  // Because there isn't a way to purge the require cache, we need to add a cache breaker query param to the\n  // script path to ensure we get the latest version of the script. This could be improved by using the git hash of\n  // the file if it exists, or a hash of the content, or even the timestamp of the file.\n  // TODO: this won't work to update anything the file imports, and doesn't seem to work for serverEntry at all...\n  let cacheBreakerQueryParam = `?t=${Date.now()}`;\n  try {\n    const { mtime } = fs.statSync(scriptPath);\n    cacheBreakerQueryParam = `?t=${mtime.getTime()}`;\n  } catch {\n    /* no-op */\n  }\n  const scriptUrl = pathToFileURL(scriptPath).toString() + cacheBreakerQueryParam;\n\n  // Import the script and try to find the render function.\n  let /** @type {F | undefined} */ renderFunction;\n  try {\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- misses jsdoc cast\n    const { default: defaultExport, render } = /** @type {{ default?: F | { render?: F }; render?: F; }} */ (\n      await import(scriptUrl)\n    );\n    renderFunction =\n      typeof render === 'function'\n        ? render\n        : typeof defaultExport === 'function'\n          ? defaultExport\n          : // less likely case for CJS interop quirks\n            defaultExport && typeof defaultExport.render === 'function'\n            ? defaultExport.render\n            : undefined;\n  } catch (error) {\n    // Include the stack here because this might be an error running the script.\n    // (It shouldn't be a module not found error since we checked existence above.)\n    return { error: `Error importing script: ${/** @type {Error} */ (error).stack || error}` };\n  }\n\n  if (!renderFunction) {\n    return { error: 'Render function not found in script (it must be the default export or a named export \"render\").' };\n  }\n\n  // Try running the script\n  try {\n    // Type inference is getting lost for some reason\n    return /** @type {ReturnType<F>} */ (await renderFunction(/** @type {*} */ (options)));\n  } catch (error) {\n    return {\n      error: `Render function threw an error:\\n${/** @type {Error} */ (error).stack || error}`,\n    };\n  }\n}\n"]}

package/lib/renderRoute/ssr/worker/runServerEntry.d.ts

@@ -1,10 +1,13 @@
 /**
  * Register the import map loader with `options.importMap`, then import and run the render script.
- * Throws if the script path is invalid, and allows exceptions from within the script to propagate.
+ *
+ * It should catch all exceptions and return them with appropriate extra text explaining the
+ * context where the error occurred (import vs run + the stack if relevant).
  * @param {RunServerEntryOptions} options
- * @returns {Promise<RenderFunctionResult>}
+ * @returns {Promise<RunScriptResult<ServerEntryFunctionResult>>}
  */
-export function runServerEntry(options: RunServerEntryOptions): Promise<RenderFunctionResult>;
+export function runServerEntry(options: RunServerEntryOptions): Promise<RunScriptResult<ServerEntryFunctionResult>>;
 import type { RunServerEntryOptions } from '../types/RunServerEntryOptions.js';
-import type { RenderFunctionResult } from '@ms-cloudpack/common-types';
+import type { ServerEntryFunctionResult } from '@ms-cloudpack/common-types';
+import type { RunScriptResult } from '../types/RunScriptResult.js';
 //# sourceMappingURL=runServerEntry.d.ts.map

package/lib/renderRoute/ssr/worker/runServerEntry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runServerEntry.d.ts","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/worker/runServerEntry.js"],"names":[],"mappings":"AAuBA;;;;;GAKG;AACH,wCAHW,qBAAqB,GACnB,OAAO,CAAC,oBAAoB,CAAC,CA4BzC;2CAjDyC,mCAAmC;0CADnE,4BAA4B"}
+{"version":3,"file":"runServerEntry.d.ts","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/worker/runServerEntry.js"],"names":[],"mappings":"AAyBA;;;;;;;GAOG;AACH,wCAHW,qBAAqB,GACnB,OAAO,CAAC,gBAAgB,yBAAyB,CAAC,CAAC,CA4C/D;2CArEyC,mCAAmC;+CADnE,4BAA4B;qCAEF,6BAA6B"}

package/lib/renderRoute/ssr/worker/runServerEntry.js

@@ -1,14 +1,16 @@
 /**
  * @import {
  *   ImportMap,
- *   RenderFunctionResult,
- *   ServerEntryFunctionScript
+ *   ServerEntryFunctionOptions,
+ *   ServerEntryFunctionResult,
  * } from '@ms-cloudpack/common-types';
  * @import { RunServerEntryOptions } from '../types/RunServerEntryOptions.js';
+ * @import { RunScriptResult } from '../types/RunScriptResult.js';
  * @import { ImportMapLoaderContext, UpdateImportMapMessage, UpdateImportMapResult } from './importMapLoader.js';
  */
 import { register } from 'node:module';
 import { MessageChannel } from 'node:worker_threads';
+import { importAndRunScript } from './importAndRunScript.js';
 let hasInitialized = false;
 // See updateImportMap comment
 const channel = new MessageChannel();
@@ -20,67 +22,84 @@ parentPort.unref();
 loaderPort.unref();
 /**
  * Register the import map loader with `options.importMap`, then import and run the render script.
- * Throws if the script path is invalid, and allows exceptions from within the script to propagate.
+ *
+ * It should catch all exceptions and return them with appropriate extra text explaining the
+ * context where the error occurred (import vs run + the stack if relevant).
  * @param {RunServerEntryOptions} options
- * @returns {Promise<RenderFunctionResult>}
+ * @returns {Promise<RunScriptResult<ServerEntryFunctionResult>>}
  */
 export async function runServerEntry(options) {
-    const { importMap, renderScriptUrl, renderParams } = options;
-    if (!hasInitialized) {
-        // Register the custom loader, which is responsible for handling "bare" import resolution
-        // using the import map where necessary.
-        hasInitialized = true;
-        const /** @type {ImportMapLoaderContext} */ context = { port: loaderPort };
-        register('./importMapLoader.js', {
-            parentURL: import.meta.url,
-            data: context,
-            transferList: [loaderPort],
-        });
+    const { importMap, renderScriptPath, renderParams } = options;
+    try {
+        if (!hasInitialized) {
+            // Register the custom loader, which is responsible for handling "bare" import resolution
+            // using the import map where necessary.
+            hasInitialized = true;
+            const /** @type {ImportMapLoaderContext} */ context = { port: loaderPort };
+            register('./importMapLoader.js', {
+                parentURL: import.meta.url,
+                data: context,
+                transferList: [loaderPort],
+            });
+        }
+        // Send the latest import map to the loader
+        const updateImportMapResult = await updateImportMap(importMap);
+        if (updateImportMapResult.error) {
+            // jsdoc type inference failure??
+            return { error: updateImportMapResult.error };
+        }
     }
-    // Send the latest import map to the loader
-    await updateImportMap(importMap);
-    // Import the render script, which will use the custom import map if relevant
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- missed jsdoc cast
-    const render = /** @type {ServerEntryFunctionScript} */ (await import(renderScriptUrl)).default;
-    if (typeof render !== 'function') {
-        throw new Error(`The serverEntry script does not export a default function.`);
+    catch (err) {
+        return {
+            error: `Error updating import map before running serverEntry: ${ /** @type {Error} */(err).stack || err}`,
+        };
     }
-    return await render(renderParams);
+    // Import the render script, which will use the custom import map if relevant
+    // (jsdoc doesn't have a direct way to provide the type parameter)
+    return /** @type {Promise<RunScriptResult<ServerEntryFunctionResult>>} */ (importAndRunScript(renderScriptPath, 
+    /** @type {ServerEntryFunctionOptions} */ ({
+        ...renderParams,
+        // Use proxies to throw errors on unsupported sub-property usage to help with migration.
+        req: getInvalidPropProxy('req'),
+        res: getInvalidPropProxy('res'),
+        session: getInvalidPropProxy('session'),
+    })));
 }
 /**
  * We have to update the import map for importMapLoader.js via message ports, since the
  * customization hooks run in a separate thread.
  * @param {ImportMap} importMap
- * @returns {Promise<void>}
+ * @returns {Promise<{ error?: string }>} Empty object on success, or message on caught error.
+ * It might also throw an exception if `postMessage()` fails somehow.
  */
 function updateImportMap(importMap) {
-    return new Promise((resolve, reject) => {
+    return new Promise((resolve) => {
         // Before sending the message, add one-off handlers for all cases to be safe.
         // This is just sending an object and waiting for confirmation, so errors are very unlikely.
         const onMessage = (/** @type {UpdateImportMapResult} */ result) => {
             handlersOff();
             if (result === true) {
-                resolve();
+                resolve({});
             }
             else if (result === false) {
                 // extremely unlikely
-                reject(new Error('Failed to update import map before running serverEntry'));
+                resolve({ error: 'Failed to update import map before running serverEntry' });
             }
             else {
                 // even less likely
-                reject(new Error(`Unexpected message from import map loader: ${JSON.stringify(message)}`));
+                resolve({ error: `Unexpected message from import map loader: ${JSON.stringify(message)}` });
             }
         };
         parentPort.once('message', onMessage);
         const onError = (/** @type {*} */ error) => {
             handlersOff();
-            reject(new Error(`Error updating import map before running serverEntry: ${error}`));
+            resolve({ error: `Error updating import map before running serverEntry: ${error}` });
         };
         parentPort.once('error', onError);
         // This should happen almost instantly, so conservatively time out after 1s
         const timeout = setTimeout(() => {
             handlersOff();
-            reject(new Error('Timed out waiting for import map update confirmation from loader'));
+            resolve({ error: 'Timed out waiting for import map update confirmation from loader' });
         }, 1000);
         const handlersOff = () => {
             parentPort.off('message', onMessage);
@@ -91,4 +110,23 @@ function updateImportMap(importMap) {
         parentPort.postMessage(message);
     });
 }
+/**
+ * Creates a proxy that throws an error when sub-properties of old non-SSR-friendly
+ * `RenderFunctionOptions` props are accessed. (The error is only thrown on sub-property access
+ * in case the top-level props are destructured but not actually used, and so that we don't need to
+ * make the whole options object into a proxy since that could have unintended side effects.)
+ * @param {string} propName The name of the `RenderFunctionOptions` property being accessed.
+ * @returns {unknown} the proxy
+ */
+function getInvalidPropProxy(propName) {
+    return new Proxy({}, {
+        get() {
+            // This will be caught and logged by an error handler which adds in info about the
+            // route and file the error came from
+            throw new Error(`"${propName}" is not supported with the "enableSSR" feature. ` +
+                'Please see the migration guide at https://microsoft.github.io/cloudpack/reference/custom-rendering#migration, ' +
+                'or disable the feature for now.');
+        },
+    });
+}
 //# sourceMappingURL=runServerEntry.js.map

package/lib/renderRoute/ssr/worker/runServerEntry.js.map

@@ -1 +1 @@
-{"version":3,"file":"runServerEntry.js","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/worker/runServerEntry.js"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,IAAI,cAAc,GAAG,KAAK,CAAC;AAE3B,8BAA8B;AAC9B,MAAM,OAAO,GAAG,IAAI,cAAc,EAAE,CAAC;AACrC,6DAA6D;AAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;AACjC,6DAA6D;AAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;AACjC,UAAU,CAAC,KAAK,EAAE,CAAC;AACnB,UAAU,CAAC,KAAK,EAAE,CAAC;AAEnB;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAO;IAC1C,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IAE7D,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,yFAAyF;QACzF,wCAAwC;QACxC,cAAc,GAAG,IAAI,CAAC;QACtB,MAAM,qCAAqC,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;QAC3E,QAAQ,CAAC,sBAAsB,EAAE;YAC/B,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;YAC1B,IAAI,EAAE,OAAO;YACb,YAAY,EAAE,CAAC,UAAU,CAAC;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,2CAA2C;IAC3C,MAAM,eAAe,CAAC,SAAS,CAAC,CAAC;IAEjC,6EAA6E;IAC7E,2FAA2F;IAC3F,MAAM,MAAM,GAAG,wCAAwC,CAAC,CAAC,MAAM,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC;IAChG,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IAChF,CAAC;IAED,OAAO,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAC,SAAS;IAChC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,6EAA6E;QAC7E,4FAA4F;QAC5F,MAAM,SAAS,GAAG,CAAC,oCAAoC,CAAC,MAAM,EAAE,EAAE;YAChE,WAAW,EAAE,CAAC;YACd,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACpB,OAAO,EAAE,CAAC;YACZ,CAAC;iBAAM,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;gBAC5B,qBAAqB;gBACrB,MAAM,CAAC,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC,CAAC;YAC9E,CAAC;iBAAM,CAAC;gBACN,mBAAmB;gBACnB,MAAM,CAAC,IAAI,KAAK,CAAC,8CAA8C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;YAC7F,CAAC;QACH,CAAC,CAAC;QAEF,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,EAAE;YACzC,WAAW,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,KAAK,CAAC,yDAAyD,KAAK,EAAE,CAAC,CAAC,CAAC;QACtF,CAAC,CAAC;QACF,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAElC,2EAA2E;QAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC9B,WAAW,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC,CAAC;QACxF,CAAC,EAAE,IAAI,CAAC,CAAC;QAET,MAAM,WAAW,GAAG,GAAG,EAAE;YACvB,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACrC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACjC,YAAY,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC,CAAC;QAEF,MAAM,qCAAqC,CAAC,OAAO,GAAG,EAAE,SAAS,EAAE,CAAC;QACpE,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["/**\n * @import {\n *   ImportMap,\n *   RenderFunctionResult,\n *   ServerEntryFunctionScript\n * } from '@ms-cloudpack/common-types';\n * @import { RunServerEntryOptions } from '../types/RunServerEntryOptions.js';\n * @import { ImportMapLoaderContext, UpdateImportMapMessage, UpdateImportMapResult } from './importMapLoader.js';\n */\nimport { register } from 'node:module';\nimport { MessageChannel } from 'node:worker_threads';\n\nlet hasInitialized = false;\n\n// See updateImportMap comment\nconst channel = new MessageChannel();\n/** Port used by the parent to communicate with the loader */\nconst parentPort = channel.port1;\n/** Port used by the loader to communicate with the parent */\nconst loaderPort = channel.port2;\nparentPort.unref();\nloaderPort.unref();\n\n/**\n * Register the import map loader with `options.importMap`, then import and run the render script.\n * Throws if the script path is invalid, and allows exceptions from within the script to propagate.\n * @param {RunServerEntryOptions} options\n * @returns {Promise<RenderFunctionResult>}\n */\nexport async function runServerEntry(options) {\n  const { importMap, renderScriptUrl, renderParams } = options;\n\n  if (!hasInitialized) {\n    // Register the custom loader, which is responsible for handling \"bare\" import resolution\n    // using the import map where necessary.\n    hasInitialized = true;\n    const /** @type {ImportMapLoaderContext} */ context = { port: loaderPort };\n    register('./importMapLoader.js', {\n      parentURL: import.meta.url,\n      data: context,\n      transferList: [loaderPort],\n    });\n  }\n\n  // Send the latest import map to the loader\n  await updateImportMap(importMap);\n\n  // Import the render script, which will use the custom import map if relevant\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access -- missed jsdoc cast\n  const render = /** @type {ServerEntryFunctionScript} */ (await import(renderScriptUrl)).default;\n  if (typeof render !== 'function') {\n    throw new Error(`The serverEntry script does not export a default function.`);\n  }\n\n  return await render(renderParams);\n}\n\n/**\n * We have to update the import map for importMapLoader.js via message ports, since the\n * customization hooks run in a separate thread.\n * @param {ImportMap} importMap\n * @returns {Promise<void>}\n */\nfunction updateImportMap(importMap) {\n  return new Promise((resolve, reject) => {\n    // Before sending the message, add one-off handlers for all cases to be safe.\n    // This is just sending an object and waiting for confirmation, so errors are very unlikely.\n    const onMessage = (/** @type {UpdateImportMapResult} */ result) => {\n      handlersOff();\n      if (result === true) {\n        resolve();\n      } else if (result === false) {\n        // extremely unlikely\n        reject(new Error('Failed to update import map before running serverEntry'));\n      } else {\n        // even less likely\n        reject(new Error(`Unexpected message from import map loader: ${JSON.stringify(message)}`));\n      }\n    };\n\n    parentPort.once('message', onMessage);\n    const onError = (/** @type {*} */ error) => {\n      handlersOff();\n      reject(new Error(`Error updating import map before running serverEntry: ${error}`));\n    };\n    parentPort.once('error', onError);\n\n    // This should happen almost instantly, so conservatively time out after 1s\n    const timeout = setTimeout(() => {\n      handlersOff();\n      reject(new Error('Timed out waiting for import map update confirmation from loader'));\n    }, 1000);\n\n    const handlersOff = () => {\n      parentPort.off('message', onMessage);\n      parentPort.off('error', onError);\n      clearTimeout(timeout);\n    };\n\n    const /** @type {UpdateImportMapMessage} */ message = { importMap };\n    parentPort.postMessage(message);\n  });\n}\n"]}
+{"version":3,"file":"runServerEntry.js","sourceRoot":"","sources":["../../../../src/renderRoute/ssr/worker/runServerEntry.js"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D,IAAI,cAAc,GAAG,KAAK,CAAC;AAE3B,8BAA8B;AAC9B,MAAM,OAAO,GAAG,IAAI,cAAc,EAAE,CAAC;AACrC,6DAA6D;AAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;AACjC,6DAA6D;AAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;AACjC,UAAU,CAAC,KAAK,EAAE,CAAC;AACnB,UAAU,CAAC,KAAK,EAAE,CAAC;AAEnB;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAO;IAC1C,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IAE9D,IAAI,CAAC;QACH,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,yFAAyF;YACzF,wCAAwC;YACxC,cAAc,GAAG,IAAI,CAAC;YACtB,MAAM,qCAAqC,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YAC3E,QAAQ,CAAC,sBAAsB,EAAE;gBAC/B,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;gBAC1B,IAAI,EAAE,OAAO;gBACb,YAAY,EAAE,CAAC,UAAU,CAAC;aAC3B,CAAC,CAAC;QACL,CAAC;QAED,2CAA2C;QAC3C,MAAM,qBAAqB,GAAG,MAAM,eAAe,CAAC,SAAS,CAAC,CAAC;QAC/D,IAAI,qBAAqB,CAAC,KAAK,EAAE,CAAC;YAChC,iCAAiC;YACjC,OAAO,EAAE,KAAK,EAAE,qBAAqB,CAAC,KAAK,EAAE,CAAC;QAChD,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO;YACL,KAAK,EAAE,yDAAyD,CAAA,oBAAqB,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,GAAG,EAAE;SAC1G,CAAC;IACJ,CAAC;IAED,6EAA6E;IAC7E,kEAAkE;IAClE,OAAO,kEAAkE,CAAC,CACxE,kBAAkB,CAChB,gBAAgB;IAChB,yCAAyC,CAAC,CAAC;QACzC,GAAG,YAAY;QACf,wFAAwF;QACxF,GAAG,EAAE,mBAAmB,CAAC,KAAK,CAAC;QAC/B,GAAG,EAAE,mBAAmB,CAAC,KAAK,CAAC;QAC/B,OAAO,EAAE,mBAAmB,CAAC,SAAS,CAAC;KACxC,CAAC,CACH,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,SAAS;IAChC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,6EAA6E;QAC7E,4FAA4F;QAC5F,MAAM,SAAS,GAAG,CAAC,oCAAoC,CAAC,MAAM,EAAE,EAAE;YAChE,WAAW,EAAE,CAAC;YACd,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACpB,OAAO,CAAC,EAAE,CAAC,CAAC;YACd,CAAC;iBAAM,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;gBAC5B,qBAAqB;gBACrB,OAAO,CAAC,EAAE,KAAK,EAAE,wDAAwD,EAAE,CAAC,CAAC;YAC/E,CAAC;iBAAM,CAAC;gBACN,mBAAmB;gBACnB,OAAO,CAAC,EAAE,KAAK,EAAE,8CAA8C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9F,CAAC;QACH,CAAC,CAAC;QAEF,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,EAAE,EAAE;YACzC,WAAW,EAAE,CAAC;YACd,OAAO,CAAC,EAAE,KAAK,EAAE,yDAAyD,KAAK,EAAE,EAAE,CAAC,CAAC;QACvF,CAAC,CAAC;QACF,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAElC,2EAA2E;QAC3E,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC9B,WAAW,EAAE,CAAC;YACd,OAAO,CAAC,EAAE,KAAK,EAAE,kEAAkE,EAAE,CAAC,CAAC;QACzF,CAAC,EAAE,IAAI,CAAC,CAAC;QAET,MAAM,WAAW,GAAG,GAAG,EAAE;YACvB,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACrC,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACjC,YAAY,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC,CAAC;QAEF,MAAM,qCAAqC,CAAC,OAAO,GAAG,EAAE,SAAS,EAAE,CAAC;QACpE,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,mBAAmB,CAAC,QAAQ;IACnC,OAAO,IAAI,KAAK,CACd,EAAE,EACF;QACE,GAAG;YACD,kFAAkF;YAClF,qCAAqC;YACrC,MAAM,IAAI,KAAK,CACb,IAAI,QAAQ,mDAAmD;gBAC7D,gHAAgH;gBAChH,iCAAiC,CACpC,CAAC;QACJ,CAAC;KACF,CACF,CAAC;AACJ,CAAC","sourcesContent":["/**\n * @import {\n *   ImportMap,\n *   ServerEntryFunctionOptions,\n *   ServerEntryFunctionResult,\n * } from '@ms-cloudpack/common-types';\n * @import { RunServerEntryOptions } from '../types/RunServerEntryOptions.js';\n * @import { RunScriptResult } from '../types/RunScriptResult.js';\n * @import { ImportMapLoaderContext, UpdateImportMapMessage, UpdateImportMapResult } from './importMapLoader.js';\n */\nimport { register } from 'node:module';\nimport { MessageChannel } from 'node:worker_threads';\nimport { importAndRunScript } from './importAndRunScript.js';\n\nlet hasInitialized = false;\n\n// See updateImportMap comment\nconst channel = new MessageChannel();\n/** Port used by the parent to communicate with the loader */\nconst parentPort = channel.port1;\n/** Port used by the loader to communicate with the parent */\nconst loaderPort = channel.port2;\nparentPort.unref();\nloaderPort.unref();\n\n/**\n * Register the import map loader with `options.importMap`, then import and run the render script.\n *\n * It should catch all exceptions and return them with appropriate extra text explaining the\n * context where the error occurred (import vs run + the stack if relevant).\n * @param {RunServerEntryOptions} options\n * @returns {Promise<RunScriptResult<ServerEntryFunctionResult>>}\n */\nexport async function runServerEntry(options) {\n  const { importMap, renderScriptPath, renderParams } = options;\n\n  try {\n    if (!hasInitialized) {\n      // Register the custom loader, which is responsible for handling \"bare\" import resolution\n      // using the import map where necessary.\n      hasInitialized = true;\n      const /** @type {ImportMapLoaderContext} */ context = { port: loaderPort };\n      register('./importMapLoader.js', {\n        parentURL: import.meta.url,\n        data: context,\n        transferList: [loaderPort],\n      });\n    }\n\n    // Send the latest import map to the loader\n    const updateImportMapResult = await updateImportMap(importMap);\n    if (updateImportMapResult.error) {\n      // jsdoc type inference failure??\n      return { error: updateImportMapResult.error };\n    }\n  } catch (err) {\n    return {\n      error: `Error updating import map before running serverEntry: ${/** @type {Error} */ (err).stack || err}`,\n    };\n  }\n\n  // Import the render script, which will use the custom import map if relevant\n  // (jsdoc doesn't have a direct way to provide the type parameter)\n  return /** @type {Promise<RunScriptResult<ServerEntryFunctionResult>>} */ (\n    importAndRunScript(\n      renderScriptPath,\n      /** @type {ServerEntryFunctionOptions} */ ({\n        ...renderParams,\n        // Use proxies to throw errors on unsupported sub-property usage to help with migration.\n        req: getInvalidPropProxy('req'),\n        res: getInvalidPropProxy('res'),\n        session: getInvalidPropProxy('session'),\n      }),\n    )\n  );\n}\n\n/**\n * We have to update the import map for importMapLoader.js via message ports, since the\n * customization hooks run in a separate thread.\n * @param {ImportMap} importMap\n * @returns {Promise<{ error?: string }>} Empty object on success, or message on caught error.\n * It might also throw an exception if `postMessage()` fails somehow.\n */\nfunction updateImportMap(importMap) {\n  return new Promise((resolve) => {\n    // Before sending the message, add one-off handlers for all cases to be safe.\n    // This is just sending an object and waiting for confirmation, so errors are very unlikely.\n    const onMessage = (/** @type {UpdateImportMapResult} */ result) => {\n      handlersOff();\n      if (result === true) {\n        resolve({});\n      } else if (result === false) {\n        // extremely unlikely\n        resolve({ error: 'Failed to update import map before running serverEntry' });\n      } else {\n        // even less likely\n        resolve({ error: `Unexpected message from import map loader: ${JSON.stringify(message)}` });\n      }\n    };\n\n    parentPort.once('message', onMessage);\n    const onError = (/** @type {*} */ error) => {\n      handlersOff();\n      resolve({ error: `Error updating import map before running serverEntry: ${error}` });\n    };\n    parentPort.once('error', onError);\n\n    // This should happen almost instantly, so conservatively time out after 1s\n    const timeout = setTimeout(() => {\n      handlersOff();\n      resolve({ error: 'Timed out waiting for import map update confirmation from loader' });\n    }, 1000);\n\n    const handlersOff = () => {\n      parentPort.off('message', onMessage);\n      parentPort.off('error', onError);\n      clearTimeout(timeout);\n    };\n\n    const /** @type {UpdateImportMapMessage} */ message = { importMap };\n    parentPort.postMessage(message);\n  });\n}\n\n/**\n * Creates a proxy that throws an error when sub-properties of old non-SSR-friendly\n * `RenderFunctionOptions` props are accessed. (The error is only thrown on sub-property access\n * in case the top-level props are destructured but not actually used, and so that we don't need to\n * make the whole options object into a proxy since that could have unintended side effects.)\n * @param {string} propName The name of the `RenderFunctionOptions` property being accessed.\n * @returns {unknown} the proxy\n */\nfunction getInvalidPropProxy(propName) {\n  return new Proxy(\n    {},\n    {\n      get() {\n        // This will be caught and logged by an error handler which adds in info about the\n        // route and file the error came from\n        throw new Error(\n          `\"${propName}\" is not supported with the \"enableSSR\" feature. ` +\n            'Please see the migration guide at https://microsoft.github.io/cloudpack/reference/custom-rendering#migration, ' +\n            'or disable the feature for now.',\n        );\n      },\n    },\n  );\n}\n"]}