Replication benchmark cleanup and readme

Author: matt-aitken

apps/webapp/test/runsReplicationBenchmark.README.md

@@ -84,14 +84,13 @@ cd apps/webapp
 BENCHMARK_NUM_RUNS=50000 pnpm run test ./test/runsReplicationBenchmark.test.ts --run
 ```
 
-**Note:** The test is marked with `.skip` by default. To run it, remove the `.skip` from the test:
+**Note:** The benchmark is gated by the `BENCHMARKS_ENABLED` environment variable
+(via `containerTest.skipIf`), so you don't need to edit the test file. Set
+`BENCHMARKS_ENABLED=1` (and optionally `BENCHMARK_NUM_RUNS`) then run:
 
-```typescript
-// Change this:
-containerTest.skip("should benchmark...", async () => {
-
-// To this:
-containerTest("should benchmark...", async () => {
+```bash
+cd apps/webapp
+BENCHMARKS_ENABLED=1 pnpm run test ./test/runsReplicationBenchmark.test.ts --run
 ```
 
 ## What Gets Measured

apps/webapp/test/runsReplicationBenchmark.test.ts

@@ -344,36 +344,39 @@ async function runBenchmark(
   const eluMonitor = new ELUMonitor();
   eluMonitor.start(100);
 
-  // Run producer in separate process
-  console.log("\n[Benchmark] Starting producer...");
-  const producerStats = await runProducer({
-    postgresUrl: postgresContainer.getConnectionUri(),
-    organizationId: organization.id,
-    projectId: project.id,
-    environmentId: runtimeEnvironment.id,
-    numRuns: BENCHMARK_CONFIG.NUM_RUNS,
-    errorRate: BENCHMARK_CONFIG.ERROR_RATE,
-    batchSize: BENCHMARK_CONFIG.PRODUCER_BATCH_SIZE,
-  });
-
-  console.log("\n[Benchmark] Waiting for replication to complete...");
-  const replicationResult = await waitForReplication(
-    clickhouse,
-    organization.id,
-    producerStats.created,
-    BENCHMARK_CONFIG.REPLICATION_TIMEOUT_MS
-  );
-
-  // Stop ELU monitoring
-  const eluStats = eluMonitor.stop();
-
-  // Get metrics
-  const metrics = await metricsHelper.getMetrics();
-  const metricsStats = extractMetrics(metrics);
+  let producerStats!: BenchmarkResult["producerStats"];
+  let replicationResult!: { duration: number; replicatedRuns: number };
+  let metricsStats!: BenchmarkResult["metricsStats"];
+  let eluStats!: BenchmarkResult["eluStats"];
+
+  try {
+    // Run producer in separate process
+    console.log("\n[Benchmark] Starting producer...");
+    producerStats = await runProducer({
+      postgresUrl: postgresContainer.getConnectionUri(),
+      organizationId: organization.id,
+      projectId: project.id,
+      environmentId: runtimeEnvironment.id,
+      numRuns: BENCHMARK_CONFIG.NUM_RUNS,
+      errorRate: BENCHMARK_CONFIG.ERROR_RATE,
+      batchSize: BENCHMARK_CONFIG.PRODUCER_BATCH_SIZE,
+    });
 
-  // Cleanup
-  await runsReplicationService.stop();
-  await metricsHelper.shutdown();
+    console.log("\n[Benchmark] Waiting for replication to complete...");
+    replicationResult = await waitForReplication(
+      clickhouse,
+      organization.id,
+      producerStats.created,
+      BENCHMARK_CONFIG.REPLICATION_TIMEOUT_MS
+    );
+
+    const metrics = await metricsHelper.getMetrics();
+    metricsStats = extractMetrics(metrics);
+  } finally {
+    eluStats = eluMonitor.stop();
+    await runsReplicationService.stop();
+    await metricsHelper.shutdown();
+  }
 
   const throughput = (replicationResult.replicatedRuns / replicationResult.duration) * 1000;