Codemirror benchmarks

.github/workflows/benchmark.yaml

@@ -0,0 +1,33 @@
+name: Push benchmarks to grafana
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  benchmark:
+    name: Time benchmark
+    environment: grafana-api-key
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: main
+          path: main
+
+      - name: Setup antlr4
+        uses: ./main/.github/actions/setup-antlr4
+
+      - name: Install dependencies with frozen lock file
+        run: npm ci
+
+      - name: Build project
+        env:
+          NODE_OPTIONS: '--max_old_space_size=4096'
+        run: npm run build
+
+      - name: Benchmark
+        run: npm run benchmark --concurrency 1
+        env:
+          GRAFANA_API_KEY: ${{ secrets.GRAFANA_API_KEY }}

.github/workflows/performance-regression.yaml

@@ -0,0 +1,64 @@
+name: Performance Regression Test
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  benchmark:
+    name: Time benchmark
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          path: pr
+
+      - uses: actions/checkout@v3
+        with:
+          ref: main
+          path: main
+
+      - name: Setup antlr4
+        uses: ./main/.github/actions/setup-antlr4
+
+      - name: Install dependencies with frozen lock file for main branch
+        run: npm ci
+        working-directory: main
+
+      - name: Install dependencies with frozen lock file for pr branch
+        run: npm ci
+        working-directory: pr
+
+      - name: Build project for main
+        env:
+          NODE_OPTIONS: '--max_old_space_size=4096'
+        run: npm run build
+        working-directory: main
+
+      - name: Build project for pr
+        env:
+          NODE_OPTIONS: '--max_old_space_size=4096'
+        run: npm run build
+        working-directory: pr
+
+      - name: Run benchmark on main (baseline)
+        run: npm run benchmark | tee main-benchmarks.txt
+        working-directory: main/packages/language-support
+
+      - name: Run benchmark on pr
+        run: npm run benchmark | tee pr-benchmarks.txt
+        working-directory: pr/packages/language-support
+
+      - name: Compare benchmark result
+        uses: openpgpjs/github-action-pull-request-benchmark@v1
+        with:
+          name: 'Time benchmark'
+          tool: 'benchmarkjs'
+          pr-benchmark-file-path: pr/packages/language-support/pr-benchmarks.txt
+          base-benchmark-file-path: main/packages/language-support/main-benchmarks.txt
+          comment-on-alert: true
+          alert-threshold: '130%'
+          fail-on-alert: true
+          fail-threshold: '150%'
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -15,4 +15,5 @@ generated
 *.jar
 *.clinic
 *.tsbuildinfo
-*.npmrc
+*.npmrc
+benchmarks.txt

.nvmrc

@@ -0,0 +1 @@
+18.18.2

package.json

@@ -23,7 +23,12 @@
     "dev-codemirror": "turbo run @neo4j-cypher/react-codemirror-playground#dev",
     "lint": "eslint . --ext .ts",
     "lint-fix": "eslint . --fix --ext .ts",
-    "format": "prettier --config .prettierrc.json '**/*.ts' --write"
+    "format": "prettier --config .prettierrc.json '**/*.ts' --write",
+    "benchmark": "turbo run benchmark --concurrency=1"
+  },
+  "engineStrict": true,
+  "engines": {
+    "node": ">=18.18.2"
   },
   "devDependencies": {
     "@changesets/cli": "^2.26.2",

packages/language-support/package.json

@@ -52,11 +52,14 @@
     "build-types": "tsc --emitDeclarationOnly --outDir dist/types",
     "build-esm": "esbuild ./src/index.ts --bundle --format=esm --sourcemap --outfile=dist/esm/index.mjs",
     "build-commonjs": "esbuild ./src/index.ts --bundle --format=cjs --sourcemap --outfile=dist/cjs/index.cjs",
+    "benchmark": "esbuild ./src/tests/benchmarks/benchmark.ts --bundle --outfile=dist/benchmark/benchmark.js && BENCHMARKING=true node dist/benchmark/benchmark.js",
     "clean": "rm -rf {dist,src/generated-parser}",
     "watch": "tsc -b -w",
     "test": "jest"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.5"
+    "@types/benchmark": "^2.1.5",
+    "@types/jest": "^29.5.5",
+    "benchmark": "^2.1.4"
   }
 }

packages/language-support/src/parserWrapper.ts

@@ -220,7 +220,8 @@ class ParserWrapper {
   parse(query: string): EnrichedParsingResult {
     if (
       this.parsingResult !== undefined &&
-      this.parsingResult.query === query
+      this.parsingResult.query === query &&
+      process.env.BENCHMARKING !== 'true'
     ) {
       return this.parsingResult;
     } else {