feat: CodSpeed Benchmarks

.c8rc.json

@@ -4,6 +4,7 @@
   "exclude": [
     "src/**/index.ts",
     "src/**/*-fuzz.ts",
+    "src/**/__benchmarks__/*.ts",
     "src/jsutils/Maybe.ts",
     "src/jsutils/ObjMap.ts",
     "src/jsutils/PromiseOrValue.ts",

.eslintignore

@@ -10,3 +10,6 @@
 
 # Ignore TS files inside integration test
 /integrationTests/ts/*.ts
+
+# Ignore config files
+/vitest.config.ts

.eslintrc.cjs

@@ -637,6 +637,12 @@ module.exports = {
         ],
       },
     },
+    {
+      files: 'src/**/__benchmarks__/**',
+      rules: {
+        'import/no-nodejs-modules': 'off',
+      },
+    },
     {
       files: 'integrationTests/*',
       env: {

.github/workflows/ci.yml

@@ -49,16 +49,17 @@ jobs:
         uses: actions/checkout@v4
         with:
           persist-credentials: false
-
       - name: Check if commit contains files that should be ignored
         run: |
           git clone --depth 1 https://github.com/github/gitignore.git
-
           rm gitignore/Global/ModelSim.gitignore
           rm gitignore/Global/Images.gitignore
           cat gitignore/Node.gitignore gitignore/Global/*.gitignore > all.gitignore
 
-          IGNORED_FILES=$(git ls-files --cached --ignored --exclude-from=all.gitignore)
+          IGNORED_FILES_UNPROCESSED=$(git ls-files --cached --ignored --exclude-from=all.gitignore)
+          IGNORED_FILES=$(grep -v -F "patches/@codspeed+core+3.1.0.patch" <<< "$IGNORED_FILES_UNPROCESSED" || true)
+
+          echo "IGNORED_FILES: $IGNORED_FILES"
           if  [[ "$IGNORED_FILES" != "" ]]; then
             echo -e "::error::Please remove these files:\n$IGNORED_FILES" | sed -z 's/\n/%0A/g'
             exit 1

.github/workflows/codspeed.yml

@@ -0,0 +1,27 @@
+name: CodSpeed Benchmarks
+
+on:
+  push:
+    branches:
+      - 'main' # or "master"
+  pull_request:
+  # `workflow_dispatch` allows CodSpeed to trigger backtest
+  # performance analysis in order to generate initial data.
+  workflow_dispatch:
+
+jobs:
+  benchmarks:
+    name: Run benchmarks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: 'actions/checkout@v4'
+      - uses: 'actions/setup-node@v3'
+      - name: Install dependencies
+        run: npm install
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v3
+        env:
+          CODSPEED_FORCE_OPTIMIZATION: true
+        with:
+          run: npm exec vitest bench
+          token: ${{ secrets.CODSPEED_TOKEN }}

cspell.yml

@@ -7,6 +7,9 @@ ignorePaths:
   - package.json
   - benchmark/github-schema.graphql
   - benchmark/github-schema.json
+  - patches
+  - src/__benchmarks__/github-schema.json
+  - src/__benchmarks__/github-schema.graphql
 overrides:
   - filename: '**/docs-old/APIReference-*.md'
     ignoreRegExpList: ['/href="[^"]*"/']
@@ -34,7 +37,7 @@ ignoreRegExpList:
 
 words:
   - graphiql
-
+  - codspeed
   # Different names used inside tests
   - Skywalker
   - Leia