forked from tigerbeetle/tigerbeetle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs_generate.zig
962 lines (837 loc) · 31.8 KB
/
docs_generate.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
const builtin = @import("builtin");
const std = @import("std");
const Docs = @import("./docs_types.zig").Docs;
const go = @import("./go/docs.zig").GoDocs;
const node = @import("./node/docs.zig").NodeDocs;
const java = @import("./java/docs.zig").JavaDocs;
const languages = [_]Docs{ go, node, java };
const MarkdownWriter = struct {
buf: *std.ArrayList(u8),
writer: std.ArrayList(u8).Writer,
fn init(buf: *std.ArrayList(u8)) MarkdownWriter {
return MarkdownWriter{
.buf = buf,
.writer = buf.writer(),
};
}
fn header(
mw: *MarkdownWriter,
comptime n: i8,
content: []const u8,
) void {
mw.print(("#" ** n) ++ " {s}\n\n", .{content});
}
fn paragraph(mw: *MarkdownWriter, content: []const u8) void {
// Don't print empty lines.
if (content.len == 0) {
return;
}
mw.print("{s}\n\n", .{content});
}
fn code(
mw: *MarkdownWriter,
language: []const u8,
content: []const u8,
) void {
// Don't print empty lines.
if (content.len == 0) {
return;
}
mw.print("```{s}\n{s}\n```\n\n", .{ language, content });
}
fn commands(mw: *MarkdownWriter, content: []const u8) void {
mw.print("```console\n", .{});
var splits = std.mem.split(u8, content, "\n");
while (splits.next()) |chunk| {
mw.print("$ {s}\n", .{chunk});
}
mw.print("```\n\n", .{});
}
fn print(
mw: *MarkdownWriter,
comptime fmt: []const u8,
args: anytype,
) void {
mw.writer.print(fmt, args) catch unreachable;
}
fn reset(mw: *MarkdownWriter) void {
mw.buf.clearRetainingCapacity();
}
fn diffOnDisk(mw: *MarkdownWriter, filename: []const u8) !bool {
const file = try std.fs.cwd().createFile(
filename,
.{ .read = true, .truncate = false },
);
const fSize = (try file.stat()).size;
if (fSize != mw.buf.items.len) {
return true;
}
var buf = std.mem.zeroes([4096]u8);
var cursor: usize = 0;
while (cursor < fSize) {
var maxCanRead = if (fSize - cursor > 4096) 4096 else fSize - cursor;
// Phil: Sometimes this infinite loops and returns `0` but
// I don't know why. Allowing it to just overwrite solves the problem.
var n = try file.read(buf[0..maxCanRead]);
if (n == 0 and maxCanRead != n) {
return true;
}
if (std.mem.eql(u8, buf[0..], mw.buf.items[cursor..n])) {
return false;
}
}
return true;
}
// save() only actually writes the buffer to disk if it has
// changed compared to what's on disk, so that file modify time stays
// reasonable.
fn save(mw: *MarkdownWriter, filename: []const u8) !void {
var diff = try mw.diffOnDisk(filename);
if (!diff) {
return;
}
const file = try std.fs.cwd().openFile(
filename,
.{ .write = true },
);
defer file.close();
// First truncate(0) the file.
try file.setEndPos(0);
// Then write what we need.
try file.writeAll(mw.buf.items);
}
};
pub fn exec(
arena: *std.heap.ArenaAllocator,
cmd: []const []const u8,
) !std.ChildProcess.ExecResult {
var res = try std.ChildProcess.exec(.{
.allocator = arena.allocator(),
.argv = cmd,
});
switch (res.term) {
.Exited => |code| {
if (code != 0) {
return error.ExecCommandFailed;
}
},
else => return error.UnknownCase,
}
return res;
}
pub fn run_with_env(
arena: *std.heap.ArenaAllocator,
cmd: []const []const u8,
env: []const []const u8,
) !void {
std.debug.print("Running:", .{});
var i: u32 = 0;
while (i < env.len) : (i += 2) {
std.debug.print(" {s}={s}", .{ env[i], env[i + 1] });
}
for (cmd) |c| {
std.debug.print(" {s}", .{c});
}
std.debug.print("\n", .{});
var cp = try std.ChildProcess.init(cmd, arena.allocator());
var env_map = try std.process.getEnvMap(arena.allocator());
i = 0;
while (i < env.len) : (i += 2) {
try env_map.put(env[i], env[i + 1]);
}
cp.env_map = &env_map;
var res = try cp.spawnAndWait();
switch (res) {
.Exited => |code| {
if (code != 0) {
return error.RunCommandFailed;
}
},
else => return error.UnknownCase,
}
}
pub fn run(
arena: *std.heap.ArenaAllocator,
cmd: []const []const u8,
) !void {
try run_with_env(arena, cmd, &.{});
}
pub const TmpDir = struct {
dir: std.testing.TmpDir,
path: []const u8,
pub fn init(arena: *std.heap.ArenaAllocator) !TmpDir {
var tmp_dir = std.testing.tmpDir(.{});
return TmpDir{
.dir = tmp_dir,
.path = try tmp_dir.dir.realpathAlloc(arena.allocator(), "."),
};
}
pub fn deinit(self: *TmpDir) void {
self.dir.cleanup();
}
};
pub fn git_root(arena: *std.heap.ArenaAllocator) ![]const u8 {
var prefix: []const u8 = "";
var tries: i32 = 0;
while (tries < 100) {
var dir = std.fs.cwd().openDir(
try std.fmt.allocPrint(
arena.allocator(),
"{s}.git",
.{prefix},
),
.{},
) catch {
prefix = try std.fmt.allocPrint(
arena.allocator(),
"../{s}",
.{prefix},
);
tries += 1;
continue;
};
// When looking up realpathAlloc, it can't be an empty string.
if (prefix.len == 0) {
prefix = ".";
}
const path = try std.fs.cwd().realpathAlloc(arena.allocator(), prefix);
dir.close();
return path;
}
std.debug.print("Failed to find .git root of TigerBeetle repo.\n", .{});
return error.CouldNotFindGitRoot;
}
const Generator = struct {
arena: *std.heap.ArenaAllocator,
language: Docs,
test_file_name: []const u8,
const DockerCommand = struct {
cmds: []const u8,
mount: ?[][]const u8,
env: ?[][]const u8,
};
const docker_mount_path = "/tmp/wrk";
fn init(
arena: *std.heap.ArenaAllocator,
language: Docs,
) !Generator {
var test_file_name = language.test_file_name;
if (test_file_name.len == 0) {
test_file_name = "test";
}
return Generator{
.arena = arena,
.language = language,
.test_file_name = test_file_name,
};
}
fn run_in_docker(self: Generator, cmd: DockerCommand) !void {
self.printf(
"Running command in Docker: {s}",
.{cmd.cmds},
);
var full_cmd = std.ArrayList([]const u8).init(self.arena.allocator());
defer full_cmd.deinit();
try full_cmd.appendSlice(&[_][]const u8{
"docker",
"run",
});
if (cmd.mount) |mounts| {
for (mounts) |entry| {
try full_cmd.append("-v");
try full_cmd.append(entry);
}
}
if (cmd.env) |envs| {
for (envs) |entry| {
try full_cmd.append("-e");
try full_cmd.append(entry);
}
}
try full_cmd.appendSlice(&[_][]const u8{
self.language.test_linux_docker_image,
"sh",
"-c",
cmd.cmds,
});
try run(self.arena, full_cmd.items);
}
fn ensure_path(self: Generator, path: []const u8) !void {
self.printf(
"[Debug] Ensuring path: {s}",
.{path},
);
var dir = try std.fs.openDirAbsolute("/", .{});
defer dir.close();
try dir.makePath(path);
}
fn run_with_file_in_docker(
self: Generator,
tmp_dir: TmpDir,
file: []const u8,
file_name: ?[]const u8,
cmd: DockerCommand,
) !void {
var tmp_file_name = self.sprintf(
"{s}/{s}{s}.{s}",
.{
tmp_dir.path,
self.language.test_source_path,
self.test_file_name,
self.language.extension,
},
);
if (file_name) |name| {
tmp_file_name = self.sprintf(
"{s}/{s}",
.{ tmp_dir.path, name },
);
}
try self.ensure_path(std.fs.path.dirname(tmp_file_name).?);
self.printf(
"Mounting in file ({s}):\n```\n{s}\n```",
.{ tmp_file_name, file },
);
var tmp_file = try std.fs.cwd().createFile(tmp_file_name, .{
.truncate = true,
});
defer tmp_file.close();
_ = try tmp_file.write(file);
var full_cmd = std.ArrayList(u8).init(self.arena.allocator());
defer full_cmd.deinit();
try full_cmd.writer().print(
"cd {s} && apk add -U build-base git xz",
.{docker_mount_path},
);
if (self.language.install_prereqs.len > 0) {
try full_cmd.writer().print(
" && {s}",
.{self.language.install_prereqs},
);
}
try full_cmd.writer().print(" && {s}", .{cmd.cmds});
var mount = std.ArrayList([]const u8).init(self.arena.allocator());
defer mount.deinit();
if (cmd.mount) |m| {
try mount.appendSlice(m);
}
try mount.append(self.sprintf(
"{s}:{s}",
.{ tmp_dir.path, docker_mount_path },
));
try self.run_in_docker(
.{
.cmds = full_cmd.items,
.mount = mount.items,
.env = cmd.env,
},
);
}
fn get_current_commit_and_repo_env(self: Generator) !std.ArrayList([]const u8) {
var env = std.ArrayList([]const u8).init(self.arena.allocator());
for (&[_][]const u8{
"GIT_SHA",
// TODO: this won't run correctly on forks that are testing
// *locally*. But it will run correctly for forks being tested in
// Github Actions.
// Could fix it by parsing `git remote -v` or something.
"GITHUB_REPOSITORY",
}) |env_var_name| {
if (std.os.getenv(env_var_name)) |value| {
try env.append(self.sprintf(
"{s}={s}",
.{
env_var_name,
value,
},
));
}
}
// GIT_SHA is correct in CI but locally it won't exist. So
// if we're local (GIT_SHA isn't set) then grab the current
// commit. The current commit isn't correct in CI because CI
// is run against pseudo/temporary branches.
if (env.items.len == 0 or !std.mem.startsWith(u8, env.items[0], "GIT_SHA=")) {
var cp = try exec(self.arena, &[_][]const u8{ "git", "rev-parse", "HEAD" });
try env.append(self.sprintf(
"GIT_SHA={s}",
.{cp.stdout},
));
}
return env;
}
fn write_shell_newlines_into_single_line(into: *std.ArrayList(u8), from: []const u8) !void {
if (from.len == 0) {
return;
}
var lines = std.mem.split(u8, from, "\n");
while (lines.next()) |line| {
try into.writer().print("{s} && ", .{line});
}
}
fn build_file_in_docker(self: Generator, tmp_dir: TmpDir, file: []const u8, run_setup_tests: bool) !void {
// Some languages (Java) have an additional project file
// (pom.xml) they need to have available.
if (self.language.project_file.len > 0) {
const project_file = try std.fs.cwd().createFile(
self.sprintf(
"{s}/{s}",
.{ tmp_dir.path, self.language.project_file_name },
),
.{ .truncate = true },
);
defer project_file.close();
_ = try project_file.write(self.language.project_file);
}
var env = try self.get_current_commit_and_repo_env();
defer env.deinit();
var cmd = std.ArrayList(u8).init(self.arena.allocator());
defer cmd.deinit();
// Build against current commit and set up project to use current build.
if (run_setup_tests) {
try cmd.appendSlice("export TEST=true && set -x && ");
}
// Join together various setup commands that are shown to the
// user (and not) into a single command we can run in Docker.
try cmd.appendSlice(" ( ");
try write_shell_newlines_into_single_line(
&cmd,
self.language.developer_setup_sh_commands,
);
try write_shell_newlines_into_single_line(
&cmd,
self.language.current_commit_pre_install_commands,
);
// The above commands all end with ` && `
try cmd.appendSlice("echo ok ) && "); // Setup commands within parens ( ) so that cwd doesn't change outside
try write_shell_newlines_into_single_line(
&cmd,
self.language.install_commands,
);
try write_shell_newlines_into_single_line(
&cmd,
self.language.current_commit_post_install_commands,
);
try write_shell_newlines_into_single_line(
&cmd,
self.language.install_sample_file_build_commands,
);
// The above commands all end with ` && `
try cmd.appendSlice("echo ok");
try self.run_with_file_in_docker(
tmp_dir,
file,
null,
.{
.cmds = cmd.items,
.mount = null,
.env = env.items,
},
);
}
fn print(self: Generator, msg: []const u8) void {
std.debug.print("[{s}] {s}\n", .{
self.language.markdown_name,
msg,
});
}
fn printf(self: Generator, comptime msg: []const u8, obj: anytype) void {
self.print(self.sprintf(msg, obj));
}
fn sprintf(self: Generator, comptime msg: []const u8, obj: anytype) []const u8 {
return std.fmt.allocPrint(
self.arena.allocator(),
msg,
obj,
) catch unreachable;
}
fn validateMinimal(self: Generator) !void {
// Test the sample file
self.print("Building minimal sample file");
var tmp_dir = try TmpDir.init(self.arena);
defer tmp_dir.deinit();
try self.build_file_in_docker(tmp_dir, self.language.install_sample_file, true);
}
fn validateAggregate(self: Generator) !void {
// Test major parts of sample code
var sample = try self.make_aggregate_sample();
self.print("Building aggregate sample file");
var tmp_dir = try TmpDir.init(self.arena);
defer tmp_dir.deinit();
try self.build_file_in_docker(tmp_dir, sample, false);
}
const tests = [_]struct {
name: []const u8,
validate: fn (Generator) anyerror!void,
}{
.{
.name = "minimal",
.validate = validateMinimal,
},
.{
.name = "aggregate",
.validate = validateAggregate,
},
};
// This will not include every snippet but it includes as much as //
// reasonable. Both so we can type-check as much as possible and also so
// we can produce a building sample file for READMEs.
fn make_aggregate_sample(self: Generator) ![]const u8 {
var parts = [_][]const u8{
self.language.test_main_prefix,
self.language.client_object_example,
self.language.create_accounts_example,
self.language.account_flags_example,
self.language.create_accounts_errors_example,
self.language.lookup_accounts_example,
self.language.create_transfers_example,
self.language.create_transfers_errors_example,
self.language.transfer_flags_link_example,
self.language.transfer_flags_post_example,
self.language.transfer_flags_void_example,
self.language.lookup_transfers_example,
self.language.linked_events_example,
self.language.test_main_suffix,
};
var aggregate = std.ArrayList(u8).init(self.arena.allocator());
for (parts) |part| {
try aggregate.writer().print("{s}\n", .{part});
}
return aggregate.items;
}
fn generate(self: Generator, mw: *MarkdownWriter) !void {
var language = self.language;
mw.print(
\\---
\\title: {s}
\\---
\\
\\This file is generated by
\\[src/clients/docs_generate.zig](/src/clients/docs_generate.zig).
\\
, .{language.proper_name});
mw.header(1, language.name);
mw.paragraph(language.description);
mw.header(3, "Prerequisites");
const windowsSupported: []const u8 = if (language.developer_setup_pwsh_commands.len > 0)
" and Windows"
else
"";
mw.print(
\\Linux >= 5.6 is the only production environment we
\\support. But for ease of development we also support macOS{s}.
\\
, .{windowsSupported});
mw.paragraph(language.prerequisites);
mw.header(2, "Setup");
if (language.project_file.len > 0) {
mw.print(
"First, create `{s}` and copy this into it:\n\n",
.{language.project_file_name},
);
mw.code(language.markdown_name, language.project_file);
}
mw.paragraph("Run:");
mw.commands(language.install_commands);
mw.print("Now, create `{s}{s}.{s}` and copy this into it:\n\n", .{
self.language.test_source_path,
self.test_file_name,
language.extension,
});
mw.code(language.markdown_name, language.install_sample_file);
mw.paragraph("Finally, build and run:");
mw.commands(language.install_sample_file_test_commands);
mw.paragraph(
\\Now that all prerequisites and dependencies are correctly set
\\up, let's dig into using TigerBeetle.
,
);
mw.paragraph(language.install_documentation);
mw.header(2, "Example projects");
mw.paragraph(
\\This document is primarily a reference guide to
\\the client. Below are various sample projects demonstrating
\\features of TigerBeetle.
,
);
const language_path = std.mem.split(u8, language.readme, "/").next();
// Absolute paths here are necessary for resolving within the docs site.
mw.print(
\\* [Basic](/src/clients/{s}/samples/basic/): Create two accounts and
\\ transfer an amount between them.
\\* [Two-Phase Transfer](/src/clients/{s}/samples/two-phase/): Create two
\\ accounts and start a pending transfer between them, then
\\ post the transfer.
\\
,
.{ language_path, language_path },
);
if (language.examples.len != 0) {
mw.paragraph(language.examples);
}
mw.header(2, "Creating a Client");
mw.paragraph(
\\A client is created with a cluster ID and replica
\\addresses for all replicas in the cluster. The cluster
\\ID and replica addresses are both chosen by the system that
\\starts the TigerBeetle cluster.
\\
\\Clients are thread-safe. But for better
\\performance, a single instance should be shared between
\\multiple concurrent tasks.
\\
\\Multiple clients are useful when connecting to more than
\\one TigerBeetle cluster.
\\
\\In this example the cluster ID is `0` and there are
\\three replicas running on ports `3001`, `3002`, and
\\`3003`.
);
mw.code(language.markdown_name, language.client_object_example);
mw.paragraph(language.client_object_documentation);
mw.paragraph(
\\The following are valid addresses:
\\* `3000` (interpreted as `127.0.0.1:3000`)
\\* `127.0.0.1:3000` (interpreted as `127.0.0.1:3000`)
\\* `127.0.0.1` (interpreted as `127.0.0.1:3001`, `3001` is the default port)
);
mw.header(2, "Creating Accounts");
mw.paragraph(
\\See details for account fields in the [Accounts
\\reference](https://docs.tigerbeetle.com/reference/accounts).
);
mw.code(language.markdown_name, language.create_accounts_example);
mw.paragraph(language.create_accounts_documentation);
mw.header(3, "Account Flags");
mw.paragraph(
\\The account flags value is a bitfield. See details for
\\these flags in the [Accounts
\\reference](https://docs.tigerbeetle.com/reference/accounts#flags).
);
mw.paragraph(language.account_flags_documentation);
mw.paragraph(
\\For example, to link two accounts where the first account
\\additionally has the `debits_must_not_exceed_credits` constraint:
);
mw.code(language.markdown_name, language.account_flags_example);
mw.header(3, "Response and Errors");
mw.paragraph(
\\The response is an empty array if all accounts were
\\created successfully. If the response is non-empty, each
\\object in the response array contains error information
\\for an account that failed. The error object contains an
\\error code and the index of the account in the request
\\batch.
\\
\\See all error conditions in the [create_accounts
\\reference](https://docs.tigerbeetle.com/reference/operations/create_accounts).
);
mw.code(language.markdown_name, language.create_accounts_errors_example);
mw.paragraph(language.create_accounts_errors_documentation);
mw.header(2, "Account Lookup");
mw.paragraph(
\\Account lookup is batched, like account creation. Pass
\\in all IDs to fetch. The account for each matched ID is returned.
\\
\\If no account matches an ID, no object is returned for
\\that account. So the order of accounts in the response is
\\not necessarily the same as the order of IDs in the
\\request. You can refer to the ID field in the response to
\\distinguish accounts.
);
mw.code(language.markdown_name, language.lookup_accounts_example);
mw.header(2, "Create Transfers");
mw.paragraph(
\\This creates a journal entry between two accounts.
\\
\\See details for transfer fields in the [Transfers
\\reference](https://docs.tigerbeetle.com/reference/transfers).
);
mw.code(language.markdown_name, language.create_transfers_example);
mw.header(3, "Response and Errors");
mw.paragraph(
\\The response is an empty array if all transfers were created
\\successfully. If the response is non-empty, each object in the
\\response array contains error information for an transfer that
\\failed. The error object contains an error code and the index of the
\\transfer in the request batch.
\\
\\See all error conditions in the [create_transfers
\\reference](https://docs.tigerbeetle.com/reference/operations/create_transfers).
);
mw.code(language.markdown_name, language.create_transfers_errors_example);
mw.paragraph(language.create_transfers_errors_documentation);
mw.header(2, "Batching");
mw.paragraph(
\\TigerBeetle performance is maximized when you batch
\\API requests. The client does not do this automatically for
\\you. So, for example, you *can* insert 1 million transfers
\\one at a time like so:
);
mw.code(language.markdown_name, language.no_batch_example);
mw.paragraph(
\\But the insert rate will be a *fraction* of
\\potential. Instead, **always batch what you can**.
\\
\\The maximum batch size is set in the TigerBeetle server. The default
\\is 8191.
);
mw.code(language.markdown_name, language.batch_example);
mw.header(3, "Queues and Workers");
mw.paragraph(
\\If you are making requests to TigerBeetle from workers
\\pulling jobs from a queue, you can batch requests to
\\TigerBeetle by having the worker act on multiple jobs from
\\the queue at once rather than one at a time. i.e. pulling
\\multiple jobs from the queue rather than just one.
);
mw.header(2, "Transfer Flags");
mw.paragraph(
\\The transfer `flags` value is a bitfield. See details for these flags in
\\the [Transfers
\\reference](https://docs.tigerbeetle.com/reference/transfers#flags).
);
mw.paragraph(language.transfer_flags_documentation);
mw.paragraph("For example, to link `transfer0` and `transfer1`:");
mw.code(language.markdown_name, language.transfer_flags_link_example);
mw.header(3, "Two-Phase Transfers");
mw.paragraph(
\\Two-phase transfers are supported natively by toggling the appropriate
\\flag. TigerBeetle will then adjust the `credits_pending` and
\\`debits_pending` fields of the appropriate accounts. A corresponding
\\post pending transfer then needs to be sent to post or void the
\\transfer.
);
mw.header(4, "Post a Pending Transfer");
mw.paragraph(
\\With `flags` set to `post_pending_transfer`,
\\TigerBeetle will post the transfer. TigerBeetle will atomically roll
\\back the changes to `debits_pending` and `credits_pending` of the
\\appropriate accounts and apply them to the `debits_posted` and
\\`credits_posted` balances.
);
mw.code(language.markdown_name, language.transfer_flags_post_example);
mw.header(4, "Void a Pending Transfer");
mw.paragraph(
\\In contrast, with `flags` set to `void_pending_transfer`,
\\TigerBeetle will void the transfer. TigerBeetle will roll
\\back the changes to `debits_pending` and `credits_pending` of the
\\appropriate accounts and **not** apply them to the `debits_posted` and
\\`credits_posted` balances.
);
mw.code(language.markdown_name, language.transfer_flags_void_example);
mw.header(2, "Transfer Lookup");
mw.paragraph(
\\NOTE: While transfer lookup exists, it is not a flexible query API. We
\\are developing query APIs and there will be new methods for querying
\\transfers in the future.
\\
\\Transfer lookup is batched, like transfer creation. Pass in all `id`s to
\\fetch, and matched transfers are returned.
\\
\\If no transfer matches an `id`, no object is returned for that
\\transfer. So the order of transfers in the response is not necessarily
\\the same as the order of `id`s in the request. You can refer to the
\\`id` field in the response to distinguish transfers.
);
mw.code(language.markdown_name, language.lookup_transfers_example);
mw.header(2, "Linked Events");
mw.paragraph(
\\When the `linked` flag is specified for an account when creating accounts or
\\a transfer when creating transfers, it links that event with the next event in the
\\batch, to create a chain of events, of arbitrary length, which all
\\succeed or fail together. The tail of a chain is denoted by the first
\\event without this flag. The last event in a batch may therefore never
\\have the `linked` flag set as this would leave a chain
\\open-ended. Multiple chains or individual events may coexist within a
\\batch to succeed or fail independently.
\\
\\Events within a chain are executed within order, or are rolled back on
\\error, so that the effect of each event in the chain is visible to the
\\next, and so that the chain is either visible or invisible as a unit
\\to subsequent events after the chain. The event that was the first to
\\break the chain will have a unique error result. Other events in the
\\chain will have their error result set to `linked_event_failed`.
);
mw.code(language.markdown_name, language.linked_events_example);
mw.header(2, "Development Setup");
// Shell setup
mw.header(3, "On Linux and macOS");
mw.paragraph("In a POSIX shell run:");
mw.commands(language.developer_setup_sh_commands);
// Windows setup
mw.header(3, "On Windows");
if (language.developer_setup_pwsh_commands.len > 0) {
mw.paragraph("In PowerShell run:");
mw.commands(language.developer_setup_pwsh_commands);
} else {
mw.paragraph("Not yet supported.");
}
try mw.save(language.readme);
}
};
pub fn main() !void {
var args = std.process.args();
var skipLanguage = [_]bool{false} ** languages.len;
var validate = true;
var generate = true;
var validateOnly: []const u8 = "";
while (args.nextPosix()) |arg| {
if (std.mem.eql(u8, arg, "--language")) {
var filter = args.nextPosix().?;
skipLanguage = [_]bool{true} ** languages.len;
for (languages) |language, i| {
if (std.mem.eql(u8, filter, language.markdown_name)) {
skipLanguage[i] = false;
}
}
}
if (std.mem.eql(u8, arg, "--validate")) {
validateOnly = args.nextPosix().?;
}
if (std.mem.eql(u8, arg, "--no-validate")) {
validate = false;
}
if (std.mem.eql(u8, arg, "--no-generate")) {
generate = false;
}
}
for (languages) |language, i| {
if (skipLanguage[i]) {
continue;
}
var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
defer arena.deinit();
const allocator = arena.allocator();
var buf = std.ArrayList(u8).init(allocator);
var mw = MarkdownWriter.init(&buf);
var generator = try Generator.init(&arena, language);
if (validate) {
generator.print("Validating");
for (Generator.tests) |t| {
var found = false;
if (validateOnly.len > 0) {
var parts = std.mem.split(u8, validateOnly, ",");
while (parts.next()) |name| {
if (std.mem.eql(u8, name, t.name)) {
found = true;
break;
}
}
if (!found) {
generator.printf(
"Skipping test [{s}]",
.{t.name},
);
continue;
}
}
try t.validate(generator);
}
}
if (generate) {
generator.print("Generating");
try generator.generate(&mw);
}
}
}