@lwrjs/view-registry 0.10.0-alpha.15 → 0.10.0-alpha.16

package/build/cjs/index.cjs

@@ -30,12 +30,12 @@ __export(exports, {
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
 var import_utils = __toModule(require("./utils.cjs"));
 var import_link_lwr_resources = __toModule(require("./linkers/link-lwr-resources.cjs"));
+var import_lru_cache = __toModule(require("lru-cache"));
 var import_view_handler = __toModule(require("./view-handler.cjs"));
 var LwrViewRegistry = class {
   constructor(context, globalConfig) {
     this.viewProviders = [];
     this.compiledViews = new Map();
-    this.viewDefinitions = new Map();
     this.immutableAssets = new Map();
     this.pendingViewDefinitions = new import_shared_utils.InflightTasks();
     this.name = "lwr-view-registry";
@@ -49,14 +49,17 @@ var LwrViewRegistry = class {
     this.globalData = context.globalData;
     this.appEmitter = context.appEmitter;
     const observer = context.appObserver;
+    this.viewDefinitions = new import_lru_cache.LRUCache({max: parseInt(process.env.VIEW_CACHE_SIZE || "500", 10)});
     observer.onViewSourceChange(({payload}) => this.onViewSourceChange(payload));
     observer.onModuleDefinitionChange(({payload}) => this.onModuleDefinitionChange(payload));
     observer.onAssetSourceChange(({payload}) => this.onAssetSourceChange(payload));
   }
   async onModuleDefinitionChange(moduleDefinition) {
     const versionedSpecifier = (0, import_shared_utils.getSpecifier)(moduleDefinition);
-    for (const [id, {viewDefinition}] of this.viewDefinitions.entries()) {
-      const {viewRecord} = viewDefinition;
+    for (const [id, viewDefEntry] of this.viewDefinitions.entries()) {
+      const {
+        viewDefinition: {viewRecord}
+      } = viewDefEntry;
       const uriMap = viewRecord.bootstrapModule?.flatGraph.uriMap;
       if (uriMap) {
         Object.keys(uriMap);
@@ -74,12 +77,12 @@ var LwrViewRegistry = class {
     const {contentTemplate, rootComponent} = compiledView.viewId;
     const compiledViewCacheKey = (0, import_shared_utils.getCacheKeyFromJson)({contentTemplate, rootComponent});
     this.compiledViews.set(compiledViewCacheKey, compiledView);
-    for (const [id, {view}] of this.viewDefinitions.entries()) {
+    for (const [id, viewDefEntry] of this.viewDefinitions.entries()) {
       const {
         contentTemplate: eContentTempl,
         layoutTemplate: eLayoutTemplate,
         rootComponent: eRootComponent
-      } = view;
+      } = viewDefEntry.view;
       if (eContentTempl === contentTemplate || eLayoutTemplate === contentTemplate || eRootComponent === rootComponent) {
         this.viewDefinitions.delete(id);
       }
@@ -87,8 +90,10 @@ var LwrViewRegistry = class {
   }
   onAssetSourceChange(asset) {
     const assetId = asset.entry;
-    for (const [id, {viewDefinition}] of this.viewDefinitions.entries()) {
-      const {viewRecord} = viewDefinition;
+    for (const [id, viewDefEntry] of this.viewDefinitions.entries()) {
+      const {
+        viewDefinition: {viewRecord}
+      } = viewDefEntry;
       const someAssets = viewRecord.assetReferences?.some((ref) => {
         return ref.override?.entry === assetId;
       });
@@ -174,11 +179,13 @@ var LwrViewRegistry = class {
     const pendingViewDefCacheKey = viewDefCacheKey + viewParamKey;
     const viewDefinition = await this.pendingViewDefinitions.execute(pendingViewDefCacheKey, () => 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);
       this.viewDefinitions.set(viewDefCacheKey, {
         view,
         viewDefinition,
         paramKey: viewParamKey
-      });
+      }, {ttl: ttl ? ttl * 1e3 : void 0});
     }
     return viewDefinition;
   }

package/build/cjs/view-handler.cjs

@@ -127,20 +127,20 @@ var LwrViewHandler = class {
     if (!route.routeHandler) {
       throw new Error("Route handler is required for a CustomView");
     }
-    const routeHandler = this.routeHandlers[route.routeHandler];
-    if (!routeHandler) {
+    const [routeHandlerFn, routeHandlerOptions] = this.routeHandlers[route.routeHandler[0]];
+    if (!routeHandlerFn) {
       throw new Error(`Route handler does not exist for id: ${route.routeHandler}`);
     }
     const {rootDir, assets, contentDir, layoutsDir} = this.globalConfig;
     const paths = {rootDir, assets, contentDir, layoutsDir};
     const locale = runtimeParams.locale;
-    const viewApi = this.getBoundApi(route, runtimeEnvironment, runtimeParams);
-    const response = await routeHandler({...viewRequest, locale}, {route, viewApi, ...paths});
+    const viewApi = this.getBoundApi(viewRequest, route, runtimeEnvironment, runtimeParams);
+    const response = await routeHandlerFn({...viewRequest, locale}, {route, viewApi, ...paths}, routeHandlerOptions);
     return response;
   }
-  getBoundApi(route, runtimeEnvironment, runtimeParams) {
+  getBoundApi(viewRequest, route, runtimeEnvironment, runtimeParams) {
     return {
-      getViewResponse: this.getViewResponse.bind(this, route, runtimeEnvironment, runtimeParams),
+      getViewResponse: this.getViewResponse.bind(this, viewRequest, route, runtimeEnvironment, runtimeParams),
       hasViewResponse: this.hasViewResponse.bind(this, route, runtimeEnvironment, runtimeParams)
     };
   }
@@ -149,10 +149,20 @@ var LwrViewHandler = class {
     const managedView = {...view, id, bootstrap};
     return this.viewRegistry.hasViewDefinition(managedView, viewParams, runtimeEnvironment, runtimeParams, renderOptions);
   }
-  async getViewResponse(route, runtimeEnvironment, runtimeParams = {}, view, viewParams, renderOptions) {
+  async getViewResponse(viewRequest, route, runtimeEnvironment, runtimeParams = {}, view, viewParams, renderOptions) {
     const {id, bootstrap} = route;
     const managedView = {...view, id, bootstrap};
-    const viewDefinition = await this.viewRegistry.getViewDefinition(managedView, viewParams, runtimeEnvironment, runtimeParams, renderOptions);
+    const viewResponse = {
+      view: managedView,
+      viewParams,
+      renderOptions
+    };
+    const {
+      view: normalizedView,
+      viewParams: normalizedViewParams,
+      renderOptions: normalizedRenderOptions
+    } = normalizeViewProperties(viewRequest, viewResponse, route, this.globalConfig);
+    const viewDefinition = await this.viewRegistry.getViewDefinition(normalizedView, normalizedViewParams, runtimeEnvironment, runtimeParams, normalizedRenderOptions);
     return {
       body: viewDefinition.renderedView,
       metadata: {

package/build/es/index.d.ts

@@ -1,5 +1,5 @@
-import { AssetRegistry, CompiledView, Json, LinkedModuleDefinition, LinkedViewDefinition, LwrAppEmitter, LwrAppObserver, ModuleBundler, ModuleRegistry, NormalizedLwrGlobalConfig, PublicViewRegistry, RenderOptions, ResourceRegistry, RuntimeEnvironment, RuntimeParams, View, ViewIdentity, ViewParams, ViewProvider, ViewRegistry, ViewTransformPlugin } from '@lwrjs/types';
-import { AssetSource } from '@lwrjs/types';
+import type { AssetRegistry, AssetSource, CompiledView, Json, LinkedModuleDefinition, LinkedViewDefinition, LwrAppEmitter, LwrAppObserver, ModuleBundler, ModuleRegistry, NormalizedLwrGlobalConfig, PublicViewRegistry, RenderOptions, ResourceRegistry, RuntimeEnvironment, RuntimeParams, View, ViewIdentity, ViewParams, ViewProvider, ViewRegistry, ViewTransformPlugin } from '@lwrjs/types';
+import { LRUCache } from 'lru-cache';
 export { LwrViewHandler } from './view-handler.js';
 interface ViewProviderContext {
     viewTransformers?: ViewTransformPlugin[];
@@ -21,7 +21,7 @@ export declare class LwrViewRegistry implements ViewRegistry {
     name: string;
     viewProviders: ViewProvider[];
     compiledViews: Map<string, CompiledView>;
-    viewDefinitions: Map<string, ViewDefinitionCacheEntry>;
+    viewDefinitions: LRUCache<string, ViewDefinitionCacheEntry>;
     resourceRegistry: ResourceRegistry;
     moduleRegistry: ModuleRegistry;
     moduleBundler: ModuleBundler;

package/build/es/index.js

@@ -1,6 +1,7 @@
-import { extractMetadataFromHtml, getCacheKeyFromJson, getSpecifier, normalizeResourcePath, createStringBuilder, shortestTtl, InflightTasks, } from '@lwrjs/shared-utils';
+import { InflightTasks, createStringBuilder, extractMetadataFromHtml, getCacheKeyFromJson, getSpecifier, normalizeResourcePath, shortestTtl, } from '@lwrjs/shared-utils';
 import { normalizeRenderOptions, normalizeRenderedResult, reduceSourceAssetReferences } from './utils.js';
 import { linkLwrResources } from './linkers/link-lwr-resources.js';
+import { LRUCache } from 'lru-cache';
 export { LwrViewHandler } from './view-handler.js';
 export class LwrViewRegistry {
     constructor(context, globalConfig) {
@@ -8,9 +9,6 @@ export class LwrViewRegistry {
         // Cache of compiled views retrieved from the viewProviders
         //  Cache key: ViewIdentity
         this.compiledViews = new Map();
-        // Cache of linked view definitions, keyed by the View
-        //  Cache key: View
-        this.viewDefinitions = new Map();
         this.immutableAssets = new Map();
         // Cache of unresolved view definitions
         //  Cache key: View + View Params
@@ -29,6 +27,7 @@ export class LwrViewRegistry {
         this.globalData = context.globalData;
         this.appEmitter = context.appEmitter;
         const observer = context.appObserver;
+        this.viewDefinitions = new LRUCache({ max: parseInt(process.env.VIEW_CACHE_SIZE || '500', 10) });
         // Observers for cached entries external dependencies -- view templates, modules, and assets
         observer.onViewSourceChange(({ payload }) => this.onViewSourceChange(payload));
         observer.onModuleDefinitionChange(({ payload }) => this.onModuleDefinitionChange(payload));
@@ -37,8 +36,8 @@ export class LwrViewRegistry {
     async onModuleDefinitionChange(moduleDefinition) {
         const versionedSpecifier = getSpecifier(moduleDefinition);
         // invalidate viewDefinition cache entries with references to the LinkedModuleDefinition
-        for (const [id, { viewDefinition }] of this.viewDefinitions.entries()) {
-            const { viewRecord } = viewDefinition;
+        for (const [id, viewDefEntry] of this.viewDefinitions.entries()) {
+            const { viewDefinition: { viewRecord }, } = viewDefEntry;
             const uriMap = viewRecord.bootstrapModule?.flatGraph.uriMap;
             if (uriMap) {
                 Object.keys(uriMap);
@@ -61,8 +60,8 @@ export class LwrViewRegistry {
         const compiledViewCacheKey = getCacheKeyFromJson({ contentTemplate, rootComponent });
         this.compiledViews.set(compiledViewCacheKey, compiledView);
         // invalidate viewDefinitions cache
-        for (const [id, { view }] of this.viewDefinitions.entries()) {
-            const { contentTemplate: eContentTempl, layoutTemplate: eLayoutTemplate, rootComponent: eRootComponent, } = view;
+        for (const [id, viewDefEntry] of this.viewDefinitions.entries()) {
+            const { contentTemplate: eContentTempl, layoutTemplate: eLayoutTemplate, rootComponent: eRootComponent, } = viewDefEntry.view;
             if (eContentTempl === contentTemplate ||
                 eLayoutTemplate === contentTemplate ||
                 eRootComponent === rootComponent) {
@@ -74,8 +73,8 @@ export class LwrViewRegistry {
     onAssetSourceChange(asset) {
         // invalidate viewDefinition cache entries with references to the AssetSource entry.
         const assetId = asset.entry;
-        for (const [id, { viewDefinition }] of this.viewDefinitions.entries()) {
-            const { viewRecord } = viewDefinition;
+        for (const [id, viewDefEntry] of this.viewDefinitions.entries()) {
+            const { viewDefinition: { viewRecord }, } = viewDefEntry;
             const someAssets = viewRecord.assetReferences?.some((ref) => {
                 return ref.override?.entry === assetId;
             });
@@ -180,11 +179,15 @@ export class LwrViewRegistry {
         const pendingViewDefCacheKey = viewDefCacheKey + viewParamKey;
         const viewDefinition = await this.pendingViewDefinitions.execute(pendingViewDefCacheKey, () => 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);
             this.viewDefinitions.set(viewDefCacheKey, {
                 view,
                 viewDefinition,
                 paramKey: viewParamKey,
-            });
+            }, 
+            // s -> ms
+            { ttl: ttl ? ttl * 1000 : undefined });
         }
         return viewDefinition;
     }

package/build/es/view-handler.js

@@ -143,26 +143,26 @@ export class LwrViewHandler {
         if (!route.routeHandler) {
             throw new Error('Route handler is required for a CustomView');
         }
-        const routeHandler = this.routeHandlers[route.routeHandler];
-        if (!routeHandler) {
+        const [routeHandlerFn, routeHandlerOptions] = this.routeHandlers[route.routeHandler[0]];
+        if (!routeHandlerFn) {
             throw new Error(`Route handler does not exist for id: ${route.routeHandler}`);
         }
         const { rootDir, assets, contentDir, layoutsDir } = this.globalConfig;
         const paths = { rootDir, assets, contentDir, layoutsDir };
         const locale = runtimeParams.locale;
-        const viewApi = this.getBoundApi(route, runtimeEnvironment, runtimeParams);
-        const response = await routeHandler({ ...viewRequest, locale }, { route: route, viewApi, ...paths });
+        const viewApi = this.getBoundApi(viewRequest, route, runtimeEnvironment, runtimeParams);
+        const response = await routeHandlerFn({ ...viewRequest, locale }, { route: route, viewApi, ...paths }, routeHandlerOptions);
         return response;
     }
     /*
         The Custom Route Handler accessible APIS are bound to runtime request when provided to a
         Route Handler.
     */
-    getBoundApi(route, runtimeEnvironment, runtimeParams) {
+    getBoundApi(viewRequest, route, runtimeEnvironment, runtimeParams) {
         return {
             // Create a version of renderView() to pass to the route handler, it will:
             //  - handle and protect the runtime environment
-            getViewResponse: this.getViewResponse.bind(this, route, runtimeEnvironment, runtimeParams),
+            getViewResponse: this.getViewResponse.bind(this, viewRequest, route, runtimeEnvironment, runtimeParams),
             hasViewResponse: this.hasViewResponse.bind(this, route, runtimeEnvironment, runtimeParams),
         };
     }
@@ -173,12 +173,18 @@ export class LwrViewHandler {
         const managedView = { ...view, id, bootstrap };
         return this.viewRegistry.hasViewDefinition(managedView, viewParams, runtimeEnvironment, runtimeParams, renderOptions);
     }
-    async getViewResponse(route, runtimeEnvironment, runtimeParams = {}, 
+    async getViewResponse(viewRequest, route, runtimeEnvironment, runtimeParams = {}, 
     // custom route handler managed properties
     view, viewParams, renderOptions) {
         const { id, bootstrap } = route;
         const managedView = { ...view, id, bootstrap };
-        const viewDefinition = await this.viewRegistry.getViewDefinition(managedView, viewParams, runtimeEnvironment, runtimeParams, renderOptions);
+        const viewResponse = {
+            view: managedView,
+            viewParams,
+            renderOptions,
+        };
+        const { view: normalizedView, viewParams: normalizedViewParams, renderOptions: normalizedRenderOptions, } = normalizeViewProperties(viewRequest, viewResponse, route, this.globalConfig);
+        const viewDefinition = await this.viewRegistry.getViewDefinition(normalizedView, normalizedViewParams, runtimeEnvironment, runtimeParams, normalizedRenderOptions);
         return {
             body: viewDefinition.renderedView,
             metadata: {

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.10.0-alpha.15",
+    "version": "0.10.0-alpha.16",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -30,15 +30,16 @@
         "build/**/*.d.ts"
     ],
     "dependencies": {
-        "@lwrjs/app-service": "0.10.0-alpha.15",
-        "@lwrjs/diagnostics": "0.10.0-alpha.15",
-        "@lwrjs/shared-utils": "0.10.0-alpha.15"
+        "@lwrjs/app-service": "0.10.0-alpha.16",
+        "@lwrjs/diagnostics": "0.10.0-alpha.16",
+        "@lwrjs/shared-utils": "0.10.0-alpha.16",
+        "lru-cache": "9.1.2"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.10.0-alpha.15"
+        "@lwrjs/types": "0.10.0-alpha.16"
     },
     "engines": {
         "node": ">=16.0.0 <20"
     },
-    "gitHead": "70557f63a46167c40cf1415f12af69f78ae402d6"
+    "gitHead": "c5a13d471330c0f738d0c783fd1b69f456c544bd"
 }