Skip to content

Commit

Permalink
fix: 224 action hangs in some cases for go fiber benchmarks (#225)
Browse files Browse the repository at this point in the history 
* fix reExtract regexp to avoid catastrophic backtracking
* add test cases from fiber that were causing issues
* add backwards compatibility for benchmarks that used to have multiple metrics in Go but they were not extracted properly before v1.18.0
  • Loading branch information
@ktrz
ktrz committed Feb 2, 2024
1 parent e108afd commit 1c81dfd
Show file tree
Hide file tree
Showing 3 changed files with 177 additions and 2 deletions.
11 changes: 9 additions & 2 deletions src/extract.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ function extractGoResult(output: string): BenchmarkResult[] {
// "A benchmark result line has the general form: <name> <iterations> <value> <unit> [<value> <unit>...]"
// "The fields are separated by runs of space characters (as defined by unicode.IsSpace), so the line can be parsed with strings.Fields. The line must have an even number of fields, and at least four."
const reExtract =
/^(?<name>Benchmark\w+(?:\/?[\w()$%^&*-=,]*?)*?)(?<procs>-\d+)?\s+(?<times>\d+)\s+(?<remainder>.+)$/;
/^(?<name>Benchmark\w+[\w()$%^&*-=|,[\]{}"#]*?)(?<procs>-\d+)?\s+(?<times>\d+)\s+(?<remainder>.+)$/;

for (const line of lines) {
const m = line.match(reExtract);
Expand All @@ -363,6 +363,13 @@ function extractGoResult(output: string): BenchmarkResult[] {
const remainder = m.groups.remainder;

const pieces = remainder.split(/[ \t]+/);

// This is done for backwards compatibility with Go benchmarks that had multiple metrics in output,
// but they were not extracted properly before v1.18.0
if (pieces.length > 2) {
pieces.unshift(pieces[0], remainder.slice(remainder.indexOf(pieces[1])));
}

for (let i = 0; i < pieces.length; i = i + 2) {
let extra = `${times} times`.replace(/\s\s+/g, ' ');
if (procs !== null) {
Expand All @@ -371,7 +378,7 @@ function extractGoResult(output: string): BenchmarkResult[] {
const value = parseFloat(pieces[i]);
const unit = pieces[i + 1];
let name;
if (pieces.length > 2) {
if (i > 0) {
name = m.groups.name + ' - ' + unit;
} else {
name = m.groups.name;
Expand Down
6 changes: 6 additions & 0 deletions test/data/extract/go_fiber_output.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Benchmark_Ctx_Accepts/run-[]string{".xml"}-4 4846809 247.6 ns/op 0 B/op 0 allocs/op
Benchmark_Ctx_Accepts/run-[]string{"json",_"xml"}-4 3900769 307.1 ns/op 0 B/op 0 allocs/op
Benchmark_Ctx_Accepts/run-[]string{"application/json",_"application/xml"}-4 5118646 316.1 ns/op 0 B/op 0 allocs/op
Benchmark_Utils_GetOffer/mime_extension#01-4 3067818 390.7 ns/op 48 B/op 2 allocs/op
Benchmark_Utils_GetOffer/mime_extension#02-4 1992943 602.1 ns/op 48 B/op 2 allocs/op
Benchmark_Utils_GetOffer/mime_extension#03-4 4180965 286.3 ns/op 0 B/op 0 allocs/op
162 changes: 162 additions & 0 deletions test/extract.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,12 @@ describe('extractResult()', function () {
value: 40537.456,
extra: '30001 times',
},
{
name: 'BenchmarkFib11',
unit: 'ns/op\t 3.000 auxMetricUnits',
value: 262.7,
extra: '4587789 times\n16 procs',
},
{
name: 'BenchmarkFib11 - ns/op',
unit: 'ns/op',
Expand All @@ -221,6 +227,12 @@ describe('extractResult()', function () {
value: 3,
extra: '4587789 times\n16 procs',
},
{
name: 'BenchmarkFib22',
unit: 'ns/op\t 4.000 auxMetricUnits',
value: 31915,
extra: '37653 times\n16 procs',
},
{
name: 'BenchmarkFib22 - ns/op',
unit: 'ns/op',
Expand All @@ -235,6 +247,156 @@ describe('extractResult()', function () {
},
],
},
{
tool: 'go',
file: 'go_fiber_output.txt',
expected: [
{
name: `Benchmark_Ctx_Accepts/run-[]string{".xml"}`,
unit: 'ns/op 0 B/op 0 allocs/op',
value: 247.6,
extra: '4846809 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{".xml"} - ns/op`,
unit: 'ns/op',
value: 247.6,
extra: '4846809 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{".xml"} - B/op`,
unit: 'B/op',
value: 0,
extra: '4846809 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{".xml"} - allocs/op`,
unit: 'allocs/op',
value: 0,
extra: '4846809 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{"json",_"xml"}`,
unit: 'ns/op 0 B/op 0 allocs/op',
value: 307.1,
extra: '3900769 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{"json",_"xml"} - ns/op`,
unit: 'ns/op',
value: 307.1,
extra: '3900769 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{"json",_"xml"} - B/op`,
unit: 'B/op',
value: 0,
extra: '3900769 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{"json",_"xml"} - allocs/op`,
unit: 'allocs/op',
value: 0,
extra: '3900769 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{"application/json",_"application/xml"}`,
unit: 'ns/op 0 B/op 0 allocs/op',
value: 316.1,
extra: '5118646 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{"application/json",_"application/xml"} - ns/op`,
unit: 'ns/op',
value: 316.1,
extra: '5118646 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{"application/json",_"application/xml"} - B/op`,
unit: 'B/op',
value: 0,
extra: '5118646 times\n4 procs',
},
{
name: `Benchmark_Ctx_Accepts/run-[]string{"application/json",_"application/xml"} - allocs/op`,
unit: 'allocs/op',
value: 0,
extra: '5118646 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#01`,
unit: 'ns/op 48 B/op 2 allocs/op',
value: 390.7,
extra: '3067818 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#01 - ns/op`,
unit: 'ns/op',
value: 390.7,
extra: '3067818 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#01 - B/op`,
unit: 'B/op',
value: 48,
extra: '3067818 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#01 - allocs/op`,
unit: 'allocs/op',
value: 2,
extra: '3067818 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#02`,
unit: 'ns/op 48 B/op 2 allocs/op',
value: 602.1,
extra: '1992943 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#02 - ns/op`,
unit: 'ns/op',
value: 602.1,
extra: '1992943 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#02 - B/op`,
unit: 'B/op',
value: 48,
extra: '1992943 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#02 - allocs/op`,
unit: 'allocs/op',
value: 2,
extra: '1992943 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#03`,
unit: 'ns/op 0 B/op 0 allocs/op',
value: 286.3,
extra: '4180965 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#03 - ns/op`,
unit: 'ns/op',
value: 286.3,
extra: '4180965 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#03 - B/op`,
unit: 'B/op',
value: 0,
extra: '4180965 times\n4 procs',
},
{
name: `Benchmark_Utils_GetOffer/mime_extension#03 - allocs/op`,
unit: 'allocs/op',
value: 0,
extra: '4180965 times\n4 procs',
},
],
},
{
tool: 'benchmarkjs',
expected: [
Expand Down

0 comments on commit 1c81dfd

Please sign in to comment.