-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
/
HarmonyImportSpecifierDependency.js
425 lines (392 loc) · 12.4 KB
/
HarmonyImportSpecifierDependency.js
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
/*
MIT License http://www.opensource.org/licenses/mit-license.php
Author Tobias Koppers @sokra
*/
"use strict";
const Dependency = require("../Dependency");
const {
getDependencyUsedByExportsCondition
} = require("../optimize/InnerGraph");
const { getTrimmedIdsAndRange } = require("../util/chainedImports");
const makeSerializable = require("../util/makeSerializable");
const propertyAccess = require("../util/propertyAccess");
const {
getAllIdsInDestructuring
} = require("./DestructuringAssignmentPropertyKeyDependency");
const HarmonyImportDependency = require("./HarmonyImportDependency");
/** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
/** @typedef {import("../ChunkGraph")} ChunkGraph */
/** @typedef {import("../Dependency").ExportsSpec} ExportsSpec */
/** @typedef {import("../Dependency").GetConditionFn} GetConditionFn */
/** @typedef {import("../Dependency").ReferencedExport} ReferencedExport */
/** @typedef {import("../Dependency").UpdateHashContext} UpdateHashContext */
/** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
/** @typedef {import("../Module")} Module */
/** @typedef {import("../Module").BuildMeta} BuildMeta */
/** @typedef {import("../ModuleGraph")} ModuleGraph */
/** @typedef {import("../ModuleGraphConnection")} ModuleGraphConnection */
/** @typedef {import("../ModuleGraphConnection").ConnectionState} ConnectionState */
/** @typedef {import("../WebpackError")} WebpackError */
/** @typedef {import("../javascript/JavascriptParser").Attributes} Attributes */
/** @typedef {import("../javascript/JavascriptParser").DestructuringAssignmentProperty} DestructuringAssignmentProperty */
/** @typedef {import("../javascript/JavascriptParser").Range} Range */
/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
/** @typedef {import("../util/Hash")} Hash */
/** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */
const idsSymbol = Symbol("HarmonyImportSpecifierDependency.ids");
const { ExportPresenceModes } = HarmonyImportDependency;
class HarmonyImportSpecifierDependency extends HarmonyImportDependency {
/**
* @param {TODO} request request
* @param {number} sourceOrder source order
* @param {string[]} ids ids
* @param {string} name name
* @param {Range} range range
* @param {TODO} exportPresenceMode export presence mode
* @param {Attributes=} attributes assertions
* @param {Range[]=} idRanges ranges for members of ids; the two arrays are right-aligned
*/
constructor(
request,
sourceOrder,
ids,
name,
range,
exportPresenceMode,
attributes,
idRanges // TODO webpack 6 make this non-optional. It must always be set to properly trim ids.
) {
super(request, sourceOrder, attributes);
this.ids = ids;
this.name = name;
this.range = range;
this.idRanges = idRanges;
this.exportPresenceMode = exportPresenceMode;
/** @type {boolean | undefined} */
this.namespaceObjectAsContext = false;
this.call = undefined;
this.directImport = undefined;
this.shorthand = undefined;
this.asiSafe = undefined;
/** @type {Set<string> | boolean | undefined} */
this.usedByExports = undefined;
/** @type {Set<DestructuringAssignmentProperty> | undefined} */
this.referencedPropertiesInDestructuring = undefined;
}
// TODO webpack 6 remove
get id() {
throw new Error("id was renamed to ids and type changed to string[]");
}
// TODO webpack 6 remove
getId() {
throw new Error("id was renamed to ids and type changed to string[]");
}
// TODO webpack 6 remove
setId() {
throw new Error("id was renamed to ids and type changed to string[]");
}
get type() {
return "harmony import specifier";
}
/**
* @param {ModuleGraph} moduleGraph the module graph
* @returns {string[]} the imported ids
*/
getIds(moduleGraph) {
const meta = moduleGraph.getMetaIfExisting(this);
if (meta === undefined) return this.ids;
const ids = meta[idsSymbol];
return ids !== undefined ? ids : this.ids;
}
/**
* @param {ModuleGraph} moduleGraph the module graph
* @param {string[]} ids the imported ids
* @returns {void}
*/
setIds(moduleGraph, ids) {
moduleGraph.getMeta(this)[idsSymbol] = ids;
}
/**
* @param {ModuleGraph} moduleGraph module graph
* @returns {null | false | GetConditionFn} function to determine if the connection is active
*/
getCondition(moduleGraph) {
return getDependencyUsedByExportsCondition(
this,
this.usedByExports,
moduleGraph
);
}
/**
* @param {ModuleGraph} moduleGraph the module graph
* @returns {ConnectionState} how this dependency connects the module to referencing modules
*/
getModuleEvaluationSideEffectsState(moduleGraph) {
return false;
}
/**
* Returns list of exports referenced by this dependency
* @param {ModuleGraph} moduleGraph module graph
* @param {RuntimeSpec} runtime the runtime for which the module is analysed
* @returns {(string[] | ReferencedExport)[]} referenced exports
*/
getReferencedExports(moduleGraph, runtime) {
let ids = this.getIds(moduleGraph);
if (ids.length === 0) return this._getReferencedExportsInDestructuring();
let namespaceObjectAsContext = this.namespaceObjectAsContext;
if (ids[0] === "default") {
const selfModule = moduleGraph.getParentModule(this);
const importedModule =
/** @type {Module} */
(moduleGraph.getModule(this));
switch (
importedModule.getExportsType(
moduleGraph,
/** @type {BuildMeta} */
(selfModule.buildMeta).strictHarmonyModule
)
) {
case "default-only":
case "default-with-named":
if (ids.length === 1)
return this._getReferencedExportsInDestructuring();
ids = ids.slice(1);
namespaceObjectAsContext = true;
break;
case "dynamic":
return Dependency.EXPORTS_OBJECT_REFERENCED;
}
}
if (
this.call &&
!this.directImport &&
(namespaceObjectAsContext || ids.length > 1)
) {
if (ids.length === 1) return Dependency.EXPORTS_OBJECT_REFERENCED;
ids = ids.slice(0, -1);
}
return this._getReferencedExportsInDestructuring(ids);
}
/**
* @param {string[]=} ids ids
* @returns {(string[] | ReferencedExport)[]} referenced exports
*/
_getReferencedExportsInDestructuring(ids) {
if (this.referencedPropertiesInDestructuring) {
/** @type {ReferencedExport[]} */
const refs = [];
for (const idsInDestructuring of getAllIdsInDestructuring(
this.referencedPropertiesInDestructuring
)) {
refs.push({
name: ids ? ids.concat(idsInDestructuring) : idsInDestructuring,
canMangle: true
});
}
return refs;
} else {
return ids ? [ids] : Dependency.EXPORTS_OBJECT_REFERENCED;
}
}
/**
* @param {ModuleGraph} moduleGraph module graph
* @returns {number} effective mode
*/
_getEffectiveExportPresenceLevel(moduleGraph) {
if (this.exportPresenceMode !== ExportPresenceModes.AUTO)
return this.exportPresenceMode;
const buildMeta = /** @type {BuildMeta} */ (
moduleGraph.getParentModule(this).buildMeta
);
return buildMeta.strictHarmonyModule
? ExportPresenceModes.ERROR
: ExportPresenceModes.WARN;
}
/**
* Returns warnings
* @param {ModuleGraph} moduleGraph module graph
* @returns {WebpackError[] | null | undefined} warnings
*/
getWarnings(moduleGraph) {
const exportsPresence = this._getEffectiveExportPresenceLevel(moduleGraph);
if (exportsPresence === ExportPresenceModes.WARN) {
return this._getErrors(moduleGraph);
}
return null;
}
/**
* Returns errors
* @param {ModuleGraph} moduleGraph module graph
* @returns {WebpackError[] | null | undefined} errors
*/
getErrors(moduleGraph) {
const exportsPresence = this._getEffectiveExportPresenceLevel(moduleGraph);
if (exportsPresence === ExportPresenceModes.ERROR) {
return this._getErrors(moduleGraph);
}
return null;
}
/**
* @param {ModuleGraph} moduleGraph module graph
* @returns {WebpackError[] | undefined} errors
*/
_getErrors(moduleGraph) {
const ids = this.getIds(moduleGraph);
return this.getLinkingErrors(
moduleGraph,
ids,
`(imported as '${this.name}')`
);
}
/**
* implement this method to allow the occurrence order plugin to count correctly
* @returns {number} count how often the id is used in this dependency
*/
getNumberOfIdOccurrences() {
return 0;
}
/**
* @param {ObjectSerializerContext} context context
*/
serialize(context) {
const { write } = context;
write(this.ids);
write(this.name);
write(this.range);
write(this.idRanges);
write(this.exportPresenceMode);
write(this.namespaceObjectAsContext);
write(this.call);
write(this.directImport);
write(this.shorthand);
write(this.asiSafe);
write(this.usedByExports);
write(this.referencedPropertiesInDestructuring);
super.serialize(context);
}
/**
* @param {ObjectDeserializerContext} context context
*/
deserialize(context) {
const { read } = context;
this.ids = read();
this.name = read();
this.range = read();
this.idRanges = read();
this.exportPresenceMode = read();
this.namespaceObjectAsContext = read();
this.call = read();
this.directImport = read();
this.shorthand = read();
this.asiSafe = read();
this.usedByExports = read();
this.referencedPropertiesInDestructuring = read();
super.deserialize(context);
}
}
makeSerializable(
HarmonyImportSpecifierDependency,
"webpack/lib/dependencies/HarmonyImportSpecifierDependency"
);
HarmonyImportSpecifierDependency.Template = class HarmonyImportSpecifierDependencyTemplate extends (
HarmonyImportDependency.Template
) {
/**
* @param {Dependency} dependency the dependency for which the template should be applied
* @param {ReplaceSource} source the current replace source which can be modified
* @param {DependencyTemplateContext} templateContext the context object
* @returns {void}
*/
apply(dependency, source, templateContext) {
const dep = /** @type {HarmonyImportSpecifierDependency} */ (dependency);
const { moduleGraph, runtime } = templateContext;
const connection = moduleGraph.getConnection(dep);
// Skip rendering depending when dependency is conditional
if (connection && !connection.isTargetActive(runtime)) return;
const {
trimmedRange: [trimmedRangeStart, trimmedRangeEnd],
trimmedIds
} = getTrimmedIdsAndRange(
dep.getIds(moduleGraph),
dep.range,
dep.idRanges,
moduleGraph,
dep
);
const exportExpr = this._getCodeForIds(
dep,
source,
templateContext,
trimmedIds
);
if (dep.shorthand) {
source.insert(trimmedRangeEnd, `: ${exportExpr}`);
} else {
source.replace(trimmedRangeStart, trimmedRangeEnd - 1, exportExpr);
}
}
/**
* @param {HarmonyImportSpecifierDependency} dep dependency
* @param {ReplaceSource} source source
* @param {DependencyTemplateContext} templateContext context
* @param {string[]} ids ids
* @returns {string} generated code
*/
_getCodeForIds(dep, source, templateContext, ids) {
const { moduleGraph, module, runtime, concatenationScope } =
templateContext;
const connection = moduleGraph.getConnection(dep);
let exportExpr;
if (
connection &&
concatenationScope &&
concatenationScope.isModuleInScope(connection.module)
) {
if (ids.length === 0) {
exportExpr = concatenationScope.createModuleReference(
connection.module,
{
asiSafe: dep.asiSafe
}
);
} else if (dep.namespaceObjectAsContext && ids.length === 1) {
exportExpr =
concatenationScope.createModuleReference(connection.module, {
asiSafe: dep.asiSafe
}) + propertyAccess(ids);
} else {
exportExpr = concatenationScope.createModuleReference(
connection.module,
{
ids,
call: dep.call,
directImport: dep.directImport,
asiSafe: dep.asiSafe
}
);
}
} else {
super.apply(dep, source, templateContext);
const { runtimeTemplate, initFragments, runtimeRequirements } =
templateContext;
exportExpr = runtimeTemplate.exportFromImport({
moduleGraph,
module: /** @type {Module} */ (moduleGraph.getModule(dep)),
request: dep.request,
exportName: ids,
originModule: module,
asiSafe: dep.shorthand ? true : dep.asiSafe,
isCall: dep.call,
callContext: !dep.directImport,
defaultInterop: true,
importVar: dep.getImportVar(moduleGraph),
initFragments,
runtime,
runtimeRequirements
});
}
return exportExpr;
}
};
module.exports = HarmonyImportSpecifierDependency;