1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
process.env.ARBORIST_DEBUG = '0'
const { Suite } = require('benchmark')
const { relative, resolve } = require('path')
const { mkdir, rm } = require('fs/promises')
const { execSync } = require('child_process')
const shaCmd = 'git show --no-patch --pretty=%H HEAD'
const dirty = !!String(execSync('git status -s -uno')).trim()
const currentSha = String(execSync(shaCmd)).trim() + (dirty ? '-dirty' : '')
const { green, red } = require('chalk')
const lastBenchmark = resolve(__dirname, 'benchmark/saved/last-benchmark.json')
const { linkSync, writeFileSync, readdirSync } = require('fs')
const registryServer = require('../test/fixtures/registry-mocks/server.js')
const options = {
previous: null,
warnRange: 5,
cache: resolve(__dirname, 'benchmark/cache'),
// save it to a specific name, so you can do stuff like this:
//
// node scripts/benchmark.js --save=without-foobles
// ... put foobles in ...
// node scripts/benchmark.js --previous=without-foobles --save=with-foobles
save: String(execSync('git branch --show-current'))
.trim()
.replace(/\.|\//, '-') + (dirty ? '-dirty' : ''),
}
const allSuites = readdirSync(resolve(__dirname, 'benchmark'))
.filter(f => /\.js$/.test(f))
.map(f => f.replace(/\.js$/, ''))
const suites = new Set()
const usage = () => {
console.log(`Arborist benchmark suite
Runs the specified suites, or all suites if none are specified.
Usage:
node ${relative(process.cwd(), __filename)} [options] [<suite> ...]
Available suites:
${allSuites.join('\n ')}
Add new suites by adding a .js file in ${
relative(process.cwd(), resolve(__dirname, 'benchmark'))}
Options:
-h --help print this message
--save=<name> save the benchmark to a given name for later comparison
--previous=<name> the name or commit sha of a previous run to compare against
(defaults to the most recent benchmark run)
--warn-range=<num> the range of % difference where faster/slower benchmarks
get highlighted in green or red. (default = 5)
--cache=<path> folder to use for the shared cache. Note that some suites
intentionally do not use this folder to test an empty cache.
(default = ${resolve(__dirname, 'benchmark/cache')})
`)
process.exit(0)
}
for (let i = 2; i < process.argv.length; i++) {
const arg = process.argv[i]
if (/^--previous=/.test(arg)) {
options.previous = arg.slice('--previous='.length)
} else if (/^--warn-range=[0-9]+/.test(arg)) {
options.warnRange = +arg.slice('--warn-range='.length)
} else if (/^--cache=/.test(arg)) {
options.cache = resolve(arg.slice('--cache='.length))
} else if (/^--save=/.test(arg)) {
const save = arg.slice('--save='.length)
if (/[/\\]|^\.\.?$/.test(save)) {
throw new Error('save cannot have slashes or be . or ..')
}
options.save = save
} else if (/^-h/.test(arg) || /^--help/.test(arg)) {
usage()
} else if (/^--/.test(arg)) {
throw new Error('Unknown option: ' + arg)
} else {
if (!allSuites.includes(arg)) {
throw new Error('Unknown benchmark suite: ' + arg)
}
suites.add(arg)
}
}
if (suites.size === 0) {
allSuites.forEach(s => suites.add(s))
}
const suiteName = suite => {
const name = suite.saveName ? ` (${suite.saveName})` : ''
return `${suite.sha} ${suite.date}${name}`
}
const suite = new Suite({
onStart () {
try {
const prevName = options.previous || 'last-benchmark'
const prev = `./benchmark/saved/${prevName}.json`
this.previous = require(prev)
if (!this.previous.saveName) {
this.previous.saveName = prevName
}
} catch (e) {
this.previous = null
}
this.date = new Date().toISOString()
this.sha = currentSha
this.cache = options.cache
this.saveName = options.save
const msg = `test: ${suiteName(this)}`
const prev = !this.previous ? '' : ` vs: ${suiteName(this.previous)}`
console.log('')
console.log('ARBORIST BENCHMARKS')
console.log(msg)
if (prev) {
console.log(prev)
}
},
onCycle (event) {
const bench = event.target
const prev = this.previous && this.previous[bench.name]
const pctDelta = prev &&
((bench.stats.mean - prev.stats.mean) / prev.stats.mean) * 100
const diff = !prev ? ''
: `${pctDelta > 0 ? '+' : ''}${pctDelta.toFixed(2)}% `
const colorDiff = ` (${
pctDelta >= options.warnRange + bench.stats.rme ? red(diff)
: pctDelta <= -(options.warnRange + bench.stats.rme) ? green(diff)
: diff
}±${bench.stats.rme.toFixed(2)}%)`
console.log('')
console.log(bench.name)
if (bench.error) {
console.log('Error:', bench.error.message || bench.error)
} else {
console.log(
` ${bench.hz.toFixed(bench.hz < 100 ? 2 : 0)} ops/s @ ~${(
bench.stats.mean * 1000
).toFixed(3)}ms/op${colorDiff}`
)
console.log(
` Sampled ${
bench.stats.sample.length
} in ${bench.times.elapsed.toFixed(2)}s.`
)
}
},
async onComplete () {
await rm(lastBenchmark, { recursive: true, force: true })
await mkdir(resolve(__dirname, 'benchmark/saved'), { recursive: true })
// always save with sha
const saveThis = resolve(__dirname, `benchmark/saved/${this.sha}.json`)
const data = JSON.stringify(this.reduce((acc, bench) => {
acc[bench.name] = bench
return acc
}, { date: this.date, sha: this.sha })) + '\n'
writeFileSync(saveThis, data)
if (this.saveName) {
const saveFile = `benchmark/saved/${this.saveName}.json`
const saveExplicit = resolve(__dirname, saveFile)
writeFileSync(saveExplicit, data)
}
linkSync(saveThis, lastBenchmark)
await teardown()
await Promise.all([
registryServer.stop(),
rm(this.cache, { recursive: true, force: true }),
])
},
})
const teardowns = []
const main = async () => {
console.log('starting mock server')
await registryServer.start()
options.registry = registryServer.registry
options.registryServer = registryServer
console.log('preparing benchmark suites', [...suites])
// benchmark functions can do async setup
const promises = []
for (const s of suites) {
const fn = require(`./benchmark/${s}.js`)
if (typeof fn.teardown === 'function') {
teardowns.push(fn.teardown)
}
promises.push(fn(suite, options))
}
await Promise.all(promises)
suite.run({ async: true })
}
const teardown = async () =>
await Promise.all(teardowns.map(t => t()))
main()
|
