Add logs to BrowserContext

Author: inancgumus

common/browser_context.go

@@ -77,7 +77,7 @@ func (b *BrowserContext) AddCookies(cookies goja.Value) {
 
 // AddInitScript adds a script that will be initialized on all new pages.
 func (b *BrowserContext) AddInitScript(script goja.Value, arg goja.Value) {
-	b.logger.Debugf("BrowserContext:AddInitScript", "")
+	b.logger.Debugf("BrowserContext:AddInitScript", "bctxid:%v", b.id)
 
 	rt := k6common.GetRuntime(b.ctx)
 
@@ -118,6 +118,8 @@ func (b *BrowserContext) Browser() api.Browser {
 
 // ClearCookies clears cookies.
 func (b *BrowserContext) ClearCookies() {
+	b.logger.Debugf("BrowserContext:ClearCookies", "bctxid:%v", b.id)
+
 	action := storage.ClearCookies().WithBrowserContextID(b.id)
 	if err := action.Do(b.ctx); err != nil {
 		k6Throw(b.ctx, "unable to clear cookies permissions: %w", err)
@@ -126,6 +128,8 @@ func (b *BrowserContext) ClearCookies() {
 
 // ClearPermissions clears any permission overrides.
 func (b *BrowserContext) ClearPermissions() {
+	b.logger.Debugf("BrowserContext:ClearPermissions", "bctxid:%v", b.id)
+
 	action := cdpbrowser.ResetPermissions().WithBrowserContextID(b.id)
 	if err := action.Do(b.ctx); err != nil {
 		k6Throw(b.ctx, "unable to clear override permissions: %w", err)
@@ -134,6 +138,8 @@ func (b *BrowserContext) ClearPermissions() {
 
 // Close shuts down the browser context.
 func (b *BrowserContext) Close() {
+	b.logger.Debugf("BrowserContext:Close", "bctxid:%v", b.id)
+
 	if b.id == "" {
 		k6Throw(b.ctx, "default browser context can't be closed")
 	}
@@ -157,7 +163,8 @@ func (b *BrowserContext) ExposeFunction(name string, callback goja.Callable) {
 
 // GrantPermissions enables the specified permissions, all others will be disabled.
 func (b *BrowserContext) GrantPermissions(permissions []string, opts goja.Value) {
-	b.logger.Debugf("BrowserContext:GrantPermissions", "")
+	b.logger.Debugf("BrowserContext:GrantPermissions", "bctxid:%v", b.id)
+
 	permsToProtocol := map[string]cdpbrowser.PermissionType{
 		"geolocation":          cdpbrowser.PermissionTypeGeolocation,
 		"midi":                 cdpbrowser.PermissionTypeMidi,
@@ -232,11 +239,15 @@ func (b *BrowserContext) Route(url goja.Value, handler goja.Callable) {
 
 // SetDefaultNavigationTimeout sets the default navigation timeout in milliseconds.
 func (b *BrowserContext) SetDefaultNavigationTimeout(timeout int64) {
+	b.logger.Debugf("BrowserContext:SetDefaultNavigationTimeout", "bctxid:%v timeout:%d", b.id, timeout)
+
 	b.timeoutSettings.setDefaultNavigationTimeout(timeout)
 }
 
 // SetDefaultTimeout sets the default maximum timeout in milliseconds.
 func (b *BrowserContext) SetDefaultTimeout(timeout int64) {
+	b.logger.Debugf("BrowserContext:SetDefaultTimeout", "bctxid:%v timeout:%d", b.id, timeout)
+
 	b.timeoutSettings.setDefaultTimeout(timeout)
 }
 
@@ -246,6 +257,8 @@ func (b *BrowserContext) SetExtraHTTPHeaders(headers map[string]string) {
 
 // SetGeolocation overrides the geo location of the user.
 func (b *BrowserContext) SetGeolocation(geolocation goja.Value) {
+	b.logger.Debugf("BrowserContext:SetGeolocation", "bctxid:%v", b.id)
+
 	g := NewGeolocation()
 	if err := g.Parse(b.ctx, geolocation); err != nil {
 		k6Throw(b.ctx, "cannot parse geo location: %w", err)
@@ -261,6 +274,8 @@ func (b *BrowserContext) SetGeolocation(geolocation goja.Value) {
 
 // SetHTTPCredentials sets username/password credentials to use for HTTP authentication.
 func (b *BrowserContext) SetHTTPCredentials(httpCredentials goja.Value) {
+	b.logger.Debugf("BrowserContext:SetHTTPCredentials", "bctxid:%v", b.id)
+
 	c := NewCredentials()
 	if err := c.Parse(b.ctx, httpCredentials); err != nil {
 		k6Throw(b.ctx, "cannot set HTTP credentials: %w", err)
@@ -274,6 +289,8 @@ func (b *BrowserContext) SetHTTPCredentials(httpCredentials goja.Value) {
 
 // SetOffline toggles the browser's connectivity on/off.
 func (b *BrowserContext) SetOffline(offline bool) {
+	b.logger.Debugf("BrowserContext:SetOffline", "bctxid:%v offline:%t", b.id, offline)
+
 	b.opts.Offline = offline
 	for _, p := range b.browser.getPages() {
 		p.updateOffline()
@@ -289,8 +306,8 @@ func (b *BrowserContext) Unroute(url goja.Value, handler goja.Callable) {
 }
 
 func (b *BrowserContext) WaitForEvent(event string, optsOrPredicate goja.Value) interface{} {
-	b.logger.Debugf("BrowserContext:WaitForEvent", "event:%q", event)
 	// TODO: This public API needs Promise support (as return value) to be useful in JS!
+	b.logger.Debugf("BrowserContext:WaitForEvent", "bctxid:%v event:%q", b.id, event)
 
 	rt := k6common.GetRuntime(b.ctx)
 
@@ -326,16 +343,16 @@ func (b *BrowserContext) WaitForEvent(event string, optsOrPredicate goja.Value)
 	ch := make(chan interface{})
 
 	go func() {
-		b.logger.Debugf("BrowserContext:WaitForEvent:go()", "starts")
-		defer b.logger.Debugf("BrowserContext:WaitForEvent:go()", "returns")
+		b.logger.Debugf("BrowserContext:WaitForEvent:go():starts", "bctxid:%v", b.id)
+		defer b.logger.Debugf("BrowserContext:WaitForEvent:go():returns", "bctxid:%v", b.id)
 		for {
 			select {
 			case <-evCancelCtx.Done():
-				b.logger.Debugf("BrowserContext:WaitForEvent:go()", "evCancelCtx done")
+				b.logger.Debugf("BrowserContext:WaitForEvent:go():evCancelCtx:done", "bctxid:%v", b.id)
 				return
 			case ev := <-chEvHandler:
 				if ev.typ == EventBrowserContextClose {
-					b.logger.Debugf("BrowserContext:WaitForEvent:go()", "EventBrowserContextClose returns")
+					b.logger.Debugf("BrowserContext:WaitForEvent:go():EventBrowserContextClose:return", "bctxid:%v", b.id)
 					ch <- nil
 					close(ch)
 
@@ -345,11 +362,11 @@ func (b *BrowserContext) WaitForEvent(event string, optsOrPredicate goja.Value)
 					return
 				}
 				if ev.typ == EventBrowserContextPage {
-					b.logger.Debugf("BrowserContext:WaitForEvent:go()", "EventBrowserContextPage")
+					b.logger.Debugf("BrowserContext:WaitForEvent:go():EventBrowserContextPage", "bctxid:%v", b.id)
 					p := ev.data.(*Page)
 					exported := k6common.Bind(rt, p, &b.ctx)
 					if retVal, err := predicateFn(rt.ToValue(exported)); err == nil && retVal.ToBoolean() {
-						b.logger.Debugf("BrowserContext:WaitForEvent:go()", "EventBrowserContextPage returns")
+						b.logger.Debugf("BrowserContext:WaitForEvent:go():EventBrowserContextPage:return", "bctxid:%v", b.id)
 						ch <- p
 						close(ch)
 
@@ -368,13 +385,13 @@ func (b *BrowserContext) WaitForEvent(event string, optsOrPredicate goja.Value)
 
 	select {
 	case <-b.ctx.Done():
-		b.logger.Debugf("BrowserContext:WaitForEvent", "b.ctx Done")
+		b.logger.Debugf("BrowserContext:WaitForEvent:ctx.Done", "bctxid:%v event:%q", b.id, event)
 	case <-time.After(timeout):
-		b.logger.Debugf("BrowserContext:WaitForEvent", "timeout")
+		b.logger.Debugf("BrowserContext:WaitForEvent:timeout", "bctxid:%v event:%q", b.id, event)
 	case evData := <-ch:
-		b.logger.Debugf("BrowserContext:WaitForEvent", "evData")
+		b.logger.Debugf("BrowserContext:WaitForEvent:evData", "bctxid:%v event:%q", b.id, event)
 		return evData
 	}
-	b.logger.Debugf("BrowserContext:WaitForEvent", "nil return")
+	b.logger.Debugf("BrowserContext:WaitForEvent:return nil", "bctxid:%v event:%q", b.id, event)
 	return nil
 }

common/frame.go

@@ -1375,8 +1375,8 @@ func (f *Frame) WaitForSelector(selector string, opts goja.Value) api.ElementHan
 func (f *Frame) WaitForTimeout(timeout int64) {
 	to := time.Duration(timeout) * time.Millisecond
 
-	f.log.Debugf("Frame:WaitForTimeout", "fid:%s furl:%q to:%s", f.id, f.url, to)
-	defer f.log.Debugf("Frame:WaitForTimeout:return", "fid:%s furl:%q to:%s", f.id, f.url, to)
+	f.log.Debugf("Frame:WaitForTimeout", "fid:%s furl:%q timeout:%s", f.id, f.url, to)
+	defer f.log.Debugf("Frame:WaitForTimeout:return", "fid:%s furl:%q timeout:%s", f.id, f.url, to)
 
 	select {
 	case <-f.ctx.Done():