update recommendation for async check #4037
Conversation
olegbespalov
requested review from
mstoykov and
oleiade
and removed request for
a team
| @@ -182,7 +179,9 @@ func (mi *K6) Check(arg0, checks sobek.Value, extras ...sobek.Value) (bool, erro | |||
| } | |||
|
|
|||
| if common.IsAsyncFunction(rt, val) { | |||
| return false, fmt.Errorf(asyncFunctionNotSupportedMsg, "check") | |||
| return false, errors.New("built-in check() does not support async functions as arguments, " + | |||
There was a problem hiding this comment.
It is probably good idea either here or/and the linked utils to explain why this is a problem similar to how it does it fro group.
There was a problem hiding this comment.
@heitortsergent maybe we should fix this part in the docs ?
There was a problem hiding this comment.
Yeah, that makes sense @mstoykov. I'll open an issue for it. 🙇
| @@ -104,7 +100,8 @@ func (mi *K6) Group(name string, val sobek.Value) (sobek.Value, error) { | |||
| return nil, errors.New("group() requires a callback as a second argument") | |||
| } | |||
| if common.IsAsyncFunction(mi.vu.Runtime(), val) { | |||
| return sobek.Undefined(), fmt.Errorf(asyncFunctionNotSupportedMsg, "group") | |||
| return sobek.Undefined(), errors.New("group() does not support async functions as arguments, " + | |||
| "please see https://grafana.com/docs/k6/latest/javascript-api/k6/group/#working-with-async-functions for more info") | |||
There was a problem hiding this comment.
Just as a small nit, we don't have the heading #working-with-async-functions on that page, so you could just link to: https://grafana.com/docs/k6/latest/javascript-api/k6/group/.
There was a problem hiding this comment.
Good catch, thanks! @heitortsergent
| @@ -182,7 +179,9 @@ func (mi *K6) Check(arg0, checks sobek.Value, extras ...sobek.Value) (bool, erro | |||
| } | |||
|
|
|||
| if common.IsAsyncFunction(rt, val) { | |||
| return false, fmt.Errorf(asyncFunctionNotSupportedMsg, "check") | |||
| return false, errors.New("built-in check() does not support async functions as arguments, " + | |||
There was a problem hiding this comment.
"The built-in check() does not support async functions as arguments. Use the JavaScript utils library as a replacement. Refer to https://grafana.com/docs/k6/latest/javascript-api/jslib/utils/check/ for more info"
Small suggestion for the message on these lines.
There was a problem hiding this comment.
Thanks! I've opened the #4043 for addressing 👍
What?
This change updates the recommendation for using the check polyfill that does support async functions.
https://grafana.com/docs/k6/latest/javascript-api/jslib/utils/check/
Why?
It improves UX of k6.
Checklist
make lint) and all checks pass.make tests) and all tests pass.Related PR(s)/Issue(s)