Added Bun build job and updated benchmark tests

Author: DarkGL

.github/workflows/release.yml

@@ -85,3 +85,52 @@ jobs:
           rebase: 'true'
           name: ${{ env.GIT_COMMIT_AUTHOR_NAME }}   ## FIX: https://github.com/github-actions-x/commit/issues/16
           email: ${{ env.GIT_COMMIT_AUTHOR_EMAIL }} ## FIX: https://github.com/github-actions-x/commit/issues/16
+  build-bun:
+    name: "Bun ${{ matrix.bun-version }}"
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      max-parallel: 1
+      matrix:
+        bun-version:
+            - 1.1.27
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Bun ${{ matrix.bun-version }}
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: ${{ matrix.bun-version }}
+
+      - name: Install
+        run: bun install
+
+      - name: Lint
+        run: bun run lint
+
+      - name: Test build
+        run: bun run test:build
+
+      - name: Test
+        run: bun run test
+
+      - name: generate benchmarks with bun
+        run: ./start.sh BUN
+
+        ## FIX: https://github.com/github-actions-x/commit/issues/16
+      - name: Expose git commit data
+        uses: rlespinasse/git-commit-data-action@v1 ## https://github.com/rlespinasse/git-commit-data-action
+
+      - name: push
+        uses: github-actions-x/commit@v2.9
+        ## prevents forked repos from comitting results in PRs
+        if: github.repository == 'moltar/typescript-runtime-type-benchmarks'
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          push-branch: master
+          commit-message: 'feat: ${{ matrix.bun-version }} adds auto-generated benchmarks and bar graph'
+          rebase: 'true'
+          name: ${{ env.GIT_COMMIT_AUTHOR_NAME }}   ## FIX: https://github.com/github-actions-x/commit/issues/16
+          email: ${{ env.GIT_COMMIT_AUTHOR_EMAIL }} ## FIX: https://github.com/github-actions-x/commit/issues/16

benchmarks/assertLoose.ts

@@ -18,7 +18,7 @@ export class AssertLoose extends Benchmark<Fn> {
     this.fn(validateData);
   }
 
-  test() {
+  test(describe: jest.Describe, expect: jest.Expect, test: jest.It) {
     describe(this.moduleName, () => {
       test('should validate the data', () => {
         expect(this.fn(validateData)).toBe(true);

benchmarks/assertStrict.ts

@@ -13,7 +13,7 @@ export class AssertStrict extends Benchmark<Fn> {
     this.fn(validateData);
   }
 
-  test() {
+  test(describe: jest.Describe, expect: jest.Expect, test: jest.It) {
     describe(this.moduleName, () => {
       test('should validate the data', () => {
         expect(this.fn(validateData)).toBe(true);

benchmarks/helpers/main.ts

@@ -6,7 +6,9 @@ import { getRegisteredBenchmarks } from './register';
 import type { BenchmarkCase, BenchmarkResult } from './types';
 
 const DOCS_DIR = join(__dirname, '../../docs');
-const NODE_VERSION = process.env.NODE_VERSION || process.version;
+const RUNTIME = process.env.RUNTIME || 'node';
+const RUNTIME_VERSION = process.env.RUNTIME_VERSION || process.version;
+const RUNTIME_FOR_PREVIEW = 'node';
 const NODE_VERSION_FOR_PREVIEW = 20;
 
 /**
@@ -28,7 +30,8 @@ export async function runAllBenchmarks() {
         name,
         ops,
         margin,
-        nodeVersion: NODE_VERSION,
+        runtime: RUNTIME,
+        runtimeVersion: RUNTIME_VERSION,
       });
     });
   }
@@ -54,7 +57,10 @@ export function deleteResults() {
 export async function createPreviewGraph() {
   const majorVersion = getNodeMajorVersion();
 
-  if (majorVersion === NODE_VERSION_FOR_PREVIEW) {
+  if (
+    majorVersion === NODE_VERSION_FOR_PREVIEW &&
+    RUNTIME_FOR_PREVIEW === 'node'
+  ) {
     const allResults: BenchmarkResult[] = JSON.parse(
       readFileSync(resultsJsonFilename()).toString()
     ).results;
@@ -96,9 +102,10 @@ function appendResults(results: BenchmarkResult[]) {
   const getKey = ({
     benchmark,
     name,
-    nodeVersion,
+    runtime,
+    runtimeVersion,
   }: BenchmarkResult): string => {
-    return JSON.stringify({ benchmark, name, nodeVersion });
+    return JSON.stringify({ benchmark, name, runtime, runtimeVersion });
   };
   const existingResultsIndex = new Set(existingResults.map(r => getKey(r)));
 
@@ -124,7 +131,7 @@ function appendResults(results: BenchmarkResult[]) {
 function resultsJsonFilename() {
   const majorVersion = getNodeMajorVersion();
 
-  return join(DOCS_DIR, 'results', `node-${majorVersion}.json`);
+  return join(DOCS_DIR, 'results', `${RUNTIME}-${majorVersion}.json`);
 }
 
 function previewSvgFilename() {
@@ -134,13 +141,13 @@ function previewSvgFilename() {
 function getNodeMajorVersion() {
   let majorVersion = 0;
 
-  majorVersion = parseInt(NODE_VERSION);
+  majorVersion = parseInt(RUNTIME_VERSION);
 
   if (!isNaN(majorVersion)) {
     return majorVersion;
   }
 
-  majorVersion = parseInt(NODE_VERSION.slice(1));
+  majorVersion = parseInt(RUNTIME_VERSION.slice(1));
 
   if (!isNaN(majorVersion)) {
     return majorVersion;

benchmarks/helpers/types.ts

@@ -5,7 +5,7 @@ export interface BenchmarkCase {
   run(): void;
 
   // run the benchmarks jest test
-  test(): void;
+  test(describe: jest.Describe, expect: jest.Expect, test: jest.It): void;
 }
 
 export abstract class Benchmark<Fn> implements BenchmarkCase {
@@ -24,7 +24,11 @@ export abstract class Benchmark<Fn> implements BenchmarkCase {
   abstract run(): void;
 
   // run the benchmarks jest test
-  abstract test(): void;
+  abstract test(
+    describe: jest.Describe,
+    expect: jest.Expect,
+    test: jest.It
+  ): void;
 }
 
 // Aliased any.
@@ -36,7 +40,8 @@ export type UnknownData = any;
 export interface BenchmarkResult {
   name: string;
   benchmark: string;
-  nodeVersion: string;
+  runtime: string;
+  runtimeVersion: string;
   ops: number;
   margin: number;
 }

benchmarks/parseSafe.ts

@@ -29,7 +29,7 @@ export class ParseSafe extends Benchmark<Fn> {
     this.fn(validateData);
   }
 
-  test() {
+  test(describe: jest.Describe, expect: jest.Expect, test: jest.It) {
     describe(this.moduleName, () => {
       test('should validate the data', () => {
         expect(this.fn(validateData)).toEqual(validateData);

benchmarks/parseStrict.ts

@@ -11,7 +11,7 @@ export class ParseStrict extends Benchmark<Fn> {
     this.fn(validateData);
   }
 
-  test() {
+  test(describe: jest.Describe, expect: jest.Expect, test: jest.It) {
     describe(this.moduleName, () => {
       test('should validate the data', () => {
         expect(this.fn(validateData)).toEqual(validateData);

start.sh

@@ -21,4 +21,7 @@ export RUNTIME
 export RUNTIME_VERSION
 
 $RUNTIME_SCRIPT run start
-$RUNTIME_SCRIPT run start create-preview-svg
+
+if [ "$ENV_TYPE" = "NODE" ]; then
+    $RUNTIME_SCRIPT run start create-preview-svg
+fi

test/benchmarks.test.ts

@@ -62,6 +62,6 @@ test('all cases must have been imported in tests', () => {
 
 getRegisteredBenchmarks().forEach(([benchmarkId, benchmarkCases]) => {
   describe(benchmarkId, () => {
-    benchmarkCases.forEach(c => c.test());
+    benchmarkCases.forEach(c => c.test(describe, expect, test));
   });
 });