@lwrjs/core 0.17.2-alpha.1 → 0.17.2-alpha.10

package/build/cjs/index.cjs

@@ -157,10 +157,8 @@ var LwrApp = class {
           try {
             await (0, import_server_warmup.warmupServer)(config, app.getInternalRequestKey());
           } catch (err) {
-            const diagnostic = (0, import_diagnostics.createSingleDiagnosticError)({
-              description: import_diagnostics.descriptions.SERVER.WARMUP_ERROR(err.message)
-            }, import_diagnostics.LwrServerError);
-            return reject(diagnostic);
+            const e = new import_diagnostics.LwrServerError(import_diagnostics.descriptions.SERVER.WARMUP_ERROR(err.message));
+            return reject(e);
           }
         }
         const opts = {serverMode, port};

package/build/cjs/middleware/asset-middleware.cjs

@@ -92,7 +92,7 @@ function createAssetMiddleware(context) {
       }
       res.status(200).stream(asset.stream());
     } catch (error) {
-      if (import_path.default.dirname(assetId.specifier) === (basePath ? basePath : "/") && error instanceof import_diagnostics.DiagnosticsError && error?.diagnostics[0]?.description.category === "lwrUnresolvable/asset") {
+      if (import_path.default.dirname(assetId.specifier) === (basePath ? basePath : "/") && error instanceof import_diagnostics.LwrUnresolvableError && error?.type === "asset") {
         await next();
         return;
       }

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.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
       return;
     }
     if (!req.validateJsonRequest()) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.UNRESOLVABLE.INVALID_JSON().message);
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_JSON());
       return;
     }
     if (!req.validateApiVersion(appConfig)) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.UNRESOLVABLE.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion).message);
+      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.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
+      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.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
+      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.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
       return;
     }
     if (!req.validateJsonRequest()) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.UNRESOLVABLE.INVALID_JSON().message);
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_JSON());
       return;
     }
     if (!req.validateApiVersion(appConfig)) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.UNRESOLVABLE.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion).message);
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion));
       return;
     }
     const {runtimeEnvironment, runtimeParams} = req.getRuntimeContext(defaultRuntimeEnvironment);
@@ -70,7 +70,7 @@ function createModuleMiddleware(context) {
     });
     const {ownHash, linkedSource} = moduleDefinition;
     if (signature !== import_shared_utils.LATEST_SIGNATURE && ownHash !== signature) {
-      res.status(404).send(import_diagnostics.descriptions.UNRESOLVABLE.SIGNED_MODULE(moduleId.specifier, signature).message);
+      res.status(404).send(import_diagnostics.descriptions.UNRESOLVABLE.SIGNED_MODULE(moduleId.specifier, signature));
       return;
     }
     if (req.isSiteGeneration()) {

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

@@ -28,8 +28,8 @@ __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();
+var MRT_REQUEST_CLASS = "x-mobify-request-class";
+var TRUE_CLIENT_IP = "true-client-ip";
 function requestProcessorMiddleware(app, context) {
   const {basePath} = context.runtimeEnvironment;
   app.use(async (req, res, next) => {
@@ -44,8 +44,9 @@ function requestProcessorMiddleware(app, context) {
           });
         }
       }
-      requestClass = req.headers[MRT_REQUEST_CLASS_KEY];
+      requestClass = req.headers[MRT_REQUEST_CLASS];
       requestDepth = (0, import_shared_utils.parseRequestDepth)(req.headers, req.query);
+      const trueClientIP = req.headers[TRUE_CLIENT_IP];
       const forwarded = req.headers["forwarded"];
       const host = req.headers["host"];
       const forwardedProto = req.headers["x-forwarded-proto"];
@@ -53,7 +54,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}, ${MRT_REQUEST_CLASS}: ${requestClass}, ${TRUE_CLIENT_IP}: ${trueClientIP}, ${import_shared_utils.REQUEST_DEPTH_HEADER}: ${requestDepth}`
         });
       }
     }
@@ -89,7 +90,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: `${MRT_REQUEST_CLASS} ignored ${req.headers ? req.headers[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.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
+      res.status(400).send(import_diagnostics.descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
       return;
     }
     const {runtimeEnvironment, runtimeParams} = req.getRuntimeContext(defaultRuntimeEnvironment);
@@ -51,7 +51,7 @@ function createResourceMiddleware(context) {
       res.status(200).type(resource.type).stream(resource.stream());
       return;
     }
-    res.status(404).send(import_diagnostics.descriptions.UNRESOLVABLE.RESOURCE(resourceId.specifier, resourceId.version).message);
+    res.status(404).send(import_diagnostics.descriptions.UNRESOLVABLE.RESOURCE(resourceId.specifier, resourceId.version));
   };
 }
 function resourceMiddleware(app, context) {

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

@@ -28,16 +28,42 @@ __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.LwrUnresolvableError && error.diagnostics[0].description.category === "lwrUnresolvable/invalid") {
-    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_KEY, 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>`;
   }
-  return {status: 500, message: `${import_diagnostics.descriptions.SERVER.SERVER_ERROR(url).message}: ${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 +75,10 @@ function handleErrors(middleware) {
       } else {
         import_diagnostics2.logger.error(err);
       }
-      const {status, message} = createReturnStatus(err, req.originalUrl);
+      const {status, body, headers} = createReturnStatus(err, req, req.query.debug !== void 0 && isBaseDoc);
+      headers && res.set(headers);
       res.status(status);
-      res.send(message);
+      res.send(body);
     }
   };
 }

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

@@ -37,9 +37,7 @@ function validateSpecifier(specifer) {
 function getModuleIdentity(req, importer) {
   const {specifier, signature} = req.params;
   if (validateSpecifier(specifier) === false) {
-    throw (0, import_diagnostics.createSingleDiagnosticError)({
-      description: import_diagnostics.descriptions.UNRESOLVABLE.INVALID_SPECIFIER(specifier)
-    }, import_diagnostics.LwrUnresolvableError);
+    throw new import_diagnostics.LwrInvalidError(import_diagnostics.descriptions.INVALID.INVALID_SPECIFIER(specifier));
   }
   const moduleId = (0, import_shared_utils.explodeSpecifier)(specifier);
   return {
@@ -63,9 +61,7 @@ function getMappingIdentity(req) {
 function getResourceIdentity(req) {
   const {specifier, signature = import_shared_utils.LATEST_SIGNATURE} = req.params;
   if (validateSpecifier(specifier) === false) {
-    throw (0, import_diagnostics.createSingleDiagnosticError)({
-      description: import_diagnostics.descriptions.UNRESOLVABLE.INVALID_SPECIFIER(specifier)
-    }, import_diagnostics.LwrUnresolvableError);
+    throw new import_diagnostics.LwrInvalidError(import_diagnostics.descriptions.INVALID.INVALID_SPECIFIER(specifier));
   }
   const resourceId = (0, import_shared_utils.explodeSpecifier)(specifier);
   return {
@@ -77,9 +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 (0, import_diagnostics.createSingleDiagnosticError)({
-      description: import_diagnostics.descriptions.UNRESOLVABLE.INVALID_SPECIFIER(specifier)
-    }, import_diagnostics.LwrUnresolvableError);
+    throw new import_diagnostics.LwrInvalidError(import_diagnostics.descriptions.INVALID.INVALID_SPECIFIER(specifier));
   }
   return {
     immutable,

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

@@ -45,12 +45,12 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
   return async (req, res) => {
     if (!req.validateEnvironmentRequest(appConfig)) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
       return;
     }
     if (!req.validateJsonRequest()) {
       res.status(400);
-      res.send(import_diagnostics.descriptions.UNRESOLVABLE.INVALID_JSON().message);
+      res.send(import_diagnostics.descriptions.INVALID.INVALID_JSON());
       return;
     }
     const {runtimeEnvironment, runtimeParams: defaultRuntimeParams} = req.getRuntimeContext(context.runtimeEnvironment);
@@ -96,7 +96,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}`);
@@ -136,24 +136,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;
@@ -187,7 +171,7 @@ function createConfigMiddleware(routes, context, viewHandler) {
     const {appId, encodedViewPath} = req.params;
     const route = routes.find((route2) => route2.id === appId);
     if (!route) {
-      res.status(404).send(import_diagnostics.descriptions.UNRESOLVABLE.APP_CONFIG(appId).message);
+      res.status(404).send(import_diagnostics.descriptions.UNRESOLVABLE.APP_CONFIG(appId));
       return;
     }
     const url = (0, import_shared_utils.decodeViewPath)(encodedViewPath);
@@ -218,7 +202,7 @@ function createConfigMiddleware(routes, context, viewHandler) {
     };
     const viewResponse = await viewHandler.getViewConfiguration(viewRequest, route, runtimeEnvironment, runtimeParams);
     if (!viewResponse) {
-      res.status(404).send(import_diagnostics.descriptions.UNRESOLVABLE.VIEW_CONFIG(url).message);
+      res.status(404).send(import_diagnostics.descriptions.UNRESOLVABLE.VIEW_CONFIG(url));
       return;
     }
     if (!res.hasHeader("cache-control")) {
@@ -238,7 +222,7 @@ function createNotFoundMiddleware(errorRoutes, context, viewHandler) {
     return createViewMiddleware(notFoundRoute, errorRoutes, context, viewHandler);
   }
   return (req, res) => {
-    res.status(404).send(import_diagnostics.descriptions.UNRESOLVABLE.VIEW(req.originalUrl).message);
+    res.status(404).send(import_diagnostics.descriptions.UNRESOLVABLE.VIEW(req.originalUrl));
   };
 }
 function viewMiddleware(app, context) {
@@ -264,7 +248,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 +283,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/index.js

@@ -1,6 +1,6 @@
 import { getFeatureFlags } from '@lwrjs/shared-utils';
 import { createInternalServer } from '@lwrjs/server';
-import { LwrServerError, createSingleDiagnosticError, descriptions, logger } from '@lwrjs/diagnostics';
+import { LwrServerError, descriptions, logger } from '@lwrjs/diagnostics';
 import { DEFAULT_LWR_BOOTSTRAP_CONFIG, loadConfig, executeConfigHooks, executeStartHooks, executeInstrumentationHooks, executeContextHooks, } from '@lwrjs/config';
 import { loadHooks, loadServices, loadRouteHandlers } from '@lwrjs/config/modules';
 import SiteGenerator from './tools/static-generation.js';
@@ -152,10 +152,8 @@ export class LwrApp {
                         await warmupServer(config, app.getInternalRequestKey());
                     }
                     catch (err) {
-                        const diagnostic = createSingleDiagnosticError({
-                            description: descriptions.SERVER.WARMUP_ERROR(err.message),
-                        }, LwrServerError);
-                        return reject(diagnostic);
+                        const e = new LwrServerError(descriptions.SERVER.WARMUP_ERROR(err.message));
+                        return reject(e);
                     }
                 }
                 const opts = { serverMode, port };

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

@@ -1,6 +1,6 @@
 import { getFeatureFlags } from '@lwrjs/shared-utils';
 import path from 'path';
-import { DiagnosticsError, logger } from '@lwrjs/diagnostics';
+import { LwrUnresolvableError, logger } from '@lwrjs/diagnostics';
 import { RequestHandlerSpan, getTracer } from '@lwrjs/instrumentation';
 import { getAssetIdentity } from './utils/identity.js';
 import { handleErrors } from './utils/error-handling.js';
@@ -76,8 +76,8 @@ function createAssetMiddleware(context) {
         catch (error) {
             // Ignore asset not found for root asset requests
             if (path.dirname(assetId.specifier) === (basePath ? basePath : '/') &&
-                error instanceof DiagnosticsError &&
-                error?.diagnostics[0]?.description.category === 'lwrUnresolvable/asset') {
+                error instanceof LwrUnresolvableError &&
+                error?.type === 'asset') {
                 // Must await other middleware or this can respond before expected.
                 await next();
                 return;

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

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

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

@@ -11,18 +11,17 @@ function createModuleMiddleware(context) {
     return async (req, res) => {
         if (!req.validateEnvironmentRequest(appConfig)) {
             res.status(400);
-            res.send(descriptions.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
+            res.send(descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
             return;
         }
         if (!req.validateJsonRequest()) {
             res.status(400);
-            res.send(descriptions.UNRESOLVABLE.INVALID_JSON().message);
+            res.send(descriptions.INVALID.INVALID_JSON());
             return;
         }
         if (!req.validateApiVersion(appConfig)) {
             res.status(400);
-            res.send(descriptions.UNRESOLVABLE.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion)
-                .message);
+            res.send(descriptions.INVALID.INVALID_API_VERSION(req.params.apiVersion, appConfig.apiVersion));
             return;
         }
         const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(defaultRuntimeEnvironment);
@@ -48,7 +47,7 @@ function createModuleMiddleware(context) {
         const { ownHash, linkedSource } = moduleDefinition;
         // validate the requested instances exists
         if (signature !== LATEST_SIGNATURE && ownHash !== signature) {
-            res.status(404).send(descriptions.UNRESOLVABLE.SIGNED_MODULE(moduleId.specifier, signature).message);
+            res.status(404).send(descriptions.UNRESOLVABLE.SIGNED_MODULE(moduleId.specifier, signature));
             return;
         }
         if (req.isSiteGeneration()) {

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

@@ -8,8 +8,8 @@
  */
 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();
+const MRT_REQUEST_CLASS = 'x-mobify-request-class';
+const TRUE_CLIENT_IP = 'true-client-ip';
 export function requestProcessorMiddleware(app, context) {
     const { basePath } = context.runtimeEnvironment;
     app.use(async (req, res, next) => {
@@ -26,8 +26,9 @@ 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 forwarded = req.headers['forwarded'];
             const host = req.headers['host'];
             const forwardedProto = req.headers['x-forwarded-proto'];
@@ -36,7 +37,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}, ${REQUEST_DEPTH_HEADER}: ${requestDepth}`,
                 });
             }
         }
@@ -81,7 +82,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;
         }

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.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
+            res.status(400).send(descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
             return;
         }
         const { runtimeEnvironment, runtimeParams } = req.getRuntimeContext(defaultRuntimeEnvironment);
@@ -23,7 +23,7 @@ function createResourceMiddleware(context) {
             res.status(200).type(resource.type).stream(resource.stream());
             return;
         }
-        res.status(404).send(descriptions.UNRESOLVABLE.RESOURCE(resourceId.specifier, resourceId.version).message);
+        res.status(404).send(descriptions.UNRESOLVABLE.RESOURCE(resourceId.specifier, resourceId.version));
     };
 }
 export function resourceMiddleware(app, context) {

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,53 @@
-import { descriptions, DiagnosticsError, 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 LwrUnresolvableError &&
-        error.diagnostics[0].description.category === 'lwrUnresolvable/invalid') {
-        return { status: 400, message: error.message };
+import { isURL, parseRequestDepth, REQUEST_DEPTH_KEY } 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_KEY, 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 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>`;
     }
-    return { status: 500, message: `${descriptions.SERVER.SERVER_ERROR(url).message}: ${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 +61,12 @@ export function handleErrors(middleware) {
             else {
                 logger.error(err);
             }
-            const { status, message } = createReturnStatus(err, req.originalUrl);
+            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);
-            res.send(message);
+            res.send(body);
         }
     };
 }

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

@@ -1,14 +1,12 @@
 import { explodeSpecifier, explodeSpecifiers, LATEST_SIGNATURE } from '@lwrjs/shared-utils';
-import { createSingleDiagnosticError, descriptions, LwrUnresolvableError } 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 createSingleDiagnosticError({
-            description: descriptions.UNRESOLVABLE.INVALID_SPECIFIER(specifier),
-        }, LwrUnresolvableError);
+        throw new LwrInvalidError(descriptions.INVALID.INVALID_SPECIFIER(specifier));
     }
     const moduleId = explodeSpecifier(specifier);
     return {
@@ -32,9 +30,7 @@ export function getMappingIdentity(req) {
 export function getResourceIdentity(req) {
     const { specifier, signature = LATEST_SIGNATURE } = req.params;
     if (validateSpecifier(specifier) === false) {
-        throw createSingleDiagnosticError({
-            description: descriptions.UNRESOLVABLE.INVALID_SPECIFIER(specifier),
-        }, LwrUnresolvableError);
+        throw new LwrInvalidError(descriptions.INVALID.INVALID_SPECIFIER(specifier));
     }
     const resourceId = explodeSpecifier(specifier);
     return {
@@ -50,9 +46,7 @@ export function getAssetIdentity(req) {
             : '/' + req.params[0]
         : req.originalUrl.split('?')[0];
     if (validateSpecifier(specifier) === false) {
-        throw createSingleDiagnosticError({
-            description: descriptions.UNRESOLVABLE.INVALID_SPECIFIER(specifier),
-        }, LwrUnresolvableError);
+        throw new LwrInvalidError(descriptions.INVALID.INVALID_SPECIFIER(specifier));
     }
     return {
         immutable,

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

@@ -2,7 +2,7 @@ import { TextEncoder } from 'util';
 import { URLSearchParams } from 'url';
 import { descriptions, logger } from '@lwrjs/diagnostics';
 import { getClientRoutes } from '@lwrjs/router';
-import { decodeViewPath, extractRequestParams, getClientBootstrapConfigurationRoutes, isURL, parseRequestDepth, REQUEST_DEPTH_KEY, isLocalDev, shortestTtl, isLambdaEnv, } from '@lwrjs/shared-utils';
+import { decodeViewPath, extractRequestParams, getClientBootstrapConfigurationRoutes, isLocalDev, shortestTtl, isLambdaEnv, } from '@lwrjs/shared-utils';
 import { RequestHandlerSpan, getTracer } from '@lwrjs/instrumentation';
 import { handleErrors } from './utils/error-handling.js';
 import { LwrViewHandler } from '@lwrjs/view-registry';
@@ -17,12 +17,12 @@ function createViewMiddleware(route, errorRoutes, context, viewHandler) {
     return async (req, res) => {
         if (!req.validateEnvironmentRequest(appConfig)) {
             res.status(400);
-            res.send(descriptions.UNRESOLVABLE.INVALID_ENVIRONMENT(req.params.environment).message);
+            res.send(descriptions.INVALID.INVALID_ENVIRONMENT(req.params.environment));
             return;
         }
         if (!req.validateJsonRequest()) {
             res.status(400);
-            res.send(descriptions.UNRESOLVABLE.INVALID_JSON().message);
+            res.send(descriptions.INVALID.INVALID_JSON());
             return;
         }
         const { runtimeEnvironment, runtimeParams: defaultRuntimeParams } = req.getRuntimeContext(context.runtimeEnvironment);
@@ -72,7 +72,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
@@ -119,29 +121,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
@@ -181,7 +164,7 @@ function createConfigMiddleware(routes, context, viewHandler) {
         // match the app id to a route
         const route = routes.find((route) => route.id === appId);
         if (!route) {
-            res.status(404).send(descriptions.UNRESOLVABLE.APP_CONFIG(appId).message);
+            res.status(404).send(descriptions.UNRESOLVABLE.APP_CONFIG(appId));
             return;
         }
         // decode the resolved view path and extract any params.
@@ -217,7 +200,7 @@ function createConfigMiddleware(routes, context, viewHandler) {
         };
         const viewResponse = await viewHandler.getViewConfiguration(viewRequest, route, runtimeEnvironment, runtimeParams);
         if (!viewResponse) {
-            res.status(404).send(descriptions.UNRESOLVABLE.VIEW_CONFIG(url).message);
+            res.status(404).send(descriptions.UNRESOLVABLE.VIEW_CONFIG(url));
             return;
         }
         // Pick the shortest TTL between the view response and route object
@@ -238,7 +221,7 @@ function createNotFoundMiddleware(errorRoutes, context, viewHandler) {
         return createViewMiddleware(notFoundRoute, errorRoutes, context, viewHandler);
     }
     return (req, res) => {
-        res.status(404).send(descriptions.UNRESOLVABLE.VIEW(req.originalUrl).message);
+        res.status(404).send(descriptions.UNRESOLVABLE.VIEW(req.originalUrl));
     };
 }
 export function viewMiddleware(app, context) {
@@ -272,7 +255,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 +308,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.1",
+    "version": "0.17.2-alpha.10",
     "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.1",
-        "@lwrjs/asset-registry": "0.17.2-alpha.1",
-        "@lwrjs/asset-transformer": "0.17.2-alpha.1",
-        "@lwrjs/base-view-provider": "0.17.2-alpha.1",
-        "@lwrjs/base-view-transformer": "0.17.2-alpha.1",
-        "@lwrjs/client-modules": "0.17.2-alpha.1",
-        "@lwrjs/config": "0.17.2-alpha.1",
-        "@lwrjs/diagnostics": "0.17.2-alpha.1",
-        "@lwrjs/esbuild": "0.17.2-alpha.1",
-        "@lwrjs/fs-asset-provider": "0.17.2-alpha.1",
-        "@lwrjs/fs-watch": "0.17.2-alpha.1",
-        "@lwrjs/html-view-provider": "0.17.2-alpha.1",
-        "@lwrjs/instrumentation": "0.17.2-alpha.1",
-        "@lwrjs/loader": "0.17.2-alpha.1",
-        "@lwrjs/lwc-module-provider": "0.17.2-alpha.1",
-        "@lwrjs/lwc-ssr": "0.17.2-alpha.1",
-        "@lwrjs/markdown-view-provider": "0.17.2-alpha.1",
-        "@lwrjs/module-bundler": "0.17.2-alpha.1",
-        "@lwrjs/module-registry": "0.17.2-alpha.1",
-        "@lwrjs/npm-module-provider": "0.17.2-alpha.1",
-        "@lwrjs/nunjucks-view-provider": "0.17.2-alpha.1",
-        "@lwrjs/o11y": "0.17.2-alpha.1",
-        "@lwrjs/resource-registry": "0.17.2-alpha.1",
-        "@lwrjs/router": "0.17.2-alpha.1",
-        "@lwrjs/server": "0.17.2-alpha.1",
-        "@lwrjs/shared-utils": "0.17.2-alpha.1",
-        "@lwrjs/static": "0.17.2-alpha.1",
-        "@lwrjs/view-registry": "0.17.2-alpha.1",
+        "@lwrjs/app-service": "0.17.2-alpha.10",
+        "@lwrjs/asset-registry": "0.17.2-alpha.10",
+        "@lwrjs/asset-transformer": "0.17.2-alpha.10",
+        "@lwrjs/base-view-provider": "0.17.2-alpha.10",
+        "@lwrjs/base-view-transformer": "0.17.2-alpha.10",
+        "@lwrjs/client-modules": "0.17.2-alpha.10",
+        "@lwrjs/config": "0.17.2-alpha.10",
+        "@lwrjs/diagnostics": "0.17.2-alpha.10",
+        "@lwrjs/esbuild": "0.17.2-alpha.10",
+        "@lwrjs/fs-asset-provider": "0.17.2-alpha.10",
+        "@lwrjs/fs-watch": "0.17.2-alpha.10",
+        "@lwrjs/html-view-provider": "0.17.2-alpha.10",
+        "@lwrjs/instrumentation": "0.17.2-alpha.10",
+        "@lwrjs/loader": "0.17.2-alpha.10",
+        "@lwrjs/lwc-module-provider": "0.17.2-alpha.10",
+        "@lwrjs/lwc-ssr": "0.17.2-alpha.10",
+        "@lwrjs/markdown-view-provider": "0.17.2-alpha.10",
+        "@lwrjs/module-bundler": "0.17.2-alpha.10",
+        "@lwrjs/module-registry": "0.17.2-alpha.10",
+        "@lwrjs/npm-module-provider": "0.17.2-alpha.10",
+        "@lwrjs/nunjucks-view-provider": "0.17.2-alpha.10",
+        "@lwrjs/o11y": "0.17.2-alpha.10",
+        "@lwrjs/resource-registry": "0.17.2-alpha.10",
+        "@lwrjs/router": "0.17.2-alpha.10",
+        "@lwrjs/server": "0.17.2-alpha.10",
+        "@lwrjs/shared-utils": "0.17.2-alpha.10",
+        "@lwrjs/static": "0.17.2-alpha.10",
+        "@lwrjs/view-registry": "0.17.2-alpha.10",
         "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.1",
+        "@lwrjs/types": "0.17.2-alpha.10",
         "@types/ws": "^8.5.12",
         "memfs": "^4.13.0"
     },
@@ -93,5 +93,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "bba15ca717a242b0375decaa378af06bdee813b5"
+    "gitHead": "3938f97f31973d7953bb61cff8388c71980c22c7"
 }