-
-
Notifications
You must be signed in to change notification settings - Fork 5.8k
/
optimizer.ts
963 lines (846 loc) · 30.9 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
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
import colors from 'picocolors'
import { createDebugger, getHash, promiseWithResolvers } from '../utils'
import type { PromiseWithResolvers } from '../utils'
import { getDepOptimizationConfig } from '../config'
import type { ResolvedConfig, ViteDevServer } from '..'
import {
addManuallyIncludedOptimizeDeps,
addOptimizedDepInfo,
createIsOptimizedDepFile,
createIsOptimizedDepUrl,
depsFromOptimizedDepInfo,
depsLogString,
discoverProjectDependencies,
extractExportsData,
getOptimizedDepPath,
initDepsOptimizerMetadata,
loadCachedDepOptimizationMetadata,
optimizeServerSsrDeps,
runOptimizeDeps,
toDiscoveredDependencies,
} from '.'
import type { DepOptimizationResult, DepsOptimizer, OptimizedDepInfo } from '.'
const debug = createDebugger('vite:deps')
/**
* 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>()
const devSsrDepsOptimizerMap = new WeakMap<ResolvedConfig, DepsOptimizer>()
export function getDepsOptimizer(
config: ResolvedConfig,
ssr?: boolean,
): DepsOptimizer | undefined {
// Workers compilation shares the DepsOptimizer from the main build
const isDevSsr = ssr && config.command !== 'build'
return (isDevSsr ? devSsrDepsOptimizerMap : depsOptimizerMap).get(
config.mainConfig || config,
)
}
export async function initDepsOptimizer(
config: ResolvedConfig,
server?: ViteDevServer,
): Promise<void> {
// Non Dev SSR Optimizer
const ssr = config.command === 'build' && !!config.build.ssr
if (!getDepsOptimizer(config, ssr)) {
await createDepsOptimizer(config, server)
}
}
let creatingDevSsrOptimizer: Promise<void> | undefined
export async function initDevSsrDepsOptimizer(
config: ResolvedConfig,
server: ViteDevServer,
): Promise<void> {
if (getDepsOptimizer(config, true)) {
// ssr
return
}
if (creatingDevSsrOptimizer) {
return creatingDevSsrOptimizer
}
creatingDevSsrOptimizer = (async function () {
// Important: scanning needs to be done before starting the SSR dev optimizer
// If ssrLoadModule is called before server.listen(), the main deps optimizer
// will not be yet created
const ssr = false
if (!getDepsOptimizer(config, ssr)) {
await initDepsOptimizer(config, server)
}
await getDepsOptimizer(config, ssr)!.scanProcessing
await createDevSsrDepsOptimizer(config)
creatingDevSsrOptimizer = undefined
})()
return await creatingDevSsrOptimizer
}
async function createDepsOptimizer(
config: ResolvedConfig,
server?: ViteDevServer,
): Promise<void> {
const { logger } = config
const isBuild = config.command === 'build'
const ssr = isBuild && !!config.build.ssr // safe as Dev SSR don't use this optimizer
const sessionTimestamp = Date.now().toString()
const cachedMetadata = await loadCachedDepOptimizationMetadata(config, ssr)
let debounceProcessingHandle: NodeJS.Timeout | undefined
let closed = false
let metadata =
cachedMetadata || initDepsOptimizerMetadata(config, ssr, sessionTimestamp)
const options = getDepOptimizationConfig(config, ssr)
const { noDiscovery, holdUntilCrawlEnd } = options
const depsOptimizer: DepsOptimizer = {
metadata,
registerMissingImport,
run: () => debouncedProcessing(0),
isOptimizedDepFile: createIsOptimizedDepFile(config),
isOptimizedDepUrl: createIsOptimizedDepUrl(config),
getOptimizedDepId: (depInfo: OptimizedDepInfo) =>
isBuild ? depInfo.file : `${depInfo.file}?v=${depInfo.browserHash}`,
registerWorkersSource,
delayDepsOptimizerUntil,
resetRegisteredIds,
ensureFirstRun,
close,
options,
}
depsOptimizerMap.set(config, depsOptimizer)
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 discoveredDepsWhileScanning: string[] = []
const logDiscoveredDepsWhileScanning = () => {
if (discoveredDepsWhileScanning.length) {
config.logger.info(
colors.green(
`✨ discovered while scanning: ${depsLogString(
discoveredDepsWhileScanning,
)}`,
),
{
timestamp: true,
},
)
discoveredDepsWhileScanning = []
}
}
let depOptimizationProcessing = promiseWithResolvers<void>()
let depOptimizationProcessingQueue: PromiseWithResolvers<void>[] = []
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
let firstRunCalled = !!cachedMetadata
let warnAboutMissedDependencies = false
// During build, we wait for every module to be scanned before resolving
// optimized deps loading for rollup on each rebuild. It will be recreated
// after each buildStart.
// During dev, if this is a cold run, we wait for static imports discovered
// from the first request before resolving to minimize full page reloads.
// On warm start or after the first optimization is run, we use a simpler
// debounce strategy each time a new dep is discovered.
let crawlEndFinder: CrawlEndFinder | undefined
if ((!noDiscovery && isBuild) || !cachedMetadata) {
crawlEndFinder = setupOnCrawlEnd(onCrawlEnd)
}
let optimizationResult:
| {
cancel: () => Promise<void>
result: Promise<DepOptimizationResult>
}
| undefined
let discover:
| {
cancel: () => Promise<void>
result: Promise<Record<string, string>>
}
| undefined
async function close() {
closed = true
crawlEndFinder?.cancel()
await Promise.allSettled([
discover?.cancel(),
depsOptimizer.scanProcessing,
optimizationResult?.cancel(),
])
}
if (!cachedMetadata) {
// Enter processing state until crawl of static imports ends
currentlyProcessing = true
// Initialize discovered deps with manually added optimizeDeps.include info
const manuallyIncludedDeps: Record<string, string> = {}
await addManuallyIncludedOptimizeDeps(manuallyIncludedDeps, config, ssr)
const manuallyIncludedDepsInfo = toDiscoveredDependencies(
config,
manuallyIncludedDeps,
ssr,
sessionTimestamp,
)
for (const depInfo of Object.values(manuallyIncludedDepsInfo)) {
addOptimizedDepInfo(metadata, 'discovered', {
...depInfo,
processing: depOptimizationProcessing.promise,
})
newDepsDiscovered = true
}
if (noDiscovery) {
// We don't need to scan for dependencies or wait for the static crawl to end
// Run the first optimization run immediately
runOptimizer()
} else if (!isBuild) {
// Important, the scanner is dev only
depsOptimizer.scanProcessing = new Promise((resolve) => {
// Runs in the background in case blocking high priority tasks
;(async () => {
try {
debug?.(colors.green(`scanning for dependencies...`))
discover = discoverProjectDependencies(config)
const deps = await discover.result
discover = undefined
const manuallyIncluded = Object.keys(manuallyIncludedDepsInfo)
discoveredDepsWhileScanning.push(
...Object.keys(metadata.discovered).filter(
(dep) => !deps[dep] && !manuallyIncluded.includes(dep),
),
)
// Add these dependencies to the discovered list, as these are currently
// used by the preAliasPlugin to support aliased and optimized deps.
// This is also used by the CJS externalization heuristics in legacy mode
for (const id of Object.keys(deps)) {
if (!metadata.discovered[id]) {
addMissingDep(id, deps[id])
}
}
const knownDeps = prepareKnownDeps()
startNextDiscoveredBatch()
// For dev, we run the scanner and the first optimization
// run on the background
optimizationResult = runOptimizeDeps(config, knownDeps)
// If the holdUntilCrawlEnd stratey is used, we wait until crawling has
// ended to decide if we send this result to the browser or we need to
// do another optimize step
if (!holdUntilCrawlEnd) {
// If not, we release the result to the browser as soon as the scanner
// is done. If the scanner missed any dependency, and a new dependency
// is discovered while crawling static imports, then there will be a
// full-page reload if new common chunks are generated between the old
// and new optimized deps.
optimizationResult.result.then((result) => {
// Check if the crawling of static imports has already finished. In that
// case, the result is handled by the onCrawlEnd callback
if (!crawlEndFinder) return
optimizationResult = undefined // signal that we'll be using the result
runOptimizer(result)
})
}
} catch (e) {
logger.error(e.stack || e.message)
} finally {
resolve()
depsOptimizer.scanProcessing = undefined
}
})()
})
}
}
function startNextDiscoveredBatch() {
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 assigned this promise from this point
depOptimizationProcessing = promiseWithResolvers()
}
function prepareKnownDeps() {
const knownDeps: Record<string, OptimizedDepInfo> = {}
// Clone optimized info objects, fileHash, browserHash may be changed for them
for (const dep of Object.keys(metadata.optimized)) {
knownDeps[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]
knownDeps[dep] = info
}
return knownDeps
}
async function runOptimizer(preRunResult?: DepOptimizationResult) {
// a successful 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
// All deps, previous known and newly discovered are rebundled,
// respect insertion order to keep the metadata file stable
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 (debounceProcessingHandle) clearTimeout(debounceProcessingHandle)
if (closed || Object.keys(metadata.discovered).length === 0) {
currentlyProcessing = false
return
}
currentlyProcessing = true
try {
let processingResult: DepOptimizationResult
if (preRunResult) {
processingResult = preRunResult
} else {
const knownDeps = prepareKnownDeps()
startNextDiscoveredBatch()
optimizationResult = runOptimizeDeps(config, knownDeps)
processingResult = await optimizationResult.result
optimizationResult = undefined
}
if (closed) {
currentlyProcessing = false
processingResult.cancel()
resolveEnqueuedProcessingPromises()
return
}
const newData = processingResult.metadata
const needsInteropMismatch = findInteropMismatches(
metadata.discovered,
newData.optimized,
)
// 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 = depsOptimizer.metadata = newData
resolveEnqueuedProcessingPromises()
}
if (!needsReload) {
await commitProcessing()
if (!debug) {
if (newDepsToLogHandle) clearTimeout(newDepsToLogHandle)
newDepsToLogHandle = setTimeout(() => {
newDepsToLogHandle = undefined
logNewlyDiscoveredDeps()
if (warnAboutMissedDependencies) {
logDiscoveredDepsWhileScanning()
config.logger.info(
colors.magenta(
`❗ add these dependencies to optimizeDeps.include to speed up cold start`,
),
{ timestamp: true },
)
warnAboutMissedDependencies = false
}
}, 2 * debounceMs)
} else {
debug(
colors.green(
`✨ ${
!isRerun
? `dependencies optimized`
: `optimized dependencies unchanged`
}`,
),
)
}
} else {
if (newDepsDiscovered) {
// There are newly discovered deps, and another rerun is about to be
// executed. 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 (!debug) {
if (newDepsToLogHandle) clearTimeout(newDepsToLogHandle)
newDepsToLogHandle = undefined
logNewlyDiscoveredDeps()
if (warnAboutMissedDependencies) {
logDiscoveredDepsWhileScanning()
config.logger.info(
colors.magenta(
`❗ add these dependencies to optimizeDeps.include to avoid a full page reload during cold start`,
),
{ timestamp: true },
)
warnAboutMissedDependencies = false
}
}
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-expect-error `enqueuedRerun` could exist because `debouncedProcessing` may run while awaited
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,
): OptimizedDepInfo {
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
}
missing = addMissingDep(id, resolved)
// 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 (!crawlEndFinder) {
if (isBuild) {
logger.error(
'Vite Internal Error: Missing dependency found after crawling ended',
)
}
// 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 addMissingDep(id: string, resolved: string) {
newDepsDiscovered = true
return addOptimizedDepInfo(metadata, 'discovered', {
id,
file: getOptimizedDepPath(id, config, ssr),
src: resolved,
// Adding 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 dependencies,
// 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, ssr),
})
}
function debouncedProcessing(timeout = debounceMs) {
if (!newDepsDiscovered) {
return
}
// Debounced rerun, let other missing dependencies be discovered before
// the next optimizeDeps run
enqueuedRerun = undefined
if (debounceProcessingHandle) clearTimeout(debounceProcessingHandle)
if (newDepsToLogHandle) clearTimeout(newDepsToLogHandle)
newDepsToLogHandle = undefined
debounceProcessingHandle = setTimeout(() => {
debounceProcessingHandle = undefined
enqueuedRerun = rerun
if (!currentlyProcessing) {
enqueuedRerun()
}
}, timeout)
}
// During dev, onCrawlEnd is called once when the server starts and all static
// imports after the first request have been crawled (dynamic imports may also
// be crawled if the browser requests them right away).
// During build, onCrawlEnd will be called once after each buildStart (so in
// watch mode it will be called after each rebuild has processed every module).
// All modules are transformed first in this case (both static and dynamic).
async function onCrawlEnd() {
// On build time, a missing dep appearing after onCrawlEnd is an internal error
// On dev, switch after this point to a simple debounce strategy
crawlEndFinder = undefined
debug?.(colors.green(`✨ static imports crawl ended`))
if (closed) {
return
}
if (isBuild) {
currentlyProcessing = false
const crawlDeps = Object.keys(metadata.discovered)
if (crawlDeps.length === 0) {
debug?.(
colors.green(
`✨ no dependencies found while processing user modules`,
),
)
firstRunCalled = true
} else {
runOptimizer()
}
return
}
// Await for the scan+optimize step running in the background
// It normally should be over by the time crawling of user code ended
await depsOptimizer.scanProcessing
if (optimizationResult) {
// In the holdUntilCrawlEnd strategy, we don't release the result of the
// post-scanner optimize step to the browser until we reach this point
// If there are new dependencies, we do another optimize run, if not, we
// use the post-scanner optimize result
// If holdUntilCrawlEnd is false and we reach here, it means that the
// scan+optimize step finished after crawl end. We follow the same
// process as in the holdUntilCrawlEnd in this case.
const afterScanResult = optimizationResult.result
optimizationResult = undefined // signal that we'll be using the result
const result = await afterScanResult
currentlyProcessing = false
const crawlDeps = Object.keys(metadata.discovered)
const scanDeps = Object.keys(result.metadata.optimized)
if (scanDeps.length === 0 && crawlDeps.length === 0) {
debug?.(
colors.green(
`✨ no dependencies found by the scanner or crawling static imports`,
),
)
result.cancel()
firstRunCalled = true
return
}
const needsInteropMismatch = findInteropMismatches(
metadata.discovered,
result.metadata.optimized,
)
const scannerMissedDeps = crawlDeps.some((dep) => !scanDeps.includes(dep))
const outdatedResult =
needsInteropMismatch.length > 0 || scannerMissedDeps
if (outdatedResult) {
// Drop this scan result, and perform a new optimization to avoid a full reload
result.cancel()
// Add deps found by the scanner to the discovered deps while crawling
for (const dep of scanDeps) {
if (!crawlDeps.includes(dep)) {
addMissingDep(dep, result.metadata.optimized[dep].src!)
}
}
if (scannerMissedDeps) {
debug?.(
colors.yellow(
`✨ new dependencies were found while crawling that weren't detected by the scanner`,
),
)
}
debug?.(colors.green(`✨ re-running optimizer`))
debouncedProcessing(0)
} else {
debug?.(
colors.green(
`✨ using post-scan optimizer result, the scanner found every used dependency`,
),
)
startNextDiscoveredBatch()
runOptimizer(result)
}
} else if (!holdUntilCrawlEnd) {
// The post-scanner optimize result has been released to the browser
// If new deps have been discovered, issue a regular rerun of the
// optimizer. A full page reload may still be avoided if the new
// optimize result is compatible in this case
if (newDepsDiscovered) {
debug?.(
colors.green(
`✨ new dependencies were found while crawling static imports, re-running optimizer`,
),
)
warnAboutMissedDependencies = true
debouncedProcessing(0)
}
} else {
const crawlDeps = Object.keys(metadata.discovered)
currentlyProcessing = false
if (crawlDeps.length === 0) {
debug?.(
colors.green(
`✨ no dependencies found while crawling the static imports`,
),
)
firstRunCalled = true
} else {
// queue the first optimizer run
debouncedProcessing(0)
}
}
}
// Called during buildStart at build time, when build --watch is used.
function resetRegisteredIds() {
crawlEndFinder?.cancel()
crawlEndFinder = setupOnCrawlEnd(onCrawlEnd)
}
function registerWorkersSource(id: string) {
crawlEndFinder?.registerWorkersSource(id)
}
function delayDepsOptimizerUntil(id: string, done: () => Promise<any>) {
if (crawlEndFinder && !depsOptimizer.isOptimizedDepFile(id)) {
crawlEndFinder.delayDepsOptimizerUntil(id, done)
}
}
function ensureFirstRun() {
crawlEndFinder?.ensureFirstRun()
}
}
const callCrawlEndIfIdleAfterMs = 50
interface CrawlEndFinder {
ensureFirstRun: () => void
registerWorkersSource: (id: string) => void
delayDepsOptimizerUntil: (id: string, done: () => Promise<any>) => void
cancel: () => void
}
function setupOnCrawlEnd(onCrawlEnd: () => void): CrawlEndFinder {
const registeredIds = new Set<string>()
const seenIds = new Set<string>()
const workersSources = new Set<string>()
let timeoutHandle: NodeJS.Timeout | undefined
let cancelled = false
function cancel() {
cancelled = true
}
let crawlEndCalled = false
function callOnCrawlEnd() {
if (!cancelled && !crawlEndCalled) {
crawlEndCalled = true
onCrawlEnd()
}
}
// If all the inputs are dependencies, we aren't going to get any
// delayDepsOptimizerUntil(id) calls. We need to guard against this
// by forcing a rerun if no deps have been registered
let firstRunEnsured = false
function ensureFirstRun() {
if (!firstRunEnsured && seenIds.size === 0) {
setTimeout(() => {
if (seenIds.size === 0) {
callOnCrawlEnd()
}
}, 200)
}
firstRunEnsured = true
}
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.delete(id)
checkIfCrawlEndAfterTimeout()
}
function delayDepsOptimizerUntil(id: string, done: () => Promise<any>): void {
if (!seenIds.has(id)) {
seenIds.add(id)
if (!workersSources.has(id)) {
registeredIds.add(id)
done()
.catch(() => {})
.finally(() => markIdAsDone(id))
}
}
}
function markIdAsDone(id: string): void {
registeredIds.delete(id)
checkIfCrawlEndAfterTimeout()
}
function checkIfCrawlEndAfterTimeout() {
if (cancelled || registeredIds.size > 0) return
if (timeoutHandle) clearTimeout(timeoutHandle)
timeoutHandle = setTimeout(
callOnCrawlEndWhenIdle,
callCrawlEndIfIdleAfterMs,
)
}
async function callOnCrawlEndWhenIdle() {
if (cancelled || registeredIds.size > 0) return
callOnCrawlEnd()
}
return {
ensureFirstRun,
registerWorkersSource,
delayDepsOptimizerUntil,
cancel,
}
}
async function createDevSsrDepsOptimizer(
config: ResolvedConfig,
): Promise<void> {
const metadata = await optimizeServerSsrDeps(config)
const depsOptimizer = {
metadata,
isOptimizedDepFile: createIsOptimizedDepFile(config),
isOptimizedDepUrl: createIsOptimizedDepUrl(config),
getOptimizedDepId: (depInfo: OptimizedDepInfo) =>
`${depInfo.file}?v=${depInfo.browserHash}`,
registerMissingImport: () => {
throw new Error(
'Vite Internal Error: registerMissingImport is not supported in dev SSR',
)
},
// noop, there is no scanning during dev SSR
// the optimizer blocks the server start
run: () => {},
registerWorkersSource: (id: string) => {},
delayDepsOptimizerUntil: (id: string, done: () => Promise<any>) => {},
resetRegisteredIds: () => {},
ensureFirstRun: () => {},
close: async () => {},
options: config.ssr.optimizeDeps,
}
devSsrDepsOptimizerMap.set(config, depsOptimizer)
}
function findInteropMismatches(
discovered: Record<string, OptimizedDepInfo>,
optimized: Record<string, OptimizedDepInfo>,
) {
const needsInteropMismatch = []
for (const dep in discovered) {
const discoveredDepInfo = discovered[dep]
const depInfo = 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)
debug?.(colors.cyan(`✨ needsInterop mismatch detected for ${dep}`))
}
}
}
return needsInteropMismatch
}