/
pluginDriver.ts
523 lines (488 loc) · 15.2 KB
/
pluginDriver.ts
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
import { EventEmitter } from 'events';
import { version as rollupVersion } from 'package.json';
import ExternalModule from '../ExternalModule';
import Graph from '../Graph';
import Module from '../Module';
import {
EmitAsset,
EmitChunk,
InputOptions,
Plugin,
PluginCache,
PluginContext,
PluginHooks,
RollupWarning,
RollupWatcher,
SerializablePluginCache
} from '../rollup/types';
import { createAssetPluginHooks } from './assetHooks';
import { BuildPhase } from './buildPhase';
import { getRollupDefaultPlugin } from './defaultPlugin';
import {
errInvalidRollupPhaseForAddWatchFile,
errInvalidRollupPhaseForEmitChunk,
error
} from './error';
type Args<T> = T extends (...args: infer K) => any ? K : never;
type EnsurePromise<T> = Promise<T extends Promise<infer K> ? K : T>;
export interface PluginDriver {
emitAsset: EmitAsset;
emitChunk: EmitChunk;
hasLoadersOrTransforms: boolean;
getAssetFileName(assetReferenceId: string): string;
hookFirst<H extends keyof PluginHooks, R = ReturnType<PluginHooks[H]>>(
hook: H,
args: Args<PluginHooks[H]>,
hookContext?: HookContext | null,
skip?: number | null
): EnsurePromise<R>;
hookFirstSync<H extends keyof PluginHooks, R = ReturnType<PluginHooks[H]>>(
hook: H,
args: Args<PluginHooks[H]>,
hookContext?: HookContext
): R;
hookParallel<H extends keyof PluginHooks>(
hook: H,
args: Args<PluginHooks[H]>,
hookContext?: HookContext
): Promise<void>;
hookReduceArg0<H extends keyof PluginHooks, V, R = ReturnType<PluginHooks[H]>>(
hook: H,
args: any[],
reduce: Reduce<V, R>,
hookContext?: HookContext
): EnsurePromise<R>;
hookReduceArg0Sync<H extends keyof PluginHooks, V, R = ReturnType<PluginHooks[H]>>(
hook: H,
args: any[],
reduce: Reduce<V, R>,
hookContext?: HookContext
): R;
hookReduceValue<R = any, T = any>(
hook: string,
value: T | Promise<T>,
args: any[],
reduce: Reduce<R, T>,
hookContext?: HookContext
): Promise<T>;
hookSeq<H extends keyof PluginHooks>(
hook: H,
args: Args<PluginHooks[H]>,
context?: HookContext
): Promise<void>;
hookSeqSync<H extends keyof PluginHooks>(
hook: H,
args: Args<PluginHooks[H]>,
context?: HookContext
): void;
}
export type Reduce<R = any, T = any> = (reduction: T, result: R, plugin: Plugin) => T;
export type HookContext = (context: PluginContext, plugin?: Plugin) => PluginContext;
const deprecatedHookNames: Record<string, string> = {
ongenerate: 'generateBundle',
onwrite: 'generateBundle',
transformBundle: 'renderChunk',
transformChunk: 'renderChunk'
};
export function createPluginDriver(
graph: Graph,
options: InputOptions,
pluginCache: Record<string, SerializablePluginCache> | void,
watcher?: RollupWatcher
): PluginDriver {
const plugins = [
...(options.plugins || []),
getRollupDefaultPlugin(options.preserveSymlinks as boolean)
];
const { emitAsset, getAssetFileName, setAssetSource } = createAssetPluginHooks(graph.assetsById);
const existingPluginKeys = new Set<string>();
let hasLoadersOrTransforms = false;
const pluginContexts: PluginContext[] = plugins.map((plugin, pidx) => {
let cacheable = true;
if (typeof plugin.cacheKey !== 'string') {
if (typeof plugin.name !== 'string' || existingPluginKeys.has(plugin.name)) {
cacheable = false;
} else {
existingPluginKeys.add(plugin.name);
}
}
if (
!hasLoadersOrTransforms &&
(plugin.load || plugin.transform || plugin.transformBundle || plugin.transformChunk)
)
hasLoadersOrTransforms = true;
let cacheInstance: PluginCache;
if (!pluginCache) {
cacheInstance = noCache;
} else if (cacheable) {
const cacheKey = plugin.cacheKey || plugin.name;
cacheInstance = createPluginCache(
pluginCache[cacheKey] || (pluginCache[cacheKey] = Object.create(null))
);
} else {
cacheInstance = uncacheablePlugin(plugin.name);
}
let watcherDeprecationWarningShown = false;
function deprecatedWatchListener(event: string, handler: () => void): EventEmitter {
if (!watcherDeprecationWarningShown) {
context.warn({
code: 'PLUGIN_WATCHER_DEPRECATED',
message: `this.watcher usage is deprecated in plugins. Use the watchChange plugin hook and this.addWatchFile() instead.`
});
watcherDeprecationWarningShown = true;
}
return (watcher as RollupWatcher).on(event, handler);
}
const context: PluginContext = {
addWatchFile(id) {
if (graph.phase >= BuildPhase.GENERATE) this.error(errInvalidRollupPhaseForAddWatchFile());
graph.watchFiles[id] = true;
},
cache: cacheInstance,
emitAsset,
emitChunk(id, options) {
if (graph.phase > BuildPhase.LOAD_AND_PARSE)
this.error(errInvalidRollupPhaseForEmitChunk());
return pluginDriver.emitChunk(id, options);
},
error(err): never {
if (typeof err === 'string') err = { message: err };
if (err.code) err.pluginCode = err.code;
err.code = 'PLUGIN_ERROR';
err.plugin = plugin.name || `Plugin at position ${pidx + 1}`;
return error(err);
},
isExternal(id, parentId, isResolved = false) {
return graph.moduleLoader.isExternal(id, parentId, isResolved);
},
getAssetFileName: getAssetFileName as (assetId: string) => string,
getChunkFileName(chunkReferenceId) {
return graph.moduleLoader.getChunkFileName(chunkReferenceId);
},
getModuleInfo(moduleId) {
const foundModule = graph.moduleById.get(moduleId);
if (foundModule == null) {
throw new Error(`Unable to find module ${moduleId}`);
}
return {
hasModuleSideEffects: foundModule.moduleSideEffects,
id: foundModule.id,
importedIds:
foundModule instanceof ExternalModule
? []
: foundModule.sources.map(id => foundModule.resolvedIds[id].id),
isEntry: foundModule instanceof Module && foundModule.isEntryPoint,
isExternal: foundModule instanceof ExternalModule
};
},
meta: {
rollupVersion
},
get moduleIds() {
return graph.moduleById.keys();
},
parse: graph.contextParse,
resolveId(source, importer) {
return graph.moduleLoader
.resolveId(source, importer)
.then(resolveId => resolveId && resolveId.id);
},
resolve(source, importer, options?: { skipSelf: boolean }) {
return graph.moduleLoader.resolveId(
source,
importer,
options && options.skipSelf ? pidx : null
);
},
setAssetSource,
warn(warning) {
if (typeof warning === 'string') warning = { message: warning } as RollupWarning;
if (warning.code) warning.pluginCode = warning.code;
warning.code = 'PLUGIN_WARNING';
warning.plugin = plugin.name || `Plugin at position ${pidx + 1}`;
graph.warn(warning);
},
watcher: watcher
? ({
...(watcher as EventEmitter),
addListener: deprecatedWatchListener,
on: deprecatedWatchListener
} as EventEmitter)
: (undefined as any)
};
return context;
});
function runHookSync<T>(
hookName: string,
args: any[],
pluginIndex: number,
permitValues = false,
hookContext?: HookContext
): T {
const plugin = plugins[pluginIndex];
let context = pluginContexts[pluginIndex];
const hook = (plugin as any)[hookName];
if (!hook) return undefined as any;
const deprecatedHookNewName = deprecatedHookNames[hookName];
if (deprecatedHookNewName)
context.warn(hookDeprecationWarning(hookName, deprecatedHookNewName, plugin, pluginIndex));
if (hookContext) {
context = hookContext(context, plugin);
if (!context || context === pluginContexts[pluginIndex])
throw new Error('Internal Rollup error: hookContext must return a new context object.');
}
try {
// permit values allows values to be returned instead of a functional hook
if (typeof hook !== 'function') {
if (permitValues) return hook;
error({
code: 'INVALID_PLUGIN_HOOK',
message: `Error running plugin hook ${hookName} for ${plugin.name ||
`Plugin at position ${pluginIndex + 1}`}, expected a function hook.`
});
}
return hook.apply(context, args);
} catch (err) {
if (typeof err === 'string') err = { message: err };
if (err.code !== 'PLUGIN_ERROR') {
if (err.code) err.pluginCode = err.code;
err.code = 'PLUGIN_ERROR';
}
err.plugin = plugin.name || `Plugin at position ${pluginIndex + 1}`;
err.hook = hookName;
error(err);
}
return undefined as any;
}
function runHook<T>(
hookName: string,
args: any[],
pluginIndex: number,
permitValues = false,
hookContext?: HookContext | null
): Promise<T> {
const plugin = plugins[pluginIndex];
let context = pluginContexts[pluginIndex];
const hook = (plugin as any)[hookName];
if (!hook) return undefined as any;
const deprecatedHookNewName = deprecatedHookNames[hookName];
if (deprecatedHookNewName)
context.warn(hookDeprecationWarning(hookName, deprecatedHookNewName, plugin, pluginIndex));
if (hookContext) {
context = hookContext(context, plugin);
if (!context || context === pluginContexts[pluginIndex])
throw new Error('Internal Rollup error: hookContext must return a new context object.');
}
return Promise.resolve()
.then(() => {
// permit values allows values to be returned instead of a functional hook
if (typeof hook !== 'function') {
if (permitValues) return hook;
error({
code: 'INVALID_PLUGIN_HOOK',
message: `Error running plugin hook ${hookName} for ${plugin.name ||
`Plugin at position ${pluginIndex + 1}`}, expected a function hook.`
});
}
return hook.apply(context, args);
})
.catch(err => {
if (typeof err === 'string') err = { message: err };
if (err.code !== 'PLUGIN_ERROR') {
if (err.code) err.pluginCode = err.code;
err.code = 'PLUGIN_ERROR';
}
err.plugin = plugin.name || `Plugin at position ${pluginIndex + 1}`;
err.hook = hookName;
error(err);
});
}
const pluginDriver: PluginDriver = {
emitAsset,
emitChunk(id, options) {
return graph.moduleLoader.addEntryModuleAndGetReferenceId({
alias: (options && options.name) || null,
unresolvedId: id
});
},
getAssetFileName: getAssetFileName as (assetId: string) => string,
hasLoadersOrTransforms,
// chains, ignores returns
hookSeq(name, args, hookContext) {
let promise: Promise<void> = Promise.resolve() as any;
for (let i = 0; i < plugins.length; i++)
promise = promise.then(() => runHook<void>(name, args as any[], i, false, hookContext));
return promise;
},
// chains, ignores returns
hookSeqSync(name, args, hookContext) {
for (let i = 0; i < plugins.length; i++)
runHookSync<void>(name, args as any[], i, false, hookContext);
},
// chains, first non-null result stops and returns
hookFirst(name, args, hookContext, skip) {
let promise: Promise<any> = Promise.resolve();
for (let i = 0; i < plugins.length; i++) {
if (skip === i) continue;
promise = promise.then((result: any) => {
if (result != null) return result;
return runHook(name, args as any[], i, false, hookContext);
});
}
return promise;
},
// chains synchronously, first non-null result stops and returns
hookFirstSync(name, args?, hookContext?) {
for (let i = 0; i < plugins.length; i++) {
const result = runHookSync(name, args, i, false, hookContext);
if (result != null) return result as any;
}
return null;
},
// parallel, ignores returns
hookParallel(name, args, hookContext) {
const promises: Promise<void>[] = [];
for (let i = 0; i < plugins.length; i++) {
const hookPromise = runHook<void>(name, args as any[], i, false, hookContext);
if (!hookPromise) continue;
promises.push(hookPromise);
}
return Promise.all(promises).then(() => {});
},
// chains, reduces returns of type R, to type T, handling the reduced value as the first hook argument
hookReduceArg0(name, [arg0, ...args], reduce, hookContext) {
let promise = Promise.resolve(arg0);
for (let i = 0; i < plugins.length; i++) {
promise = promise.then(arg0 => {
const hookPromise = runHook(name, [arg0, ...args], i, false, hookContext);
if (!hookPromise) return arg0;
return hookPromise.then((result: any) =>
reduce.call(pluginContexts[i], arg0, result, plugins[i])
);
});
}
return promise;
},
// chains synchronously, reduces returns of type R, to type T, handling the reduced value as the first hook argument
hookReduceArg0Sync(name, [arg0, ...args], reduce, hookContext) {
for (let i = 0; i < plugins.length; i++) {
const result: any = runHookSync(name, [arg0, ...args], i, false, hookContext);
arg0 = reduce.call(pluginContexts[i], arg0, result, plugins[i]);
}
return arg0;
},
// chains, reduces returns of type R, to type T, handling the reduced value separately. permits hooks as values.
hookReduceValue(name, initial, args, reduce, hookContext) {
let promise = Promise.resolve(initial);
for (let i = 0; i < plugins.length; i++) {
promise = promise.then(value => {
const hookPromise = runHook(name, args, i, true, hookContext);
if (!hookPromise) return value;
return hookPromise.then((result: any) =>
reduce.call(pluginContexts[i], value, result, plugins[i])
);
});
}
return promise;
}
};
return pluginDriver;
}
export function createPluginCache(cache: SerializablePluginCache): PluginCache {
return {
has(id: string) {
const item = cache[id];
if (!item) return false;
item[0] = 0;
return true;
},
get(id: string) {
const item = cache[id];
if (!item) return undefined;
item[0] = 0;
return item[1];
},
set(id: string, value: any) {
cache[id] = [0, value];
},
delete(id: string) {
return delete cache[id];
}
};
}
export function trackPluginCache(pluginCache: PluginCache) {
const result = { used: false, cache: (undefined as any) as PluginCache };
result.cache = {
has(id: string) {
result.used = true;
return pluginCache.has(id);
},
get(id: string) {
result.used = true;
return pluginCache.get(id);
},
set(id: string, value: any) {
result.used = true;
return pluginCache.set(id, value);
},
delete(id: string) {
result.used = true;
return pluginCache.delete(id);
}
};
return result;
}
const noCache: PluginCache = {
has() {
return false;
},
get() {
return undefined as any;
},
set() {},
delete() {
return false;
}
};
function uncacheablePluginError(pluginName: string) {
if (!pluginName)
error({
code: 'ANONYMOUS_PLUGIN_CACHE',
message:
'A plugin is trying to use the Rollup cache but is not declaring a plugin name or cacheKey.'
});
else
error({
code: 'DUPLICATE_PLUGIN_NAME',
message: `The plugin name ${pluginName} is being used twice in the same build. Plugin names must be distinct or provide a cacheKey (please post an issue to the plugin if you are a plugin user).`
});
}
const uncacheablePlugin: (pluginName: string) => PluginCache = pluginName => ({
has() {
uncacheablePluginError(pluginName);
return false;
},
get() {
uncacheablePluginError(pluginName);
return undefined as any;
},
set() {
uncacheablePluginError(pluginName);
},
delete() {
uncacheablePluginError(pluginName);
return false;
}
});
function hookDeprecationWarning(
name: string,
newName: string,
plugin: Plugin,
pluginIndex: number
) {
return {
code: name.toUpperCase() + '_HOOK_DEPRECATED',
message: `The ${name} hook used by plugin ${plugin.name ||
`at position ${pluginIndex + 1}`} is deprecated. The ${newName} hook should be used instead.`
};
}