Merge pull request #649 from grafana/add/641-naked-browser-launch-opts

Add/641 naked browser launch opts

Author: inancgumus

chromium/browser_type.go

@@ -131,9 +131,8 @@ func (b *BrowserType) Launch(opts goja.Value) api.Browser {
 	if b.logger, err = makeLogger(ctx); err != nil {
 		k6ext.Panic(ctx, "setting up logger: %w", err)
 	}
-
 	launchOpts := common.NewLaunchOptions(k6ext.OnCloud())
-	if err := launchOpts.Parse(ctx, opts, b.logger); err != nil {
+	if err := launchOpts.Parse(ctx, b.logger, opts); err != nil {
 		k6ext.Panic(ctx, "parsing launch options: %w", err)
 	}
 	ctx = common.WithLaunchOptions(ctx, launchOpts)

common/browser_options.go

@@ -2,7 +2,6 @@ package common
 
 import (
 	"context"
-	"errors"
 	"time"
 
 	"github.com/dop251/goja"
@@ -55,9 +54,10 @@ func NewLaunchOptions(onCloud bool) *LaunchOptions {
 }
 
 // Parse parses launch options from a JS object.
-func (l *LaunchOptions) Parse(ctx context.Context, opts goja.Value, logger *log.Logger) error { //nolint:cyclop
+func (l *LaunchOptions) Parse(ctx context.Context, logger *log.Logger, opts goja.Value) error { //nolint:cyclop
+	// when opts is nil, we just return the default options without error.
 	if !gojaValueExists(opts) {
-		return errors.New("LaunchOptions does not exist in the runtime")
+		return nil
 	}
 	var (
 		rt       = k6ext.Runtime(ctx)

common/browser_options_test.go

@@ -14,6 +14,13 @@ import (
 func TestBrowserLaunchOptionsParse(t *testing.T) {
 	t.Parallel()
 
+	defaultOptions := &LaunchOptions{
+		Env:               make(map[string]string),
+		Headless:          true,
+		LogCategoryFilter: ".*",
+		Timeout:           DefaultTimeout,
+	}
+
 	for name, tt := range map[string]struct {
 		opts    map[string]any
 		assert  func(testing.TB, *LaunchOptions)
@@ -24,12 +31,14 @@ func TestBrowserLaunchOptionsParse(t *testing.T) {
 			opts: map[string]any{},
 			assert: func(tb testing.TB, lo *LaunchOptions) {
 				tb.Helper()
-				assert.Equal(t, &LaunchOptions{
-					Env:               make(map[string]string),
-					Headless:          true,
-					LogCategoryFilter: ".*",
-					Timeout:           DefaultTimeout,
-				}, lo)
+				assert.Equal(t, defaultOptions, lo)
+			},
+		},
+		"defaults_nil": { // providing nil option returns default options
+			opts: nil,
+			assert: func(tb testing.TB, lo *LaunchOptions) {
+				tb.Helper()
+				assert.Equal(t, defaultOptions, lo)
 			},
 		},
 		"defaults_on_cloud": {
@@ -253,7 +262,7 @@ func TestBrowserLaunchOptionsParse(t *testing.T) {
 				vu = k6test.NewVU(t)
 				lo = NewLaunchOptions(tt.onCloud)
 			)
-			err := lo.Parse(vu.Context(), vu.ToGojaValue(tt.opts), log.NewNullLogger())
+			err := lo.Parse(vu.Context(), log.NewNullLogger(), vu.ToGojaValue(tt.opts))
 			if tt.err != "" {
 				require.ErrorContains(t, err, tt.err)
 			} else {

examples/launch_naked.js

@@ -0,0 +1,15 @@
+import exec from 'k6/execution';
+import { chromium } from 'k6/x/browser';
+
+export const options = {}
+
+export default function() {
+  try {
+    const browser = chromium.launch();
+    browser.close();
+  } catch (e) {
+    // The test should not fail when launching the browser without
+    // options. Try catch is used to report the error to the shell.
+    exec.test.abort(e);
+  }
+}