@lwrjs/view-registry 0.12.0-alpha.12 → 0.12.0-alpha.13

package/build/cjs/index.cjs

@@ -167,44 +167,53 @@ var LwrViewRegistry = class {
     return false;
   }
   async getViewDefinition(view, viewParams, runtimeEnvironment, runtimeParams, renderOptions) {
-    const {skipCaching, freezeAssets, viewParamCacheKey} = (0, import_utils.normalizeRenderOptions)(this.runtimeEnvironment, renderOptions);
-    const viewDefCacheKey = (0, import_shared_utils.getCacheKeyFromJson)({
-      ...view,
-      freezeAssets,
-      locale: runtimeParams?.locale,
-      basePath: runtimeParams?.basePath,
-      debug: runtimeEnvironment.debug
-    });
-    import_diagnostics.logger.debug(`[view-registry][getViewDefinition] viewDefCacheKey=${viewDefCacheKey}`);
-    const viewParamKey = viewParamCacheKey ? (0, import_shared_utils.getCacheKeyFromJson)(viewParamCacheKey) : (0, import_shared_utils.getCacheKeyFromJson)(viewParams);
-    import_diagnostics.logger.debug(`[view-registry][getViewDefinition] viewParamKey=${viewParamKey}`);
-    const cacheDisabled = process.env.NOCACHE === "true" || skipCaching;
-    if (cacheDisabled === false && this.viewDefinitions.has(viewDefCacheKey)) {
-      const viewDefinition2 = this.viewDefinitions.get(viewDefCacheKey);
-      if (viewDefinition2 && viewDefinition2.paramKey === viewParamKey && viewDefinition2.viewDefinition.immutable) {
-        return viewDefinition2.viewDefinition;
+    try {
+      const {skipCaching, freezeAssets, viewParamCacheKey} = (0, import_utils.normalizeRenderOptions)(this.runtimeEnvironment, renderOptions);
+      const viewDefCacheKey = (0, import_shared_utils.getCacheKeyFromJson)({
+        ...view,
+        freezeAssets,
+        locale: runtimeParams?.locale,
+        basePath: runtimeParams?.basePath,
+        debug: runtimeEnvironment.debug
+      });
+      import_diagnostics.logger.debug(`[view-registry][getViewDefinition] viewDefCacheKey=${viewDefCacheKey}`);
+      const viewParamKey = viewParamCacheKey ? (0, import_shared_utils.getCacheKeyFromJson)(viewParamCacheKey) : (0, import_shared_utils.getCacheKeyFromJson)(viewParams);
+      import_diagnostics.logger.debug(`[view-registry][getViewDefinition] viewParamKey=${viewParamKey}`);
+      const cacheDisabled = process.env.NOCACHE === "true" || skipCaching;
+      if (cacheDisabled === false && this.viewDefinitions.has(viewDefCacheKey)) {
+        const viewDefinition2 = this.viewDefinitions.get(viewDefCacheKey);
+        if (viewDefinition2 && viewDefinition2.paramKey === viewParamKey && viewDefinition2.viewDefinition.immutable) {
+          return viewDefinition2.viewDefinition;
+        }
       }
-    }
-    const pendingViewDefCacheKey = viewDefCacheKey + viewParamKey;
-    const viewDefinition = await this.pendingViewDefinitions.execute(pendingViewDefCacheKey, () => (0, import_instrumentation.getTracer)().trace({
-      name: import_instrumentation.ViewSpan.RenderView,
-      attributes: {
-        view: view.id,
-        ssr: view.bootstrap?.ssr === true
+      const pendingViewDefCacheKey = viewDefCacheKey + viewParamKey;
+      const viewDefinition = await this.pendingViewDefinitions.execute(pendingViewDefCacheKey, () => (0, import_instrumentation.getTracer)().trace({
+        name: import_instrumentation.ViewSpan.RenderView,
+        attributes: {
+          view: view.id,
+          ssr: view.bootstrap?.ssr === true
+        }
+      }, () => this.renderView(view, viewParams, runtimeEnvironment, runtimeParams, renderOptions)));
+      if (cacheDisabled === false) {
+        const route = this.globalConfig.routes.find((r) => r.id === view.id);
+        const ttl = (0, import_shared_utils.shortestTtl)(viewDefinition.cache?.ttl, route?.cache?.ttl);
+        if (ttl !== 0) {
+          this.viewDefinitions.set(viewDefCacheKey, {
+            view,
+            viewDefinition,
+            paramKey: viewParamKey
+          }, {ttl: ttl ? ttl * 1e3 : void 0});
+        }
       }
-    }, () => this.renderView(view, viewParams, runtimeEnvironment, runtimeParams, renderOptions)));
-    if (cacheDisabled === false) {
-      const route = this.globalConfig.routes.find((r) => r.id === view.id);
-      const ttl = (0, import_shared_utils.shortestTtl)(viewDefinition.cache?.ttl, route?.cache?.ttl);
-      if (ttl !== 0) {
-        this.viewDefinitions.set(viewDefCacheKey, {
-          view,
-          viewDefinition,
-          paramKey: viewParamKey
-        }, {ttl: ttl ? ttl * 1e3 : void 0});
+      return viewDefinition;
+    } catch (err) {
+      if (err instanceof import_diagnostics.DiagnosticsError) {
+        throw err;
       }
+      import_diagnostics.logger.error(`Failed to get view definition "${view.id}": ${err}`);
+      const message = err instanceof Error ? err.message : String(err);
+      throw (0, import_diagnostics.createSingleDiagnosticError)({description: import_diagnostics.descriptions.SERVER.UNEXPECTED_ERROR(message)}, import_diagnostics.LwrServerError);
     }
-    return viewDefinition;
   }
   async renderView(view, viewParams, runtimeEnvironment, runtimeParams = {}, renderOptions) {
     const {id, contentTemplate, rootComponent, layoutTemplate} = view;

package/build/cjs/linkers/utils.cjs

@@ -45,8 +45,10 @@ function getViewBootstrapConfigurationResource(viewInfo, config, runtimeEnvironm
     },
     ...debug && {modifiers: {debug: "true"}}
   };
-  const environment = {
-    NODE_ENV: runtimeEnvironment.serverMode,
+  const nodeEnv = {
+    NODE_ENV: runtimeEnvironment.serverMode
+  };
+  const lwrEnv = {
     SSR: false,
     ...(0, import_shared_utils.buildEnvironmentContext)(runtimeParams)
   };
@@ -58,7 +60,8 @@ function getViewBootstrapConfigurationResource(viewInfo, config, runtimeEnvironm
       ...config,
       endpoints
     })});`,
-    `globalThis.process = { env: ${JSON.stringify(environment)} };`,
+    `globalThis.LWR = {...globalThis.LWR, env: ${JSON.stringify(lwrEnv)}};`,
+    `globalThis.process={...globalThis.process,env:{...globalThis.process?.env,...${JSON.stringify(nodeEnv)}}};`,
     `globalThis.lwcRuntimeFlags = { ENABLE_MIXED_SHADOW_MODE: ${viewInfo.mixedMode} };`,
     debug && debugMessage && `console.warn(${JSON.stringify(debugMessage)});`
   ].filter(Boolean).join("\n");

package/build/cjs/view-handler.cjs

@@ -30,6 +30,7 @@ var import_path = __toModule(require("path"));
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
 var import_instrumentation = __toModule(require("@lwrjs/instrumentation"));
 var import_utils = __toModule(require("./utils.cjs"));
+var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var LwrViewHandler = class {
   constructor(context, globalConfig) {
     this.globalConfig = globalConfig;
@@ -135,7 +136,17 @@ var LwrViewHandler = class {
         view: route.id,
         route: viewRequest.requestPath
       }
-    }, async () => routeHandlerFn({...viewRequest, locale}, {route, viewApi, ...paths}, routeHandlerOptions));
+    }, async () => {
+      try {
+        return await routeHandlerFn({...viewRequest, locale}, {route, viewApi, ...paths}, routeHandlerOptions);
+      } catch (err) {
+        if (err instanceof import_diagnostics.DiagnosticsError) {
+          throw err;
+        }
+        const message = err instanceof Error ? err.message : String(err);
+        throw (0, import_diagnostics.createSingleDiagnosticError)({description: import_diagnostics.descriptions.APPLICATION.ROUTE_HANDLER_ERROR(route.id, message)}, import_diagnostics.LwrApplicationError);
+      }
+    });
     return response;
   }
   getBoundApi(viewRequest, route, runtimeEnvironment, runtimeParams) {

package/build/es/index.js

@@ -3,7 +3,7 @@ import { getTracer, ViewSpan } from '@lwrjs/instrumentation';
 import { normalizeRenderOptions, normalizeRenderedResult, reduceSourceAssetReferences } from './utils.js';
 import { linkLwrResources } from './linkers/link-lwr-resources.js';
 import { LRUCache } from 'lru-cache';
-import { logger } from '@lwrjs/diagnostics';
+import { DiagnosticsError, LwrServerError, createSingleDiagnosticError, descriptions, logger, } from '@lwrjs/diagnostics';
 export { LwrViewHandler } from './view-handler.js';
 export class LwrViewRegistry {
     constructor(context, globalConfig) {
@@ -159,55 +159,65 @@ export class LwrViewRegistry {
         return false;
     }
     async getViewDefinition(view, viewParams, runtimeEnvironment, runtimeParams, renderOptions) {
-        const { skipCaching, freezeAssets, viewParamCacheKey } = normalizeRenderOptions(this.runtimeEnvironment, renderOptions);
-        const viewDefCacheKey = getCacheKeyFromJson({
-            ...view,
-            freezeAssets,
-            locale: runtimeParams?.locale,
-            basePath: runtimeParams?.basePath,
-            debug: runtimeEnvironment.debug,
-        });
-        logger.debug(`[view-registry][getViewDefinition] viewDefCacheKey=${viewDefCacheKey}`);
-        // viewParams is an unbounded object and can be very large (17MB/view for developer.salesforce.com). Allowing consumers
-        // to provide a simple override avoids the excess memory / performance overhead of serializing & storing the viewParams
-        // on every request, while still reusing our caching logic.
-        const viewParamKey = viewParamCacheKey
-            ? getCacheKeyFromJson(viewParamCacheKey)
-            : getCacheKeyFromJson(viewParams);
-        logger.debug(`[view-registry][getViewDefinition] viewParamKey=${viewParamKey}`);
-        const cacheDisabled = process.env.NOCACHE === 'true' || skipCaching;
-        // important: cache key does not include the unbounded viewParams
-        if (cacheDisabled === false && this.viewDefinitions.has(viewDefCacheKey)) {
-            const viewDefinition = this.viewDefinitions.get(viewDefCacheKey);
-            if (viewDefinition &&
-                viewDefinition.paramKey === viewParamKey &&
-                viewDefinition.viewDefinition.immutable) {
-                return viewDefinition.viewDefinition;
+        try {
+            const { skipCaching, freezeAssets, viewParamCacheKey } = normalizeRenderOptions(this.runtimeEnvironment, renderOptions);
+            const viewDefCacheKey = getCacheKeyFromJson({
+                ...view,
+                freezeAssets,
+                locale: runtimeParams?.locale,
+                basePath: runtimeParams?.basePath,
+                debug: runtimeEnvironment.debug,
+            });
+            logger.debug(`[view-registry][getViewDefinition] viewDefCacheKey=${viewDefCacheKey}`);
+            // viewParams is an unbounded object and can be very large (17MB/view for developer.salesforce.com). Allowing consumers
+            // to provide a simple override avoids the excess memory / performance overhead of serializing & storing the viewParams
+            // on every request, while still reusing our caching logic.
+            const viewParamKey = viewParamCacheKey
+                ? getCacheKeyFromJson(viewParamCacheKey)
+                : getCacheKeyFromJson(viewParams);
+            logger.debug(`[view-registry][getViewDefinition] viewParamKey=${viewParamKey}`);
+            const cacheDisabled = process.env.NOCACHE === 'true' || skipCaching;
+            // important: cache key does not include the unbounded viewParams
+            if (cacheDisabled === false && this.viewDefinitions.has(viewDefCacheKey)) {
+                const viewDefinition = this.viewDefinitions.get(viewDefCacheKey);
+                if (viewDefinition &&
+                    viewDefinition.paramKey === viewParamKey &&
+                    viewDefinition.viewDefinition.immutable) {
+                    return viewDefinition.viewDefinition;
+                }
             }
+            const pendingViewDefCacheKey = viewDefCacheKey + viewParamKey;
+            const viewDefinition = await this.pendingViewDefinitions.execute(pendingViewDefCacheKey, () => getTracer().trace({
+                name: ViewSpan.RenderView,
+                attributes: {
+                    view: view.id,
+                    ssr: view.bootstrap?.ssr === true,
+                },
+            }, () => this.renderView(view, viewParams, runtimeEnvironment, runtimeParams, renderOptions)));
+            if (cacheDisabled === false) {
+                const route = this.globalConfig.routes.find((r) => r.id === view.id);
+                const ttl = shortestTtl(viewDefinition.cache?.ttl, route?.cache?.ttl);
+                if (ttl !== 0) {
+                    // cache view definition for the shortest ttl or until it is the least recently used when ttl is undefined
+                    this.viewDefinitions.set(viewDefCacheKey, {
+                        view,
+                        viewDefinition,
+                        paramKey: viewParamKey,
+                    }, 
+                    // s -> ms
+                    { ttl: ttl ? ttl * 1000 : undefined });
+                }
+            }
+            return viewDefinition;
         }
-        const pendingViewDefCacheKey = viewDefCacheKey + viewParamKey;
-        const viewDefinition = await this.pendingViewDefinitions.execute(pendingViewDefCacheKey, () => getTracer().trace({
-            name: ViewSpan.RenderView,
-            attributes: {
-                view: view.id,
-                ssr: view.bootstrap?.ssr === true,
-            },
-        }, () => this.renderView(view, viewParams, runtimeEnvironment, runtimeParams, renderOptions)));
-        if (cacheDisabled === false) {
-            const route = this.globalConfig.routes.find((r) => r.id === view.id);
-            const ttl = shortestTtl(viewDefinition.cache?.ttl, route?.cache?.ttl);
-            if (ttl !== 0) {
-                // cache view definition for the shortest ttl or until it is the least recently used when ttl is undefined
-                this.viewDefinitions.set(viewDefCacheKey, {
-                    view,
-                    viewDefinition,
-                    paramKey: viewParamKey,
-                }, 
-                // s -> ms
-                { ttl: ttl ? ttl * 1000 : undefined });
+        catch (err) {
+            if (err instanceof DiagnosticsError) {
+                throw err;
             }
+            logger.error(`Failed to get view definition "${view.id}": ${err}`);
+            const message = err instanceof Error ? err.message : String(err);
+            throw createSingleDiagnosticError({ description: descriptions.SERVER.UNEXPECTED_ERROR(message) }, LwrServerError);
         }
-        return viewDefinition;
     }
     async renderView(view, viewParams, runtimeEnvironment, runtimeParams = {}, renderOptions) {
         const { id, contentTemplate, rootComponent, layoutTemplate } = view;

package/build/es/linkers/utils.js

@@ -17,9 +17,11 @@ export function getViewBootstrapConfigurationResource(viewInfo, config, runtimeE
         },
         ...(debug && { modifiers: { debug: 'true' } }),
     };
-    const environment = {
+    const nodeEnv = {
         // TODO: W-12639529 change NODE_ENV after addressing downstream customers
         NODE_ENV: runtimeEnvironment.serverMode,
+    };
+    const lwrEnv = {
         // Note: SSR is always false because this script is executed on the client
         SSR: false,
         // Used by `lwr/environment`
@@ -33,7 +35,8 @@ export function getViewBootstrapConfigurationResource(viewInfo, config, runtimeE
             ...config,
             endpoints,
         })});`,
-        `globalThis.process = { env: ${JSON.stringify(environment)} };`,
+        `globalThis.LWR = {...globalThis.LWR, env: ${JSON.stringify(lwrEnv)}};`,
+        `globalThis.process={...globalThis.process,env:{...globalThis.process?.env,...${JSON.stringify(nodeEnv)}}};`,
         `globalThis.lwcRuntimeFlags = { ENABLE_MIXED_SHADOW_MODE: ${viewInfo.mixedMode} };`,
         debug && debugMessage && `console.warn(${JSON.stringify(debugMessage)});`,
     ]

package/build/es/view-handler.js

@@ -2,6 +2,7 @@ import { resolve } from 'path';
 import { normalizeResourcePath, shortestTtl } from '@lwrjs/shared-utils';
 import { getTracer, ViewSpan } from '@lwrjs/instrumentation';
 import { generateHtmlTag, generatePageContext, isViewResponse, toJsonFormat } from './utils.js';
+import { DiagnosticsError, LwrApplicationError, createSingleDiagnosticError, descriptions, } from '@lwrjs/diagnostics';
 export class LwrViewHandler {
     constructor(context, globalConfig) {
         this.globalConfig = globalConfig;
@@ -145,14 +146,24 @@ export class LwrViewHandler {
         const paths = { rootDir, assets, contentDir, layoutsDir };
         const locale = runtimeParams.locale;
         const viewApi = this.getBoundApi(viewRequest, route, runtimeEnvironment, runtimeParams);
-        // TODO: add trace attributes
         const response = await getTracer().trace({
             name: ViewSpan.ExecuteRouteHandler,
             attributes: {
                 view: route.id,
                 route: viewRequest.requestPath,
             },
-        }, async () => routeHandlerFn({ ...viewRequest, locale }, { route: route, viewApi, ...paths }, routeHandlerOptions));
+        }, async () => {
+            try {
+                return await routeHandlerFn({ ...viewRequest, locale }, { route: route, viewApi, ...paths }, routeHandlerOptions);
+            }
+            catch (err) {
+                if (err instanceof DiagnosticsError) {
+                    throw err;
+                }
+                const message = err instanceof Error ? err.message : String(err);
+                throw createSingleDiagnosticError({ description: descriptions.APPLICATION.ROUTE_HANDLER_ERROR(route.id, message) }, LwrApplicationError);
+            }
+        });
         return response;
     }
     /*

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.12.0-alpha.12",
+    "version": "0.12.0-alpha.13",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -30,17 +30,17 @@
         "build/**/*.d.ts"
     ],
     "dependencies": {
-        "@lwrjs/app-service": "0.12.0-alpha.12",
-        "@lwrjs/diagnostics": "0.12.0-alpha.12",
-        "@lwrjs/instrumentation": "0.12.0-alpha.12",
-        "@lwrjs/shared-utils": "0.12.0-alpha.12",
+        "@lwrjs/app-service": "0.12.0-alpha.13",
+        "@lwrjs/diagnostics": "0.12.0-alpha.13",
+        "@lwrjs/instrumentation": "0.12.0-alpha.13",
+        "@lwrjs/shared-utils": "0.12.0-alpha.13",
         "lru-cache": "^10.2.0"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.12.0-alpha.12"
+        "@lwrjs/types": "0.12.0-alpha.13"
     },
     "engines": {
         "node": ">=18.0.0"
     },
-    "gitHead": "bc8a88bce246e9ec00641955152de526ea030ebb"
+    "gitHead": "7a63e416f9e5f27b44331311a371f68e20ce685c"
 }