Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/nodejs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,8 @@ jobs:
- run: npm test
env:
CI: true
- name: Run benchmarks (non-blocking)
run: npm run bench
continue-on-error: true
env:
CI: true
2,579 changes: 646 additions & 1,933 deletions package-lock.json

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,20 +43,22 @@
"test:deno": "deno test --config deno/tsconfig.json deno/test.ts",
"test": "npm run lint && npm run compile && vitest run --coverage",
"vitest": "vitest run --coverage",
"bench": "vitest bench --run",
"dev": "vitest"
},
"devDependencies": {
"@featherscloud/pinion": "^0.5.5",
"@typescript-eslint/eslint-plugin": "^8.38.0",
"@typescript-eslint/parser": "^8.38.0",
"@vitest/coverage-v8": "^3.2.4",
"@vitest/coverage-v8": "^5.0.5",
"eslint": "^9.32.0",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-prettier": "^5.5.3",
"lerna": "^8.2.3",
"npm-check-updates": "^18.0.2",
"prettier": "^3.6.2",
"typescript": "^5.8.0",
"vitest": "^3.2.4"
"vite": "^7.3.7",
"vitest": "^5.0.5"
}
}
4 changes: 1 addition & 3 deletions packages/create-feathers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,8 @@
"gitHead": "90caf635aec850550b9d37bea2762af959d9e8d5",
"devDependencies": {
"@types/node": "^24.1.0",
"@vitest/coverage-v8": "^5.0.0",
"shx": "^0.4.0",
"typescript": "^7.0.2",
"vitest": "^5.0.0"
"typescript": "^7.0.2"
},
"dependencies": {
"@featherscloud/pinion": "^0.5.7",
Expand Down
4 changes: 1 addition & 3 deletions packages/feathers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,8 @@
},
"devDependencies": {
"@types/node": "^25.5.0",
"@vitest/coverage-v8": "^5.0.0",
"shx": "^0.4.0",
"typescript": "^7.0.2",
"vitest": "^5.0.0"
"typescript": "^7.0.2"
},
"gitHead": "5796fdf52a5ca94f993fe3c588767b75534d2e09"
}
55 changes: 55 additions & 0 deletions packages/feathers/src/hooks/benchmark.bench.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import { describe, expect, test } from 'vitest'
import { HookContext, hooks, middleware, NextFunction } from './index.js'

// A hooked function must not be more than this many times slower than the plain function
const MAX_OVERHEAD = 10
// The iterations of compared benchmarks are interleaved so system load affects them equally
const RUN_OPTIONS = { time: 500, warmupTime: 100 }

const hello = async (name: string, _params: any = {}) => {
return `Hello ${name}`
}

const benchmarks = [
['empty hook', hooks(hello, middleware([]))],
[
'single simple hook',
hooks(
hello,
middleware([
async (_ctx: HookContext, next: NextFunction) => {
await next()
}
])
)
],
[
'single hook, withParams and props',
hooks(
hello,
middleware([
async (_ctx: HookContext, next: NextFunction) => {
await next()
}
])
.params('name')
.props({ dave: true })
)
]
] as const

describe('feathers/hooks benchmark', () => {
for (const [name, hookHello] of benchmarks) {
test(name, async ({ bench }) => {
const results = await bench.compare(
bench('baseline', () => hello('Dave')),
bench(name, () => hookHello('Dave')),
RUN_OPTIONS
)
// Compare the medians since single garbage collection pauses skew the mean
const overhead = results.get(name).latency.p50 / results.get('baseline').latency.p50

expect(overhead).toBeLessThan(MAX_OVERHEAD)
})
}
})
65 changes: 0 additions & 65 deletions packages/feathers/src/hooks/benchmark.test.ts

This file was deleted.

2 changes: 1 addition & 1 deletion packages/feathers/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"extends": "../../tsconfig",
"include": ["src/**/*.ts"],
"exclude": ["src/**/*.test.ts", "src/**/test/**"],
"exclude": ["src/**/*.test.ts", "src/**/*.bench.ts", "src/**/test/**"],
"compilerOptions": {
"rootDir": "src",
"outDir": "lib",
Expand Down
14 changes: 13 additions & 1 deletion vitest.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,22 @@ import { defineConfig } from 'vitest/config'
export default defineConfig({
test: {
include: ['packages/**/src/**/*.{test,spec}.{js,ts,tsx,jsx}'],
benchmark: {
include: ['packages/**/src/**/*.bench.ts']
},
coverage: {
provider: 'v8',
include: ['packages/*/src/**/*.{js,ts,tsx,jsx}'],
exclude: ['**/*.test.{js,ts,tsx,jsx}', '**/*.spec.{js,ts,tsx,jsx}', '**/node_modules/**', '**/lib/**', '**/dist/**', '**/*.d.ts', '**/fixtures/**'],
exclude: [
'**/*.test.{js,ts,tsx,jsx}',
'**/*.spec.{js,ts,tsx,jsx}',
'**/*.bench.ts',
'**/node_modules/**',
'**/lib/**',
'**/dist/**',
'**/*.d.ts',
'**/fixtures/**'
],
reporter: ['text', 'html', 'lcov']
}
}
Expand Down
Loading