-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Expand file tree
/
Copy pathNormalModule.js
More file actions
2342 lines (2187 loc) · 74.3 KB
/
Copy pathNormalModule.js
File metadata and controls
2342 lines (2187 loc) · 74.3 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
/*
MIT License http://www.opensource.org/licenses/mit-license.php
Author Tobias Koppers @sokra
*/
"use strict";
const querystring = require("querystring");
const { getContext, runLoaders } = require("loader-runner");
const {
AsyncSeriesBailHook,
HookMap,
SyncHook,
SyncWaterfallHook
} = require("tapable");
const {
CachedSource,
OriginalSource,
RawSource,
SourceMapSource
} = require("webpack-sources");
const Dependency = require("./Dependency");
const Module = require("./Module");
const ModuleGraphConnection = require("./ModuleGraphConnection");
const { JAVASCRIPT_MODULE_TYPE_AUTO } = require("./ModuleTypeConstants");
const RuntimeGlobals = require("./RuntimeGlobals");
const HookWebpackError = require("./errors/HookWebpackError");
const ModuleBuildError = require("./errors/ModuleBuildError");
const ModuleError = require("./errors/ModuleError");
const ModuleParseError = require("./errors/ModuleParseError");
const ModuleWarning = require("./errors/ModuleWarning");
const NonErrorEmittedError = require("./errors/NonErrorEmittedError");
const UnhandledSchemeError = require("./errors/UnhandledSchemeError");
const LazySet = require("./util/LazySet");
const { isSubset } = require("./util/SetHelpers");
const { getScheme } = require("./util/URLAbsoluteSpecifier");
const {
concatComparators,
keepOriginalOrder,
sortWithSourceOrder
} = require("./util/comparators");
const createHash = require("./util/createHash");
const createHooksRegistry = require("./util/createHooksRegistry");
const { createFakeHook } = require("./util/deprecation");
const formatLocation = require("./util/formatLocation");
const { join } = require("./util/fs");
const {
ABSOLUTE_PATH_REGEXP,
absolutify,
contextify,
makePathsRelative
} = require("./util/identifier");
const makeSerializable = require("./util/makeSerializable");
const memoize = require("./util/memoize");
const parseJson = require("./util/parseJson");
/** @typedef {import("enhanced-resolve").ResolveContext} ResolveContext */
/** @typedef {import("enhanced-resolve").ResolveRequest} ResolveRequest */
/** @typedef {import("webpack-sources").Source} Source */
/** @typedef {import("webpack-sources").RawSourceMap} RawSourceMap */
/** @typedef {import("../declarations/WebpackOptions").ResolveOptions} ResolveOptions */
/** @typedef {import("../declarations/WebpackOptions").NoParse} NoParse */
/** @typedef {import("./Compilation")} Compilation */
/** @typedef {import("./config/defaults").WebpackOptionsNormalizedWithDefaults} WebpackOptions */
/** @typedef {import("./Dependency").UpdateHashContext} UpdateHashContext */
/** @typedef {import("./Generator")} Generator */
/** @typedef {import("./Generator").GenerateErrorFn} GenerateErrorFn */
/** @typedef {import("./FileSystemInfo").Snapshot} Snapshot */
/** @typedef {import("./Module").BuildInfo} BuildInfo */
/** @typedef {import("./Module").FileSystemDependencies} FileSystemDependencies */
/** @typedef {import("./Module").ValueCacheVersions} ValueCacheVersions */
/** @typedef {import("./Module").BuildMeta} BuildMeta */
/** @typedef {import("./Module").CodeGenerationContext} CodeGenerationContext */
/** @typedef {import("./Module").CodeGenerationResult} CodeGenerationResult */
/** @typedef {import("./Module").CodeGenerationResultData} CodeGenerationResultData */
/** @typedef {import("./Module").ConcatenationBailoutReasonContext} ConcatenationBailoutReasonContext */
/** @typedef {import("./Module").KnownBuildInfo} KnownBuildInfo */
/** @typedef {import("./Module").LibIdentOptions} LibIdentOptions */
/** @typedef {import("./Module").LibIdent} LibIdent */
/** @typedef {import("./Module").NameForCondition} NameForCondition */
/** @typedef {import("./Module").NeedBuildContext} NeedBuildContext */
/** @typedef {import("./Module").NeedBuildCallback} NeedBuildCallback */
/** @typedef {import("./Module").BuildCallback} BuildCallback */
/** @typedef {import("./Module").RuntimeRequirements} RuntimeRequirements */
/** @typedef {import("./Module").Sources} Sources */
/** @typedef {import("./Module").SourceType} SourceType */
/** @typedef {import("./Module").SourceTypes} SourceTypes */
/** @typedef {import("./Module").UnsafeCacheData} UnsafeCacheData */
/** @typedef {import("./ModuleGraph")} ModuleGraph */
/** @typedef {import("./ModuleGraphConnection").ConnectionState} ConnectionState */
/** @typedef {import("./NormalModuleFactory")} NormalModuleFactory */
/** @typedef {import("./NormalModuleFactory").NormalModuleTypes} NormalModuleTypes */
/** @typedef {import("./NormalModuleFactory").ParserByType} ParserByType */
/** @typedef {import("./NormalModuleFactory").ParserOptionsByType} ParserOptionsByType */
/** @typedef {import("./NormalModuleFactory").GeneratorByType} GeneratorByType */
/** @typedef {import("./NormalModuleFactory").GeneratorOptionsByType} GeneratorOptionsByType */
/** @typedef {import("./NormalModuleFactory").ResourceSchemeData} ResourceSchemeData */
/** @typedef {import("./Parser")} Parser */
/** @typedef {import("./Parser").PreparsedAst} PreparsedAst */
/** @typedef {import("./RequestShortener")} RequestShortener */
/** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
/** @typedef {import("./util/Hash")} Hash */
/** @typedef {import("./util/fs").InputFileSystem} InputFileSystem */
/** @typedef {import("../declarations/WebpackOptions").HashFunction} HashFunction */
/** @typedef {import("./util/identifier").AssociatedObjectForCache} AssociatedObjectForCache */
/**
* @template T
* @typedef {import("./util/deprecation").FakeHook<T>} FakeHook
*/
/** @typedef {{ [k: string]: EXPECTED_ANY }} ParserOptions */
/** @typedef {{ [k: string]: EXPECTED_ANY }} GeneratorOptions */
/**
* @template T
* @typedef {import("../declarations/LoaderContext").LoaderContext<T>} LoaderContext
*/
/**
* @template T
* @typedef {import("../declarations/LoaderContext").NormalModuleLoaderContext<T>} NormalModuleLoaderContext
*/
/** @typedef {(content: string) => boolean} NoParseFn */
const getInvalidDependenciesModuleWarning = memoize(() =>
require("./errors/InvalidDependenciesModuleWarning")
);
const getExtractSourceMap = memoize(() => require("./util/extractSourceMap"));
const getValidate = memoize(() => require("schema-utils").validate);
const getHarmonyImportSideEffectDependency = memoize(() =>
require("./dependencies/HarmonyImportSideEffectDependency")
);
/**
* @param {NormalModule} mod the module
* @param {ModuleGraph} moduleGraph the module graph
* @param {Dependency} dep the dep that triggered the bailout
*/
const recordSideEffectsBailout = (mod, moduleGraph, dep) => {
if (mod._addedSideEffectsBailout === undefined) {
mod._addedSideEffectsBailout = new WeakSet();
} else if (mod._addedSideEffectsBailout.has(moduleGraph)) {
return;
}
mod._addedSideEffectsBailout.add(moduleGraph);
moduleGraph
.getOptimizationBailout(mod)
.push(
() =>
`Dependency (${dep.type}) with side effects at ${formatLocation(dep.loc)}`
);
};
// Maximum recursive descent depth before switching to the iterative walker.
// #20986 reported overflow around 1300 modules in webpack 5.107.0 where each
// step consumed two stack frames (`NormalModule.getSideEffectsConnectionState`
// plus `HarmonyImportSideEffectDependency.getModuleEvaluationSideEffectsState`).
// `walkSideEffectsRecursive` folds the second call into the first and uses
// one frame per module, so this limit caps the native stack at half the depth
// where the original code overflowed — well within the safe range across
// platforms while keeping the common (shallow) case purely recursive.
const SIDE_EFFECTS_RECURSION_LIMIT = 2000;
/**
* Iterative form of the side-effects walker. Used as a fallback once the
* recursive form reaches `SIDE_EFFECTS_RECURSION_LIMIT` so deep chains
* (#20986) don't overflow V8's stack. Safe to enter while ancestors set
* `_isEvaluatingSideEffects` on their own modules — those are treated as
* `CIRCULAR_CONNECTION` if revisited, matching the original recursive
* behavior.
* @param {NormalModule} rootMod the module to walk
* @param {ModuleGraph} moduleGraph the module graph
* @param {SideEffectsWalkContext} ctx per-walk cycle-tracking context
* @returns {ConnectionState} the side-effects connection state
*/
const walkSideEffectsIterative = (rootMod, moduleGraph, ctx) => {
const SideEffectDep = getHarmonyImportSideEffectDependency();
/** @type {NormalModule[]} */
const modStack = [rootMod];
/** @type {Dependency[][]} */
const depsStack = [rootMod.dependencies];
const indexStack = [0];
/** @type {ConnectionState[]} */
const currentStack = [false];
rootMod._isEvaluatingSideEffects = true;
/**
* Result from a just-popped child frame, to be applied to the new
* top's current dep. `undefined` means "no pending; advance".
* @type {ConnectionState | undefined}
*/
let pending;
while (modStack.length > 0) {
const top = modStack.length - 1;
const topMod = modStack[top];
const deps = depsStack[top];
let index = indexStack[top];
let current = currentStack[top];
if (pending !== undefined) {
const state = pending;
pending = undefined;
const dep = deps[index];
if (state === true) {
recordSideEffectsBailout(topMod, moduleGraph, dep);
topMod._isEvaluatingSideEffects = false;
// `true` is monotonic — safe to memoize regardless of cycle
// status, matching the direct-bailout branch below.
topMod._sideEffectsStateGraph = moduleGraph;
topMod._sideEffectsStateValue = true;
modStack.pop();
depsStack.pop();
indexStack.pop();
currentStack.pop();
pending = true;
continue;
}
if (state !== ModuleGraphConnection.CIRCULAR_CONNECTION) {
current = ModuleGraphConnection.addConnectionStates(current, state);
}
index++;
}
let descended = false;
const depCount = deps.length;
while (index < depCount) {
const dep = deps[index];
/** @type {ConnectionState} */
let state;
if (dep instanceof SideEffectDep) {
const refModule = moduleGraph.getModule(dep);
if (!refModule) {
state = true;
} else if (refModule instanceof NormalModule) {
// Cache hit
if (refModule._sideEffectsStateGraph === moduleGraph) {
state = /** @type {ConnectionState} */ (
refModule._sideEffectsStateValue
);
}
// Fast-path checks inlined to avoid the helper call.
else if (refModule.factoryMeta !== undefined) {
if (refModule.factoryMeta.sideEffectFree) {
state = false;
} else if (refModule.factoryMeta.sideEffectFree === false) {
state = true;
} else if (
!(
refModule.buildMeta !== undefined &&
refModule.buildMeta.sideEffectFree
)
) {
state = true;
} else if (refModule._isEvaluatingSideEffects) {
ctx.circular = true;
state = ModuleGraphConnection.CIRCULAR_CONNECTION;
} else {
// Descend
indexStack[top] = index;
currentStack[top] = current;
refModule._isEvaluatingSideEffects = true;
modStack.push(refModule);
depsStack.push(refModule.dependencies);
indexStack.push(0);
currentStack.push(false);
descended = true;
break;
}
} else if (
!(
refModule.buildMeta !== undefined &&
refModule.buildMeta.sideEffectFree
)
) {
state = true;
} else if (refModule._isEvaluatingSideEffects) {
ctx.circular = true;
state = ModuleGraphConnection.CIRCULAR_CONNECTION;
} else {
// Descend
indexStack[top] = index;
currentStack[top] = current;
refModule._isEvaluatingSideEffects = true;
modStack.push(refModule);
depsStack.push(refModule.dependencies);
indexStack.push(0);
currentStack.push(false);
descended = true;
break;
}
} else {
ctx.circular = true;
state = refModule.getSideEffectsConnectionState(moduleGraph);
}
} else {
state = dep.getModuleEvaluationSideEffectsState(moduleGraph);
}
if (state === true) {
recordSideEffectsBailout(topMod, moduleGraph, dep);
topMod._isEvaluatingSideEffects = false;
topMod._sideEffectsStateGraph = moduleGraph;
topMod._sideEffectsStateValue = true;
modStack.pop();
depsStack.pop();
indexStack.pop();
currentStack.pop();
pending = true;
descended = true;
break;
}
if (state !== ModuleGraphConnection.CIRCULAR_CONNECTION) {
current = ModuleGraphConnection.addConnectionStates(current, state);
}
index++;
}
if (descended) continue;
topMod._isEvaluatingSideEffects = false;
if (!ctx.circular) {
topMod._sideEffectsStateGraph = moduleGraph;
topMod._sideEffectsStateValue = current;
}
pending = current;
modStack.pop();
depsStack.pop();
indexStack.pop();
currentStack.pop();
}
return /** @type {ConnectionState} */ (pending);
};
/**
* @typedef {object} SideEffectsWalkContext
* @property {boolean} circular whether a cycle was seen anywhere in this walk
*/
/**
* Walks back up a stack of linear-chain ancestors, applying the result
* `state` of the chain's tail to each ancestor. Each ancestor in the
* stack had exactly one `HarmonyImportSideEffectDependency` returning
* `state`, so its result is just `state` (with the usual aggregation
* rules) and we can avoid building per-frame `current` accumulators.
* @param {(NormalModule | Dependency)[] | null} ancestors interleaved stack of `[mod, sideEffectDep, mod, sideEffectDep, …]` in descent order; `null` if there were none
* @param {ConnectionState} state result from the chain's tail
* @param {ModuleGraph} moduleGraph the module graph
* @param {SideEffectsWalkContext} ctx per-walk cycle-tracking context
* @returns {ConnectionState} the root ancestor's result
*/
const propagateLinearResult = (ancestors, state, moduleGraph, ctx) => {
if (ancestors === null) return state;
while (ancestors.length > 0) {
const dep = /** @type {Dependency} */ (ancestors.pop());
const ancestor = /** @type {NormalModule} */ (ancestors.pop());
ancestor._isEvaluatingSideEffects = false;
if (state === true) {
recordSideEffectsBailout(ancestor, moduleGraph, dep);
// `true` is monotonic — safe to cache regardless of cycle status.
ancestor._sideEffectsStateGraph = moduleGraph;
ancestor._sideEffectsStateValue = true;
} else if (state === ModuleGraphConnection.CIRCULAR_CONNECTION) {
// CIRCULAR_CONNECTION is filtered before folding into `current`,
// so the ancestor's `current` stays at its initial `false`. From
// this point upward the propagated state is `false`, and the
// cycle taint prevents memoization further up (handled by
// `ctx.circular`).
state = false;
} else if (!ctx.circular) {
ancestor._sideEffectsStateGraph = moduleGraph;
ancestor._sideEffectsStateValue = state;
}
}
return state;
};
/**
* Recursive form of the side-effects walker. Folds the descent through
* `HarmonyImportSideEffectDependency.getModuleEvaluationSideEffectsState`
* directly into the loop so each module costs only one V8 stack frame
* (vs. two in the original recursive code).
*
* Linear-chain heads (modules with exactly one
* `HarmonyImportSideEffectDependency` to another `NormalModule`) are
* walked iteratively inside the function via an explicit
* `linearAncestors` stack — no additional V8 frame per descent — and
* their results are propagated back up by `propagateLinearResult`. This
* keeps stack consumption at O(1) for the common deep-import-chain
* pattern that motivated #20986 and also avoids the heavier iterative
* fallback.
*
* Falls back to `walkSideEffectsIterative` only when a *non-linear*
* walk reaches `SIDE_EFFECTS_RECURSION_LIMIT` — i.e. a deep tree, where
* each level genuinely needs its own recursion frame.
*
* Caches the result on the module when the walk did not encounter a
* cycle, so subsequent queries (e.g. repeated lookups during
* `SideEffectsFlagPlugin`'s incoming-connection optimization and its
* `exportInfo.getTarget` callbacks) return in O(1).
* @param {NormalModule} mod the module being walked
* @param {ModuleGraph} moduleGraph the module graph
* @param {number} depth current recursion depth (only counts true V8 frames)
* @param {EXPECTED_ANY} SideEffectDep `HarmonyImportSideEffectDependency` constructor, resolved once at the public entry to avoid repeated `require` lookups in the recursive call
* @param {SideEffectsWalkContext} ctx per-walk cycle-tracking context
* @returns {ConnectionState} the side-effects connection state
*/
const walkSideEffectsRecursive = (
mod,
moduleGraph,
depth,
SideEffectDep,
ctx
) => {
// Interleaved `[mod, linearDep, mod, linearDep, …]` for the linear
// chain head; `null` until the first descent.
/** @type {(NormalModule | Dependency)[] | null} */
let linearAncestors = null;
// Walk the linear-chain head iteratively. Every loop iteration peels
// off one module without consuming a V8 stack frame.
while (true) {
if (mod._sideEffectsStateGraph === moduleGraph) {
return propagateLinearResult(
linearAncestors,
/** @type {ConnectionState} */ (mod._sideEffectsStateValue),
moduleGraph,
ctx
);
}
if (mod.factoryMeta !== undefined) {
if (mod.factoryMeta.sideEffectFree) {
return propagateLinearResult(linearAncestors, false, moduleGraph, ctx);
}
if (mod.factoryMeta.sideEffectFree === false) {
return propagateLinearResult(linearAncestors, true, moduleGraph, ctx);
}
}
if (!(mod.buildMeta !== undefined && mod.buildMeta.sideEffectFree)) {
return propagateLinearResult(linearAncestors, true, moduleGraph, ctx);
}
if (mod._isEvaluatingSideEffects) {
ctx.circular = true;
return propagateLinearResult(
linearAncestors,
ModuleGraphConnection.CIRCULAR_CONNECTION,
moduleGraph,
ctx
);
}
// A real ESM module's `dependencies` typically include one
// `HarmonyImportSideEffectDependency` plus several non-recursive deps
// (export specifiers, const dependencies, …) that report
// `false`/`CIRCULAR_CONNECTION` from
// `getModuleEvaluationSideEffectsState`. Walk the deps in order
// here: as long as at most one is a `SideEffectDep` and no
// non-recursive dep triggers a bailout or contributes a non-`false`
// state, we can still tail-call iteratively through that one
// `SideEffectDep` — no V8 frame needed. This is what keeps the
// 1300-module cyclic chain from #20986 from overflowing V8's stack
// even though each generated module has multiple `dependencies`.
const deps = mod.dependencies;
/** @type {Dependency | null} */
let linearDep = null;
/** @type {ConnectionState} */
let nonRecursiveCurrent = false;
let linearOk = true;
for (let i = 0; i < deps.length; i++) {
const dep = deps[i];
if (dep instanceof SideEffectDep) {
if (linearDep !== null) {
// Two `SideEffectDep`s in the same module — fall back to
// the general walk so each can recurse normally.
linearOk = false;
break;
}
linearDep = dep;
} else {
const state = dep.getModuleEvaluationSideEffectsState(moduleGraph);
if (state === true) {
recordSideEffectsBailout(mod, moduleGraph, dep);
mod._sideEffectsStateGraph = moduleGraph;
mod._sideEffectsStateValue = true;
return propagateLinearResult(linearAncestors, true, moduleGraph, ctx);
}
if (state !== ModuleGraphConnection.CIRCULAR_CONNECTION) {
nonRecursiveCurrent = ModuleGraphConnection.addConnectionStates(
nonRecursiveCurrent,
state
);
}
}
}
if (!linearOk || nonRecursiveCurrent !== false) {
// Multiple `SideEffectDep`s, or a non-recursive dep contributed
// a non-`false` state (e.g. `TRANSITIVE_ONLY`). The linear
// propagation rule "ancestor's current = chain state" no longer
// holds, so fall back to the general walk.
break;
}
if (linearDep === null) {
// No `SideEffectDep` — the module is a leaf as far as the
// side-effects graph is concerned. Cache and propagate `false`.
if (!ctx.circular) {
mod._sideEffectsStateGraph = moduleGraph;
mod._sideEffectsStateValue = false;
}
return propagateLinearResult(linearAncestors, false, moduleGraph, ctx);
}
const refModule = moduleGraph.getModule(linearDep);
if (!refModule) {
recordSideEffectsBailout(mod, moduleGraph, linearDep);
mod._sideEffectsStateGraph = moduleGraph;
mod._sideEffectsStateValue = true;
return propagateLinearResult(linearAncestors, true, moduleGraph, ctx);
}
if (!(refModule instanceof NormalModule)) {
// Non-NormalModule's `getSideEffectsConnectionState` re-enters
// the public method; defer to the general walk for safety.
break;
}
mod._isEvaluatingSideEffects = true;
if (linearAncestors === null) linearAncestors = [];
// Push (mod, linearDep) so `propagateLinearResult` records bailouts
// against the actual `SideEffectDep` that triggered the descent —
// which may not be `dependencies[0]` when the module also has
// export / const dependencies.
linearAncestors.push(mod, linearDep);
mod = refModule;
continue;
}
// Non-linear walk. Each genuine recursive call costs one V8 frame, so
// honour the depth limit here.
if (depth >= SIDE_EFFECTS_RECURSION_LIMIT) {
return propagateLinearResult(
linearAncestors,
walkSideEffectsIterative(mod, moduleGraph, ctx),
moduleGraph,
ctx
);
}
mod._isEvaluatingSideEffects = true;
/** @type {ConnectionState} */
let current = false;
for (const dep of mod.dependencies) {
/** @type {ConnectionState} */
let state;
if (dep instanceof SideEffectDep) {
const refModule = moduleGraph.getModule(dep);
if (!refModule) {
state = true;
} else if (refModule instanceof NormalModule) {
state = walkSideEffectsRecursive(
refModule,
moduleGraph,
depth + 1,
SideEffectDep,
ctx
);
} else {
// Non-NormalModule's `getSideEffectsConnectionState` (notably
// `ConcatenatedModule` delegating to its root) re-enters the
// public method and may walk through modules that the outer
// walk has marked as evaluating. We can't observe whether
// the inner walk hit a cycle that reflected the outer's
// state, so treat the walk as cycle-tainted and skip the
// cache for safety.
ctx.circular = true;
state = refModule.getSideEffectsConnectionState(moduleGraph);
}
} else {
state = dep.getModuleEvaluationSideEffectsState(moduleGraph);
}
if (state === true) {
recordSideEffectsBailout(mod, moduleGraph, dep);
mod._isEvaluatingSideEffects = false;
// `true` is monotonic — once any dep declares side effects, the
// answer is `true` regardless of how cycles resolve, so it's
// always safe to memoize.
mod._sideEffectsStateGraph = moduleGraph;
mod._sideEffectsStateValue = true;
return propagateLinearResult(linearAncestors, true, moduleGraph, ctx);
}
if (state !== ModuleGraphConnection.CIRCULAR_CONNECTION) {
current = ModuleGraphConnection.addConnectionStates(current, state);
}
}
mod._isEvaluatingSideEffects = false;
// Only memoize when no cycle has been observed anywhere in the walk
// since the public entry. A cycle anywhere can affect any ancestor's
// result (the back-edge target's contribution is hidden by
// CIRCULAR_CONNECTION short-circuiting), so this single flag is the
// conservative-but-cheap approximation of "this subtree's result is
// independent of cycle context". The public entry resets the flag.
if (!ctx.circular) {
mod._sideEffectsStateGraph = moduleGraph;
mod._sideEffectsStateValue = current;
}
return propagateLinearResult(linearAncestors, current, moduleGraph, ctx);
};
/**
* @typedef {object} LoaderItem
* @property {string} loader
* @property {string | null | undefined | Record<string, EXPECTED_ANY>} options
* @property {string | null=} ident
* @property {string | null=} type
*/
/**
* @param {string} context absolute context path
* @param {string} source a source path
* @param {AssociatedObjectForCache=} associatedObjectForCache an object to which the cache will be attached
* @returns {string} new source path
*/
const contextifySourceUrl = (context, source, associatedObjectForCache) => {
if (source.startsWith("webpack://")) return source;
return `webpack://${makePathsRelative(
context,
source,
associatedObjectForCache
)}`;
};
/**
* @param {string} context absolute context path
* @param {string | RawSourceMap} sourceMap a source map
* @param {AssociatedObjectForCache=} associatedObjectForCache an object to which the cache will be attached
* @returns {string | RawSourceMap} new source map
*/
const contextifySourceMap = (context, sourceMap, associatedObjectForCache) => {
if (typeof sourceMap === "string" || !Array.isArray(sourceMap.sources)) {
return sourceMap;
}
const { sourceRoot } = sourceMap;
/** @type {(source: string) => string} */
const mapper = !sourceRoot
? (source) => source
: sourceRoot.endsWith("/")
? (source) =>
source.startsWith("/")
? `${sourceRoot.slice(0, -1)}${source}`
: `${sourceRoot}${source}`
: (source) =>
source.startsWith("/")
? `${sourceRoot}${source}`
: `${sourceRoot}/${source}`;
const newSources = sourceMap.sources.map((source) =>
contextifySourceUrl(context, mapper(source), associatedObjectForCache)
);
return {
...sourceMap,
file: "x",
sourceRoot: undefined,
sources: newSources
};
};
/**
* @param {string | Buffer} input the input
* @returns {string} the converted string
*/
const asString = (input) => {
if (Buffer.isBuffer(input)) {
return input.toString("utf8");
}
return input;
};
/**
* @param {string | Buffer} input the input
* @returns {Buffer} the converted buffer
*/
const asBuffer = (input) => {
if (!Buffer.isBuffer(input)) {
return Buffer.from(input, "utf8");
}
return input;
};
/** @typedef {[string | Buffer, string | RawSourceMap | undefined, PreparsedAst | undefined]} Result */
/** @typedef {LoaderContext<EXPECTED_ANY>} AnyLoaderContext */
/**
* @deprecated Use the `readResource` hook instead.
* @typedef {HookMap<FakeHook<AsyncSeriesBailHook<[string, NormalModule], string | Buffer | null>>>} DeprecatedReadResourceForScheme
*/
/**
* @typedef {object} NormalModuleCompilationHooks
* @property {SyncHook<[AnyLoaderContext, NormalModule]>} loader
* @property {SyncHook<[LoaderItem[], NormalModule, AnyLoaderContext]>} beforeLoaders
* @property {SyncHook<[NormalModule]>} beforeParse
* @property {SyncHook<[NormalModule]>} beforeSnapshot
* @property {DeprecatedReadResourceForScheme} readResourceForScheme
* @property {HookMap<AsyncSeriesBailHook<[AnyLoaderContext], string | Buffer | null>>} readResource
* @property {SyncWaterfallHook<[Result, NormalModule]>} processResult
* @property {AsyncSeriesBailHook<[NormalModule, NeedBuildContext], boolean>} needBuild
*/
/**
* @template {NormalModuleTypes | ""} [T=NormalModuleTypes | ""]
* @typedef {object} NormalModuleCreateData
* @property {string=} layer an optional layer in which the module is
* @property {T} type module type. When deserializing, this is set to an empty string "".
* @property {string} request request string
* @property {string} userRequest request intended by user (without loaders from config)
* @property {string} rawRequest request without resolving
* @property {LoaderItem[]} loaders list of loaders
* @property {string} resource path + query of the real resource
* @property {(ResourceSchemeData & Partial<ResolveRequest>)=} resourceResolveData resource resolve data
* @property {string} context context directory for resolving
* @property {string=} matchResource path + query of the matched resource (virtual)
* @property {ParserByType[T]} parser the parser used
* @property {ParserOptionsByType[T]=} parserOptions the options of the parser used
* @property {GeneratorByType[T]} generator the generator used
* @property {GeneratorOptionsByType[T]=} generatorOptions the options of the generator used
* @property {ResolveOptions=} resolveOptions options used for resolving requests from this module
* @property {boolean} extractSourceMap enable/disable extracting source map
*/
/**
* @typedef {(resourcePath: string, getLoaderContext: (resourcePath: string) => AnyLoaderContext) => Promise<string | Buffer<ArrayBufferLike>>} ReadResource
*/
/**
* Defines the build info properties of normal modules (filesystem-backed, loader-processed).
* @typedef {object} KnownNormalModuleBuildInfo
* @property {boolean=} parsed
* @property {string=} hash
* @property {FileSystemDependencies=} fileDependencies
* @property {FileSystemDependencies=} contextDependencies
* @property {FileSystemDependencies=} missingDependencies
* @property {FileSystemDependencies=} buildDependencies
* @property {ValueCacheVersions=} valueDependencies
* @property {(Snapshot | null)=} snapshot
* @property {string=} resourceIntegrity using in HttpUriPlugin
*/
/** @typedef {BuildInfo & KnownNormalModuleBuildInfo} NormalModuleBuildInfo */
const normalModuleHooksRegistry = createHooksRegistry(() => {
// TODO webpack 6 deprecate
/** @type {Partial<NormalModuleCompilationHooks>} */
const hooks = {};
hooks.readResourceForScheme = new HookMap((scheme) => {
const hook =
/** @type {NormalModuleCompilationHooks} */
(hooks).readResource.for(scheme);
return createFakeHook(
/** @type {AsyncSeriesBailHook<[string, NormalModule], string | Buffer | null>} */ ({
tap: (options, fn) =>
hook.tap(options, (loaderContext) =>
fn(
loaderContext.resource,
/** @type {NormalModule} */ (loaderContext._module)
)
),
tapAsync: (options, fn) =>
hook.tapAsync(options, (loaderContext, callback) =>
fn(
loaderContext.resource,
/** @type {NormalModule} */ (loaderContext._module),
callback
)
),
tapPromise: (options, fn) =>
hook.tapPromise(options, (loaderContext) =>
fn(
loaderContext.resource,
/** @type {NormalModule} */ (loaderContext._module)
)
)
})
);
});
hooks.readResource = new HookMap(
() => new AsyncSeriesBailHook(["loaderContext"])
);
hooks.loader = new SyncHook(["loaderContext", "module"]);
hooks.beforeLoaders = new SyncHook(["loaders", "module", "loaderContext"]);
hooks.beforeParse = new SyncHook(["module"]);
hooks.beforeSnapshot = new SyncHook(["module"]);
hooks.processResult = new SyncWaterfallHook(["result", "module"]);
hooks.needBuild = new AsyncSeriesBailHook(["module", "context"]);
return /** @type {NormalModuleCompilationHooks} */ (hooks);
});
class NormalModule extends Module {
/**
* @param {Compilation} compilation the compilation
* @returns {NormalModuleCompilationHooks} the attached hooks
*/
static getCompilationHooks(compilation) {
return normalModuleHooksRegistry(compilation);
}
/**
* @param {NormalModuleCreateData} options options object
*/
constructor({
layer,
type,
request,
userRequest,
rawRequest,
loaders,
resource,
resourceResolveData,
context,
matchResource,
parser,
parserOptions,
generator,
generatorOptions,
resolveOptions,
extractSourceMap
}) {
super(type, context || getContext(resource), layer);
// Info from Factory
/** @type {NormalModuleCreateData['request']} */
this.request = request;
/** @type {NormalModuleCreateData['userRequest']} */
this.userRequest = userRequest;
/** @type {NormalModuleCreateData['rawRequest']} */
this.rawRequest = rawRequest;
/** @type {boolean} */
this.binary = /^(?:asset|webassembly)\b/.test(type);
/** @type {NormalModuleCreateData['parser'] | undefined} */
this.parser = parser;
/** @type {NormalModuleCreateData['parserOptions']} */
this.parserOptions = parserOptions;
/** @type {NormalModuleCreateData['generator'] | undefined} */
this.generator = generator;
/** @type {NormalModuleCreateData['generatorOptions']} */
this.generatorOptions = generatorOptions;
/** @type {NormalModuleCreateData['resource']} */
this.resource = resource;
/** @type {NormalModuleCreateData['resourceResolveData']} */
this.resourceResolveData = resourceResolveData;
/** @type {NormalModuleCreateData['matchResource']} */
this.matchResource = matchResource;
/** @type {NormalModuleCreateData['loaders']} */
this.loaders = loaders;
if (resolveOptions !== undefined) {
// already declared in super class
/** @type {NormalModuleCreateData['resolveOptions']} */
this.resolveOptions = resolveOptions;
}
/** @type {NormalModuleCreateData['extractSourceMap']} */
this.extractSourceMap = extractSourceMap;
// Set by HotModuleReplacementPlugin via NormalModuleFactory's `module` hook
/** @type {boolean} */
this.hot = false;
// Info from Build
// Redeclared with the normal module specific shape (see KnownNormalModuleBuildInfo)
/** @type {NormalModuleBuildInfo | undefined} */
this.buildInfo = undefined;
/** @type {Error | null} */
this.error = null;
/**
* @private
* @type {Source | null}
*/
this._source = null;
/**
* @private
* @type {Map<undefined | SourceType, number> | undefined}
*/
this._sourceSizes = undefined;
/**
* @private
* @type {undefined | SourceTypes}
*/
this._sourceTypes = undefined;
// Cache
/**
* @private
* @type {BuildMeta}
*/
this._lastSuccessfulBuildMeta = {};
/**
* @private
* @type {boolean}
*/
this._forceBuild = true;
/**
* @type {boolean}
*/
this._isEvaluatingSideEffects = false;
/**
* @type {WeakSet<ModuleGraph> | undefined}
*/
this._addedSideEffectsBailout = undefined;
/**
* Memoizes the result of `getSideEffectsConnectionState`. The
* graph slot keys the cached value to the `ModuleGraph` it was
* computed against so stale values never leak across compilations
* — a walk that targets a different graph just overwrites both
* slots. Populated only for results computed without encountering
* a circular connection (see `walkSideEffectsRecursive`).
* @type {ModuleGraph | undefined}
*/
this._sideEffectsStateGraph = undefined;
/** @type {ConnectionState | undefined} */
this._sideEffectsStateValue = undefined;
/**
* @private
* @type {CodeGenerationResultData}
*/
this._codeGeneratorData = new Map();
}
/**
* Returns the unique identifier used to reference this module.
* @returns {string} a unique identifier of the module
*/
identifier() {
if (this.layer === null) {
if (this.type === JAVASCRIPT_MODULE_TYPE_AUTO) {
return this.request;
}
return `${this.type}|${this.request}`;
}
return `${this.type}|${this.request}|${this.layer}`;
}
/**
* Returns a human-readable identifier for this module.
* @param {RequestShortener} requestShortener the request shortener
* @returns {string} a user readable identifier of the module
*/
readableIdentifier(requestShortener) {
return /** @type {string} */ (requestShortener.shorten(this.userRequest));
}
/**
* @returns {string | null} return the resource path
*/
getResource() {
return this.matchResource || this.resource;
}
/**
* Gets the library identifier.
* @param {LibIdentOptions} options options
* @returns {LibIdent | null} an identifier for library inclusion
*/
libIdent(options) {
let ident = contextify(
options.context,
this.userRequest,
options.associatedObjectForCache
);
if (this.layer) ident = `(${this.layer})/${ident}`;
return ident;
}
/**
* Returns the path used when matching this module against rule conditions.
* @returns {NameForCondition | null} absolute path which should be used for condition matching (usually the resource path)
*/
nameForCondition() {
const resource = /** @type {string} */ (this.getResource());
const idx = resource.indexOf("?");
if (idx >= 0) return resource.slice(0, idx);
return resource;
}
/**
* Assuming this module is in the cache. Update the (cached) module with
* the fresh module from the factory. Usually updates internal references
* and properties.