@lwrjs/static 0.17.2-alpha.9 → 0.18.0

package/build/cjs/providers/static-bundle-provider.cjs

@@ -60,26 +60,45 @@ var StaticBundleProvider = class {
     }
   }
   async bundle(moduleId, runtimeEnvironment, runtimeParams) {
-    const {specifier, name, namespace, version} = moduleId;
+    const {specifier, version} = moduleId;
     const {
-      debug,
       i18n: {defaultLocale}
     } = runtimeEnvironment;
     const localeId = runtimeParams?.locale || defaultLocale;
     const ssr = runtimeParams?.ssr;
-    const metadata = this.getBundleMetadata({moduleId, localeId, debug, ssr});
+    let debug = runtimeEnvironment.debug;
+    let metadata = this.getBundleMetadata({moduleId, localeId, debug, ssr});
+    if (!metadata && debug) {
+      metadata = this.getBundleMetadata({moduleId, localeId, debug: false, ssr});
+      if (metadata)
+        debug = false;
+    }
+    if (!metadata && (0, import_shared_utils.isExternalSpecifier)(moduleId.specifier, this.bundleConfig)) {
+      const {specifier: unversionedSepcifier} = (0, import_shared_utils.explodeSpecifier)(moduleId.specifier);
+      metadata = {
+        path: this.bundleConfig?.external?.[unversionedSepcifier],
+        imports: [],
+        dynamicImports: [],
+        version: moduleId.version
+      };
+      return this.createBundleDefinition(moduleId, metadata, localeId, debug, ssr, async () => "", (0, import_shared_utils.normalizeFromFileURL)(metadata.path, this.siteRootDir) ?? metadata.path);
+    }
     if (!metadata) {
+      this.logBundleError(moduleId, localeId, debug, ssr);
       return void 0;
     }
     const bundlePath = import_path.default.join(this.siteRootDir, metadata.path);
-    const resolvedBundlePath = this.getCodePath(bundlePath, debug, specifier, version, localeId, ssr);
-    const codePromiser = this.getCodePromiser(resolvedBundlePath, {
+    const codePromiser = this.getCodePromiser(bundlePath, {
       specifier,
       version,
       locale: localeId,
       ssr,
       debug
     });
+    return this.createBundleDefinition(moduleId, metadata, localeId, debug, ssr, codePromiser, bundlePath);
+  }
+  async createBundleDefinition(moduleId, metadata, localeId, debug, ssr, codePromiser, bundlePath) {
+    const {specifier, name, namespace, version} = moduleId;
     const imports = metadata.imports.map((importSpecifier) => this.getModuleReference(importSpecifier, localeId, debug, false));
     const dynamicImports = metadata.dynamicImports?.map((importSpecifier) => this.getModuleReference(importSpecifier, localeId, debug, false));
     const id = (0, import_shared_utils.getSpecifier)(moduleId);
@@ -179,26 +198,29 @@ var StaticBundleProvider = class {
       return code;
     };
   }
-  getCodePath(bundlePath, debug, specifier, version, localeId, ssr) {
-    const isLambda = (0, import_shared_utils.isLambdaEnv)();
-    let bundleSourcePath = bundlePath;
-    if (debug && isLambda) {
-      const metadata = this.getBundleMetadata({
-        moduleId: {specifier, version},
+  logBundleError(moduleId, localeId, debug, ssr) {
+    const moduleSpecifier = moduleId.namespace ? `${moduleId.namespace}/${moduleId.name}` : moduleId.name;
+    const siteBundleId = (0, import_site_metadata.getSiteBundleId)(moduleId, localeId, ssr, this.i18n);
+    const siteBundles = this.siteMetadata.getSiteBundles()?.bundles || {};
+    const siteDebugBundles = this.siteMetadata.getDebugSiteBundles()?.bundles || {};
+    const runtimeBundles = Object.keys(siteBundles).filter((key) => key.startsWith(moduleSpecifier));
+    const debugBundles = Object.keys(siteDebugBundles).filter((key) => key.startsWith(moduleSpecifier));
+    import_diagnostics.logger.error({
+      message: JSON.stringify({
+        message: "Failed to find static bundle",
+        moduleId,
         localeId,
-        debug: false,
-        ssr
-      });
-      if (!metadata) {
-        import_diagnostics.logger.error({
-          label: "static-bundle-provider",
-          message: `Unexpected code reference: ${specifier}`
-        });
-        return BUNDLE_SOURCE_NOT_FOUND;
-      }
-      bundleSourcePath = import_path.default.join(this.siteRootDir, metadata.path);
-    }
-    return bundleSourcePath;
+        debug,
+        ssr,
+        moduleSpecifier,
+        siteBundleId,
+        debugBundles,
+        runtimeBundles,
+        totalBundlesCount: Object.keys(siteBundles).length,
+        totalDebugBundlesCount: Object.keys(siteDebugBundles).length
+      }),
+      label: "static-bundle-provider"
+    });
   }
 };
 var static_bundle_provider_default = StaticBundleProvider;

package/build/cjs/transformers/mrt-static-uri-transformer.cjs

@@ -43,7 +43,7 @@ function mrtStaticUriTransformer() {
         };
       }
       let basePathlessUri = uriDef.uri;
-      if (runtimeEnvironment?.basePath) {
+      if (runtimeEnvironment?.basePath && uriDef.uri.startsWith(runtimeEnvironment?.basePath)) {
         basePathlessUri = uriDef.uri.replace(runtimeEnvironment?.basePath, "");
       }
       const uri = (0, import_shared_utils.getMrtArtifactUrl)(runtimeEnvironment?.basePath || "", basePathlessUri);

package/build/es/providers/static-asset-provider.js

@@ -3,8 +3,13 @@ import { hashContent, mimeLookup, normalizeResourcePath } from '@lwrjs/shared-ut
 import path from 'path';
 import fs from 'fs-extra';
 export default class StaticAssetProvider {
+    name = 'static-asset-provider';
+    siteAssets;
+    resourcePaths;
+    siteRootDir;
+    basePath;
+    assetsOnLambda;
     constructor(_config, context) {
-        this.name = 'static-asset-provider';
         if (!context.siteMetadata) {
             throw new Error(`[${this.name}] Site metadata was not found`);
         }

package/build/es/providers/static-bundle-provider.d.ts

@@ -12,6 +12,7 @@ export default class StaticBundleProvider implements BundleProvider {
         bundleCacheSize?: number;
     }, context: ProviderContext);
     bundle<BundleIdentifier extends AbstractModuleId, RE extends RuntimeEnvironment>(moduleId: BundleIdentifier, runtimeEnvironment: RE, runtimeParams: RuntimeParams): Promise<BundleDefinition | undefined>;
+    private createBundleDefinition;
     getBundleMetadata({ moduleId, localeId, debug, ssr, }: {
         moduleId: Partial<AbstractModuleId>;
         localeId: string;
@@ -30,16 +31,17 @@ export default class StaticBundleProvider implements BundleProvider {
         debug: boolean;
     }): () => Promise<string>;
     /**
-     * Get the local source code path for the a static bundle
-     * If we are running in a lambda and the mode is debug we will return the prod source code instead of the debug source code
+     * Logs an error when a bundle fails to load and provides debugging metadata.
      *
-     * @param bundlePath The default path for the bundle for prod read from .metadata/bundle-metadata.json, for debug .metadata/bundle-metadata-debug.json
-     * @param debug Is the request in debug mode?
-     * @param specifier Root specifier for the requested bundle
-     * @param version Root specifier version
-     * @param localeId Locale id (e.g. en-US) for the current request
-     * @param ssr True if this is a server bundle
+     * This function logs details about the failed bundle load attempt, including the module ID,
+     * locale, debug mode, and SSR status. It also attempts to retrieve additional metadata
+     * about the site bundles and debug bundles associated with the module.
+     *
+     * @param {Partial<AbstractModuleId>} moduleId - The module identifier, which may include a namespace and name.
+     * @param {string} localeId - The locale associated with the bundle.
+     * @param {boolean} debug - Indicates whether debug mode is enabled.
+     * @param {boolean} ssr - Indicates whether the bundle is for server-side rendering (SSR).
      */
-    getCodePath(bundlePath: string, debug: boolean, specifier: string, version: string | undefined, localeId: string, ssr: boolean): string;
+    logBundleError(moduleId: Partial<AbstractModuleId>, localeId: string, debug: boolean, ssr: boolean): void;
 }
 //# sourceMappingURL=static-bundle-provider.d.ts.map

package/build/es/providers/static-bundle-provider.js

@@ -1,5 +1,5 @@
 import { logger } from '@lwrjs/diagnostics';
-import { VERSION_SIGIL, explodeSpecifier, getSpecifier, isLambdaEnv } from '@lwrjs/shared-utils';
+import { VERSION_SIGIL, explodeSpecifier, getSpecifier, isExternalSpecifier, isLambdaEnv, normalizeFromFileURL, } from '@lwrjs/shared-utils';
 import path from 'path';
 import fs from 'fs-extra';
 import { LRUCache } from 'lru-cache';
@@ -8,8 +8,14 @@ import { cacheCountStore } from '@lwrjs/instrumentation';
 import { getTracer, BundleSpan } from '@lwrjs/instrumentation';
 const BUNDLE_SOURCE_NOT_FOUND = 'Bundle Source Path Not Found';
 export default class StaticBundleProvider {
+    name = 'static-bundle-provider';
+    codeCache;
+    siteRootDir;
+    bundleConfig;
+    i18n;
+    siteMetadata;
+    bundleCacheSize;
     constructor(config, context) {
-        this.name = 'static-bundle-provider';
         if (!context.siteMetadata) {
             throw new Error(`[${this.name}] Site metadata was not found`);
         }
@@ -34,25 +40,48 @@ export default class StaticBundleProvider {
         }
     }
     async bundle(moduleId, runtimeEnvironment, runtimeParams) {
-        const { specifier, name, namespace, version } = moduleId;
-        const { debug, i18n: { defaultLocale }, } = runtimeEnvironment;
+        const { specifier, version } = moduleId;
+        const { i18n: { defaultLocale }, } = runtimeEnvironment;
         const localeId = (runtimeParams?.locale || defaultLocale);
         const ssr = runtimeParams?.ssr;
-        const metadata = this.getBundleMetadata({ moduleId, localeId, debug, ssr });
+        let debug = runtimeEnvironment.debug;
+        let metadata = this.getBundleMetadata({ moduleId, localeId, debug, ssr });
+        if (!metadata && debug) {
+            // Fallback to use prod bundles if the debug variant does not exist
+            // eg: debug bundles are not shipped to the Lambda
+            // eg: locally, an MRT bundle may or may not have debug metadata, depending on how it's generated
+            metadata = this.getBundleMetadata({ moduleId, localeId, debug: false, ssr });
+            if (metadata)
+                debug = false;
+        }
+        if (!metadata && isExternalSpecifier(moduleId.specifier, this.bundleConfig)) {
+            const { specifier: unversionedSepcifier } = explodeSpecifier(moduleId.specifier);
+            metadata = {
+                path: this.bundleConfig?.external?.[unversionedSepcifier],
+                imports: [],
+                dynamicImports: [],
+                version: moduleId.version,
+            };
+            return this.createBundleDefinition(moduleId, metadata, localeId, debug, ssr, async () => '', normalizeFromFileURL(metadata.path, this.siteRootDir) ?? metadata.path);
+        }
         if (!metadata) {
+            this.logBundleError(moduleId, localeId, debug, ssr);
             return undefined;
         }
         // Default bundle source path
         const bundlePath = path.join(this.siteRootDir, metadata.path);
         // Get the associated bundle source code
-        const resolvedBundlePath = this.getCodePath(bundlePath, debug, specifier, version, localeId, ssr);
-        const codePromiser = this.getCodePromiser(resolvedBundlePath, {
+        const codePromiser = this.getCodePromiser(bundlePath, {
             specifier,
             version,
             locale: localeId,
             ssr,
             debug,
         });
+        return this.createBundleDefinition(moduleId, metadata, localeId, debug, ssr, codePromiser, bundlePath);
+    }
+    async createBundleDefinition(moduleId, metadata, localeId, debug, ssr, codePromiser, bundlePath) {
+        const { specifier, name, namespace, version } = moduleId;
         const imports = metadata.imports.map((importSpecifier) => this.getModuleReference(importSpecifier, localeId, debug, false));
         const dynamicImports = metadata.dynamicImports?.map((importSpecifier) => this.getModuleReference(importSpecifier, localeId, debug, false));
         const id = getSpecifier(moduleId);
@@ -155,42 +184,44 @@ export default class StaticBundleProvider {
         };
     }
     /**
-     * Get the local source code path for the a static bundle
-     * If we are running in a lambda and the mode is debug we will return the prod source code instead of the debug source code
+     * Logs an error when a bundle fails to load and provides debugging metadata.
+     *
+     * This function logs details about the failed bundle load attempt, including the module ID,
+     * locale, debug mode, and SSR status. It also attempts to retrieve additional metadata
+     * about the site bundles and debug bundles associated with the module.
      *
-     * @param bundlePath The default path for the bundle for prod read from .metadata/bundle-metadata.json, for debug .metadata/bundle-metadata-debug.json
-     * @param debug Is the request in debug mode?
-     * @param specifier Root specifier for the requested bundle
-     * @param version Root specifier version
-     * @param localeId Locale id (e.g. en-US) for the current request
-     * @param ssr True if this is a server bundle
+     * @param {Partial<AbstractModuleId>} moduleId - The module identifier, which may include a namespace and name.
+     * @param {string} localeId - The locale associated with the bundle.
+     * @param {boolean} debug - Indicates whether debug mode is enabled.
+     * @param {boolean} ssr - Indicates whether the bundle is for server-side rendering (SSR).
      */
-    getCodePath(bundlePath, debug, specifier, version, localeId, ssr) {
-        // Flag is used to indicate that we are running on a lambda
-        const isLambda = isLambdaEnv();
-        // Default source code path determined from metadata based on debug mode
-        let bundleSourcePath = bundlePath;
-        // This is the special case where the request is in debug mode and we are on the lambda
-        // So we will look up the prod source code instead of the debug source code
-        if (debug && isLambda) {
-            const metadata = this.getBundleMetadata({
-                moduleId: { specifier, version },
+    logBundleError(moduleId, localeId, debug, ssr) {
+        const moduleSpecifier = moduleId.namespace
+            ? `${moduleId.namespace}/${moduleId.name}`
+            : moduleId.name;
+        const siteBundleId = getSiteBundleId(moduleId, localeId, ssr, this.i18n);
+        // Retrieve site bundles and debug bundles
+        const siteBundles = this.siteMetadata.getSiteBundles()?.bundles || {};
+        const siteDebugBundles = this.siteMetadata.getDebugSiteBundles()?.bundles || {};
+        // Extract keys and filter bundles by module specifier
+        const runtimeBundles = Object.keys(siteBundles).filter((key) => key.startsWith(moduleSpecifier));
+        const debugBundles = Object.keys(siteDebugBundles).filter((key) => key.startsWith(moduleSpecifier));
+        logger.error({
+            message: JSON.stringify({
+                message: 'Failed to find static bundle',
+                moduleId,
                 localeId,
-                debug: false,
+                debug,
                 ssr,
-            });
-            if (!metadata) {
-                // We did not find the bundle prod bundle even though we did find it in the debug metadata before
-                logger.error({
-                    label: 'static-bundle-provider',
-                    message: `Unexpected code reference: ${specifier}`,
-                });
-                return BUNDLE_SOURCE_NOT_FOUND;
-            }
-            // Overwrite the default source code path the prod source code path
-            bundleSourcePath = path.join(this.siteRootDir, metadata.path);
-        }
-        return bundleSourcePath;
+                moduleSpecifier,
+                siteBundleId,
+                debugBundles,
+                runtimeBundles,
+                totalBundlesCount: Object.keys(siteBundles).length,
+                totalDebugBundlesCount: Object.keys(siteDebugBundles).length,
+            }),
+            label: 'static-bundle-provider',
+        });
     }
 }
 //# sourceMappingURL=static-bundle-provider.js.map

package/build/es/providers/static-module-provider.js

@@ -3,8 +3,13 @@ import { VERSION_SIGIL, explodeSpecifier, getSpecifier, isLambdaEnv } from '@lwr
 import path from 'path';
 import { getSiteBundleId, parseSiteId, resolveStaticBundleVersion } from '../site-metadata.js';
 export default class StaticModuleProvider {
+    name = 'static-module-provider';
+    siteRootDir;
+    externals;
+    fingerprintIndex;
+    i18n;
+    siteMetadata;
     constructor(_config, context) {
-        this.name = 'static-module-provider';
         if (!context.siteMetadata) {
             throw new Error(`[${this.name}] Site metadata was not found`);
         }

package/build/es/providers/static-resource-provider.js

@@ -4,8 +4,11 @@ import path from 'path';
 import fs from 'fs-extra';
 import { getSiteResourceId } from '../site-metadata.js';
 export default class StaticResourceProvider {
+    name = 'static-resource-provider';
+    siteRootDir;
+    siteMetadata;
+    resourceRegistry;
     constructor(_config, context) {
-        this.name = 'static-resource-provider';
         if (!context.siteMetadata) {
             throw new Error(`[${this.name}] Site metadata was not found`);
         }

package/build/es/site-metadata.js

@@ -13,6 +13,14 @@ export const SITE_VERSION_PREFIX = `|${VERSION_SIGIL}/`;
 export const SITE_LOCALE_PREFIX = `|${LOCALE_SIGIL}/`;
 export const SITE_SSR_PREFIX = `|${SSR_SIGIL}`;
 export class SiteMetadataImpl {
+    options;
+    siteBundles;
+    debugSiteBundles;
+    siteResources;
+    debugSiteResources;
+    siteAssets;
+    bundleDecisionTree;
+    resourceDecisionTree;
     constructor(options) {
         this.options = options;
         this.siteBundles = this.readStaticBundleMetadata(options.rootDir, STATIC_BUNDLE_METADATA_PATH);

package/build/es/transformers/mrt-static-uri-transformer.js

@@ -20,7 +20,7 @@ export default function mrtStaticUriTransformer() {
             }
             // Remove the basePath from the uri
             let basePathlessUri = uriDef.uri;
-            if (runtimeEnvironment?.basePath) {
+            if (runtimeEnvironment?.basePath && uriDef.uri.startsWith(runtimeEnvironment?.basePath)) {
                 basePathlessUri = uriDef.uri.replace(runtimeEnvironment?.basePath, '');
             }
             const uri = getMrtArtifactUrl(runtimeEnvironment?.basePath || '', basePathlessUri);

package/build/es/utils/decision-tree.js

@@ -33,9 +33,7 @@ const CHOICE_PROD = 'prod';
 const CHOICE_DEBUG = 'debug';
 // Tree of decisions to lead you to the right artifact
 export default class DecisionTreeImpl {
-    constructor() {
-        this.root = new TreeNode(); // Root node does not hold any decision value
-    }
+    root = new TreeNode(); // Root node does not hold any decision value
     // Insert an artifact into the tree based on a path of decisions
     insert(siteArtifactId, artifact, debug, localeFallbacks) {
         // The decision path is the set of choices needed to get to the right metadata
@@ -179,9 +177,12 @@ export default class DecisionTreeImpl {
  * It maintains the rank of all choices at this node, allowing a later node with a higher rank to replace the current one as the best option.
  */
 class TreeNode {
+    decisionValue; // The decision value at this node (version ['1_0' or WILDCARD etc], localeId ['en-MX' or WILDCARD etc], etc.)
+    children = new Map(); // Maps a decision key to the next TreeNode
+    artifact = undefined; // Final artifact at a leaf node
+    parentPath; // parent path  (i.e. foo/bar|DEBUG|1_0|WILD_CARD) just used for debugging
+    rank; // choice rank to prioritize lower ranked choices
     constructor(value = '', parentPath = '') {
-        this.children = new Map(); // Maps a decision key to the next TreeNode
-        this.artifact = undefined; // Final artifact at a leaf node
         this.decisionValue = value;
         this.parentPath = parentPath;
     }

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.17.2-alpha.9",
+    "version": "0.18.0",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -56,25 +56,25 @@
         "build/**/*.d.ts"
     ],
     "dependencies": {
-        "@lwrjs/diagnostics": "0.17.2-alpha.9",
-        "@lwrjs/instrumentation": "0.17.2-alpha.9",
-        "@lwrjs/shared-utils": "0.17.2-alpha.9",
+        "@lwrjs/diagnostics": "0.18.0",
+        "@lwrjs/instrumentation": "0.18.0",
+        "@lwrjs/shared-utils": "0.18.0",
         "lru-cache": "^10.4.3"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.17.2-alpha.9",
+        "@lwrjs/types": "0.18.0",
         "@types/express": "^4.17.21",
-        "jest": "^26.6.3",
+        "jest": "29.7.0",
         "jest-express": "^1.12.0",
         "memfs": "^4.13.0",
         "mock-res": "^0.6.0",
-        "ts-jest": "^26.5.6"
+        "ts-jest": "^29.2.6"
     },
     "engines": {
-        "node": ">=18.0.0"
+        "node": ">=20.0.0"
     },
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "7ede5d04a97513b9869b13e66155bc4f3920bb99"
+    "gitHead": "763c7c558ea75fe34a91162c9793de63e55f1d2f"
 }