test: add examples and run them in the ci

.github/workflows/ci.yml

@@ -40,16 +40,40 @@ jobs:
         with:
           run: pnpm moon run :bench
 
+  list-examples:
+    runs-on: "ubuntu-latest"
+    name: List examples
+    outputs:
+      examples: ${{ steps.list-examples.outputs.examples }}
+    steps:
+      - uses: "actions/checkout@v3"
+      # list the directories in ./examples and output them to a github action workflow variables as a JSON array
+      - run: |
+          examples=$(find ./examples -maxdepth 1 -mindepth 1 -type d -printf '%f\n' | jq -R -s -c 'split("\n") | map(select(length > 0))')
+          echo "::set-output name=examples::$examples"
+        id: list-examples
+
   node-versions:
     runs-on: "ubuntu-latest"
-    name: "Node ${{ matrix.node-version }}"
+    name: "${{ matrix.example }} on Node ${{ matrix.node-version }}"
+    needs: list-examples
     strategy:
       matrix:
         node-version: ["14", "16", "18", "20"]
+        example: ${{ fromJson(needs.list-examples.outputs.examples) }}
         include:
+          # tinybench does not support node 14
           - node-version: "14"
             pnpm-version: "7"
             skip-tinybench: true
+        exclude:
+          # esbuild-register does not work well with node 14
+          - node-version: "14"
+            example: with-typescript-cjs
+          - node-version: "14"
+            example: with-typescript-esm
+          - node-version: "14"
+            example: with-typescript-simple-esm
       fail-fast: false
     steps:
       - uses: "actions/checkout@v3"
@@ -66,16 +90,16 @@ jobs:
       - run: pnpm install --frozen-lockfile --prefer-offline
       - run: pnpm moon run :build
 
-      - name: Run benchmarks on tinybench-plugin
+      - name: Run benchmarks with tinybench-plugin
         if: matrix.skip-tinybench != true
         uses: CodSpeedHQ/action@feat/node-script
         with:
-          run: pnpm moon run tinybench-plugin:bench
+          run: pnpm --filter ${{ matrix.example }} bench-tinybench
         env:
           SKIP_UPLOAD: true
-      - name: Run benchmarks on benchmark.js-plugin
+      - name: Run benchmarks with benchmark.js-plugin
         uses: CodSpeedHQ/action@feat/node-script
         with:
-          run: pnpm moon run benchmark.js-plugin:bench
+          run: pnpm --filter ${{ matrix.example }} bench-benchmark-js
         env:
           SKIP_UPLOAD: true

.npmrc

@@ -0,0 +1 @@
+auto-install-peers=true

examples/with-javascript-cjs/benchmark-js.js

@@ -0,0 +1,18 @@
+const { withCodSpeed } = require("@codspeed/benchmark.js-plugin");
+const Benchmark = require("benchmark");
+
+const suite = withCodSpeed(new Benchmark.Suite());
+
+suite
+  .add("RegExp#test", function () {
+    /o/.test("Hello World!");
+  })
+  .add("String#indexOf", function () {
+    "Hello World!".indexOf("o") > -1;
+  })
+  // add listeners
+  .on("cycle", function (event) {
+    console.log(String(event.target));
+  })
+  // run async
+  .run({ async: true });

examples/with-javascript-cjs/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "with-javascript-cjs",
+  "private": true,
+  "scripts": {
+    "bench-benchmark-js": "node benchmark-js.js",
+    "bench-tinybench": "node tinybench.js"
+  },
+  "devDependencies": {
+    "@codspeed/benchmark.js-plugin": "workspace:^1.1.0",
+    "@codspeed/tinybench-plugin": "workspace:^1.1.0",
+    "benchmark": "^2.1.4",
+    "tinybench": "^2.5.0"
+  }
+}

examples/with-javascript-cjs/tinybench.js

@@ -0,0 +1,30 @@
+const { withCodSpeed } = require("@codspeed/tinybench-plugin");
+const { Bench } = require("tinybench");
+
+const bench = withCodSpeed(new Bench({ time: 100 }));
+
+bench
+  .add("switch 1", () => {
+    let a = 1;
+    let b = 2;
+    const c = a;
+    a = b;
+    b = c;
+  })
+  .add("switch 2", () => {
+    let a = 1;
+    let b = 10;
+    a = b + a;
+    b = a - b;
+    a = b - a;
+  });
+
+bench.run().then(() => {
+  console.table(
+    bench.tasks.map(({ name, result }) => ({
+      "Task Name": name,
+      "Average Time (ps)": result?.mean ? result.mean * 1000 : "N/A",
+      "Variance (ps)": result?.variance ? result.variance * 1000 : "N/A",
+    }))
+  );
+});

examples/with-javascript-esm/benchmark-js.js

@@ -0,0 +1,18 @@
+import { withCodSpeed } from "@codspeed/benchmark.js-plugin";
+import Benchmark from "benchmark";
+
+const suite = withCodSpeed(new Benchmark.Suite());
+
+suite
+  .add("RegExp#test", function () {
+    /o/.test("Hello World!");
+  })
+  .add("String#indexOf", function () {
+    "Hello World!".indexOf("o") > -1;
+  })
+  // add listeners
+  .on("cycle", function (event) {
+    console.log(String(event.target));
+  })
+  // run async
+  .run({ async: true });

examples/with-javascript-esm/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "with-javascript-esm",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "bench-benchmark-js": "node benchmark-js.js",
+    "bench-tinybench": "node tinybench.js"
+  },
+  "devDependencies": {
+    "@codspeed/benchmark.js-plugin": "workspace:^1.1.0",
+    "@codspeed/tinybench-plugin": "workspace:^1.1.0",
+    "benchmark": "^2.1.4",
+    "tinybench": "^2.5.0"
+  }
+}

examples/with-javascript-esm/tinybench.js

@@ -0,0 +1,30 @@
+import { withCodSpeed } from "@codspeed/tinybench-plugin";
+import { Bench } from "tinybench";
+
+const bench = withCodSpeed(new Bench({ time: 100 }));
+
+bench
+  .add("switch 1", () => {
+    let a = 1;
+    let b = 2;
+    const c = a;
+    a = b;
+    b = c;
+  })
+  .add("switch 2", () => {
+    let a = 1;
+    let b = 10;
+    a = b + a;
+    b = a - b;
+    a = b - a;
+  });
+
+bench.run().then(() => {
+  console.table(
+    bench.tasks.map(({ name, result }) => ({
+      "Task Name": name,
+      "Average Time (ps)": result?.mean ? result.mean * 1000 : "N/A",
+      "Variance (ps)": result?.variance ? result.variance * 1000 : "N/A",
+    }))
+  );
+});

examples/with-typescript-cjs/bench/benchmark.js/branchingConfusion.bench.ts

@@ -0,0 +1,8 @@
+import type { WithCodSpeedSuite } from "@codspeed/benchmark.js-plugin";
+import { branching_confusion } from "../../src/branchingConfusion";
+
+export function registerBranchingConfusionBenchmarks(suite: WithCodSpeedSuite) {
+  suite.add("test branching confusion", () => {
+    branching_confusion();
+  });
+}

examples/with-typescript-cjs/bench/benchmark.js/fibo.bench.ts

@@ -0,0 +1,35 @@
+import type { WithCodSpeedSuite } from "@codspeed/benchmark.js-plugin";
+import {
+  iterativeFibonacci,
+  recursiveCachedFibonacci,
+  recursiveFibonacci,
+} from "../../src/fibonacci";
+
+export function registerFiboBenchmarks(suite: WithCodSpeedSuite) {
+  suite
+    .add("test_recursive_fibo_10", () => {
+      recursiveFibonacci(10);
+    })
+    .add("test_recursive_fibo_20", () => {
+      recursiveFibonacci(20);
+    });
+
+  suite
+    .add("test_recursive_cached_fibo_10", () => {
+      recursiveCachedFibonacci(10);
+    })
+    .add("test_recursive_cached_fibo_20", () => {
+      recursiveCachedFibonacci(20);
+    })
+    .add("test_recursive_cached_fibo_30", () => {
+      recursiveCachedFibonacci(30);
+    });
+
+  suite
+    .add("test_iterative_fibo_10", () => {
+      iterativeFibonacci(10);
+    })
+    .add("test_iterative_fibo_100", () => {
+      iterativeFibonacci(100);
+    });
+}

examples/with-typescript-cjs/bench/benchmark.js/foobarbaz.bench.ts

@@ -0,0 +1,20 @@
+import type { WithCodSpeedSuite } from "@codspeed/benchmark.js-plugin";
+import { aBaz, baz } from "../../src/foobarbaz";
+
+export function registerFoobarbazBenchmarks(suite: WithCodSpeedSuite) {
+  suite
+    .add("test sync baz 10", () => {
+      baz(10);
+    })
+    .add("test sync baz 100", () => {
+      baz(100);
+    });
+
+  suite
+    .add("test async baz 10", async () => {
+      await aBaz(10);
+    })
+    .add("test async baz 100", async () => {
+      await aBaz(100);
+    });
+}

examples/with-typescript-cjs/bench/benchmark.js/index.bench.ts

@@ -0,0 +1,19 @@
+import { withCodSpeed } from "@codspeed/benchmark.js-plugin";
+import Benchmark from "benchmark";
+import { registerBranchingConfusionBenchmarks } from "./branchingConfusion.bench";
+import { registerFiboBenchmarks } from "./fibo.bench";
+import { registerFoobarbazBenchmarks } from "./foobarbaz.bench";
+
+export const suite = withCodSpeed(new Benchmark.Suite());
+
+(async () => {
+  registerFiboBenchmarks(suite);
+  registerFoobarbazBenchmarks(suite);
+  registerBranchingConfusionBenchmarks(suite);
+
+  suite.on("cycle", function (event: Benchmark.Event) {
+    console.log(String(event.target));
+  });
+
+  await suite.run({ async: true });
+})();

examples/with-typescript-cjs/bench/tinybench/branchingConfusion.bench.ts

@@ -0,0 +1,8 @@
+import { Bench } from "tinybench";
+import { branching_confusion } from "../../src/branchingConfusion";
+
+export function registerBranchingConfusionBenchmarks(bench: Bench) {
+  bench.add("test branching confusion", () => {
+    branching_confusion();
+  });
+}

examples/with-typescript-cjs/bench/tinybench/fibo.bench.ts

@@ -0,0 +1,35 @@
+import { Bench } from "tinybench";
+import {
+  iterativeFibonacci,
+  recursiveCachedFibonacci,
+  recursiveFibonacci,
+} from "../../src/fibonacci";
+
+export function registerFiboBenchmarks(bench: Bench) {
+  bench
+    .add("test_recursive_fibo_10", () => {
+      recursiveFibonacci(10);
+    })
+    .add("test_recursive_fibo_20", () => {
+      recursiveFibonacci(20);
+    });
+
+  bench
+    .add("test_recursive_cached_fibo_10", () => {
+      recursiveCachedFibonacci(10);
+    })
+    .add("test_recursive_cached_fibo_20", () => {
+      recursiveCachedFibonacci(20);
+    })
+    .add("test_recursive_cached_fibo_30", () => {
+      recursiveCachedFibonacci(30);
+    });
+
+  bench
+    .add("test_iterative_fibo_10", () => {
+      iterativeFibonacci(10);
+    })
+    .add("test_iterative_fibo_100", () => {
+      iterativeFibonacci(100);
+    });
+}

examples/with-typescript-cjs/bench/tinybench/foobarbaz.bench.ts

@@ -0,0 +1,20 @@
+import { Bench } from "tinybench";
+import { aBaz, baz } from "../../src/foobarbaz";
+
+export function registerFoobarbazBenchmarks(bench: Bench) {
+  bench
+    .add("test sync baz 10", () => {
+      baz(10);
+    })
+    .add("test sync baz 100", () => {
+      baz(100);
+    });
+
+  bench
+    .add("test async baz 10", async () => {
+      await aBaz(10);
+    })
+    .add("test async baz 100", async () => {
+      await aBaz(100);
+    });
+}

examples/with-typescript-cjs/bench/tinybench/index.bench.ts

@@ -0,0 +1,22 @@
+import { withCodSpeed } from "@codspeed/tinybench-plugin";
+import { Bench } from "tinybench";
+import { registerBranchingConfusionBenchmarks } from "./branchingConfusion.bench";
+import { registerFiboBenchmarks } from "./fibo.bench";
+import { registerFoobarbazBenchmarks } from "./foobarbaz.bench";
+
+export const bench = withCodSpeed(new Bench());
+
+(async () => {
+  registerFiboBenchmarks(bench);
+  registerFoobarbazBenchmarks(bench);
+  registerBranchingConfusionBenchmarks(bench);
+
+  await bench.run();
+  console.table(
+    bench.tasks.map(({ name, result }) => ({
+      "Task Name": name,
+      "Average Time (ps)": result?.mean ? result.mean * 1000 : "N/A",
+      "Variance (ps)": result?.variance ? result.variance * 1000 : "N/A",
+    }))
+  );
+})();

examples/with-typescript-cjs/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "with-typescript-cjs",
+  "private": true,
+  "scripts": {
+    "bench-benchmark-js": "node -r esbuild-register bench/benchmark.js/index.bench.ts",
+    "bench-tinybench": "node -r esbuild-register bench/tinybench/index.bench.ts"
+  },
+  "devDependencies": {
+    "@codspeed/benchmark.js-plugin": "workspace:^1.1.0",
+    "@codspeed/tinybench-plugin": "workspace:^1.1.0",
+    "@types/benchmark": "^2.1.2",
+    "benchmark": "^2.1.4",
+    "tinybench": "^2.5.0",
+    "typescript": "^5.1.3"
+  }
+}