Skip to content

Commit 7e872b6

Browse files
wesleytoddwesleytodd
committed
WIP: convert to local runner
1 parent 8787274 commit 7e872b6

File tree

11 files changed

+416
-1133
lines changed

11 files changed

+416
-1133
lines changed

‎package-lock.json‎

Lines changed: 16 additions & 1128 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/autocannon/index.mjs‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { spawnSync, spawn } from 'node:child_process';
12
import autocannon from 'autocannon';
23

34
export function run (opts) {
@@ -30,3 +31,51 @@ export default async function main (_opts = {}) {
3031

3132
return run(opts);
3233
}
34+
35+
export class AutocannonBenchmarker {
36+
constructor() {
37+
const shell = (process.platform === 'win32');
38+
this.name = 'autocannon';
39+
this.opts = { shell };
40+
this.executable = shell ? 'autocannon.cmd' : 'autocannon';
41+
const result = spawnSync(this.executable, ['-h'], this.opts);
42+
if (shell) {
43+
this.present = (result.status === 0);
44+
} else {
45+
this.present = !(result.error && result.error.code === 'ENOENT');
46+
}
47+
}
48+
49+
create(options) {
50+
const args = [
51+
'-d', options.duration,
52+
'-c', options.connections,
53+
'-j',
54+
'-n',
55+
];
56+
for (const field in options.headers) {
57+
if (this.opts.shell) {
58+
args.push('-H', `'${field}=${options.headers[field]}'`);
59+
} else {
60+
args.push('-H', `${field}=${options.headers[field]}`);
61+
}
62+
}
63+
const scheme = options.scheme || 'http';
64+
args.push(`${scheme}://127.0.0.1:${options.port}${options.path}`);
65+
const child = spawn(this.executable, args, this.opts);
66+
return child;
67+
}
68+
69+
processResults(output) {
70+
let result;
71+
try {
72+
result = JSON.parse(output);
73+
} catch {
74+
return undefined;
75+
}
76+
if (!result || !result.requests || !result.requests.average) {
77+
return undefined;
78+
}
79+
return result.requests.average;
80+
}
81+
}

‎packages/cli/load.mjs‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export function help (opts = {}) {
1111
Flags:
1212
1313
--cwd=${opts.cwd || normalize(join(import.meta.dirname, '..', '..'))}
14-
--runner=@expressjs/perf-runner-vanilla
14+
--runner=@expressjs/perf-runner-local
1515
--repo=https://github.com/expressjs/perf-wg.git
1616
--repo-ref=master
1717
--test=@expressjs/perf-load-example
@@ -53,9 +53,9 @@ export default function main (_opts = {}) {
5353

5454
const opts = {
5555
cwd,
56-
repo: 'https://github.com/expressjs/perf-wg.git',
57-
repoRef: 'master',
58-
runner: '@expressjs/perf-runner-vanilla',
56+
repo: null, // 'https://github.com/expressjs/perf-wg.git',
57+
repoRef: null, // 'master',
58+
runner: '@expressjs/perf-runner-local',
5959
test: '@expressjs/perf-load-example',
6060
node: 'lts_latest',
6161
...conf,
@@ -109,6 +109,11 @@ export default function main (_opts = {}) {
109109
const vers = await nv(opts.node, {
110110
latestOfMajorOnly: true
111111
});
112+
if (!vers?.[0]?.version) {
113+
throw Object.assign(new Error(`Unable to resolve node version`), {
114+
spec: opts.node
115+
});
116+
}
112117

113118
const results = await runner({
114119
cwd: opts.cwd,

‎packages/runner-local-docker/scripts/start.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ node metadata.mjs > ./results/metadata.json
1616
# If not, require a repo and ref
1717
REPO_DIR="./repo"
1818
if [ -d "$REPO_DIR" ]; then
19-
echo "Using local benchmarks"
19+
echo "Using local repo."
2020
cd "$REPO_DIR"
2121
else
2222
if [ -z "$REPO" ]; then

‎packages/runner-local/client.mjs‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
import { styleText } from 'node:util';
2+
import { AutocannonBenchmarker } from '@expressjs/perf-autocannon';
3+
import { Wrk2Benchmarker } from '@expressjs/perf-wrk2';
4+
5+
function runBenchmarker(instance, options) {
6+
console.log(styleText(['blue'], `Running ${instance.name} load...`));
7+
return new Promise((resolve, reject) => {
8+
const proc = instance.create(options);
9+
proc.stderr.pipe(process.stderr);
10+
11+
let stdout = '';
12+
proc.stdout.setEncoding('utf8');
13+
proc.stdout.on('data', (chunk) => stdout += chunk);
14+
15+
proc.once('close', (code) => {
16+
if (code) {
17+
let error_message = `${instance.name} failed with ${code}.`;
18+
if (stdout !== '') {
19+
error_message += ` Output: ${stdout}`;
20+
}
21+
reject(new Error(error_message), code);
22+
return;
23+
}
24+
25+
const result = instance.processResults(stdout);
26+
resolve(result);
27+
});
28+
})
29+
}
30+
31+
32+
export async function startClient (opts = {}) {
33+
if (opts.signal.aborted) {
34+
return;
35+
}
36+
37+
const autocannon = new AutocannonBenchmarker();
38+
const wrk2 = new Wrk2Benchmarker();
39+
const waitFor = [];
40+
41+
if (!wrk2.present) {
42+
console.log(styleText(['bold', 'yellow'], 'Wrk2 not found. Please install it'));
43+
} else {
44+
waitFor.push(
45+
runBenchmarker(wrk2, {
46+
duration: 30,
47+
connections: 100,
48+
rate: 2000,
49+
port: 3000,
50+
path: '/'
51+
})
52+
);
53+
console.log('Running Wrk2');
54+
}
55+
56+
if (!autocannon.present) {
57+
console.log(styleText(['bold', 'yellow'], 'Autocannon not found. Please install it with `npm i -g autocannon`'));
58+
} else {
59+
waitFor.push(
60+
runBenchmarker(autocannon, {
61+
duration: 30,
62+
connections: 100,
63+
port: 3000,
64+
path: '/',
65+
})
66+
);
67+
console.log('Running Autocannon');
68+
}
69+
70+
return {
71+
metadata: {},
72+
close: async () => {
73+
// TODO: need to get the client classes into order for this
74+
},
75+
results: () => {
76+
return Promise.allSettled(waitFor);
77+
}
78+
};
79+
}

‎packages/runner-local/index.mjs‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
import { dirname } from 'node:path';
2+
import { fileURLToPath } from 'node:url';
3+
4+
import { setup, cleanup } from './setup.mjs';
5+
import { startServer } from './server.mjs';
6+
import { startClient } from './client.mjs';
7+
8+
export default async function runner (_opts = {}) {
9+
// Start up the server, then the client
10+
const opts = {
11+
..._opts
12+
};
13+
14+
const cwd = fileURLToPath(dirname(import.meta.resolve(opts.test)));
15+
await setup(cwd, opts);
16+
17+
const server = await startServer(cwd, opts);
18+
const client = await startClient(opts, server);
19+
20+
// Wait for the client to finish, then the server
21+
const clientResults = await client.results();
22+
const serverResults = await server.results();
23+
24+
await client.close();
25+
await server.close();
26+
27+
await cleanup(cwd);
28+
29+
return {
30+
serverMetadata: server.metadata,
31+
clientMetadata: client.metadata,
32+
serverResults,
33+
clientResults
34+
};
35+
}

‎packages/runner-local/package.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"name": "@expressjs/perf-runner-local",
3+
"version": "1.0.0",
4+
"description": "",
5+
"main": "index.mjs",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"keywords": [],
10+
"author": "",
11+
"license": "ISC",
12+
"dependencies": {
13+
"@expressjs/perf-autocannon": "^1.0.0",
14+
"@expressjs/perf-wrk2": "^1.0.0"
15+
}
16+
}

‎packages/runner-local/server.mjs‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
import { execFile } from 'node:child_process';
2+
import { fileURLToPath } from 'node:url';
3+
4+
export async function startServer (cwd, opts = {}) {
5+
if (opts?.signal.aborted) {
6+
return;
7+
}
8+
return new Promise((resolve, reject) => {
9+
const test = fileURLToPath(import.meta.resolve(opts.test));
10+
const cp = execFile(process.execPath, [ test ], { cwd });
11+
12+
const server = {
13+
metadata: {
14+
url: new URL('http://localhost:3000'),
15+
},
16+
status: 'starting',
17+
close: () => {
18+
return new Promise((closeResolve) => {
19+
cp.on('exit', () => {
20+
closeResolve();
21+
});
22+
cp.kill('SIGINT');
23+
});
24+
},
25+
results: async () => {
26+
return { };
27+
}
28+
};
29+
30+
opts?.signal.addEventListener('abort', () => {
31+
server.status = 'aborted';
32+
cp.kill('SIGINT');
33+
reject(new Error('aborted'));
34+
});
35+
cp.on('error', reject);
36+
cp.stdout.on('data', (d) => {
37+
process.stdout.write(d);
38+
if (server.status === 'starting' && d.toString('utf8').includes("startup:")) {
39+
server.status = 'started';
40+
resolve(server);
41+
}
42+
});
43+
cp.stderr.on('data', (d) => {
44+
process.stderr.write(d);
45+
});
46+
});
47+
}

‎packages/runner-local/setup.mjs‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
import {
2+
rename,
3+
access,
4+
writeFile,
5+
rm,
6+
realpath,
7+
constants as fsConstants
8+
} from 'node:fs/promises';
9+
import { dirname, join } from 'node:path';
10+
import { promisify } from 'node:util';
11+
import { execFile } from 'node:child_process';
12+
13+
const pExecFile = promisify(execFile);
14+
15+
async function restore (cwd) {
16+
const pkgPath = join(cwd, 'package.json');
17+
const pkgBakPath = join(cwd, 'package.json.bak');
18+
try {
19+
await access(pkgBakPath, fsConstants.R_OK | fsConstants.W_OK);
20+
console.log('package.json.bak exists, restoring original');
21+
await rm(pkgPath);
22+
await rename(pkgBakPath, pkgPath, fsConstants.COPYFILE_FICLONE);
23+
} catch (e) {
24+
if (e.code !== 'ENOENT') {
25+
throw e;
26+
}
27+
}
28+
return { pkgPath, pkgBakPath };
29+
}
30+
31+
export async function setup (cwd, opts = {}) {
32+
// Ensure we have the right node version
33+
if (process.version !== `v${opts.node}`) {
34+
// TODO: install node with nvm?
35+
throw Object.assign(new Error(`Incorrect node.js version`), {
36+
wanted: opts.node,
37+
found: process.version.replace(/^v/, '')
38+
});
39+
}
40+
41+
// Setup the repo if asked
42+
if (!opts.repo) {
43+
console.log('Using local repo.');
44+
} else {
45+
// TODO: clone repo into tmp dir
46+
throw new Error('cloning repo not yet implemented');
47+
}
48+
49+
// Restore backup if necessary
50+
const { pkgPath, pkgBakPath } = await restore(cwd);
51+
52+
// Read in package.json contets
53+
const pkg = await import(pkgPath, {
54+
with: {
55+
type: 'json'
56+
}
57+
});
58+
59+
// Apply overrides
60+
if (opts.overrides) {
61+
await rename(pkgPath, pkgBakPath);
62+
pkg.overrides = {
63+
...(pkg.overrides ?? {}),
64+
...opts.overrides
65+
};
66+
await writeFile(pkgPath, JSON.stringify(pkg, null, 2));
67+
}
68+
69+
// node --run setup || npm run setup
70+
try {
71+
const nodePath = await realpath(process.execPath);
72+
await pExecFile(nodePath, ['--run', 'setup'], { cwd });
73+
} catch (e) {
74+
const npmPath = await realpath(join(dirname(process.execPath), 'npm'));
75+
await pExecFile(npmPath, ['run', 'setup'], { cwd });
76+
}
77+
78+
return { cwd };
79+
}
80+
81+
export async function cleanup (cwd) {
82+
await restore(cwd);
83+
await rm(join(cwd, 'package-lock.json'), {
84+
force: true
85+
});
86+
await rm(join(cwd, 'node_modules'), {
87+
force: true,
88+
recursive: true
89+
});
90+
}

0 commit comments

Comments
 (0)