forked from oven-sh/bun
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathoutput.zig
1191 lines (1020 loc) · 40.7 KB
/
output.zig
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
const bun = @import("root").bun;
const std = @import("std");
const Environment = @import("./env.zig");
const string = bun.string;
const root = @import("root");
const strings = bun.strings;
const StringTypes = bun.StringTypes;
const Global = bun.Global;
const ComptimeStringMap = bun.ComptimeStringMap;
const use_mimalloc = bun.use_mimalloc;
const writeStream = std.json.writeStream;
const WriteStream = std.json.WriteStream;
const SystemTimer = @import("./system_timer.zig").Timer;
// These are threadlocal so we don't have stdout/stderr writing on top of each other
threadlocal var source: Source = undefined;
threadlocal var source_set: bool = false;
// These are not threadlocal so we avoid opening stdout/stderr for every thread
var stderr_stream: Source.StreamType = undefined;
var stdout_stream: Source.StreamType = undefined;
var stdout_stream_set = false;
const File = bun.sys.File;
pub var terminal_size: std.posix.winsize = .{
.ws_row = 0,
.ws_col = 0,
.ws_xpixel = 0,
.ws_ypixel = 0,
};
pub const Source = struct {
pub const StreamType: type = brk: {
if (Environment.isWasm) {
break :brk std.io.FixedBufferStream([]u8);
} else {
break :brk File;
// var stdout = std.io.getStdOut();
// return @TypeOf(std.io.bufferedWriter(stdout.writer()));
}
};
pub const BufferedStream: type = struct {
fn getBufferedStream() type {
if (comptime Environment.isWasm)
return StreamType;
return std.io.BufferedWriter(4096, @TypeOf(StreamType.quietWriter(undefined)));
}
}.getBufferedStream();
buffered_stream: BufferedStream,
buffered_error_stream: BufferedStream,
stream: StreamType,
error_stream: StreamType,
out_buffer: []u8 = &([_]u8{}),
err_buffer: []u8 = &([_]u8{}),
pub fn init(
stream: StreamType,
err_stream: StreamType,
) Source {
if (comptime Environment.isDebug) {
if (comptime use_mimalloc) {
if (!source_set) {
const Mimalloc = @import("./allocators/mimalloc.zig");
Mimalloc.mi_option_set(.show_errors, 1);
}
}
}
source_set = true;
return Source{
.stream = stream,
.error_stream = err_stream,
.buffered_stream = if (Environment.isNative)
BufferedStream{ .unbuffered_writer = stream.quietWriter() }
else
stream,
.buffered_error_stream = if (Environment.isNative)
BufferedStream{ .unbuffered_writer = err_stream.quietWriter() }
else
err_stream,
};
}
pub fn configureThread() void {
if (source_set) return;
bun.debugAssert(stdout_stream_set);
source = Source.init(stdout_stream, stderr_stream);
}
pub fn configureNamedThread(name: StringTypes.stringZ) void {
Global.setThreadName(name);
configureThread();
}
pub fn isNoColor() bool {
const no_color = bun.getenvZ("NO_COLOR") orelse return false;
// https://no-color.org/
// "when present and not an empty string (regardless of its value)"
return no_color.len != 0;
}
pub fn getForceColorDepth() ?ColorDepth {
const force_color = bun.getenvZ("FORCE_COLOR") orelse return null;
// Supported by Node.js, if set will ignore NO_COLOR.
// - "0" to indicate no color support
// - "1", "true", or "" to indicate 16-color support
// - "2" to indicate 256-color support
// - "3" to indicate 16 million-color support
if (strings.eqlComptime(force_color, "1") or strings.eqlComptime(force_color, "true") or strings.eqlComptime(force_color, "")) {
return ColorDepth.@"16";
}
if (strings.eqlComptime(force_color, "2")) {
return ColorDepth.@"256";
}
if (strings.eqlComptime(force_color, "3")) {
return ColorDepth.@"16m";
}
return ColorDepth.none;
}
pub fn isForceColor() bool {
return (getForceColorDepth() orelse ColorDepth.none) != .none;
}
pub fn isColorTerminal() bool {
if (Environment.isWindows) {
// https://github.com/chalk/supports-color/blob/d4f413efaf8da045c5ab440ed418ef02dbb28bf1/index.js#L100C11-L112
// Windows 10 build 10586 is the first Windows release that supports 256 colors.
// Windows 10 build 14931 is the first release that supports 16m/TrueColor.
// Every other version supports 16 colors.
return true;
}
return colorDepth() != .none;
}
export var bun_stdio_tty: [3]i32 = .{ 0, 0, 0 };
const WindowsStdio = struct {
const w = bun.windows;
/// At program start, we snapshot the console modes of standard in, out, and err
/// so that we can restore them at program exit if they change. Restoration is
/// best-effort, and may not be applied if the process is killed abruptly.
pub var console_mode = [3]?u32{ null, null, null };
pub var console_codepage = @as(u32, 0);
pub var console_output_codepage = @as(u32, 0);
pub export fn Bun__restoreWindowsStdio() callconv(.C) void {
restore();
}
comptime {
if (Environment.isWindows) {
_ = &Bun__restoreWindowsStdio;
}
}
pub fn restore() void {
const peb = std.os.windows.peb();
const stdout = peb.ProcessParameters.hStdOutput;
const stderr = peb.ProcessParameters.hStdError;
const stdin = peb.ProcessParameters.hStdInput;
const handles = &.{ &stdin, &stdout, &stderr };
inline for (console_mode, handles) |mode, handle| {
if (mode) |m| {
_ = w.SetConsoleMode(handle.*, m);
}
}
if (console_output_codepage != 0)
_ = w.kernel32.SetConsoleOutputCP(console_output_codepage);
if (console_codepage != 0)
_ = w.SetConsoleCP(console_codepage);
}
pub fn init() void {
w.libuv.uv_disable_stdio_inheritance();
const stdin = std.os.windows.GetStdHandle(std.os.windows.STD_INPUT_HANDLE) catch w.INVALID_HANDLE_VALUE;
const stdout = std.os.windows.GetStdHandle(std.os.windows.STD_OUTPUT_HANDLE) catch w.INVALID_HANDLE_VALUE;
const stderr = std.os.windows.GetStdHandle(std.os.windows.STD_ERROR_HANDLE) catch w.INVALID_HANDLE_VALUE;
bun.win32.STDERR_FD = if (stderr != std.os.windows.INVALID_HANDLE_VALUE) bun.toFD(stderr) else bun.invalid_fd;
bun.win32.STDOUT_FD = if (stdout != std.os.windows.INVALID_HANDLE_VALUE) bun.toFD(stdout) else bun.invalid_fd;
bun.win32.STDIN_FD = if (stdin != std.os.windows.INVALID_HANDLE_VALUE) bun.toFD(stdin) else bun.invalid_fd;
buffered_stdin.unbuffered_reader.context.handle = bun.win32.STDIN_FD;
// https://learn.microsoft.com/en-us/windows/console/setconsoleoutputcp
const CP_UTF8 = 65001;
console_output_codepage = w.kernel32.GetConsoleOutputCP();
_ = w.kernel32.SetConsoleOutputCP(CP_UTF8);
console_codepage = w.kernel32.GetConsoleOutputCP();
_ = w.SetConsoleCP(CP_UTF8);
var mode: w.DWORD = undefined;
if (w.kernel32.GetConsoleMode(stdin, &mode) != 0) {
console_mode[0] = mode;
bun_stdio_tty[0] = 1;
// There are no flags to set on standard in, but just in case something
// later modifies the mode, we can still reset it at the end of program run
//
// In the past, Bun would set ENABLE_VIRTUAL_TERMINAL_INPUT, which was not
// intentionally set for any purpose, and instead only caused problems.
}
if (w.kernel32.GetConsoleMode(stdout, &mode) != 0) {
console_mode[1] = mode;
bun_stdio_tty[1] = 1;
_ = w.SetConsoleMode(stdout, w.ENABLE_PROCESSED_OUTPUT | std.os.windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING | w.ENABLE_WRAP_AT_EOL_OUTPUT | mode);
}
if (w.kernel32.GetConsoleMode(stderr, &mode) != 0) {
console_mode[2] = mode;
bun_stdio_tty[2] = 1;
_ = w.SetConsoleMode(stderr, w.ENABLE_PROCESSED_OUTPUT | std.os.windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING | w.ENABLE_WRAP_AT_EOL_OUTPUT | mode);
}
}
};
pub const Stdio = struct {
extern "C" var bun_is_stdio_null: [3]i32;
pub fn isStderrNull() bool {
return bun_is_stdio_null[2] == 1;
}
pub fn isStdoutNull() bool {
return bun_is_stdio_null[1] == 1;
}
pub fn isStdinNull() bool {
return bun_is_stdio_null[0] == 1;
}
pub fn init() void {
bun.C.bun_initialize_process();
if (Environment.isWindows) {
WindowsStdio.init();
}
const stdout = bun.sys.File.from(std.io.getStdOut());
const stderr = bun.sys.File.from(std.io.getStdErr());
Source.init(stdout, stderr)
.set();
if (comptime Environment.isDebug or Environment.enable_logs) {
initScopedDebugWriterAtStartup();
}
}
pub fn restore() void {
if (Environment.isWindows) {
WindowsStdio.restore();
} else {
bun.C.bun_restore_stdio();
}
}
};
pub const ColorDepth = enum {
none,
@"16",
@"256",
@"16m",
};
var lazy_color_depth: ColorDepth = .none;
var color_depth_once = std.once(getColorDepthOnce);
fn getColorDepthOnce() void {
if (getForceColorDepth()) |depth| {
lazy_color_depth = depth;
return;
}
if (isNoColor()) {
return;
}
const term = bun.getenvZ("TERM") orelse "";
if (strings.eqlComptime(term, "dumb")) {
return;
}
if (bun.getenvZ("TMUX") != null) {
lazy_color_depth = .@"256";
return;
}
if (bun.getenvZ("CI")) |ci| {
inline for (.{ "APPVEYOR", "BUILDKITE", "CIRCLECI", "DRONE", "GITHUB_ACTIONS", "GITLAB_CI", "TRAVIS" }) |ci_env| {
if (strings.eqlComptime(ci, ci_env)) {
lazy_color_depth = .@"256";
return;
}
}
lazy_color_depth = .@"16";
return;
}
if (bun.getenvZ("TERM_PROGRAM")) |term_program| {
if (strings.eqlComptime(term_program, "iTerm.app")) {
lazy_color_depth = .@"16m";
return;
}
if (strings.eqlComptime(term_program, "WezTerm")) {
lazy_color_depth = .@"16m";
return;
}
if (strings.eqlComptime(term_program, "ghostty")) {
lazy_color_depth = .@"16m";
return;
}
}
var has_color_term_set = false;
if (bun.getenvZ("COLORTERM")) |color_term| {
if (strings.eqlComptime(color_term, "truecolor") or strings.eqlComptime(color_term, "24bit")) {
lazy_color_depth = .@"16m";
return;
}
has_color_term_set = true;
}
if (term.len > 0) {
if (strings.hasPrefixComptime(term, "xterm-256")) {
lazy_color_depth = .@"256";
return;
}
const pairs = .{
.{ "st", ColorDepth.@"16" },
.{ "hurd", ColorDepth.@"16" },
.{ "eterm", ColorDepth.@"16" },
.{ "gnome", ColorDepth.@"16" },
.{ "kterm", ColorDepth.@"16" },
.{ "mosh", ColorDepth.@"16m" },
.{ "putty", ColorDepth.@"16" },
.{ "cons25", ColorDepth.@"16" },
.{ "cygwin", ColorDepth.@"16" },
.{ "dtterm", ColorDepth.@"16" },
.{ "mlterm", ColorDepth.@"16" },
.{ "console", ColorDepth.@"16" },
.{ "jfbterm", ColorDepth.@"16" },
.{ "konsole", ColorDepth.@"16" },
.{ "terminator", ColorDepth.@"16m" },
.{ "xterm-ghostty", ColorDepth.@"16m" },
.{ "rxvt-unicode-24bit", ColorDepth.@"16m" },
};
inline for (pairs) |pair| {
if (strings.eqlComptime(term, pair[0])) {
lazy_color_depth = pair[1];
return;
}
}
if (strings.includes(term, "con") or
strings.includes(term, "ansi") or
strings.includes(term, "rxvt") or
strings.includes(term, "color") or
strings.includes(term, "linux") or
strings.includes(term, "vt100") or
strings.includes(term, "xterm") or
strings.includes(term, "screen"))
{
lazy_color_depth = .@"16";
return;
}
}
if (has_color_term_set) {
lazy_color_depth = .@"16";
return;
}
lazy_color_depth = .none;
}
pub fn colorDepth() ColorDepth {
color_depth_once.call();
return lazy_color_depth;
}
pub fn set(new_source: *const Source) void {
source = new_source.*;
source_set = true;
if (!stdout_stream_set) {
stdout_stream_set = true;
if (comptime Environment.isNative) {
const is_stdout_tty = bun_stdio_tty[1] != 0;
if (is_stdout_tty) {
stdout_descriptor_type = OutputStreamDescriptor.terminal;
}
const is_stderr_tty = bun_stdio_tty[2] != 0;
if (is_stderr_tty) {
stderr_descriptor_type = OutputStreamDescriptor.terminal;
}
var enable_color: ?bool = null;
if (isForceColor()) {
enable_color = true;
} else if (isNoColor()) {
enable_color = false;
} else if (isColorTerminal() and (is_stdout_tty or is_stderr_tty)) {
enable_color = true;
}
enable_ansi_colors_stdout = enable_color orelse is_stdout_tty;
enable_ansi_colors_stderr = enable_color orelse is_stderr_tty;
enable_ansi_colors = enable_ansi_colors_stdout or enable_ansi_colors_stderr;
}
stdout_stream = new_source.stream;
stderr_stream = new_source.error_stream;
}
}
};
pub const OutputStreamDescriptor = enum {
unknown,
// file,
// pipe,
terminal,
};
pub var enable_ansi_colors = Environment.isNative;
pub var enable_ansi_colors_stderr = Environment.isNative;
pub var enable_ansi_colors_stdout = Environment.isNative;
pub var enable_buffering = Environment.isNative;
pub var is_verbose = false;
pub var is_github_action = false;
pub var stderr_descriptor_type = OutputStreamDescriptor.unknown;
pub var stdout_descriptor_type = OutputStreamDescriptor.unknown;
pub inline fn isEmojiEnabled() bool {
return enable_ansi_colors;
}
pub fn isGithubAction() bool {
if (bun.getenvZ("GITHUB_ACTIONS")) |value| {
return strings.eqlComptime(value, "true");
}
return false;
}
pub fn isVerbose() bool {
// Set by Github Actions when a workflow is run using debug mode.
if (bun.getenvZ("RUNNER_DEBUG")) |value| {
if (strings.eqlComptime(value, "1")) {
return true;
}
}
return false;
}
var _source_for_test: if (Environment.isTest) Source else void = undefined;
var _source_for_test_set = false;
pub fn initTest() void {
if (_source_for_test_set) return;
_source_for_test_set = true;
const in = std.io.getStdErr();
const out = std.io.getStdOut();
_source_for_test = Source.init(File.from(out), File.from(in));
Source.set(&_source_for_test);
}
pub fn enableBuffering() void {
if (comptime Environment.isNative) enable_buffering = true;
}
pub fn disableBuffering() void {
flush();
if (comptime Environment.isNative) enable_buffering = false;
}
pub fn panic(comptime fmt: string, args: anytype) noreturn {
@setCold(true);
if (isEmojiEnabled()) {
std.debug.panic(comptime prettyFmt(fmt, true), args);
} else {
std.debug.panic(comptime prettyFmt(fmt, false), args);
}
}
pub const WriterType: type = @TypeOf(Source.StreamType.quietWriter(undefined));
// TODO: investigate migrating this to the buffered one.
pub fn errorWriter() WriterType {
bun.debugAssert(source_set);
return source.error_stream.quietWriter();
}
pub fn errorWriterBuffered() Source.BufferedStream.Writer {
bun.debugAssert(source_set);
return source.buffered_error_stream.writer();
}
// TODO: investigate returning the buffered_error_stream
pub fn errorStream() Source.StreamType {
bun.debugAssert(source_set);
return source.error_stream;
}
pub fn writer() WriterType {
bun.debugAssert(source_set);
return source.stream.quietWriter();
}
pub fn resetTerminal() void {
if (!enable_ansi_colors) {
return;
}
if (enable_ansi_colors_stderr) {
_ = source.error_stream.write("\x1B[2J\x1B[3J\x1B[H").unwrap() catch 0;
} else {
_ = source.stream.write("\x1B[2J\x1B[3J\x1B[H").unwrap() catch 0;
}
}
pub fn resetTerminalAll() void {
if (enable_ansi_colors_stderr)
_ = source.error_stream.write("\x1B[2J\x1B[3J\x1B[H").unwrap() catch 0;
if (enable_ansi_colors_stdout)
_ = source.stream.write("\x1B[2J\x1B[3J\x1B[H").unwrap() catch 0;
}
/// Write buffered stdout & stderr to the terminal.
/// Must be called before the process exits or the buffered output will be lost.
/// Bun automatically calls this function in Global.exit().
pub fn flush() void {
if (Environment.isNative and source_set) {
source.buffered_stream.flush() catch {};
source.buffered_error_stream.flush() catch {};
// source.stream.flush() catch {};
// source.error_stream.flush() catch {};
}
}
pub const ElapsedFormatter = struct {
colors: bool,
duration_ns: u64 = 0,
pub fn format(self: ElapsedFormatter, comptime _: []const u8, _: std.fmt.FormatOptions, writer_: anytype) !void {
switch (self.duration_ns) {
0...std.time.ns_per_ms * 10 => {
const fmt_str = "<r><d>[{d:>.2}ms<r><d>]<r>";
switch (self.colors) {
inline else => |colors| try writer_.print(comptime prettyFmt(fmt_str, colors), .{@as(f64, @floatFromInt(self.duration_ns)) / std.time.ns_per_ms}),
}
},
std.time.ns_per_ms * 8_000...std.math.maxInt(u64) => {
const fmt_str = "<r><d>[<r><yellow>{d:>.2}ms<r><d>]<r>";
switch (self.colors) {
inline else => |colors| try writer_.print(comptime prettyFmt(fmt_str, colors), .{@as(f64, @floatFromInt(self.duration_ns)) / std.time.ns_per_ms}),
}
},
else => {
const fmt_str = "<r><d>[<b>{d:>.2}ms<r><d>]<r>";
switch (self.colors) {
inline else => |colors| try writer_.print(comptime prettyFmt(fmt_str, colors), .{@as(f64, @floatFromInt(self.duration_ns)) / std.time.ns_per_ms}),
}
},
}
}
};
inline fn printElapsedToWithCtx(elapsed: f64, comptime printerFn: anytype, comptime has_ctx: bool, ctx: anytype) void {
switch (@as(i64, @intFromFloat(@round(elapsed)))) {
0...1500 => {
const fmt = "<r><d>[<b>{d:>.2}ms<r><d>]<r>";
const args = .{elapsed};
if (comptime has_ctx) {
printerFn(ctx, fmt, args);
} else {
printerFn(fmt, args);
}
},
else => {
const fmt = "<r><d>[<b>{d:>.2}s<r><d>]<r>";
const args = .{elapsed / 1000.0};
if (comptime has_ctx) {
printerFn(ctx, fmt, args);
} else {
printerFn(fmt, args);
}
},
}
}
pub noinline fn printElapsedTo(elapsed: f64, comptime printerFn: anytype, ctx: anytype) void {
printElapsedToWithCtx(elapsed, printerFn, true, ctx);
}
pub fn printElapsed(elapsed: f64) void {
printElapsedToWithCtx(elapsed, prettyError, false, {});
}
pub fn printElapsedStdout(elapsed: f64) void {
printElapsedToWithCtx(elapsed, pretty, false, {});
}
pub fn printElapsedStdoutTrim(elapsed: f64) void {
switch (@as(i64, @intFromFloat(@round(elapsed)))) {
0...1500 => {
const fmt = "<r><d>[<b>{d:>}ms<r><d>]<r>";
const args = .{elapsed};
pretty(fmt, args);
},
else => {
const fmt = "<r><d>[<b>{d:>}s<r><d>]<r>";
const args = .{elapsed / 1000.0};
pretty(fmt, args);
},
}
}
pub fn printStartEnd(start: i128, end: i128) void {
const elapsed = @divTrunc(@as(i64, @truncate(end - start)), @as(i64, std.time.ns_per_ms));
printElapsed(@as(f64, @floatFromInt(elapsed)));
}
pub fn printStartEndStdout(start: i128, end: i128) void {
const elapsed = @divTrunc(@as(i64, @truncate(end - start)), @as(i64, std.time.ns_per_ms));
printElapsedStdout(@as(f64, @floatFromInt(elapsed)));
}
pub fn printTimer(timer: *SystemTimer) void {
if (comptime Environment.isWasm) return;
const elapsed = @divTrunc(timer.read(), @as(u64, std.time.ns_per_ms));
printElapsed(@as(f64, @floatFromInt(elapsed)));
}
pub noinline fn printErrorable(comptime fmt: string, args: anytype) !void {
if (comptime Environment.isWasm) {
try source.stream.seekTo(0);
try source.stream.writer().print(fmt, args);
root.console_error(root.Uint8Array.fromSlice(source.stream.buffer[0..source.stream.pos]));
} else {
std.fmt.format(source.stream.writer(), fmt, args) catch unreachable;
}
}
/// Print to stdout
/// This will appear in the terminal, including in production.
/// Text automatically buffers
pub noinline fn println(comptime fmt: string, args: anytype) void {
if (fmt.len == 0 or fmt[fmt.len - 1] != '\n') {
return print(fmt ++ "\n", args);
}
return print(fmt, args);
}
/// Print to stdout, but only in debug builds.
/// Text automatically buffers
pub fn debug(comptime fmt: string, args: anytype) void {
if (comptime Environment.isRelease) return;
prettyErrorln("<d>DEBUG:<r> " ++ fmt, args);
flush();
}
pub inline fn _debug(comptime fmt: string, args: anytype) void {
bun.debugAssert(source_set);
println(fmt, args);
}
// callconv is a workaround for a zig wasm bug?
pub noinline fn print(comptime fmt: string, args: anytype) callconv(std.builtin.CallingConvention.Unspecified) void {
if (comptime Environment.isWasm) {
source.stream.pos = 0;
std.fmt.format(source.stream.writer(), fmt, args) catch unreachable;
root.console_log(root.Uint8Array.fromSlice(source.stream.buffer[0..source.stream.pos]));
} else {
bun.debugAssert(source_set);
// There's not much we can do if this errors. Especially if it's something like BrokenPipe.
if (enable_buffering) {
std.fmt.format(source.buffered_stream.writer(), fmt, args) catch {};
} else {
std.fmt.format(writer(), fmt, args) catch {};
}
}
}
/// Debug-only logs which should not appear in release mode
/// To enable a specific log at runtime, set the environment variable
/// BUN_DEBUG_${TAG} to 1
/// For example, to enable the "foo" log, set the environment variable
/// BUN_DEBUG_foo=1
/// To enable all logs, set the environment variable
/// BUN_DEBUG_ALL=1
pub const LogFunction = fn (comptime fmt: string, args: anytype) callconv(bun.callconv_inline) void;
pub fn Scoped(comptime tag: anytype, comptime disabled: bool) type {
const tagname = comptime brk: {
const input = switch (@TypeOf(tag)) {
@Type(.EnumLiteral) => @tagName(tag),
else => tag,
};
var ascii_slice: [input.len]u8 = undefined;
for (input, &ascii_slice) |in, *out| {
out.* = std.ascii.toLower(in);
}
break :brk ascii_slice;
};
return ScopedLogger(&tagname, disabled);
}
fn ScopedLogger(comptime tagname: []const u8, comptime disabled: bool) type {
if (comptime !Environment.enable_logs) {
return struct {
pub inline fn isVisible() bool {
return false;
}
pub inline fn log(comptime _: string, _: anytype) void {}
};
}
return struct {
const BufferedWriter = std.io.BufferedWriter(4096, bun.sys.File.QuietWriter);
var buffered_writer: BufferedWriter = undefined;
var out: BufferedWriter.Writer = undefined;
var out_set = false;
var really_disable = disabled;
var evaluated_disable = false;
var lock = std.Thread.Mutex{};
pub fn isVisible() bool {
if (!evaluated_disable) {
evaluated_disable = true;
if (bun.getenvZAnyCase("BUN_DEBUG_" ++ tagname)) |val| {
really_disable = strings.eqlComptime(val, "0");
} else if (bun.getenvZAnyCase("BUN_DEBUG_ALL")) |val| {
really_disable = strings.eqlComptime(val, "0");
} else if (bun.getenvZAnyCase("BUN_DEBUG_QUIET_LOGS")) |val| {
really_disable = really_disable or !strings.eqlComptime(val, "0");
} else {
for (bun.argv) |arg| {
if (strings.eqlCaseInsensitiveASCII(arg, comptime "--debug-" ++ tagname, true)) {
really_disable = false;
break;
} else if (strings.eqlCaseInsensitiveASCII(arg, comptime "--debug-all", true)) {
really_disable = false;
break;
}
}
}
}
return !really_disable;
}
/// Debug-only logs which should not appear in release mode
/// To enable a specific log at runtime, set the environment variable
/// BUN_DEBUG_${TAG} to 1
/// For example, to enable the "foo" log, set the environment variable
/// BUN_DEBUG_foo=1
/// To enable all logs, set the environment variable
/// BUN_DEBUG_ALL=1
pub fn log(comptime fmt: string, args: anytype) void {
if (!source_set) return;
if (fmt.len == 0 or fmt[fmt.len - 1] != '\n') {
return log(fmt ++ "\n", args);
}
if (ScopedDebugWriter.disable_inside_log > 0) {
return;
}
if (Environment.enable_logs) ScopedDebugWriter.disable_inside_log += 1;
defer {
if (Environment.enable_logs)
ScopedDebugWriter.disable_inside_log -= 1;
}
if (!isVisible())
return;
if (!out_set) {
buffered_writer = .{
.unbuffered_writer = scopedWriter(),
};
out = buffered_writer.writer();
out_set = true;
}
lock.lock();
defer lock.unlock();
if (enable_ansi_colors_stdout and source_set and buffered_writer.unbuffered_writer.context.handle == writer().context.handle) {
out.print(comptime prettyFmt("<r><d>[" ++ tagname ++ "]<r> " ++ fmt, true), args) catch {
really_disable = true;
return;
};
buffered_writer.flush() catch {
really_disable = true;
return;
};
} else {
out.print(comptime prettyFmt("<r><d>[" ++ tagname ++ "]<r> " ++ fmt, false), args) catch {
really_disable = true;
return;
};
buffered_writer.flush() catch {
really_disable = true;
return;
};
}
}
};
}
pub fn scoped(comptime tag: anytype, comptime disabled: bool) LogFunction {
return Scoped(
tag,
disabled,
).log;
}
// Valid "colors":
// <black>
// <blue>
// <cyan>
// <green>
// <magenta>
// <red>
// <white>
// <yellow>
// <b> - bold
// <d> - dim
// </r> - reset
// <r> - reset
const ED = "\x1b[";
pub const color_map = ComptimeStringMap(string, .{
&.{ "black", ED ++ "30m" },
&.{ "blue", ED ++ "34m" },
&.{ "b", ED ++ "1m" },
&.{ "d", ED ++ "2m" },
&.{ "i", ED ++ "3m" },
&.{ "cyan", ED ++ "36m" },
&.{ "green", ED ++ "32m" },
&.{ "magenta", ED ++ "35m" },
&.{ "red", ED ++ "31m" },
&.{ "white", ED ++ "37m" },
&.{ "yellow", ED ++ "33m" },
});
const RESET: string = "\x1b[0m";
pub fn prettyFmt(comptime fmt: string, comptime is_enabled: bool) [:0]const u8 {
if (comptime bun.fast_debug_build_mode)
return fmt;
comptime var new_fmt: [fmt.len * 4]u8 = undefined;
comptime var new_fmt_i: usize = 0;
@setEvalBranchQuota(9999);
comptime var i: usize = 0;
comptime while (i < fmt.len) {
const c = fmt[i];
switch (c) {
'\\' => {
i += 1;
if (i < fmt.len) {
switch (fmt[i]) {
'<', '>' => {
new_fmt[new_fmt_i] = fmt[i];
new_fmt_i += 1;
i += 1;
},
else => {
new_fmt[new_fmt_i] = '\\';
new_fmt_i += 1;
new_fmt[new_fmt_i] = fmt[i];
new_fmt_i += 1;
i += 1;
},
}
}
},
'>' => {
i += 1;
},
'{' => {
while (fmt.len > i and fmt[i] != '}') {
new_fmt[new_fmt_i] = fmt[i];
new_fmt_i += 1;
i += 1;
}
},
'<' => {
i += 1;
var is_reset = fmt[i] == '/';
if (is_reset) i += 1;
const start: usize = i;
while (i < fmt.len and fmt[i] != '>') {
i += 1;
}
const color_name = fmt[start..i];
const color_str = color_picker: {
if (color_map.get(color_name)) |color_name_literal| {
break :color_picker color_name_literal;
} else if (std.mem.eql(u8, color_name, "r")) {
is_reset = true;
break :color_picker "";
} else {
@compileError("Invalid color name passed: " ++ color_name);
}
};
if (is_enabled) {
for (if (is_reset) RESET else color_str) |ch| {
new_fmt[new_fmt_i] = ch;
new_fmt_i += 1;
}
}
},
else => {
new_fmt[new_fmt_i] = fmt[i];
new_fmt_i += 1;
i += 1;
},
}
};
return comptime (new_fmt[0..new_fmt_i].* ++ .{0})[0..new_fmt_i :0];
}
pub noinline fn prettyWithPrinter(comptime fmt: string, args: anytype, comptime printer: anytype, comptime l: Destination) void {
if (if (comptime l == .stdout) enable_ansi_colors_stdout else enable_ansi_colors_stderr) {
printer(comptime prettyFmt(fmt, true), args);
} else {
printer(comptime prettyFmt(fmt, false), args);
}
}
pub noinline fn prettyWithPrinterFn(comptime fmt: string, args: anytype, comptime printFn: anytype, ctx: anytype) void {
if (comptime bun.fast_debug_build_mode)
return printFn(ctx, comptime prettyFmt(fmt, false), args);
if (enable_ansi_colors) {
printFn(ctx, comptime prettyFmt(fmt, true), args);
} else {
printFn(ctx, comptime prettyFmt(fmt, false), args);
}
}
pub noinline fn pretty(comptime fmt: string, args: anytype) void {
prettyWithPrinter(fmt, args, print, .stdout);
}
/// Like Output.println, except it will automatically strip ansi color codes if
/// the terminal doesn't support them.
pub fn prettyln(comptime fmt: string, args: anytype) void {
prettyWithPrinter(fmt, args, println, .stdout);
}
pub noinline fn printErrorln(comptime fmt: string, args: anytype) void {
if (fmt.len == 0 or fmt[fmt.len - 1] != '\n') {
return printError(fmt ++ "\n", args);
}
return printError(fmt, args);
}
pub noinline fn prettyError(comptime fmt: string, args: anytype) void {
prettyWithPrinter(fmt, args, printError, .stderr);
}
/// Print to stderr with ansi color codes automatically stripped out if the
/// terminal doesn't support them. Text is buffered
pub fn prettyErrorln(comptime fmt: string, args: anytype) void {
prettyWithPrinter(fmt, args, printErrorln, .stderr);
}
pub const Destination = enum(u8) {
stderr,
stdout,
};