Do not expose browser.on method

ka3de · ka3de · commit 56e4c944ea73 · 2023-06-02T15:18:13.000+02:00
A decision was made to no longer expose browser.on method as it currently only supports 'disconnect' event, and that is non applicable after the changes made to abstract the browser initialization/closing procedures from the JS API in #910.
diff --git a/browser/mapping.go b/browser/mapping.go
@@ -697,15 +697,6 @@ func mapBrowser(vu moduleVU, wsURL string, isRemoteBrowser bool) mapping { //nol
 			}
 			return b.IsConnected(), nil
 		},
-		"on": func(event string) *goja.Promise {
-			return k6ext.Promise(vu.Context(), func() (result any, reason error) {
-				b, err := getOrInitBrowser(ctx, bt, vu, wsURL, isRemoteBrowser)
-				if err != nil {
-					return nil, err
-				}
-				return b.On(event) //nolint:wrapcheck
-			})
-		},
 		"newContext": func(opts goja.Value) (*goja.Object, error) {
 			b, err := getOrInitBrowser(ctx, bt, vu, wsURL, isRemoteBrowser)
 			if err != nil {
diff --git a/browser/mapping_test.go b/browser/mapping_test.go
@@ -40,6 +40,10 @@ func customMappings() map[string]string {
 		"Frame.loaderID":         "",
 		"JSHandle.objectID":      "",
 		"Browser.close":          "",
+		// TODO: browser.on method is unexposed until more event
+		// types other than 'disconnect' are supported.
+		// See: https://github.com/grafana/xk6-browser/issues/913
+		"Browser.on": "",
 	}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,10 @@ func customMappings() map[string]string {`
`40`	`40`	`"Frame.loaderID": "",`
`41`	`41`	`"JSHandle.objectID": "",`
`42`	`42`	`"Browser.close": "",`
	`43`	`+ // TODO: browser.on method is unexposed until more event`
	`44`	`+ // types other than 'disconnect' are supported.`
	`45`	`+ // See: https://github.com/grafana/xk6-browser/issues/913`
	`46`	`+ "Browser.on": "",`
`43`	`47`	`}`
`44`	`48`	`}`
`45`	`49`