forked from openclaw/openclaw
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbench-gateway-startup.ts
More file actions
1026 lines (964 loc) · 30.1 KB
/
Copy pathbench-gateway-startup.ts
File metadata and controls
1026 lines (964 loc) · 30.1 KB
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
// Bench Gateway Startup script supports OpenClaw repository automation.
import { spawn } from "node:child_process";
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import path from "node:path";
import { performance } from "node:perf_hooks";
import { pathToFileURL } from "node:url";
import { parseStrictIntegerOption } from "./lib/dev-tooling-safety.ts";
import { delay, stopChild } from "./lib/gateway-bench-child.ts";
import {
getFreePort,
parseProcessRssKb,
readProcessRssMb,
readProcessTreeCpuMs,
requestProbeStatus,
} from "./lib/gateway-bench-probes.ts";
type GatewayBenchCase = {
config: Record<string, unknown>;
env?: Record<string, string>;
id: string;
name: string;
pluginActivationOnStartup?: boolean;
pluginCount?: number;
};
type ProbeResult = {
firstErrorKind: string | null;
firstRecoveryMs: number | null;
ms: number | null;
status: number | null;
transitions: ProbeTransition[];
};
type ProbeTransition = {
errorKind?: string;
ms: number;
status: number | null;
};
type GatewaySample = {
cpuCoreRatio: number | null;
cpuMs: number | null;
exitedBeforeTeardown?: boolean;
exitCode: number | null;
firstOutputMs: number | null;
gatewayReadyLogLine: string | null;
gatewayReadyLogMs: number | null;
healthz: ProbeResult;
httpListenLogLine: string | null;
httpListenLogMs: number | null;
maxRssMb: number | null;
outputTail: string;
readyz: ProbeResult;
signal: string | null;
startupTrace: Record<string, number>;
};
type SummaryStats = {
avg: number;
max: number;
min: number;
p50: number;
p95: number;
};
type CaseResult = {
id: string;
name: string;
samples: GatewaySample[];
summary: {
firstOutputMs: SummaryStats | null;
cpuCoreRatio: SummaryStats | null;
cpuMs: SummaryStats | null;
gatewayReadyLogMs: SummaryStats | null;
healthzMs: SummaryStats | null;
httpListenLogMs: SummaryStats | null;
maxRssMb: SummaryStats | null;
readyzMs: SummaryStats | null;
startupTrace: Record<string, SummaryStats>;
};
};
type BenchmarkFailure = {
id: string;
reason: string;
sampleIndex: number;
};
type PluginFixtureResult = {
pluginIds: string[];
pluginsDir: string;
};
type CliOptions = {
cases: GatewayBenchCase[];
cpuProfDir?: string;
entry: string;
json: boolean;
output?: string;
runs: number;
timeoutMs: number;
warmup: number;
};
const DEFAULT_RUNS = 5;
const DEFAULT_WARMUP = 1;
const DEFAULT_TIMEOUT_MS = 30_000;
const DEFAULT_ENTRY = "dist/entry.js";
const BOOLEAN_FLAGS = new Set(["--help", "-h", "--json"]);
const VALUE_FLAGS = new Set([
"--case",
"--cpu-prof-dir",
"--entry",
"--output",
"--runs",
"--timeout-ms",
"--warmup",
]);
class CliArgumentError extends Error {
override name = "CliArgumentError";
}
const BASE_CONFIG = {
browser: { enabled: false },
gateway: {
mode: "local",
bind: "loopback",
auth: { mode: "none" },
controlUi: { enabled: false },
tailscale: { mode: "off" },
},
plugins: {
enabled: true,
entries: {
browser: { enabled: false },
},
},
} satisfies Record<string, unknown>;
const GATEWAY_CASES: readonly GatewayBenchCase[] = [
{
id: "default",
name: "gateway default",
config: BASE_CONFIG,
},
{
id: "skipChannels",
name: "gateway, skip channels",
env: { OPENCLAW_SKIP_CHANNELS: "1" },
config: BASE_CONFIG,
},
{
id: "oneInternalHook",
name: "gateway, one configured internal hook",
env: { OPENCLAW_SKIP_CHANNELS: "1" },
config: {
...BASE_CONFIG,
hooks: {
internal: {
entries: {
"session-memory": { enabled: true },
},
},
},
},
},
{
id: "allInternalHooks",
name: "gateway, all internal hooks",
env: { OPENCLAW_SKIP_CHANNELS: "1" },
config: {
...BASE_CONFIG,
hooks: {
internal: {
enabled: true,
},
},
},
},
{
id: "fiftyPlugins",
name: "gateway, 50 manifest plugins",
env: { OPENCLAW_SKIP_CHANNELS: "1" },
pluginActivationOnStartup: true,
pluginCount: 50,
config: BASE_CONFIG,
},
{
id: "fiftyStartupLazyPlugins",
name: "gateway, 50 startup-lazy manifest plugins",
env: { OPENCLAW_SKIP_CHANNELS: "1" },
pluginActivationOnStartup: false,
pluginCount: 50,
config: BASE_CONFIG,
},
] as const;
function readRequiredFlagValue(argv: string[], index: number, flag: string): string {
const value = argv[index + 1];
if (!value || value.startsWith("-")) {
throw new CliArgumentError(`${flag} requires a value`);
}
return value;
}
function validateCliArgs(argv: string[]): void {
const seenSingleValueFlags = new Set<string>();
for (let index = 0; index < argv.length; index += 1) {
const arg = argv[index] ?? "";
if (BOOLEAN_FLAGS.has(arg)) {
continue;
}
if (VALUE_FLAGS.has(arg)) {
if (arg !== "--case") {
if (seenSingleValueFlags.has(arg)) {
throw new CliArgumentError(`${arg} was provided more than once`);
}
seenSingleValueFlags.add(arg);
}
readRequiredFlagValue(argv, index, arg);
index += 1;
continue;
}
throw new CliArgumentError(`Unknown argument: ${arg}`);
}
}
function parseFlagValue(argv: string[], flag: string): string | undefined {
for (let index = 0; index < argv.length; index += 1) {
if (argv[index] === flag) {
return readRequiredFlagValue(argv, index, flag);
}
}
return undefined;
}
function hasFlag(argv: string[], flag: string): boolean {
return argv.includes(flag);
}
function hasHelpFlag(argv: string[]): boolean {
return hasFlag(argv, "--help") || hasFlag(argv, "-h");
}
function parseRepeatableFlag(argv: string[], flag: string): string[] {
const values: string[] = [];
for (let index = 0; index < argv.length; index += 1) {
if (argv[index] === flag) {
values.push(readRequiredFlagValue(argv, index, flag));
index += 1;
}
}
return values;
}
function parsePositiveInt(raw: string | undefined, fallback: number, label: string): number {
return parseStrictIntegerOption({ fallback, label, min: 1, raw });
}
function parseNonNegativeInt(raw: string | undefined, fallback: number, label: string): number {
return parseStrictIntegerOption({ fallback, label, min: 0, raw });
}
function resolveEntry(raw: string | undefined): string {
const entry = raw?.trim() || DEFAULT_ENTRY;
if (entry.includes("\0")) {
throw new Error("--entry must not contain NUL bytes");
}
if (entry.startsWith("-")) {
throw new Error(`--entry must be a file path, not a Node option: ${JSON.stringify(entry)}`);
}
return entry;
}
function resolveOutputPath(raw: string | undefined): string | undefined {
const output = raw?.trim();
if (!output) {
return undefined;
}
if (output.includes("\0")) {
throw new Error("--output must not contain NUL bytes");
}
return output;
}
function resolveCases(caseIds: string[]): GatewayBenchCase[] {
if (caseIds.length === 0) {
return [...GATEWAY_CASES];
}
const seenIds = new Set<string>();
for (const id of caseIds) {
if (seenIds.has(id)) {
throw new CliArgumentError(`Duplicate --case "${id}"`);
}
seenIds.add(id);
}
const byId = new Map(GATEWAY_CASES.map((benchCase) => [benchCase.id, benchCase]));
return caseIds.map((id) => {
const benchCase = byId.get(id);
if (!benchCase) {
throw new Error(`Unknown --case "${id}"`);
}
return benchCase;
});
}
function parseOptions(argv: string[] = process.argv.slice(2)): CliOptions {
validateCliArgs(argv);
return {
cases: resolveCases(parseRepeatableFlag(argv, "--case")),
cpuProfDir: parseFlagValue(argv, "--cpu-prof-dir"),
entry: resolveEntry(parseFlagValue(argv, "--entry")),
json: hasFlag(argv, "--json"),
output: resolveOutputPath(parseFlagValue(argv, "--output")),
runs: parsePositiveInt(parseFlagValue(argv, "--runs"), DEFAULT_RUNS, "--runs"),
timeoutMs: parsePositiveInt(
parseFlagValue(argv, "--timeout-ms"),
DEFAULT_TIMEOUT_MS,
"--timeout-ms",
),
warmup: parseNonNegativeInt(parseFlagValue(argv, "--warmup"), DEFAULT_WARMUP, "--warmup"),
};
}
function printUsage(): void {
console.log(`OpenClaw Gateway startup benchmark
Usage:
pnpm test:startup:gateway -- [options]
node --import tsx scripts/bench-gateway-startup.ts [options]
Options:
--case <id> Specific case id to run; repeatable
--entry <path> Gateway CLI entry file (default: ${DEFAULT_ENTRY})
--runs <n> Measured runs per case (default: ${DEFAULT_RUNS})
--warmup <n> Warmup runs per case (default: ${DEFAULT_WARMUP})
--timeout-ms <ms> Per-run timeout (default: ${DEFAULT_TIMEOUT_MS})
--cpu-prof-dir <dir> Write one V8 CPU profile per run
--output <path> Write machine-readable JSON to a file
--json Emit machine-readable JSON
--help, -h Show this text
Case ids:
${GATEWAY_CASES.map((benchCase) => `${benchCase.id} (${benchCase.name})`).join("\n ")}
`);
}
function median(values: number[]): number {
const sorted = [...values].toSorted((a, b) => a - b);
const middle = Math.floor(sorted.length / 2);
if (sorted.length % 2 === 0) {
return (sorted[middle - 1] + sorted[middle]) / 2;
}
return sorted[middle] ?? 0;
}
function percentile(values: number[], p: number): number {
const sorted = [...values].toSorted((a, b) => a - b);
const index = Math.min(sorted.length - 1, Math.floor((p / 100) * sorted.length));
return sorted[index] ?? 0;
}
function summarizeNumbers(values: number[]): SummaryStats | null {
if (values.length === 0) {
return null;
}
const total = values.reduce((sum, value) => sum + value, 0);
return {
avg: total / values.length,
max: Math.max(...values),
min: Math.min(...values),
p50: median(values),
p95: percentile(values, 95),
};
}
function summarizeCase(benchCase: GatewayBenchCase, samples: GatewaySample[]): CaseResult {
const startupTraceKeys = new Set<string>();
for (const sample of samples) {
for (const key of Object.keys(sample.startupTrace)) {
startupTraceKeys.add(key);
}
}
const startupTrace: Record<string, SummaryStats> = {};
for (const key of [...startupTraceKeys].toSorted()) {
const stats = summarizeNumbers(
samples
.map((sample) => sample.startupTrace[key])
.filter((value): value is number => typeof value === "number"),
);
if (stats) {
startupTrace[key] = stats;
}
}
return {
id: benchCase.id,
name: benchCase.name,
samples,
summary: {
firstOutputMs: summarizeNumbers(
samples
.map((sample) => sample.firstOutputMs)
.filter((value): value is number => typeof value === "number"),
),
cpuCoreRatio: summarizeNumbers(
samples
.map((sample) => sample.cpuCoreRatio)
.filter((value): value is number => typeof value === "number"),
),
cpuMs: summarizeNumbers(
samples
.map((sample) => sample.cpuMs)
.filter((value): value is number => typeof value === "number"),
),
gatewayReadyLogMs: summarizeNumbers(
samples
.map((sample) => sample.gatewayReadyLogMs)
.filter((value): value is number => typeof value === "number"),
),
healthzMs: summarizeNumbers(
samples
.map((sample) => sample.healthz.ms)
.filter((value): value is number => typeof value === "number"),
),
httpListenLogMs: summarizeNumbers(
samples
.map((sample) => sample.httpListenLogMs)
.filter((value): value is number => typeof value === "number"),
),
maxRssMb: summarizeNumbers(
samples
.map((sample) => sample.maxRssMb)
.filter((value): value is number => typeof value === "number"),
),
readyzMs: summarizeNumbers(
samples
.map((sample) => sample.readyz.ms)
.filter((value): value is number => typeof value === "number"),
),
startupTrace,
},
};
}
function collectResultFailures(
results: CaseResult[],
options: { processMetricsRequired?: boolean } = {},
): BenchmarkFailure[] {
const processMetricsRequired = options.processMetricsRequired ?? process.platform !== "win32";
const failures: BenchmarkFailure[] = [];
for (const result of results) {
result.samples.forEach((sample, index) => {
const missing: string[] = [];
if (sample.healthz.status !== 200 || sample.healthz.ms == null) {
missing.push("/healthz");
}
if (sample.readyz.status !== 200 || sample.readyz.ms == null) {
missing.push("/readyz");
}
if (processMetricsRequired) {
if (sample.cpuMs == null || sample.cpuCoreRatio == null) {
missing.push("cpu");
}
if (sample.maxRssMb == null) {
missing.push("rss");
}
}
if (missing.length > 0) {
failures.push({
id: result.id,
reason: `missing ${missing.join(", ")}`,
sampleIndex: index + 1,
});
return;
}
if (sample.exitedBeforeTeardown === true) {
failures.push({
id: result.id,
reason:
sample.signal == null
? `child exited ${sample.exitCode ?? "before teardown"}`
: `child exited by ${sample.signal}`,
sampleIndex: index + 1,
});
}
});
}
return failures;
}
function printBenchmarkFailures(failures: BenchmarkFailure[]): void {
if (failures.length === 0) {
return;
}
console.error(
`[gateway-startup-bench] failed: ${failures.length} sample(s) did not produce ready probes or process metrics`,
);
for (const failure of failures.slice(0, 8)) {
console.error(
`[gateway-startup-bench] ${failure.id} run ${failure.sampleIndex}: ${failure.reason}`,
);
}
if (failures.length > 8) {
console.error(`[gateway-startup-bench] ${failures.length - 8} more sample failure(s) omitted`);
}
}
function formatMs(value: number | null): string {
if (value == null) {
return "n/a";
}
return `${value.toFixed(1)}ms`;
}
function formatMb(value: number | null): string {
if (value == null) {
return "n/a";
}
return `${value.toFixed(1)}MB`;
}
function formatRatio(value: number | null): string {
if (value == null) {
return "n/a";
}
return value.toFixed(3);
}
function formatStats(stats: SummaryStats | null): string {
if (!stats) {
return "n/a";
}
return `p50=${formatMs(stats.p50)} avg=${formatMs(stats.avg)} min=${formatMs(stats.min)} max=${formatMs(stats.max)}`;
}
function formatMemoryStats(stats: SummaryStats | null): string {
if (!stats) {
return "n/a";
}
return `p50=${formatMb(stats.p50)} avg=${formatMb(stats.avg)} min=${formatMb(stats.min)} max=${formatMb(stats.max)}`;
}
function formatRatioStats(stats: SummaryStats | null): string {
if (!stats) {
return "n/a";
}
return `p50=${formatRatio(stats.p50)} avg=${formatRatio(stats.avg)} min=${formatRatio(stats.min)} max=${formatRatio(stats.max)}`;
}
function getStartupTraceStat(
startupTrace: Record<string, SummaryStats>,
key: string,
): SummaryStats | null {
return startupTrace[key] ?? null;
}
async function waitForProbe(params: {
deadlineAt: number;
isDone?: () => boolean;
path: string;
port: number;
startAt: number;
}): Promise<ProbeResult> {
let firstErrorKind: string | null = null;
let firstRecoveryMs: number | null = null;
let lastStatus: number | null = null;
let lastStateKey: string | null = null;
let sawUnreadyState = false;
const transitions: ProbeTransition[] = [];
while (performance.now() < params.deadlineAt) {
if (params.isDone?.()) {
break;
}
const attempt = await requestProbeStatus(params.port, params.path);
const now = performance.now();
const elapsedMs = now - params.startAt;
lastStatus = attempt.status;
const stateKey = `${attempt.status ?? "none"}:${attempt.errorKind ?? "ok"}`;
if (stateKey !== lastStateKey) {
transitions.push({
ms: elapsedMs,
status: attempt.status,
...(attempt.errorKind ? { errorKind: attempt.errorKind } : {}),
});
lastStateKey = stateKey;
}
if (attempt.errorKind && firstErrorKind == null) {
firstErrorKind = attempt.errorKind;
}
if (attempt.status !== 200) {
sawUnreadyState = true;
}
if (attempt.status === 200) {
if (sawUnreadyState && firstRecoveryMs == null) {
firstRecoveryMs = elapsedMs;
}
return {
firstErrorKind,
firstRecoveryMs,
ms: elapsedMs,
status: attempt.status,
transitions,
};
}
await delay(25);
}
return { firstErrorKind, firstRecoveryMs, ms: null, status: lastStatus, transitions };
}
function writePluginFixtures(
root: string,
count: number,
activationOnStartup?: boolean,
): PluginFixtureResult {
const pluginIds: string[] = [];
const pluginsDir = path.join(root, "plugins");
mkdirSync(pluginsDir, { recursive: true });
for (let index = 0; index < count; index += 1) {
const id = `bench-plugin-${String(index + 1).padStart(2, "0")}`;
pluginIds.push(id);
const pluginDir = path.join(pluginsDir, id);
mkdirSync(pluginDir, { recursive: true });
const entry = path.join(pluginDir, "index.cjs");
writeFileSync(entry, `module.exports = { id: ${JSON.stringify(id)}, register() {} };\n`);
writeFileSync(
path.join(pluginDir, "openclaw.plugin.json"),
`${JSON.stringify(
{
id,
...(activationOnStartup === undefined
? {}
: { activation: { onStartup: activationOnStartup } }),
configSchema: { type: "object", additionalProperties: false },
},
null,
2,
)}\n`,
);
}
return { pluginIds, pluginsDir };
}
function writeConfig(root: string, benchCase: GatewayBenchCase): string {
const pluginFixtures = benchCase.pluginCount
? writePluginFixtures(root, benchCase.pluginCount, benchCase.pluginActivationOnStartup)
: null;
const config = {
...benchCase.config,
plugins: {
...(benchCase.config.plugins as Record<string, unknown> | undefined),
...(pluginFixtures
? {
load: { paths: [pluginFixtures.pluginsDir] },
allow: pluginFixtures.pluginIds,
}
: {}),
},
};
const configPath = path.join(root, "openclaw.json");
writeFileSync(configPath, `${JSON.stringify(config, null, 2)}\n`);
return configPath;
}
function sanitizedEnv(
root: string,
configPath: string,
benchCase: GatewayBenchCase,
): NodeJS.ProcessEnv {
const env: NodeJS.ProcessEnv = {
CI: process.env.CI ?? "1",
HOME: root,
LANG: process.env.LANG ?? "en_US.UTF-8",
LOGNAME: process.env.LOGNAME ?? "openclaw-bench",
NO_COLOR: "1",
PATH: process.env.PATH,
SHELL: process.env.SHELL,
TMPDIR: process.env.TMPDIR,
USER: process.env.USER ?? "openclaw-bench",
npm_config_update_notifier: "false",
OPENCLAW_CONFIG: configPath,
OPENCLAW_CONFIG_PATH: configPath,
OPENCLAW_GATEWAY_STARTUP_TRACE: "1",
OPENCLAW_HOME: root,
OPENCLAW_NO_RESPAWN: "1",
OPENCLAW_STATE_DIR: path.join(root, "state"),
OPENCLAW_TEST_DISABLE_UPDATE_CHECK: "1",
...benchCase.env,
};
return env;
}
function collectStartupTrace(line: string, startupTrace: Record<string, number>): void {
const phaseMatch = /startup trace: ([^ ]+) ([0-9.]+)ms total=([0-9.]+)ms(?: (.*))?/u.exec(line);
if (phaseMatch) {
startupTrace[phaseMatch[1]] = Number(phaseMatch[2]);
startupTrace[`${phaseMatch[1]}.total`] = Number(phaseMatch[3]);
for (const metric of parseStartupTraceMetrics(phaseMatch[4] ?? "")) {
startupTrace[`${phaseMatch[1]}.${metric.key}`] = metric.value;
}
return;
}
const detailMatch = /startup trace: ([^ ]+) (.*)/u.exec(line);
if (!detailMatch) {
return;
}
for (const metric of parseStartupTraceMetrics(detailMatch[2])) {
startupTrace[`${detailMatch[1]}.${metric.key}`] = metric.value;
}
}
function classifyGatewayReadyLog(line: string): "gateway-ready" | "http-listen" | null {
if (line.includes("[gateway] http server listening (")) {
return "http-listen";
}
if (/\[gateway\] ready(?:\s*\(|\s*$)/.test(line)) {
return "gateway-ready";
}
return null;
}
function parseStartupTraceMetrics(raw: string): Array<{ key: string; value: number }> {
const metrics: Array<{ key: string; value: number }> = [];
for (const part of raw.trim().split(/\s+/u)) {
const metricMatch = /^([A-Za-z][A-Za-z0-9]*)=([0-9.]+)(?:ms)?$/u.exec(part);
if (!metricMatch) {
continue;
}
const key = metricMatch[1];
const value = Number(metricMatch[2]);
if (
!Number.isFinite(value) ||
(key !== "eventLoopMax" &&
!key.endsWith("Ms") &&
!key.endsWith("Mb") &&
!key.endsWith("Count"))
) {
continue;
}
metrics.push({ key, value });
}
return metrics;
}
async function runGatewaySample(options: {
benchCase: GatewayBenchCase;
cpuProfDir?: string;
entry: string;
sampleIndex: number;
timeoutMs: number;
}): Promise<GatewaySample> {
const root = mkdtempSync(path.join(tmpdir(), "openclaw-gateway-bench-"));
const port = await getFreePort();
const configPath = writeConfig(root, options.benchCase);
const env = sanitizedEnv(root, configPath, options.benchCase);
const startAt = performance.now();
const deadlineAt = startAt + options.timeoutMs;
const startupTrace: Record<string, number> = {};
const output: string[] = [];
let firstOutputMs: number | null = null;
let gatewayReadyLogLine: string | null = null;
let gatewayReadyLogMs: number | null = null;
let httpListenLogLine: string | null = null;
let httpListenLogMs: number | null = null;
let maxRssMb: number | null = null;
let childExited = false;
const childArgs = [
...(options.cpuProfDir
? [
"--cpu-prof",
"--cpu-prof-dir",
options.cpuProfDir,
"--cpu-prof-name",
`openclaw-gateway-${options.benchCase.id}-${options.sampleIndex}-${Date.now()}.cpuprofile`,
]
: []),
options.entry,
"gateway",
"run",
"--port",
String(port),
"--bind",
"loopback",
"--auth",
"none",
"--tailscale",
"off",
"--allow-unconfigured",
];
const child = spawn(process.execPath, childArgs, {
cwd: process.cwd(),
detached: process.platform !== "win32",
env,
});
const cpuStartMs = readProcessTreeCpuMs(child.pid);
const sampleRss = () => {
const rssMb = readProcessRssMb(child.pid);
if (rssMb != null) {
maxRssMb = maxRssMb == null ? rssMb : Math.max(maxRssMb, rssMb);
}
};
sampleRss();
const rssTimer = setInterval(sampleRss, 100);
rssTimer.unref?.();
const childExitPromise = new Promise<{ exitCode: number | null; signal: string | null }>(
(resolve) => {
child.once("exit", (exitCode, signal) => {
childExited = true;
resolve({ exitCode, signal });
});
},
);
const onChunk = (chunk: Buffer) => {
if (firstOutputMs == null) {
firstOutputMs = performance.now() - startAt;
}
const text = chunk.toString("utf8");
output.push(text);
if (output.length > 20) {
output.splice(0, output.length - 20);
}
for (const line of text.split(/\r?\n/u)) {
const readyLogKind = classifyGatewayReadyLog(line);
if (readyLogKind === "http-listen" && httpListenLogMs == null) {
httpListenLogMs = performance.now() - startAt;
httpListenLogLine = line;
}
if (readyLogKind === "gateway-ready" && gatewayReadyLogMs == null) {
gatewayReadyLogMs = performance.now() - startAt;
gatewayReadyLogLine = line;
}
collectStartupTrace(line, startupTrace);
}
};
child.stdout.on("data", onChunk);
child.stderr.on("data", onChunk);
const [healthz, readyz] = await Promise.all([
waitForProbe({
deadlineAt,
isDone: () => childExited,
path: "/healthz",
port,
startAt,
}),
waitForProbe({
deadlineAt,
isDone: () => childExited,
path: "/readyz",
port,
startAt,
}),
]);
const readyAt = performance.now();
const cpuEndMs = readProcessTreeCpuMs(child.pid);
const cpuMs = cpuStartMs == null || cpuEndMs == null ? null : Math.max(0, cpuEndMs - cpuStartMs);
const cpuCoreRatio = cpuMs == null ? null : cpuMs / Math.max(1, readyAt - startAt);
const exit = await stopChild(child);
clearInterval(rssTimer);
sampleRss();
// stopChild is the bounded teardown wait; the raw exit promise may never settle.
void childExitPromise.catch(() => null);
rmSync(root, { force: true, maxRetries: 3, recursive: true, retryDelay: 100 });
return {
cpuCoreRatio,
cpuMs,
exitedBeforeTeardown: exit.exitedBeforeTeardown,
exitCode: exit.exitCode,
firstOutputMs,
gatewayReadyLogLine,
gatewayReadyLogMs,
healthz,
httpListenLogLine,
httpListenLogMs,
maxRssMb,
outputTail: output.join("").split(/\r?\n/u).slice(-20).join("\n"),
readyz,
signal: exit.signal,
startupTrace,
};
}
async function runCase(options: {
benchCase: GatewayBenchCase;
cpuProfDir?: string;
entry: string;
runs: number;
timeoutMs: number;
warmup: number;
}): Promise<CaseResult> {
const samples: GatewaySample[] = [];
const total = options.runs + options.warmup;
for (let index = 0; index < total; index += 1) {
const sample = await runGatewaySample({
benchCase: options.benchCase,
cpuProfDir: options.cpuProfDir,
entry: options.entry,
sampleIndex: index + 1,
timeoutMs: options.timeoutMs,
});
if (index >= options.warmup) {
samples.push(sample);
const heapUsedMb = sample.startupTrace["memory.ready.heapUsedMb"] ?? null;
console.log(
`[gateway-startup-bench] ${options.benchCase.id} run ${samples.length}/${options.runs}: healthz=${formatMs(sample.healthz.ms)} readyz=${formatMs(sample.readyz.ms)} httpListen=${formatMs(sample.httpListenLogMs)} gatewayReady=${formatMs(sample.gatewayReadyLogMs)} cpu=${formatMs(sample.cpuMs)} cpuCore=${formatRatio(sample.cpuCoreRatio)} rss=${formatMb(sample.maxRssMb)} heap=${formatMb(heapUsedMb)}`,
);
} else {
const heapUsedMb = sample.startupTrace["memory.ready.heapUsedMb"] ?? null;
console.log(
`[gateway-startup-bench] ${options.benchCase.id} warmup ${index + 1}/${options.warmup}: healthz=${formatMs(sample.healthz.ms)} readyz=${formatMs(sample.readyz.ms)} cpu=${formatMs(sample.cpuMs)} cpuCore=${formatRatio(sample.cpuCoreRatio)} rss=${formatMb(sample.maxRssMb)} heap=${formatMb(heapUsedMb)}`,
);
}
}
return summarizeCase(options.benchCase, samples);
}
function printResult(result: CaseResult): void {
console.log(`\n${result.name} (${result.id})`);
console.log(` first output: ${formatStats(result.summary.firstOutputMs)}`);
console.log(` CPU: ${formatStats(result.summary.cpuMs)}`);
console.log(` CPU core: ${formatRatioStats(result.summary.cpuCoreRatio)}`);
console.log(` /healthz: ${formatStats(result.summary.healthzMs)}`);
console.log(` http listen: ${formatStats(result.summary.httpListenLogMs)}`);
console.log(` gateway ready: ${formatStats(result.summary.gatewayReadyLogMs)}`);
console.log(` /readyz: ${formatStats(result.summary.readyzMs)}`);
console.log(` max RSS: ${formatMemoryStats(result.summary.maxRssMb)}`);
console.log(
` ready memory: rss=${formatMemoryStats(getStartupTraceStat(result.summary.startupTrace, "memory.ready.rssMb"))} heap=${formatMemoryStats(getStartupTraceStat(result.summary.startupTrace, "memory.ready.heapUsedMb"))} external=${formatMemoryStats(getStartupTraceStat(result.summary.startupTrace, "memory.ready.externalMb"))}`,
);
console.log(
` post-ready memory: rss=${formatMemoryStats(getStartupTraceStat(result.summary.startupTrace, "memory.post-ready.rssMb"))} heap=${formatMemoryStats(getStartupTraceStat(result.summary.startupTrace, "memory.post-ready.heapUsedMb"))} external=${formatMemoryStats(getStartupTraceStat(result.summary.startupTrace, "memory.post-ready.externalMb"))}`,
);
const trace = Object.entries(result.summary.startupTrace)
.filter(([name]) => !name.endsWith(".total") && !name.startsWith("memory."))
.toSorted((a, b) => (b[1].avg ?? 0) - (a[1].avg ?? 0))
.slice(0, 8);
if (trace.length > 0) {
console.log(" trace top:");
for (const [name, stats] of trace) {
console.log(` ${name}: ${formatStats(stats)}`);
}
}
}
async function main() {
const argv = process.argv.slice(2);
if (hasHelpFlag(argv)) {
printUsage();
return;
}
const options = parseOptions(argv);
if (options.cpuProfDir) {
mkdirSync(options.cpuProfDir, { recursive: true });
}
const results: CaseResult[] = [];
for (const benchCase of options.cases) {
results.push(
await runCase({
benchCase,
cpuProfDir: options.cpuProfDir,
entry: options.entry,
runs: options.runs,
timeoutMs: options.timeoutMs,
warmup: options.warmup,
}),
);
}
const payload = {
entry: options.entry,
generatedAt: new Date().toISOString(),
results,
};
if (options.output) {
mkdirSync(path.dirname(options.output), { recursive: true });
writeFileSync(options.output, `${JSON.stringify(payload, null, 2)}\n`);
}
if (options.json) {
console.log(JSON.stringify(payload, null, 2));
} else {
for (const result of results) {
printResult(result);
}
}
const failures = collectResultFailures(results);
if (failures.length > 0) {
printBenchmarkFailures(failures);
process.exitCode = 1;
}
}
export const testing = {
classifyGatewayReadyLog,
collectResultFailures,