ci: add initial benchmark infrastructure

.github/workflows/bench.yml

@@ -0,0 +1,38 @@
+name: Benchmarks
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  benchmark:
+    name: Performance regression check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+       uses: actions/checkout@v4
+
+      - name: CI Setup
+        uses: ./.github/actions/test-setup
+
+      # Run benchmark and stores the output to a file
+      - name: Run benchmark
+        run: pnpm node:bench | tee benchmark_results.txt
+
+      # Process the output to check for performance regression
+      - name: Process benchmark results
+        id: benchmark
+        run: |
+          RESULTS=$(cat benchmark_results.txt | sed 's/$/\\n/' | tr -d '\n')
+          echo "results<<EOF" >> $GITHUB_OUTPUT
+          echo "$RESULTS" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Create comment
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          body: |
+            # Benchmark results
+            ${{ steps.benchmark.outputs.results }}

.gitignore

@@ -24,6 +24,7 @@ lib-cov
 *.pid
 *.gz
 *.swp
+*.0x/*
 
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
@@ -144,6 +145,10 @@ Forc.lock
 **/out/release
 **/test-predicate-*/index.ts
 
+## Ignore perf test files
+*clinic*
+.clinic/*
+
 # Ignore typegen test files
 **/test/typegen
 

package.json

@@ -30,6 +30,13 @@
     "test:validate": "./scripts/tests-validate.sh",
     "test:browser:filter": "vitest --run --coverage false --config vitest.browser.config.mts",
     "test:e2e": "vitest --run --config vitest.node.config.mts $(scripts/tests-find.sh --e2e)",
+    "bench:node": "vitest bench --run --config vitest.node.config.mts $(scripts/tests-find.sh)",
+    "bench:node:filter": "vitest bench --run --config vitest.node.config.mts",
+    "clinic:flame": "clinic flame --autocannon [ / ] -- node packages/${npm_config_package_name}/dist/profile.js",
+    "clinic:bubble": "clinic bubbleprof --autocannon [ -c 5 -a 500 / ] -- node packages/${npm_config_package_name}/dist/profile.js",
+    "clinic:doctor": "clinic doctor --autocannon [ / ] -- node packages/${npm_config_package_name}/dist/profile.js",
+    "clinic:heap": "clinic heapprofiler --autocannon [ / ] -- node packages/${npm_config_package_name}/dist/profile.js",
+    "0x": "0x -o -P 'autocannon localhost:$PORT' -- node packages/${npm_config_package_name}/dist/profile.js",
     "test:integration": "vitest --run --config vitest.node.config.mts $(scripts/tests-find.sh --integration)",
     "lint": "run-s lint:check prettier:check",
     "lint:check": "eslint . --ext .ts --max-warnings 0",
@@ -62,6 +69,7 @@
   },
   "homepage": "https://github.com/FuelLabs/fuels-ts#readme",
   "devDependencies": {
+    "0x": "^5.7.0",
     "@actions/core": "^1.10.1",
     "@actions/github": "^6.0.0",
     "@changesets/cli": "^2.27.7",
@@ -82,6 +90,8 @@
     "@typescript-eslint/parser": "^6.21.0",
     "@vitest/browser": "^1.6.0",
     "@vitest/coverage-istanbul": "^1.6.0",
+    "autocannon": "^7.15.0",
+    "clinic": "^13.0.0",
     "compare-versions": "^6.1.1",
     "coverage-diff": "^3.2.0",
     "eslint": "^8.57.0",

packages/abi-coder/package.json

@@ -33,6 +33,7 @@
     "@fuel-ts/interfaces": "workspace:*",
     "@fuel-ts/math": "workspace:*",
     "@fuel-ts/utils": "workspace:*",
+    "restify": "^11.1.0",
     "type-fest": "^4.24.0"
   }
 }