forked from webpack/copy-webpack-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.js
More file actions
1181 lines (977 loc) · 36.4 KB
/
index.js
File metadata and controls
1181 lines (977 loc) · 36.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
const path = require("node:path");
const { validate } = require("schema-utils");
const { version } = require("../package.json");
const schema = require("./options.json");
const { memoize, readFile, stat, throttleAll } = require("./utils");
const template = /\[\\*([\w:]+)\\*\]/i;
const getNormalizePath = memoize(() => require("normalize-path"));
const getGlobParent = memoize(() => require("glob-parent"));
const getSerializeJavascript = memoize(() => require("serialize-javascript"));
const getTinyGlobby = memoize(() => require("tinyglobby"));
/** @typedef {import("schema-utils/declarations/validate").Schema} Schema */
/** @typedef {import("webpack").Compiler} Compiler */
/** @typedef {import("webpack").Compilation} Compilation */
/** @typedef {import("webpack").Asset} Asset */
/** @typedef {import("webpack").AssetInfo} AssetInfo */
/** @typedef {import("webpack").InputFileSystem} InputFileSystem */
/** @typedef {import("tinyglobby").GlobOptions} GlobbyOptions */
/** @typedef {ReturnType<Compilation["getLogger"]>} WebpackLogger */
/** @typedef {ReturnType<Compilation["getCache"]>} CacheFacade */
/** @typedef {ReturnType<ReturnType<Compilation["getCache"]>["getLazyHashedEtag"]>} Etag */
/** @typedef {ReturnType<Compilation["fileSystemInfo"]["mergeSnapshots"]>} Snapshot */
/**
* @typedef {boolean} Force
*/
/**
* @typedef {object} CopiedResult
* @property {string} sourceFilename relative path to the file from the context
* @property {string} absoluteFilename absolute path to the file
* @property {string} filename relative path to the file from the output path
* @property {Asset["source"]} source source of the file
* @property {Force | undefined} force whether to force update the asset if it already exists
* @property {Record<string, unknown>} info additional information about the asset
*/
/**
* @typedef {string} StringPattern
*/
/**
* @typedef {boolean} NoErrorOnMissing
*/
/**
* @typedef {string} Context
*/
/**
* @typedef {string} From
*/
/**
* @callback ToFunction
* @param {{ context: string, absoluteFilename?: string }} pathData
* @returns {string | Promise<string>}
*/
/**
* @typedef {string | ToFunction} To
*/
/**
* @typedef {"dir" | "file" | "template"} ToType
*/
/**
* @callback TransformerFunction
* @param {Buffer} input
* @param {string} absoluteFilename
* @returns {string | Buffer | Promise<string> | Promise<Buffer>}
*/
/**
* @typedef {{ keys: { [key: string]: unknown } } | { keys: ((defaultCacheKeys: { [key: string]: unknown }, absoluteFilename: string) => Promise<{ [key: string]: unknown }>) }} TransformerCacheObject
*/
/**
* @typedef {object} TransformerObject
* @property {TransformerFunction} transformer function to transform the file content
* @property {boolean | TransformerCacheObject=} cache whether to cache the transformed content or an object with keys for caching
*/
/**
* @typedef {TransformerFunction | TransformerObject} Transform
*/
/**
* @callback Filter
* @param {string} filepath
* @returns {boolean | Promise<boolean>}
*/
/**
* @callback TransformAllFunction
* @param {{ data: Buffer, sourceFilename: string, absoluteFilename: string }[]} data
* @returns {string | Buffer | Promise<string> | Promise<Buffer>}
*/
/**
* @typedef {Record<string, unknown> | ((item: { absoluteFilename: string, sourceFilename: string, filename: string, toType: ToType }) => Record<string, unknown>)} Info
*/
/**
* @typedef {object} ObjectPattern
* @property {From} from source path or glob pattern to copy files from
* @property {GlobbyOptions=} globOptions options for globbing
* @property {Context=} context context for the source path or glob pattern
* @property {To=} to destination path or function to determine the destination path
* @property {ToType=} toType type of the destination path, can be "dir", "file" or "template"
* @property {Info=} info additional information about the asset
* @property {Filter=} filter function to filter files, if it returns false, the file will be skipped
* @property {Transform=} transform function to transform the file content, can be a function or an object with a transformer function and cache options
* @property {TransformAllFunction=} transformAll function to transform all files, it receives an array of objects with data, sourceFilename and absoluteFilename properties
* @property {Force=} force whether to force update the asset if it already exists
* @property {number=} priority priority of the pattern, patterns with higher priority will be processed first
* @property {NoErrorOnMissing=} noErrorOnMissing whether to skip errors when no files are found for the pattern
*/
/**
* @typedef {StringPattern | ObjectPattern} Pattern
*/
/**
* @typedef {object} AdditionalOptions
* @property {number=} concurrency maximum number of concurrent operations, default is 100
*/
/**
* @typedef {object} PluginOptions
* @property {Pattern[]} patterns array of patterns to copy files from
* @property {AdditionalOptions=} options additional options for the plugin
*/
const PLUGIN_NAME = "CopyPlugin";
class CopyPlugin {
/**
* @param {PluginOptions=} options options for the plugin
*/
constructor(options = { patterns: [] }) {
validate(/** @type {Schema} */ (schema), options, {
name: "Copy Plugin",
baseDataPath: "options",
});
/**
* @private
* @type {Pattern[]}
*/
this.patterns = options.patterns;
/**
* @private
* @type {AdditionalOptions}
*/
this.options = options.options || {};
}
/**
* @private
* @param {Compilation} compilation the compilation
* @param {number} startTime the start time of the snapshot creation
* @param {string} dependency the dependency for which the snapshot is created
* @returns {Promise<Snapshot | undefined>} creates a snapshot for the given dependency
*/
static async createSnapshot(compilation, startTime, dependency) {
return new Promise((resolve, reject) => {
compilation.fileSystemInfo.createSnapshot(
startTime,
[dependency],
null,
null,
null,
(error, snapshot) => {
if (error) {
reject(error);
return;
}
resolve(/** @type {Snapshot} */ (snapshot));
},
);
});
}
/**
* @private
* @param {Compilation} compilation the compilation
* @param {Snapshot} snapshot /the snapshot to check
* @returns {Promise<boolean | undefined>} checks if the snapshot is valid
*/
static async checkSnapshotValid(compilation, snapshot) {
return new Promise((resolve, reject) => {
compilation.fileSystemInfo.checkSnapshotValid(
snapshot,
(error, isValid) => {
if (error) {
reject(error);
return;
}
resolve(isValid);
},
);
});
}
/**
* @private
* @param {Compiler} compiler the compiler
* @param {Compilation} compilation the compilation
* @param {Buffer} source the source content to hash
* @returns {string} returns the content hash of the source
*/
static getContentHash(compiler, compilation, source) {
const { outputOptions } = compilation;
const { hashDigest, hashDigestLength, hashFunction, hashSalt } =
outputOptions;
const hash = compiler.webpack.util.createHash(
/** @type {string} */
(hashFunction),
);
if (hashSalt) {
hash.update(hashSalt);
}
hash.update(source);
const fullContentHash = hash.digest(hashDigest);
return fullContentHash.toString().slice(0, hashDigestLength);
}
/**
* @private
* @param {Compilation} compilation the compilation
* @param {"file" | "dir" | "glob"} typeOfFrom the type of from
* @param {string} absoluteFrom the source content to hash
* @param {InputFileSystem | null} inputFileSystem input file system
* @param {WebpackLogger} logger the logger to use for logging
* @returns {Promise<void>}
*/
static async addCompilationDependency(
compilation,
typeOfFrom,
absoluteFrom,
inputFileSystem,
logger,
) {
switch (typeOfFrom) {
case "dir":
compilation.contextDependencies.add(absoluteFrom);
logger.debug(`added '${absoluteFrom}' as a context dependency`);
break;
case "file":
compilation.fileDependencies.add(absoluteFrom);
logger.debug(`added '${absoluteFrom}' as a file dependency`);
break;
case "glob":
default: {
const contextDependency = getTinyGlobby().isDynamicPattern(absoluteFrom)
? path.normalize(getGlobParent()(absoluteFrom))
: path.normalize(absoluteFrom);
let stats;
// If we have `inputFileSystem` we should check the glob is existing or not
if (inputFileSystem) {
try {
stats = await stat(inputFileSystem, contextDependency);
} catch {
// Nothing
}
}
// To prevent double compilation during aggregation (initial run) - https://github.com/webpack/copy-webpack-plugin/issues/806.
// On first run we don't know if the glob exists or not, adding the dependency to the context dependencies triggers the `removed` event during aggregation.
// To prevent this behavior we should add the glob to the missing dependencies if the glob doesn't exist,
// otherwise we should add the dependency to the context dependencies.
if (inputFileSystem && !stats) {
compilation.missingDependencies.add(contextDependency);
logger.debug(`added '${contextDependency}' as a missing dependency`);
} else {
compilation.contextDependencies.add(contextDependency);
logger.debug(`added '${contextDependency}' as a context dependency`);
}
}
}
}
/**
* @private
* @param {typeof import("tinyglobby").glob} globby the globby function to use for globbing
* @param {Compiler} compiler the compiler
* @param {Compilation} compilation the compilation
* @param {WebpackLogger} logger the logger to use for logging
* @param {CacheFacade} cache the cache facade to use for caching
* @param {number} concurrency /maximum number of concurrent operations
* @param {ObjectPattern & { context: string }} pattern the pattern to process
* @param {number} index the index of the pattern in the patterns array
* @returns {Promise<(CopiedResult | undefined)[] | undefined>} processes the pattern and returns an array of copied results
*/
static async glob(
globby,
compiler,
compilation,
logger,
cache,
concurrency,
pattern,
index,
) {
const { RawSource } = compiler.webpack.sources;
logger.log(
`starting to process a pattern from '${pattern.from}' using '${pattern.context}' context`,
);
const absoluteFrom = path.isAbsolute(pattern.from)
? path.normalize(pattern.from)
: path.resolve(pattern.context, pattern.from);
logger.debug(`getting stats for '${absoluteFrom}'...`);
const { inputFileSystem } =
/** @type {Compiler & { inputFileSystem: InputFileSystem }} */
(compiler);
let stats;
try {
stats = await stat(inputFileSystem, absoluteFrom);
} catch {
// Nothing
}
/**
* @type {"file" | "dir" | "glob"}
*/
let typeOfFrom;
if (stats) {
if (stats.isDirectory()) {
typeOfFrom = "dir";
logger.debug(`determined '${absoluteFrom}' is a directory`);
} else if (stats.isFile()) {
typeOfFrom = "file";
logger.debug(`determined '${absoluteFrom}' is a file`);
} else {
// Fallback
typeOfFrom = "glob";
logger.debug(`determined '${absoluteFrom}' is unknown`);
}
} else {
typeOfFrom = "glob";
logger.debug(`determined '${absoluteFrom}' is a glob`);
}
/** @type {GlobbyOptions} */
const globOptions = {
absolute: true,
followSymbolicLinks: true,
...pattern.globOptions,
cwd: pattern.context,
onlyFiles: true,
};
// Will work when https://github.com/SuperchupuDev/tinyglobby/issues/81 will be resolved, so let's pass it to `tinyglobby` right now
// @ts-expect-error - tinyglobby types are incomplete
globOptions.fs = inputFileSystem;
let glob;
switch (typeOfFrom) {
case "dir":
pattern.context = absoluteFrom;
glob = path.posix.join(
getTinyGlobby().escapePath(getNormalizePath()(absoluteFrom)),
"**/*",
);
if (typeof globOptions.dot === "undefined") {
globOptions.dot = true;
}
break;
case "file":
pattern.context = path.dirname(absoluteFrom);
glob = getTinyGlobby().escapePath(getNormalizePath()(absoluteFrom));
if (typeof globOptions.dot === "undefined") {
globOptions.dot = true;
}
break;
case "glob":
default: {
glob = path.isAbsolute(pattern.from)
? pattern.from
: path.posix.join(
getTinyGlobby().escapePath(getNormalizePath()(pattern.context)),
pattern.from,
);
}
}
logger.log(`begin globbing '${glob}'...`);
/**
* @type {string[]}
*/
let globEntries;
try {
globEntries = await globby(glob, globOptions);
} catch (error) {
compilation.errors.push(/** @type {Error} */ (error));
return;
}
if (globEntries.length === 0) {
await CopyPlugin.addCompilationDependency(
compilation,
typeOfFrom,
absoluteFrom,
inputFileSystem,
logger,
);
if (pattern.noErrorOnMissing) {
logger.log(
`finished to process a pattern from '${pattern.from}' using '${pattern.context}' context to '${pattern.to}'`,
);
return;
}
compilation.errors.push(new Error(`unable to locate '${glob}' glob`));
return;
}
await CopyPlugin.addCompilationDependency(
compilation,
typeOfFrom,
absoluteFrom,
null,
logger,
);
/**
* @type {(CopiedResult | undefined)[]}
*/
let copiedResult;
try {
copiedResult = await throttleAll(
concurrency,
globEntries.map((globEntry) => async () => {
if (pattern.filter) {
let isFiltered;
try {
isFiltered = await pattern.filter(globEntry);
} catch (error) {
compilation.errors.push(/** @type {Error} */ (error));
return;
}
if (!isFiltered) {
logger.log(`skip '${globEntry}', because it was filtered`);
return;
}
}
const absoluteFilename = path.normalize(globEntry);
logger.debug(`found '${absoluteFilename}'`);
const to =
typeof pattern.to === "function"
? await pattern.to({
context: pattern.context,
absoluteFilename,
})
: path.normalize(
typeof pattern.to !== "undefined" ? pattern.to : "",
);
const toType =
pattern.toType ||
(template.test(to)
? "template"
: path.extname(to) === "" || to.slice(-1) === path.sep
? "dir"
: "file");
logger.log(`'to' option '${to}' determinated as '${toType}'`);
const relativeFilename = path.relative(
pattern.context,
absoluteFilename,
);
let filename =
toType === "dir" ? path.join(to, relativeFilename) : to;
if (path.isAbsolute(filename)) {
filename = path.relative(
/** @type {string} */
(compiler.options.output.path),
filename,
);
}
logger.log(
`determined that '${absoluteFilename}' should write to '${filename}'`,
);
const sourceFilename = getNormalizePath()(
path.relative(compiler.context, absoluteFilename),
);
// If this came from a glob or dir, add it to the file dependencies
if (typeOfFrom === "dir" || typeOfFrom === "glob") {
compilation.fileDependencies.add(absoluteFilename);
logger.debug(`added '${absoluteFilename}' as a file dependency`);
}
let cacheEntry;
logger.debug(`getting cache for '${absoluteFilename}'...`);
try {
cacheEntry = await cache.getPromise(
`${sourceFilename}|${index}`,
null,
);
} catch (error) {
compilation.errors.push(/** @type {Error} */ (error));
return;
}
/**
* @type {Asset["source"] | undefined}
*/
let source;
if (cacheEntry) {
logger.debug(`found cache for '${absoluteFilename}'...`);
let isValidSnapshot;
logger.debug(
`checking snapshot on valid for '${absoluteFilename}'...`,
);
try {
isValidSnapshot = await CopyPlugin.checkSnapshotValid(
compilation,
cacheEntry.snapshot,
);
} catch (error) {
compilation.errors.push(/** @type {Error} */ (error));
return;
}
if (isValidSnapshot) {
logger.debug(`snapshot for '${absoluteFilename}' is valid`);
({ source } = cacheEntry);
} else {
logger.debug(`snapshot for '${absoluteFilename}' is invalid`);
}
} else {
logger.debug(`missed cache for '${absoluteFilename}'`);
}
if (!source) {
const startTime = Date.now();
logger.debug(`reading '${absoluteFilename}'...`);
let data;
try {
data = await readFile(inputFileSystem, absoluteFilename);
} catch (error) {
compilation.errors.push(/** @type {Error} */ (error));
return;
}
logger.debug(`read '${absoluteFilename}'`);
source = new RawSource(data);
let snapshot;
logger.debug(`creating snapshot for '${absoluteFilename}'...`);
try {
snapshot = await CopyPlugin.createSnapshot(
compilation,
startTime,
absoluteFilename,
);
} catch (error) {
compilation.errors.push(/** @type {Error} */ (error));
return;
}
if (snapshot) {
logger.debug(`created snapshot for '${absoluteFilename}'`);
logger.debug(`storing cache for '${absoluteFilename}'...`);
try {
await cache.storePromise(`${sourceFilename}|${index}`, null, {
source,
snapshot,
});
} catch (error) {
compilation.errors.push(/** @type {Error} */ (error));
return;
}
logger.debug(`stored cache for '${absoluteFilename}'`);
}
}
if (pattern.transform) {
/**
* @type {TransformerObject}
*/
const transformObj =
typeof pattern.transform === "function"
? { transformer: pattern.transform }
: pattern.transform;
if (transformObj.transformer) {
logger.log(`transforming content for '${absoluteFilename}'...`);
const buffer = source.buffer();
if (transformObj.cache) {
const hasher = compiler.webpack.util.createHash(
/** @type {string} */
(compilation.outputOptions.hashFunction),
);
const defaultCacheKeys = {
version,
sourceFilename,
transform: transformObj.transformer,
contentHash: hasher.update(buffer).digest("hex"),
index,
};
const cacheKeys = `transform|${getSerializeJavascript()(
typeof transformObj.cache === "boolean"
? defaultCacheKeys
: typeof transformObj.cache.keys === "function"
? await transformObj.cache.keys(
defaultCacheKeys,
absoluteFilename,
)
: { ...defaultCacheKeys, ...transformObj.cache.keys },
)}`;
logger.debug(
`getting transformation cache for '${absoluteFilename}'...`,
);
const cacheItem = cache.getItemCache(
cacheKeys,
cache.getLazyHashedEtag(source),
);
source = await cacheItem.getPromise();
logger.debug(
source
? `found transformation cache for '${absoluteFilename}'`
: `no transformation cache for '${absoluteFilename}'`,
);
if (!source) {
const transformed = await transformObj.transformer(
buffer,
absoluteFilename,
);
source = new RawSource(transformed);
logger.debug(
`caching transformation for '${absoluteFilename}'...`,
);
await cacheItem.storePromise(source);
logger.debug(
`cached transformation for '${absoluteFilename}'`,
);
}
} else {
source = new RawSource(
await transformObj.transformer(buffer, absoluteFilename),
);
}
}
}
/** @type {AssetInfo} */
let info =
typeof pattern.info === "undefined"
? {}
: typeof pattern.info === "function"
? pattern.info({
absoluteFilename,
sourceFilename,
filename,
toType,
}) || {}
: pattern.info || {};
if (toType === "template") {
logger.log(
`interpolating template '${filename}' for '${sourceFilename}'...`,
);
const contentHash = CopyPlugin.getContentHash(
compiler,
compilation,
source.buffer(),
);
const ext = path.extname(sourceFilename);
const base = path.basename(sourceFilename);
const name = base.slice(0, base.length - ext.length);
const data = {
filename: getNormalizePath()(relativeFilename),
contentHash,
chunk: {
name,
id: /** @type {string} */ (sourceFilename),
hash: contentHash,
},
};
const { path: interpolatedFilename, info: assetInfo } =
compilation.getPathWithInfo(getNormalizePath()(filename), data);
info = { ...info, ...assetInfo };
filename = interpolatedFilename;
logger.log(
`interpolated template '${filename}' for '${sourceFilename}'`,
);
} else {
filename = getNormalizePath()(filename);
}
return {
sourceFilename,
absoluteFilename,
filename,
source,
info,
force: pattern.force,
};
}),
);
} catch (error) {
compilation.errors.push(/** @type {Error} */ (error));
return;
}
if (copiedResult.length === 0) {
if (pattern.noErrorOnMissing) {
logger.log(
`finished to process a pattern from '${pattern.from}' using '${pattern.context}' context to '${pattern.to}'`,
);
return;
}
compilation.errors.push(
new Error(`Unable to locate '${glob}' glob after filtering paths`),
);
return;
}
logger.log(
`finished to process a pattern from '${pattern.from}' using '${pattern.context}' context`,
);
return copiedResult;
}
/**
* @param {Compiler} compiler the compiler
*/
apply(compiler) {
const pluginName = this.constructor.name;
compiler.hooks.thisCompilation.tap(pluginName, (compilation) => {
const logger = compilation.getLogger("copy-webpack-plugin");
const cache = compilation.getCache("CopyWebpackPlugin");
/**
* @type {typeof import("tinyglobby").glob}
*/
let globby;
compilation.hooks.processAssets.tapAsync(
{
name: PLUGIN_NAME,
stage: compiler.webpack.Compilation.PROCESS_ASSETS_STAGE_ADDITIONAL,
},
async (unusedAssets, callback) => {
if (typeof globby === "undefined") {
try {
globby = await getTinyGlobby().glob;
} catch (error) {
callback(/** @type {Error} */ (error));
return;
}
}
logger.log("starting to add additional assets...");
const concurrency = this.options.concurrency || 100;
/** @type {Map<number, Map<number, CopiedResult[]>>} */
const copiedResultMap = new Map();
await throttleAll(
// Should be enough, it might be worth considering an option for this, but in real configurations it usually doesn't exceed this value
// https://github.com/webpack/copy-webpack-plugin/issues/627
2,
this.patterns.map((item, index) => async () => {
/**
* @type {ObjectPattern}
*/
const pattern =
typeof item === "string" ? { from: item } : { ...item };
const context =
typeof pattern.context === "undefined"
? compiler.context
: path.isAbsolute(pattern.context)
? pattern.context
: path.join(compiler.context, pattern.context);
pattern.context = context;
/**
* @type {(CopiedResult | undefined)[] | undefined}
*/
let copiedResult;
const fromList = Array.isArray(pattern.from)
? pattern.from
: [pattern.from];
if (fromList.length === 0) {
copiedResult = [];
} else if (fromList.length > 1) {
const results = [];
for (let i = 0; i < fromList.length; i++) {
const from = fromList[i];
const arrayPattern = { ...pattern, from };
try {
const result = await CopyPlugin.glob(
globby,
compiler,
compilation,
logger,
cache,
concurrency,
/** @type {ObjectPattern & { context: string }} */
(arrayPattern),
index * 1000 + i, // Unique index for caching
);
if (result) {
results.push(...result);
}
} catch (error) {
compilation.errors.push(/** @type {Error} */ (error));
// Continue with next from in array
continue;
}
}
copiedResult = results;
} else {
const singlePattern = {
...pattern,
from: /** @type {string} */ (fromList[0]),
};
try {
copiedResult = await CopyPlugin.glob(
globby,
compiler,
compilation,
logger,
cache,
concurrency,
/** @type {ObjectPattern & { context: string }} */
(singlePattern),
index,
);
} catch (error) {
compilation.errors.push(/** @type {Error} */ (error));
return;
}
}
if (!copiedResult) {
return;
}
/**
* @type {CopiedResult[]}
*/
let filteredCopiedResult = copiedResult.filter(
/**
* @param {CopiedResult | undefined} result The result to filter
* @returns {result is CopiedResult} True if the result is defined
*/
(result) => result !== undefined,
);
if (typeof pattern.transformAll !== "undefined") {
if (typeof pattern.to === "undefined") {
compilation.errors.push(
new Error(
`Invalid "pattern.to" for the "pattern.from": "${pattern.from}" and "pattern.transformAll" function. The "to" option must be specified.`,
),
);
return;
}
filteredCopiedResult.sort((a, b) =>
a.absoluteFilename > b.absoluteFilename
? 1
: a.absoluteFilename < b.absoluteFilename
? -1
: 0,
);
const mergedEtag =
filteredCopiedResult.length === 1
? cache.getLazyHashedEtag(filteredCopiedResult[0].source)
: filteredCopiedResult.reduce(
/**
* @param {Etag} accumulator merged Etag accumulator
* @param {CopiedResult} asset /copied asset to merge Etag with
* @param {number} i index of the asset in the array
* @returns {Etag} merged Etag
*/
// @ts-expect-error - webpack cache types are incomplete
(accumulator, asset, i) => {
accumulator = cache.mergeEtags(
i === 1
? cache.getLazyHashedEtag(
/** @type {CopiedResult} */ (accumulator)
.source,
)
: accumulator,
cache.getLazyHashedEtag(asset.source),
);
return accumulator;
},
);
const cacheItem = cache.getItemCache(