HotModuleReplacement.runtime.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. /** @typedef {string | number} ModuleId */
  7. /** @typedef {Record<string, unknown>} HotData */
  8. /** @typedef {(data: HotData) => void} DisposeHandler */
  9. /** @typedef {(outdatedDependencies: ModuleId[]) => void} AcceptCallback */
  10. /** @typedef {(err: Error, context: { moduleId: ModuleId, dependencyId?: ModuleId, module?: HotModule }) => void} AcceptErrorHandler */
  11. /** @typedef {(status: string) => (Promise<void> | void)} StatusHandler */
  12. /** @typedef {Record<string, unknown>} ApplyOptions */
  13. /** @typedef {(reportError: (err: Error) => void) => Promise<ModuleId[]>} ApplyFn */
  14. /** @typedef {(chunkId: ModuleId, fetchPriority?: string) => Promise<unknown>} EnsureChunk */
  15. /** @typedef {(chunkId: ModuleId, importFn: () => Promise<unknown>) => Promise<unknown>} AnalyzableChunkImport */
  16. /** @typedef {{ (id: ModuleId): unknown, e?: EnsureChunk, ei?: AnalyzableChunkImport, [name: string]: unknown }} WebpackRequire */
  17. /**
  18. * @typedef {object} ApplyResult
  19. * @property {Error=} error fatal error that aborts the update
  20. * @property {(() => void)=} dispose dispose phase of the update
  21. * @property {ApplyFn=} apply apply phase of the update
  22. */
  23. /** @typedef {(options: ApplyOptions) => ApplyResult} ApplyHandler */
  24. /** @typedef {(moduleId: ModuleId, applyHandlers: ApplyHandler[]) => void} InvalidateModuleHandler */
  25. /** @typedef {(chunkIds: ModuleId[], removedChunks: ModuleId[], removedModules: ModuleId[], promises: Promise<unknown>[], applyHandlers: ApplyHandler[], updatedModulesList: ModuleId[], css: ModuleId[] | undefined, forceLoadChunks: ModuleId[] | undefined) => void} DownloadUpdateHandler */
  26. /**
  27. * @typedef {object} HMRManifest
  28. * @property {ModuleId[]} c updated chunk ids
  29. * @property {ModuleId[]} r removed chunk ids
  30. * @property {ModuleId[]} m removed module ids
  31. * @property {ModuleId[]=} css updated css chunk ids
  32. * @property {ModuleId[]=} f chunk ids to force-load
  33. */
  34. /**
  35. * @typedef {object} HotModule
  36. * @property {ModuleId} id module id
  37. * @property {Hot} hot hot API of the module
  38. * @property {ModuleId[]} parents ids of modules requiring this module
  39. * @property {ModuleId[]} children ids of modules required by this module
  40. */
  41. /**
  42. * @typedef {object} Hot
  43. * @property {Record<ModuleId, AcceptCallback>} _acceptedDependencies accept callbacks by dependency id
  44. * @property {Record<ModuleId, AcceptErrorHandler | undefined>} _acceptedErrorHandlers error handlers by dependency id
  45. * @property {Record<ModuleId, boolean>} _declinedDependencies declined dependency ids
  46. * @property {boolean | EXPECTED_FUNCTION} _selfAccepted true or the self-accept error handler
  47. * @property {boolean} _selfDeclined module declined itself
  48. * @property {boolean} _selfInvalidated module invalidated itself
  49. * @property {DisposeHandler[]} _disposeHandlers registered dispose handlers
  50. * @property {boolean} _main module is the entry of the update
  51. * @property {() => void} _requireSelf re-require the module on apply
  52. * @property {boolean} active module is not disposed
  53. * @property {(dep?: ModuleId | ModuleId[] | AcceptCallback, callback?: AcceptCallback, errorHandler?: AcceptErrorHandler) => void} accept accept updates
  54. * @property {(dep?: ModuleId | ModuleId[]) => void} decline decline updates
  55. * @property {(callback: DisposeHandler) => void} dispose add a dispose handler
  56. * @property {(callback: DisposeHandler) => void} addDisposeHandler add a dispose handler
  57. * @property {(callback: DisposeHandler) => void} removeDisposeHandler remove a dispose handler
  58. * @property {() => void} invalidate invalidate the module
  59. * @property {(applyOnUpdate?: boolean | ApplyOptions) => Promise<ModuleId[] | null>} check check for an update
  60. * @property {(options?: ApplyOptions) => Promise<ModuleId[]>} apply apply a checked update
  61. * @property {(l?: StatusHandler) => string | void} status get status or add a status handler
  62. * @property {(l: StatusHandler) => void} addStatusHandler add a status handler
  63. * @property {(l: StatusHandler) => void} removeStatusHandler remove a status handler
  64. * @property {HotData} data data left from the previous dispose
  65. */
  66. /** @typedef {{ module: HotModule, require: WebpackRequire, id: ModuleId }} InterceptOptions */
  67. // Globals injected by code generation; declared here only to type the template.
  68. /* eslint-disable no-unassigned-vars */
  69. /** @type {((options: InterceptOptions) => void)[]} */
  70. var $interceptModuleExecution$;
  71. /** @type {Record<ModuleId, HotModule>} */
  72. var $moduleCache$;
  73. /** @type {Record<ModuleId, HotData>} */
  74. var $hmrModuleData$;
  75. /** @type {() => Promise<HMRManifest | void>} */
  76. var $hmrDownloadManifest$;
  77. /** @type {Record<string, DownloadUpdateHandler>} */
  78. var $hmrDownloadUpdateHandlers$;
  79. /** @type {Record<string, InvalidateModuleHandler>} */
  80. var $hmrInvalidateModuleHandlers$;
  81. /** @type {(id: ModuleId) => unknown} */
  82. var __webpack_require__;
  83. /* eslint-enable no-unassigned-vars */
  84. module.exports = function () {
  85. /** @type {Record<ModuleId, HotData>} */
  86. var currentModuleData = {};
  87. var installedModules = $moduleCache$;
  88. // module and require creation
  89. /** @type {ModuleId | undefined} */
  90. var currentChildModule;
  91. /** @type {ModuleId[]} */
  92. var currentParents = [];
  93. // status
  94. /** @type {StatusHandler[]} */
  95. var registeredStatusHandlers = [];
  96. var currentStatus = "idle";
  97. // while downloading
  98. var blockingPromises = 0;
  99. /** @type {(() => void)[]} */
  100. var blockingPromisesWaiting = [];
  101. // The update info
  102. /** @type {ApplyHandler[] | undefined} */
  103. var currentUpdateApplyHandlers;
  104. /** @type {ModuleId[] | undefined} */
  105. var queuedInvalidatedModules;
  106. $hmrModuleData$ = currentModuleData;
  107. $interceptModuleExecution$.push(function (options) {
  108. var module = options.module;
  109. var require = createRequire(options.require, options.id);
  110. module.hot = createModuleHotObject(options.id, module);
  111. module.parents = currentParents;
  112. module.children = [];
  113. currentParents = [];
  114. options.require = require;
  115. });
  116. $hmrDownloadUpdateHandlers$ = {};
  117. $hmrInvalidateModuleHandlers$ = {};
  118. /**
  119. * @param {WebpackRequire} require the original require function
  120. * @param {ModuleId} moduleId module id
  121. * @returns {WebpackRequire} hot-aware require function
  122. */
  123. function createRequire(require, moduleId) {
  124. var me = installedModules[moduleId];
  125. if (!me) return require;
  126. /**
  127. * @param {ModuleId} request requested module id
  128. * @returns {unknown} module exports
  129. */
  130. var fn = function (request) {
  131. if (me.hot.active) {
  132. if (installedModules[request]) {
  133. var parents = installedModules[request].parents;
  134. if (parents.indexOf(moduleId) === -1) {
  135. parents.push(moduleId);
  136. }
  137. } else {
  138. currentParents = [moduleId];
  139. currentChildModule = request;
  140. }
  141. if (me.children.indexOf(request) === -1) {
  142. me.children.push(request);
  143. }
  144. } else {
  145. console.warn(
  146. "[HMR] unexpected require(" +
  147. request +
  148. ") from disposed module " +
  149. moduleId
  150. );
  151. currentParents = [];
  152. }
  153. return require(request);
  154. };
  155. /**
  156. * @param {string} name property name
  157. * @returns {PropertyDescriptor} descriptor forwarding to require
  158. */
  159. var createPropertyDescriptor = function (name) {
  160. return {
  161. configurable: true,
  162. enumerable: true,
  163. get: function () {
  164. return require[name];
  165. },
  166. set: function (value) {
  167. require[name] = value;
  168. }
  169. };
  170. };
  171. for (var name in require) {
  172. if (
  173. Object.prototype.hasOwnProperty.call(require, name) &&
  174. name !== "e" &&
  175. name !== "ei"
  176. ) {
  177. Object.defineProperty(fn, name, createPropertyDescriptor(name));
  178. }
  179. }
  180. // A chunk load blocks the update until it settles, and `.ei` is the analyzable
  181. // half of `.e`. A runtime that loads no chunks has neither to wrap.
  182. if (require.e) {
  183. /** @type {WebpackRequire} */ (fn).e = function (chunkId, fetchPriority) {
  184. return trackBlockingPromise(
  185. /** @type {EnsureChunk} */ (require.e)(chunkId, fetchPriority)
  186. );
  187. };
  188. }
  189. if (require.ei) {
  190. /** @type {WebpackRequire} */ (fn).ei = function (chunkId, importFn) {
  191. return trackBlockingPromise(
  192. /** @type {AnalyzableChunkImport} */ (require.ei)(chunkId, importFn)
  193. );
  194. };
  195. }
  196. return /** @type {WebpackRequire} */ (fn);
  197. }
  198. /**
  199. * @param {ModuleId} moduleId module id
  200. * @param {HotModule} me the module
  201. * @returns {Hot} hot API
  202. */
  203. function createModuleHotObject(moduleId, me) {
  204. var _main = currentChildModule !== moduleId;
  205. /** @type {Hot} */
  206. var hot = {
  207. // private stuff
  208. _acceptedDependencies: {},
  209. _acceptedErrorHandlers: {},
  210. _declinedDependencies: {},
  211. _selfAccepted: false,
  212. _selfDeclined: false,
  213. _selfInvalidated: false,
  214. _disposeHandlers: [],
  215. _main: _main,
  216. _requireSelf: function () {
  217. currentParents = me.parents.slice();
  218. currentChildModule = _main ? undefined : moduleId;
  219. __webpack_require__(moduleId);
  220. },
  221. // Module API
  222. active: true,
  223. accept: function (dep, callback, errorHandler) {
  224. if (dep === undefined) hot._selfAccepted = true;
  225. else if (typeof dep === "function") hot._selfAccepted = dep;
  226. else if (typeof dep === "object" && dep !== null) {
  227. for (var i = 0; i < dep.length; i++) {
  228. hot._acceptedDependencies[dep[i]] = callback || function () {};
  229. hot._acceptedErrorHandlers[dep[i]] = errorHandler;
  230. }
  231. } else {
  232. hot._acceptedDependencies[dep] = callback || function () {};
  233. hot._acceptedErrorHandlers[dep] = errorHandler;
  234. }
  235. },
  236. decline: function (dep) {
  237. if (dep === undefined) hot._selfDeclined = true;
  238. else if (typeof dep === "object" && dep !== null)
  239. for (var i = 0; i < dep.length; i++)
  240. hot._declinedDependencies[dep[i]] = true;
  241. else hot._declinedDependencies[dep] = true;
  242. },
  243. dispose: function (callback) {
  244. hot._disposeHandlers.push(callback);
  245. },
  246. addDisposeHandler: function (callback) {
  247. hot._disposeHandlers.push(callback);
  248. },
  249. removeDisposeHandler: function (callback) {
  250. var idx = hot._disposeHandlers.indexOf(callback);
  251. if (idx >= 0) hot._disposeHandlers.splice(idx, 1);
  252. },
  253. invalidate: function () {
  254. this._selfInvalidated = true;
  255. switch (currentStatus) {
  256. case "idle":
  257. currentUpdateApplyHandlers = [];
  258. Object.keys($hmrInvalidateModuleHandlers$).forEach(function (key) {
  259. $hmrInvalidateModuleHandlers$[key](
  260. moduleId,
  261. /** @type {ApplyHandler[]} */ (currentUpdateApplyHandlers)
  262. );
  263. });
  264. setStatus("ready");
  265. break;
  266. case "ready":
  267. Object.keys($hmrInvalidateModuleHandlers$).forEach(function (key) {
  268. $hmrInvalidateModuleHandlers$[key](
  269. moduleId,
  270. /** @type {ApplyHandler[]} */ (currentUpdateApplyHandlers)
  271. );
  272. });
  273. break;
  274. case "prepare":
  275. case "check":
  276. case "dispose":
  277. case "apply":
  278. (queuedInvalidatedModules = queuedInvalidatedModules || []).push(
  279. moduleId
  280. );
  281. break;
  282. default:
  283. // ignore requests in error states
  284. break;
  285. }
  286. },
  287. // Management API
  288. check: hotCheck,
  289. apply: hotApply,
  290. status: function (l) {
  291. if (!l) return currentStatus;
  292. registeredStatusHandlers.push(l);
  293. },
  294. addStatusHandler: function (l) {
  295. registeredStatusHandlers.push(l);
  296. },
  297. removeStatusHandler: function (l) {
  298. var idx = registeredStatusHandlers.indexOf(l);
  299. if (idx >= 0) registeredStatusHandlers.splice(idx, 1);
  300. },
  301. // inherit from previous dispose call
  302. data: currentModuleData[moduleId]
  303. };
  304. currentChildModule = undefined;
  305. return hot;
  306. }
  307. /**
  308. * @param {string} newStatus new status
  309. * @returns {Promise<void>} promise resolving when all handlers ran
  310. */
  311. function setStatus(newStatus) {
  312. currentStatus = newStatus;
  313. /** @type {(Promise<void> | void)[]} */
  314. var results = [];
  315. for (var i = 0; i < registeredStatusHandlers.length; i++)
  316. results[i] = registeredStatusHandlers[i].call(null, newStatus);
  317. return Promise.all(results).then(function () {});
  318. }
  319. function unblock() {
  320. if (--blockingPromises === 0) {
  321. setStatus("ready").then(function () {
  322. if (blockingPromises === 0) {
  323. var list = blockingPromisesWaiting;
  324. blockingPromisesWaiting = [];
  325. for (var i = 0; i < list.length; i++) {
  326. list[i]();
  327. }
  328. }
  329. });
  330. }
  331. }
  332. /**
  333. * @param {Promise<unknown>} promise blocking promise
  334. * @returns {Promise<unknown>} the same promise
  335. */
  336. function trackBlockingPromise(promise) {
  337. switch (currentStatus) {
  338. case "ready":
  339. setStatus("prepare");
  340. /* fallthrough */
  341. case "prepare":
  342. blockingPromises++;
  343. promise.then(unblock, unblock);
  344. return promise;
  345. default:
  346. return promise;
  347. }
  348. }
  349. /**
  350. * @param {() => Promise<ModuleId[]>} fn function to run once unblocked
  351. * @returns {Promise<ModuleId[]>} result of fn
  352. */
  353. function waitForBlockingPromises(fn) {
  354. if (blockingPromises === 0) return fn();
  355. return /** @type {Promise<ModuleId[]>} */ (
  356. new Promise(function (resolve) {
  357. blockingPromisesWaiting.push(function () {
  358. resolve(fn());
  359. });
  360. })
  361. );
  362. }
  363. /**
  364. * @param {boolean | ApplyOptions=} applyOnUpdate apply the update right away
  365. * @returns {Promise<ModuleId[] | null>} updated module ids or null
  366. */
  367. function hotCheck(applyOnUpdate) {
  368. if (currentStatus !== "idle") {
  369. throw new Error("check() is only allowed in idle status");
  370. }
  371. return setStatus("check")
  372. .then($hmrDownloadManifest$)
  373. .then(function (update) {
  374. if (!update) {
  375. return setStatus(applyInvalidatedModules() ? "ready" : "idle").then(
  376. function () {
  377. return null;
  378. }
  379. );
  380. }
  381. return setStatus("prepare").then(function () {
  382. /** @type {ModuleId[]} */
  383. var updatedModules = [];
  384. currentUpdateApplyHandlers = [];
  385. return Promise.all(
  386. Object.keys($hmrDownloadUpdateHandlers$).reduce(function (
  387. promises,
  388. key
  389. ) {
  390. $hmrDownloadUpdateHandlers$[key](
  391. update.c,
  392. update.r,
  393. update.m,
  394. promises,
  395. /** @type {ApplyHandler[]} */ (currentUpdateApplyHandlers),
  396. updatedModules,
  397. update.css,
  398. update.f
  399. );
  400. return promises;
  401. }, /** @type {Promise<unknown>[]} */ ([]))
  402. ).then(function () {
  403. return waitForBlockingPromises(function () {
  404. if (applyOnUpdate) {
  405. return internalApply(applyOnUpdate);
  406. }
  407. return setStatus("ready").then(function () {
  408. return updatedModules;
  409. });
  410. });
  411. });
  412. });
  413. });
  414. }
  415. /**
  416. * @param {ApplyOptions=} options apply options
  417. * @returns {Promise<ModuleId[]>} updated module ids
  418. */
  419. function hotApply(options) {
  420. if (currentStatus !== "ready") {
  421. return Promise.resolve().then(function () {
  422. throw new Error(
  423. "apply() is only allowed in ready status (state: " +
  424. currentStatus +
  425. ")"
  426. );
  427. });
  428. }
  429. return internalApply(options);
  430. }
  431. /**
  432. * @param {boolean | ApplyOptions=} options apply options
  433. * @returns {Promise<ModuleId[]>} updated module ids
  434. */
  435. function internalApply(options) {
  436. options = options || {};
  437. applyInvalidatedModules();
  438. var results = /** @type {ApplyHandler[]} */ (
  439. currentUpdateApplyHandlers
  440. ).map(function (handler) {
  441. return handler(/** @type {ApplyOptions} */ (options));
  442. });
  443. currentUpdateApplyHandlers = undefined;
  444. var errors = results
  445. .map(function (r) {
  446. return r.error;
  447. })
  448. .filter(Boolean);
  449. if (errors.length > 0) {
  450. return setStatus("abort").then(function () {
  451. throw errors[0];
  452. });
  453. }
  454. // Now in "dispose" phase
  455. var disposePromise = setStatus("dispose");
  456. results.forEach(function (result) {
  457. if (result.dispose) result.dispose();
  458. });
  459. // Now in "apply" phase
  460. var applyPromise = setStatus("apply");
  461. /** @type {Error | undefined} */
  462. var error;
  463. /**
  464. * @param {Error} err error thrown while applying
  465. * @returns {void}
  466. */
  467. var reportError = function (err) {
  468. if (!error) error = err;
  469. };
  470. /** @type {ModuleId[]} */
  471. var outdatedModules = [];
  472. /**
  473. * @returns {Promise<ModuleId[]>} updated module ids
  474. */
  475. var onAccepted = function () {
  476. return Promise.all([disposePromise, applyPromise]).then(function () {
  477. // handle errors in accept handlers and self accepted module load
  478. if (error) {
  479. return setStatus("fail").then(function () {
  480. throw error;
  481. });
  482. }
  483. if (queuedInvalidatedModules) {
  484. return internalApply(options).then(function (list) {
  485. outdatedModules.forEach(function (moduleId) {
  486. if (list.indexOf(moduleId) < 0) list.push(moduleId);
  487. });
  488. return list;
  489. });
  490. }
  491. return setStatus("idle").then(function () {
  492. return outdatedModules;
  493. });
  494. });
  495. };
  496. return Promise.all(
  497. results
  498. .filter(function (result) {
  499. return result.apply;
  500. })
  501. .map(function (result) {
  502. return /** @type {ApplyFn} */ (result.apply)(reportError);
  503. })
  504. )
  505. .then(function (applyResults) {
  506. applyResults.forEach(function (modules) {
  507. if (modules) {
  508. for (var i = 0; i < modules.length; i++) {
  509. outdatedModules.push(modules[i]);
  510. }
  511. }
  512. });
  513. })
  514. .then(onAccepted);
  515. }
  516. /**
  517. * @returns {boolean | undefined} true when invalidated modules were applied
  518. */
  519. function applyInvalidatedModules() {
  520. if (queuedInvalidatedModules) {
  521. if (!currentUpdateApplyHandlers) currentUpdateApplyHandlers = [];
  522. Object.keys($hmrInvalidateModuleHandlers$).forEach(function (key) {
  523. /** @type {ModuleId[]} */ (queuedInvalidatedModules).forEach(
  524. function (moduleId) {
  525. $hmrInvalidateModuleHandlers$[key](
  526. moduleId,
  527. /** @type {ApplyHandler[]} */ (currentUpdateApplyHandlers)
  528. );
  529. }
  530. );
  531. });
  532. queuedInvalidatedModules = undefined;
  533. return true;
  534. }
  535. }
  536. };