@lwrjs/view-registry 0.12.0-alpha.0 → 0.12.0-alpha.2

package/build/cjs/index.cjs

@@ -32,6 +32,7 @@ var import_instrumentation = __toModule(require("@lwrjs/instrumentation"));
 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_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var import_view_handler = __toModule(require("./view-handler.cjs"));
 var LwrViewRegistry = class {
   constructor(context, globalConfig) {
@@ -130,6 +131,7 @@ var LwrViewRegistry = class {
   async getView(viewId, skipCaching = false) {
     const {contentTemplate, rootComponent} = viewId;
     const compiledViewCacheKey = (0, import_shared_utils.getCacheKeyFromJson)({contentTemplate, rootComponent});
+    import_diagnostics.logger.debug(`[view-registry][getView] compiledViewCacheKey=${compiledViewCacheKey}`);
     if (!skipCaching && this.compiledViews.has(compiledViewCacheKey)) {
       return this.compiledViews.get(compiledViewCacheKey);
     }
@@ -153,7 +155,9 @@ var LwrViewRegistry = class {
       basePath: runtimeParams?.basePath,
       debug: runtimeEnvironment.debug
     });
+    import_diagnostics.logger.debug(`[view-registry][hasViewDefinition] viewDefId=${viewDefId}`);
     const viewParamKey = viewParamCacheKey ? (0, import_shared_utils.getCacheKeyFromJson)(viewParamCacheKey) : (0, import_shared_utils.getCacheKeyFromJson)(viewParams);
+    import_diagnostics.logger.debug(`[view-registry][hasViewDefinition] viewParamKey=${viewParamKey}`);
     if (this.viewDefinitions.has(viewDefId)) {
       const viewDef = this.viewDefinitions.get(viewDefId);
       if (viewDef && viewDef.paramKey === viewParamKey) {
@@ -171,7 +175,9 @@ var LwrViewRegistry = class {
       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);

package/build/cjs/linkers/legacy_view_bootstrap.cjs

@@ -101,11 +101,17 @@ async function getHtmlResources(view, viewParams, resourceContext) {
           throw Error("Failed to find definition of resource: " + shimBundle);
         }
       }
+      if (!def.inline && !def.src) {
+        throw Error(`Invalid Shim ${shimBundle}: ${JSON.stringify(def)}`);
+      }
       requiredResources.push(def);
       const errorShimDef = await resourceRegistry.getResource({specifier: "lwr-error-shim.js", version}, runtimeEnvironment, runtimeParams);
       if (!errorShimDef) {
         throw Error("Failed to find definition of resource: lwr-error-shim.js");
       }
+      if (!errorShimDef.inline && !errorShimDef.src) {
+        throw Error(`Invalid Shim lwr-error-shim.js: ${JSON.stringify(errorShimDef)}`);
+      }
       requiredResources.push(errorShimDef);
     }
     const bootstrapModuleGraph = await (0, import_shared_utils.getModuleGraphs)(bootstrapSpecifier, {includeUris: true, includeLinkedDefinitions: true, depth}, moduleRegistry, defRegistry, runtimeEnvironment, runtimeParams, visitedCache);
@@ -116,6 +122,9 @@ async function getHtmlResources(view, viewParams, resourceContext) {
     };
     versionedSpecifier = bootstrapModuleGraph.graphs[0].specifier;
     const uri = bootstrapModuleGraph.uriMap[versionedSpecifier];
+    if (!uri) {
+      throw Error(`Invalid Module Resource ${versionedSpecifier}`);
+    }
     moduleResources.push((0, import_utils.getModuleResourceByUri)(uri, runtimeEnvironment, {isPreload: false, isSSR}));
     for (const depSpecifier of bootstrapModuleGraph.graphs[0].static) {
       if (!isExternal(depSpecifier)) {

package/build/cjs/linkers/preload-utils.cjs

@@ -30,6 +30,9 @@ __export(exports, {
 var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
 function setPreloadModulesMeta(specifier, uri, groups, preloads) {
+  if (!uri) {
+    throw Error(`Invalid Preload Module ${specifier}`);
+  }
   const [removedVersion, version] = specifier.split("/v/");
   const normalizedSpecifier = version === import_shared_utils.VERSION_NOT_PROVIDED ? removedVersion : specifier;
   specifier = normalizedSpecifier;

package/build/cjs/linkers/utils.cjs

@@ -64,7 +64,7 @@ function getViewBootstrapConfigurationResource(viewInfo, config, runtimeEnvironm
   ].filter(Boolean).join("\n");
   if (viewInfo.configAsSrc) {
     const viewUrl = viewInfo.url || "/";
-    const url = (0, import_shared_utils.getClientBootstrapConfigurationUri)({id: viewInfo.id, url: viewUrl}, runtimeEnvironment, runtimeParams, (0, import_shared_utils.hashContent)(configString));
+    const url = (0, import_shared_utils.getClientBootstrapConfigurationUri)({id: viewInfo.id, url: viewUrl, query: runtimeParams.query}, runtimeEnvironment, runtimeParams, (0, import_shared_utils.hashContent)(configString));
     return {
       type: CONTENT_TYPE,
       content: configString,

package/build/cjs/linkers/view_bootstrap.cjs

@@ -92,11 +92,17 @@ async function getHtmlResources(view, viewParams, resourceContext) {
       if (!def) {
         throw Error("Failed to find definition of resource: " + shimBundle);
       }
+      if (!def.inline && !def.src) {
+        throw Error(`Invalid Shim ${shimBundle}: ${JSON.stringify(def)}`);
+      }
       requiredResources.push(def);
       const errorShimDef = await resourceRegistry.getResource({specifier: "lwr-error-shim.js", version}, runtimeEnvironment, runtimeParams);
       if (!errorShimDef) {
         throw Error("Failed to find definition of resource: lwr-error-shim.js");
       }
+      if (!errorShimDef.inline && !errorShimDef.src) {
+        throw Error(`Invalid Shim lwr-error-shim.js: ${JSON.stringify(errorShimDef)}`);
+      }
       requiredResources.push(errorShimDef);
     }
     const bootstrapModuleGraph = await (0, import_shared_utils.getModuleGraphs)(bootstrapSpecifier, {includeUris: true, includeLinkedDefinitions: true, depth}, moduleRegistry, defRegistry, runtimeEnvironment, runtimeParams, visitedCache);
@@ -107,6 +113,9 @@ async function getHtmlResources(view, viewParams, resourceContext) {
     };
     versionedSpecifier = bootstrapModuleGraph.graphs[0].specifier;
     const uri = bootstrapModuleGraph.uriMap[versionedSpecifier];
+    if (!uri) {
+      throw Error(`Invalid Module Resource ${versionedSpecifier}`);
+    }
     moduleResources.push((0, import_utils.getModuleResourceByUri)(uri, runtimeEnvironment, {isPreload: false, isSSR}));
     for (const depSpecifier of bootstrapModuleGraph.graphs[0].static) {
       if (!isExternal(depSpecifier)) {

package/build/cjs/utils.cjs

@@ -165,7 +165,7 @@ async function toJsonFormat(viewRequest, viewDefinition, route, runtimeEnvironme
     });
     resources.push({
       type: "application/javascript",
-      src: (0, import_shared_utils.getClientBootstrapConfigurationUri)({url: viewRequest.url, id: route.id}, runtimeEnvironment, runtimeParams)
+      src: (0, import_shared_utils.getClientBootstrapConfigurationUri)({url: viewRequest.url, id: route.id, query: viewRequest.query}, runtimeEnvironment, runtimeParams)
     });
   }
   const mappingUrl = (0, import_shared_utils.getMappingUriPrefix)(runtimeEnvironment, runtimeParams);

package/build/es/index.js

@@ -3,6 +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';
 export { LwrViewHandler } from './view-handler.js';
 export class LwrViewRegistry {
     constructor(context, globalConfig) {
@@ -114,6 +115,7 @@ export class LwrViewRegistry {
     async getView(viewId, skipCaching = false) {
         const { contentTemplate, rootComponent } = viewId;
         const compiledViewCacheKey = getCacheKeyFromJson({ contentTemplate, rootComponent });
+        logger.debug(`[view-registry][getView] compiledViewCacheKey=${compiledViewCacheKey}`);
         // use cached compiledView if available
         if (!skipCaching && this.compiledViews.has(compiledViewCacheKey)) {
             return this.compiledViews.get(compiledViewCacheKey);
@@ -139,12 +141,14 @@ export class LwrViewRegistry {
             basePath: runtimeParams?.basePath,
             debug: runtimeEnvironment.debug,
         });
+        logger.debug(`[view-registry][hasViewDefinition] viewDefId=${viewDefId}`);
         // viewParams is an unbounded object and can be very large (17MB/view for developer.salesforce.com). Allowing conusmers
         // 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][hasViewDefinition] viewParamKey=${viewParamKey}`);
         // important: cache key does not include the unbounded viewParams
         if (this.viewDefinitions.has(viewDefId)) {
             const viewDef = this.viewDefinitions.get(viewDefId);
@@ -163,12 +167,14 @@ export class LwrViewRegistry {
             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)) {

package/build/es/linkers/legacy_view_bootstrap.js

@@ -94,12 +94,20 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
                     throw Error('Failed to find definition of resource: ' + shimBundle);
                 }
             }
+            // Throw a very specific error if we get this back and the src or inline properties are not set
+            if (!def.inline && !def.src) {
+                throw Error(`Invalid Shim ${shimBundle}: ${JSON.stringify(def)}`);
+            }
             requiredResources.push(def);
             // Always inline the error shim script after the shim
             const errorShimDef = (await resourceRegistry.getResource({ specifier: 'lwr-error-shim.js', version }, runtimeEnvironment, runtimeParams));
             if (!errorShimDef) {
                 throw Error('Failed to find definition of resource: lwr-error-shim.js');
             }
+            // Throw a very specific error if we get this back and the src or inline properties are not set
+            if (!errorShimDef.inline && !errorShimDef.src) {
+                throw Error(`Invalid Shim lwr-error-shim.js: ${JSON.stringify(errorShimDef)}`);
+            }
             requiredResources.push(errorShimDef);
         }
         // ------- Application Bootstrap module
@@ -115,6 +123,10 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
         // ADD bootstrap module uri as a script resource
         versionedSpecifier = bootstrapModuleGraph.graphs[0].specifier;
         const uri = bootstrapModuleGraph.uriMap[versionedSpecifier];
+        // Throw a very specific error if we get this back and the uri property is not set
+        if (!uri) {
+            throw Error(`Invalid Module Resource ${versionedSpecifier}`);
+        }
         moduleResources.push(getModuleResourceByUri(uri, runtimeEnvironment, { isPreload: false, isSSR }));
         // PRELOAD the bootstrap module static dependencies as preloaded script resources
         for (const depSpecifier of bootstrapModuleGraph.graphs[0].static) {

package/build/es/linkers/preload-utils.js

@@ -4,6 +4,10 @@ import { explodeSpecifier, getGroupName, getVersionedModuleId, normalizeVersionT
  * keeps track of preloadModules metadata
  */
 export function setPreloadModulesMeta(specifier, uri, groups, preloads) {
+    // Throw a very specific error if we get this back and the uri property is not set
+    if (!uri) {
+        throw Error(`Invalid Preload Module ${specifier}`);
+    }
     // We need to support version-less preloadModules, including version-less rootComponents.
     // Removing the "/v/version_not_provided" hack from the preloadModules specifier
     // because otherwise the loader will wait for that module that will never get defined.

package/build/es/linkers/utils.js

@@ -41,7 +41,7 @@ export function getViewBootstrapConfigurationResource(viewInfo, config, runtimeE
         .join('\n');
     if (viewInfo.configAsSrc) {
         const viewUrl = viewInfo.url || '/';
-        const url = getClientBootstrapConfigurationUri({ id: viewInfo.id, url: viewUrl }, runtimeEnvironment, runtimeParams, hashContent(configString));
+        const url = getClientBootstrapConfigurationUri({ id: viewInfo.id, url: viewUrl, query: runtimeParams.query }, runtimeEnvironment, runtimeParams, hashContent(configString));
         return {
             type: CONTENT_TYPE,
             content: configString,

package/build/es/linkers/view_bootstrap.js

@@ -79,12 +79,20 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
             if (!def) {
                 throw Error('Failed to find definition of resource: ' + shimBundle);
             }
+            // Throw a very specific error if we get this back and the src or inline properties are not set
+            if (!def.inline && !def.src) {
+                throw Error(`Invalid Shim ${shimBundle}: ${JSON.stringify(def)}`);
+            }
             requiredResources.push(def);
             // Always inline the error shim script after the shim
             const errorShimDef = (await resourceRegistry.getResource({ specifier: 'lwr-error-shim.js', version }, runtimeEnvironment, runtimeParams));
             if (!errorShimDef) {
                 throw Error('Failed to find definition of resource: lwr-error-shim.js');
             }
+            // Throw a very specific error if we get this back and the src or inline properties are not set
+            if (!errorShimDef.inline && !errorShimDef.src) {
+                throw Error(`Invalid Shim lwr-error-shim.js: ${JSON.stringify(errorShimDef)}`);
+            }
             requiredResources.push(errorShimDef);
         }
         // ------- Application Bootstrap module
@@ -99,6 +107,10 @@ export async function getHtmlResources(view, viewParams, resourceContext) {
         // ADD bootstrap module uri as a script resource
         versionedSpecifier = bootstrapModuleGraph.graphs[0].specifier;
         const uri = bootstrapModuleGraph.uriMap[versionedSpecifier];
+        // Throw a very specific error if we get this back and the uri property is not set
+        if (!uri) {
+            throw Error(`Invalid Module Resource ${versionedSpecifier}`);
+        }
         moduleResources.push(getModuleResourceByUri(uri, runtimeEnvironment, { isPreload: false, isSSR }));
         // PRELOAD the bootstrap module static dependencies as preloaded script resources
         for (const depSpecifier of bootstrapModuleGraph.graphs[0].static) {

package/build/es/utils.js

@@ -140,7 +140,7 @@ export async function toJsonFormat(viewRequest, viewDefinition, route, runtimeEn
         // If bootstrapGraph exists exposes its resources via configuration URL
         resources.push({
             type: 'application/javascript',
-            src: getClientBootstrapConfigurationUri({ url: viewRequest.url, id: route.id }, runtimeEnvironment, runtimeParams),
+            src: getClientBootstrapConfigurationUri({ url: viewRequest.url, id: route.id, query: viewRequest.query }, runtimeEnvironment, runtimeParams),
         });
     }
     const mappingUrl = getMappingUriPrefix(runtimeEnvironment, runtimeParams);

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.12.0-alpha.0",
+    "version": "0.12.0-alpha.2",
     "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.0",
-        "@lwrjs/diagnostics": "0.12.0-alpha.0",
-        "@lwrjs/instrumentation": "0.12.0-alpha.0",
-        "@lwrjs/shared-utils": "0.12.0-alpha.0",
+        "@lwrjs/app-service": "0.12.0-alpha.2",
+        "@lwrjs/diagnostics": "0.12.0-alpha.2",
+        "@lwrjs/instrumentation": "0.12.0-alpha.2",
+        "@lwrjs/shared-utils": "0.12.0-alpha.2",
         "lru-cache": "^10.0.0"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.12.0-alpha.0"
+        "@lwrjs/types": "0.12.0-alpha.2"
     },
     "engines": {
-        "node": ">=16.0.0"
+        "node": ">=18.0.0"
     },
-    "gitHead": "e79862bc238ededc3cf61f0d2c7d8120d1105a6b"
+    "gitHead": "586a2aa659882483af9249dc3db7fe07bc842a25"
 }