@lwrjs/config 0.12.0-alpha.29 → 0.12.0-alpha.30

package/build/cjs/global-config.cjs

@@ -52,7 +52,11 @@ function getLwrConfigFromFile(rootDir, lwrConfigPath = import_defaults.DEFAULT_L
   }
   const configSource = (0, import_shared_utils.readFile)(resolvedLwrConfigPath);
   (0, import_app_config.validateLwrAppConfig)(configSource, "file");
-  return (0, import_jsonc_parser.parse)(configSource);
+  let parsedConfig = (0, import_jsonc_parser.parse)(configSource);
+  if (parsedConfig?.routes) {
+    parsedConfig.routes = parsedConfig.routes.filter((route) => route.path !== "/lwr-info");
+  }
+  return parsedConfig;
 }
 function createCacheFolder(cache, rootDir) {
   const cacheDir = (0, import_shared_utils.normalizeDirectory)(cache, rootDir);
@@ -68,7 +72,7 @@ function mergeConfig(configArg) {
   const rootDir = import_path.default.resolve(configArg?.rootDir || import_defaults.DEFAULT_ROOT_DIR);
   const configFile = !configArg?.ignoreLwrConfigFile ? getLwrConfigFromFile(rootDir, configArg?.lwrConfigFile) : void 0;
   if (configFile) {
-    configFile.routes = (configFile?.routes ?? []).concat(import_defaults.DEFAULT_LWR_CONFIG.routes);
+    configFile.routes = [...import_defaults.DEFAULT_LWR_CONFIG.routes, ...configFile?.routes ?? []];
   }
   const bundleConfig = (0, import_merge.mergeBundleConfig)(configFile, configArg);
   if (bundleConfig.external) {

package/build/cjs/hooks.cjs

@@ -33,6 +33,17 @@ var import_routes = __toModule(require("./utils/routes.cjs"));
 var import_app_config = __toModule(require("./validation/app-config.cjs"));
 var import_instrumentation = __toModule(require("@lwrjs/instrumentation"));
 var import_defaults = __toModule(require("./defaults.cjs"));
+var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
+function isInfoRoute(route) {
+  if (route.path === import_defaults.LWR_INFO_ROUTE.path && route.id === import_defaults.LWR_INFO_ROUTE.id) {
+    if (Array.isArray(route.routeHandler)) {
+      return route.routeHandler?.includes(`${import_defaults.LWR_INFO_ROUTE.routeHandler}`);
+    } else if (typeof route.routeHandler === "string") {
+      return route.routeHandler === import_defaults.LWR_INFO_ROUTE.routeHandler;
+    }
+  }
+  return false;
+}
 async function executeConfigHooks(hooks, globalConfig, runtimeEnvironment, globalData, skipValidate = false) {
   const span = (0, import_instrumentation.getTracer)().startSpan({name: import_instrumentation.ConfigSpan.ExecuteConfigHooks});
   if (!hooks.length) {
@@ -45,11 +56,22 @@ async function executeConfigHooks(hooks, globalConfig, runtimeEnvironment, globa
     }
     await hook.initConfigs(globalConfig, globalData, runtimeEnvironment);
   }
-  const hasInfoRoute = globalConfig.routes.some((route) => route.id === import_defaults.LWR_INFO_ROUTE.id);
+  let filteredRoutes = globalConfig.routes.filter((e) => e.path !== "/lwr-info" || isInfoRoute(e));
+  if (filteredRoutes.length < globalConfig.routes.length) {
+    import_diagnostics.logger.warn({
+      label: "config hooks",
+      message: "config hook attempted to redefine protected /lwr-info path"
+    });
+  }
+  const hasInfoRoute = filteredRoutes.some((route) => isInfoRoute(route));
   if (!hasInfoRoute) {
-    globalConfig.routes = [...globalConfig.routes, import_defaults.LWR_INFO_ROUTE];
+    filteredRoutes = [import_defaults.LWR_INFO_ROUTE, ...filteredRoutes];
+    import_diagnostics.logger.warn({
+      label: "config hooks",
+      message: "config hook attempted to remove /lwr-info route"
+    });
   }
-  globalConfig.routes = (0, import_routes.normalizeRoutes)(globalConfig.routes, globalConfig.routeHandlers);
+  globalConfig.routes = (0, import_routes.normalizeRoutes)(filteredRoutes, globalConfig.routeHandlers);
   globalConfig.errorRoutes = (0, import_routes.normalizeRoutes)(globalConfig.errorRoutes, globalConfig.routeHandlers);
   if (!skipValidate) {
     (0, import_app_config.validateLwrAppConfig)(globalConfig, "post");
@@ -78,11 +100,22 @@ function executeStartHooks(hooks, globalConfig, runtimeEnvironment, skipValidate
     globalConfig.routes = onStartConfig.routes || [];
     globalConfig.errorRoutes = onStartConfig.errorRoutes || [];
   }
-  const hasInfoRoute = globalConfig.routes.some((route) => route.id === import_defaults.LWR_INFO_ROUTE.id);
+  let filteredRoutes = globalConfig.routes.filter((e) => e.path !== "/lwr-info" || isInfoRoute(e));
+  if (filteredRoutes.length < globalConfig.routes.length) {
+    import_diagnostics.logger.warn({
+      label: "start hooks",
+      message: "onStart hook attempted to redefine protected /lwr-info path"
+    });
+  }
+  const hasInfoRoute = filteredRoutes.some((route) => isInfoRoute(route));
   if (!hasInfoRoute) {
-    globalConfig.routes = [...globalConfig.routes, import_defaults.LWR_INFO_ROUTE];
+    filteredRoutes = [import_defaults.LWR_INFO_ROUTE, ...filteredRoutes];
+    import_diagnostics.logger.warn({
+      label: "start hooks",
+      message: "onStart hook attempted to remove /lwr-info route"
+    });
   }
-  globalConfig.routes = (0, import_routes.normalizeRoutes)(globalConfig.routes, globalConfig.routeHandlers);
+  globalConfig.routes = (0, import_routes.normalizeRoutes)(filteredRoutes, globalConfig.routeHandlers);
   globalConfig.errorRoutes = (0, import_routes.normalizeRoutes)(globalConfig.errorRoutes, globalConfig.routeHandlers);
   if (!skipValidate) {
     (0, import_app_config.validateLwrAppConfig)(globalConfig, "post");

package/build/cjs/validation/app-config.cjs

@@ -288,6 +288,9 @@ function validateLwrAppConfig(config, phase) {
     if (validationContext.diagnostics.length) {
       throw new import_diagnostics2.LwrConfigValidationError(`Configuration validation errors in ${SOURCE_BY_PHASE[phase]}`, validationContext.diagnostics);
     }
+    if (phase === "file" && jsonSourceText.includes("/lwr-info")) {
+      import_diagnostics.logger.warn({label: `config`, message: `LWR Config file attempted to override "/lwr-info" path`});
+    }
     span.end();
     return;
   } catch (err) {

package/build/es/global-config.js

@@ -35,7 +35,11 @@ export function getLwrConfigFromFile(rootDir, lwrConfigPath = DEFAULT_LWR_CONFIG
     }
     const configSource = readFile(resolvedLwrConfigPath);
     validateLwrAppConfig(configSource, 'file');
-    return parse(configSource);
+    let parsedConfig = parse(configSource);
+    if (parsedConfig?.routes) {
+        parsedConfig.routes = parsedConfig.routes.filter(route => route.path !== '/lwr-info');
+    }
+    return parsedConfig;
 }
 /**
  * Normalize the cache directory path and create the directory
@@ -79,7 +83,7 @@ function mergeConfig(configArg) {
         : undefined;
     // merge default routes with the config file routes
     if (configFile) {
-        configFile.routes = (configFile?.routes ?? []).concat(DEFAULT_LWR_CONFIG.routes);
+        configFile.routes = [...DEFAULT_LWR_CONFIG.routes, ...(configFile?.routes ?? [])];
     }
     // Merge the bundle configs
     const bundleConfig = mergeBundleConfig(configFile, configArg);

package/build/es/hooks.d.ts

@@ -1,18 +1,4 @@
 import type { GlobalData, HooksPlugin, Instrumentation, NormalizedLwrGlobalConfig, RuntimeEnvironment, ServerContext } from '@lwrjs/types';
-/**
- * Run `initConfigs` hooks
- *
- * @remarks
- * Route normalization and validation will be executed after all config hooks have been executed.
- *
- * @privateRemarks
- * Changes to configurations are made by reference.
- *
- * @param hooks - hooks plugins
- * @param globalConfig - global configuration
- * @param runtimeEnvironment - runtime environment resolved from programmatic config and config file
- * @param globalData - resolved global data
- */
 export declare function executeConfigHooks(hooks: HooksPlugin[], globalConfig: NormalizedLwrGlobalConfig, runtimeEnvironment: RuntimeEnvironment, globalData: GlobalData, skipValidate?: boolean): Promise<void>;
 /**
  * Run `onStart` hooks

package/build/es/hooks.js

@@ -2,7 +2,19 @@ import { normalizeRoutes } from './utils/routes.js';
 import { validateLwrAppConfig } from './validation/app-config.js';
 import { getTracer, ConfigSpan } from '@lwrjs/instrumentation';
 import { LWR_INFO_ROUTE } from './defaults.js';
-/**
+import { logger } from '@lwrjs/diagnostics';
+function isInfoRoute(route) {
+    if (route.path === LWR_INFO_ROUTE.path && route.id === LWR_INFO_ROUTE.id) {
+        if (Array.isArray(route.routeHandler)) {
+            return route.routeHandler?.includes(`${LWR_INFO_ROUTE.routeHandler}`);
+        }
+        else if (typeof route.routeHandler === 'string') {
+            return route.routeHandler === LWR_INFO_ROUTE.routeHandler;
+        }
+    }
+    return false;
+}
+/*
  * Run `initConfigs` hooks
  *
  * @remarks
@@ -29,11 +41,24 @@ export async function executeConfigHooks(hooks, globalConfig, runtimeEnvironment
         // eslint-disable-next-line no-await-in-loop
         await hook.initConfigs(globalConfig, globalData, runtimeEnvironment);
     }
-    const hasInfoRoute = globalConfig.routes.some(route => route.id === LWR_INFO_ROUTE.id);
+    // Check if /lwr-info was redefined
+    let filteredRoutes = globalConfig.routes.filter(e => e.path !== "/lwr-info" || isInfoRoute(e));
+    if (filteredRoutes.length < globalConfig.routes.length) {
+        logger.warn({
+            label: 'config hooks',
+            message: 'config hook attempted to redefine protected /lwr-info path',
+        });
+    }
+    // Check if /lwr-info was removed
+    const hasInfoRoute = filteredRoutes.some(route => isInfoRoute(route));
     if (!hasInfoRoute) {
-        globalConfig.routes = [...globalConfig.routes, LWR_INFO_ROUTE];
+        filteredRoutes = [LWR_INFO_ROUTE, ...filteredRoutes];
+        logger.warn({
+            label: 'config hooks',
+            message: 'config hook attempted to remove /lwr-info route',
+        });
     }
-    globalConfig.routes = normalizeRoutes(globalConfig.routes, globalConfig.routeHandlers);
+    globalConfig.routes = normalizeRoutes(filteredRoutes, globalConfig.routeHandlers);
     globalConfig.errorRoutes = normalizeRoutes(globalConfig.errorRoutes, globalConfig.routeHandlers);
     if (!skipValidate) {
         validateLwrAppConfig(globalConfig, 'post');
@@ -77,12 +102,24 @@ export function executeStartHooks(hooks, globalConfig, runtimeEnvironment, skipV
         globalConfig.routes = (onStartConfig.routes || []);
         globalConfig.errorRoutes = (onStartConfig.errorRoutes || []);
     }
-    // Check if Info Route was removed
-    const hasInfoRoute = globalConfig.routes.some(route => route.id === LWR_INFO_ROUTE.id);
+    // Check if /lwr-info was redefined
+    let filteredRoutes = globalConfig.routes.filter(e => e.path !== "/lwr-info" || isInfoRoute(e));
+    if (filteredRoutes.length < globalConfig.routes.length) {
+        logger.warn({
+            label: 'start hooks',
+            message: 'onStart hook attempted to redefine protected /lwr-info path',
+        });
+    }
+    // Check if /lwr-info was removed
+    const hasInfoRoute = filteredRoutes.some(route => isInfoRoute(route));
     if (!hasInfoRoute) {
-        globalConfig.routes = [...globalConfig.routes, LWR_INFO_ROUTE];
+        filteredRoutes = [LWR_INFO_ROUTE, ...filteredRoutes];
+        logger.warn({
+            label: 'start hooks',
+            message: 'onStart hook attempted to remove /lwr-info route',
+        });
     }
-    globalConfig.routes = normalizeRoutes(globalConfig.routes, globalConfig.routeHandlers);
+    globalConfig.routes = normalizeRoutes(filteredRoutes, globalConfig.routeHandlers);
     globalConfig.errorRoutes = normalizeRoutes(globalConfig.errorRoutes, globalConfig.routeHandlers);
     if (!skipValidate) {
         validateLwrAppConfig(globalConfig, 'post');

package/build/es/validation/app-config.js

@@ -356,6 +356,9 @@ export function validateLwrAppConfig(config, phase) {
         if (validationContext.diagnostics.length) {
             throw new LwrConfigValidationError(`Configuration validation errors in ${SOURCE_BY_PHASE[phase]}`, validationContext.diagnostics);
         }
+        if (phase === 'file' && jsonSourceText.includes("/lwr-info")) {
+            logger.warn({ label: `config`, message: `LWR Config file attempted to override "/lwr-info" path` });
+        }
         span.end();
         return;
     }

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.12.0-alpha.29",
+    "version": "0.12.0-alpha.30",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -42,14 +42,14 @@
         "test": "jest"
     },
     "dependencies": {
-        "@lwrjs/diagnostics": "0.12.0-alpha.29",
-        "@lwrjs/instrumentation": "0.12.0-alpha.29",
-        "@lwrjs/shared-utils": "0.12.0-alpha.29",
+        "@lwrjs/diagnostics": "0.12.0-alpha.30",
+        "@lwrjs/instrumentation": "0.12.0-alpha.30",
+        "@lwrjs/shared-utils": "0.12.0-alpha.30",
         "fs-extra": "^11.2.0",
         "jsonc-parser": "^3.2.1"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.12.0-alpha.29",
+        "@lwrjs/types": "0.12.0-alpha.30",
         "jest": "^26.6.3",
         "ts-jest": "^26.5.6"
     },
@@ -70,5 +70,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "452c6d4343b2139e03147100eec8aed7d17d7c51"
+    "gitHead": "5273cb7ece90a3a28645cb1dfde9d315548605db"
 }