Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Don't panic on no arguments to metric.Add() #2427

Merged
merged 2 commits into from
Mar 9, 2022
Merged

Don't panic on no arguments to metric.Add() #2427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b3494a
Don't panic on no arguments to `metric.Add()`
mstoykov Mar 9, 2022
9c78116
fix lint issue
mstoykov Mar 9, 2022
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
12 changes: 9 additions & 3 deletions js/modules/k6/metrics/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,16 +99,22 @@ func (m Metric) add(v goja.Value, addTags ...map[string]string) (bool, error) {
}

// return/throw exception if throw enabled, otherwise just log
raiseNan := func() (bool, error) {
err := fmt.Errorf("'%s' is an invalid value for metric '%s', a number or a boolean value is expected",
limitValue(v.String()), m.metric.Name)
raiseErr := func(err error) (bool, error) { //nolint:unparam // we want to just do `return raiseErr(...)`
if state.Options.Throw.Bool {
return false, err
}
state.Logger.Warn(err)
return false, nil
}
raiseNan := func() (bool, error) {
return raiseErr(fmt.Errorf("'%s' is an invalid value for metric '%s', a number or a boolean value is expected",
limitValue(v.String()), m.metric.Name))
}

if v == nil {
return raiseErr(fmt.Errorf("no value was provided for metric '%s', a number or a boolean value is expected",
m.metric.Name))
}
if goja.IsNull(v) {
return raiseNan()
}
Expand Down
38 changes: 21 additions & 17 deletions js/modules/k6/metrics/metrics_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,10 @@ import (
)

type addTestValue struct {
JS string
Float float64
isError bool
JS string
Float float64
errStr string
noTags bool
}

type addTest struct {
Expand All @@ -59,16 +60,16 @@ type addTest struct {

func (a addTest) run(t *testing.T) {
_, err := a.rt.RunString(a.js)
if a.val.isError && a.isThrow {
if len(a.val.errStr) != 0 && a.isThrow {
if assert.Error(t, err) {
return
}
} else {
assert.NoError(t, err)
if a.val.isError && !a.isThrow {
if len(a.val.errStr) != 0 && !a.isThrow {
lines := a.hook.Drain()
require.Len(t, lines, 1)
assert.Contains(t, lines[0].Message, "is an invalid value for metric")
assert.Contains(t, lines[0].Message, a.val.errStr)
return
}
}
Expand Down Expand Up @@ -99,13 +100,14 @@ func TestMetrics(t *testing.T) {
"Int": {JS: `5`, Float: 5.0},
"True": {JS: `true`, Float: 1.0},
"False": {JS: `false`, Float: 0.0},
"null": {JS: `null`, isError: true},
"undefined": {JS: `undefined`, isError: true},
"NaN": {JS: `NaN`, isError: true},
"string": {JS: `"string"`, isError: true},
"null": {JS: `null`, errStr: "is an invalid value for metric"},
"undefined": {JS: `undefined`, errStr: "is an invalid value for metric"},
"NaN": {JS: `NaN`, errStr: "is an invalid value for metric"},
"string": {JS: `"string"`, errStr: "is an invalid value for metric"},
"string 5": {JS: `"5.3"`, Float: 5.3},
"some object": {JS: `{something: 3}`, isError: true},
"another metric object": {JS: `m`, isError: true},
"some object": {JS: `{something: 3}`, errStr: "is an invalid value for metric"},
"another metric object": {JS: `m`, errStr: "is an invalid value for metric"},
"no argument": {JS: ``, errStr: "no value was provided", noTags: true},
}
for fn, mtyp := range types {
fn, mtyp := fn, mtyp
Expand Down Expand Up @@ -168,11 +170,13 @@ func TestMetrics(t *testing.T) {
test.expectedTags = map[string]string{"key": "value"}
test.run(t)
})
t.Run(fmt.Sprintf("%s/isThrow=%v/Tags", name, isThrow), func(t *testing.T) {
test.js = fmt.Sprintf(`m.add(%v, {a:1})`, val.JS)
test.expectedTags = map[string]string{"key": "value", "a": "1"}
test.run(t)
})
if !val.noTags {
t.Run(fmt.Sprintf("%s/isThrow=%v/Tags", name, isThrow), func(t *testing.T) {
test.js = fmt.Sprintf(`m.add(%v, {a:1})`, val.JS)
test.expectedTags = map[string]string{"key": "value", "a": "1"}
test.run(t)
})
}
}
}
})
Expand Down