@lwrjs/loader 0.6.0-alpha.13 → 0.6.0-alpha.14

package/build/assets/prod/lwr-loader-shim-legacy.bundle.js

@@ -4,244 +4,307 @@
 * SPDX-License-Identifier: MIT
 * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
 */
-/* LWR Legacy Module Loader Shim v0.6.0-alpha.13 */
+/* LWR Legacy Module Loader Shim v0.6.0-alpha.14 */
 (function () {
-    'use strict';
+  'use strict';
 
-    function createLoader(name, definition, baseUrl, externalModules) {
-        if (!definition || typeof definition[2] !== 'function') {
-            throw new Error(`Expected loader with specifier "${name}" to be a module`);
-        }
-        // Create a Loader instance
-        const exports = {};
-        definition[2].call(null, exports);
-        const { Loader } = exports;
-        const loader = new Loader(baseUrl);
-        // register externally loaded modules
-        if (externalModules && externalModules.length) {
-            loader.registerExternalModules(externalModules);
-        }
-        // Define the loader module with public API: { define, load, services }
-        const exporter = (exports) => {
-            Object.assign(exports, {
-                define: loader.define.bind(loader),
-                load: loader.load.bind(loader),
-                services: loader.services,
-            });
-            return;
-        };
-        loader.define(name, ['exports'], exporter, definition[3]);
-        return loader;
-    }
+  // Bootstrap / shim
+  const BOOTSTRAP_PREFIX = 'lwr.bootstrap.';
+  const BOOTSTRAP_ERROR = `${BOOTSTRAP_PREFIX}error`;
 
-    const REQUIRED_MODULES_TIMEOUT = 300 * 1000;
+  var Phase;
 
-    var Phase;
+  (function (Phase) {
+    Phase[Phase["Start"] = 0] = "Start";
+    Phase[Phase["End"] = 1] = "End";
+  })(Phase || (Phase = {}));
 
-    (function (Phase) {
-      Phase[Phase["Start"] = 0] = "Start";
-      Phase[Phase["End"] = 1] = "End";
-    })(Phase || (Phase = {}));
-    function attachDispatcher(dispatcher) {
-    } // Check if the Performance API is available
+  // Attach a custom dispatcher
+  let customDispatcher;
+  function attachDispatcher(dispatcher) {
+    customDispatcher = dispatcher;
+  } // Check if the Performance API is available
+  // e.g. JSDom (used in Jest) doesn't implement these
 
-    // Check for errors with autoBoot and customInit
-    function validatePreInit(autoBoot, customInit) {
-        // If autoBoot === false, there must be a customInit hook
-        if (!autoBoot && !customInit) {
-            throw new Error('The customInit hook is required when autoBoot is false');
-        }
-        // If autoBoot === true, there must NOT be a customInit hook
-        if (autoBoot && customInit) {
-            throw new Error('The customInit hook must not be defined when autoBoot is true');
-        }
-    }
-    // Process the customInit hook
-    function customInit(config, initializeApp, define, onBootstrapError) {
-        // Validate config
-        const { autoBoot, customInit } = config;
-        validatePreInit(autoBoot, customInit);
-        // Set up arguments and call the customInit hook, if available
-        if (customInit) {
-            const lwr = {
-                initializeApp,
-                define,
-                onBootstrapError,
-                attachDispatcher,
-            };
-            customInit(lwr, config);
-        }
-    }
+  const perf = globalThis.performance;
+  const isPerfSupported = typeof perf !== 'undefined' && typeof perf.mark === 'function' && typeof perf.clearMarks === 'function' && typeof perf.measure === 'function' && typeof perf.clearMeasures === 'function'; // For marking request metrics
+  // Fallback to the Performance API if there is no custom dispatcher
 
-    /* global document */
-    /* eslint-disable lwr/no-unguarded-apis */
-    const hasSetTimeout = typeof setTimeout === 'function';
-    const hasConsole = typeof console !== 'undefined';
-    /* eslint-enable lwr/no-unguarded-apis */
-    class LoaderShim {
-        constructor(global) {
-            this.defineCache = {};
-            this.orderedDefs = [];
-            // Parse configuration
-            this.global = global;
-            this.config = global.LWR;
-            this.loaderModule = 'lwr/loaderLegacy/v/0_6_0-alpha_13';
-            // Set up the temporary LWR.define function and customInit hook
-            const tempDefine = this.tempDefine.bind(this);
-            global.LWR.define = tempDefine;
-            this.bootReady = this.config.autoBoot;
-            // Start watchdog timer
-            if (hasSetTimeout) {
-                this.watchdogTimerId = this.startWatchdogTimer();
-            }
-            try {
-                customInit(Object.freeze(this.config), this.postCustomInit.bind(this), tempDefine, (e) => {
-                    this.errorHandler = e;
-                });
-            }
-            catch (e) {
-                this.enterErrorState(e);
-            }
-        }
-        // Return true if the app can be initialized
-        canInit() {
-            // Initialize the app if:
-            //  - bootReady: autoBoot is on OR customInit has finished
-            //  - all required modules are defined
-            const allDefined = this.config.requiredModules.every((m) => this.orderedDefs.includes(m));
-            return this.bootReady && allDefined;
-        }
-        /**
-         * Create a temporary LWR.define() function which captures all
-         * calls that occur BEFORE the full loader module is available
-         *
-         * Each call to LWR.define() is stored in 2 ways:
-         *      - in a map as [moduleName, arguments] pairs
-         *      - each moduleName is pushed onto an array, to preserve
-         *          the order in which the modules were defined
-         */
-        tempDefine(...args) {
-            // Cache the incoming module
-            const moduleName = args[0];
-            this.defineCache[moduleName] = args;
-            this.orderedDefs.push(moduleName);
-            if (this.canInit()) {
-                if (hasSetTimeout) {
-                    // requiredModules are defined, clear watchdog timer
-                    // eslint-disable-next-line lwr/no-unguarded-apis, no-undef
-                    clearTimeout(this.watchdogTimerId);
-                }
-                this.initApp();
-            }
-        }
-        // Called by the customInit hook via lwr.initializeApp()
-        postCustomInit() {
-            this.bootReady = true;
-            if (this.canInit()) {
-                this.initApp();
-            }
-        }
-        // Create the loader and initialize the application
-        initApp() {
-            try {
-                const loader = createLoader(this.loaderModule, this.defineCache[this.loaderModule], this.config.baseUrl, this.config.preloadModules);
-                this.mountApp(loader);
-            }
-            catch (e) {
-                this.enterErrorState(e);
-            }
-        }
-        waitForDOMContentLoaded() {
-            // eslint-disable-next-line lwr/no-unguarded-apis
-            if (typeof document === undefined) {
-                return Promise.resolve();
-            }
-            // Resolve if document is already "ready" https://developer.mozilla.org/en-US/docs/Web/API/Document/readyState
-            // eslint-disable-next-line lwr/no-unguarded-apis
-            if (document.readyState === 'interactive' || document.readyState === 'complete') {
-                return Promise.resolve();
-            }
-            return new Promise((resolve) => {
-                // eslint-disable-next-line lwr/no-unguarded-apis
-                document.addEventListener('DOMContentLoaded', () => {
-                    resolve();
-                });
-            });
-        }
-        // Set up the application globals, import map, root custom element...
-        mountApp(loader) {
-            const { bootstrapModule, rootComponent, importMappings, rootComponents, endpoints } = this.config;
-            // Set global LWR.define to loader.define
-            this.global.LWR = Object.freeze({
-                define: loader.define.bind(loader),
-                rootComponent,
-                rootComponents,
-                importMappings,
-                endpoints,
-            });
-            // Redefine all modules in the temporary cache
-            this.orderedDefs.forEach((specifier) => {
-                if (specifier !== this.loaderModule) {
-                    loader.define(...this.defineCache[specifier]);
-                }
-            });
-            // Define a dummy profiler since the "lwr/profiler" module is used in "lwr/init" (which is global to all server modes)
-            const profilerExporter = (exports) => {
-                Object.assign(exports, {
-                    logOperationStart: () => {
-                        /* noop */
-                    },
-                });
-                return;
-            };
-            loader.define('lwr/profiler/v/0_6_0-alpha_13', ['exports'], profilerExporter, {});
-            // by default, app initialization is gated on waiting for document to be parsed (via DOMContentLoaded)
-            const { disableInitDefer } = this.config;
-            // Load the import mappings and application bootstrap module
-            loader
-                .registerImportMappings(importMappings)
-                .then(() => {
-                if (!disableInitDefer) {
-                    return this.waitForDOMContentLoaded();
-                }
-            })
-                .then(() => loader.load(bootstrapModule))
-                .catch((reason) => {
-                this.enterErrorState(new Error(`Application ${rootComponent} could not be loaded: ${reason}`));
-            });
-        }
-        // Trigger bootstrap error state, and call error handler if registered
-        enterErrorState(error) {
-            if (this.errorHandler) {
-                this.errorHandler(error);
-            }
-            else {
-                if (hasConsole) {
-                    // eslint-disable-next-line lwr/no-unguarded-apis, no-undef
-                    console.error(`An error occurred during LWR bootstrap. ${error.message}`, error.stack);
-                }
-            }
-        }
-        // eslint-disable-next-line no-undef, lwr/no-unguarded-apis
-        startWatchdogTimer() {
-            // eslint-disable-next-line lwr/no-unguarded-apis, no-undef
-            return setTimeout(() => {
-                this.enterErrorState(new Error('Failed to load required modules - timed out'));
-            }, REQUIRED_MODULES_TIMEOUT);
-        }
+  function logOperationStart({
+    id,
+    specifier
+  }) {
+    if (customDispatcher) {
+      customDispatcher({
+        id,
+        phase: Phase.Start,
+        specifier
+      });
+    } else if (isPerfSupported) {
+      perf.mark(id + (specifier ? `.${specifier}` : ''));
     }
+  } // For measuring duration metrics
+  // Fallback to the Performance API if there is no custom dispatcher
+
+  /* istanbul ignore next */
 
-    // The loader module is ALWAYS required
-    const GLOBAL = globalThis;
-    GLOBAL.LWR.requiredModules = GLOBAL.LWR.requiredModules || [];
-    if (GLOBAL.LWR.requiredModules.indexOf('lwr/loaderLegacy/v/0_6_0-alpha_13') < 0) {
-        GLOBAL.LWR.requiredModules.push('lwr/loaderLegacy/v/0_6_0-alpha_13');
+  function logOperationEnd({
+    id,
+    specifier
+  }) {
+    if (customDispatcher) {
+      customDispatcher({
+        id,
+        phase: Phase.End,
+        specifier
+      });
+    } else if (isPerfSupported) {
+      const suffix = specifier ? `.${specifier}` : '';
+      const markName = id + suffix;
+      const measureName = `${id}.duration${suffix}`;
+      perf.measure(measureName, markName); // Clear the created mark and measure to avoid filling the performance entry buffer
+      // Even if they get deleted, existing PerformanceObservers preserve copies of the entries
+
+      perf.clearMarks(markName);
+      perf.clearMeasures(measureName);
     }
-    new LoaderShim(GLOBAL);
+  }
+
+  function createLoader(name, definition, config, externalModules) {
+      if (!definition || typeof definition[2] !== 'function') {
+          throw new Error(`Expected loader with specifier "${name}" to be a module`);
+      }
+      // Create a Loader instance
+      const exports = {};
+      definition[2].call(null, exports);
+      const { Loader } = exports;
+      const loader = new Loader(config);
+      // register externally loaded modules
+      if (externalModules && externalModules.length) {
+          loader.registerExternalModules(externalModules);
+      }
+      // Define the loader module with public API: { define, load, services }
+      const exporter = (exports) => {
+          Object.assign(exports, {
+              define: loader.define.bind(loader),
+              load: loader.load.bind(loader),
+              services: loader.services,
+          });
+          return;
+      };
+      loader.define(name, ['exports'], exporter, definition[3]);
+      return loader;
+  }
+
+  const REQUIRED_MODULES_TIMEOUT = 300 * 1000;
+
+  // Check for errors with autoBoot and customInit
+  function validatePreInit(autoBoot, customInit) {
+      // If autoBoot === false, there must be a customInit hook
+      if (!autoBoot && !customInit) {
+          throw new Error('The customInit hook is required when autoBoot is false');
+      }
+      // If autoBoot === true, there must NOT be a customInit hook
+      if (autoBoot && customInit) {
+          throw new Error('The customInit hook must not be defined when autoBoot is true');
+      }
+  }
+  // Process the customInit hook
+  function customInit(config, initializeApp, define, onBootstrapError) {
+      // Validate config
+      const { autoBoot, customInit } = config;
+      validatePreInit(autoBoot, customInit);
+      // Set up arguments and call the customInit hook, if available
+      if (customInit) {
+          const lwr = {
+              initializeApp,
+              define,
+              onBootstrapError,
+              attachDispatcher,
+          };
+          customInit(lwr, config);
+      }
+  }
+
+  /* global document */
+  /* eslint-disable lwr/no-unguarded-apis */
+  const hasSetTimeout = typeof setTimeout === 'function';
+  const hasConsole = typeof console !== 'undefined';
+  /* eslint-enable lwr/no-unguarded-apis */
+  class LoaderShim {
+      constructor(global) {
+          this.defineCache = {};
+          this.orderedDefs = [];
+          // Parse configuration
+          this.global = global;
+          this.config = global.LWR;
+          this.loaderModule = 'lwr/loaderLegacy/v/0_6_0-alpha_14';
+          // Set up the temporary LWR.define function and customInit hook
+          const tempDefine = this.tempDefine.bind(this);
+          global.LWR.define = tempDefine;
+          this.bootReady = this.config.autoBoot;
+          // Start watchdog timer
+          if (hasSetTimeout) {
+              this.watchdogTimerId = this.startWatchdogTimer();
+          }
+          try {
+              customInit(Object.freeze(this.config), this.postCustomInit.bind(this), tempDefine, (e) => {
+                  this.errorHandler = e;
+              });
+          }
+          catch (e) {
+              this.enterErrorState(e);
+          }
+      }
+      // Return true if the app can be initialized
+      canInit() {
+          // Initialize the app if:
+          //  - bootReady: autoBoot is on OR customInit has finished
+          //  - all required modules are defined
+          const allDefined = this.config.requiredModules.every((m) => this.orderedDefs.includes(m));
+          return this.bootReady && allDefined;
+      }
+      /**
+       * Create a temporary LWR.define() function which captures all
+       * calls that occur BEFORE the full loader module is available
+       *
+       * Each call to LWR.define() is stored in 2 ways:
+       *      - in a map as [moduleName, arguments] pairs
+       *      - each moduleName is pushed onto an array, to preserve
+       *          the order in which the modules were defined
+       */
+      tempDefine(...args) {
+          // Cache the incoming module
+          const moduleName = args[0];
+          this.defineCache[moduleName] = args;
+          this.orderedDefs.push(moduleName);
+          if (this.canInit()) {
+              if (hasSetTimeout) {
+                  // requiredModules are defined, clear watchdog timer
+                  // eslint-disable-next-line lwr/no-unguarded-apis, no-undef
+                  clearTimeout(this.watchdogTimerId);
+              }
+              this.initApp();
+          }
+      }
+      // Called by the customInit hook via lwr.initializeApp()
+      postCustomInit() {
+          this.bootReady = true;
+          if (this.canInit()) {
+              this.initApp();
+          }
+      }
+      // Create the loader and initialize the application
+      initApp() {
+          try {
+              const loaderConfig = {
+                  baseUrl: this.config.baseUrl,
+                  profiler: { logOperationStart, logOperationEnd },
+                  // TODO: can be removed following https://github.com/salesforce/lwr/issues/1087
+                  appMetadata: {
+                      bootstrapModule: this.config.bootstrapModule,
+                      rootComponent: this.config.rootComponent,
+                      rootComponents: this.config.rootComponents,
+                  },
+              };
+              const loader = createLoader(this.loaderModule, this.defineCache[this.loaderModule], loaderConfig, this.config.preloadModules);
+              this.createProfilerModule(loader);
+              this.mountApp(loader);
+          }
+          catch (e) {
+              this.enterErrorState(e);
+          }
+      }
+      waitForDOMContentLoaded() {
+          // eslint-disable-next-line lwr/no-unguarded-apis
+          if (typeof document === undefined) {
+              return Promise.resolve();
+          }
+          // Resolve if document is already "ready" https://developer.mozilla.org/en-US/docs/Web/API/Document/readyState
+          // eslint-disable-next-line lwr/no-unguarded-apis
+          if (document.readyState === 'interactive' || document.readyState === 'complete') {
+              return Promise.resolve();
+          }
+          return new Promise((resolve) => {
+              // eslint-disable-next-line lwr/no-unguarded-apis
+              document.addEventListener('DOMContentLoaded', () => {
+                  resolve();
+              });
+          });
+      }
+      // Create a module out of the profiler
+      // Note: The profiler is also available as a module through lwc module resolution (see package.json)
+      createProfilerModule(loader) {
+          const exporter = (exports) => {
+              Object.assign(exports, { logOperationStart, logOperationEnd });
+          };
+          loader.define('lwr/profiler/v/0_6_0-alpha_14', ['exports'], exporter, {});
+      }
+      // Set up the application globals, import map, root custom element...
+      mountApp(loader) {
+          const { bootstrapModule, rootComponent, importMappings, rootComponents, endpoints } = this.config;
+          // Set global LWR.define to loader.define
+          this.global.LWR = Object.freeze({
+              define: loader.define.bind(loader),
+              rootComponent,
+              rootComponents,
+              importMappings,
+              endpoints,
+          });
+          // Redefine all modules in the temporary cache
+          this.orderedDefs.forEach((specifier) => {
+              if (specifier !== this.loaderModule) {
+                  loader.define(...this.defineCache[specifier]);
+              }
+          });
+          // by default, app initialization is gated on waiting for document to be parsed (via DOMContentLoaded)
+          const { disableInitDefer } = this.config;
+          // Load the import mappings and application bootstrap module
+          loader
+              .registerImportMappings(importMappings)
+              .then(() => {
+              if (!disableInitDefer) {
+                  return this.waitForDOMContentLoaded();
+              }
+          })
+              .then(() => loader.load(bootstrapModule))
+              .catch((reason) => {
+              this.enterErrorState(new Error(`Application ${rootComponent} could not be loaded: ${reason}`));
+          });
+      }
+      // Trigger bootstrap error state, and call error handler if registered
+      enterErrorState(error) {
+          logOperationStart({ id: BOOTSTRAP_ERROR });
+          if (this.errorHandler) {
+              this.errorHandler(error);
+          }
+          else {
+              if (hasConsole) {
+                  // eslint-disable-next-line lwr/no-unguarded-apis, no-undef
+                  console.error(`An error occurred during LWR bootstrap. ${error.message}`, error.stack);
+              }
+          }
+      }
+      // eslint-disable-next-line no-undef, lwr/no-unguarded-apis
+      startWatchdogTimer() {
+          // eslint-disable-next-line lwr/no-unguarded-apis, no-undef
+          return setTimeout(() => {
+              this.enterErrorState(new Error('Failed to load required modules - timed out'));
+          }, REQUIRED_MODULES_TIMEOUT);
+      }
+  }
+
+  // The loader module is ALWAYS required
+  const GLOBAL = globalThis;
+  GLOBAL.LWR.requiredModules = GLOBAL.LWR.requiredModules || [];
+  if (GLOBAL.LWR.requiredModules.indexOf('lwr/loaderLegacy/v/0_6_0-alpha_14') < 0) {
+      GLOBAL.LWR.requiredModules.push('lwr/loaderLegacy/v/0_6_0-alpha_14');
+  }
+  new LoaderShim(GLOBAL);
 
 }());
 
-LWR.define('lwr/loaderLegacy/v/0_6_0-alpha_13', ['exports'], function (exports) { 'use strict';
+LWR.define('lwr/loaderLegacy/v/0_6_0-alpha_14', ['exports'], function (exports) { 'use strict';
 
     const templateRegex = /\{([0-9]+)\}/g;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -639,14 +702,22 @@ LWR.define('lwr/loaderLegacy/v/0_6_0-alpha_13', ['exports'], function (exports)
         }
     }
 
+    // Bootstrap / shim
+
+    const LOADER_PREFIX = 'lwr.loader.';
+    const MODULE_DEFINE = `${LOADER_PREFIX}module.define`;
+    const MODULE_FETCH = `${LOADER_PREFIX}module.fetch`;
+    const MODULE_ERROR = `${LOADER_PREFIX}module.error`; // Loader: mappings
+
     /* global console,process */
     class ModuleRegistry {
-        constructor(baseUrl) {
+        constructor(config) {
             // A registry for named AMD defines containing the *metadata* of AMD module
             this.namedDefineRegistry = new Map();
             // The evaluted module registry where the module identifier (name or URL?) is the key
             this.moduleRegistry = new Map();
-            this.baseUrl = baseUrl;
+            this.baseUrl = config.baseUrl;
+            this.profiler = config.profiler;
         }
         async load(id, importer) {
             const resolvedId = await this.resolve(id, importer);
@@ -761,6 +832,7 @@ LWR.define('lwr/loaderLegacy/v/0_6_0-alpha_13', ['exports'], function (exports)
                 // if module is "external", resolve the external promise to notify any dependees
                 mod.external.resolveExternal(moduleDef);
             }
+            this.profiler.logOperationStart({ id: MODULE_DEFINE, specifier: name });
             this.namedDefineRegistry.set(name, moduleDef);
             this.lastDefine = moduleDef;
             // Check signatures of dependencies against those in the namedDefineRegistry
@@ -1031,6 +1103,8 @@ LWR.define('lwr/loaderLegacy/v/0_6_0-alpha_13', ['exports'], function (exports)
                 return moduleDef;
             }
             const parentUrl = this.baseUrl; // only support baseUrl for now
+            const specifier = moduleName || originalId;
+            this.profiler.logOperationStart({ id: MODULE_FETCH, specifier });
             return Promise.resolve()
                 .then(async () => {
                 const loadHooks = this.loadHook;
@@ -1068,9 +1142,11 @@ LWR.define('lwr/loaderLegacy/v/0_6_0-alpha_13', ['exports'], function (exports)
                 if (!moduleDef) {
                     throw new LoaderError(FAIL_INSTANTIATE, [resolvedId]);
                 }
+                this.profiler.logOperationEnd({ id: MODULE_FETCH, specifier });
                 return moduleDef;
             })
                 .catch((e) => {
+                this.profiler.logOperationStart({ id: MODULE_ERROR, specifier });
                 throw e;
             });
         }
@@ -1298,7 +1374,10 @@ LWR.define('lwr/loaderLegacy/v/0_6_0-alpha_13', ['exports'], function (exports)
      * The LWR loader is inspired and borrows from the algorithms and native browser principles of https://github.com/systemjs/systemjs
      */
     class Loader {
-        constructor(baseUrl) {
+        constructor(config) {
+            config = config || {};
+            let baseUrl = config.baseUrl;
+            let profiler = config.profiler;
             if (baseUrl) {
                 // add a trailing slash, if it does not exist
                 baseUrl = baseUrl.replace(/\/?$/, '/');
@@ -1310,10 +1389,23 @@ LWR.define('lwr/loaderLegacy/v/0_6_0-alpha_13', ['exports'], function (exports)
                 throw new LoaderError(NO_BASE_URL);
             }
             this.baseUrl = baseUrl;
-            this.registry = new ModuleRegistry(baseUrl);
+            if (!profiler) {
+                // default noop profiler
+                profiler = {
+                    logOperationStart: () => {
+                        /* noop */
+                    },
+                    logOperationEnd: () => {
+                        /* noop */
+                    },
+                };
+            }
+            this.registry = new ModuleRegistry({ baseUrl, profiler });
+            // TODO: https://github.com/salesforce/lwr/issues/1087
             this.services = Object.freeze({
                 addLoaderPlugin: this.registry.addLoaderPlugin.bind(this.registry),
                 handleStaleModule: this.registry.registerHandleStaleModuleHook.bind(this.registry),
+                appMetadata: config.appMetadata,
             });
         }
         /**