chore(infra): integrate with codespeed (#214)

Co-authored-by: Wei <[email protected]>

.github/workflows/test-ubuntu.yml

@@ -98,10 +98,18 @@ jobs:
         if: steps.changes.outputs.changed == 'true'
         run: pnpm install && cd ./tests && npx playwright install
 
-      - name: Features Integration Test (Vitest)
+      - name: Integration Test (Vitest)
         if: steps.changes.outputs.changed == 'true'
         run: pnpm run test:integration
 
-      - name: Examples E2E Test (Playwright)
+      - name: E2E Test (Playwright)
         if: steps.changes.outputs.changed == 'true'
         run: pnpm run test:e2e
+
+      # only run benchmark in Ubuntu 
+      - name: Benchmarks (Vitest)
+        uses: CodSpeedHQ/action@v3
+        with:
+          run: pnpm run test:benchmark
+          # token retrieved from the CodSpeed app at the previous step
+          token: ${{ secrets.CODSPEED_TOKEN }}

.github/workflows/test-windows.yml

@@ -103,15 +103,14 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'pnpm'
-
       - name: Install Dependencies
         if: steps.changes.outputs.changed == 'true'
         run: pnpm install && cd ./tests && npx playwright install
 
-      - name: Features Integration Test (Vitest)
+      - name: Integration Test (Vitest)
         if: steps.changes.outputs.changed == 'true'
         run: pnpm run test:integration
 
-      - name: Examples E2E Test (Playwright)
+      - name: E2E Test (Playwright)
         if: steps.changes.outputs.changed == 'true'
         run: pnpm run test:e2e

package.json

@@ -18,6 +18,7 @@
     "prepare": "pnpm run build && simple-git-hooks",
     "sort-package-json": "npx sort-package-json \"packages/*/package.json\"",
     "test": "pnpm run test:unit && pnpm run test:integration && pnpm run test:e2e",
+    "test:benchmark": "cd ./tests && pnpm run test:benchmark",
     "test:e2e": "pnpm run build:examples && cd tests && pnpm run test:e2e",
     "test:integration": "vitest run --project integration",
     "test:integration:watch": "vitest --project integration",

scripts/dictionary.txt

@@ -14,6 +14,7 @@ cjsx
 classname
 codegen
 codesandbox
+codspeed
 compat
 consolas
 contentful

tests/benchmark/index.bench.ts

@@ -0,0 +1,21 @@
+import { getCwdByExample, rslibBuild } from 'test-helper';
+import { bench, describe } from 'vitest';
+
+describe('run rslib in examples', () => {
+  bench(
+    'examples/express-plugin',
+    async () => {
+      const cwd = getCwdByExample('express-plugin');
+      await rslibBuild(cwd);
+    },
+    { time: 5 },
+  );
+  bench(
+    'examples/react-component',
+    async () => {
+      const cwd = getCwdByExample('react-component');
+      await rslibBuild(cwd);
+    },
+    { time: 5 },
+  );
+});

tests/package.json

@@ -3,6 +3,7 @@
   "private": true,
   "type": "module",
   "scripts": {
+    "test:benchmark": "vitest bench",
     "test:e2e": "playwright test --pass-with-no-tests"
   },
   "dependencies": {
@@ -11,6 +12,7 @@
     "react-dom": "^18.3.1"
   },
   "devDependencies": {
+    "@codspeed/vitest-plugin": "^3.1.1",
     "@playwright/test": "1.47.2",
     "@rsbuild/core": "1.0.7",
     "@rsbuild/plugin-react": "1.0.2",

tests/scripts/shared.ts

@@ -1,5 +1,6 @@
 import fs from 'node:fs';
-import { join } from 'node:path';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import {
   type InspectConfigResult,
   mergeRsbuildConfig as mergeConfig,
@@ -8,6 +9,13 @@ import type { Format, LibConfig, RslibConfig } from '@rslib/core';
 import { build, loadConfig } from '@rslib/core';
 import { globContentJSON } from './helper';
 
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+export function getCwdByExample(exampleName: string) {
+  return join(__dirname, '../../examples', exampleName);
+}
+
 export function generateBundleEsmConfig(config: LibConfig = {}): LibConfig {
   const esmBasicConfig: LibConfig = {
     format: 'esm',
@@ -136,6 +144,15 @@ export async function getResults(
   };
 }
 
+export async function rslibBuild(fixturePath: string) {
+  const rslibConfig = await loadConfig({
+    cwd: fixturePath,
+  });
+  process.chdir(fixturePath);
+  const rsbuildInstance = await build(rslibConfig);
+  return { rsbuildInstance, rslibConfig };
+}
+
 export async function buildAndGetResults(
   fixturePath: string,
   type: 'all',
@@ -152,11 +169,7 @@ export async function buildAndGetResults(
   fixturePath: string,
   type: 'js' | 'dts' | 'css' | 'all' = 'js',
 ) {
-  const rslibConfig = await loadConfig({
-    cwd: fixturePath,
-  });
-  process.chdir(fixturePath);
-  const rsbuildInstance = await build(rslibConfig);
+  const { rsbuildInstance, rslibConfig } = await rslibBuild(fixturePath);
   const {
     origin: { bundlerConfigs, rsbuildConfig },
   } = await rsbuildInstance.inspectConfig({ verbose: true });

tests/tsconfig.json

@@ -4,7 +4,12 @@
     "noEmit": true,
     "composite": true
   },
-  "include": ["cases/**/*.ts", "playwright.config.ts", "scripts"],
+  "include": [
+    "e2e/cases/**/*.ts",
+    "benchmark/**/*.ts",
+    "playwright.config.ts",
+    "scripts"
+  ],
   "exclude": ["**/node_modules", "**/.*/"],
   "references": [
     {

tests/vitest.config.ts

@@ -1,3 +1,4 @@
+import codspeedPlugin from '@codspeed/vitest-plugin';
 import { defineConfig } from 'vitest/config';
 import { shared } from '../vitest.workspace';
 
@@ -8,5 +9,9 @@ export default defineConfig({
     setupFiles: ['./setupVitestTests.ts'],
     include: ['./integration/**/*.test.ts'],
     exclude: ['**/node_modules/**'],
+    benchmark: {
+      include: ['./benchmark/**/*.bench.ts'],
+    },
   },
+  plugins: [codspeedPlugin()],
 });