Update keyboard.type to return err

grafana · May 8, 2024 · 35e42a9 · 35e42a9
1 parent 1ea8653
commit 35e42a9
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/browser/mapping_test.go b/browser/mapping_test.go
@@ -528,7 +528,7 @@ type keyboardAPI interface {
 	Up(key string) error
 	InsertText(char string) error
 	Press(key string, opts goja.Value) error
-	Type(text string, opts goja.Value)
+	Type(text string, opts goja.Value) error
 }
 
 // touchscreenAPI is the interface of a touchscreen.

diff --git a/common/keyboard.go b/common/keyboard.go
@@ -6,7 +6,6 @@ import (
 	"strings"
 	"time"
 
-	"github.com/grafana/xk6-browser/k6ext"
 	"github.com/grafana/xk6-browser/keyboardlayout"
 
 	"github.com/chromedp/cdproto/cdp"
@@ -89,14 +88,15 @@ func (k *Keyboard) InsertText(text string) error {
 //
 // It sends an insertText message if a character is not among
 // valid characters in the keyboard's layout.
-func (k *Keyboard) Type(text string, opts goja.Value) {
+func (k *Keyboard) Type(text string, opts goja.Value) error {
 	kbdOpts := NewKeyboardOptions()
 	if err := kbdOpts.Parse(k.ctx, opts); err != nil {
-		k6ext.Panic(k.ctx, "parsing keyboard options: %w", err)
+		return fmt.Errorf("parsing keyboard options: %w", err)
 	}
 	if err := k.typ(text, kbdOpts); err != nil {
-		k6ext.Panic(k.ctx, "typing text: %w", err)
+		return fmt.Errorf("typing text: %w", err)
 	}
+	return nil
 }
 
 func (k *Keyboard) down(key string) error {

diff --git a/tests/keyboard_test.go b/tests/keyboard_test.go
@@ -41,7 +41,7 @@ func TestKeyboardPress(t *testing.T) {
 		require.NoError(t, err)
 		p.Focus("input", nil)
 
-		kb.Type("Hello World!", nil)
+		require.NoError(t, kb.Type("Hello World!", nil))
 		require.Equal(t, "Hello World!", el.InputValue(nil))
 
 		require.NoError(t, kb.Press("Backspace", nil))
@@ -114,7 +114,7 @@ func TestKeyboardPress(t *testing.T) {
 		require.NoError(t, err)
 		p.Focus("textarea", nil)
 
-		kb.Type("L+m+KeyN", nil)
+		require.NoError(t, kb.Type("L+m+KeyN", nil))
 		assert.Equal(t, "L+m+KeyN", el.InputValue(nil))
 	})
 
@@ -159,7 +159,7 @@ func TestKeyboardPress(t *testing.T) {
 		p.Focus("textarea", nil)
 
 		require.NoError(t, kb.Down("Shift"))
-		kb.Type("oPqR", nil)
+		require.NoError(t, kb.Type("oPqR", nil))
 		require.NoError(t, kb.Up("Shift"))
 
 		assert.Equal(t, "oPqR", el.InputValue(nil))
@@ -177,10 +177,10 @@ func TestKeyboardPress(t *testing.T) {
 		require.NoError(t, err)
 		p.Focus("textarea", nil)
 
-		kb.Type("Hello", nil)
+		require.NoError(t, kb.Type("Hello", nil))
 		require.NoError(t, kb.Press("Enter", nil))
 		require.NoError(t, kb.Press("Enter", nil))
-		kb.Type("World!", nil)
+		require.NoError(t, kb.Type("World!", nil))
 		assert.Equal(t, "Hello\n\nWorld!", el.InputValue(nil))
 	})
 
@@ -197,7 +197,7 @@ func TestKeyboardPress(t *testing.T) {
 		require.NoError(t, err)
 		p.Focus("input", nil)
 
-		kb.Type("Hello World!", nil)
+		require.NoError(t, kb.Type("Hello World!", nil))
 		require.Equal(t, "Hello World!", el.InputValue(nil))
 
 		require.NoError(t, kb.Press("ArrowLeft", nil))