Repository navigation
ci: add benchmark workflow #150
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| name: benchmark | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
|
|
||
| env: | ||
| pnpm_config_dangerously_allow_all_builds: true | ||
| SKIP_INSTALL_SIMPLE_GIT_HOOKS: true | ||
|
|
||
| jobs: | ||
| benchmark: | ||
| name: Benchmark | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout head | ||
| uses: actions/checkout@v7 | ||
| with: | ||
| path: head | ||
| persist-credentials: false | ||
| - name: Checkout base | ||
| uses: actions/checkout@v7 | ||
| with: | ||
| ref: ${{ github.event.pull_request.base.sha }} | ||
| path: base | ||
| persist-credentials: false | ||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v7 | ||
| with: | ||
| node-version: lts/* | ||
| - name: Setup PNPM | ||
| uses: pnpm/action-setup@v6 | ||
| with: | ||
| version: latest | ||
| - name: Install head | ||
| working-directory: head | ||
| run: pnpm install | ||
| - name: Install base | ||
| working-directory: base | ||
| run: | | ||
| [ -f benchmark/index.js ] || exit 0 | ||
| pnpm install || { | ||
| echo "::warning::base install failed, comparing without it" | ||
| rm benchmark/index.js | ||
| } | ||
| - name: Run base and head alternately | ||
| env: | ||
| ROUNDS: 5 | ||
| run: | | ||
| set -euo pipefail | ||
| mkdir -p results | ||
| run_side () { | ||
| if [ "$1" = base ] && [ ! -f base/benchmark/index.js ]; then return 0; fi | ||
| if (cd "$1" && node benchmark/index.js) && [ -f "$1/benchmark-output.json" ]; then | ||
| mv "$1/benchmark-output.json" "results/$1-$2.json" | ||
| elif [ "$1" = base ]; then | ||
| echo "::warning::base benchmark failed in round $2, comparing without it" | ||
| else | ||
| exit 1 | ||
| fi | ||
| } | ||
| for round in $(seq "$ROUNDS"); do | ||
| if [ $((round % 2)) -eq 1 ]; then run_side base "$round"; run_side head "$round" | ||
| else run_side head "$round"; run_side base "$round"; fi | ||
| done | ||
| - name: Compare | ||
| env: | ||
| NAME: cacheable-response | ||
| BASE_SHA: ${{ github.event.pull_request.base.sha }} | ||
| run: | | ||
| node - <<'EOF' | ||
| const { readdirSync, readFileSync, writeFileSync, mkdirSync, appendFileSync } = require('fs') | ||
| const median = values => { | ||
| const sorted = [...values].sort((a, b) => a - b) | ||
| const middle = sorted.length >> 1 | ||
| return sorted.length % 2 ? sorted[middle] : (sorted[middle - 1] + sorted[middle]) / 2 | ||
| } | ||
| const round = value => Number(value.toFixed(2)) | ||
| const readSide = side => | ||
| readdirSync('results') | ||
| .filter(file => file.startsWith(`${side}-`)) | ||
| .map(file => JSON.parse(readFileSync(`results/${file}`, 'utf8'))) | ||
| const merge = runs => { | ||
| const names = [...new Set(runs.flatMap(run => run.map(result => result.name)))] | ||
| return names.map(name => { | ||
| const matches = runs.flatMap(run => run.filter(result => result.name === name)) | ||
| const values = matches.map(result => result.value) | ||
| return { | ||
| name, | ||
| unit: matches[0].unit, | ||
| value: round(median(values)), | ||
| range: `${round(Math.min(...values))}-${round(Math.max(...values))}`, | ||
| extra: `median of ${values.length} rounds: ${values.join(', ')}` | ||
| } | ||
| }) | ||
| } | ||
| const head = merge(readSide('head')) | ||
| const baseRuns = readSide('base') | ||
| const base = baseRuns.length ? merge(baseRuns) : [] | ||
| writeFileSync('head-output.json', JSON.stringify(head, null, 2)) | ||
| mkdirSync('cache', { recursive: true }) | ||
| const seed = base.length | ||
| ? { [process.env.NAME]: [{ commit: { id: process.env.BASE_SHA }, date: Date.now(), tool: 'customSmallerIsBetter', benches: base }] } | ||
| : {} | ||
| writeFileSync('cache/benchmark-data.json', JSON.stringify({ lastUpdate: Date.now(), repoUrl: '', entries: seed })) | ||
| const rows = head.map(current => { | ||
| const previous = base.find(result => result.name === current.name) | ||
| const ratio = previous ? (current.value / previous.value).toFixed(2) : '' | ||
| const format = result => (result ? `${result.value} ${result.unit}` : '') | ||
| return `| \`${current.name}\` | ${format(previous)} | ${format(current)} | ${ratio} |` | ||
| }) | ||
| const summary = ['| case | base | head | head/base |', '|-|-|-|-|', ...rows].join('\n') | ||
| console.log(summary) | ||
| appendFileSync(process.env.GITHUB_STEP_SUMMARY, summary + '\n') | ||
| EOF | ||
| - name: Comment | ||
| if: github.event.pull_request.head.repo.full_name == github.repository | ||
| uses: benchmark-action/github-action-benchmark@v1.22.2 | ||
| with: | ||
| name: cacheable-response | ||
| tool: customSmallerIsBetter | ||
| output-file-path: head-output.json | ||
| external-data-json-path: cache/benchmark-data.json | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| auto-push: false | ||
| comment-always: true | ||
| comment-on-alert: false | ||
| fail-on-alert: false | ||
| summary-always: false | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,3 +35,6 @@ coverage | |
| .env | ||
| .envrc | ||
| .envrc | ||
| benchmark-output.json | ||
| head-output.json | ||
| cache/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| 'use strict' | ||
|
|
||
| const { writeFileSync } = require('fs') | ||
| const { join } = require('path') | ||
| const { setFlagsFromString } = require('v8') | ||
| const { runInNewContext } = require('vm') | ||
|
|
||
| const cacheableResponse = require('..') | ||
|
|
||
| const RUNS = 7 | ||
| const HIT_REQUESTS = 20_000 | ||
| const MISS_REQUESTS = 10_000 | ||
| const NOT_MODIFIED_REQUESTS = 20_000 | ||
| const COMPRESSED_REQUESTS = 2_000 | ||
| const SMALL_PAGE_SECTIONS = 2 | ||
| const LARGE_PAGE_SECTIONS = 200 | ||
|
|
||
| setFlagsFromString('--expose-gc') | ||
| const collectGarbage = runInNewContext('gc') | ||
|
|
||
| const now = () => process.hrtime.bigint() | ||
|
|
||
| const elapsed = started => Number(now() - started) / 1e6 | ||
|
|
||
| const median = values => { | ||
| const sorted = values.slice().sort((a, b) => a - b) | ||
| return sorted[Math.floor(sorted.length / 2)] | ||
| } | ||
|
Kikobeats marked this conversation as resolved.
Resolved
|
||
|
|
||
| const createPage = sections => | ||
| Array.from( | ||
| { length: sections }, | ||
| (_, section) => | ||
| `<section id="s${section}"><h2>Section ${section}</h2><p>Lorem ipsum dolor sit amet ${section}</p></section>` | ||
| ).join('') | ||
|
|
||
| const SMALL_PAGE = createPage(SMALL_PAGE_SECTIONS) | ||
| const LARGE_PAGE = createPage(LARGE_PAGE_SECTIONS) | ||
|
|
||
| const createRequest = (url, headers = {}) => ({ url, headers }) | ||
|
|
||
| const createResponse = () => { | ||
| const response = { | ||
| statusCode: 200, | ||
| writableEnded: false, | ||
| headers: {}, | ||
| body: undefined, | ||
| setHeader: (name, value) => { | ||
| response.headers[name.toLowerCase()] = value | ||
| }, | ||
| end: body => { | ||
| response.body = body | ||
| response.writableEnded = true | ||
| } | ||
| } | ||
| return response | ||
| } | ||
|
|
||
| const createHandler = ({ page = SMALL_PAGE, ...options } = {}) => | ||
| cacheableResponse({ | ||
| get: ({ req }) => ({ data: `${req.url}${page}` }), | ||
| send: ({ data, res }) => res.end(data), | ||
| ...options | ||
| }) | ||
|
|
||
| const serve = async (handler, url, headers) => { | ||
| const res = createResponse() | ||
| await handler({ req: createRequest(url, headers), res }) | ||
| return res | ||
| } | ||
|
|
||
| const serveSequentially = async (handler, urlOf, count, headersOf) => { | ||
| const tally = { statuses: {}, codes: {}, bytes: 0 } | ||
| for (let request = 0; request < count; request++) { | ||
| const res = await serve(handler, urlOf(request), headersOf?.(request)) | ||
| const status = res.headers['x-cache-status'] | ||
| tally.statuses[status] = (tally.statuses[status] || 0) + 1 | ||
| tally.codes[res.statusCode] = (tally.codes[res.statusCode] || 0) + 1 | ||
| if (res.statusCode === 200) tally.bytes += res.body.length | ||
| } | ||
| return tally | ||
| } | ||
|
|
||
| const pageBytes = (url, page = SMALL_PAGE) => url.length + page.length | ||
|
|
||
| const HIT_URL = '/blog/post?utm_source=newsletter&page=2' | ||
|
|
||
| const hitCase = { | ||
| name: 'cache hit', | ||
| extra: `${HIT_REQUESTS} requests for one cached URL`, | ||
| setup: async state => { | ||
| state.handler = createHandler() | ||
| await serve(state.handler, HIT_URL) | ||
| }, | ||
| timed: state => | ||
| serveSequentially(state.handler, () => HIT_URL, HIT_REQUESTS), | ||
| verify: ({ statuses, bytes }) => | ||
| statuses.HIT === HIT_REQUESTS && | ||
| bytes === HIT_REQUESTS * pageBytes(HIT_URL) | ||
| } | ||
|
|
||
| const missCase = { | ||
| name: 'cache miss', | ||
| extra: `${MISS_REQUESTS} requests for distinct URLs into an empty cache`, | ||
| setup: () => {}, | ||
| timed: () => | ||
| serveSequentially( | ||
| createHandler(), | ||
| request => `/item/${request}?ref=home`, | ||
| MISS_REQUESTS | ||
| ), | ||
| verify: ({ statuses, bytes }) => | ||
| statuses.MISS === MISS_REQUESTS && | ||
| bytes > MISS_REQUESTS * SMALL_PAGE.length | ||
| } | ||
|
|
||
| const notModifiedCase = { | ||
| name: 'cache hit 304 via If-None-Match', | ||
| extra: `${NOT_MODIFIED_REQUESTS} conditional requests for one cached URL`, | ||
| setup: async state => { | ||
| state.handler = createHandler() | ||
| const res = await serve(state.handler, HIT_URL) | ||
| state.headers = { 'if-none-match': res.headers.etag } | ||
| }, | ||
| timed: state => | ||
| serveSequentially( | ||
| state.handler, | ||
| () => HIT_URL, | ||
| NOT_MODIFIED_REQUESTS, | ||
| () => state.headers | ||
| ), | ||
| verify: ({ statuses, codes }) => | ||
| statuses.HIT === NOT_MODIFIED_REQUESTS && | ||
| codes[304] === NOT_MODIFIED_REQUESTS | ||
| } | ||
|
|
||
| const compressedHitCase = { | ||
| name: 'cache hit with brotli compression', | ||
| extra: `${COMPRESSED_REQUESTS} requests decompressing a ${LARGE_PAGE.length} byte page`, | ||
| setup: async state => { | ||
| state.handler = createHandler({ compress: true, page: LARGE_PAGE }) | ||
| await serve(state.handler, HIT_URL) | ||
| }, | ||
| timed: state => | ||
| serveSequentially(state.handler, () => HIT_URL, COMPRESSED_REQUESTS), | ||
| verify: ({ statuses, bytes }) => | ||
| statuses.HIT === COMPRESSED_REQUESTS && | ||
| bytes === COMPRESSED_REQUESTS * pageBytes(HIT_URL, LARGE_PAGE) | ||
| } | ||
|
|
||
| const CASES = [hitCase, missCase, notModifiedCase, compressedHitCase] | ||
|
|
||
| const fmt = value => value.toFixed(1) | ||
|
|
||
| const report = slot => { | ||
| const med = slot.walls.length ? median(slot.walls) : Number.NaN | ||
| const min = slot.walls.length ? Math.min(...slot.walls) : Number.NaN | ||
| const max = slot.walls.length ? Math.max(...slot.walls) : Number.NaN | ||
| const extra = `${slot.entry.extra}, errors ${slot.errors}, runs ${RUNS}` | ||
| console.log( | ||
| `${slot.entry.name} median ${fmt(med)}ms range ${fmt(min)}-${fmt( | ||
| max | ||
| )} ${extra}` | ||
| ) | ||
| return { | ||
| name: slot.entry.name, | ||
| unit: 'ms', | ||
| value: Number(med.toFixed(1)), | ||
| range: `${fmt(min)}-${fmt(max)}`, | ||
| extra | ||
| } | ||
| } | ||
|
|
||
| const takeSample = async (slot, run) => { | ||
| try { | ||
| collectGarbage() | ||
| const started = now() | ||
| const outcome = await slot.entry.timed(slot.state) | ||
| const wall = elapsed(started) | ||
| if (!slot.entry.verify(outcome)) { | ||
| console.error(`${slot.entry.name} run ${run} produced unexpected output`) | ||
| slot.errors++ | ||
| return | ||
| } | ||
| slot.walls.push(wall) | ||
| } catch (error) { | ||
| console.error(error) | ||
| slot.errors++ | ||
| } | ||
| } | ||
|
|
||
| const main = async () => { | ||
| const slots = [] | ||
| for (const entry of CASES) { | ||
| const state = {} | ||
| await entry.setup(state) | ||
| await entry.timed(state) | ||
| slots.push({ entry, state, walls: [], errors: 0 }) | ||
| } | ||
| for (let run = 0; run < RUNS; run++) { | ||
| for (const slot of slots) await takeSample(slot, run) | ||
| } | ||
| const results = slots.map(report) | ||
| writeFileSync( | ||
| join(__dirname, '..', 'benchmark-output.json'), | ||
| JSON.stringify(results, null, 2) + '\n' | ||
| ) | ||
| const errors = slots.reduce((total, slot) => total + slot.errors, 0) | ||
| if (errors > 0 || results.some(result => !Number.isFinite(result.value))) { | ||
| process.exitCode = 1 | ||
| } | ||
| } | ||
|
|
||
| main().catch(error => { | ||
| console.error(error) | ||
| process.exit(1) | ||
| }) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.