Merge browser in k6

go.mod

@@ -14,7 +14,6 @@ require (
 	github.com/go-sourcemap/sourcemap v2.1.4+incompatible
 	github.com/golang/protobuf v1.5.4
 	github.com/gorilla/websocket v1.5.3
-	github.com/grafana/xk6-browser v1.9.1
 	github.com/grafana/xk6-dashboard v0.7.5
 	github.com/grafana/xk6-output-opentelemetry v0.3.0
 	github.com/grafana/xk6-output-prometheus-remote v0.5.0
@@ -66,7 +65,7 @@ require (
 	github.com/bufbuild/protocompile v0.14.1 // indirect
 	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
-	github.com/chromedp/cdproto v0.0.0-20240919203636-12af5e8a671f // indirect
+	github.com/chromedp/cdproto v0.0.0-20240919203636-12af5e8a671f
 	github.com/chromedp/sysutil v1.0.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
@@ -96,7 +95,7 @@ require (
 	go.opentelemetry.io/otel/metric v1.29.0 // indirect
 	go.opentelemetry.io/otel/sdk/metric v1.28.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.3.1 // indirect
-	golang.org/x/sync v0.8.0 // indirect
+	golang.org/x/sync v0.8.0
 	golang.org/x/sys v0.26.0 // indirect
 	golang.org/x/text v0.19.0 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20240822170219-fc7c04adadcd // indirect

go.sum

@@ -44,8 +44,8 @@ github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/r
 github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
 github.com/dlclark/regexp2 v1.11.4 h1:rPYF9/LECdNymJufQKmri9gV604RvvABwgOA8un7yAo=
 github.com/dlclark/regexp2 v1.11.4/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
-github.com/dop251/goja v0.0.0-20240610225006-393f6d42497b h1:fMKDnOAKCGXSZBphY/ilLtu7cmwMnjqE+xJxUkfkpCY=
-github.com/dop251/goja v0.0.0-20240610225006-393f6d42497b/go.mod h1:o31y53rb/qiIAONF7w3FHJZRqqP3fzHUr1HqanthByw=
+github.com/dop251/goja v0.0.0-20240516125602-ccbae20bcec2 h1:OFTHt+yJDo/uaIKMGjEKzc3DGhrpQZoqvMUIloZv6ZY=
+github.com/dop251/goja v0.0.0-20240516125602-ccbae20bcec2/go.mod h1:o31y53rb/qiIAONF7w3FHJZRqqP3fzHUr1HqanthByw=
 github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
 github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
 github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=
@@ -89,8 +89,6 @@ github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aN
 github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/grafana/sobek v0.0.0-20241024150027-d91f02b05e9b h1:hzfIt1lf19Zx1jIYdeHvuWS266W+jL+7dxbpvH2PZMQ=
 github.com/grafana/sobek v0.0.0-20241024150027-d91f02b05e9b/go.mod h1:FmcutBFPLiGgroH42I4/HBahv7GxVjODcVWFTw1ISes=
-github.com/grafana/xk6-browser v1.9.1 h1:wmISbIbzl7JtmvpkbXKhUg3XtFPepN+fss6UupZyRW0=
-github.com/grafana/xk6-browser v1.9.1/go.mod h1:c0wf9sUlUjbhCnwHUFf6tkgkpoh/AXMuVd21XXIhyWY=
 github.com/grafana/xk6-dashboard v0.7.5 h1:TcILyffT/Ea/XD7xG1jMA5lwtusOPRbEQsQDHmO30Mk=
 github.com/grafana/xk6-dashboard v0.7.5/go.mod h1:Y75F8xmgCraKT+pBzFH6me9AyH5PkXD+Bxo1dm6Il/M=
 github.com/grafana/xk6-output-opentelemetry v0.3.0 h1:dmclGBFtFVRJijqLncpu2dKVIIvx1GS3y6sQGg4Khl8=

js/jsmodules.go

@@ -8,6 +8,7 @@ import (
 	"go.k6.io/k6/js/common"
 	"go.k6.io/k6/js/modules"
 	"go.k6.io/k6/js/modules/k6"
+	"go.k6.io/k6/js/modules/k6/browser/browser"
 	"go.k6.io/k6/js/modules/k6/crypto"
 	"go.k6.io/k6/js/modules/k6/crypto/x509"
 	"go.k6.io/k6/js/modules/k6/data"
@@ -24,7 +25,6 @@ import (
 	"go.k6.io/k6/js/modules/k6/timers"
 	"go.k6.io/k6/js/modules/k6/ws"
 
-	"github.com/grafana/xk6-browser/browser"
 	"github.com/grafana/xk6-redis/redis"
 	"github.com/grafana/xk6-webcrypto/webcrypto"
 	expws "github.com/grafana/xk6-websockets/websockets"

vendor/github.com/grafana/xk6-browser/browser/browser_context_mapping.go → js/modules/k6/browser/browser/browser_context_mapping.go

@@ -4,12 +4,13 @@ import (
 	"errors"
 	"fmt"
 	"reflect"
+	"time"
 
 	"github.com/grafana/sobek"
 
-	"github.com/grafana/xk6-browser/common"
-	"github.com/grafana/xk6-browser/k6error"
-	"github.com/grafana/xk6-browser/k6ext"
+	"go.k6.io/k6/js/modules/k6/browser/common"
+	"go.k6.io/k6/js/modules/k6/browser/k6error"
+	"go.k6.io/k6/js/modules/k6/browser/k6ext"
 )
 
 // mapBrowserContext to the JS module.
@@ -74,40 +75,47 @@ func mapBrowserContext(vu moduleVU, bc *common.BrowserContext) mapping { //nolin
 				return bc.Cookies(urls...) //nolint:wrapcheck
 			})
 		},
-		"grantPermissions": func(permissions []string, opts sobek.Value) *sobek.Promise {
+		"grantPermissions": func(permissions []string, opts sobek.Value) (*sobek.Promise, error) {
+			popts, err := exportTo[common.GrantPermissionsOptions](vu.Runtime(), opts)
+			if err != nil {
+				return nil, fmt.Errorf("parsing grant permission options: %w", err)
+			}
 			return k6ext.Promise(vu.Context(), func() (any, error) {
-				popts := common.NewGrantPermissionsOptions()
-				popts.Parse(vu.Context(), opts)
-
-				return nil, bc.GrantPermissions(permissions, popts) //nolint:wrapcheck
-			})
+				return nil, bc.GrantPermissions(permissions, popts)
+			}), nil
 		},
 		"setDefaultNavigationTimeout": bc.SetDefaultNavigationTimeout,
 		"setDefaultTimeout":           bc.SetDefaultTimeout,
-		"setGeolocation": func(geolocation sobek.Value) *sobek.Promise {
+		"setGeolocation": func(geolocation sobek.Value) (*sobek.Promise, error) {
+			gl, err := exportTo[common.Geolocation](vu.Runtime(), geolocation)
+			if err != nil {
+				return nil, fmt.Errorf("parsing geo location: %w", err)
+			}
 			return k6ext.Promise(vu.Context(), func() (any, error) {
-				return nil, bc.SetGeolocation(geolocation) //nolint:wrapcheck
-			})
+				return nil, bc.SetGeolocation(&gl)
+			}), nil
 		},
-		"setHTTPCredentials": func(httpCredentials sobek.Value) *sobek.Promise {
+		"setHTTPCredentials": func(httpCredentials sobek.Value) (*sobek.Promise, error) {
+			creds, err := exportTo[common.Credentials](rt, httpCredentials)
+			if err != nil {
+				return nil, fmt.Errorf("parsing HTTP credentials: %w", err)
+			}
 			return k6ext.Promise(vu.Context(), func() (any, error) {
-				return nil, bc.SetHTTPCredentials(httpCredentials) //nolint:staticcheck,wrapcheck
-			})
+				return nil, bc.SetHTTPCredentials(creds) //nolint:staticcheck
+			}), nil
 		},
 		"setOffline": func(offline bool) *sobek.Promise {
 			return k6ext.Promise(vu.Context(), func() (any, error) {
 				return nil, bc.SetOffline(offline) //nolint:wrapcheck
 			})
 		},
 		"waitForEvent": func(event string, optsOrPredicate sobek.Value) (*sobek.Promise, error) {
-			ctx := vu.Context()
-			popts := common.NewWaitForEventOptions(
-				bc.Timeout(),
-			)
-			if err := popts.Parse(ctx, optsOrPredicate); err != nil {
-				return nil, fmt.Errorf("parsing waitForEvent options: %w", err)
+			popts, err := parseWaitForEventOptions(vu.Runtime(), optsOrPredicate, bc.Timeout())
+			if err != nil {
+				return nil, fmt.Errorf("parsing wait for event options: %w", err)
 			}
 
+			ctx := vu.Context()
 			return k6ext.Promise(ctx, func() (result any, reason error) {
 				var runInTaskQueue func(p *common.Page) (bool, error)
 				if popts.PredicateFn != nil {
@@ -177,3 +185,48 @@ func mapBrowserContext(vu moduleVU, bc *common.BrowserContext) mapping { //nolin
 		},
 	}
 }
+
+// waitForEventOptions are the options used by the browserContext.waitForEvent API.
+type waitForEventOptions struct {
+	Timeout     time.Duration
+	PredicateFn sobek.Callable
+}
+
+// parseWaitForEventOptions parses optsOrPredicate into a WaitForEventOptions.
+// It returns a WaitForEventOptions with the default timeout if optsOrPredicate is nil,
+// or not a callable predicate function.
+// It can parse only a callable predicate function or an object which contains a
+// callable predicate function and a timeout.
+func parseWaitForEventOptions(
+	rt *sobek.Runtime, optsOrPredicate sobek.Value, defaultTime time.Duration,
+) (*waitForEventOptions, error) {
+	w := &waitForEventOptions{
+		Timeout: defaultTime,
+	}
+
+	if !sobekValueExists(optsOrPredicate) {
+		return w, nil
+	}
+	var isCallable bool
+	w.PredicateFn, isCallable = sobek.AssertFunction(optsOrPredicate)
+	if isCallable {
+		return w, nil
+	}
+
+	opts := optsOrPredicate.ToObject(rt)
+	for _, k := range opts.Keys() {
+		switch k {
+		case "predicate":
+			w.PredicateFn, isCallable = sobek.AssertFunction(opts.Get(k))
+			if !isCallable {
+				return nil, errors.New("predicate function is not callable")
+			}
+		case "timeout":
+			w.Timeout = time.Duration(opts.Get(k).ToInteger()) * time.Millisecond
+		default:
+			return nil, fmt.Errorf("unknown option: %s", k)
+		}
+	}
+
+	return w, nil
+}

js/modules/k6/browser/browser/browser_context_options_test.go

@@ -0,0 +1,136 @@
+package browser
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"go.k6.io/k6/js/modules/k6/browser/common"
+	"go.k6.io/k6/js/modules/k6/browser/k6ext/k6test"
+)
+
+func TestBrowserContextOptionsPermissions(t *testing.T) {
+	vu := k6test.NewVU(t)
+
+	opts, err := parseBrowserContextOptions(vu.Runtime(), vu.ToSobekValue((struct {
+		Permissions []any `js:"permissions"`
+	}{
+		Permissions: []any{"camera", "microphone"},
+	})))
+	assert.NoError(t, err)
+	assert.Len(t, opts.Permissions, 2)
+	assert.Equal(t, opts.Permissions, []string{"camera", "microphone"})
+}
+
+func TestBrowserContextSetGeolocation(t *testing.T) {
+	vu := k6test.NewVU(t)
+
+	opts, err := parseBrowserContextOptions(vu.Runtime(), vu.ToSobekValue((struct {
+		GeoLocation *common.Geolocation `js:"geolocation"`
+	}{
+		GeoLocation: &common.Geolocation{
+			Latitude:  1.0,
+			Longitude: 2.0,
+			Accuracy:  3.0,
+		},
+	})))
+	assert.NoError(t, err)
+	assert.NotNil(t, opts)
+	assert.Equal(t, 1.0, opts.Geolocation.Latitude)
+	assert.Equal(t, 2.0, opts.Geolocation.Longitude)
+	assert.Equal(t, 3.0, opts.Geolocation.Accuracy)
+}
+
+func TestBrowserContextDefaultOptions(t *testing.T) {
+	vu := k6test.NewVU(t)
+
+	defaults := common.DefaultBrowserContextOptions()
+
+	// gets the default options by default
+	opts, err := parseBrowserContextOptions(vu.Runtime(), nil)
+	require.NoError(t, err)
+	assert.Equal(t, defaults, opts)
+
+	// merges with the default options
+	opts, err = parseBrowserContextOptions(vu.Runtime(), vu.ToSobekValue((struct {
+		DeviceScaleFactor float64 `js:"deviceScaleFactor"` // just to test a different field
+	}{
+		DeviceScaleFactor: defaults.DeviceScaleFactor + 1,
+	})))
+	require.NoError(t, err)
+	assert.NotEqual(t, defaults.DeviceScaleFactor, opts.DeviceScaleFactor)
+	assert.Equal(t, defaults.Locale, opts.Locale) // should remain as default
+}
+
+func TestBrowserContextAllOptions(t *testing.T) {
+	vu := k6test.NewVU(t)
+	opts, err := vu.Runtime().RunString(`const opts = {
+			acceptDownloads: true,
+			downloadsPath: '/tmp',
+			bypassCSP: true,
+			colorScheme: 'dark',
+			deviceScaleFactor: 1,
+			extraHTTPHeaders: {
+				'X-Header': 'value',
+			},
+			geolocation: { latitude: 51.509865, longitude: -0.118092, accuracy: 1 },
+			hasTouch: true,
+			httpCredentials: { username: 'admin', password: 'password' },
+			ignoreHTTPSErrors: true,
+			isMobile: true,
+			javaScriptEnabled: true,
+			locale: 'fr-FR',
+			offline: true,
+			permissions: ['camera', 'microphone'],
+			reducedMotion: 'no-preference',
+			screen: { width: 800, height: 600 },
+			timezoneID: 'Europe/Paris',
+			userAgent: 'my agent',
+			viewport: { width: 800, height: 600 },
+		};
+		opts;
+	`)
+	require.NoError(t, err)
+
+	parsedOpts, err := parseBrowserContextOptions(vu.Runtime(), opts)
+	require.NoError(t, err)
+
+	assert.Equal(t, &common.BrowserContextOptions{
+		AcceptDownloads:   true,
+		DownloadsPath:     "/tmp",
+		BypassCSP:         true,
+		ColorScheme:       common.ColorSchemeDark,
+		DeviceScaleFactor: 1,
+		ExtraHTTPHeaders: map[string]string{
+			"X-Header": "value",
+		},
+		Geolocation: &common.Geolocation{
+			Latitude:  51.509865,
+			Longitude: -0.118092,
+			Accuracy:  1,
+		},
+		HasTouch: true,
+		HTTPCredentials: common.Credentials{
+			Username: "admin",
+			Password: "password",
+		},
+		IgnoreHTTPSErrors: true,
+		IsMobile:          true,
+		JavaScriptEnabled: true,
+		Locale:            "fr-FR",
+		Offline:           true,
+		Permissions:       []string{"camera", "microphone"},
+		ReducedMotion:     common.ReducedMotionNoPreference,
+		Screen: common.Screen{
+			Width:  800,
+			Height: 600,
+		},
+		TimezoneID: "Europe/Paris",
+		UserAgent:  "my agent",
+		Viewport: common.Viewport{
+			Width:  800,
+			Height: 600,
+		},
+	}, parsedOpts)
+}

vendor/github.com/grafana/xk6-browser/browser/browser_mapping.go → js/modules/k6/browser/browser/browser_mapping.go

@@ -5,8 +5,8 @@ import (
 
 	"github.com/grafana/sobek"
 
-	"github.com/grafana/xk6-browser/common"
-	"github.com/grafana/xk6-browser/k6ext"
+	"go.k6.io/k6/js/modules/k6/browser/common"
+	"go.k6.io/k6/js/modules/k6/browser/k6ext"
 )
 
 // mapBrowser to the JS module.
@@ -36,8 +36,8 @@ func mapBrowser(vu moduleVU) mapping { //nolint:funlen,cyclop,gocognit
 			return b.IsConnected(), nil
 		},
 		"newContext": func(opts sobek.Value) (*sobek.Promise, error) {
-			popts := common.NewBrowserContextOptions()
-			if err := popts.Parse(vu.Context(), opts); err != nil {
+			popts, err := parseBrowserContextOptions(vu.Runtime(), opts)
+			if err != nil {
 				return nil, fmt.Errorf("parsing browser.newContext options: %w", err)
 			}
 			return k6ext.Promise(vu.Context(), func() (any, error) {
@@ -71,8 +71,8 @@ func mapBrowser(vu moduleVU) mapping { //nolint:funlen,cyclop,gocognit
 			return b.Version(), nil
 		},
 		"newPage": func(opts sobek.Value) (*sobek.Promise, error) {
-			popts := common.NewBrowserContextOptions()
-			if err := popts.Parse(vu.Context(), opts); err != nil {
+			popts, err := parseBrowserContextOptions(vu.Runtime(), opts)
+			if err != nil {
 				return nil, fmt.Errorf("parsing browser.newPage options: %w", err)
 			}
 			return k6ext.Promise(vu.Context(), func() (any, error) {
@@ -107,3 +107,12 @@ func initBrowserContext(bctx *common.BrowserContext, testRunID string) error {
 
 	return nil
 }
+
+// parseBrowserContextOptions parses the [common.BrowserContext] options from a Sobek value.
+func parseBrowserContextOptions(rt *sobek.Runtime, opts sobek.Value) (*common.BrowserContextOptions, error) {
+	b := common.DefaultBrowserContextOptions()
+	if err := mergeWith(rt, b, opts); err != nil {
+		return nil, err
+	}
+	return b, nil
+}

vendor/github.com/grafana/xk6-browser/browser/console_message_mapping.go → js/modules/k6/browser/browser/console_message_mapping.go

@@ -1,7 +1,7 @@
 package browser
 
 import (
-	"github.com/grafana/xk6-browser/common"
+	"go.k6.io/k6/js/modules/k6/browser/common"
 )
 
 // mapConsoleMessage to the JS module.

vendor/github.com/grafana/xk6-browser/browser/element_handle_mapping.go → js/modules/k6/browser/browser/element_handle_mapping.go

@@ -5,8 +5,8 @@ import (
 
 	"github.com/grafana/sobek"
 
-	"github.com/grafana/xk6-browser/common"
-	"github.com/grafana/xk6-browser/k6ext"
+	"go.k6.io/k6/js/modules/k6/browser/common"
+	"go.k6.io/k6/js/modules/k6/browser/k6ext"
 )
 
 // mapElementHandle to the JS module.