@lwrjs/core 0.17.2-alpha.2 → 0.17.2-alpha.20

package/build/cjs/middleware/bundle-middleware.cjs

@@ -45,17 +45,17 @@ function createBundleMiddleware(context) {
   return async (req, res) => {
     if (!req.validateEnvironmentRequest(appConfig)) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
       return;
     }
     if (!req.validateJsonRequest()) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.APPLICATION.INVALID_JSON());
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_JSON());
       return;
     }
     if (!req.validateApiVersion(appConfig)) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.APPLICATION.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion));
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion));
       return;
     }
     const {runtimeEnvironment, runtimeParams} = req.getRuntimeContext(defaultRuntimeEnvironment);
@@ -92,7 +92,7 @@ function createSourceMapMiddleware(context) {
   return async (req, res) => {
     if (!req.validateEnvironmentRequest(appConfig)) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
       return;
     }
     const {runtimeEnvironment} = req.getRuntimeContext(defaultRuntimeEnvironment);

package/build/cjs/middleware/mapping-middleware.cjs

@@ -41,7 +41,7 @@ function createMappingMiddleware(context) {
   return async (req, res) => {
     if (!req.validateEnvironmentRequest(appConfig)) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
       return;
     }
     const {runtimeEnvironment, runtimeParams} = req.getRuntimeContext(defaultRuntimeEnvironment);

package/build/cjs/middleware/module-middleware.cjs

@@ -39,17 +39,17 @@ function createModuleMiddleware(context) {
   return async (req, res) => {
     if (!req.validateEnvironmentRequest(appConfig)) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
       return;
     }
     if (!req.validateJsonRequest()) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.APPLICATION.INVALID_JSON());
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_JSON());
       return;
     }
     if (!req.validateApiVersion(appConfig)) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.APPLICATION.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion));
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion));
       return;
     }
     const {runtimeEnvironment, runtimeParams} = req.getRuntimeContext(defaultRuntimeEnvironment);

package/build/cjs/middleware/request-processor-middleware.cjs

@@ -28,8 +28,6 @@ __export(exports, {
 });
 var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
-var MRT_REQUEST_CLASS = "X-Mobify-Request-Class";
-var MRT_REQUEST_CLASS_KEY = MRT_REQUEST_CLASS.toLowerCase();
 function requestProcessorMiddleware(app, context) {
   const {basePath} = context.runtimeEnvironment;
   app.use(async (req, res, next) => {
@@ -44,8 +42,10 @@ function requestProcessorMiddleware(app, context) {
           });
         }
       }
-      requestClass = req.headers[MRT_REQUEST_CLASS_KEY];
+      requestClass = req.headers[import_shared_utils.MRT_REQUEST_CLASS];
       requestDepth = (0, import_shared_utils.parseRequestDepth)(req.headers, req.query);
+      const trueClientIP = req.headers[import_shared_utils.TRUE_CLIENT_IP];
+      const correlationID = req.headers[import_shared_utils.CORRELATION_ID];
       const forwarded = req.headers["forwarded"];
       const host = req.headers["host"];
       const forwardedProto = req.headers["x-forwarded-proto"];
@@ -53,7 +53,7 @@ function requestProcessorMiddleware(app, context) {
       if ((0, import_shared_utils.isLambdaEnv)()) {
         import_diagnostics.logger.info({
           label: `request-processor-middleware`,
-          message: `Original Url: ${req.originalUrl}, Forwarded: ${forwarded}, X-Forwarded-Proto: ${forwardedProto}, Host: ${host},  Protocol: ${protocol}, ${MRT_REQUEST_CLASS}: ${requestClass}, ${import_shared_utils.REQUEST_DEPTH_HEADER}: ${requestDepth}`
+          message: `Original Url: ${req.originalUrl}, Forwarded: ${forwarded}, X-Forwarded-Proto: ${forwardedProto}, Host: ${host},  Protocol: ${protocol}, ${import_shared_utils.MRT_REQUEST_CLASS}: ${requestClass}, ${import_shared_utils.TRUE_CLIENT_IP}: ${trueClientIP}, ${import_shared_utils.CORRELATION_ID}: ${correlationID}, ${import_shared_utils.REQUEST_DEPTH_HEADER}: ${requestDepth}`
         });
       }
     }
@@ -89,7 +89,7 @@ function requestProcessorMiddleware(app, context) {
     } else {
       import_diagnostics.logger.debug({
         label: `request-processor-middleware`,
-        message: `${MRT_REQUEST_CLASS_KEY} ignored ${req.headers ? req.headers[MRT_REQUEST_CLASS_KEY] : "no-headers"}`
+        message: `${import_shared_utils.MRT_REQUEST_CLASS} ignored ${req.headers ? req.headers[import_shared_utils.MRT_REQUEST_CLASS] : "no-headers"}`
       });
       req.basePath = basePath;
     }

package/build/cjs/middleware/resource-middleware.cjs

@@ -33,7 +33,7 @@ function createResourceMiddleware(context) {
   const {appConfig, resourceRegistry, runtimeEnvironment: defaultRuntimeEnvironment} = context;
   return async (req, res) => {
     if (!req.validateEnvironmentRequest(appConfig)) {
-      res.status(400).send(import_diagnostics.descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+      res.status(400).send(import_diagnostics.descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
       return;
     }
     const {runtimeEnvironment, runtimeParams} = req.getRuntimeContext(defaultRuntimeEnvironment);

package/build/cjs/middleware/utils/error-handling.cjs

@@ -28,16 +28,43 @@ __export(exports, {
 });
 var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var import_diagnostics2 = __toModule(require("@lwrjs/diagnostics"));
-function createReturnStatus(error, url) {
-  if (error instanceof import_diagnostics.LwrApplicationError) {
-    return {status: 400, message: error.message};
+var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
+function addRedirectQueryParam(redirectUrl, depth) {
+  const fakeOrigin = "http://parse.com";
+  const url = (0, import_shared_utils.isURL)(redirectUrl) ? new URL(redirectUrl) : new URL(`${fakeOrigin}${redirectUrl}`);
+  url.searchParams.set(import_shared_utils.REQUEST_DEPTH_HEADER, String(depth + 1));
+  return url.toString().replace(fakeOrigin, "");
+}
+function createReturnStatus(error, req, debug) {
+  let status = 500, body = error.message || "";
+  const headers = {};
+  if (error instanceof import_diagnostics.LwrStatusError) {
+    status = error.status;
+    const rawHeaders = error.headers || {};
+    Object.entries(rawHeaders).forEach(([key, value]) => headers[key.toLowerCase()] = value);
+    if (status === 301 || status === 302) {
+      const location = headers.location;
+      if (location && (0, import_shared_utils.isURL)(location) || location?.startsWith("/")) {
+        headers.location = addRedirectQueryParam(location, (0, import_shared_utils.parseRequestDepth)(req.headers, req.query));
+      } else {
+        import_diagnostics2.logger.warn(`[error-middleware] Invalid location header for HTTP status ${status}: "${location}"`);
+      }
+    }
+  }
+  if (error instanceof import_diagnostics.LwrInvalidError) {
+    status = 400;
+  } else if (error instanceof import_diagnostics.LwrUnresolvableError) {
+    status = 404;
+  } else {
+    body = error instanceof import_diagnostics.LwrError ? body : `${import_diagnostics.descriptions.SERVER.SERVER_ERROR(req.originalUrl)}: ${body}`;
   }
-  if (error instanceof import_diagnostics.LwrUnresolvableError) {
-    return {status: 404, message: error.message};
+  if (debug) {
+    body = `<div style="font-family:sans-serif;margin:50px;"><h1>${status}: Document generation failed</h1><p>${body.replace(/</g, "&lt;").replace(/>/g, "&gt;")}</p></div>`;
+    status = 200;
   }
-  return {status: 500, message: `${import_diagnostics.descriptions.SERVER.SERVER_ERROR(url)}: ${error.message}`};
+  return {status, body, headers: Object.keys(headers).length > 0 ? headers : void 0};
 }
-function handleErrors(middleware) {
+function handleErrors(middleware, isBaseDoc = false) {
   return async (req, res, next) => {
     try {
       await middleware(req, res, next);
@@ -49,9 +76,9 @@ function handleErrors(middleware) {
       } else {
         import_diagnostics2.logger.error(err);
       }
-      const {status, message} = createReturnStatus(err, req.originalUrl);
-      res.status(status);
-      res.send(message);
+      const {status, body, headers} = createReturnStatus(err, req, req.query.debug !== void 0 && isBaseDoc);
+      headers && res.set(headers);
+      res.status(status).send(body);
     }
   };
 }

package/build/cjs/middleware/utils/identity.cjs

@@ -37,7 +37,7 @@ function validateSpecifier(specifer) {
 function getModuleIdentity(req, importer) {
   const {specifier, signature} = req.params;
   if (validateSpecifier(specifier) === false) {
-    throw new import_diagnostics.LwrApplicationError(import_diagnostics.descriptions.APPLICATION.INVALID_SPECIFIER(specifier));
+    throw new import_diagnostics.LwrInvalidError(import_diagnostics.descriptions.INVALID.INVALID_SPECIFIER(specifier));
   }
   const moduleId = (0, import_shared_utils.explodeSpecifier)(specifier);
   return {
@@ -61,7 +61,7 @@ function getMappingIdentity(req) {
 function getResourceIdentity(req) {
   const {specifier, signature = import_shared_utils.LATEST_SIGNATURE} = req.params;
   if (validateSpecifier(specifier) === false) {
-    throw new import_diagnostics.LwrApplicationError(import_diagnostics.descriptions.APPLICATION.INVALID_SPECIFIER(specifier));
+    throw new import_diagnostics.LwrInvalidError(import_diagnostics.descriptions.INVALID.INVALID_SPECIFIER(specifier));
   }
   const resourceId = (0, import_shared_utils.explodeSpecifier)(specifier);
   return {
@@ -73,7 +73,7 @@ function getAssetIdentity(req) {
   const {signature, immutable, assetType: type} = req.params;
   const specifier = type ? process.platform === "win32" ? req.params[0] : "/" + req.params[0] : req.originalUrl.split("?")[0];
   if (validateSpecifier(specifier) === false) {
-    throw new import_diagnostics.LwrApplicationError(import_diagnostics.descriptions.APPLICATION.INVALID_SPECIFIER(specifier));
+    throw new import_diagnostics.LwrInvalidError(import_diagnostics.descriptions.INVALID.INVALID_SPECIFIER(specifier));
   }
   return {
     immutable,

package/build/cjs/middleware/view-middleware.cjs

@@ -26,17 +26,16 @@ __markAsModule(exports);
 __export(exports, {
   viewMiddleware: () => viewMiddleware
 });
-var import_util = __toModule(require("util"));
 var import_url = __toModule(require("url"));
+var import_util = __toModule(require("util"));
+var import_zlib = __toModule(require("zlib"));
 var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
+var import_instrumentation = __toModule(require("@lwrjs/instrumentation"));
 var import_router = __toModule(require("@lwrjs/router"));
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
-var import_instrumentation = __toModule(require("@lwrjs/instrumentation"));
-var import_error_handling = __toModule(require("./utils/error-handling.cjs"));
 var import_view_registry = __toModule(require("@lwrjs/view-registry"));
-var import_instrumentation2 = __toModule(require("@lwrjs/instrumentation"));
-var import_zlib = __toModule(require("zlib"));
 var import_compression = __toModule(require("./utils/compression.cjs"));
+var import_error_handling = __toModule(require("./utils/error-handling.cjs"));
 function createViewMiddleware(route, errorRoutes, context, viewHandler) {
   const errorRoute = errorRoutes.find((route2) => route2.status === 500);
   const appConfig = context.appConfig;
@@ -45,12 +44,12 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
   return async (req, res) => {
     if (!req.validateEnvironmentRequest(appConfig)) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
       return;
     }
     if (!req.validateJsonRequest()) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.APPLICATION.INVALID_JSON());
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_JSON());
       return;
     }
     const {runtimeEnvironment, runtimeParams: defaultRuntimeParams} = req.getRuntimeContext(context.runtimeEnvironment);
@@ -69,13 +68,15 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
       params: viewRequest.params,
       query: viewRequest.query,
       cookie: req.headers?.cookie,
-      trueClientIP: req.headers && req.headers["true-client-ip"],
+      trueClientIP: req.headers?.[import_shared_utils.TRUE_CLIENT_IP],
+      correlationID: req.headers?.[import_shared_utils.CORRELATION_ID],
       coreProxy: req.getCoreProxy(appConfig.coreProxy ?? void 0, route.bootstrap?.proxyForSSR)
     };
     const resolve = req.isJsonRequest() ? viewHandler.getViewJson : viewHandler.getViewContent;
     let viewResponse;
     let resolvedRoute;
     let traceId;
+    let headers = {};
     try {
       viewResponse = await (0, import_instrumentation.getTracer)().trace({
         name: import_instrumentation.RequestHandlerSpan.GetView,
@@ -87,7 +88,9 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
           locale: runtimeParams.locale
         }
       }, async (span) => {
+        runtimeParams.viewSpanID = span.spanId;
         traceId = span.traceId;
+        headers = (0, import_shared_utils.getTraceHeaders)(runtimeParams, span);
         const res2 = await resolve.call(viewHandler, viewRequest, route, runtimeEnvironment, runtimeParams);
         span.setAttributes({
           size: byteSize(res2.body)
@@ -96,7 +99,7 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
       });
       resolvedRoute = route;
     } catch (err) {
-      if (!errorRoute) {
+      if (!errorRoute || runtimeEnvironment.debug) {
         throw err;
       }
       import_diagnostics.logger.error(`[view-middleware] Route Error ${req.originalUrl}`);
@@ -111,12 +114,13 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
       });
       resolvedRoute = errorRoute;
     } finally {
+      if (Object.keys(headers).length)
+        res.set(headers);
       if (traceId?.length) {
-        res.setHeader("x-trace-id", traceId);
         res.set({
-          "Server-Timing": (0, import_instrumentation2.getTraceCollector)().getSpansInTrace(traceId)
+          "Server-Timing": (0, import_instrumentation.getTraceCollector)().getSpansInTrace(traceId)
         });
-        (0, import_instrumentation2.getTraceCollector)().dropTrace(traceId);
+        (0, import_instrumentation.getTraceCollector)().dropTrace(traceId);
       }
     }
     if (req.isSiteGeneration()) {
@@ -136,24 +140,8 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
       }
     }
     let status = resolvedRoute.status || viewResponse.status || 200;
-    const viewDefinitionStatus = viewResponse.metadata?.viewDefinition?.status;
     if (viewResponse.status === 301 || viewResponse.status === 302) {
       status = viewResponse.status;
-    } else if (viewDefinitionStatus && viewDefinitionStatus.code) {
-      const origStatus = status;
-      const {code, location} = viewDefinitionStatus;
-      const isRedirect = code === 301 || code === 302;
-      status = code;
-      if (isRedirect) {
-        if (location && (0, import_shared_utils.isURL)(location) || location?.startsWith("/")) {
-          res.set({
-            location: addRedirectQueryParam(location, (0, import_shared_utils.parseRequestDepth)(req.headers, req.query))
-          });
-        } else {
-          status = origStatus;
-          import_diagnostics.logger.warn(`[view-middleware] Ignoring invalid location header: "${location}"`);
-        }
-      }
     }
     res.status(status);
     const viewResponseBody = viewResponse.body;
@@ -264,7 +252,7 @@ function viewMiddleware(app, context) {
       }
     }
     import_diagnostics.logger.debug({label: `view-middleware`, message: `Add view paths ${paths}`});
-    app.get(paths, (0, import_error_handling.handleErrors)(createViewMiddleware(route, errorRoutes, context, viewHandler)));
+    app.get(paths, (0, import_error_handling.handleErrors)(createViewMiddleware(route, errorRoutes, context, viewHandler), true));
   }
   app.get((0, import_shared_utils.getClientBootstrapConfigurationRoutes)(), (0, import_error_handling.handleErrors)(createConfigMiddleware(routes, context, viewHandler)));
   app.get("/" + app.getRegexWildcard(), (0, import_error_handling.handleErrors)(createNotFoundMiddleware(errorRoutes, context, viewHandler)));
@@ -299,12 +287,6 @@ function addDefaultLocaleRedirects(defaultLocale, defaultLocalePaths, defaultRed
     return res.sendStatus(301);
   });
 }
-function addRedirectQueryParam(redirectUrl, depth) {
-  const fakeOrigin = "http://parse.com";
-  const url = (0, import_shared_utils.isURL)(redirectUrl) ? new URL(redirectUrl) : new URL(`${fakeOrigin}${redirectUrl}`);
-  url.searchParams.set(import_shared_utils.REQUEST_DEPTH_KEY, String(depth + 1));
-  return url.toString().replace(fakeOrigin, "");
-}
 function byteSize(body) {
   if (Buffer.isBuffer(body)) {
     return body.length;

package/build/es/middleware/bundle-middleware.js

@@ -12,17 +12,17 @@ function createBundleMiddleware(context) {
     return async (req, res) => {
         if (!req.validateEnvironmentRequest(appConfig)) {
             res.status(400);
-            res.send(descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+            res.send(descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
             return;
         }
         if (!req.validateJsonRequest()) {
             res.status(400);
-            res.send(descriptions.APPLICATION.INVALID_JSON());
+            res.send(descriptions.INVALID.INVALID_JSON());
             return;
         }
         if (!req.validateApiVersion(appConfig)) {
             res.status(400);
-            res.send(descriptions.APPLICATION.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion));
+            res.send(descriptions.INVALID.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion));
             return;
         }
         const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(defaultRuntimeEnvironment);
@@ -65,7 +65,7 @@ function createSourceMapMiddleware(context) {
     return async (req, res) => {
         if (!req.validateEnvironmentRequest(appConfig)) {
             res.status(400);
-            res.send(descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+            res.send(descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
             return;
         }
         const { runtimeEnvironment } = req.getRuntimeContext(defaultRuntimeEnvironment);

package/build/es/middleware/mapping-middleware.js

@@ -8,7 +8,7 @@ function createMappingMiddleware(context) {
     return async (req, res) => {
         if (!req.validateEnvironmentRequest(appConfig)) {
             res.status(400);
-            res.send(descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+            res.send(descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
             return;
         }
         const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(defaultRuntimeEnvironment);

package/build/es/middleware/module-middleware.js

@@ -11,17 +11,17 @@ function createModuleMiddleware(context) {
     return async (req, res) => {
         if (!req.validateEnvironmentRequest(appConfig)) {
             res.status(400);
-            res.send(descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+            res.send(descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
             return;
         }
         if (!req.validateJsonRequest()) {
             res.status(400);
-            res.send(descriptions.APPLICATION.INVALID_JSON());
+            res.send(descriptions.INVALID.INVALID_JSON());
             return;
         }
         if (!req.validateApiVersion(appConfig)) {
             res.status(400);
-            res.send(descriptions.APPLICATION.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion));
+            res.send(descriptions.INVALID.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion));
             return;
         }
         const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(defaultRuntimeEnvironment);

package/build/es/middleware/request-processor-middleware.js

@@ -1,15 +1,5 @@
-/**
- * Parse passed to us via the X-Mobify-Request-Class.
- *
- * basePath: The dynamic base path
- *  '' or undefined -> LWR basePath ''
- *  token or /token -> LWR basePath '/token'
- *
- */
 import { logger } from '@lwrjs/diagnostics';
-import { REQUEST_DEPTH_HEADER, isLambdaEnv, parseRequestDepth } from '@lwrjs/shared-utils';
-const MRT_REQUEST_CLASS = 'X-Mobify-Request-Class';
-const MRT_REQUEST_CLASS_KEY = MRT_REQUEST_CLASS.toLowerCase();
+import { CORRELATION_ID, MRT_REQUEST_CLASS, REQUEST_DEPTH_HEADER, TRUE_CLIENT_IP, isLambdaEnv, parseRequestDepth, } from '@lwrjs/shared-utils';
 export function requestProcessorMiddleware(app, context) {
     const { basePath } = context.runtimeEnvironment;
     app.use(async (req, res, next) => {
@@ -26,8 +16,10 @@ export function requestProcessorMiddleware(app, context) {
                     });
                 }
             }
-            requestClass = req.headers[MRT_REQUEST_CLASS_KEY];
+            requestClass = req.headers[MRT_REQUEST_CLASS];
             requestDepth = parseRequestDepth(req.headers, req.query);
+            const trueClientIP = req.headers[TRUE_CLIENT_IP];
+            const correlationID = req.headers[CORRELATION_ID];
             const forwarded = req.headers['forwarded'];
             const host = req.headers['host'];
             const forwardedProto = req.headers['x-forwarded-proto'];
@@ -36,7 +28,7 @@ export function requestProcessorMiddleware(app, context) {
             if (isLambdaEnv()) {
                 logger.info({
                     label: `request-processor-middleware`,
-                    message: `Original Url: ${req.originalUrl}, Forwarded: ${forwarded}, X-Forwarded-Proto: ${forwardedProto}, Host: ${host},  Protocol: ${protocol}, ${MRT_REQUEST_CLASS}: ${requestClass}, ${REQUEST_DEPTH_HEADER}: ${requestDepth}`,
+                    message: `Original Url: ${req.originalUrl}, Forwarded: ${forwarded}, X-Forwarded-Proto: ${forwardedProto}, Host: ${host},  Protocol: ${protocol}, ${MRT_REQUEST_CLASS}: ${requestClass}, ${TRUE_CLIENT_IP}: ${trueClientIP}, ${CORRELATION_ID}: ${correlationID}, ${REQUEST_DEPTH_HEADER}: ${requestDepth}`,
                 });
             }
         }
@@ -81,7 +73,7 @@ export function requestProcessorMiddleware(app, context) {
         else {
             logger.debug({
                 label: `request-processor-middleware`,
-                message: `${MRT_REQUEST_CLASS_KEY} ignored ${req.headers ? req.headers[MRT_REQUEST_CLASS_KEY] : 'no-headers'}`,
+                message: `${MRT_REQUEST_CLASS} ignored ${req.headers ? req.headers[MRT_REQUEST_CLASS] : 'no-headers'}`,
             });
             req.basePath = basePath;
         }
@@ -89,12 +81,21 @@ export function requestProcessorMiddleware(app, context) {
         await next();
     });
 }
+/**
+ * Parse the basePath passed via the X-Mobify-Request-Class header.
+ * Example: basePath=/token
+ *
+ * basePath: The dynamic base path
+ *  '' or undefined -> LWR basePath ''
+ *  token or /token -> LWR basePath '/token'
+ *
+ */
 function parseRequestClass(requestClass) {
     // If there is no requestClass do not bother parsing
     if (!requestClass) {
         return {};
     }
-    // Split the Forwarded header into individual key-value pairs
+    // Split the header into individual key-value pairs
     const keyValuePairs = requestClass.split(';');
     // Create an object to store the parsed values
     const parsed = {};

package/build/es/middleware/resource-middleware.js

@@ -5,7 +5,7 @@ function createResourceMiddleware(context) {
     const { appConfig, resourceRegistry, runtimeEnvironment: defaultRuntimeEnvironment } = context;
     return async (req, res) => {
         if (!req.validateEnvironmentRequest(appConfig)) {
-            res.status(400).send(descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+            res.status(400).send(descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
             return;
         }
         const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(defaultRuntimeEnvironment);

package/build/es/middleware/utils/error-handling.d.ts

@@ -1,3 +1,3 @@
 import type { MiddlewareFunction } from '@lwrjs/types';
-export declare function handleErrors(middleware: MiddlewareFunction): MiddlewareFunction;
+export declare function handleErrors(middleware: MiddlewareFunction, isBaseDoc?: boolean): MiddlewareFunction;
 //# sourceMappingURL=error-handling.d.ts.map

package/build/es/middleware/utils/error-handling.js

@@ -1,16 +1,54 @@
-import { descriptions, DiagnosticsError, LwrApplicationError, LwrUnresolvableError, } from '@lwrjs/diagnostics';
+import { descriptions, DiagnosticsError, LwrError, LwrInvalidError, LwrStatusError, LwrUnresolvableError, } from '@lwrjs/diagnostics';
 import { logger } from '@lwrjs/diagnostics';
-function createReturnStatus(error, url) {
-    if (error instanceof LwrApplicationError) {
-        return { status: 400, message: error.message };
+import { isURL, parseRequestDepth, REQUEST_DEPTH_HEADER } from '@lwrjs/shared-utils';
+function addRedirectQueryParam(redirectUrl, depth) {
+    // add a request depth query param to the URL
+    // the depth header cannot be used since headers cannot be added to a redirect
+    const fakeOrigin = 'http://parse.com';
+    const url = isURL(redirectUrl) ? new URL(redirectUrl) : new URL(`${fakeOrigin}${redirectUrl}`);
+    url.searchParams.set(REQUEST_DEPTH_HEADER, String(depth + 1));
+    return url.toString().replace(fakeOrigin, '');
+}
+function createReturnStatus(error, req, debug) {
+    let status = 500, body = error.message || '';
+    const headers = {};
+    if (error instanceof LwrStatusError) {
+        // handle special HTTP statuses, eg: 301, 302, 429, 503
+        status = error.status;
+        const rawHeaders = error.headers || {};
+        Object.entries(rawHeaders).forEach(([key, value]) => (headers[key.toLowerCase()] = value));
+        if (status === 301 || status === 302) {
+            // handle redirect
+            const location = headers.location;
+            if ((location && isURL(location)) || location?.startsWith('/')) {
+                headers.location = addRedirectQueryParam(location, parseRequestDepth(req.headers, req.query));
+            }
+            else {
+                logger.warn(`[error-middleware] Invalid location header for HTTP status ${status}: "${location}"`);
+            }
+        }
+    }
+    if (error instanceof LwrInvalidError) {
+        status = 400;
+    }
+    else if (error instanceof LwrUnresolvableError) {
+        status = 404;
+    }
+    else {
+        // catchall: likely a LwrServerError
+        body =
+            error instanceof LwrError
+                ? body
+                : `${descriptions.SERVER.SERVER_ERROR(req.originalUrl)}: ${body}`;
     }
-    if (error instanceof LwrUnresolvableError) {
-        return { status: 404, message: error.message };
+    if (debug) {
+        // return a debug base doc and a 200 response code if debug mode is on
+        body = `<div style="font-family:sans-serif;margin:50px;"><h1>${status}: Document generation failed</h1><p>${body.replace(/</g, '&lt;').replace(/>/g, '&gt;')}</p></div>`;
+        status = 200;
     }
-    // catchall: likely a LwrServerError
-    return { status: 500, message: `${descriptions.SERVER.SERVER_ERROR(url)}: ${error.message}` };
+    return { status, body, headers: Object.keys(headers).length > 0 ? headers : undefined };
 }
-export function handleErrors(middleware) {
+export function handleErrors(middleware, isBaseDoc = false) {
     return async (req, res, next) => {
         try {
             await middleware(req, res, next);
@@ -24,9 +62,11 @@ export function handleErrors(middleware) {
             else {
                 logger.error(err);
             }
-            const { status, message } = createReturnStatus(err, req.originalUrl);
-            res.status(status);
-            res.send(message);
+            const { status, body, headers } = createReturnStatus(err, req, 
+            // only return HTML error screen for base doc requests in debug mode
+            req.query.debug !== undefined && isBaseDoc);
+            headers && res.set(headers);
+            res.status(status).send(body);
         }
     };
 }

package/build/es/middleware/utils/identity.js

@@ -1,12 +1,12 @@
 import { explodeSpecifier, explodeSpecifiers, LATEST_SIGNATURE } from '@lwrjs/shared-utils';
-import { descriptions, LwrApplicationError } from '@lwrjs/diagnostics';
+import { descriptions, LwrInvalidError } from '@lwrjs/diagnostics';
 function validateSpecifier(specifer) {
     return specifer.indexOf('../') < 0;
 }
 export function getModuleIdentity(req, importer) {
     const { specifier, signature } = req.params;
     if (validateSpecifier(specifier) === false) {
-        throw new LwrApplicationError(descriptions.APPLICATION.INVALID_SPECIFIER(specifier));
+        throw new LwrInvalidError(descriptions.INVALID.INVALID_SPECIFIER(specifier));
     }
     const moduleId = explodeSpecifier(specifier);
     return {
@@ -30,7 +30,7 @@ export function getMappingIdentity(req) {
 export function getResourceIdentity(req) {
     const { specifier, signature = LATEST_SIGNATURE } = req.params;
     if (validateSpecifier(specifier) === false) {
-        throw new LwrApplicationError(descriptions.APPLICATION.INVALID_SPECIFIER(specifier));
+        throw new LwrInvalidError(descriptions.INVALID.INVALID_SPECIFIER(specifier));
     }
     const resourceId = explodeSpecifier(specifier);
     return {
@@ -46,7 +46,7 @@ export function getAssetIdentity(req) {
             : '/' + req.params[0]
         : req.originalUrl.split('?')[0];
     if (validateSpecifier(specifier) === false) {
-        throw new LwrApplicationError(descriptions.APPLICATION.INVALID_SPECIFIER(specifier));
+        throw new LwrInvalidError(descriptions.INVALID.INVALID_SPECIFIER(specifier));
     }
     return {
         immutable,

package/build/es/middleware/view-middleware.js

@@ -1,14 +1,13 @@
-import { TextEncoder } from 'util';
 import { URLSearchParams } from 'url';
+import { TextEncoder } from 'util';
+import { brotliCompressSync, gzipSync } from 'zlib';
 import { descriptions, logger } from '@lwrjs/diagnostics';
+import { RequestHandlerSpan, getTraceCollector, getTracer } from '@lwrjs/instrumentation';
 import { getClientRoutes } from '@lwrjs/router';
-import { decodeViewPath, extractRequestParams, getClientBootstrapConfigurationRoutes, isURL, parseRequestDepth, REQUEST_DEPTH_KEY, isLocalDev, shortestTtl, isLambdaEnv, } from '@lwrjs/shared-utils';
-import { RequestHandlerSpan, getTracer } from '@lwrjs/instrumentation';
-import { handleErrors } from './utils/error-handling.js';
+import { CORRELATION_ID, TRUE_CLIENT_IP, decodeViewPath, extractRequestParams, getClientBootstrapConfigurationRoutes, getTraceHeaders, isLambdaEnv, isLocalDev, shortestTtl, } from '@lwrjs/shared-utils';
 import { LwrViewHandler } from '@lwrjs/view-registry';
-import { getTraceCollector } from '@lwrjs/instrumentation';
-import { brotliCompressSync, gzipSync } from 'zlib';
 import { getMrtCompressionThreshold } from './utils/compression.js';
+import { handleErrors } from './utils/error-handling.js';
 function createViewMiddleware(route, errorRoutes, context, viewHandler) {
     const errorRoute = errorRoutes.find((route) => route.status === 500);
     const appConfig = context.appConfig;
@@ -17,12 +16,12 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
     return async (req, res) => {
         if (!req.validateEnvironmentRequest(appConfig)) {
             res.status(400);
-            res.send(descriptions.APPLICATION.INVALID_ENVIRONMENT(req.params.environment));
+            res.send(descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
             return;
         }
         if (!req.validateJsonRequest()) {
             res.status(400);
-            res.send(descriptions.APPLICATION.INVALID_JSON());
+            res.send(descriptions.INVALID.INVALID_JSON());
             return;
         }
         const { runtimeEnvironment, runtimeParams: defaultRuntimeParams } = req.getRuntimeContext(context.runtimeEnvironment);
@@ -43,13 +42,15 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
             params: viewRequest.params,
             query: viewRequest.query,
             cookie: req.headers?.cookie,
-            trueClientIP: req.headers && req.headers['true-client-ip'],
+            trueClientIP: req.headers?.[TRUE_CLIENT_IP],
+            correlationID: req.headers?.[CORRELATION_ID],
             coreProxy: req.getCoreProxy(appConfig.coreProxy ?? undefined, route.bootstrap?.proxyForSSR),
         };
         const resolve = req.isJsonRequest() ? viewHandler.getViewJson : viewHandler.getViewContent;
         let viewResponse;
         let resolvedRoute;
         let traceId;
+        let headers = {};
         try {
             viewResponse = await getTracer().trace({
                 name: RequestHandlerSpan.GetView,
@@ -61,7 +62,9 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
                     locale: runtimeParams.locale,
                 },
             }, async (span) => {
+                runtimeParams.viewSpanID = span.spanId;
                 traceId = span.traceId;
+                headers = getTraceHeaders(runtimeParams, span);
                 const res = await resolve.call(viewHandler, viewRequest, route, runtimeEnvironment, runtimeParams);
                 // Add the view size metric
                 span.setAttributes({
@@ -72,7 +75,9 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
             resolvedRoute = route;
         }
         catch (err) {
-            if (!errorRoute) {
+            if (!errorRoute || runtimeEnvironment.debug) {
+                // this is handled by the error middleware
+                // when debug mode is on, always show the error screen
                 throw err;
             }
             // Log Unexpected Routing Errors
@@ -89,8 +94,9 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
             resolvedRoute = errorRoute;
         }
         finally {
+            if (Object.keys(headers).length)
+                res.set(headers);
             if (traceId?.length) {
-                res.setHeader('x-trace-id', traceId);
                 res.set({
                     'Server-Timing': getTraceCollector().getSpansInTrace(traceId),
                 });
@@ -119,29 +125,10 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
             }
         }
         let status = resolvedRoute.status || viewResponse.status || 200;
-        const viewDefinitionStatus = viewResponse.metadata?.viewDefinition?.status;
         if (viewResponse.status === 301 || viewResponse.status === 302) {
             // route handle redirect status takes precedence
             status = viewResponse.status;
         }
-        else if (viewDefinitionStatus && viewDefinitionStatus.code) {
-            const origStatus = status;
-            const { code, location } = viewDefinitionStatus;
-            const isRedirect = code === 301 || code === 302;
-            status = code;
-            if (isRedirect) {
-                if ((location && isURL(location)) || location?.startsWith('/')) {
-                    res.set({
-                        location: addRedirectQueryParam(location, parseRequestDepth(req.headers, req.query)),
-                    });
-                }
-                else {
-                    // reset the status in the event of an invalid location when redirecting
-                    status = origStatus;
-                    logger.warn(`[view-middleware] Ignoring invalid location header: "${location}"`);
-                }
-            }
-        }
         res.status(status);
         // LWR@MRT 254 temporary safeguard for "dupe styles" issue causing huge base docs
         // Re-evaluate for removal once we determine it is no longer needed: W-17201070
@@ -272,7 +259,7 @@ export function viewMiddleware(app, context) {
             }
         }
         logger.debug({ label: `view-middleware`, message: `Add view paths ${paths}` });
-        app.get(paths, handleErrors(createViewMiddleware(route, errorRoutes, context, viewHandler)));
+        app.get(paths, handleErrors(createViewMiddleware(route, errorRoutes, context, viewHandler), true));
     }
     // create and attach middleware for bootstrap configurations
     app.get(getClientBootstrapConfigurationRoutes(), handleErrors(createConfigMiddleware(routes, context, viewHandler)));
@@ -325,14 +312,6 @@ function addDefaultLocaleRedirects(defaultLocale, defaultLocalePaths, defaultRed
         return res.sendStatus(301);
     });
 }
-function addRedirectQueryParam(redirectUrl, depth) {
-    // add a request depth query param to the URL
-    // the depth header cannot be used since headers cannot be added to a redirect
-    const fakeOrigin = 'http://parse.com';
-    const url = isURL(redirectUrl) ? new URL(redirectUrl) : new URL(`${fakeOrigin}${redirectUrl}`);
-    url.searchParams.set(REQUEST_DEPTH_KEY, String(depth + 1));
-    return url.toString().replace(fakeOrigin, '');
-}
 // Get number of bytes from a string.  Different char encodings can effect size per char.
 function byteSize(body) {
     if (Buffer.isBuffer(body)) {

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.17.2-alpha.2",
+    "version": "0.17.2-alpha.20",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -43,34 +43,34 @@
         "build": "tsc -b"
     },
     "dependencies": {
-        "@lwrjs/app-service": "0.17.2-alpha.2",
-        "@lwrjs/asset-registry": "0.17.2-alpha.2",
-        "@lwrjs/asset-transformer": "0.17.2-alpha.2",
-        "@lwrjs/base-view-provider": "0.17.2-alpha.2",
-        "@lwrjs/base-view-transformer": "0.17.2-alpha.2",
-        "@lwrjs/client-modules": "0.17.2-alpha.2",
-        "@lwrjs/config": "0.17.2-alpha.2",
-        "@lwrjs/diagnostics": "0.17.2-alpha.2",
-        "@lwrjs/esbuild": "0.17.2-alpha.2",
-        "@lwrjs/fs-asset-provider": "0.17.2-alpha.2",
-        "@lwrjs/fs-watch": "0.17.2-alpha.2",
-        "@lwrjs/html-view-provider": "0.17.2-alpha.2",
-        "@lwrjs/instrumentation": "0.17.2-alpha.2",
-        "@lwrjs/loader": "0.17.2-alpha.2",
-        "@lwrjs/lwc-module-provider": "0.17.2-alpha.2",
-        "@lwrjs/lwc-ssr": "0.17.2-alpha.2",
-        "@lwrjs/markdown-view-provider": "0.17.2-alpha.2",
-        "@lwrjs/module-bundler": "0.17.2-alpha.2",
-        "@lwrjs/module-registry": "0.17.2-alpha.2",
-        "@lwrjs/npm-module-provider": "0.17.2-alpha.2",
-        "@lwrjs/nunjucks-view-provider": "0.17.2-alpha.2",
-        "@lwrjs/o11y": "0.17.2-alpha.2",
-        "@lwrjs/resource-registry": "0.17.2-alpha.2",
-        "@lwrjs/router": "0.17.2-alpha.2",
-        "@lwrjs/server": "0.17.2-alpha.2",
-        "@lwrjs/shared-utils": "0.17.2-alpha.2",
-        "@lwrjs/static": "0.17.2-alpha.2",
-        "@lwrjs/view-registry": "0.17.2-alpha.2",
+        "@lwrjs/app-service": "0.17.2-alpha.20",
+        "@lwrjs/asset-registry": "0.17.2-alpha.20",
+        "@lwrjs/asset-transformer": "0.17.2-alpha.20",
+        "@lwrjs/base-view-provider": "0.17.2-alpha.20",
+        "@lwrjs/base-view-transformer": "0.17.2-alpha.20",
+        "@lwrjs/client-modules": "0.17.2-alpha.20",
+        "@lwrjs/config": "0.17.2-alpha.20",
+        "@lwrjs/diagnostics": "0.17.2-alpha.20",
+        "@lwrjs/esbuild": "0.17.2-alpha.20",
+        "@lwrjs/fs-asset-provider": "0.17.2-alpha.20",
+        "@lwrjs/fs-watch": "0.17.2-alpha.20",
+        "@lwrjs/html-view-provider": "0.17.2-alpha.20",
+        "@lwrjs/instrumentation": "0.17.2-alpha.20",
+        "@lwrjs/loader": "0.17.2-alpha.20",
+        "@lwrjs/lwc-module-provider": "0.17.2-alpha.20",
+        "@lwrjs/lwc-ssr": "0.17.2-alpha.20",
+        "@lwrjs/markdown-view-provider": "0.17.2-alpha.20",
+        "@lwrjs/module-bundler": "0.17.2-alpha.20",
+        "@lwrjs/module-registry": "0.17.2-alpha.20",
+        "@lwrjs/npm-module-provider": "0.17.2-alpha.20",
+        "@lwrjs/nunjucks-view-provider": "0.17.2-alpha.20",
+        "@lwrjs/o11y": "0.17.2-alpha.20",
+        "@lwrjs/resource-registry": "0.17.2-alpha.20",
+        "@lwrjs/router": "0.17.2-alpha.20",
+        "@lwrjs/server": "0.17.2-alpha.20",
+        "@lwrjs/shared-utils": "0.17.2-alpha.20",
+        "@lwrjs/static": "0.17.2-alpha.20",
+        "@lwrjs/view-registry": "0.17.2-alpha.20",
         "chokidar": "^3.6.0",
         "esbuild": "^0.9.7",
         "fs-extra": "^11.2.0",
@@ -80,7 +80,7 @@
         "ws": "^8.18.0"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.17.2-alpha.2",
+        "@lwrjs/types": "0.17.2-alpha.20",
         "@types/ws": "^8.5.12",
         "memfs": "^4.13.0"
     },
@@ -88,10 +88,10 @@
         "lwc": ">= 2.x"
     },
     "engines": {
-        "node": ">=18.0.0"
+        "node": ">=20.0.0"
     },
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "739b237f5d7f2c1989142cb505a56cc763f21976"
+    "gitHead": "871213620dec8ff886be421339f1e90e86dbee96"
 }