feat: add cli flag to trigger gc (#20)

* Add a CLI flag to trigger GC

* Bump the rc version

Author: nazarhussain

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chainsafe/benchmark",
-  "version": "1.1.0-rc.4",
+  "version": "1.1.0-rc.5",
   "repository": "[email protected]:chainsafe/benchmark.git",
   "author": "ChainSafe Systems",
   "license": "MIT",

src/benchmark/reporter.ts

@@ -76,7 +76,7 @@ export class BenchmarkReporter {
 
           const ratio = result.averageNs / prevResult.averageNs;
           if (ratio > threshold) {
-            const fmt = this.indent() + color("fail", "  " + symbols.err) + " " + resultRow;
+            const fmt = this.indent() + color("fail", "  " + symbols.bang) + " " + resultRow;
             consoleLog(fmt);
             this.failed++;
             return;

src/benchmark/runner.ts

@@ -13,6 +13,7 @@ import {BenchmarkReporter} from "./reporter.js";
 import {store} from "./globalState.js";
 
 export class BenchmarkRunner implements VitestRunner {
+  readonly triggerGC: boolean;
   readonly config: VitestRunnerConfig;
   readonly reporter: BenchmarkReporter;
   readonly prevBench: Benchmark | null;
@@ -29,6 +30,7 @@ export class BenchmarkRunner implements VitestRunner {
       setupFiles: benchmarkOpts.setupFiles ? benchmarkOpts.setupFiles.map((s) => path.resolve(s)) : [],
       retry: 0,
     };
+    this.triggerGC = benchmarkOpts.triggerGC ?? false;
     this.prevBench = prevBench;
     this.benchmarkOpts = benchmarkOpts;
     this.reporter = new BenchmarkReporter({prevBench, benchmarkOpts});
@@ -50,6 +52,12 @@ export class BenchmarkRunner implements VitestRunner {
   onAfterRunTask(task: Task): void {
     this.reporter.onTestFinished(task);
     store.removeOptions(task);
+
+    // To help maintain consistent memory usage patterns
+    // we trigger garbage collection manually
+    if (this.triggerGC && global.gc) {
+      global.gc();
+    }
   }
 
   onAfterRunFiles(files: File[]): void {

src/cli/options.ts

@@ -191,4 +191,10 @@ export const benchmarkOptions: ICliCommandOptions<CLIBenchmarkOptions> = {
     default: [],
     group: benchmarkGroup,
   },
+  triggerGC: {
+    type: "boolean",
+    description: "Trigger GC (if available) after every benchmark",
+    default: false,
+    group: benchmarkGroup,
+  },
 };

src/types.ts

@@ -63,6 +63,8 @@ export type BenchmarkOpts = {
   skip?: boolean;
   /** Setup files to load before the test files */
   setupFiles?: string[];
+  /** Trigger GC cleanup every test to have consistent memory usage */
+  triggerGC?: boolean;
 };
 
 // Create partial only for specific keys