@lwrjs/core 0.15.0-alpha.33 → 0.15.0-alpha.35

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

@@ -27,6 +27,7 @@ __export(exports, {
   viewMiddleware: () => viewMiddleware
 });
 var import_util = __toModule(require("util"));
+var import_url = __toModule(require("url"));
 var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var import_router = __toModule(require("@lwrjs/router"));
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
@@ -160,7 +161,7 @@ function createConfigMiddleware(routes, context, viewHandler) {
     const query = {};
     if (url.indexOf("?") !== -1) {
       requestPath = url.substring(0, url.indexOf("?"));
-      const searchParams = new URLSearchParams(url.substring(url.indexOf("?")));
+      const searchParams = new import_url.URLSearchParams(url.substring(url.indexOf("?")));
       for (const [key, value] of searchParams.entries()) {
         query[key] = value;
       }
@@ -236,16 +237,30 @@ function viewMiddleware(app, context) {
 }
 function addDefaultLocaleRedirects(defaultLocale, defaultLocalePaths, defaultRedirectParams, app) {
   import_diagnostics.logger.debug({label: `view-middleware`, message: `Add default localized paths ${defaultLocalePaths}`});
-  app.get(defaultLocalePaths, (req, res) => {
-    let modifiedPath = req.originalUrl.replace(`/${defaultLocale}`, "");
-    if (modifiedPath.indexOf("/") !== 0) {
-      modifiedPath = `/${modifiedPath}`;
+  app.get(defaultLocalePaths, (req, res, next) => {
+    if (!req.originalUrl?.startsWith(`/${defaultLocale}`)) {
+      import_diagnostics.logger.warn({
+        label: "view-middleware",
+        message: `Attempted to redirect to a URL that did not start with the default locale: /${defaultLocale} ${req.originalUrl}`
+      });
+      return next();
+    }
+    const [originalPath, queryString] = req.originalUrl.split("?");
+    let modifiedPath = originalPath.replace(`/${defaultLocale}`, "");
+    if (req.basePath) {
+      modifiedPath = `${req.basePath}${modifiedPath}`;
     }
+    const queryParams = new import_url.URLSearchParams(queryString);
     if (defaultRedirectParams) {
       Object.entries(defaultRedirectParams).forEach(([key, value]) => {
-        modifiedPath += `${modifiedPath.includes("?") ? "&" : "?"}${key}=${value}`;
+        if (queryParams.has(key) && queryParams.get(key) !== value) {
+          queryParams.set(key, value);
+        } else if (!queryParams.has(key)) {
+          queryParams.set(key, value);
+        }
       });
     }
+    modifiedPath = queryParams.toString() ? `${modifiedPath}?${queryParams.toString()}` : modifiedPath;
     res.setHeader("Location", modifiedPath);
     return res.sendStatus(301);
   });

package/build/cjs/tools/static-generation.cjs

@@ -143,6 +143,7 @@ var SiteGenerator = class {
       let context;
       context = await dispatcher.dispatchUrl(url, "GET", siteConfig.locale);
       if (context?.fs?.headers?.Location) {
+        this.saveServerBundles(siteConfig, context.fs.metadata?.viewDefinition?.viewRecord.serverBundles);
         const redirectUrl = context?.fs?.headers?.Location;
         url = redirectUrl;
         const redirectContext = await dispatcher.dispatchUrl(url, "GET", siteConfig.locale);
@@ -204,7 +205,7 @@ var SiteGenerator = class {
         }
       }
       if (moduleDefinition.bundleRecord) {
-        this.addBundleToSiteMetadata(moduleDefinition, url, siteConfig);
+        this.addBundleToSiteMetadata(moduleDefinition, url, false, siteConfig);
       }
     }
     const uris = context.fs?.metadata?.resolvedUris || [];
@@ -229,10 +230,10 @@ var SiteGenerator = class {
       siteBundles[specifier] = bundleMetadata;
     }
   }
-  addBundleToSiteMetadata(bundleDefinition, url, siteConfig) {
+  addBundleToSiteMetadata(bundleDefinition, url, ssr, siteConfig) {
     if (siteConfig.siteMetadata) {
       const locale = siteConfig.locale;
-      const specifier = (0, import_site_metadata.getSiteBundleId)(bundleDefinition, locale, false, siteConfig.i18n);
+      const specifier = (0, import_site_metadata.getSiteBundleId)(bundleDefinition, locale, ssr, siteConfig.i18n);
       const imports = bundleDefinition.bundleRecord.imports?.map((moduleRef) => (0, import_site_metadata.getSiteBundleId)(moduleRef, locale, false, siteConfig.i18n)) || [];
       const dynamicImports = bundleDefinition.bundleRecord.dynamicImports?.map((moduleRef) => (0, import_site_metadata.getSiteBundleId)(moduleRef, locale, false, siteConfig.i18n));
       const includedModules = bundleDefinition.bundleRecord.includedModules?.map((moduleRef) => {
@@ -363,6 +364,7 @@ var SiteGenerator = class {
         dispatchRequests.push(this.dispatchJSResourceRecursive(jsUri, dispatcher, siteConfig));
       }
     }
+    this.saveServerBundles(siteConfig, viewDefinition.viewRecord.serverBundles);
     const bootstrapResources = viewDefinition.viewRecord.bootstrapModule?.resources || [];
     for (const resource of bootstrapResources) {
       if (!resource.inline) {
@@ -549,7 +551,8 @@ var SiteGenerator = class {
     const endpoints = {
       uris: {
         legacyDefault: (0, import_shared_utils.getModuleUriPrefix)(runtimeEnvironment, {locale}),
-        mapping: (0, import_shared_utils.getMappingUriPrefix)(runtimeEnvironment, {locale})
+        mapping: (0, import_shared_utils.getMappingUriPrefix)(runtimeEnvironment, {locale}),
+        server: (0, import_shared_utils.getModuleUriPrefix)({...runtimeEnvironment, bundle: true}, {locale}).replace("/bundle/", "/bundle-server/")
       }
     };
     return {
@@ -615,6 +618,22 @@ ${mergeIndex}
     this.addAdditionalImportMetadataToViewConfig(siteConfig);
     await siteConfig.siteMetadata?.persistSiteMetadata();
   }
+  async saveServerBundles(siteConfig, bundles) {
+    if (bundles?.size) {
+      const {endpoints, outputDir} = siteConfig;
+      bundles.forEach(async (bundle) => {
+        const {specifier, version} = bundle;
+        const vSpecifier = (0, import_shared_utils.getSpecifier)({
+          specifier,
+          version: version ? (0, import_shared_utils.normalizeVersionToUri)(version) : void 0
+        });
+        const url = `${endpoints?.uris.server}${vSpecifier}/s/${(0, import_shared_utils.signBundle)(bundle)}/bundle_${(0, import_shared_utils.prettyModuleUriSuffix)(specifier)}.js`;
+        this.addBundleToSiteMetadata(bundle, url, true, siteConfig);
+        (0, import_dir.createResourceDir)((0, import_path.dirname)(url), outputDir);
+        await (0, import_stream.writeResponse)({fs: {body: await bundle.getCode()}}, (0, import_path.join)(outputDir, url));
+      });
+    }
+  }
 };
 var static_generation_default = SiteGenerator;
 var ViewImportMetadataImpl = class {

package/build/cjs/tools/utils/stream.cjs

@@ -38,6 +38,8 @@ async function writeStream(readStream, fullPath) {
   });
 }
 async function writeResponse(context, fullPath) {
+  if (import_fs.default.existsSync(fullPath))
+    return;
   if (context.fs?.stream) {
     const stream = context.fs?.stream;
     await writeStream(stream, fullPath);

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

@@ -1,4 +1,5 @@
 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, shortestTtl, } from '@lwrjs/shared-utils';
@@ -241,18 +242,41 @@ export function viewMiddleware(app, context) {
  */
 function addDefaultLocaleRedirects(defaultLocale, defaultLocalePaths, defaultRedirectParams, app) {
     logger.debug({ label: `view-middleware`, message: `Add default localized paths ${defaultLocalePaths}` });
-    app.get(defaultLocalePaths, (req, res) => {
-        // Get the original URL path and split it into segments
-        let modifiedPath = req.originalUrl.replace(`/${defaultLocale}`, '');
-        // Make sure there is a leading slash.  Redirect to '' causes an infinite loop.
-        if (modifiedPath.indexOf('/') !== 0) {
-            modifiedPath = `/${modifiedPath}`;
+    app.get(defaultLocalePaths, (req, res, next) => {
+        // This middleware should only have been called with paths that start with /{defaultLocale}.
+        // If somehow that is not the case log a warning and do not re-direct
+        if (!req.originalUrl?.startsWith(`/${defaultLocale}`)) {
+            logger.warn({
+                label: 'view-middleware',
+                message: `Attempted to redirect to a URL that did not start with the default locale: /${defaultLocale} ${req.originalUrl}`,
+            });
+            return next();
+        }
+        // Separate the path and query string from the original URL
+        const [originalPath, queryString] = req.originalUrl.split('?');
+        // Remove the default locale from the original path
+        let modifiedPath = originalPath.replace(`/${defaultLocale}`, '');
+        // Ensure modifiedPath starts with req.basePath if set
+        if (req.basePath) {
+            modifiedPath = `${req.basePath}${modifiedPath}`;
         }
+        // Parse existing query parameters into an object
+        const queryParams = new URLSearchParams(queryString);
+        // Merge in defaultRedirectParams, replacing values if the key exists with a different value
         if (defaultRedirectParams) {
             Object.entries(defaultRedirectParams).forEach(([key, value]) => {
-                modifiedPath += `${modifiedPath.includes('?') ? '&' : '?'}${key}=${value}`;
+                // If the key exists but has a different value, replace it
+                if (queryParams.has(key) && queryParams.get(key) !== value) {
+                    queryParams.set(key, value);
+                }
+                else if (!queryParams.has(key)) {
+                    // Add the parameter if it doesn't exist
+                    queryParams.set(key, value);
+                }
             });
         }
+        // Rebuild the modified path, adding query params only if they exist
+        modifiedPath = queryParams.toString() ? `${modifiedPath}?${queryParams.toString()}` : modifiedPath;
         // Perform a 301 redirect to the modified URL
         res.setHeader('Location', modifiedPath);
         return res.sendStatus(301);

package/build/es/tools/static-generation.d.ts

@@ -114,6 +114,10 @@ export default class SiteGenerator {
      * Capture additional metadata collected during the processing of a route or additional module
      */
     private captureAdditionalRouteMetadata;
+    /**
+     * Save the server bundles gathered during view generation to the file system and metadata
+     */
+    private saveServerBundles;
 }
 export declare class ViewImportMetadataImpl implements ViewImportMetadata {
     private existing;

package/build/es/tools/static-generation.js

@@ -1,6 +1,8 @@
 import { performance } from 'perf_hooks';
 import { logger } from '@lwrjs/diagnostics';
-import { getSpecifier, getFeatureFlags, hashContent, isSelfUrl, getModuleUriPrefix, getMappingUriPrefix, isExternalUrl, mimeLookup, getViewUri, sortLocalesByFallback, VERSION_NOT_PROVIDED, PROTOCOL_FILE, normalizeFromFileURL, isExternalSpecifier, explodeSpecifier, } from '@lwrjs/shared-utils';
+import { 
+// createIntegrityHash,
+getSpecifier, getFeatureFlags, hashContent, isSelfUrl, getModuleUriPrefix, getMappingUriPrefix, isExternalUrl, mimeLookup, getViewUri, sortLocalesByFallback, VERSION_NOT_PROVIDED, PROTOCOL_FILE, normalizeFromFileURL, isExternalSpecifier, explodeSpecifier, prettyModuleUriSuffix, normalizeVersionToUri, signBundle, } from '@lwrjs/shared-utils';
 import { SiteMetadataImpl, getSiteBundleId, getSiteResourceId } from '@lwrjs/static/site-metadata';
 import { join, dirname, extname, normalize } from 'path';
 import fs from 'fs-extra';
@@ -166,6 +168,7 @@ export default class SiteGenerator {
             context = await dispatcher.dispatchUrl(url, 'GET', siteConfig.locale);
             // Handle 302 redirect if applicable
             if (context?.fs?.headers?.Location) {
+                this.saveServerBundles(siteConfig, context.fs.metadata?.viewDefinition?.viewRecord.serverBundles);
                 const redirectUrl = context?.fs?.headers?.Location;
                 url = redirectUrl;
                 const redirectContext = await dispatcher.dispatchUrl(url, 'GET', siteConfig.locale);
@@ -211,6 +214,12 @@ export default class SiteGenerator {
         createResourceDir(dirname(normalizedUrl), outputDir);
         const ext = extname(normalizedUrl);
         const fullPath = join(outputDir, `${normalizedUrl}${ext ? '' : '.js'}`);
+        // TEMP: Code to force client bundles to fail fast during SSR for manual testing
+        // if (context.fs?.body) {
+        //     const body = `if (typeof window === 'undefined') throw new Error('This is a client bundle! ${specifier}');\n${context.fs.body}`;
+        //     if (moduleDefinition) moduleDefinition.integrity = createIntegrityHash(body);
+        //     context.fs.body = body;
+        // }
         await writeResponse(context, fullPath);
         // Build up a list of dispatch requests to kick off in parallel
         const dispatchRequests = [];
@@ -266,7 +275,7 @@ export default class SiteGenerator {
             }
             // If this is a bundle add it to the bundle metadata
             if (moduleDefinition.bundleRecord) {
-                this.addBundleToSiteMetadata(moduleDefinition, url, siteConfig);
+                this.addBundleToSiteMetadata(moduleDefinition, url, false, siteConfig);
             }
         }
         // Bundles with unresolved module uris
@@ -296,10 +305,10 @@ export default class SiteGenerator {
             siteBundles[specifier] = bundleMetadata;
         }
     }
-    addBundleToSiteMetadata(bundleDefinition, url, siteConfig) {
+    addBundleToSiteMetadata(bundleDefinition, url, ssr, siteConfig) {
         if (siteConfig.siteMetadata) {
             const locale = siteConfig.locale;
-            const specifier = getSiteBundleId(bundleDefinition, locale, false, siteConfig.i18n);
+            const specifier = getSiteBundleId(bundleDefinition, locale, ssr, siteConfig.i18n);
             const imports = bundleDefinition.bundleRecord.imports?.map((moduleRef) => getSiteBundleId(moduleRef, locale, false, siteConfig.i18n)) || [];
             const dynamicImports = bundleDefinition.bundleRecord.dynamicImports?.map((moduleRef) => getSiteBundleId(moduleRef, locale, false, siteConfig.i18n));
             const includedModules = bundleDefinition.bundleRecord.includedModules?.map((moduleRef) => {
@@ -482,6 +491,8 @@ export default class SiteGenerator {
                 dispatchRequests.push(this.dispatchJSResourceRecursive(jsUri, dispatcher, siteConfig));
             }
         }
+        // Server bundles
+        this.saveServerBundles(siteConfig, viewDefinition.viewRecord.serverBundles);
         // Bootstrap Resources
         const bootstrapResources = viewDefinition.viewRecord.bootstrapModule?.resources || [];
         for (const resource of bootstrapResources) {
@@ -730,6 +741,7 @@ export default class SiteGenerator {
                 // legacy globalThis.LWR.importMappings.default
                 legacyDefault: getModuleUriPrefix(runtimeEnvironment, { locale }),
                 mapping: getMappingUriPrefix(runtimeEnvironment, { locale }),
+                server: getModuleUriPrefix({ ...runtimeEnvironment, bundle: true }, { locale }).replace('/bundle/', '/bundle-server/'),
             },
         };
         return {
@@ -810,6 +822,28 @@ export default class SiteGenerator {
         // Save site meta data
         await siteConfig.siteMetadata?.persistSiteMetadata();
     }
+    /**
+     * Save the server bundles gathered during view generation to the file system and metadata
+     */
+    async saveServerBundles(siteConfig, bundles) {
+        if (bundles?.size) {
+            const { endpoints, outputDir } = siteConfig;
+            bundles.forEach(async (bundle) => {
+                const { specifier, version } = bundle;
+                const vSpecifier = getSpecifier({
+                    specifier,
+                    version: version ? normalizeVersionToUri(version) : undefined,
+                });
+                const url = `${endpoints?.uris.server}${vSpecifier}/s/${signBundle(bundle)}/bundle_${prettyModuleUriSuffix(specifier)}.js`;
+                this.addBundleToSiteMetadata(bundle, url, true, siteConfig);
+                createResourceDir(dirname(url), outputDir);
+                // TEMP: Code to force server bundles to fail fast on the client during manual testing
+                // const body = `if (typeof window !== 'undefined') throw new Error('This is a server bundle! ${specifier}');\n${await bundle.getCode()}`;
+                // await writeResponse({ fs: { body } }, join(outputDir, url));
+                await writeResponse({ fs: { body: await bundle.getCode() } }, join(outputDir, url));
+            });
+        }
+    }
 }
 // Class used to track import metadata for a view
 export class ViewImportMetadataImpl {

package/build/es/tools/utils/stream.d.ts

@@ -2,7 +2,7 @@
 import type { Readable } from 'stream';
 import type { FsContext } from '@lwrjs/types';
 export declare function writeStream(readStream: Readable, fullPath: string): Promise<void>;
-export declare function writeResponse(context: FsContext, fullPath: string): Promise<void>;
+export declare function writeResponse(context: Pick<FsContext, 'fs'>, fullPath: string): Promise<void>;
 /**
  * @param {*} o - Item to check if it's an object
  * @returns {boolean}

package/build/es/tools/utils/stream.js

@@ -8,6 +8,8 @@ export async function writeStream(readStream, fullPath) {
     });
 }
 export async function writeResponse(context, fullPath) {
+    if (fs.existsSync(fullPath))
+        return;
     if (context.fs?.stream) {
         const stream = context.fs?.stream;
         await writeStream(stream, fullPath);

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.15.0-alpha.33",
+    "version": "0.15.0-alpha.35",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -43,34 +43,34 @@
         "build": "tsc -b"
     },
     "dependencies": {
-        "@lwrjs/app-service": "0.15.0-alpha.33",
-        "@lwrjs/asset-registry": "0.15.0-alpha.33",
-        "@lwrjs/asset-transformer": "0.15.0-alpha.33",
-        "@lwrjs/base-view-provider": "0.15.0-alpha.33",
-        "@lwrjs/base-view-transformer": "0.15.0-alpha.33",
-        "@lwrjs/client-modules": "0.15.0-alpha.33",
-        "@lwrjs/config": "0.15.0-alpha.33",
-        "@lwrjs/diagnostics": "0.15.0-alpha.33",
-        "@lwrjs/esbuild": "0.15.0-alpha.33",
-        "@lwrjs/fs-asset-provider": "0.15.0-alpha.33",
-        "@lwrjs/fs-watch": "0.15.0-alpha.33",
-        "@lwrjs/html-view-provider": "0.15.0-alpha.33",
-        "@lwrjs/instrumentation": "0.15.0-alpha.33",
-        "@lwrjs/loader": "0.15.0-alpha.33",
-        "@lwrjs/lwc-module-provider": "0.15.0-alpha.33",
-        "@lwrjs/lwc-ssr": "0.15.0-alpha.33",
-        "@lwrjs/markdown-view-provider": "0.15.0-alpha.33",
-        "@lwrjs/module-bundler": "0.15.0-alpha.33",
-        "@lwrjs/module-registry": "0.15.0-alpha.33",
-        "@lwrjs/npm-module-provider": "0.15.0-alpha.33",
-        "@lwrjs/nunjucks-view-provider": "0.15.0-alpha.33",
-        "@lwrjs/o11y": "0.15.0-alpha.33",
-        "@lwrjs/resource-registry": "0.15.0-alpha.33",
-        "@lwrjs/router": "0.15.0-alpha.33",
-        "@lwrjs/server": "0.15.0-alpha.33",
-        "@lwrjs/shared-utils": "0.15.0-alpha.33",
-        "@lwrjs/static": "0.15.0-alpha.33",
-        "@lwrjs/view-registry": "0.15.0-alpha.33",
+        "@lwrjs/app-service": "0.15.0-alpha.35",
+        "@lwrjs/asset-registry": "0.15.0-alpha.35",
+        "@lwrjs/asset-transformer": "0.15.0-alpha.35",
+        "@lwrjs/base-view-provider": "0.15.0-alpha.35",
+        "@lwrjs/base-view-transformer": "0.15.0-alpha.35",
+        "@lwrjs/client-modules": "0.15.0-alpha.35",
+        "@lwrjs/config": "0.15.0-alpha.35",
+        "@lwrjs/diagnostics": "0.15.0-alpha.35",
+        "@lwrjs/esbuild": "0.15.0-alpha.35",
+        "@lwrjs/fs-asset-provider": "0.15.0-alpha.35",
+        "@lwrjs/fs-watch": "0.15.0-alpha.35",
+        "@lwrjs/html-view-provider": "0.15.0-alpha.35",
+        "@lwrjs/instrumentation": "0.15.0-alpha.35",
+        "@lwrjs/loader": "0.15.0-alpha.35",
+        "@lwrjs/lwc-module-provider": "0.15.0-alpha.35",
+        "@lwrjs/lwc-ssr": "0.15.0-alpha.35",
+        "@lwrjs/markdown-view-provider": "0.15.0-alpha.35",
+        "@lwrjs/module-bundler": "0.15.0-alpha.35",
+        "@lwrjs/module-registry": "0.15.0-alpha.35",
+        "@lwrjs/npm-module-provider": "0.15.0-alpha.35",
+        "@lwrjs/nunjucks-view-provider": "0.15.0-alpha.35",
+        "@lwrjs/o11y": "0.15.0-alpha.35",
+        "@lwrjs/resource-registry": "0.15.0-alpha.35",
+        "@lwrjs/router": "0.15.0-alpha.35",
+        "@lwrjs/server": "0.15.0-alpha.35",
+        "@lwrjs/shared-utils": "0.15.0-alpha.35",
+        "@lwrjs/static": "0.15.0-alpha.35",
+        "@lwrjs/view-registry": "0.15.0-alpha.35",
         "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.15.0-alpha.33",
+        "@lwrjs/types": "0.15.0-alpha.35",
         "@types/ws": "^8.5.12",
         "memfs": "^4.13.0"
     },
@@ -93,5 +93,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "0e636fb16ede654870100f5fa3bb5b3985a3db00"
+    "gitHead": "42f04ad68558ec00f543a04e363671ceb294c88b"
 }