Module.js
30.1 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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
/*
MIT License http://www.opensource.org/licenses/mit-license.php
Author Tobias Koppers @sokra
*/
"use strict";
const util = require("util");
const ChunkGraph = require("./ChunkGraph");
const DependenciesBlock = require("./DependenciesBlock");
const ModuleGraph = require("./ModuleGraph");
const RuntimeGlobals = require("./RuntimeGlobals");
const { first } = require("./util/SetHelpers");
const { compareChunksById } = require("./util/comparators");
const makeSerializable = require("./util/makeSerializable");
/** @typedef {import("webpack-sources").Source} Source */
/** @typedef {import("../declarations/WebpackOptions").ResolveOptions} ResolveOptions */
/** @typedef {import("../declarations/WebpackOptions").WebpackOptionsNormalized} WebpackOptions */
/** @typedef {import("./Chunk")} Chunk */
/** @typedef {import("./ChunkGroup")} ChunkGroup */
/** @typedef {import("./CodeGenerationResults")} CodeGenerationResults */
/** @typedef {import("./Compilation")} Compilation */
/** @typedef {import("./ConcatenationScope")} ConcatenationScope */
/** @typedef {import("./Dependency")} Dependency */
/** @typedef {import("./Dependency").UpdateHashContext} UpdateHashContext */
/** @typedef {import("./DependencyTemplates")} DependencyTemplates */
/** @typedef {import("./ExportsInfo").UsageStateType} UsageStateType */
/** @typedef {import("./FileSystemInfo")} FileSystemInfo */
/** @typedef {import("./ModuleGraphConnection").ConnectionState} ConnectionState */
/** @typedef {import("./NormalModuleFactory")} NormalModuleFactory */
/** @typedef {import("./RequestShortener")} RequestShortener */
/** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
/** @typedef {import("./RuntimeTemplate")} RuntimeTemplate */
/** @typedef {import("./WebpackError")} WebpackError */
/** @typedef {import("./util/Hash")} Hash */
/** @template T @typedef {import("./util/LazySet")<T>} LazySet<T> */
/** @template T @typedef {import("./util/SortableSet")<T>} SortableSet<T> */
/** @typedef {import("./util/fs").InputFileSystem} InputFileSystem */
/** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
/**
* @typedef {Object} SourceContext
* @property {DependencyTemplates} dependencyTemplates the dependency templates
* @property {RuntimeTemplate} runtimeTemplate the runtime template
* @property {ModuleGraph} moduleGraph the module graph
* @property {ChunkGraph} chunkGraph the chunk graph
* @property {RuntimeSpec} runtime the runtimes code should be generated for
* @property {string=} type the type of source that should be generated
*/
// TODO webpack 6: compilation will be required in CodeGenerationContext
/**
* @typedef {Object} CodeGenerationContext
* @property {DependencyTemplates} dependencyTemplates the dependency templates
* @property {RuntimeTemplate} runtimeTemplate the runtime template
* @property {ModuleGraph} moduleGraph the module graph
* @property {ChunkGraph} chunkGraph the chunk graph
* @property {RuntimeSpec} runtime the runtimes code should be generated for
* @property {ConcatenationScope=} concatenationScope when in concatenated module, information about other concatenated modules
* @property {CodeGenerationResults} codeGenerationResults code generation results of other modules (need to have a codeGenerationDependency to use that)
* @property {Compilation=} compilation the compilation
* @property {ReadonlySet<string>=} sourceTypes source types
*/
/**
* @typedef {Object} ConcatenationBailoutReasonContext
* @property {ModuleGraph} moduleGraph the module graph
* @property {ChunkGraph} chunkGraph the chunk graph
*/
/**
* @typedef {Object} CodeGenerationResult
* @property {Map<string, Source>} sources the resulting sources for all source types
* @property {Map<string, any>=} data the resulting data for all source types
* @property {ReadonlySet<string>} runtimeRequirements the runtime requirements
* @property {string=} hash a hash of the code generation result (will be automatically calculated from sources and runtimeRequirements if not provided)
*/
/**
* @typedef {Object} LibIdentOptions
* @property {string} context absolute context path to which lib ident is relative to
* @property {Object=} associatedObjectForCache object for caching
*/
/**
* @typedef {Object} KnownBuildMeta
* @property {string=} moduleArgument
* @property {string=} exportsArgument
* @property {boolean=} strict
* @property {string=} moduleConcatenationBailout
* @property {("default" | "namespace" | "flagged" | "dynamic")=} exportsType
* @property {(false | "redirect" | "redirect-warn")=} defaultObject
* @property {boolean=} strictHarmonyModule
* @property {boolean=} async
* @property {boolean=} sideEffectFree
*/
/**
* @typedef {Object} NeedBuildContext
* @property {Compilation} compilation
* @property {FileSystemInfo} fileSystemInfo
* @property {Map<string, string | Set<string>>} valueCacheVersions
*/
/** @typedef {KnownBuildMeta & Record<string, any>} BuildMeta */
const EMPTY_RESOLVE_OPTIONS = {};
let debugId = 1000;
const DEFAULT_TYPES_UNKNOWN = new Set(["unknown"]);
const DEFAULT_TYPES_JS = new Set(["javascript"]);
const deprecatedNeedRebuild = util.deprecate(
(module, context) => {
return module.needRebuild(
context.fileSystemInfo.getDeprecatedFileTimestamps(),
context.fileSystemInfo.getDeprecatedContextTimestamps()
);
},
"Module.needRebuild is deprecated in favor of Module.needBuild",
"DEP_WEBPACK_MODULE_NEED_REBUILD"
);
/** @typedef {(requestShortener: RequestShortener) => string} OptimizationBailoutFunction */
class Module extends DependenciesBlock {
/**
* @param {string} type the module type
* @param {string=} context an optional context
* @param {string=} layer an optional layer in which the module is
*/
constructor(type, context = null, layer = null) {
super();
/** @type {string} */
this.type = type;
/** @type {string | null} */
this.context = context;
/** @type {string | null} */
this.layer = layer;
/** @type {boolean} */
this.needId = true;
// Unique Id
/** @type {number} */
this.debugId = debugId++;
// Info from Factory
/** @type {ResolveOptions} */
this.resolveOptions = EMPTY_RESOLVE_OPTIONS;
/** @type {object | undefined} */
this.factoryMeta = undefined;
// TODO refactor this -> options object filled from Factory
// TODO webpack 6: use an enum
/** @type {boolean} */
this.useSourceMap = false;
/** @type {boolean} */
this.useSimpleSourceMap = false;
// Info from Build
/** @type {WebpackError[] | undefined} */
this._warnings = undefined;
/** @type {WebpackError[] | undefined} */
this._errors = undefined;
/** @type {BuildMeta} */
this.buildMeta = undefined;
/** @type {Record<string, any>} */
this.buildInfo = undefined;
/** @type {Dependency[] | undefined} */
this.presentationalDependencies = undefined;
/** @type {Dependency[] | undefined} */
this.codeGenerationDependencies = undefined;
}
// TODO remove in webpack 6
// BACKWARD-COMPAT START
get id() {
return ChunkGraph.getChunkGraphForModule(
this,
"Module.id",
"DEP_WEBPACK_MODULE_ID"
).getModuleId(this);
}
set id(value) {
if (value === "") {
this.needId = false;
return;
}
ChunkGraph.getChunkGraphForModule(
this,
"Module.id",
"DEP_WEBPACK_MODULE_ID"
).setModuleId(this, value);
}
/**
* @returns {string} the hash of the module
*/
get hash() {
return ChunkGraph.getChunkGraphForModule(
this,
"Module.hash",
"DEP_WEBPACK_MODULE_HASH"
).getModuleHash(this, undefined);
}
/**
* @returns {string} the shortened hash of the module
*/
get renderedHash() {
return ChunkGraph.getChunkGraphForModule(
this,
"Module.renderedHash",
"DEP_WEBPACK_MODULE_RENDERED_HASH"
).getRenderedModuleHash(this, undefined);
}
get profile() {
return ModuleGraph.getModuleGraphForModule(
this,
"Module.profile",
"DEP_WEBPACK_MODULE_PROFILE"
).getProfile(this);
}
set profile(value) {
ModuleGraph.getModuleGraphForModule(
this,
"Module.profile",
"DEP_WEBPACK_MODULE_PROFILE"
).setProfile(this, value);
}
get index() {
return ModuleGraph.getModuleGraphForModule(
this,
"Module.index",
"DEP_WEBPACK_MODULE_INDEX"
).getPreOrderIndex(this);
}
set index(value) {
ModuleGraph.getModuleGraphForModule(
this,
"Module.index",
"DEP_WEBPACK_MODULE_INDEX"
).setPreOrderIndex(this, value);
}
get index2() {
return ModuleGraph.getModuleGraphForModule(
this,
"Module.index2",
"DEP_WEBPACK_MODULE_INDEX2"
).getPostOrderIndex(this);
}
set index2(value) {
ModuleGraph.getModuleGraphForModule(
this,
"Module.index2",
"DEP_WEBPACK_MODULE_INDEX2"
).setPostOrderIndex(this, value);
}
get depth() {
return ModuleGraph.getModuleGraphForModule(
this,
"Module.depth",
"DEP_WEBPACK_MODULE_DEPTH"
).getDepth(this);
}
set depth(value) {
ModuleGraph.getModuleGraphForModule(
this,
"Module.depth",
"DEP_WEBPACK_MODULE_DEPTH"
).setDepth(this, value);
}
get issuer() {
return ModuleGraph.getModuleGraphForModule(
this,
"Module.issuer",
"DEP_WEBPACK_MODULE_ISSUER"
).getIssuer(this);
}
set issuer(value) {
ModuleGraph.getModuleGraphForModule(
this,
"Module.issuer",
"DEP_WEBPACK_MODULE_ISSUER"
).setIssuer(this, value);
}
get usedExports() {
return ModuleGraph.getModuleGraphForModule(
this,
"Module.usedExports",
"DEP_WEBPACK_MODULE_USED_EXPORTS"
).getUsedExports(this, undefined);
}
/**
* @deprecated
* @returns {(string | OptimizationBailoutFunction)[]} list
*/
get optimizationBailout() {
return ModuleGraph.getModuleGraphForModule(
this,
"Module.optimizationBailout",
"DEP_WEBPACK_MODULE_OPTIMIZATION_BAILOUT"
).getOptimizationBailout(this);
}
get optional() {
return this.isOptional(
ModuleGraph.getModuleGraphForModule(
this,
"Module.optional",
"DEP_WEBPACK_MODULE_OPTIONAL"
)
);
}
addChunk(chunk) {
const chunkGraph = ChunkGraph.getChunkGraphForModule(
this,
"Module.addChunk",
"DEP_WEBPACK_MODULE_ADD_CHUNK"
);
if (chunkGraph.isModuleInChunk(this, chunk)) return false;
chunkGraph.connectChunkAndModule(chunk, this);
return true;
}
removeChunk(chunk) {
return ChunkGraph.getChunkGraphForModule(
this,
"Module.removeChunk",
"DEP_WEBPACK_MODULE_REMOVE_CHUNK"
).disconnectChunkAndModule(chunk, this);
}
isInChunk(chunk) {
return ChunkGraph.getChunkGraphForModule(
this,
"Module.isInChunk",
"DEP_WEBPACK_MODULE_IS_IN_CHUNK"
).isModuleInChunk(this, chunk);
}
isEntryModule() {
return ChunkGraph.getChunkGraphForModule(
this,
"Module.isEntryModule",
"DEP_WEBPACK_MODULE_IS_ENTRY_MODULE"
).isEntryModule(this);
}
getChunks() {
return ChunkGraph.getChunkGraphForModule(
this,
"Module.getChunks",
"DEP_WEBPACK_MODULE_GET_CHUNKS"
).getModuleChunks(this);
}
getNumberOfChunks() {
return ChunkGraph.getChunkGraphForModule(
this,
"Module.getNumberOfChunks",
"DEP_WEBPACK_MODULE_GET_NUMBER_OF_CHUNKS"
).getNumberOfModuleChunks(this);
}
get chunksIterable() {
return ChunkGraph.getChunkGraphForModule(
this,
"Module.chunksIterable",
"DEP_WEBPACK_MODULE_CHUNKS_ITERABLE"
).getOrderedModuleChunksIterable(this, compareChunksById);
}
/**
* @param {string} exportName a name of an export
* @returns {boolean | null} true, if the export is provided why the module.
* null, if it's unknown.
* false, if it's not provided.
*/
isProvided(exportName) {
return ModuleGraph.getModuleGraphForModule(
this,
"Module.usedExports",
"DEP_WEBPACK_MODULE_USED_EXPORTS"
).isExportProvided(this, exportName);
}
// BACKWARD-COMPAT END
/**
* @returns {string} name of the exports argument
*/
get exportsArgument() {
return (this.buildInfo && this.buildInfo.exportsArgument) || "exports";
}
/**
* @returns {string} name of the module argument
*/
get moduleArgument() {
return (this.buildInfo && this.buildInfo.moduleArgument) || "module";
}
/**
* @param {ModuleGraph} moduleGraph the module graph
* @param {boolean} strict the importing module is strict
* @returns {"namespace" | "default-only" | "default-with-named" | "dynamic"} export type
* "namespace": Exports is already a namespace object. namespace = exports.
* "dynamic": Check at runtime if __esModule is set. When set: namespace = { ...exports, default: exports }. When not set: namespace = { default: exports }.
* "default-only": Provide a namespace object with only default export. namespace = { default: exports }
* "default-with-named": Provide a namespace object with named and default export. namespace = { ...exports, default: exports }
*/
getExportsType(moduleGraph, strict) {
switch (this.buildMeta && this.buildMeta.exportsType) {
case "flagged":
return strict ? "default-with-named" : "namespace";
case "namespace":
return "namespace";
case "default":
switch (this.buildMeta.defaultObject) {
case "redirect":
return "default-with-named";
case "redirect-warn":
return strict ? "default-only" : "default-with-named";
default:
return "default-only";
}
case "dynamic": {
if (strict) return "default-with-named";
// Try to figure out value of __esModule by following reexports
const handleDefault = () => {
switch (this.buildMeta.defaultObject) {
case "redirect":
case "redirect-warn":
return "default-with-named";
default:
return "default-only";
}
};
const exportInfo = moduleGraph.getReadOnlyExportInfo(
this,
"__esModule"
);
if (exportInfo.provided === false) {
return handleDefault();
}
const target = exportInfo.getTarget(moduleGraph);
if (
!target ||
!target.export ||
target.export.length !== 1 ||
target.export[0] !== "__esModule"
) {
return "dynamic";
}
switch (
target.module.buildMeta &&
target.module.buildMeta.exportsType
) {
case "flagged":
case "namespace":
return "namespace";
case "default":
return handleDefault();
default:
return "dynamic";
}
}
default:
return strict ? "default-with-named" : "dynamic";
}
}
/**
* @param {Dependency} presentationalDependency dependency being tied to module.
* This is a Dependency without edge in the module graph. It's only for presentation.
* @returns {void}
*/
addPresentationalDependency(presentationalDependency) {
if (this.presentationalDependencies === undefined) {
this.presentationalDependencies = [];
}
this.presentationalDependencies.push(presentationalDependency);
}
/**
* @param {Dependency} codeGenerationDependency dependency being tied to module.
* This is a Dependency where the code generation result of the referenced module is needed during code generation.
* The Dependency should also be added to normal dependencies via addDependency.
* @returns {void}
*/
addCodeGenerationDependency(codeGenerationDependency) {
if (this.codeGenerationDependencies === undefined) {
this.codeGenerationDependencies = [];
}
this.codeGenerationDependencies.push(codeGenerationDependency);
}
/**
* Removes all dependencies and blocks
* @returns {void}
*/
clearDependenciesAndBlocks() {
if (this.presentationalDependencies !== undefined) {
this.presentationalDependencies.length = 0;
}
if (this.codeGenerationDependencies !== undefined) {
this.codeGenerationDependencies.length = 0;
}
super.clearDependenciesAndBlocks();
}
/**
* @param {WebpackError} warning the warning
* @returns {void}
*/
addWarning(warning) {
if (this._warnings === undefined) {
this._warnings = [];
}
this._warnings.push(warning);
}
/**
* @returns {Iterable<WebpackError> | undefined} list of warnings if any
*/
getWarnings() {
return this._warnings;
}
/**
* @returns {number} number of warnings
*/
getNumberOfWarnings() {
return this._warnings !== undefined ? this._warnings.length : 0;
}
/**
* @param {WebpackError} error the error
* @returns {void}
*/
addError(error) {
if (this._errors === undefined) {
this._errors = [];
}
this._errors.push(error);
}
/**
* @returns {Iterable<WebpackError> | undefined} list of errors if any
*/
getErrors() {
return this._errors;
}
/**
* @returns {number} number of errors
*/
getNumberOfErrors() {
return this._errors !== undefined ? this._errors.length : 0;
}
/**
* removes all warnings and errors
* @returns {void}
*/
clearWarningsAndErrors() {
if (this._warnings !== undefined) {
this._warnings.length = 0;
}
if (this._errors !== undefined) {
this._errors.length = 0;
}
}
/**
* @param {ModuleGraph} moduleGraph the module graph
* @returns {boolean} true, if the module is optional
*/
isOptional(moduleGraph) {
let hasConnections = false;
for (const r of moduleGraph.getIncomingConnections(this)) {
if (
!r.dependency ||
!r.dependency.optional ||
!r.isTargetActive(undefined)
) {
return false;
}
hasConnections = true;
}
return hasConnections;
}
/**
* @param {ChunkGraph} chunkGraph the chunk graph
* @param {Chunk} chunk a chunk
* @param {Chunk=} ignoreChunk chunk to be ignored
* @returns {boolean} true, if the module is accessible from "chunk" when ignoring "ignoreChunk"
*/
isAccessibleInChunk(chunkGraph, chunk, ignoreChunk) {
// Check if module is accessible in ALL chunk groups
for (const chunkGroup of chunk.groupsIterable) {
if (!this.isAccessibleInChunkGroup(chunkGraph, chunkGroup)) return false;
}
return true;
}
/**
* @param {ChunkGraph} chunkGraph the chunk graph
* @param {ChunkGroup} chunkGroup a chunk group
* @param {Chunk=} ignoreChunk chunk to be ignored
* @returns {boolean} true, if the module is accessible from "chunkGroup" when ignoring "ignoreChunk"
*/
isAccessibleInChunkGroup(chunkGraph, chunkGroup, ignoreChunk) {
const queue = new Set([chunkGroup]);
// Check if module is accessible from all items of the queue
queueFor: for (const cg of queue) {
// 1. If module is in one of the chunks of the group we can continue checking the next items
// because it's accessible.
for (const chunk of cg.chunks) {
if (chunk !== ignoreChunk && chunkGraph.isModuleInChunk(this, chunk))
continue queueFor;
}
// 2. If the chunk group is initial, we can break here because it's not accessible.
if (chunkGroup.isInitial()) return false;
// 3. Enqueue all parents because it must be accessible from ALL parents
for (const parent of chunkGroup.parentsIterable) queue.add(parent);
}
// When we processed through the whole list and we didn't bailout, the module is accessible
return true;
}
/**
* @param {Chunk} chunk a chunk
* @param {ModuleGraph} moduleGraph the module graph
* @param {ChunkGraph} chunkGraph the chunk graph
* @returns {boolean} true, if the module has any reason why "chunk" should be included
*/
hasReasonForChunk(chunk, moduleGraph, chunkGraph) {
// check for each reason if we need the chunk
for (const [
fromModule,
connections
] of moduleGraph.getIncomingConnectionsByOriginModule(this)) {
if (!connections.some(c => c.isTargetActive(chunk.runtime))) continue;
for (const originChunk of chunkGraph.getModuleChunksIterable(
fromModule
)) {
// return true if module this is not reachable from originChunk when ignoring chunk
if (!this.isAccessibleInChunk(chunkGraph, originChunk, chunk))
return true;
}
}
return false;
}
/**
* @param {ModuleGraph} moduleGraph the module graph
* @param {RuntimeSpec} runtime the runtime
* @returns {boolean} true if at least one other module depends on this module
*/
hasReasons(moduleGraph, runtime) {
for (const c of moduleGraph.getIncomingConnections(this)) {
if (c.isTargetActive(runtime)) return true;
}
return false;
}
/**
* @returns {string} for debugging
*/
toString() {
return `Module[${this.debugId}: ${this.identifier()}]`;
}
/**
* @param {NeedBuildContext} context context info
* @param {function((WebpackError | null)=, boolean=): void} callback callback function, returns true, if the module needs a rebuild
* @returns {void}
*/
needBuild(context, callback) {
callback(
null,
!this.buildMeta ||
this.needRebuild === Module.prototype.needRebuild ||
deprecatedNeedRebuild(this, context)
);
}
/**
* @deprecated Use needBuild instead
* @param {Map<string, number|null>} fileTimestamps timestamps of files
* @param {Map<string, number|null>} contextTimestamps timestamps of directories
* @returns {boolean} true, if the module needs a rebuild
*/
needRebuild(fileTimestamps, contextTimestamps) {
return true;
}
/**
* @param {Hash} hash the hash used to track dependencies
* @param {UpdateHashContext} context context
* @returns {void}
*/
updateHash(
hash,
context = {
chunkGraph: ChunkGraph.getChunkGraphForModule(
this,
"Module.updateHash",
"DEP_WEBPACK_MODULE_UPDATE_HASH"
),
runtime: undefined
}
) {
const { chunkGraph, runtime } = context;
hash.update(chunkGraph.getModuleGraphHash(this, runtime));
if (this.presentationalDependencies !== undefined) {
for (const dep of this.presentationalDependencies) {
dep.updateHash(hash, context);
}
}
super.updateHash(hash, context);
}
/**
* @returns {void}
*/
invalidateBuild() {
// should be overridden to support this feature
}
/* istanbul ignore next */
/**
* @abstract
* @returns {string} a unique identifier of the module
*/
identifier() {
const AbstractMethodError = require("./AbstractMethodError");
throw new AbstractMethodError();
}
/* istanbul ignore next */
/**
* @abstract
* @param {RequestShortener} requestShortener the request shortener
* @returns {string} a user readable identifier of the module
*/
readableIdentifier(requestShortener) {
const AbstractMethodError = require("./AbstractMethodError");
throw new AbstractMethodError();
}
/* istanbul ignore next */
/**
* @abstract
* @param {WebpackOptions} options webpack options
* @param {Compilation} compilation the compilation
* @param {ResolverWithOptions} resolver the resolver
* @param {InputFileSystem} fs the file system
* @param {function(WebpackError=): void} callback callback function
* @returns {void}
*/
build(options, compilation, resolver, fs, callback) {
const AbstractMethodError = require("./AbstractMethodError");
throw new AbstractMethodError();
}
/**
* @abstract
* @returns {Set<string>} types available (do not mutate)
*/
getSourceTypes() {
// Better override this method to return the correct types
if (this.source === Module.prototype.source) {
return DEFAULT_TYPES_UNKNOWN;
} else {
return DEFAULT_TYPES_JS;
}
}
/**
* @abstract
* @deprecated Use codeGeneration() instead
* @param {DependencyTemplates} dependencyTemplates the dependency templates
* @param {RuntimeTemplate} runtimeTemplate the runtime template
* @param {string=} type the type of source that should be generated
* @returns {Source} generated source
*/
source(dependencyTemplates, runtimeTemplate, type = "javascript") {
if (this.codeGeneration === Module.prototype.codeGeneration) {
const AbstractMethodError = require("./AbstractMethodError");
throw new AbstractMethodError();
}
const chunkGraph = ChunkGraph.getChunkGraphForModule(
this,
"Module.source() is deprecated. Use Compilation.codeGenerationResults.getSource(module, runtime, type) instead",
"DEP_WEBPACK_MODULE_SOURCE"
);
/** @type {CodeGenerationContext} */
const codeGenContext = {
dependencyTemplates,
runtimeTemplate,
moduleGraph: chunkGraph.moduleGraph,
chunkGraph,
runtime: undefined,
codeGenerationResults: undefined
};
const sources = this.codeGeneration(codeGenContext).sources;
return type ? sources.get(type) : sources.get(first(this.getSourceTypes()));
}
/* istanbul ignore next */
/**
* @abstract
* @param {string=} type the source type for which the size should be estimated
* @returns {number} the estimated size of the module (must be non-zero)
*/
size(type) {
const AbstractMethodError = require("./AbstractMethodError");
throw new AbstractMethodError();
}
/**
* @param {LibIdentOptions} options options
* @returns {string | null} an identifier for library inclusion
*/
libIdent(options) {
return null;
}
/**
* @returns {string | null} absolute path which should be used for condition matching (usually the resource path)
*/
nameForCondition() {
return null;
}
/**
* @param {ConcatenationBailoutReasonContext} context context
* @returns {string | undefined} reason why this module can't be concatenated, undefined when it can be concatenated
*/
getConcatenationBailoutReason(context) {
return `Module Concatenation is not implemented for ${this.constructor.name}`;
}
/**
* @param {ModuleGraph} moduleGraph the module graph
* @returns {ConnectionState} how this module should be connected to referencing modules when consumed for side-effects only
*/
getSideEffectsConnectionState(moduleGraph) {
return true;
}
/**
* @param {CodeGenerationContext} context context for code generation
* @returns {CodeGenerationResult} result
*/
codeGeneration(context) {
// Best override this method
const sources = new Map();
for (const type of this.getSourceTypes()) {
if (type !== "unknown") {
sources.set(
type,
this.source(
context.dependencyTemplates,
context.runtimeTemplate,
type
)
);
}
}
return {
sources,
runtimeRequirements: new Set([
RuntimeGlobals.module,
RuntimeGlobals.exports,
RuntimeGlobals.require
])
};
}
/**
* @param {Chunk} chunk the chunk which condition should be checked
* @param {Compilation} compilation the compilation
* @returns {boolean} true, if the chunk is ok for the module
*/
chunkCondition(chunk, compilation) {
return true;
}
hasChunkCondition() {
return this.chunkCondition !== Module.prototype.chunkCondition;
}
/**
* Assuming this module is in the cache. Update the (cached) module with
* the fresh module from the factory. Usually updates internal references
* and properties.
* @param {Module} module fresh module
* @returns {void}
*/
updateCacheModule(module) {
this.type = module.type;
this.layer = module.layer;
this.context = module.context;
this.factoryMeta = module.factoryMeta;
this.resolveOptions = module.resolveOptions;
}
/**
* Module should be unsafe cached. Get data that's needed for that.
* This data will be passed to restoreFromUnsafeCache later.
* @returns {object} cached data
*/
getUnsafeCacheData() {
return {
factoryMeta: this.factoryMeta,
resolveOptions: this.resolveOptions
};
}
/**
* restore unsafe cache data
* @param {object} unsafeCacheData data from getUnsafeCacheData
* @param {NormalModuleFactory} normalModuleFactory the normal module factory handling the unsafe caching
*/
_restoreFromUnsafeCache(unsafeCacheData, normalModuleFactory) {
this.factoryMeta = unsafeCacheData.factoryMeta;
this.resolveOptions = unsafeCacheData.resolveOptions;
}
/**
* Assuming this module is in the cache. Remove internal references to allow freeing some memory.
*/
cleanupForCache() {
this.factoryMeta = undefined;
this.resolveOptions = undefined;
}
/**
* @returns {Source | null} the original source for the module before webpack transformation
*/
originalSource() {
return null;
}
/**
* @param {LazySet<string>} fileDependencies set where file dependencies are added to
* @param {LazySet<string>} contextDependencies set where context dependencies are added to
* @param {LazySet<string>} missingDependencies set where missing dependencies are added to
* @param {LazySet<string>} buildDependencies set where build dependencies are added to
*/
addCacheDependencies(
fileDependencies,
contextDependencies,
missingDependencies,
buildDependencies
) {}
serialize(context) {
const { write } = context;
write(this.type);
write(this.layer);
write(this.context);
write(this.resolveOptions);
write(this.factoryMeta);
write(this.useSourceMap);
write(this.useSimpleSourceMap);
write(
this._warnings !== undefined && this._warnings.length === 0
? undefined
: this._warnings
);
write(
this._errors !== undefined && this._errors.length === 0
? undefined
: this._errors
);
write(this.buildMeta);
write(this.buildInfo);
write(this.presentationalDependencies);
write(this.codeGenerationDependencies);
super.serialize(context);
}
deserialize(context) {
const { read } = context;
this.type = read();
this.layer = read();
this.context = read();
this.resolveOptions = read();
this.factoryMeta = read();
this.useSourceMap = read();
this.useSimpleSourceMap = read();
this._warnings = read();
this._errors = read();
this.buildMeta = read();
this.buildInfo = read();
this.presentationalDependencies = read();
this.codeGenerationDependencies = read();
super.deserialize(context);
}
}
makeSerializable(Module, "webpack/lib/Module");
// TODO remove in webpack 6
Object.defineProperty(Module.prototype, "hasEqualsChunks", {
get() {
throw new Error(
"Module.hasEqualsChunks was renamed (use hasEqualChunks instead)"
);
}
});
// TODO remove in webpack 6
Object.defineProperty(Module.prototype, "isUsed", {
get() {
throw new Error(
"Module.isUsed was renamed (use getUsedName, isExportUsed or isModuleUsed instead)"
);
}
});
// TODO remove in webpack 6
Object.defineProperty(Module.prototype, "errors", {
get: util.deprecate(
/**
* @this {Module}
* @returns {WebpackError[]} array
*/
function () {
if (this._errors === undefined) {
this._errors = [];
}
return this._errors;
},
"Module.errors was removed (use getErrors instead)",
"DEP_WEBPACK_MODULE_ERRORS"
)
});
// TODO remove in webpack 6
Object.defineProperty(Module.prototype, "warnings", {
get: util.deprecate(
/**
* @this {Module}
* @returns {WebpackError[]} array
*/
function () {
if (this._warnings === undefined) {
this._warnings = [];
}
return this._warnings;
},
"Module.warnings was removed (use getWarnings instead)",
"DEP_WEBPACK_MODULE_WARNINGS"
)
});
// TODO remove in webpack 6
Object.defineProperty(Module.prototype, "used", {
get() {
throw new Error(
"Module.used was refactored (use ModuleGraph.getUsedExports instead)"
);
},
set(value) {
throw new Error(
"Module.used was refactored (use ModuleGraph.setUsedExports instead)"
);
}
});
module.exports = Module;