test: add more worker and element tests (#89)

Author: mxschmitt

element_handle.go

@@ -277,7 +277,6 @@ func newElementHandle(parent *channelOwner, objectType string, guid string, init
 func normalizeFilePayloads(files []InputFile) []map[string]string {
 	out := make([]map[string]string, 0)
 	for _, file := range files {
-		// file.Buffer
 		out = append(out, map[string]string{
 			"name":     file.Name,
 			"mimeType": file.MimeType,

frame.go

@@ -297,7 +297,7 @@ func (f *frameImpl) EvalOnSelectorAll(selector string, expression string, option
 	return parseResult(result), nil
 }
 
-func (f *frameImpl) EvaluateHandle(expression string, options ...interface{}) (interface{}, error) {
+func (f *frameImpl) EvaluateHandle(expression string, options ...interface{}) (JSHandle, error) {
 	var arg interface{}
 	forceExpression := false
 	if !isFunctionBody(expression) {
@@ -321,7 +321,7 @@ func (f *frameImpl) EvaluateHandle(expression string, options ...interface{}) (i
 	if channelOwner == nil {
 		return nil, nil
 	}
-	return channelOwner, nil
+	return channelOwner.(JSHandle), nil
 }
 
 func (f *frameImpl) Click(selector string, options ...PageClickOptions) error {

generated_interfaces.go

@@ -213,7 +213,7 @@ type Download interface {
 // ElementHandles are auto-disposed when their origin frame gets navigated.
 // ElementHandle instances can be used as an argument in page.$eval(selector, pageFunction[, arg]) and page.evaluate(pageFunction[, arg]) methods.
 type ElementHandle interface {
-	AsElement() ElementHandle
+	JSHandle
 	// This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is
 	// calculated relative to the main frame viewport - which is usually the same as the browser window.
 	// Scrolling affects the returned bonding box, similarly to
@@ -486,7 +486,7 @@ type Frame interface {
 	// the promise to resolve and return its value.
 	// A string can also be passed in instead of a function.
 	// JSHandle instances can be passed as an argument to the `frame.evaluateHandle`:
-	EvaluateHandle(expression string, options ...interface{}) (interface{}, error)
+	EvaluateHandle(expression string, options ...interface{}) (JSHandle, error)
 	// Returns the return value of `pageFunction`
 	// The method finds an element matching the specified selector within the frame and passes it as a first argument to
 	// `pageFunction`. See Working with selectors for more details. If no elements match the
@@ -669,7 +669,7 @@ type JSHandle interface {
 	// If the function passed to the `jsHandle.evaluateHandle` returns a Promise, then `jsHandle.evaluateHandle` would wait
 	// for the promise to resolve and return its value.
 	// See page.evaluateHandle(pageFunction[, arg]) for more details.
-	EvaluateHandle(expression string, options ...interface{}) (interface{}, error)
+	EvaluateHandle(expression string, options ...interface{}) (JSHandle, error)
 	// The method returns a map with **own property names** as keys and JSHandle instances for the property values.
 	GetProperties() (map[string]JSHandle, error)
 	// Fetches a single property from the referenced object.
@@ -757,10 +757,10 @@ type Mouse interface {
 // This example logs a message for a single page `load` event:
 // To unsubscribe from events use the `removeListener` method:
 type Page interface {
+	EventEmitter
 	Mouse() Mouse
 	Keyboard() Keyboard
 	Touchscreen() Touchscreen
-	EventEmitter
 	// Adds a script which would be evaluated in one of the following scenarios:
 	// Whenever the page is navigated.
 	// Whenever the child frame is attached or navigated. In this case, the script is evaluated in the context of the newly attached frame.
@@ -875,7 +875,7 @@ type Page interface {
 	// promise to resolve and return its value.
 	// A string can also be passed in instead of a function:
 	// JSHandle instances can be passed as an argument to the `page.evaluateHandle`:
-	EvaluateHandle(expression string, options ...interface{}) (interface{}, error)
+	EvaluateHandle(expression string, options ...interface{}) (JSHandle, error)
 	// The method finds an element matching the specified selector within the page and passes it as a first argument to
 	// `pageFunction`. If no elements match the selector, the method throws an error. Returns the value of `pageFunction`.
 	// If `pageFunction` returns a Promise, then `page.$eval` would wait for the promise to resolve and return its value.
@@ -891,7 +891,7 @@ type Page interface {
 	ExpectDownload(cb func() error) (Download, error)
 	ExpectEvent(event string, cb func() error, predicates ...interface{}) (interface{}, error)
 	ExpectFileChooser(cb func() error) (FileChooser, error)
-	ExpectLoadState(state string, cb func() error) (ConsoleMessage, error)
+	ExpectLoadState(state string, cb func() error) error
 	ExpectNavigation(cb func() error, options ...PageWaitForNavigationOptions) (Response, error)
 	ExpectPopup(cb func() error) (Page, error)
 	ExpectRequest(url interface{}, cb func() error, options ...interface{}) (Request, error)
@@ -1269,6 +1269,7 @@ type Video interface {
 // event is emitted on the page object to signal a worker creation. `close` event is emitted on the worker object when the
 // worker is gone.
 type Worker interface {
+	EventEmitter
 	// Returns the return value of `pageFunction`
 	// If the function passed to the `worker.evaluate` returns a Promise, then `worker.evaluate` would wait for the promise
 	// to resolve and return its value.
@@ -1283,4 +1284,6 @@ type Worker interface {
 	// the promise to resolve and return its value.
 	EvaluateHandle(expression string, options ...interface{}) (JSHandle, error)
 	URL() string
+	WaitForEvent(event string, predicate ...interface{}) interface{}
+	ExpectEvent(event string, cb func() error, predicates ...interface{}) (interface{}, error)
 }

js_handle.go

@@ -38,7 +38,7 @@ func (j *jsHandleImpl) Evaluate(expression string, options ...interface{}) (inte
 	return parseResult(result), nil
 }
 
-func (j *jsHandleImpl) EvaluateHandle(expression string, options ...interface{}) (interface{}, error) {
+func (j *jsHandleImpl) EvaluateHandle(expression string, options ...interface{}) (JSHandle, error) {
 	var arg interface{}
 	forceExpression := false
 	if !isFunctionBody(expression) {
@@ -171,6 +171,13 @@ func serializeValue(value interface{}, handles *[]*channel, depth int) interface
 			"h": h,
 		}
 	}
+	if handle, ok := value.(*jsHandleImpl); ok {
+		h := len(*handles)
+		*handles = append(*handles, handle.channel)
+		return map[string]interface{}{
+			"h": h,
+		}
+	}
 	if depth > 100 {
 		panic(errors.New("Maximum argument depth exceeded"))
 	}

page.go

@@ -126,7 +126,7 @@ func (p *pageImpl) Evaluate(expression string, options ...interface{}) (interfac
 	return p.mainFrame.Evaluate(expression, options...)
 }
 
-func (p *pageImpl) EvaluateHandle(expression string, options ...interface{}) (interface{}, error) {
+func (p *pageImpl) EvaluateHandle(expression string, options ...interface{}) (JSHandle, error) {
 	return p.mainFrame.EvaluateHandle(expression, options...)
 }
 
@@ -390,9 +390,9 @@ func (p *pageImpl) ExpectFileChooser(cb func() error) (FileChooser, error) {
 	return response.(*fileChooserImpl), err
 }
 
-func (p *pageImpl) ExpectLoadState(state string, cb func() error) (ConsoleMessage, error) {
-	response, err := newExpectWrapper(p.mainFrame.WaitForLoadState, []interface{}{state}, cb)
-	return response.(*consoleMessageImpl), err
+func (p *pageImpl) ExpectLoadState(state string, cb func() error) error {
+	_, err := newExpectWrapper(p.mainFrame.WaitForLoadState, []interface{}{state}, cb)
+	return err
 }
 
 func (p *pageImpl) ExpectPopup(cb func() error) (Page, error) {

scripts/data/interfaces.json

@@ -6,7 +6,9 @@
 		]
 	},
 	"Browser": {
-		"EventEmitter": [],
+		"extends": [
+			"EventEmitter"
+		],
 		"Close": [
 			null,
 			"error"
@@ -33,7 +35,9 @@
 		]
 	},
 	"BrowserContext": {
-		"EventEmitter": [],
+		"extends": [
+			"EventEmitter"
+		],
 		"AddCookies": [
 			"cookies ...SetNetworkCookieParam",
 			"error"
@@ -216,9 +220,8 @@
 		]
 	},
 	"ElementHandle": {
-		"AsElement": [
-			null,
-			"ElementHandle"
+		"extends": [
+			"JSHandle"
 		],
 		"BoundingBox": [
 			null,
@@ -408,7 +411,7 @@
 		],
 		"EvaluateHandle": [
 			"expression string, options ...interface{}",
-			"interface{}, error"
+			"JSHandle, error"
 		],
 		"EvalOnSelector": [
 			"selector string, expression string, options ...interface{}",
@@ -550,7 +553,7 @@
 		],
 		"EvaluateHandle": [
 			"expression string, options ...interface{}",
-			"interface{}, error"
+			"JSHandle, error"
 		],
 		"GetProperties": [
 			null,
@@ -614,6 +617,9 @@
 		]
 	},
 	"Page": {
+		"extends": [
+			"EventEmitter"
+		],
 		"Mouse": [
 			null,
 			"Mouse"
@@ -626,7 +632,6 @@
 			null,
 			"Touchscreen"
 		],
-		"EventEmitter": [],
 		"AddInitScript": [
 			"options BrowserContextAddInitScriptOptions",
 			"error"
@@ -689,7 +694,7 @@
 		],
 		"EvaluateHandle": [
 			"expression string, options ...interface{}",
-			"interface{}, error"
+			"JSHandle, error"
 		],
 		"EvalOnSelector": [
 			"selector string, expression string, options ...interface{}",
@@ -717,7 +722,7 @@
 		],
 		"ExpectLoadState": [
 			"state string, cb func() error",
-			"ConsoleMessage, error"
+			"error"
 		],
 		"ExpectNavigation": [
 			"cb func() error, options ...PageWaitForNavigationOptions",
@@ -1049,7 +1054,9 @@
 		]
 	},
 	"WebSocket": {
-		"EventEmitter": [],
+		"extends": [
+			"EventEmitter"
+		],
 		"IsClosed": [
 			null,
 			"bool"
@@ -1070,6 +1077,9 @@
 		]
 	},
 	"Worker": {
+		"extends": [
+			"EventEmitter"
+		],
 		"Evaluate": [
 			"expression string, options ...interface{}",
 			"interface{}, error"
@@ -1081,6 +1091,14 @@
 		"URL": [
 			null,
 			"string"
+		],
+		"WaitForEvent": [
+			"event string, predicate ...interface{}",
+			"interface{}"
+		],
+		"ExpectEvent": [
+			"event string, cb func() error, predicates ...interface{}",
+			"(interface{}, error)"
 		]
 	}
 }

scripts/generate-interfaces.js

@@ -48,8 +48,9 @@ for (const [className, methods] of Object.entries(interfaceData)) {
     writeComment(api[className].comment)
   console.log(`type ${className} interface {`)
   for (const [funcName, funcData] of Object.entries(methods)) {
-    if (funcData.length === 0) {
-      console.log(funcName)
+    if (funcName === "extends") {
+      for (const inheritedInterface of funcData)
+        console.log(inheritedInterface)
     } else {
       const apiFunc = api[className] && Object.entries(api[className].methods).find(([item]) => transformMethodNamesToGo(item) === funcName)
       if (apiFunc && apiFunc[1].comment)

tests/binding_test.go

@@ -80,3 +80,25 @@ func TestBrowserContextExposeBindingPanic(t *testing.T) {
 	stack := strings.Split(innerError["stack"].(string), "\n")
 	require.Contains(t, stack[len(stack)-1], "binding_test.go")
 }
+
+func TestBrowserContextExposeBindingHandleShouldWork(t *testing.T) {
+	BeforeEach(t)
+	defer AfterEach(t)
+	targets := []playwright.JSHandle{}
+
+	logme := func(t interface{}) int {
+		targets = append(targets, t.(playwright.JSHandle))
+		return 17
+	}
+
+	err := page.ExposeBinding("logme", func(source *playwright.BindingSource, args ...interface{}) interface{} {
+		return logme(args[0])
+	}, true)
+	require.NoError(t, err)
+	result, err := page.Evaluate("logme({ foo: 42 })")
+	require.NoError(t, err)
+	require.Equal(t, result, 17)
+	res, err := targets[0].Evaluate("x => x.foo")
+	require.NoError(t, err)
+	require.Equal(t, 42, res)
+}

tests/browser_test.go

@@ -32,7 +32,9 @@ func TestBrowserNewPage(t *testing.T) {
 	page, err := browser.NewPage()
 	require.NoError(t, err)
 	require.Equal(t, 2, len(browser.Contexts()))
+	require.False(t, page.IsClosed())
 	require.NoError(t, page.Close())
+	require.True(t, page.IsClosed())
 	require.Equal(t, 1, len(browser.Contexts()))
 }
 

tests/dialog_test.go

@@ -19,3 +19,25 @@ func TestDialog(t *testing.T) {
 	_, err := page.Evaluate("alert('yo')")
 	require.NoError(t, err)
 }
+
+func TestDialogDismiss(t *testing.T) {
+	BeforeEach(t)
+	defer AfterEach(t)
+	page.On("dialog", func(dialog playwright.Dialog) {
+		require.NoError(t, dialog.Dismiss())
+	})
+	result, err := page.Evaluate("prompt('question?')")
+	require.NoError(t, err)
+	require.Equal(t, result, nil)
+}
+
+func TestDialogAcceptWithText(t *testing.T) {
+	BeforeEach(t)
+	defer AfterEach(t)
+	page.On("dialog", func(dialog playwright.Dialog) {
+		require.NoError(t, dialog.Accept("hey foobar"))
+	})
+	result, err := page.Evaluate("prompt('question?')")
+	require.NoError(t, err)
+	require.Equal(t, result, "hey foobar")
+}