123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338 |
- /*
- MIT License http://www.opensource.org/licenses/mit-license.php
- */
- "use strict";
- const { SyncWaterfallHook } = require("tapable");
- const Compilation = require("../Compilation");
- const RuntimeGlobals = require("../RuntimeGlobals");
- const RuntimeModule = require("../RuntimeModule");
- const Template = require("../Template");
- const {
- getChunkFilenameTemplate,
- chunkHasJs
- } = require("../javascript/JavascriptModulesPlugin");
- const { getInitialChunkIds } = require("../javascript/StartupHelpers");
- const compileBooleanMatcher = require("../util/compileBooleanMatcher");
- const { getUndoPath } = require("../util/identifier");
- /** @typedef {import("../Chunk")} Chunk */
- /** @typedef {import("../ChunkGraph")} ChunkGraph */
- /** @typedef {import("../Module").ReadOnlyRuntimeRequirements} ReadOnlyRuntimeRequirements */
- /**
- * @typedef {object} JsonpCompilationPluginHooks
- * @property {SyncWaterfallHook<[string, Chunk]>} linkPreload
- * @property {SyncWaterfallHook<[string, Chunk]>} linkPrefetch
- */
- /** @type {WeakMap<Compilation, JsonpCompilationPluginHooks>} */
- const compilationHooksMap = new WeakMap();
- class ModuleChunkLoadingRuntimeModule extends RuntimeModule {
- /**
- * @param {Compilation} compilation the compilation
- * @returns {JsonpCompilationPluginHooks} hooks
- */
- static getCompilationHooks(compilation) {
- if (!(compilation instanceof Compilation)) {
- throw new TypeError(
- "The 'compilation' argument must be an instance of Compilation"
- );
- }
- let hooks = compilationHooksMap.get(compilation);
- if (hooks === undefined) {
- hooks = {
- linkPreload: new SyncWaterfallHook(["source", "chunk"]),
- linkPrefetch: new SyncWaterfallHook(["source", "chunk"])
- };
- compilationHooksMap.set(compilation, hooks);
- }
- return hooks;
- }
- /**
- * @param {ReadOnlyRuntimeRequirements} runtimeRequirements runtime requirements
- */
- constructor(runtimeRequirements) {
- super("import chunk loading", RuntimeModule.STAGE_ATTACH);
- this._runtimeRequirements = runtimeRequirements;
- }
- /**
- * @private
- * @param {Chunk} chunk chunk
- * @param {string} rootOutputDir root output directory
- * @returns {string} generated code
- */
- _generateBaseUri(chunk, rootOutputDir) {
- const options = chunk.getEntryOptions();
- if (options && options.baseUri) {
- return `${RuntimeGlobals.baseURI} = ${JSON.stringify(options.baseUri)};`;
- }
- const compilation = /** @type {Compilation} */ (this.compilation);
- const {
- outputOptions: { importMetaName }
- } = compilation;
- return `${RuntimeGlobals.baseURI} = new URL(${JSON.stringify(
- rootOutputDir
- )}, ${importMetaName}.url);`;
- }
- /**
- * @returns {string | null} runtime code
- */
- generate() {
- const compilation = /** @type {Compilation} */ (this.compilation);
- const chunkGraph = /** @type {ChunkGraph} */ (this.chunkGraph);
- const chunk = /** @type {Chunk} */ (this.chunk);
- const {
- runtimeTemplate,
- outputOptions: { environment, importFunctionName, crossOriginLoading }
- } = compilation;
- const fn = RuntimeGlobals.ensureChunkHandlers;
- const withBaseURI = this._runtimeRequirements.has(RuntimeGlobals.baseURI);
- const withExternalInstallChunk = this._runtimeRequirements.has(
- RuntimeGlobals.externalInstallChunk
- );
- const withLoading = this._runtimeRequirements.has(
- RuntimeGlobals.ensureChunkHandlers
- );
- const withOnChunkLoad = this._runtimeRequirements.has(
- RuntimeGlobals.onChunksLoaded
- );
- const withHmr = this._runtimeRequirements.has(
- RuntimeGlobals.hmrDownloadUpdateHandlers
- );
- const { linkPreload, linkPrefetch } =
- ModuleChunkLoadingRuntimeModule.getCompilationHooks(compilation);
- const withPrefetch =
- environment.document &&
- this._runtimeRequirements.has(RuntimeGlobals.prefetchChunkHandlers);
- const withPreload =
- environment.document &&
- this._runtimeRequirements.has(RuntimeGlobals.preloadChunkHandlers);
- const conditionMap = chunkGraph.getChunkConditionMap(chunk, chunkHasJs);
- const hasJsMatcher = compileBooleanMatcher(conditionMap);
- const initialChunkIds = getInitialChunkIds(chunk, chunkGraph, chunkHasJs);
- const outputName = compilation.getPath(
- getChunkFilenameTemplate(chunk, compilation.outputOptions),
- {
- chunk,
- contentHashType: "javascript"
- }
- );
- const rootOutputDir = getUndoPath(
- outputName,
- /** @type {string} */ (compilation.outputOptions.path),
- true
- );
- const stateExpression = withHmr
- ? `${RuntimeGlobals.hmrRuntimeStatePrefix}_module`
- : undefined;
- return Template.asString([
- withBaseURI
- ? this._generateBaseUri(chunk, rootOutputDir)
- : "// no baseURI",
- "",
- "// object to store loaded and loading chunks",
- "// undefined = chunk not loaded, null = chunk preloaded/prefetched",
- "// [resolve, Promise] = chunk loading, 0 = chunk loaded",
- `var installedChunks = ${
- stateExpression ? `${stateExpression} = ${stateExpression} || ` : ""
- }{`,
- Template.indent(
- Array.from(initialChunkIds, id => `${JSON.stringify(id)}: 0`).join(
- ",\n"
- )
- ),
- "};",
- "",
- withLoading || withExternalInstallChunk
- ? `var installChunk = ${runtimeTemplate.basicFunction("data", [
- runtimeTemplate.destructureObject(
- ["ids", "modules", "runtime"],
- "data"
- ),
- '// add "modules" to the modules object,',
- '// then flag all "ids" as loaded and fire callback',
- "var moduleId, chunkId, i = 0;",
- "for(moduleId in modules) {",
- Template.indent([
- `if(${RuntimeGlobals.hasOwnProperty}(modules, moduleId)) {`,
- Template.indent(
- `${RuntimeGlobals.moduleFactories}[moduleId] = modules[moduleId];`
- ),
- "}"
- ]),
- "}",
- `if(runtime) runtime(${RuntimeGlobals.require});`,
- "for(;i < ids.length; i++) {",
- Template.indent([
- "chunkId = ids[i];",
- `if(${RuntimeGlobals.hasOwnProperty}(installedChunks, chunkId) && installedChunks[chunkId]) {`,
- Template.indent("installedChunks[chunkId][0]();"),
- "}",
- "installedChunks[ids[i]] = 0;"
- ]),
- "}",
- withOnChunkLoad ? `${RuntimeGlobals.onChunksLoaded}();` : ""
- ])}`
- : "// no install chunk",
- "",
- withLoading
- ? Template.asString([
- `${fn}.j = ${runtimeTemplate.basicFunction(
- "chunkId, promises",
- hasJsMatcher !== false
- ? Template.indent([
- "// import() chunk loading for javascript",
- `var installedChunkData = ${RuntimeGlobals.hasOwnProperty}(installedChunks, chunkId) ? installedChunks[chunkId] : undefined;`,
- 'if(installedChunkData !== 0) { // 0 means "already installed".',
- Template.indent([
- "",
- '// a Promise means "currently loading".',
- "if(installedChunkData) {",
- Template.indent([
- "promises.push(installedChunkData[1]);"
- ]),
- "} else {",
- Template.indent([
- hasJsMatcher === true
- ? "if(true) { // all chunks have JS"
- : `if(${hasJsMatcher("chunkId")}) {`,
- Template.indent([
- "// setup Promise in chunk cache",
- `var promise = ${importFunctionName}(${JSON.stringify(
- rootOutputDir
- )} + ${
- RuntimeGlobals.getChunkScriptFilename
- }(chunkId)).then(installChunk, ${runtimeTemplate.basicFunction(
- "e",
- [
- "if(installedChunks[chunkId] !== 0) installedChunks[chunkId] = undefined;",
- "throw e;"
- ]
- )});`,
- `var promise = Promise.race([promise, new Promise(${runtimeTemplate.expressionFunction(
- `installedChunkData = installedChunks[chunkId] = [resolve]`,
- "resolve"
- )})])`,
- `promises.push(installedChunkData[1] = promise);`
- ]),
- hasJsMatcher === true
- ? "}"
- : "} else installedChunks[chunkId] = 0;"
- ]),
- "}"
- ]),
- "}"
- ])
- : Template.indent(["installedChunks[chunkId] = 0;"])
- )};`
- ])
- : "// no chunk on demand loading",
- "",
- withPrefetch && hasJsMatcher !== false
- ? `${
- RuntimeGlobals.prefetchChunkHandlers
- }.j = ${runtimeTemplate.basicFunction("chunkId", [
- `if((!${
- RuntimeGlobals.hasOwnProperty
- }(installedChunks, chunkId) || installedChunks[chunkId] === undefined) && ${
- hasJsMatcher === true ? "true" : hasJsMatcher("chunkId")
- }) {`,
- Template.indent([
- "installedChunks[chunkId] = null;",
- linkPrefetch.call(
- Template.asString([
- "var link = document.createElement('link');",
- crossOriginLoading
- ? `link.crossOrigin = ${JSON.stringify(
- crossOriginLoading
- )};`
- : "",
- `if (${RuntimeGlobals.scriptNonce}) {`,
- Template.indent(
- `link.setAttribute("nonce", ${RuntimeGlobals.scriptNonce});`
- ),
- "}",
- 'link.rel = "prefetch";',
- 'link.as = "script";',
- `link.href = ${RuntimeGlobals.publicPath} + ${RuntimeGlobals.getChunkScriptFilename}(chunkId);`
- ]),
- chunk
- ),
- "document.head.appendChild(link);"
- ]),
- "}"
- ])};`
- : "// no prefetching",
- "",
- withPreload && hasJsMatcher !== false
- ? `${
- RuntimeGlobals.preloadChunkHandlers
- }.j = ${runtimeTemplate.basicFunction("chunkId", [
- `if((!${
- RuntimeGlobals.hasOwnProperty
- }(installedChunks, chunkId) || installedChunks[chunkId] === undefined) && ${
- hasJsMatcher === true ? "true" : hasJsMatcher("chunkId")
- }) {`,
- Template.indent([
- "installedChunks[chunkId] = null;",
- linkPreload.call(
- Template.asString([
- "var link = document.createElement('link');",
- "link.charset = 'utf-8';",
- `if (${RuntimeGlobals.scriptNonce}) {`,
- Template.indent(
- `link.setAttribute("nonce", ${RuntimeGlobals.scriptNonce});`
- ),
- "}",
- 'link.rel = "modulepreload";',
- `link.href = ${RuntimeGlobals.publicPath} + ${RuntimeGlobals.getChunkScriptFilename}(chunkId);`,
- crossOriginLoading
- ? crossOriginLoading === "use-credentials"
- ? 'link.crossOrigin = "use-credentials";'
- : Template.asString([
- "if (link.href.indexOf(window.location.origin + '/') !== 0) {",
- Template.indent(
- `link.crossOrigin = ${JSON.stringify(
- crossOriginLoading
- )};`
- ),
- "}"
- ])
- : ""
- ]),
- chunk
- ),
- "document.head.appendChild(link);"
- ]),
- "}"
- ])};`
- : "// no preloaded",
- "",
- withExternalInstallChunk
- ? Template.asString([
- `${RuntimeGlobals.externalInstallChunk} = installChunk;`
- ])
- : "// no external install chunk",
- "",
- withOnChunkLoad
- ? `${
- RuntimeGlobals.onChunksLoaded
- }.j = ${runtimeTemplate.returningFunction(
- "installedChunks[chunkId] === 0",
- "chunkId"
- )};`
- : "// no on chunks loaded"
- ]);
- }
- }
- module.exports = ModuleChunkLoadingRuntimeModule;
|