-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
common.ts
1858 lines (1685 loc) · 75 KB
/
common.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
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
import type * as types from "./types"
import * as protocol from "./stdio_protocol"
declare const ESBUILD_VERSION: string
const quote: (x: string) => string = JSON.stringify
const buildLogLevelDefault = 'warning'
const transformLogLevelDefault = 'silent'
function validateTarget(target: string): string {
validateStringValue(target, 'target')
if (target.indexOf(',') >= 0) throw new Error(`Invalid target: ${target}`)
return target
}
let canBeAnything = () => null
let mustBeBoolean = (value: boolean | undefined): string | null =>
typeof value === 'boolean' ? null : 'a boolean'
let mustBeString = (value: string | undefined): string | null =>
typeof value === 'string' ? null : 'a string'
let mustBeRegExp = (value: RegExp | undefined): string | null =>
value instanceof RegExp ? null : 'a RegExp object'
let mustBeInteger = (value: number | undefined): string | null =>
typeof value === 'number' && value === (value | 0) ? null : 'an integer'
let mustBeFunction = (value: Function | undefined): string | null =>
typeof value === 'function' ? null : 'a function'
let mustBeArray = <T>(value: T[] | undefined): string | null =>
Array.isArray(value) ? null : 'an array'
let mustBeObject = (value: Object | undefined): string | null =>
typeof value === 'object' && value !== null && !Array.isArray(value) ? null : 'an object'
let mustBeEntryPoints = (value: types.BuildOptions['entryPoints']): string | null =>
typeof value === 'object' && value !== null ? null : 'an array or an object'
let mustBeWebAssemblyModule = (value: WebAssembly.Module | undefined): string | null =>
value instanceof WebAssembly.Module ? null : 'a WebAssembly.Module'
let mustBeObjectOrNull = (value: Object | null | undefined): string | null =>
typeof value === 'object' && !Array.isArray(value) ? null : 'an object or null'
let mustBeStringOrBoolean = (value: string | boolean | undefined): string | null =>
typeof value === 'string' || typeof value === 'boolean' ? null : 'a string or a boolean'
let mustBeStringOrObject = (value: string | Object | undefined): string | null =>
typeof value === 'string' || typeof value === 'object' && value !== null && !Array.isArray(value) ? null : 'a string or an object'
let mustBeStringOrArray = (value: string | string[] | undefined): string | null =>
typeof value === 'string' || Array.isArray(value) ? null : 'a string or an array'
let mustBeStringOrUint8Array = (value: string | Uint8Array | undefined): string | null =>
typeof value === 'string' || value instanceof Uint8Array ? null : 'a string or a Uint8Array'
let mustBeStringOrURL = (value: string | URL | undefined): string | null =>
typeof value === 'string' || value instanceof URL ? null : 'a string or a URL'
type OptionKeys = { [key: string]: boolean }
function getFlag<T, K extends (keyof T & string)>(object: T, keys: OptionKeys, key: K, mustBeFn: (value: T[K]) => string | null): T[K] | undefined {
let value = object[key]
keys[key + ''] = true
if (value === undefined) return undefined
let mustBe = mustBeFn(value)
if (mustBe !== null) throw new Error(`${quote(key)} must be ${mustBe}`)
return value
}
function checkForInvalidFlags(object: Object, keys: OptionKeys, where: string): void {
for (let key in object) {
if (!(key in keys)) {
throw new Error(`Invalid option ${where}: ${quote(key)}`)
}
}
}
export function validateInitializeOptions(options: types.InitializeOptions): types.InitializeOptions {
let keys: OptionKeys = Object.create(null)
let wasmURL = getFlag(options, keys, 'wasmURL', mustBeStringOrURL)
let wasmModule = getFlag(options, keys, 'wasmModule', mustBeWebAssemblyModule)
let worker = getFlag(options, keys, 'worker', mustBeBoolean)
checkForInvalidFlags(options, keys, 'in initialize() call')
return {
wasmURL,
wasmModule,
worker,
}
}
type MangleCache = Record<string, string | false>
function validateMangleCache(mangleCache: MangleCache | undefined): MangleCache | undefined {
let validated: MangleCache | undefined
if (mangleCache !== undefined) {
validated = Object.create(null) as MangleCache
for (let key in mangleCache) {
let value = mangleCache[key]
if (typeof value === 'string' || value === false) {
validated[key] = value
} else {
throw new Error(`Expected ${quote(key)} in mangle cache to map to either a string or false`)
}
}
}
return validated
}
type CommonOptions = types.BuildOptions | types.TransformOptions
function pushLogFlags(flags: string[], options: CommonOptions, keys: OptionKeys, isTTY: boolean, logLevelDefault: types.LogLevel): void {
let color = getFlag(options, keys, 'color', mustBeBoolean)
let logLevel = getFlag(options, keys, 'logLevel', mustBeString)
let logLimit = getFlag(options, keys, 'logLimit', mustBeInteger)
if (color !== void 0) flags.push(`--color=${color}`)
else if (isTTY) flags.push(`--color=true`); // This is needed to fix "execFileSync" which buffers stderr
flags.push(`--log-level=${logLevel || logLevelDefault}`)
flags.push(`--log-limit=${logLimit || 0}`)
}
function validateStringValue(value: unknown, what: string, key?: string): string {
if (typeof value !== 'string') {
throw new Error(`Expected value for ${what}${key !== void 0 ? ' ' + quote(key) : ''} to be a string, got ${typeof value} instead`)
}
return value
}
function pushCommonFlags(flags: string[], options: CommonOptions, keys: OptionKeys): void {
let legalComments = getFlag(options, keys, 'legalComments', mustBeString)
let sourceRoot = getFlag(options, keys, 'sourceRoot', mustBeString)
let sourcesContent = getFlag(options, keys, 'sourcesContent', mustBeBoolean)
let target = getFlag(options, keys, 'target', mustBeStringOrArray)
let format = getFlag(options, keys, 'format', mustBeString)
let globalName = getFlag(options, keys, 'globalName', mustBeString)
let mangleProps = getFlag(options, keys, 'mangleProps', mustBeRegExp)
let reserveProps = getFlag(options, keys, 'reserveProps', mustBeRegExp)
let mangleQuoted = getFlag(options, keys, 'mangleQuoted', mustBeBoolean)
let minify = getFlag(options, keys, 'minify', mustBeBoolean)
let minifySyntax = getFlag(options, keys, 'minifySyntax', mustBeBoolean)
let minifyWhitespace = getFlag(options, keys, 'minifyWhitespace', mustBeBoolean)
let minifyIdentifiers = getFlag(options, keys, 'minifyIdentifiers', mustBeBoolean)
let lineLimit = getFlag(options, keys, 'lineLimit', mustBeInteger)
let drop = getFlag(options, keys, 'drop', mustBeArray)
let dropLabels = getFlag(options, keys, 'dropLabels', mustBeArray)
let charset = getFlag(options, keys, 'charset', mustBeString)
let treeShaking = getFlag(options, keys, 'treeShaking', mustBeBoolean)
let ignoreAnnotations = getFlag(options, keys, 'ignoreAnnotations', mustBeBoolean)
let jsx = getFlag(options, keys, 'jsx', mustBeString)
let jsxFactory = getFlag(options, keys, 'jsxFactory', mustBeString)
let jsxFragment = getFlag(options, keys, 'jsxFragment', mustBeString)
let jsxImportSource = getFlag(options, keys, 'jsxImportSource', mustBeString)
let jsxDev = getFlag(options, keys, 'jsxDev', mustBeBoolean)
let jsxSideEffects = getFlag(options, keys, 'jsxSideEffects', mustBeBoolean)
let define = getFlag(options, keys, 'define', mustBeObject)
let logOverride = getFlag(options, keys, 'logOverride', mustBeObject)
let supported = getFlag(options, keys, 'supported', mustBeObject)
let pure = getFlag(options, keys, 'pure', mustBeArray)
let keepNames = getFlag(options, keys, 'keepNames', mustBeBoolean)
let platform = getFlag(options, keys, 'platform', mustBeString)
let tsconfigRaw = getFlag(options, keys, 'tsconfigRaw', mustBeStringOrObject)
if (legalComments) flags.push(`--legal-comments=${legalComments}`)
if (sourceRoot !== void 0) flags.push(`--source-root=${sourceRoot}`)
if (sourcesContent !== void 0) flags.push(`--sources-content=${sourcesContent}`)
if (target) {
if (Array.isArray(target)) flags.push(`--target=${Array.from(target).map(validateTarget).join(',')}`)
else flags.push(`--target=${validateTarget(target)}`)
}
if (format) flags.push(`--format=${format}`)
if (globalName) flags.push(`--global-name=${globalName}`)
if (platform) flags.push(`--platform=${platform}`)
if (tsconfigRaw) flags.push(`--tsconfig-raw=${typeof tsconfigRaw === 'string' ? tsconfigRaw : JSON.stringify(tsconfigRaw)}`)
if (minify) flags.push('--minify')
if (minifySyntax) flags.push('--minify-syntax')
if (minifyWhitespace) flags.push('--minify-whitespace')
if (minifyIdentifiers) flags.push('--minify-identifiers')
if (lineLimit) flags.push(`--line-limit=${lineLimit}`)
if (charset) flags.push(`--charset=${charset}`)
if (treeShaking !== void 0) flags.push(`--tree-shaking=${treeShaking}`)
if (ignoreAnnotations) flags.push(`--ignore-annotations`)
if (drop) for (let what of drop) flags.push(`--drop:${validateStringValue(what, 'drop')}`)
if (dropLabels) flags.push(`--drop-labels=${Array.from(dropLabels).map(what => validateStringValue(what, 'dropLabels')).join(',')}`)
if (mangleProps) flags.push(`--mangle-props=${mangleProps.source}`)
if (reserveProps) flags.push(`--reserve-props=${reserveProps.source}`)
if (mangleQuoted !== void 0) flags.push(`--mangle-quoted=${mangleQuoted}`)
if (jsx) flags.push(`--jsx=${jsx}`)
if (jsxFactory) flags.push(`--jsx-factory=${jsxFactory}`)
if (jsxFragment) flags.push(`--jsx-fragment=${jsxFragment}`)
if (jsxImportSource) flags.push(`--jsx-import-source=${jsxImportSource}`)
if (jsxDev) flags.push(`--jsx-dev`)
if (jsxSideEffects) flags.push(`--jsx-side-effects`)
if (define) {
for (let key in define) {
if (key.indexOf('=') >= 0) throw new Error(`Invalid define: ${key}`)
flags.push(`--define:${key}=${validateStringValue(define[key], 'define', key)}`)
}
}
if (logOverride) {
for (let key in logOverride) {
if (key.indexOf('=') >= 0) throw new Error(`Invalid log override: ${key}`)
flags.push(`--log-override:${key}=${validateStringValue(logOverride[key], 'log override', key)}`)
}
}
if (supported) {
for (let key in supported) {
if (key.indexOf('=') >= 0) throw new Error(`Invalid supported: ${key}`)
const value = supported[key]
if (typeof value !== 'boolean') throw new Error(`Expected value for supported ${quote(key)} to be a boolean, got ${typeof value} instead`)
flags.push(`--supported:${key}=${value}`)
}
}
if (pure) for (let fn of pure) flags.push(`--pure:${validateStringValue(fn, 'pure')}`)
if (keepNames) flags.push(`--keep-names`)
}
function flagsForBuildOptions(
callName: string,
options: types.BuildOptions,
isTTY: boolean,
logLevelDefault: types.LogLevel,
writeDefault: boolean,
): {
entries: [string, string][],
flags: string[],
write: boolean,
stdinContents: Uint8Array | null,
stdinResolveDir: string | null,
absWorkingDir: string | undefined,
nodePaths: string[],
mangleCache: MangleCache | undefined,
} {
let flags: string[] = []
let entries: [string, string][] = []
let keys: OptionKeys = Object.create(null)
let stdinContents: Uint8Array | null = null
let stdinResolveDir: string | null = null
pushLogFlags(flags, options, keys, isTTY, logLevelDefault)
pushCommonFlags(flags, options, keys)
let sourcemap = getFlag(options, keys, 'sourcemap', mustBeStringOrBoolean)
let bundle = getFlag(options, keys, 'bundle', mustBeBoolean)
let splitting = getFlag(options, keys, 'splitting', mustBeBoolean)
let preserveSymlinks = getFlag(options, keys, 'preserveSymlinks', mustBeBoolean)
let metafile = getFlag(options, keys, 'metafile', mustBeBoolean)
let outfile = getFlag(options, keys, 'outfile', mustBeString)
let outdir = getFlag(options, keys, 'outdir', mustBeString)
let outbase = getFlag(options, keys, 'outbase', mustBeString)
let tsconfig = getFlag(options, keys, 'tsconfig', mustBeString)
let resolveExtensions = getFlag(options, keys, 'resolveExtensions', mustBeArray)
let nodePathsInput = getFlag(options, keys, 'nodePaths', mustBeArray)
let mainFields = getFlag(options, keys, 'mainFields', mustBeArray)
let conditions = getFlag(options, keys, 'conditions', mustBeArray)
let external = getFlag(options, keys, 'external', mustBeArray)
let packages = getFlag(options, keys, 'packages', mustBeString)
let alias = getFlag(options, keys, 'alias', mustBeObject)
let loader = getFlag(options, keys, 'loader', mustBeObject)
let outExtension = getFlag(options, keys, 'outExtension', mustBeObject)
let publicPath = getFlag(options, keys, 'publicPath', mustBeString)
let entryNames = getFlag(options, keys, 'entryNames', mustBeString)
let chunkNames = getFlag(options, keys, 'chunkNames', mustBeString)
let assetNames = getFlag(options, keys, 'assetNames', mustBeString)
let inject = getFlag(options, keys, 'inject', mustBeArray)
let banner = getFlag(options, keys, 'banner', mustBeObject)
let footer = getFlag(options, keys, 'footer', mustBeObject)
let entryPoints = getFlag(options, keys, 'entryPoints', mustBeEntryPoints)
let absWorkingDir = getFlag(options, keys, 'absWorkingDir', mustBeString)
let stdin = getFlag(options, keys, 'stdin', mustBeObject)
let write = getFlag(options, keys, 'write', mustBeBoolean) ?? writeDefault; // Default to true if not specified
let allowOverwrite = getFlag(options, keys, 'allowOverwrite', mustBeBoolean)
let mangleCache = getFlag(options, keys, 'mangleCache', mustBeObject)
keys.plugins = true; // "plugins" has already been read earlier
checkForInvalidFlags(options, keys, `in ${callName}() call`)
if (sourcemap) flags.push(`--sourcemap${sourcemap === true ? '' : `=${sourcemap}`}`)
if (bundle) flags.push('--bundle')
if (allowOverwrite) flags.push('--allow-overwrite')
if (splitting) flags.push('--splitting')
if (preserveSymlinks) flags.push('--preserve-symlinks')
if (metafile) flags.push(`--metafile`)
if (outfile) flags.push(`--outfile=${outfile}`)
if (outdir) flags.push(`--outdir=${outdir}`)
if (outbase) flags.push(`--outbase=${outbase}`)
if (tsconfig) flags.push(`--tsconfig=${tsconfig}`)
if (packages) flags.push(`--packages=${packages}`)
if (resolveExtensions) {
let values: string[] = []
for (let value of resolveExtensions) {
validateStringValue(value, 'resolve extension')
if (value.indexOf(',') >= 0) throw new Error(`Invalid resolve extension: ${value}`)
values.push(value)
}
flags.push(`--resolve-extensions=${values.join(',')}`)
}
if (publicPath) flags.push(`--public-path=${publicPath}`)
if (entryNames) flags.push(`--entry-names=${entryNames}`)
if (chunkNames) flags.push(`--chunk-names=${chunkNames}`)
if (assetNames) flags.push(`--asset-names=${assetNames}`)
if (mainFields) {
let values: string[] = []
for (let value of mainFields) {
validateStringValue(value, 'main field')
if (value.indexOf(',') >= 0) throw new Error(`Invalid main field: ${value}`)
values.push(value)
}
flags.push(`--main-fields=${values.join(',')}`)
}
if (conditions) {
let values: string[] = []
for (let value of conditions) {
validateStringValue(value, 'condition')
if (value.indexOf(',') >= 0) throw new Error(`Invalid condition: ${value}`)
values.push(value)
}
flags.push(`--conditions=${values.join(',')}`)
}
if (external) for (let name of external) flags.push(`--external:${validateStringValue(name, 'external')}`)
if (alias) {
for (let old in alias) {
if (old.indexOf('=') >= 0) throw new Error(`Invalid package name in alias: ${old}`)
flags.push(`--alias:${old}=${validateStringValue(alias[old], 'alias', old)}`)
}
}
if (banner) {
for (let type in banner) {
if (type.indexOf('=') >= 0) throw new Error(`Invalid banner file type: ${type}`)
flags.push(`--banner:${type}=${validateStringValue(banner[type], 'banner', type)}`)
}
}
if (footer) {
for (let type in footer) {
if (type.indexOf('=') >= 0) throw new Error(`Invalid footer file type: ${type}`)
flags.push(`--footer:${type}=${validateStringValue(footer[type], 'footer', type)}`)
}
}
if (inject) for (let path of inject) flags.push(`--inject:${validateStringValue(path, 'inject')}`)
if (loader) {
for (let ext in loader) {
if (ext.indexOf('=') >= 0) throw new Error(`Invalid loader extension: ${ext}`)
flags.push(`--loader:${ext}=${validateStringValue(loader[ext], 'loader', ext)}`)
}
}
if (outExtension) {
for (let ext in outExtension) {
if (ext.indexOf('=') >= 0) throw new Error(`Invalid out extension: ${ext}`)
flags.push(`--out-extension:${ext}=${validateStringValue(outExtension[ext], 'out extension', ext)}`)
}
}
if (entryPoints) {
if (Array.isArray(entryPoints)) {
for (let i = 0, n = entryPoints.length; i < n; i++) {
let entryPoint = entryPoints[i]
if (typeof entryPoint === 'object' && entryPoint !== null) {
let entryPointKeys: OptionKeys = Object.create(null)
let input = getFlag(entryPoint, entryPointKeys, 'in', mustBeString)
let output = getFlag(entryPoint, entryPointKeys, 'out', mustBeString)
checkForInvalidFlags(entryPoint, entryPointKeys, 'in entry point at index ' + i)
if (input === undefined) throw new Error('Missing property "in" for entry point at index ' + i)
if (output === undefined) throw new Error('Missing property "out" for entry point at index ' + i)
entries.push([output, input])
} else {
entries.push(['', validateStringValue(entryPoint, 'entry point at index ' + i)])
}
}
} else {
for (let key in entryPoints) {
entries.push([key, validateStringValue(entryPoints[key], 'entry point', key)])
}
}
}
if (stdin) {
let stdinKeys: OptionKeys = Object.create(null)
let contents = getFlag(stdin, stdinKeys, 'contents', mustBeStringOrUint8Array)
let resolveDir = getFlag(stdin, stdinKeys, 'resolveDir', mustBeString)
let sourcefile = getFlag(stdin, stdinKeys, 'sourcefile', mustBeString)
let loader = getFlag(stdin, stdinKeys, 'loader', mustBeString)
checkForInvalidFlags(stdin, stdinKeys, 'in "stdin" object')
if (sourcefile) flags.push(`--sourcefile=${sourcefile}`)
if (loader) flags.push(`--loader=${loader}`)
if (resolveDir) stdinResolveDir = resolveDir
if (typeof contents === 'string') stdinContents = protocol.encodeUTF8(contents)
else if (contents instanceof Uint8Array) stdinContents = contents
}
let nodePaths: string[] = []
if (nodePathsInput) {
for (let value of nodePathsInput) {
value += ''
nodePaths.push(value)
}
}
return {
entries,
flags,
write,
stdinContents,
stdinResolveDir,
absWorkingDir,
nodePaths,
mangleCache: validateMangleCache(mangleCache),
}
}
function flagsForTransformOptions(
callName: string,
options: types.TransformOptions,
isTTY: boolean,
logLevelDefault: types.LogLevel,
): {
flags: string[],
mangleCache: MangleCache | undefined,
} {
let flags: string[] = []
let keys: OptionKeys = Object.create(null)
pushLogFlags(flags, options, keys, isTTY, logLevelDefault)
pushCommonFlags(flags, options, keys)
let sourcemap = getFlag(options, keys, 'sourcemap', mustBeStringOrBoolean)
let sourcefile = getFlag(options, keys, 'sourcefile', mustBeString)
let loader = getFlag(options, keys, 'loader', mustBeString)
let banner = getFlag(options, keys, 'banner', mustBeString)
let footer = getFlag(options, keys, 'footer', mustBeString)
let mangleCache = getFlag(options, keys, 'mangleCache', mustBeObject)
checkForInvalidFlags(options, keys, `in ${callName}() call`)
if (sourcemap) flags.push(`--sourcemap=${sourcemap === true ? 'external' : sourcemap}`)
if (sourcefile) flags.push(`--sourcefile=${sourcefile}`)
if (loader) flags.push(`--loader=${loader}`)
if (banner) flags.push(`--banner=${banner}`)
if (footer) flags.push(`--footer=${footer}`)
return {
flags,
mangleCache: validateMangleCache(mangleCache),
}
}
export interface StreamIn {
writeToStdin: (data: Uint8Array) => void
readFileSync?: (path: string, encoding: 'utf8') => string
isSync: boolean
hasFS: boolean
esbuild: types.PluginBuild['esbuild']
}
export interface StreamOut {
readFromStdout: (data: Uint8Array) => void
afterClose: (error: Error | null) => void
service: StreamService
}
export interface StreamFS {
writeFile(contents: string | Uint8Array, callback: (path: string | null) => void): void
readFile(path: string, callback: (err: Error | null, contents: string | null) => void): void
}
export interface Refs {
ref(): void
unref(): void
}
export interface StreamService {
buildOrContext(args: {
callName: string,
refs: Refs | null,
options: types.BuildOptions,
isTTY: boolean,
defaultWD: string,
callback: (err: Error | null, res: types.BuildResult | types.BuildContext | null) => void,
}): void
transform(args: {
callName: string,
refs: Refs | null,
input: string | Uint8Array,
options: types.TransformOptions,
isTTY: boolean,
fs: StreamFS,
callback: (err: Error | null, res: types.TransformResult | null) => void,
}): void
formatMessages(args: {
callName: string,
refs: Refs | null,
messages: types.PartialMessage[],
options: types.FormatMessagesOptions,
callback: (err: Error | null, res: string[] | null) => void,
}): void
analyzeMetafile(args: {
callName: string,
refs: Refs | null,
metafile: string,
options: types.AnalyzeMetafileOptions | undefined,
callback: (err: Error | null, res: string | null) => void,
}): void
}
type CloseData = { didClose: boolean, reason: string }
type RequestCallback = (id: number, request: any) => Promise<void> | void
// This can't use any promises in the main execution flow because it must work
// for both sync and async code. There is an exception for plugin code because
// that can't work in sync code anyway.
export function createChannel(streamIn: StreamIn): StreamOut {
const requestCallbacksByKey: { [key: number]: { [command: string]: RequestCallback } } = {}
const closeData: CloseData = { didClose: false, reason: '' }
let responseCallbacks: { [id: number]: (error: string | null, response: protocol.Value) => void } = {}
let nextRequestID = 0
let nextBuildKey = 0
// Use a long-lived buffer to store stdout data
let stdout = new Uint8Array(16 * 1024)
let stdoutUsed = 0
let readFromStdout = (chunk: Uint8Array) => {
// Append the chunk to the stdout buffer, growing it as necessary
let limit = stdoutUsed + chunk.length
if (limit > stdout.length) {
let swap = new Uint8Array(limit * 2)
swap.set(stdout)
stdout = swap
}
stdout.set(chunk, stdoutUsed)
stdoutUsed += chunk.length
// Process all complete (i.e. not partial) packets
let offset = 0
while (offset + 4 <= stdoutUsed) {
let length = protocol.readUInt32LE(stdout, offset)
if (offset + 4 + length > stdoutUsed) {
break
}
offset += 4
handleIncomingPacket(stdout.subarray(offset, offset + length))
offset += length
}
if (offset > 0) {
stdout.copyWithin(0, offset, stdoutUsed)
stdoutUsed -= offset
}
}
let afterClose = (error: Error | null) => {
// When the process is closed, fail all pending requests
closeData.didClose = true
if (error) closeData.reason = ': ' + (error.message || error)
const text = 'The service was stopped' + closeData.reason
for (let id in responseCallbacks) {
responseCallbacks[id](text, null)
}
responseCallbacks = {}
}
let sendRequest = <Req, Res>(refs: Refs | null, value: Req, callback: (error: string | null, response: Res | null) => void): void => {
if (closeData.didClose) return callback('The service is no longer running' + closeData.reason, null)
let id = nextRequestID++
responseCallbacks[id] = (error, response) => {
try {
callback(error, response as any)
} finally {
if (refs) refs.unref() // Do this after the callback so the callback can extend the lifetime if needed
}
}
if (refs) refs.ref()
streamIn.writeToStdin(protocol.encodePacket({ id, isRequest: true, value: value as any }))
}
let sendResponse = (id: number, value: protocol.Value): void => {
if (closeData.didClose) throw new Error('The service is no longer running' + closeData.reason)
streamIn.writeToStdin(protocol.encodePacket({ id, isRequest: false, value }))
}
let handleRequest = async (id: number, request: any) => {
// Catch exceptions in the code below so they get passed to the caller
try {
if (request.command === 'ping') {
sendResponse(id, {})
return
}
if (typeof request.key === 'number') {
const requestCallbacks = requestCallbacksByKey[request.key]
if (!requestCallbacks) {
// Ignore invalid commands for old builds that no longer exist.
// This can happen when "context.cancel" and "context.dispose"
// is called while esbuild is processing many files in parallel.
// See https://github.com/evanw/esbuild/issues/3318 for details.
return
}
const callback = requestCallbacks[request.command]
if (callback) {
await callback(id, request)
return
}
}
throw new Error(`Invalid command: ` + request.command)
} catch (e) {
const errors = [extractErrorMessageV8(e, streamIn, null, void 0, '')]
try {
sendResponse(id, { errors } as any)
} catch {
// This may fail if the esbuild process is no longer running, but
// that's ok. Catch and swallow this exception so that we don't
// cause an unhandled promise rejection. Our caller isn't expecting
// this call to fail and doesn't handle the promise rejection.
}
}
}
let isFirstPacket = true
let handleIncomingPacket = (bytes: Uint8Array): void => {
// The first packet is a version check
if (isFirstPacket) {
isFirstPacket = false
// Validate the binary's version number to make sure esbuild was installed
// correctly. This check was added because some people have reported
// errors that appear to indicate an incorrect installation.
let binaryVersion = String.fromCharCode(...bytes)
if (binaryVersion !== ESBUILD_VERSION) {
throw new Error(`Cannot start service: Host version "${ESBUILD_VERSION}" does not match binary version ${quote(binaryVersion)}`)
}
return
}
let packet = protocol.decodePacket(bytes) as any
if (packet.isRequest) {
handleRequest(packet.id, packet.value)
}
else {
let callback = responseCallbacks[packet.id]!
delete responseCallbacks[packet.id]
if (packet.value.error) callback(packet.value.error, {})
else callback(null, packet.value)
}
}
let buildOrContext: StreamService['buildOrContext'] = ({ callName, refs, options, isTTY, defaultWD, callback }) => {
let refCount = 0
const buildKey = nextBuildKey++
const requestCallbacks: { [command: string]: RequestCallback } = {}
const buildRefs: Refs = {
ref() {
if (++refCount === 1) {
if (refs) refs.ref()
}
},
unref() {
if (--refCount === 0) {
delete requestCallbacksByKey[buildKey]
if (refs) refs.unref()
}
},
}
requestCallbacksByKey[buildKey] = requestCallbacks
// Guard the whole "build" request with a temporary ref count bump. We
// don't want the ref count to be bumped above zero and then back down
// to zero before the callback is called.
buildRefs.ref()
buildOrContextImpl(
callName,
buildKey,
sendRequest,
sendResponse,
buildRefs,
streamIn,
requestCallbacks,
options,
isTTY,
defaultWD,
(err, res) => {
// Now that the initial "build" request is done, we can release our
// temporary ref count bump. Any code that wants to extend the life
// of the build will have to do so by explicitly retaining a count.
try {
callback(err, res)
} finally {
buildRefs.unref()
}
},
)
}
let transform: StreamService['transform'] = ({ callName, refs, input, options, isTTY, fs, callback }) => {
const details = createObjectStash()
// Ideally the "transform()" API would be faster than calling "build()"
// since it doesn't need to touch the file system. However, performance
// measurements with large files on macOS indicate that sending the data
// over the stdio pipe can be 2x slower than just using a temporary file.
//
// This appears to be an OS limitation. Both the JavaScript and Go code
// are using large buffers but the pipe only writes data in 8kb chunks.
// An investigation seems to indicate that this number is hard-coded into
// the OS source code. Presumably files are faster because the OS uses
// a larger chunk size, or maybe even reads everything in one syscall.
//
// The cross-over size where this starts to be faster is around 1mb on
// my machine. In that case, this code tries to use a temporary file if
// possible but falls back to sending the data over the stdio pipe if
// that doesn't work.
let start = (inputPath: string | null) => {
try {
if (typeof input !== 'string' && !(input instanceof Uint8Array))
throw new Error('The input to "transform" must be a string or a Uint8Array')
let {
flags,
mangleCache,
} = flagsForTransformOptions(callName, options, isTTY, transformLogLevelDefault)
let request: protocol.TransformRequest = {
command: 'transform',
flags,
inputFS: inputPath !== null,
input: inputPath !== null ? protocol.encodeUTF8(inputPath)
: typeof input === 'string' ? protocol.encodeUTF8(input)
: input,
}
if (mangleCache) request.mangleCache = mangleCache
sendRequest<protocol.TransformRequest, protocol.TransformResponse>(refs, request, (error, response) => {
if (error) return callback(new Error(error), null)
let errors = replaceDetailsInMessages(response!.errors, details)
let warnings = replaceDetailsInMessages(response!.warnings, details)
let outstanding = 1
let next = () => {
if (--outstanding === 0) {
let result: types.TransformResult = {
warnings,
code: response!.code,
map: response!.map,
mangleCache: undefined,
legalComments: undefined,
}
if ('legalComments' in response!) result.legalComments = response?.legalComments
if (response!.mangleCache) result.mangleCache = response?.mangleCache
callback(null, result)
}
}
if (errors.length > 0) return callback(failureErrorWithLog('Transform failed', errors, warnings), null)
// Read the JavaScript file from the file system
if (response!.codeFS) {
outstanding++
fs.readFile(response!.code, (err, contents) => {
if (err !== null) {
callback(err, null)
} else {
response!.code = contents!
next()
}
})
}
// Read the source map file from the file system
if (response!.mapFS) {
outstanding++
fs.readFile(response!.map, (err, contents) => {
if (err !== null) {
callback(err, null)
} else {
response!.map = contents!
next()
}
})
}
next()
})
} catch (e) {
let flags: string[] = []
try { pushLogFlags(flags, options, {}, isTTY, transformLogLevelDefault) } catch { }
const error = extractErrorMessageV8(e, streamIn, details, void 0, '')
sendRequest(refs, { command: 'error', flags, error }, () => {
error.detail = details.load(error.detail)
callback(failureErrorWithLog('Transform failed', [error], []), null)
})
}
}
if ((typeof input === 'string' || input instanceof Uint8Array) && input.length > 1024 * 1024) {
let next = start
start = () => fs.writeFile(input, next)
}
start(null)
}
let formatMessages: StreamService['formatMessages'] = ({ callName, refs, messages, options, callback }) => {
if (!options) throw new Error(`Missing second argument in ${callName}() call`)
let keys: OptionKeys = {}
let kind = getFlag(options, keys, 'kind', mustBeString)
let color = getFlag(options, keys, 'color', mustBeBoolean)
let terminalWidth = getFlag(options, keys, 'terminalWidth', mustBeInteger)
checkForInvalidFlags(options, keys, `in ${callName}() call`)
if (kind === void 0) throw new Error(`Missing "kind" in ${callName}() call`)
if (kind !== 'error' && kind !== 'warning') throw new Error(`Expected "kind" to be "error" or "warning" in ${callName}() call`)
let request: protocol.FormatMsgsRequest = {
command: 'format-msgs',
messages: sanitizeMessages(messages, 'messages', null, '', terminalWidth),
isWarning: kind === 'warning',
}
if (color !== void 0) request.color = color
if (terminalWidth !== void 0) request.terminalWidth = terminalWidth
sendRequest<protocol.FormatMsgsRequest, protocol.FormatMsgsResponse>(refs, request, (error, response) => {
if (error) return callback(new Error(error), null)
callback(null, response!.messages)
})
}
let analyzeMetafile: StreamService['analyzeMetafile'] = ({ callName, refs, metafile, options, callback }) => {
if (options === void 0) options = {}
let keys: OptionKeys = {}
let color = getFlag(options, keys, 'color', mustBeBoolean)
let verbose = getFlag(options, keys, 'verbose', mustBeBoolean)
checkForInvalidFlags(options, keys, `in ${callName}() call`)
let request: protocol.AnalyzeMetafileRequest = {
command: 'analyze-metafile',
metafile,
}
if (color !== void 0) request.color = color
if (verbose !== void 0) request.verbose = verbose
sendRequest<protocol.AnalyzeMetafileRequest, protocol.AnalyzeMetafileResponse>(refs, request, (error, response) => {
if (error) return callback(new Error(error), null)
callback(null, response!.result)
})
}
return {
readFromStdout,
afterClose,
service: {
buildOrContext,
transform,
formatMessages,
analyzeMetafile,
},
}
}
function buildOrContextImpl(
callName: string,
buildKey: number,
sendRequest: <Req, Res>(refs: Refs | null, value: Req, callback: (error: string | null, response: Res | null) => void) => void,
sendResponse: (id: number, value: protocol.Value) => void,
refs: Refs,
streamIn: StreamIn,
requestCallbacks: { [command: string]: RequestCallback },
options: types.BuildOptions,
isTTY: boolean,
defaultWD: string,
callback: (err: Error | null, res: types.BuildResult | types.BuildContext | null) => void,
): void {
const details = createObjectStash()
const isContext = callName === 'context'
const handleError = (e: any, pluginName: string): void => {
const flags: string[] = []
try { pushLogFlags(flags, options, {}, isTTY, buildLogLevelDefault) } catch { }
const message = extractErrorMessageV8(e, streamIn, details, void 0, pluginName)
sendRequest(refs, { command: 'error', flags, error: message }, () => {
message.detail = details.load(message.detail)
callback(failureErrorWithLog(isContext ? 'Context failed' : 'Build failed', [message], []), null)
})
}
let plugins: types.Plugin[] | undefined
if (typeof options === 'object') {
const value = options.plugins
if (value !== void 0) {
if (!Array.isArray(value)) return handleError(new Error(`"plugins" must be an array`), '')
plugins = value
}
}
if (plugins && plugins.length > 0) {
if (streamIn.isSync) return handleError(new Error('Cannot use plugins in synchronous API calls'), '')
// Plugins can use async/await because they can't be run with "buildSync"
handlePlugins(
buildKey,
sendRequest,
sendResponse,
refs,
streamIn,
requestCallbacks,
options,
plugins,
details,
).then(
result => {
if (!result.ok) return handleError(result.error, result.pluginName)
try {
buildOrContextContinue(result.requestPlugins, result.runOnEndCallbacks, result.scheduleOnDisposeCallbacks)
} catch (e) {
handleError(e, '')
}
},
e => handleError(e, ''),
)
return
}
try {
buildOrContextContinue(null, (result, done) => done([], []), () => { })
} catch (e) {
handleError(e, '')
}
// "buildOrContext" cannot be written using async/await due to "buildSync"
// and must be written in continuation-passing style instead
function buildOrContextContinue(requestPlugins: protocol.BuildPlugin[] | null, runOnEndCallbacks: RunOnEndCallbacks, scheduleOnDisposeCallbacks: () => void) {
const writeDefault = streamIn.hasFS
const {
entries,
flags,
write,
stdinContents,
stdinResolveDir,
absWorkingDir,
nodePaths,
mangleCache,
} = flagsForBuildOptions(callName, options, isTTY, buildLogLevelDefault, writeDefault)
if (write && !streamIn.hasFS) throw new Error(`The "write" option is unavailable in this environment`)
// Construct the request
const request: protocol.BuildRequest = {
command: 'build',
key: buildKey,
entries,
flags,
write,
stdinContents,
stdinResolveDir,
absWorkingDir: absWorkingDir || defaultWD,
nodePaths,
context: isContext,
}
if (requestPlugins) request.plugins = requestPlugins
if (mangleCache) request.mangleCache = mangleCache
// Factor out response handling so it can be reused for rebuilds
const buildResponseToResult = (
response: protocol.BuildResponse | null,
callback: (error: types.BuildFailure | null, result: types.BuildResult | null, onEndErrors: types.Message[], onEndWarnings: types.Message[]) => void,
): void => {
const result: types.BuildResult = {
errors: replaceDetailsInMessages(response!.errors, details),
warnings: replaceDetailsInMessages(response!.warnings, details),
outputFiles: undefined,
metafile: undefined,
mangleCache: undefined,
}
const originalErrors = result.errors.slice()
const originalWarnings = result.warnings.slice()
if (response!.outputFiles) result.outputFiles = response!.outputFiles.map(convertOutputFiles)
if (response!.metafile) result.metafile = JSON.parse(response!.metafile)
if (response!.mangleCache) result.mangleCache = response!.mangleCache
if (response!.writeToStdout !== void 0) console.log(protocol.decodeUTF8(response!.writeToStdout).replace(/\n$/, ''))
runOnEndCallbacks(result, (onEndErrors, onEndWarnings) => {
if (originalErrors.length > 0 || onEndErrors.length > 0) {
const error = failureErrorWithLog('Build failed', originalErrors.concat(onEndErrors), originalWarnings.concat(onEndWarnings))
return callback(error, null, onEndErrors, onEndWarnings)
}
callback(null, result, onEndErrors, onEndWarnings)
})
}
// In context mode, Go runs the "onEnd" callbacks instead of JavaScript
let latestResultPromise: Promise<types.BuildResult> | undefined
let provideLatestResult: ((error: types.BuildFailure | null, result: types.BuildResult | null) => void) | undefined
if (isContext)
requestCallbacks['on-end'] = (id, request: protocol.OnEndRequest) =>
new Promise(resolve => {
buildResponseToResult(request, (err, result, onEndErrors, onEndWarnings) => {
const response: protocol.OnEndResponse = {
errors: onEndErrors,
warnings: onEndWarnings,
}
if (provideLatestResult) provideLatestResult(err, result)
latestResultPromise = undefined
provideLatestResult = undefined
sendResponse(id, response as any)
resolve()
})
})