index.js 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.default = void 0;
  6. var _path = _interopRequireDefault(require("path"));
  7. var _schemaUtils = require("schema-utils");
  8. var _globby = _interopRequireDefault(require("globby"));
  9. var _serializeJavascript = _interopRequireDefault(require("serialize-javascript"));
  10. var _normalizePath = _interopRequireDefault(require("normalize-path"));
  11. var _globParent = _interopRequireDefault(require("glob-parent"));
  12. var _fastGlob = _interopRequireDefault(require("fast-glob"));
  13. var _package = require("../package.json");
  14. var _options = _interopRequireDefault(require("./options.json"));
  15. var _utils = require("./utils");
  16. function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
  17. const template = /\[\\*([\w:]+)\\*\]/i;
  18. class CopyPlugin {
  19. constructor(options = {}) {
  20. (0, _schemaUtils.validate)(_options.default, options, {
  21. name: "Copy Plugin",
  22. baseDataPath: "options"
  23. });
  24. this.patterns = options.patterns;
  25. this.options = options.options || {};
  26. }
  27. static async createSnapshot(compilation, startTime, dependency) {
  28. // eslint-disable-next-line consistent-return
  29. return new Promise((resolve, reject) => {
  30. compilation.fileSystemInfo.createSnapshot(startTime, [dependency], // eslint-disable-next-line no-undefined
  31. undefined, // eslint-disable-next-line no-undefined
  32. undefined, null, (error, snapshot) => {
  33. if (error) {
  34. reject(error);
  35. return;
  36. }
  37. resolve(snapshot);
  38. });
  39. });
  40. }
  41. static async checkSnapshotValid(compilation, snapshot) {
  42. // eslint-disable-next-line consistent-return
  43. return new Promise((resolve, reject) => {
  44. compilation.fileSystemInfo.checkSnapshotValid(snapshot, (error, isValid) => {
  45. if (error) {
  46. reject(error);
  47. return;
  48. }
  49. resolve(isValid);
  50. });
  51. });
  52. }
  53. static getContentHash(compiler, compilation, source) {
  54. const {
  55. outputOptions
  56. } = compilation;
  57. const {
  58. hashDigest,
  59. hashDigestLength,
  60. hashFunction,
  61. hashSalt
  62. } = outputOptions;
  63. const hash = compiler.webpack.util.createHash(hashFunction);
  64. if (hashSalt) {
  65. hash.update(hashSalt);
  66. }
  67. hash.update(source);
  68. const fullContentHash = hash.digest(hashDigest);
  69. return fullContentHash.slice(0, hashDigestLength);
  70. }
  71. static async runPattern(compiler, compilation, logger, cache, inputPattern, index) {
  72. const {
  73. RawSource
  74. } = compiler.webpack.sources;
  75. const pattern = typeof inputPattern === "string" ? {
  76. from: inputPattern
  77. } : { ...inputPattern
  78. };
  79. pattern.fromOrigin = pattern.from;
  80. pattern.from = _path.default.normalize(pattern.from);
  81. pattern.context = typeof pattern.context === "undefined" ? compiler.context : _path.default.isAbsolute(pattern.context) ? pattern.context : _path.default.join(compiler.context, pattern.context);
  82. logger.log(`starting to process a pattern from '${pattern.from}' using '${pattern.context}' context`);
  83. if (_path.default.isAbsolute(pattern.from)) {
  84. pattern.absoluteFrom = pattern.from;
  85. } else {
  86. pattern.absoluteFrom = _path.default.resolve(pattern.context, pattern.from);
  87. }
  88. logger.debug(`getting stats for '${pattern.absoluteFrom}'...`);
  89. const {
  90. inputFileSystem
  91. } = compiler;
  92. let stats;
  93. try {
  94. stats = await (0, _utils.stat)(inputFileSystem, pattern.absoluteFrom);
  95. } catch (error) {// Nothing
  96. }
  97. if (stats) {
  98. if (stats.isDirectory()) {
  99. pattern.fromType = "dir";
  100. logger.debug(`determined '${pattern.absoluteFrom}' is a directory`);
  101. } else if (stats.isFile()) {
  102. pattern.fromType = "file";
  103. logger.debug(`determined '${pattern.absoluteFrom}' is a file`);
  104. } else {
  105. logger.debug(`determined '${pattern.absoluteFrom}' is a glob`);
  106. }
  107. } // eslint-disable-next-line no-param-reassign
  108. pattern.globOptions = { ...{
  109. followSymbolicLinks: true
  110. },
  111. ...(pattern.globOptions || {}),
  112. ...{
  113. cwd: pattern.context,
  114. objectMode: true
  115. }
  116. };
  117. pattern.globOptions.fs = inputFileSystem;
  118. switch (pattern.fromType) {
  119. case "dir":
  120. compilation.contextDependencies.add(pattern.absoluteFrom);
  121. logger.debug(`added '${pattern.absoluteFrom}' as a context dependency`);
  122. /* eslint-disable no-param-reassign */
  123. pattern.context = pattern.absoluteFrom;
  124. pattern.glob = _path.default.posix.join(_fastGlob.default.escapePath((0, _normalizePath.default)(_path.default.resolve(pattern.absoluteFrom))), "**/*");
  125. pattern.absoluteFrom = _path.default.join(pattern.absoluteFrom, "**/*");
  126. if (typeof pattern.globOptions.dot === "undefined") {
  127. pattern.globOptions.dot = true;
  128. }
  129. /* eslint-enable no-param-reassign */
  130. break;
  131. case "file":
  132. compilation.fileDependencies.add(pattern.absoluteFrom);
  133. logger.debug(`added '${pattern.absoluteFrom}' as a file dependency`);
  134. /* eslint-disable no-param-reassign */
  135. pattern.context = _path.default.dirname(pattern.absoluteFrom);
  136. pattern.glob = _fastGlob.default.escapePath((0, _normalizePath.default)(_path.default.resolve(pattern.absoluteFrom)));
  137. if (typeof pattern.globOptions.dot === "undefined") {
  138. pattern.globOptions.dot = true;
  139. }
  140. /* eslint-enable no-param-reassign */
  141. break;
  142. default:
  143. {
  144. const contextDependencies = _path.default.normalize((0, _globParent.default)(pattern.absoluteFrom));
  145. compilation.contextDependencies.add(contextDependencies);
  146. logger.debug(`added '${contextDependencies}' as a context dependency`);
  147. /* eslint-disable no-param-reassign */
  148. pattern.fromType = "glob";
  149. pattern.glob = _path.default.isAbsolute(pattern.fromOrigin) ? pattern.fromOrigin : _path.default.posix.join(_fastGlob.default.escapePath((0, _normalizePath.default)(_path.default.resolve(pattern.context))), pattern.fromOrigin);
  150. /* eslint-enable no-param-reassign */
  151. }
  152. }
  153. logger.log(`begin globbing '${pattern.glob}'...`);
  154. let paths;
  155. try {
  156. paths = await (0, _globby.default)(pattern.glob, pattern.globOptions);
  157. } catch (error) {
  158. compilation.errors.push(error);
  159. return;
  160. }
  161. if (paths.length === 0) {
  162. if (pattern.noErrorOnMissing) {
  163. logger.log(`finished to process a pattern from '${pattern.from}' using '${pattern.context}' context to '${pattern.to}'`);
  164. return;
  165. }
  166. const missingError = new Error(`unable to locate '${pattern.glob}' glob`);
  167. compilation.errors.push(missingError);
  168. return;
  169. }
  170. const filteredPaths = (await Promise.all(paths.map(async item => {
  171. // Exclude directories
  172. if (!item.dirent.isFile()) {
  173. return false;
  174. }
  175. if (pattern.filter) {
  176. let isFiltered;
  177. try {
  178. isFiltered = await pattern.filter(item.path);
  179. } catch (error) {
  180. compilation.errors.push(error);
  181. return false;
  182. }
  183. if (!isFiltered) {
  184. logger.log(`skip '${item.path}', because it was filtered`);
  185. }
  186. return isFiltered ? item : false;
  187. }
  188. return item;
  189. }))).filter(item => item);
  190. if (filteredPaths.length === 0) {
  191. if (pattern.noErrorOnMissing) {
  192. logger.log(`finished to process a pattern from '${pattern.from}' using '${pattern.context}' context to '${pattern.to}'`);
  193. return;
  194. }
  195. const missingError = new Error(`unable to locate '${pattern.glob}' glob after filtering paths`);
  196. compilation.errors.push(missingError);
  197. return;
  198. }
  199. const files = await Promise.all(filteredPaths.map(async item => {
  200. const from = item.path;
  201. logger.debug(`found '${from}'`); // `globby`/`fast-glob` return the relative path when the path contains special characters on windows
  202. const absoluteFilename = _path.default.resolve(pattern.context, from);
  203. pattern.to = typeof pattern.to === "function" ? await pattern.to({
  204. context: pattern.context,
  205. absoluteFilename
  206. }) : _path.default.normalize(typeof pattern.to !== "undefined" ? pattern.to : "");
  207. const isToDirectory = _path.default.extname(pattern.to) === "" || pattern.to.slice(-1) === _path.default.sep;
  208. const toType = pattern.toType ? pattern.toType : template.test(pattern.to) ? "template" : isToDirectory ? "dir" : "file";
  209. logger.log(`'to' option '${pattern.to}' determinated as '${toType}'`);
  210. const relativeFrom = _path.default.relative(pattern.context, absoluteFilename);
  211. let filename = toType === "dir" ? _path.default.join(pattern.to, relativeFrom) : pattern.to;
  212. if (_path.default.isAbsolute(filename)) {
  213. filename = _path.default.relative(compiler.options.output.path, filename);
  214. }
  215. logger.log(`determined that '${from}' should write to '${filename}'`);
  216. const sourceFilename = (0, _normalizePath.default)(_path.default.relative(compiler.context, absoluteFilename));
  217. return {
  218. absoluteFilename,
  219. sourceFilename,
  220. filename,
  221. toType
  222. };
  223. }));
  224. let assets;
  225. try {
  226. assets = await Promise.all(files.map(async file => {
  227. const {
  228. absoluteFilename,
  229. sourceFilename,
  230. filename,
  231. toType
  232. } = file;
  233. const info = typeof pattern.info === "function" ? pattern.info(file) || {} : pattern.info || {};
  234. const result = {
  235. absoluteFilename,
  236. sourceFilename,
  237. filename,
  238. force: pattern.force,
  239. info
  240. }; // If this came from a glob or dir, add it to the file dependencies
  241. if (pattern.fromType === "dir" || pattern.fromType === "glob") {
  242. compilation.fileDependencies.add(absoluteFilename);
  243. logger.debug(`added '${absoluteFilename}' as a file dependency`);
  244. }
  245. let cacheEntry;
  246. logger.debug(`getting cache for '${absoluteFilename}'...`);
  247. try {
  248. cacheEntry = await cache.getPromise(`${sourceFilename}|${index}`, null);
  249. } catch (error) {
  250. compilation.errors.push(error);
  251. return;
  252. }
  253. if (cacheEntry) {
  254. logger.debug(`found cache for '${absoluteFilename}'...`);
  255. let isValidSnapshot;
  256. logger.debug(`checking snapshot on valid for '${absoluteFilename}'...`);
  257. try {
  258. isValidSnapshot = await CopyPlugin.checkSnapshotValid(compilation, cacheEntry.snapshot);
  259. } catch (error) {
  260. compilation.errors.push(error);
  261. return;
  262. }
  263. if (isValidSnapshot) {
  264. logger.debug(`snapshot for '${absoluteFilename}' is valid`);
  265. result.source = cacheEntry.source;
  266. } else {
  267. logger.debug(`snapshot for '${absoluteFilename}' is invalid`);
  268. }
  269. } else {
  270. logger.debug(`missed cache for '${absoluteFilename}'`);
  271. }
  272. if (!result.source) {
  273. const startTime = Date.now();
  274. logger.debug(`reading '${absoluteFilename}'...`);
  275. let data;
  276. try {
  277. data = await (0, _utils.readFile)(inputFileSystem, absoluteFilename);
  278. } catch (error) {
  279. compilation.errors.push(error);
  280. return;
  281. }
  282. logger.debug(`read '${absoluteFilename}'`);
  283. result.source = new RawSource(data);
  284. let snapshot;
  285. logger.debug(`creating snapshot for '${absoluteFilename}'...`);
  286. try {
  287. snapshot = await CopyPlugin.createSnapshot(compilation, startTime, absoluteFilename);
  288. } catch (error) {
  289. compilation.errors.push(error);
  290. return;
  291. }
  292. if (snapshot) {
  293. logger.debug(`created snapshot for '${absoluteFilename}'`);
  294. logger.debug(`storing cache for '${absoluteFilename}'...`);
  295. try {
  296. await cache.storePromise(`${sourceFilename}|${index}`, null, {
  297. source: result.source,
  298. snapshot
  299. });
  300. } catch (error) {
  301. compilation.errors.push(error);
  302. return;
  303. }
  304. logger.debug(`stored cache for '${absoluteFilename}'`);
  305. }
  306. }
  307. if (pattern.transform) {
  308. const transform = typeof pattern.transform === "function" ? {
  309. transformer: pattern.transform
  310. } : pattern.transform;
  311. if (transform.transformer) {
  312. logger.log(`transforming content for '${absoluteFilename}'...`);
  313. const buffer = result.source.buffer();
  314. if (transform.cache) {
  315. // TODO: remove in the next major release
  316. const hasher = compiler.webpack && compiler.webpack.util && compiler.webpack.util.createHash ? compiler.webpack.util.createHash("xxhash64") : // eslint-disable-next-line global-require
  317. require("crypto").createHash("md4");
  318. const defaultCacheKeys = {
  319. version: _package.version,
  320. sourceFilename,
  321. transform: transform.transformer,
  322. contentHash: hasher.update(buffer).digest("hex"),
  323. index
  324. };
  325. const cacheKeys = `transform|${(0, _serializeJavascript.default)(typeof transform.cache.keys === "function" ? await transform.cache.keys(defaultCacheKeys, absoluteFilename) : { ...defaultCacheKeys,
  326. ...pattern.transform.cache.keys
  327. })}`;
  328. logger.debug(`getting transformation cache for '${absoluteFilename}'...`);
  329. const cacheItem = cache.getItemCache(cacheKeys, cache.getLazyHashedEtag(result.source));
  330. result.source = await cacheItem.getPromise();
  331. logger.debug(result.source ? `found transformation cache for '${absoluteFilename}'` : `no transformation cache for '${absoluteFilename}'`);
  332. if (!result.source) {
  333. const transformed = await transform.transformer(buffer, absoluteFilename);
  334. result.source = new RawSource(transformed);
  335. logger.debug(`caching transformation for '${absoluteFilename}'...`);
  336. await cacheItem.storePromise(result.source);
  337. logger.debug(`cached transformation for '${absoluteFilename}'`);
  338. }
  339. } else {
  340. result.source = new RawSource(await transform.transformer(buffer, absoluteFilename));
  341. }
  342. }
  343. }
  344. if (toType === "template") {
  345. logger.log(`interpolating template '${filename}' for '${sourceFilename}'...`);
  346. const contentHash = CopyPlugin.getContentHash(compiler, compilation, result.source.buffer());
  347. const ext = _path.default.extname(result.sourceFilename);
  348. const base = _path.default.basename(result.sourceFilename);
  349. const name = base.slice(0, base.length - ext.length);
  350. const data = {
  351. filename: (0, _normalizePath.default)(_path.default.relative(pattern.context, absoluteFilename)),
  352. contentHash,
  353. chunk: {
  354. name,
  355. id: result.sourceFilename,
  356. hash: contentHash,
  357. contentHash
  358. }
  359. };
  360. const {
  361. path: interpolatedFilename,
  362. info: assetInfo
  363. } = compilation.getPathWithInfo((0, _normalizePath.default)(result.filename), data);
  364. result.info = { ...result.info,
  365. ...assetInfo
  366. };
  367. result.filename = interpolatedFilename;
  368. logger.log(`interpolated template '${filename}' for '${sourceFilename}'`);
  369. } else {
  370. // eslint-disable-next-line no-param-reassign
  371. result.filename = (0, _normalizePath.default)(result.filename);
  372. } // eslint-disable-next-line consistent-return
  373. return result;
  374. }));
  375. } catch (error) {
  376. compilation.errors.push(error);
  377. return;
  378. }
  379. logger.log(`finished to process a pattern from '${pattern.from}' using '${pattern.context}' context to '${pattern.to}'`); // eslint-disable-next-line consistent-return
  380. return assets;
  381. }
  382. apply(compiler) {
  383. const pluginName = this.constructor.name;
  384. compiler.hooks.thisCompilation.tap(pluginName, compilation => {
  385. const logger = compilation.getLogger("copy-webpack-plugin");
  386. const cache = compilation.getCache("CopyWebpackPlugin");
  387. compilation.hooks.processAssets.tapAsync({
  388. name: "copy-webpack-plugin",
  389. stage: compiler.webpack.Compilation.PROCESS_ASSETS_STAGE_ADDITIONAL
  390. }, async (unusedAssets, callback) => {
  391. logger.log("starting to add additional assets...");
  392. const assetMap = new Map();
  393. const scheduledTasks = [];
  394. this.patterns.map((item, index) => scheduledTasks.push(async () => {
  395. let assets;
  396. try {
  397. assets = await CopyPlugin.runPattern(compiler, compilation, logger, cache, item, index);
  398. } catch (error) {
  399. compilation.errors.push(error);
  400. return;
  401. }
  402. if (assets && assets.length > 0) {
  403. if (item.transformAll) {
  404. if (typeof item.to === "undefined") {
  405. compilation.errors.push(new Error(`Invalid "pattern.to" for the "pattern.from": "${item.from}" and "pattern.transformAll" function. The "to" option must be specified.`));
  406. return;
  407. }
  408. assets.sort((a, b) => a.absoluteFilename > b.absoluteFilename ? 1 : a.absoluteFilename < b.absoluteFilename ? -1 : 0);
  409. const mergedEtag = assets.length === 1 ? cache.getLazyHashedEtag(assets[0].source.buffer()) : assets.reduce((accumulator, asset, i) => {
  410. // eslint-disable-next-line no-param-reassign
  411. accumulator = cache.mergeEtags(i === 1 ? cache.getLazyHashedEtag(accumulator.source.buffer()) : accumulator, cache.getLazyHashedEtag(asset.source.buffer()));
  412. return accumulator;
  413. });
  414. const cacheKeys = `transformAll|${(0, _serializeJavascript.default)({
  415. version: _package.version,
  416. from: item.from,
  417. to: item.to,
  418. transformAll: item.transformAll
  419. })}`;
  420. const eTag = cache.getLazyHashedEtag(mergedEtag);
  421. const cacheItem = cache.getItemCache(cacheKeys, eTag);
  422. let transformedAsset = await cacheItem.getPromise();
  423. if (!transformedAsset) {
  424. transformedAsset = {
  425. filename: item.to
  426. };
  427. try {
  428. transformedAsset.data = await item.transformAll(assets.map(asset => {
  429. return {
  430. data: asset.source.buffer(),
  431. sourceFilename: asset.sourceFilename,
  432. absoluteFilename: asset.absoluteFilename
  433. };
  434. }));
  435. } catch (error) {
  436. compilation.errors.push(error);
  437. return;
  438. }
  439. if (template.test(item.to)) {
  440. const contentHash = CopyPlugin.getContentHash(compiler, compilation, transformedAsset.data);
  441. const {
  442. path: interpolatedFilename,
  443. info: assetInfo
  444. } = compilation.getPathWithInfo((0, _normalizePath.default)(item.to), {
  445. contentHash,
  446. chunk: {
  447. hash: contentHash,
  448. contentHash
  449. }
  450. });
  451. transformedAsset.filename = interpolatedFilename;
  452. transformedAsset.info = assetInfo;
  453. }
  454. const {
  455. RawSource
  456. } = compiler.webpack.sources;
  457. transformedAsset.source = new RawSource(transformedAsset.data);
  458. transformedAsset.force = item.force;
  459. await cacheItem.storePromise(transformedAsset);
  460. }
  461. assets = [transformedAsset];
  462. }
  463. const priority = item.priority || 0;
  464. if (!assetMap.has(priority)) {
  465. assetMap.set(priority, []);
  466. }
  467. assetMap.get(priority).push(...assets);
  468. }
  469. }));
  470. await (0, _utils.throttleAll)(this.options.concurrency || 100, scheduledTasks);
  471. const assets = [...assetMap.entries()].sort((a, b) => a[0] - b[0]); // Avoid writing assets inside `p-limit`, because it creates concurrency.
  472. // It could potentially lead to an error - 'Multiple assets emit different content to the same filename'
  473. assets.reduce((acc, val) => acc.concat(val[1]), []).filter(Boolean).forEach(asset => {
  474. const {
  475. absoluteFilename,
  476. sourceFilename,
  477. filename,
  478. source,
  479. force
  480. } = asset;
  481. const existingAsset = compilation.getAsset(filename);
  482. if (existingAsset) {
  483. if (force) {
  484. const info = {
  485. copied: true,
  486. sourceFilename
  487. };
  488. logger.log(`force updating '${filename}' from '${absoluteFilename}' to compilation assets, because it already exists...`);
  489. compilation.updateAsset(filename, source, { ...info,
  490. ...asset.info
  491. });
  492. logger.log(`force updated '${filename}' from '${absoluteFilename}' to compilation assets, because it already exists`);
  493. return;
  494. }
  495. logger.log(`skip adding '${filename}' from '${absoluteFilename}' to compilation assets, because it already exists`);
  496. return;
  497. }
  498. const info = {
  499. copied: true,
  500. sourceFilename
  501. };
  502. logger.log(`writing '${filename}' from '${absoluteFilename}' to compilation assets...`);
  503. compilation.emitAsset(filename, source, { ...info,
  504. ...asset.info
  505. });
  506. logger.log(`written '${filename}' from '${absoluteFilename}' to compilation assets`);
  507. });
  508. logger.log("finished to adding additional assets");
  509. callback();
  510. });
  511. if (compilation.hooks.statsPrinter) {
  512. compilation.hooks.statsPrinter.tap(pluginName, stats => {
  513. stats.hooks.print.for("asset.info.copied").tap("copy-webpack-plugin", (copied, {
  514. green,
  515. formatFlag
  516. }) => // eslint-disable-next-line no-undefined
  517. copied ? green(formatFlag("copied")) : undefined);
  518. });
  519. }
  520. });
  521. }
  522. }
  523. var _default = CopyPlugin;
  524. exports.default = _default;