ModuleChunkLoadingRuntimeModule.js 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. */
  4. "use strict";
  5. const { SyncWaterfallHook } = require("tapable");
  6. const Compilation = require("../Compilation");
  7. const RuntimeGlobals = require("../RuntimeGlobals");
  8. const RuntimeModule = require("../RuntimeModule");
  9. const Template = require("../Template");
  10. const {
  11. getChunkFilenameTemplate,
  12. chunkHasJs
  13. } = require("../javascript/JavascriptModulesPlugin");
  14. const { getInitialChunkIds } = require("../javascript/StartupHelpers");
  15. const compileBooleanMatcher = require("../util/compileBooleanMatcher");
  16. const { getUndoPath } = require("../util/identifier");
  17. /** @typedef {import("../Chunk")} Chunk */
  18. /** @typedef {import("../ChunkGraph")} ChunkGraph */
  19. /**
  20. * @typedef {Object} JsonpCompilationPluginHooks
  21. * @property {SyncWaterfallHook<[string, Chunk]>} linkPreload
  22. * @property {SyncWaterfallHook<[string, Chunk]>} linkPrefetch
  23. */
  24. /** @type {WeakMap<Compilation, JsonpCompilationPluginHooks>} */
  25. const compilationHooksMap = new WeakMap();
  26. class ModuleChunkLoadingRuntimeModule extends RuntimeModule {
  27. /**
  28. * @param {Compilation} compilation the compilation
  29. * @returns {JsonpCompilationPluginHooks} hooks
  30. */
  31. static getCompilationHooks(compilation) {
  32. if (!(compilation instanceof Compilation)) {
  33. throw new TypeError(
  34. "The 'compilation' argument must be an instance of Compilation"
  35. );
  36. }
  37. let hooks = compilationHooksMap.get(compilation);
  38. if (hooks === undefined) {
  39. hooks = {
  40. linkPreload: new SyncWaterfallHook(["source", "chunk"]),
  41. linkPrefetch: new SyncWaterfallHook(["source", "chunk"])
  42. };
  43. compilationHooksMap.set(compilation, hooks);
  44. }
  45. return hooks;
  46. }
  47. /**
  48. * @param {ReadonlySet<string>} runtimeRequirements runtime requirements
  49. */
  50. constructor(runtimeRequirements) {
  51. super("import chunk loading", RuntimeModule.STAGE_ATTACH);
  52. this._runtimeRequirements = runtimeRequirements;
  53. }
  54. /**
  55. * @private
  56. * @param {Chunk} chunk chunk
  57. * @param {string} rootOutputDir root output directory
  58. * @returns {string} generated code
  59. */
  60. _generateBaseUri(chunk, rootOutputDir) {
  61. const options = chunk.getEntryOptions();
  62. if (options && options.baseUri) {
  63. return `${RuntimeGlobals.baseURI} = ${JSON.stringify(options.baseUri)};`;
  64. }
  65. const compilation = /** @type {Compilation} */ (this.compilation);
  66. const {
  67. outputOptions: { importMetaName }
  68. } = compilation;
  69. return `${RuntimeGlobals.baseURI} = new URL(${JSON.stringify(
  70. rootOutputDir
  71. )}, ${importMetaName}.url);`;
  72. }
  73. /**
  74. * @returns {string | null} runtime code
  75. */
  76. generate() {
  77. const compilation = /** @type {Compilation} */ (this.compilation);
  78. const chunkGraph = /** @type {ChunkGraph} */ (this.chunkGraph);
  79. const chunk = /** @type {Chunk} */ (this.chunk);
  80. const {
  81. runtimeTemplate,
  82. outputOptions: { importFunctionName }
  83. } = compilation;
  84. const fn = RuntimeGlobals.ensureChunkHandlers;
  85. const withBaseURI = this._runtimeRequirements.has(RuntimeGlobals.baseURI);
  86. const withExternalInstallChunk = this._runtimeRequirements.has(
  87. RuntimeGlobals.externalInstallChunk
  88. );
  89. const withLoading = this._runtimeRequirements.has(
  90. RuntimeGlobals.ensureChunkHandlers
  91. );
  92. const withOnChunkLoad = this._runtimeRequirements.has(
  93. RuntimeGlobals.onChunksLoaded
  94. );
  95. const withHmr = this._runtimeRequirements.has(
  96. RuntimeGlobals.hmrDownloadUpdateHandlers
  97. );
  98. const conditionMap = chunkGraph.getChunkConditionMap(chunk, chunkHasJs);
  99. const hasJsMatcher = compileBooleanMatcher(conditionMap);
  100. const initialChunkIds = getInitialChunkIds(chunk, chunkGraph, chunkHasJs);
  101. const outputName = compilation.getPath(
  102. getChunkFilenameTemplate(chunk, compilation.outputOptions),
  103. {
  104. chunk,
  105. contentHashType: "javascript"
  106. }
  107. );
  108. const rootOutputDir = getUndoPath(
  109. outputName,
  110. /** @type {string} */ (compilation.outputOptions.path),
  111. true
  112. );
  113. const stateExpression = withHmr
  114. ? `${RuntimeGlobals.hmrRuntimeStatePrefix}_module`
  115. : undefined;
  116. return Template.asString([
  117. withBaseURI
  118. ? this._generateBaseUri(chunk, rootOutputDir)
  119. : "// no baseURI",
  120. "",
  121. "// object to store loaded and loading chunks",
  122. "// undefined = chunk not loaded, null = chunk preloaded/prefetched",
  123. "// [resolve, Promise] = chunk loading, 0 = chunk loaded",
  124. `var installedChunks = ${
  125. stateExpression ? `${stateExpression} = ${stateExpression} || ` : ""
  126. }{`,
  127. Template.indent(
  128. Array.from(initialChunkIds, id => `${JSON.stringify(id)}: 0`).join(
  129. ",\n"
  130. )
  131. ),
  132. "};",
  133. "",
  134. withLoading || withExternalInstallChunk
  135. ? `var installChunk = ${runtimeTemplate.basicFunction("data", [
  136. runtimeTemplate.destructureObject(
  137. ["ids", "modules", "runtime"],
  138. "data"
  139. ),
  140. '// add "modules" to the modules object,',
  141. '// then flag all "ids" as loaded and fire callback',
  142. "var moduleId, chunkId, i = 0;",
  143. "for(moduleId in modules) {",
  144. Template.indent([
  145. `if(${RuntimeGlobals.hasOwnProperty}(modules, moduleId)) {`,
  146. Template.indent(
  147. `${RuntimeGlobals.moduleFactories}[moduleId] = modules[moduleId];`
  148. ),
  149. "}"
  150. ]),
  151. "}",
  152. `if(runtime) runtime(${RuntimeGlobals.require});`,
  153. "for(;i < ids.length; i++) {",
  154. Template.indent([
  155. "chunkId = ids[i];",
  156. `if(${RuntimeGlobals.hasOwnProperty}(installedChunks, chunkId) && installedChunks[chunkId]) {`,
  157. Template.indent("installedChunks[chunkId][0]();"),
  158. "}",
  159. "installedChunks[ids[i]] = 0;"
  160. ]),
  161. "}",
  162. withOnChunkLoad ? `${RuntimeGlobals.onChunksLoaded}();` : ""
  163. ])}`
  164. : "// no install chunk",
  165. "",
  166. withLoading
  167. ? Template.asString([
  168. `${fn}.j = ${runtimeTemplate.basicFunction(
  169. "chunkId, promises",
  170. hasJsMatcher !== false
  171. ? Template.indent([
  172. "// import() chunk loading for javascript",
  173. `var installedChunkData = ${RuntimeGlobals.hasOwnProperty}(installedChunks, chunkId) ? installedChunks[chunkId] : undefined;`,
  174. 'if(installedChunkData !== 0) { // 0 means "already installed".',
  175. Template.indent([
  176. "",
  177. '// a Promise means "currently loading".',
  178. "if(installedChunkData) {",
  179. Template.indent([
  180. "promises.push(installedChunkData[1]);"
  181. ]),
  182. "} else {",
  183. Template.indent([
  184. hasJsMatcher === true
  185. ? "if(true) { // all chunks have JS"
  186. : `if(${hasJsMatcher("chunkId")}) {`,
  187. Template.indent([
  188. "// setup Promise in chunk cache",
  189. `var promise = ${importFunctionName}(${JSON.stringify(
  190. rootOutputDir
  191. )} + ${
  192. RuntimeGlobals.getChunkScriptFilename
  193. }(chunkId)).then(installChunk, ${runtimeTemplate.basicFunction(
  194. "e",
  195. [
  196. "if(installedChunks[chunkId] !== 0) installedChunks[chunkId] = undefined;",
  197. "throw e;"
  198. ]
  199. )});`,
  200. `var promise = Promise.race([promise, new Promise(${runtimeTemplate.expressionFunction(
  201. `installedChunkData = installedChunks[chunkId] = [resolve]`,
  202. "resolve"
  203. )})])`,
  204. `promises.push(installedChunkData[1] = promise);`
  205. ]),
  206. hasJsMatcher === true
  207. ? "}"
  208. : "} else installedChunks[chunkId] = 0;"
  209. ]),
  210. "}"
  211. ]),
  212. "}"
  213. ])
  214. : Template.indent(["installedChunks[chunkId] = 0;"])
  215. )};`
  216. ])
  217. : "// no chunk on demand loading",
  218. "",
  219. withExternalInstallChunk
  220. ? Template.asString([
  221. `${RuntimeGlobals.externalInstallChunk} = installChunk;`
  222. ])
  223. : "// no external install chunk",
  224. "",
  225. withOnChunkLoad
  226. ? `${
  227. RuntimeGlobals.onChunksLoaded
  228. }.j = ${runtimeTemplate.returningFunction(
  229. "installedChunks[chunkId] === 0",
  230. "chunkId"
  231. )};`
  232. : "// no on chunks loaded"
  233. ]);
  234. }
  235. }
  236. module.exports = ModuleChunkLoadingRuntimeModule;