Refactor lifecycle tests home handler

Deduplicate the home handler in the lifecycle tests.

Author: ankur22

tests/lifecycle_wait_test.go

@@ -14,6 +14,25 @@ import (
 	"github.com/grafana/xk6-browser/common"
 )
 
+// General guidelines on lifecycle events:
+//
+// - load: This lifecycle event is emitted by the browser once:
+//            1. The HTML is loaded;
+//            2. The async scripts have loaded;
+//         It does not wait for the other network requests to
+//         complete.
+//
+// - domcontentloaded: This lifecycle event is emitted by the
+//                     browser once:
+//                         1. The HTML is loaded;
+//                     It does not wait for the async scripts or
+//                     the other network requests to complete.
+//
+// - networkidle: This lifecycle event is emitted by the browser once:
+//            1. The HTML is loaded;
+//            2. The async scripts have loaded;
+//            3. All other network requests have completed;
+
 func TestLifecycleWaitForLoadStateLoad(t *testing.T) {
 	// Test description
 	//
@@ -27,15 +46,12 @@ func TestLifecycleWaitForLoadStateLoad(t *testing.T) {
 	//                   (which is when load is fired). We also want
 	//                   to ensure that the load event is stored
 	//                   internally, and we don't block on WaitForLoadState.
-
 	t.Parallel()
 
 	tb := newTestBrowser(t, withFileServer())
 	p := tb.NewPage(nil)
-	tb.withHandler("/home", func(w http.ResponseWriter, r *http.Request) {
-		http.Redirect(w, r, tb.staticURL("wait_for_nav_lifecycle.html"), http.StatusMovedPermanently)
-	})
 
+	withHomeHandler(t, tb, "wait_for_nav_lifecycle.html")
 	withPingHandler(t, tb, time.Millisecond*100, nil)
 	withPingJSHandler(t, tb, false, nil)
 
@@ -70,10 +86,8 @@ func TestLifecycleWaitForLoadStateDOMContentLoaded(t *testing.T) {
 
 	tb := newTestBrowser(t, withFileServer())
 	p := tb.NewPage(nil)
-	tb.withHandler("/home", func(w http.ResponseWriter, r *http.Request) {
-		http.Redirect(w, r, tb.staticURL("wait_for_nav_lifecycle.html"), http.StatusMovedPermanently)
-	})
 
+	withHomeHandler(t, tb, "wait_for_nav_lifecycle.html")
 	withPingHandler(t, tb, time.Millisecond*100, nil)
 	withPingJSHandler(t, tb, true, nil)
 
@@ -106,10 +120,8 @@ func TestLifecycleWaitForLoadStateNetworkIdle(t *testing.T) {
 
 	tb := newTestBrowser(t, withFileServer())
 	p := tb.NewPage(nil)
-	tb.withHandler("/home", func(w http.ResponseWriter, r *http.Request) {
-		http.Redirect(w, r, tb.staticURL("wait_for_nav_lifecycle.html"), http.StatusMovedPermanently)
-	})
 
+	withHomeHandler(t, tb, "wait_for_nav_lifecycle.html")
 	withPingHandler(t, tb, 0, nil)
 	withPingJSHandler(t, tb, false, nil)
 
@@ -141,10 +153,8 @@ func TestLifecycleWaitForLoadStateDOMContentLoadedThenNetworkIdle(t *testing.T)
 
 	tb := newTestBrowser(t, withFileServer())
 	p := tb.NewPage(nil)
-	tb.withHandler("/home", func(w http.ResponseWriter, r *http.Request) {
-		http.Redirect(w, r, tb.staticURL("wait_for_nav_lifecycle.html"), http.StatusMovedPermanently)
-	})
 
+	withHomeHandler(t, tb, "wait_for_nav_lifecycle.html")
 	withPingHandler(t, tb, time.Millisecond*100, nil)
 	withPingJSHandler(t, tb, false, nil)
 
@@ -164,10 +174,8 @@ func TestLifecycleReloadLoad(t *testing.T) {
 
 	tb := newTestBrowser(t, withFileServer())
 	p := tb.NewPage(nil)
-	tb.withHandler("/home", func(w http.ResponseWriter, r *http.Request) {
-		http.Redirect(w, r, tb.staticURL("reload_lifecycle.html"), http.StatusMovedPermanently)
-	})
 
+	withHomeHandler(t, tb, "reload_lifecycle.html")
 	withPingHandler(t, tb, time.Millisecond*100, nil)
 	withPingJSHandler(t, tb, false, nil)
 
@@ -198,10 +206,8 @@ func TestLifecycleReloadDOMContentLoaded(t *testing.T) {
 
 	tb := newTestBrowser(t, withFileServer())
 	p := tb.NewPage(nil)
-	tb.withHandler("/home", func(w http.ResponseWriter, r *http.Request) {
-		http.Redirect(w, r, tb.staticURL("reload_lifecycle.html"), http.StatusMovedPermanently)
-	})
 
+	withHomeHandler(t, tb, "reload_lifecycle.html")
 	withPingHandler(t, tb, time.Millisecond*100, nil)
 	withPingJSHandler(t, tb, true, nil)
 
@@ -232,10 +238,8 @@ func TestLifecycleReloadNetworkIdle(t *testing.T) {
 
 	tb := newTestBrowser(t, withFileServer())
 	p := tb.NewPage(nil)
-	tb.withHandler("/home", func(w http.ResponseWriter, r *http.Request) {
-		http.Redirect(w, r, tb.staticURL("reload_lifecycle.html"), http.StatusMovedPermanently)
-	})
 
+	withHomeHandler(t, tb, "reload_lifecycle.html")
 	withPingHandler(t, tb, 0, nil)
 	withPingJSHandler(t, tb, false, nil)
 
@@ -294,10 +298,8 @@ func TestLifecycleNetworkIdle(t *testing.T) {
 
 		tb := newTestBrowser(t, withFileServer())
 		p := tb.NewPage(nil)
-		tb.withHandler("/home", func(w http.ResponseWriter, r *http.Request) {
-			http.Redirect(w, r, tb.staticURL("prolonged_network_idle.html"), http.StatusMovedPermanently)
-		})
 
+		withHomeHandler(t, tb, "prolonged_network_idle.html")
 		ch := make(chan bool)
 		withPingHandler(t, tb, time.Millisecond*50, ch)
 		withPingJSHandler(t, tb, false, ch)
@@ -316,10 +318,8 @@ func TestLifecycleNetworkIdle(t *testing.T) {
 
 		tb := newTestBrowser(t, withFileServer())
 		p := tb.NewPage(nil)
-		tb.withHandler("/home", func(w http.ResponseWriter, r *http.Request) {
-			http.Redirect(w, r, tb.staticURL("prolonged_network_idle_10.html"), http.StatusMovedPermanently)
-		})
 
+		withHomeHandler(t, tb, "prolonged_network_idle_10.html")
 		withPingHandler(t, tb, time.Millisecond*50, nil)
 
 		assertHome(t, tb, p, common.LifecycleEventNetworkIdle, func() {
@@ -329,6 +329,14 @@ func TestLifecycleNetworkIdle(t *testing.T) {
 	})
 }
 
+func withHomeHandler(t *testing.T, tb *testBrowser, htmlFile string) {
+	t.Helper()
+
+	tb.withHandler("/home", func(w http.ResponseWriter, r *http.Request) {
+		http.Redirect(w, r, tb.staticURL(htmlFile), http.StatusMovedPermanently)
+	})
+}
+
 func withPingHandler(t *testing.T, tb *testBrowser, slow time.Duration, ch chan bool) {
 	t.Helper()