ResolverCachePlugin.js 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const LazySet = require("../util/LazySet");
  7. const makeSerializable = require("../util/makeSerializable");
  8. /** @typedef {import("enhanced-resolve/lib/Resolver")} Resolver */
  9. /** @typedef {import("../CacheFacade").ItemCacheFacade} ItemCacheFacade */
  10. /** @typedef {import("../Compiler")} Compiler */
  11. /** @typedef {import("../FileSystemInfo")} FileSystemInfo */
  12. /** @typedef {import("../FileSystemInfo").Snapshot} Snapshot */
  13. class CacheEntry {
  14. constructor(result, snapshot) {
  15. this.result = result;
  16. this.snapshot = snapshot;
  17. }
  18. serialize({ write }) {
  19. write(this.result);
  20. write(this.snapshot);
  21. }
  22. deserialize({ read }) {
  23. this.result = read();
  24. this.snapshot = read();
  25. }
  26. }
  27. makeSerializable(CacheEntry, "webpack/lib/cache/ResolverCachePlugin");
  28. /**
  29. * @template T
  30. * @param {Set<T> | LazySet<T>} set set to add items to
  31. * @param {Set<T> | LazySet<T>} otherSet set to add items from
  32. * @returns {void}
  33. */
  34. const addAllToSet = (set, otherSet) => {
  35. if (set instanceof LazySet) {
  36. set.addAll(otherSet);
  37. } else {
  38. for (const item of otherSet) {
  39. set.add(item);
  40. }
  41. }
  42. };
  43. /**
  44. * @param {Object} object an object
  45. * @param {boolean} excludeContext if true, context is not included in string
  46. * @returns {string} stringified version
  47. */
  48. const objectToString = (object, excludeContext) => {
  49. let str = "";
  50. for (const key in object) {
  51. if (excludeContext && key === "context") continue;
  52. const value = object[key];
  53. if (typeof value === "object" && value !== null) {
  54. str += `|${key}=[${objectToString(value, false)}|]`;
  55. } else {
  56. str += `|${key}=|${value}`;
  57. }
  58. }
  59. return str;
  60. };
  61. class ResolverCachePlugin {
  62. /**
  63. * Apply the plugin
  64. * @param {Compiler} compiler the compiler instance
  65. * @returns {void}
  66. */
  67. apply(compiler) {
  68. const cache = compiler.getCache("ResolverCachePlugin");
  69. /** @type {FileSystemInfo} */
  70. let fileSystemInfo;
  71. let snapshotOptions;
  72. let realResolves = 0;
  73. let cachedResolves = 0;
  74. let cacheInvalidResolves = 0;
  75. let concurrentResolves = 0;
  76. compiler.hooks.thisCompilation.tap("ResolverCachePlugin", compilation => {
  77. snapshotOptions = compilation.options.snapshot.resolve;
  78. fileSystemInfo = compilation.fileSystemInfo;
  79. compilation.hooks.finishModules.tap("ResolverCachePlugin", () => {
  80. if (realResolves + cachedResolves > 0) {
  81. const logger = compilation.getLogger("webpack.ResolverCachePlugin");
  82. logger.log(
  83. `${Math.round(
  84. (100 * realResolves) / (realResolves + cachedResolves)
  85. )}% really resolved (${realResolves} real resolves with ${cacheInvalidResolves} cached but invalid, ${cachedResolves} cached valid, ${concurrentResolves} concurrent)`
  86. );
  87. realResolves = 0;
  88. cachedResolves = 0;
  89. cacheInvalidResolves = 0;
  90. concurrentResolves = 0;
  91. }
  92. });
  93. });
  94. /**
  95. * @param {ItemCacheFacade} itemCache cache
  96. * @param {Resolver} resolver the resolver
  97. * @param {Object} resolveContext context for resolving meta info
  98. * @param {Object} request the request info object
  99. * @param {function((Error | null)=, Object=): void} callback callback function
  100. * @returns {void}
  101. */
  102. const doRealResolve = (
  103. itemCache,
  104. resolver,
  105. resolveContext,
  106. request,
  107. callback
  108. ) => {
  109. realResolves++;
  110. const newRequest = {
  111. _ResolverCachePluginCacheMiss: true,
  112. ...request
  113. };
  114. const newResolveContext = {
  115. ...resolveContext,
  116. stack: new Set(),
  117. missingDependencies: new LazySet(),
  118. fileDependencies: new LazySet(),
  119. contextDependencies: new LazySet()
  120. };
  121. const propagate = key => {
  122. if (resolveContext[key]) {
  123. addAllToSet(resolveContext[key], newResolveContext[key]);
  124. }
  125. };
  126. const resolveTime = Date.now();
  127. resolver.doResolve(
  128. resolver.hooks.resolve,
  129. newRequest,
  130. "Cache miss",
  131. newResolveContext,
  132. (err, result) => {
  133. propagate("fileDependencies");
  134. propagate("contextDependencies");
  135. propagate("missingDependencies");
  136. if (err) return callback(err);
  137. const fileDependencies = newResolveContext.fileDependencies;
  138. const contextDependencies = newResolveContext.contextDependencies;
  139. const missingDependencies = newResolveContext.missingDependencies;
  140. fileSystemInfo.createSnapshot(
  141. resolveTime,
  142. fileDependencies,
  143. contextDependencies,
  144. missingDependencies,
  145. snapshotOptions,
  146. (err, snapshot) => {
  147. if (err) return callback(err);
  148. if (!snapshot) {
  149. if (result) return callback(null, result);
  150. return callback();
  151. }
  152. itemCache.store(new CacheEntry(result, snapshot), storeErr => {
  153. if (storeErr) return callback(storeErr);
  154. if (result) return callback(null, result);
  155. callback();
  156. });
  157. }
  158. );
  159. }
  160. );
  161. };
  162. compiler.resolverFactory.hooks.resolver.intercept({
  163. factory(type, hook) {
  164. /** @type {Map<string, (function(Error=, Object=): void)[]>} */
  165. const activeRequests = new Map();
  166. hook.tap(
  167. "ResolverCachePlugin",
  168. /**
  169. * @param {Resolver} resolver the resolver
  170. * @param {Object} options resolve options
  171. * @param {Object} userOptions resolve options passed by the user
  172. * @returns {void}
  173. */
  174. (resolver, options, userOptions) => {
  175. if (options.cache !== true) return;
  176. const optionsIdent = objectToString(userOptions, false);
  177. const cacheWithContext =
  178. options.cacheWithContext !== undefined
  179. ? options.cacheWithContext
  180. : false;
  181. resolver.hooks.resolve.tapAsync(
  182. {
  183. name: "ResolverCachePlugin",
  184. stage: -100
  185. },
  186. (request, resolveContext, callback) => {
  187. if (request._ResolverCachePluginCacheMiss || !fileSystemInfo) {
  188. return callback();
  189. }
  190. const identifier = `${type}${optionsIdent}${objectToString(
  191. request,
  192. !cacheWithContext
  193. )}`;
  194. const activeRequest = activeRequests.get(identifier);
  195. if (activeRequest) {
  196. activeRequest.push(callback);
  197. return;
  198. }
  199. const itemCache = cache.getItemCache(identifier, null);
  200. let callbacks;
  201. const done = (err, result) => {
  202. if (callbacks === undefined) {
  203. callback(err, result);
  204. callbacks = false;
  205. } else {
  206. for (const callback of callbacks) {
  207. callback(err, result);
  208. }
  209. activeRequests.delete(identifier);
  210. callbacks = false;
  211. }
  212. };
  213. /**
  214. * @param {Error=} err error if any
  215. * @param {CacheEntry=} cacheEntry cache entry
  216. * @returns {void}
  217. */
  218. const processCacheResult = (err, cacheEntry) => {
  219. if (err) return done(err);
  220. if (cacheEntry) {
  221. const { snapshot, result } = cacheEntry;
  222. fileSystemInfo.checkSnapshotValid(
  223. snapshot,
  224. (err, valid) => {
  225. if (err || !valid) {
  226. cacheInvalidResolves++;
  227. return doRealResolve(
  228. itemCache,
  229. resolver,
  230. resolveContext,
  231. request,
  232. done
  233. );
  234. }
  235. cachedResolves++;
  236. if (resolveContext.missingDependencies) {
  237. addAllToSet(
  238. resolveContext.missingDependencies,
  239. snapshot.getMissingIterable()
  240. );
  241. }
  242. if (resolveContext.fileDependencies) {
  243. addAllToSet(
  244. resolveContext.fileDependencies,
  245. snapshot.getFileIterable()
  246. );
  247. }
  248. if (resolveContext.contextDependencies) {
  249. addAllToSet(
  250. resolveContext.contextDependencies,
  251. snapshot.getContextIterable()
  252. );
  253. }
  254. done(null, result);
  255. }
  256. );
  257. } else {
  258. doRealResolve(
  259. itemCache,
  260. resolver,
  261. resolveContext,
  262. request,
  263. done
  264. );
  265. }
  266. };
  267. itemCache.get(processCacheResult);
  268. if (callbacks === undefined) {
  269. callbacks = [callback];
  270. activeRequests.set(identifier, callbacks);
  271. }
  272. }
  273. );
  274. }
  275. );
  276. return hook;
  277. }
  278. });
  279. }
  280. }
  281. module.exports = ResolverCachePlugin;