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

Fix 1204: panic while exporting nil goja values #1205

Merged
merged 6 commits into from
Feb 6, 2024
Merged

Fix 1204: panic while exporting nil goja values #1205

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
153b3fc
Fix panic while exporting a nil Goja value
inancgumus Feb 2, 2024
9bb0d08
Update the evaluate example with a null param
inancgumus Feb 2, 2024
b7da453
Add a dispatch event example
inancgumus Feb 2, 2024
43be12c
Move gojaValueExists to the mapping layer
inancgumus Feb 6, 2024
f5f26e9
Move mapping helpers to a file
inancgumus Feb 6, 2024
36a214e
Use gojaValueExists in exportArg
inancgumus Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
69 changes: 32 additions & 37 deletions browser/mapping.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ func mapLocator(vu moduleVU, lo *common.Locator) mapping {
if err := popts.Parse(vu.Context(), opts); err != nil {
return fmt.Errorf("parsing locator dispatch event options: %w", err)
}
return lo.DispatchEvent(typ, eventInit.Export(), popts) //nolint:wrapcheck
return lo.DispatchEvent(typ, exportArg(eventInit), popts) //nolint:wrapcheck
},
"waitFor": lo.WaitFor,
}
Expand Down Expand Up @@ -190,16 +190,12 @@ func mapJSHandle(vu moduleVU, jsh common.JSHandleAPI) mapping {
"evaluate": func(pageFunc goja.Value, gargs ...goja.Value) any {
args := make([]any, 0, len(gargs))
for _, a := range gargs {
args = append(args, a.Export())
args = append(args, exportArg(a))
}
return jsh.Evaluate(pageFunc.String(), args...)
},
"evaluateHandle": func(pageFunc goja.Value, gargs ...goja.Value) (mapping, error) {
args := make([]any, 0, len(gargs))
for _, a := range gargs {
args = append(args, a.Export())
}
h, err := jsh.EvaluateHandle(pageFunc.String(), args...)
h, err := jsh.EvaluateHandle(pageFunc.String(), exportArgs(gargs)...)
if err != nil {
return nil, err //nolint:wrapcheck
}
Expand Down Expand Up @@ -258,7 +254,7 @@ func mapElementHandle(vu moduleVU, eh *common.ElementHandle) mapping {
},
"dblclick": eh.Dblclick,
"dispatchEvent": func(typ string, eventInit goja.Value) error {
return eh.DispatchEvent(typ, eventInit.Export()) //nolint:wrapcheck
return eh.DispatchEvent(typ, exportArg(eventInit)) //nolint:wrapcheck
},
"fill": eh.Fill,
"focus": eh.Focus,
Expand Down Expand Up @@ -387,21 +383,13 @@ func mapFrame(vu moduleVU, f *common.Frame) mapping {
if err := popts.Parse(vu.Context(), opts); err != nil {
return fmt.Errorf("parsing frame dispatch event options: %w", err)
}
return f.DispatchEvent(selector, typ, eventInit.Export(), popts) //nolint:wrapcheck
return f.DispatchEvent(selector, typ, exportArg(eventInit), popts) //nolint:wrapcheck
},
"evaluate": func(pageFunction goja.Value, gargs ...goja.Value) any {
args := make([]any, 0, len(gargs))
for _, a := range gargs {
args = append(args, a.Export())
}
return f.Evaluate(pageFunction.String(), args...)
return f.Evaluate(pageFunction.String(), exportArgs(gargs)...)
},
"evaluateHandle": func(pageFunction goja.Value, gargs ...goja.Value) (mapping, error) {
args := make([]any, 0, len(gargs))
for _, a := range gargs {
args = append(args, a.Export())
}
jsh, err := f.EvaluateHandle(pageFunction.String(), args...)
jsh, err := f.EvaluateHandle(pageFunction.String(), exportArgs(gargs)...)
if err != nil {
return nil, err //nolint:wrapcheck
}
Expand Down Expand Up @@ -535,7 +523,7 @@ func mapFrame(vu moduleVU, f *common.Frame) mapping {
}

func parseWaitForFunctionArgs(
ctx context.Context, timeout time.Duration, pageFunc, opts goja.Value, args ...goja.Value,
ctx context.Context, timeout time.Duration, pageFunc, opts goja.Value, gargs ...goja.Value,
) (string, *common.FrameWaitForFunctionOptions, []any, error) {
popts := common.NewFrameWaitForFunctionOptions(timeout)
err := popts.Parse(ctx, opts)
Expand All @@ -549,12 +537,7 @@ func parseWaitForFunctionArgs(
js = fmt.Sprintf("() => (%s)", js)
}

pargs := make([]any, 0, len(args))
for _, arg := range args {
pargs = append(pargs, arg.Export())
}

return js, popts, pargs, nil
return js, popts, exportArgs(gargs), nil
}

// mapPage to the JS module.
Expand Down Expand Up @@ -592,24 +575,16 @@ func mapPage(vu moduleVU, p *common.Page) mapping {
if err := popts.Parse(vu.Context(), opts); err != nil {
return fmt.Errorf("parsing page dispatch event options: %w", err)
}
return p.DispatchEvent(selector, typ, eventInit.Export(), popts) //nolint:wrapcheck
return p.DispatchEvent(selector, typ, exportArg(eventInit), popts) //nolint:wrapcheck
},
"dragAndDrop": p.DragAndDrop,
"emulateMedia": p.EmulateMedia,
"emulateVisionDeficiency": p.EmulateVisionDeficiency,
"evaluate": func(pageFunction goja.Value, gargs ...goja.Value) any {
args := make([]any, 0, len(gargs))
for _, a := range gargs {
args = append(args, a.Export())
}
return p.Evaluate(pageFunction.String(), args...)
return p.Evaluate(pageFunction.String(), exportArgs(gargs)...)
},
"evaluateHandle": func(pageFunc goja.Value, gargs ...goja.Value) (mapping, error) {
args := make([]any, 0, len(gargs))
for _, a := range gargs {
args = append(args, a.Export())
}
jsh, err := p.EvaluateHandle(pageFunc.String(), args...)
jsh, err := p.EvaluateHandle(pageFunc.String(), exportArgs(gargs)...)
if err != nil {
return nil, err //nolint:wrapcheck
}
Expand Down Expand Up @@ -1042,3 +1017,23 @@ func panicIfFatalError(ctx context.Context, err error) {
k6ext.Abort(ctx, err.Error())
}
}

// exportArg exports the value and returns it.
// It returns nil if the value is undefined or null.
func exportArg(gv goja.Value) any {
if gv == nil || gv == goja.Undefined() || gv == goja.Null() {
inancgumus marked this conversation as resolved.
Show resolved Hide resolved
return nil
}
return gv.Export()
}

// exportArgs returns a slice of exported Goja values.
func exportArgs(gargs []goja.Value) []any {
args := make([]any, 0, len(gargs))
for _, garg := range gargs {
// leaves a nil garg in the array since users might want to
// pass undefined or null as an argument to a function
args = append(args, exportArg(garg))
}
return args
}