@lwrjs/core 0.10.0-alpha.19 → 0.10.0-alpha.20

package/build/cjs/index.cjs

@@ -45,6 +45,7 @@ var import_asset_middleware = __toModule(require("./middleware/asset-middleware.
 var import_view_middleware = __toModule(require("./middleware/view-middleware.cjs"));
 var import_resource_middleware = __toModule(require("./middleware/resource-middleware.cjs"));
 var import_hmr_middleware = __toModule(require("./middleware/hmr-middleware.cjs"));
+var import_instrumentation = __toModule(require("@lwrjs/instrumentation"));
 function initMiddleware(app, server, serverContext) {
   app.useCompression();
   (0, import_locale_middleware.localeMiddleware)(app, serverContext);
@@ -67,10 +68,11 @@ async function initContext(appConfig, runtimeEnvironment, globalData) {
   if (hooks.length) {
     const skipValidation = true;
     await (0, import_config.executeConfigHooks)(hooks, appConfig, runtimeEnvironment, globalData, skipValidation);
+    (0, import_config.executeInstrumentationHooks)(hooks);
     (0, import_config.executeStartHooks)(hooks, appConfig);
   }
   const services = await (0, import_modules.loadServices)(appConfig);
-  const serverContext = (0, import_server2.createServerContext)(appConfig, runtimeEnvironment, globalData);
+  const serverContext = (0, import_instrumentation.getTracer)().trace({name: import_instrumentation.CoreSpan.CreateServerContext}, () => (0, import_server2.createServerContext)(appConfig, runtimeEnvironment, globalData));
   const providerContext = (0, import_provider.createProviderContext)(serverContext);
   const {moduleRegistry, assetRegistry, resourceRegistry, viewRegistry, moduleBundler} = serverContext;
   const moduleProviders = createServices(services.moduleProviders, providerContext);
@@ -98,6 +100,7 @@ async function initContext(appConfig, runtimeEnvironment, globalData) {
 var LwrApp = class {
   constructor(config = {}) {
     this.initialized = false;
+    const span = (0, import_instrumentation.getTracer)().startSpan({name: import_instrumentation.CoreSpan.CreateServer});
     const {appConfig, runtimeEnvironment, globalData} = (0, import_config.loadConfig)(config);
     this.config = appConfig;
     this.runtimeEnvironment = runtimeEnvironment;
@@ -105,6 +108,7 @@ var LwrApp = class {
     const {basePath} = this.config;
     this.app = (0, import_server.createInternalServer)(this.config.serverType, {basePath});
     this.server = this.app.createHttpServer();
+    span.end();
   }
   setConfig(config) {
     const {appConfig, runtimeEnvironment, globalData} = (0, import_config.loadConfig)(config);
@@ -116,6 +120,7 @@ var LwrApp = class {
     return this.config;
   }
   async init() {
+    const span = (0, import_instrumentation.getTracer)().startSpan({name: import_instrumentation.CoreSpan.InitServer});
     if (this.initialized) {
       return;
     }
@@ -127,8 +132,10 @@ var LwrApp = class {
       this.initialized = false;
       throw e;
     }
+    span.end();
   }
   async listen(callback) {
+    const span = (0, import_instrumentation.getTracer)().startSpan({name: import_instrumentation.CoreSpan.StartServer});
     await this.init();
     const {server, config, app} = this;
     const {serverMode, port} = config;
@@ -155,6 +162,7 @@ var LwrApp = class {
         }
         const opts = {serverMode, port};
         callback?.(opts);
+        span.end();
         resolve(opts);
       });
     });

package/build/cjs/middleware/asset-middleware.cjs

@@ -29,45 +29,63 @@ __export(exports, {
 var import_path = __toModule(require("path"));
 var import_identity = __toModule(require("./utils/identity.cjs"));
 var import_error_handling = __toModule(require("./utils/error-handling.cjs"));
+var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 function createAssetMiddleware(context) {
   const {
     assetRegistry,
     runtimeEnvironment: {basePath}
   } = context;
-  return async (req, res) => {
+  return async (req, res, next) => {
     const {runtimeEnvironment} = req.getRuntimeContext(context.runtimeEnvironment);
     const {assetId, immutable, signature} = (0, import_identity.getAssetIdentity)(req);
     if (basePath && !assetId.specifier.startsWith(basePath)) {
       assetId.specifier = import_path.default.join(basePath, assetId.specifier);
     }
-    const assetUri = await assetRegistry.resolveAssetUri(assetId, runtimeEnvironment);
-    if (assetUri.external) {
-      res.set({
-        Location: assetUri.uri,
-        "cache-control": "public, max-age=60"
-      });
-      res.sendStatus(302);
-      return;
+    try {
+      const assetUri = await assetRegistry.resolveAssetUri(assetId, runtimeEnvironment);
+      if (assetUri.external) {
+        res.set({
+          Location: assetUri.uri,
+          "cache-control": "public, max-age=60"
+        });
+        res.sendStatus(302);
+        return;
+      }
+      const asset = await assetRegistry.getAsset({...assetId, signature}, runtimeEnvironment, req.isSiteGeneration());
+      if (req.isSiteGeneration()) {
+        res.setSiteGenerationMetadata({asset});
+      }
+      if (asset.mime) {
+        res.type(asset.mime);
+      }
+      if (runtimeEnvironment.immutableAssets && immutable) {
+        res.setHeader("Cache-control", "public, max-age=12895706, immutable");
+      } else if (runtimeEnvironment.immutableAssets) {
+        res.setHeader("Cache-control", "public, max-age=60");
+      }
+      res.status(200).stream(asset.stream());
+    } catch (error) {
+      if (import_path.default.dirname(assetId.specifier) === (basePath ? basePath : "/") && error instanceof import_diagnostics.DiagnosticsError && error?.diagnostics[0]?.description.category === "lwrUnresolvable/asset") {
+        await next();
+        return;
+      }
+      throw error;
     }
-    const asset = await assetRegistry.getAsset({...assetId, signature}, runtimeEnvironment, req.isSiteGeneration());
-    if (req.isSiteGeneration()) {
-      res.setSiteGenerationMetadata({asset});
-    }
-    if (asset.mime) {
-      res.type(asset.mime);
-    }
-    if (runtimeEnvironment.immutableAssets && immutable) {
-      res.setHeader("Cache-control", "public, max-age=12895706, immutable");
-    } else if (runtimeEnvironment.immutableAssets) {
-      res.setHeader("Cache-control", "public, max-age=60");
-    }
-    res.status(200).stream(asset.stream());
   };
 }
 function assetMiddleware(app, context) {
-  const paths = context.appConfig.assets.map((a) => a.urlPath + app.getRegexWildcard());
+  const paths = context.appConfig.assets.map((config) => {
+    const assetDirConfig = config;
+    let urlPath = config.urlPath;
+    if (assetDirConfig.root) {
+      urlPath = "/:filename";
+    } else if (assetDirConfig.dir) {
+      urlPath += app.getRegexWildcard();
+    }
+    return urlPath;
+  });
   app.get([
-    ...paths,
+    ...[...new Set(paths)],
     "/:apiVersion/:assetType(asset|content-asset)/:immutable?/s/:signature/" + app.getRegexWildcard(),
     "/:apiVersion/:assetType(asset|content-asset)/:immutable?/" + app.getRegexWildcard()
   ], (0, import_error_handling.handleErrors)(createAssetMiddleware(context)));

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

@@ -199,7 +199,8 @@ var SiteGenerator = class {
         const specifier = resourceDefinition.specifier;
         const resourceMetadata = {
           path: decodeURIComponent(url),
-          mimeType: resourceDefinition.type
+          mimeType: resourceDefinition.type,
+          inline: resourceDefinition.inline
         };
         const siteResources = siteConfig.siteMetadata.getSiteResources();
         siteResources.resources[specifier] = resourceMetadata;
@@ -395,7 +396,8 @@ var SiteGenerator = class {
       try {
         const assetSrcFile = asset.file;
         const assetSrcDir = asset.dir;
-        const assetsPath = (0, import_path.join)(outputDir, basePath ? basePath + asset.urlPath : asset.urlPath);
+        const urlPath = asset.urlPath;
+        const assetsPath = (0, import_path.join)(outputDir, basePath ? basePath + urlPath : urlPath);
         if (assetSrcDir && import_fs_extra.default.existsSync(assetSrcDir)) {
           import_fs_extra.default.copySync(assetSrcDir, assetsPath);
           this.addAssetsToMetadata(assetsPath, siteConfig);

package/build/es/index.js

@@ -1,7 +1,7 @@
 import { getFeatureFlags, DEFAULT_LWR_BOOTSTRAP_CONFIG, logger } from '@lwrjs/shared-utils';
 import { createInternalServer } from '@lwrjs/server';
 import { LwrServerError, createSingleDiagnosticError, descriptions } from '@lwrjs/diagnostics';
-import { loadConfig, executeConfigHooks, executeStartHooks } from '@lwrjs/config';
+import { loadConfig, executeConfigHooks, executeStartHooks, executeInstrumentationHooks, } from '@lwrjs/config';
 import { loadHooks, loadServices, loadRouteHandlers } from '@lwrjs/config/modules';
 import SiteGenerator from './tools/static-generation.js';
 import { warmupServer } from './tools/server-warmup.js';
@@ -15,6 +15,7 @@ import { assetMiddleware } from './middleware/asset-middleware.js';
 import { viewMiddleware } from './middleware/view-middleware.js';
 import { resourceMiddleware } from './middleware/resource-middleware.js';
 import { hmrMiddleware } from './middleware/hmr-middleware.js';
+import { getTracer, CoreSpan } from '@lwrjs/instrumentation';
 function initMiddleware(app, server, serverContext) {
     // all middleware attached AFTER compression will have compressed responses
     app.useCompression();
@@ -44,12 +45,13 @@ async function initContext(appConfig, runtimeEnvironment, globalData) {
     if (hooks.length) {
         const skipValidation = true; // skip for config hook, since `executeStartHooks` hook will validate
         await executeConfigHooks(hooks, appConfig, runtimeEnvironment, globalData, skipValidation);
+        executeInstrumentationHooks(hooks);
         executeStartHooks(hooks, appConfig);
     }
     // load all configurable modules
     const services = await loadServices(appConfig);
     // create all framework components(ie. registries)
-    const serverContext = createServerContext(appConfig, runtimeEnvironment, globalData);
+    const serverContext = getTracer().trace({ name: CoreSpan.CreateServerContext }, () => createServerContext(appConfig, runtimeEnvironment, globalData));
     // create public subset of configurations
     const providerContext = createProviderContext(serverContext);
     const { moduleRegistry, assetRegistry, resourceRegistry, viewRegistry, moduleBundler } = serverContext;
@@ -87,6 +89,7 @@ async function initContext(appConfig, runtimeEnvironment, globalData) {
 export class LwrApp {
     constructor(config = {}) {
         this.initialized = false;
+        const span = getTracer().startSpan({ name: CoreSpan.CreateServer });
         const { appConfig, runtimeEnvironment, globalData } = loadConfig(config);
         this.config = appConfig;
         this.runtimeEnvironment = runtimeEnvironment;
@@ -94,6 +97,7 @@ export class LwrApp {
         const { basePath } = this.config;
         this.app = createInternalServer(this.config.serverType, { basePath });
         this.server = this.app.createHttpServer();
+        span.end();
     }
     setConfig(config) {
         const { appConfig, runtimeEnvironment, globalData } = loadConfig(config);
@@ -105,6 +109,7 @@ export class LwrApp {
         return this.config;
     }
     async init() {
+        const span = getTracer().startSpan({ name: CoreSpan.InitServer });
         if (this.initialized) {
             return;
         }
@@ -121,8 +126,10 @@ export class LwrApp {
             this.initialized = false;
             throw e;
         }
+        span.end();
     }
     async listen(callback) {
+        const span = getTracer().startSpan({ name: CoreSpan.StartServer });
         await this.init();
         const { server, config, app } = this;
         const { serverMode, port } = config;
@@ -150,6 +157,7 @@ export class LwrApp {
                 }
                 const opts = { serverMode, port };
                 callback?.(opts);
+                span.end(); // TODO is this the right tracing for start server?
                 resolve(opts);
             });
         });

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

@@ -1,44 +1,71 @@
 import path from 'path';
 import { getAssetIdentity } from './utils/identity.js';
 import { handleErrors } from './utils/error-handling.js';
+import { DiagnosticsError } from '@lwrjs/diagnostics';
 function createAssetMiddleware(context) {
     const { assetRegistry, runtimeEnvironment: { basePath }, } = context;
-    return async (req, res) => {
+    return async (req, res, next) => {
         const { runtimeEnvironment } = req.getRuntimeContext(context.runtimeEnvironment);
         const { assetId, immutable, signature } = getAssetIdentity(req);
         if (basePath && !assetId.specifier.startsWith(basePath)) {
             assetId.specifier = path.join(basePath, assetId.specifier);
         }
-        // Redirect if this is an external asset
-        const assetUri = await assetRegistry.resolveAssetUri(assetId, runtimeEnvironment);
-        if (assetUri.external) {
-            res.set({
-                Location: assetUri.uri,
-                'cache-control': 'public, max-age=60',
-            });
-            res.sendStatus(302);
-            return;
+        try {
+            // Redirect if this is an external asset
+            const assetUri = await assetRegistry.resolveAssetUri(assetId, runtimeEnvironment);
+            if (assetUri.external) {
+                res.set({
+                    Location: assetUri.uri,
+                    'cache-control': 'public, max-age=60',
+                });
+                res.sendStatus(302);
+                return;
+            }
+            const asset = await assetRegistry.getAsset({ ...assetId, signature }, runtimeEnvironment, req.isSiteGeneration());
+            if (req.isSiteGeneration()) {
+                res.setSiteGenerationMetadata({ asset });
+            }
+            if (asset.mime) {
+                res.type(asset.mime);
+            }
+            if (runtimeEnvironment.immutableAssets && immutable) {
+                res.setHeader('Cache-control', 'public, max-age=12895706, immutable');
+            }
+            else if (runtimeEnvironment.immutableAssets) {
+                res.setHeader('Cache-control', 'public, max-age=60');
+            }
+            res.status(200).stream(asset.stream());
         }
-        const asset = await assetRegistry.getAsset({ ...assetId, signature }, runtimeEnvironment, req.isSiteGeneration());
-        if (req.isSiteGeneration()) {
-            res.setSiteGenerationMetadata({ asset });
+        catch (error) {
+            // Ignore asset not found for root asset requests
+            if (path.dirname(assetId.specifier) === (basePath ? basePath : '/') &&
+                error instanceof DiagnosticsError &&
+                error?.diagnostics[0]?.description.category === 'lwrUnresolvable/asset') {
+                // Must await other middleware or this can respond before expected.
+                await next();
+                return;
+            }
+            // else throw the error
+            throw error;
         }
-        if (asset.mime) {
-            res.type(asset.mime);
-        }
-        if (runtimeEnvironment.immutableAssets && immutable) {
-            res.setHeader('Cache-control', 'public, max-age=12895706, immutable');
-        }
-        else if (runtimeEnvironment.immutableAssets) {
-            res.setHeader('Cache-control', 'public, max-age=60');
-        }
-        res.status(200).stream(asset.stream());
     };
 }
 export function assetMiddleware(app, context) {
-    const paths = context.appConfig.assets.map((a) => a.urlPath + app.getRegexWildcard());
+    const paths = context.appConfig.assets.map((config) => {
+        const assetDirConfig = config;
+        let urlPath = config.urlPath;
+        // If this is a root config add a /:filename path to match any file in the root.  The middleware will fall through if there is no match.
+        if (assetDirConfig.root) {
+            urlPath = '/:filename';
+        }
+        else if (assetDirConfig.dir) {
+            urlPath += app.getRegexWildcard();
+        }
+        return urlPath;
+    });
     app.get([
-        ...paths,
+        // De-dupe paths (i.e. root path may have been added more than once)
+        ...[...new Set(paths)],
         '/:apiVersion/:assetType(asset|content-asset)/:immutable?/s/:signature/' + app.getRegexWildcard(),
         '/:apiVersion/:assetType(asset|content-asset)/:immutable?/' + app.getRegexWildcard(),
     ], handleErrors(createAssetMiddleware(context)));

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

@@ -255,6 +255,7 @@ export default class SiteGenerator {
                 const resourceMetadata = {
                     path: decodeURIComponent(url),
                     mimeType: resourceDefinition.type,
+                    inline: resourceDefinition.inline,
                 };
                 const siteResources = siteConfig.siteMetadata.getSiteResources();
                 siteResources.resources[specifier] = resourceMetadata;
@@ -553,7 +554,8 @@ export default class SiteGenerator {
             try {
                 const assetSrcFile = asset.file;
                 const assetSrcDir = asset.dir;
-                const assetsPath = join(outputDir, basePath ? basePath + asset.urlPath : asset.urlPath);
+                const urlPath = asset.urlPath;
+                const assetsPath = join(outputDir, basePath ? basePath + urlPath : urlPath);
                 if (assetSrcDir && fs.existsSync(assetSrcDir)) {
                     fs.copySync(assetSrcDir, assetsPath);
                     this.addAssetsToMetadata(assetsPath, siteConfig);

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.10.0-alpha.19",
+    "version": "0.10.0-alpha.20",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -40,30 +40,31 @@
     },
     "dependencies": {
         "@locker/compiler": "0.19.5",
-        "@lwrjs/app-service": "0.10.0-alpha.19",
-        "@lwrjs/asset-registry": "0.10.0-alpha.19",
-        "@lwrjs/asset-transformer": "0.10.0-alpha.19",
-        "@lwrjs/base-view-provider": "0.10.0-alpha.19",
-        "@lwrjs/base-view-transformer": "0.10.0-alpha.19",
-        "@lwrjs/client-modules": "0.10.0-alpha.19",
-        "@lwrjs/config": "0.10.0-alpha.19",
-        "@lwrjs/diagnostics": "0.10.0-alpha.19",
-        "@lwrjs/fs-asset-provider": "0.10.0-alpha.19",
-        "@lwrjs/html-view-provider": "0.10.0-alpha.19",
-        "@lwrjs/loader": "0.10.0-alpha.19",
-        "@lwrjs/lwc-module-provider": "0.10.0-alpha.19",
-        "@lwrjs/markdown-view-provider": "0.10.0-alpha.19",
-        "@lwrjs/module-bundler": "0.10.0-alpha.19",
-        "@lwrjs/module-registry": "0.10.0-alpha.19",
-        "@lwrjs/npm-module-provider": "0.10.0-alpha.19",
-        "@lwrjs/nunjucks-view-provider": "0.10.0-alpha.19",
-        "@lwrjs/o11y": "0.10.0-alpha.19",
-        "@lwrjs/resource-registry": "0.10.0-alpha.19",
-        "@lwrjs/router": "0.10.0-alpha.19",
-        "@lwrjs/server": "0.10.0-alpha.19",
-        "@lwrjs/shared-utils": "0.10.0-alpha.19",
-        "@lwrjs/static": "0.10.0-alpha.19",
-        "@lwrjs/view-registry": "0.10.0-alpha.19",
+        "@lwrjs/app-service": "0.10.0-alpha.20",
+        "@lwrjs/asset-registry": "0.10.0-alpha.20",
+        "@lwrjs/asset-transformer": "0.10.0-alpha.20",
+        "@lwrjs/base-view-provider": "0.10.0-alpha.20",
+        "@lwrjs/base-view-transformer": "0.10.0-alpha.20",
+        "@lwrjs/client-modules": "0.10.0-alpha.20",
+        "@lwrjs/config": "0.10.0-alpha.20",
+        "@lwrjs/diagnostics": "0.10.0-alpha.20",
+        "@lwrjs/fs-asset-provider": "0.10.0-alpha.20",
+        "@lwrjs/html-view-provider": "0.10.0-alpha.20",
+        "@lwrjs/instrumentation": "0.10.0-alpha.20",
+        "@lwrjs/loader": "0.10.0-alpha.20",
+        "@lwrjs/lwc-module-provider": "0.10.0-alpha.20",
+        "@lwrjs/markdown-view-provider": "0.10.0-alpha.20",
+        "@lwrjs/module-bundler": "0.10.0-alpha.20",
+        "@lwrjs/module-registry": "0.10.0-alpha.20",
+        "@lwrjs/npm-module-provider": "0.10.0-alpha.20",
+        "@lwrjs/nunjucks-view-provider": "0.10.0-alpha.20",
+        "@lwrjs/o11y": "0.10.0-alpha.20",
+        "@lwrjs/resource-registry": "0.10.0-alpha.20",
+        "@lwrjs/router": "0.10.0-alpha.20",
+        "@lwrjs/server": "0.10.0-alpha.20",
+        "@lwrjs/shared-utils": "0.10.0-alpha.20",
+        "@lwrjs/static": "0.10.0-alpha.20",
+        "@lwrjs/view-registry": "0.10.0-alpha.20",
         "chokidar": "^3.5.3",
         "esbuild": "^0.9.7",
         "fs-extra": "^11.1.1",
@@ -73,7 +74,7 @@
         "ws": "^8.8.1"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.10.0-alpha.19",
+        "@lwrjs/types": "0.10.0-alpha.20",
         "@types/ws": "^8.5.3"
     },
     "peerDependencies": {
@@ -85,5 +86,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "0bd55139c08ddf5a532978cfa9e037eaf27e78e2"
+    "gitHead": "45a867fc54e98f77dd442ccd5f668e23027b9246"
 }