Refactor page.type to return err

grafana · May 28, 2024 · 461a16d · 461a16d
1 parent 007d52a
commit 461a16d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 9 deletions.
diff --git a/browser/mapping_test.go b/browser/mapping_test.go
@@ -345,7 +345,7 @@ type pageAPI interface {
 	ThrottleCPU(common.CPUProfile) error
 	ThrottleNetwork(common.NetworkProfile) error
 	Title() (string, error)
-	Type(selector string, text string, opts goja.Value)
+	Type(selector string, text string, opts goja.Value) error
 	Uncheck(selector string, opts goja.Value) error
 	URL() (string, error)
 	ViewportSize() map[string]float64
@@ -408,7 +408,7 @@ type frameAPI interface {
 	Tap(selector string, opts goja.Value) error
 	TextContent(selector string, opts goja.Value) (string, error)
 	Title() string
-	Type(selector string, text string, opts goja.Value)
+	Type(selector string, text string, opts goja.Value) error
 	Uncheck(selector string, opts goja.Value) error
 	URL() string
 	WaitForFunction(pageFunc, opts goja.Value, args ...goja.Value) (any, error)

diff --git a/common/frame.go b/common/frame.go
@@ -1676,18 +1676,20 @@ func (f *Frame) Title() string {
 }
 
 // Type text on the first element found matches the selector.
-func (f *Frame) Type(selector, text string, opts goja.Value) {
+func (f *Frame) Type(selector, text string, opts goja.Value) error {
 	f.log.Debugf("Frame:Type", "fid:%s furl:%q sel:%q text:%q", f.ID(), f.URL(), selector, text)
 
 	popts := NewFrameTypeOptions(f.defaultTimeout())
 	if err := popts.Parse(f.ctx, opts); err != nil {
-		k6ext.Panic(f.ctx, "parsing type options: %w", err)
+		return fmt.Errorf("parsing type options: %w", err)
 	}
 	if err := f.typ(selector, text, popts); err != nil {
-		k6ext.Panic(f.ctx, "typing %q in %q: %w", text, selector, err)
+		return fmt.Errorf("typing %q in %q: %w", text, selector, err)
 	}
 
 	applySlowMo(f.ctx)
+
+	return nil
 }
 
 func (f *Frame) typ(selector, text string, opts *FrameTypeOptions) error {

diff --git a/common/page.go b/common/page.go
@@ -1263,10 +1263,11 @@ func (p *Page) ThrottleNetwork(networkProfile NetworkProfile) error {
 	return nil
 }
 
-func (p *Page) Type(selector string, text string, opts goja.Value) {
+// Type text on the first element found matches the selector.
+func (p *Page) Type(selector string, text string, opts goja.Value) error {
 	p.logger.Debugf("Page:Type", "sid:%v selector:%s text:%s", p.sessionID(), selector, text)
 
-	p.MainFrame().Type(selector, text, opts)
+	return p.MainFrame().Type(selector, text, opts)
 }
 
 // URL returns the location of the page.

diff --git a/tests/launch_options_slowmo_test.go b/tests/launch_options_slowmo_test.go
@@ -156,7 +156,8 @@ func TestBrowserOptionsSlowMo(t *testing.T) {
 			t.Parallel()
 			tb := newTestBrowser(t, withFileServer())
 			testPageSlowMoImpl(t, tb, func(_ *testBrowser, p *common.Page) {
-				p.Type(".fill", "a", nil)
+				err := p.Type(".fill", "a", nil)
+				require.NoError(t, err)
 			})
 		})
 		t.Run("uncheck", func(t *testing.T) {
@@ -287,7 +288,8 @@ func TestBrowserOptionsSlowMo(t *testing.T) {
 			t.Parallel()
 			tb := newTestBrowser(t, withFileServer())
 			testFrameSlowMoImpl(t, tb, func(_ *testBrowser, f *common.Frame) {
-				f.Type(".fill", "a", nil)
+				err := f.Type(".fill", "a", nil)
+				require.NoError(t, err)
 			})
 		})
 		t.Run("uncheck", func(t *testing.T) {