/
optimizer.ts
609 lines (532 loc) · 19.1 KB
/
optimizer.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
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
import path from 'node:path'
import colors from 'picocolors'
import _debug from 'debug'
import glob from 'fast-glob'
import { FS_PREFIX } from '../constants'
import { getHash } from '../utils'
import { transformRequest } from '../server/transformRequest'
import type { ResolvedConfig, ViteDevServer } from '..'
import {
addOptimizedDepInfo,
createIsOptimizedDepUrl,
debuggerViteDeps as debug,
depsFromOptimizedDepInfo,
depsLogString,
discoverProjectDependencies,
extractExportsData,
getOptimizedDepPath,
initDepsOptimizerMetadata,
initialProjectDependencies,
isOptimizedDepFile,
loadCachedDepOptimizationMetadata,
newDepOptimizationProcessing,
optimizeServerSsrDeps,
runOptimizeDeps
} from '.'
import type {
DepOptimizationMetadata,
DepOptimizationProcessing,
DepsOptimizer,
OptimizedDepInfo
} from '.'
const isDebugEnabled = _debug('vite:deps').enabled
/**
* The amount to wait for requests to register newly found dependencies before triggering
* a re-bundle + page reload
*/
const debounceMs = 100
const depsOptimizerMap = new WeakMap<ResolvedConfig, DepsOptimizer>()
export function getDepsOptimizer(
config: ResolvedConfig
): DepsOptimizer | undefined {
// Workers compilation shares the DepsOptimizer from the main build
return depsOptimizerMap.get(config.mainConfig || config)
}
export async function initDepsOptimizer(
config: ResolvedConfig,
server?: ViteDevServer
): Promise<DepsOptimizer> {
const { logger } = config
const isBuild = config.command === 'build'
const scan = config.command !== 'build' && config.legacy?.devDepsScanner
const sessionTimestamp = Date.now().toString()
const cachedMetadata = loadCachedDepOptimizationMetadata(config)
let handle: NodeJS.Timeout | undefined
let ssrServerDepsMetadata: DepOptimizationMetadata
let _metadata =
cachedMetadata || initDepsOptimizerMetadata(config, sessionTimestamp)
const depsOptimizer: DepsOptimizer = {
metadata: (options: { ssr: boolean }) => {
if (isBuild || !options.ssr) {
return _metadata
} else {
return ssrServerDepsMetadata
}
},
registerMissingImport,
run: () => debouncedProcessing(0),
isOptimizedDepFile: (id: string) => isOptimizedDepFile(id, config),
isOptimizedDepUrl: createIsOptimizedDepUrl(config),
getOptimizedDepId: (depInfo: OptimizedDepInfo) =>
isBuild ? depInfo.file : `${depInfo.file}?v=${depInfo.browserHash}`,
registerWorkersSource,
delayDepsOptimizerUntil,
resetRegisteredIds,
options: config.optimizeDeps
}
depsOptimizerMap.set(config, depsOptimizer)
if (!isBuild && config.ssr) {
ssrServerDepsMetadata = await optimizeServerSsrDeps(config)
}
let newDepsDiscovered = false
let newDepsToLog: string[] = []
let newDepsToLogHandle: NodeJS.Timeout | undefined
const logNewlyDiscoveredDeps = () => {
if (newDepsToLog.length) {
config.logger.info(
colors.green(
`✨ new dependencies optimized: ${depsLogString(newDepsToLog)}`
),
{
timestamp: true
}
)
newDepsToLog = []
}
}
let depOptimizationProcessing = newDepOptimizationProcessing()
let depOptimizationProcessingQueue: DepOptimizationProcessing[] = []
const resolveEnqueuedProcessingPromises = () => {
// Resolve all the processings (including the ones which were delayed)
for (const processing of depOptimizationProcessingQueue) {
processing.resolve()
}
depOptimizationProcessingQueue = []
}
let enqueuedRerun: (() => void) | undefined
let currentlyProcessing = false
// Only pretransform optimizeDeps.entries on cold start
let optimizeDepsEntriesVisited = !!cachedMetadata
// If there wasn't a cache or it is outdated, we need to prepare a first run
let firstRunCalled = !!cachedMetadata
if (!cachedMetadata) {
if (!scan) {
// Initialize discovered deps with manually added optimizeDeps.include info
const discovered = await initialProjectDependencies(
config,
sessionTimestamp
)
const metadata = _metadata
for (const depInfo of Object.values(discovered)) {
addOptimizedDepInfo(metadata, 'discovered', {
...depInfo,
processing: depOptimizationProcessing.promise
})
}
} else {
// Perform a esbuild base scan of user code to discover dependencies
currentlyProcessing = true
const scanPhaseProcessing = newDepOptimizationProcessing()
depsOptimizer.scanProcessing = scanPhaseProcessing.promise
setTimeout(async () => {
try {
debug(colors.green(`scanning for dependencies...`))
const metadata = _metadata
const discovered = await discoverProjectDependencies(
config,
sessionTimestamp
)
// Respect the scan phase discover order to improve reproducibility
for (const depInfo of Object.values(discovered)) {
addOptimizedDepInfo(metadata, 'discovered', {
...depInfo,
processing: depOptimizationProcessing.promise
})
}
debug(
colors.green(
`dependencies found: ${depsLogString(Object.keys(discovered))}`
)
)
scanPhaseProcessing.resolve()
depsOptimizer.scanProcessing = undefined
await runOptimizer()
} catch (e) {
logger.error(e.message)
if (depsOptimizer.scanProcessing) {
scanPhaseProcessing.resolve()
depsOptimizer.scanProcessing = undefined
}
}
}, 0)
}
}
async function runOptimizer() {
const isRerun = firstRunCalled
firstRunCalled = true
// Ensure that rerun is called sequentially
enqueuedRerun = undefined
// Ensure that a rerun will not be issued for current discovered deps
if (handle) clearTimeout(handle)
if (Object.keys(_metadata.discovered).length === 0) {
currentlyProcessing = false
return
}
currentlyProcessing = true
// a succesful completion of the optimizeDeps rerun will end up
// creating new bundled version of all current and discovered deps
// in the cache dir and a new metadata info object assigned
// to _metadata. A fullReload is only issued if the previous bundled
// dependencies have changed.
// if the rerun fails, _metadata remains untouched, current discovered
// deps are cleaned, and a fullReload is issued
let metadata = _metadata
// All deps, previous known and newly discovered are rebundled,
// respect insertion order to keep the metadata file stable
const newDeps: Record<string, OptimizedDepInfo> = {}
// Clone optimized info objects, fileHash, browserHash may be changed for them
for (const dep of Object.keys(metadata.optimized)) {
newDeps[dep] = { ...metadata.optimized[dep] }
}
for (const dep of Object.keys(metadata.discovered)) {
// Clone the discovered info discarding its processing promise
const { processing, ...info } = metadata.discovered[dep]
newDeps[dep] = info
}
newDepsDiscovered = false
// Add the current depOptimizationProcessing to the queue, these
// promises are going to be resolved once a rerun is committed
depOptimizationProcessingQueue.push(depOptimizationProcessing)
// Create a new promise for the next rerun, discovered missing
// dependencies will be asigned this promise from this point
depOptimizationProcessing = newDepOptimizationProcessing()
try {
const processingResult = await runOptimizeDeps(config, newDeps)
const newData = processingResult.metadata
const needsInteropMismatch = []
for (const dep in metadata.discovered) {
const discoveredDepInfo = metadata.discovered[dep]
const depInfo = newData.optimized[dep]
if (depInfo) {
if (
discoveredDepInfo.needsInterop !== undefined &&
depInfo.needsInterop !== discoveredDepInfo.needsInterop
) {
// This only happens when a discovered dependency has mixed ESM and CJS syntax
// and it hasn't been manually added to optimizeDeps.needsInterop
needsInteropMismatch.push(dep)
}
}
}
// After a re-optimization, if the internal bundled chunks change a full page reload
// is required. If the files are stable, we can avoid the reload that is expensive
// for large applications. Comparing their fileHash we can find out if it is safe to
// keep the current browser state.
const needsReload =
needsInteropMismatch.length > 0 ||
metadata.hash !== newData.hash ||
Object.keys(metadata.optimized).some((dep) => {
return (
metadata.optimized[dep].fileHash !== newData.optimized[dep].fileHash
)
})
const commitProcessing = async () => {
await processingResult.commit()
// While optimizeDeps is running, new missing deps may be discovered,
// in which case they will keep being added to metadata.discovered
for (const id in metadata.discovered) {
if (!newData.optimized[id]) {
addOptimizedDepInfo(newData, 'discovered', metadata.discovered[id])
}
}
// If we don't reload the page, we need to keep browserHash stable
if (!needsReload) {
newData.browserHash = metadata.browserHash
for (const dep in newData.chunks) {
newData.chunks[dep].browserHash = metadata.browserHash
}
for (const dep in newData.optimized) {
newData.optimized[dep].browserHash = (
metadata.optimized[dep] || metadata.discovered[dep]
).browserHash
}
}
// Commit hash and needsInterop changes to the discovered deps info
// object. Allow for code to await for the discovered processing promise
// and use the information in the same object
for (const o in newData.optimized) {
const discovered = metadata.discovered[o]
if (discovered) {
const optimized = newData.optimized[o]
discovered.browserHash = optimized.browserHash
discovered.fileHash = optimized.fileHash
discovered.needsInterop = optimized.needsInterop
discovered.processing = undefined
}
}
if (isRerun) {
newDepsToLog.push(
...Object.keys(newData.optimized).filter(
(dep) => !metadata.optimized[dep]
)
)
}
metadata = _metadata = newData
resolveEnqueuedProcessingPromises()
}
if (!needsReload) {
await commitProcessing()
if (!isDebugEnabled) {
if (newDepsToLogHandle) clearTimeout(newDepsToLogHandle)
newDepsToLogHandle = setTimeout(() => {
newDepsToLogHandle = undefined
logNewlyDiscoveredDeps()
}, 2 * debounceMs)
} else {
debug(colors.green(`✨ optimized dependencies unchanged`))
}
} else {
if (newDepsDiscovered) {
// There are newly discovered deps, and another rerun is about to be
// excecuted. Avoid the current full reload discarding this rerun result
// We don't resolve the processing promise, as they will be resolved
// once a rerun is committed
processingResult.cancel()
debug(
colors.green(
`✨ delaying reload as new dependencies have been found...`
)
)
} else {
await commitProcessing()
if (!isDebugEnabled) {
if (newDepsToLogHandle) clearTimeout(newDepsToLogHandle)
newDepsToLogHandle = undefined
logNewlyDiscoveredDeps()
}
logger.info(
colors.green(`✨ optimized dependencies changed. reloading`),
{
timestamp: true
}
)
if (needsInteropMismatch.length > 0) {
config.logger.warn(
`Mixed ESM and CJS detected in ${colors.yellow(
needsInteropMismatch.join(', ')
)}, add ${
needsInteropMismatch.length === 1 ? 'it' : 'them'
} to optimizeDeps.needsInterop to speed up cold start`,
{
timestamp: true
}
)
}
fullReload()
}
}
} catch (e) {
logger.error(
colors.red(`error while updating dependencies:\n${e.stack}`),
{ timestamp: true, error: e }
)
resolveEnqueuedProcessingPromises()
// Reset missing deps, let the server rediscover the dependencies
metadata.discovered = {}
}
currentlyProcessing = false
// @ts-ignore
enqueuedRerun?.()
}
function fullReload() {
if (server) {
// Cached transform results have stale imports (resolved to
// old locations) so they need to be invalidated before the page is
// reloaded.
server.moduleGraph.invalidateAll()
server.ws.send({
type: 'full-reload',
path: '*'
})
}
}
async function rerun() {
// debounce time to wait for new missing deps finished, issue a new
// optimization of deps (both old and newly found) once the previous
// optimizeDeps processing is finished
const deps = Object.keys(_metadata.discovered)
const depsString = depsLogString(deps)
debug(colors.green(`new dependencies found: ${depsString}`))
runOptimizer()
}
function getDiscoveredBrowserHash(
hash: string,
deps: Record<string, string>,
missing: Record<string, string>
) {
return getHash(
hash + JSON.stringify(deps) + JSON.stringify(missing) + sessionTimestamp
)
}
function registerMissingImport(
id: string,
resolved: string,
ssr?: boolean
): OptimizedDepInfo {
if (depsOptimizer.scanProcessing) {
config.logger.error(
'Vite internal error: registering missing import before initial scanning is over'
)
}
if (!isBuild && ssr) {
config.logger.error(
`Error: ${id} is a missing dependency in SSR dev server, it needs to be added to optimizeDeps.include`
)
}
const metadata = _metadata
const optimized = metadata.optimized[id]
if (optimized) {
return optimized
}
const chunk = metadata.chunks[id]
if (chunk) {
return chunk
}
let missing = metadata.discovered[id]
if (missing) {
// We are already discover this dependency
// It will be processed in the next rerun call
return missing
}
newDepsDiscovered = true
missing = addOptimizedDepInfo(metadata, 'discovered', {
id,
file: getOptimizedDepPath(id, config, ssr),
src: resolved,
// Assing a browserHash to this missing dependency that is unique to
// the current state of known + missing deps. If its optimizeDeps run
// doesn't alter the bundled files of previous known dependendencies,
// we don't need a full reload and this browserHash will be kept
browserHash: getDiscoveredBrowserHash(
metadata.hash,
depsFromOptimizedDepInfo(metadata.optimized),
depsFromOptimizedDepInfo(metadata.discovered)
),
// loading of this pre-bundled dep needs to await for its processing
// promise to be resolved
processing: depOptimizationProcessing.promise,
exportsData: extractExportsData(resolved, config)
})
// Until the first optimize run is called, avoid triggering processing
// We'll wait until the user codebase is eagerly processed by Vite so
// we can get a list of every missing dependency before giving to the
// browser a dependency that may be outdated, thus avoiding full page reloads
if (scan || firstRunCalled) {
// Debounced rerun, let other missing dependencies be discovered before
// the running next optimizeDeps
debouncedProcessing()
}
// Return the path for the optimized bundle, this path is known before
// esbuild is run to generate the pre-bundle
return missing
}
function debouncedProcessing(timeout = debounceMs) {
// Debounced rerun, let other missing dependencies be discovered before
// the running next optimizeDeps
enqueuedRerun = undefined
if (handle) clearTimeout(handle)
if (newDepsToLogHandle) clearTimeout(newDepsToLogHandle)
newDepsToLogHandle = undefined
handle = setTimeout(() => {
handle = undefined
enqueuedRerun = rerun
if (!currentlyProcessing) {
enqueuedRerun()
}
}, timeout)
}
const runOptimizerIfIdleAfterMs = 100
let registeredIds: { id: string; done: () => Promise<any> }[] = []
let seenIds = new Set<string>()
let workersSources = new Set<string>()
let waitingOn: string | undefined
function resetRegisteredIds() {
registeredIds = []
seenIds = new Set<string>()
workersSources = new Set<string>()
waitingOn = undefined
}
function registerWorkersSource(id: string): void {
workersSources.add(id)
// Avoid waiting for this id, as it may be blocked by the rollup
// bundling process of the worker that also depends on the optimizer
registeredIds = registeredIds.filter((registered) => registered.id !== id)
if (waitingOn === id) {
waitingOn = undefined
runOptimizerWhenIdle()
}
}
function delayDepsOptimizerUntil(id: string, done: () => Promise<any>): void {
if (!depsOptimizer.isOptimizedDepFile(id) && !seenIds.has(id)) {
seenIds.add(id)
registeredIds.push({ id, done })
runOptimizerWhenIdle()
}
if (server && !optimizeDepsEntriesVisited) {
optimizeDepsEntriesVisited = true
preTransformOptimizeDepsEntries(server)
}
}
function runOptimizerWhenIdle() {
if (!waitingOn) {
const next = registeredIds.pop()
if (next) {
waitingOn = next.id
const afterLoad = () => {
waitingOn = undefined
if (!workersSources.has(next.id)) {
if (registeredIds.length > 0) {
runOptimizerWhenIdle()
} else {
getDepsOptimizer(config)?.run()
}
}
}
next
.done()
.then(() => {
setTimeout(
afterLoad,
registeredIds.length > 0 ? 0 : runOptimizerIfIdleAfterMs
)
})
.catch(afterLoad)
}
}
}
return depsOptimizer
}
export async function preTransformOptimizeDepsEntries(
server: ViteDevServer
): Promise<void> {
const { config } = server
const { root } = config
const { entries } = config.optimizeDeps
if (entries) {
const explicitEntries = await glob(entries, {
cwd: root,
ignore: ['**/node_modules/**', `**/${config.build.outDir}/**`],
absolute: true
})
// TODO: should we restrict the entries to JS and HTML like the
// scanner did? I think we can let the user chose any entry
for (const entry of explicitEntries) {
const url = entry.startsWith(root + '/')
? entry.slice(root.length)
: path.posix.join(FS_PREFIX + entry)
transformRequest(url, server, { ssr: false }).catch((e) => {
config.logger.error(e.message)
})
}
}
}