feat: add support for Page.ResetNavigationHistory (#1087)

* feat: add support for Page.ResetNavigationHistory * Update .gitignore Co-authored-by: Yad Smood <[email protected]> * Update page.go Co-authored-by: Yad Smood <[email protected]> --------- Co-authored-by: jackcipher <[email protected]> Co-authored-by: Yad Smood <[email protected]>
go-rod · Jul 11, 2024 · 6671261 · 6671261
1 parent c42b414
commit 6671261
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 0 deletions.
diff --git a/must.go b/must.go
@@ -233,6 +233,12 @@ func (p *Page) MustNavigate(url string) *Page {
 	return p
 }
 
+// MustResetNavigationHistory is similar to [Page.ResetNavigationHistory]
+func (p *Page) MustResetNavigationHistory() *Page {
+	p.e(p.ResetNavigationHistory())
+	return p
+}
+
 // MustReload is similar to [Page.Reload].
 func (p *Page) MustReload() *Page {
 	p.e(p.Reload())

diff --git a/page.go b/page.go
@@ -197,6 +197,17 @@ func (p *Page) NavigateBack() error {
 	return err
 }
 
+// ResetNavigationHistory reset history
+func (p *Page) ResetNavigationHistory() error {
+	err := proto.PageResetNavigationHistory{}.Call(p)
+	return err
+}
+
+// GetNavigationHistory get navigation history
+func (p *Page) GetNavigationHistory() (*proto.PageGetNavigationHistoryResult, error) {
+	return proto.PageGetNavigationHistory{}.Call(p)
+}
+
 // NavigateForward history.
 func (p *Page) NavigateForward() error {
 	// Not using cdp API because it doesn't work for iframe

diff --git a/page_test.go b/page_test.go
@@ -1085,3 +1085,63 @@ func TestPageActionAfterClose(t *testing.T) {
 		g.Eq(err, context.Canceled)
 	}
 }
+
+func TestPageResetNavigationHistory(t *testing.T) {
+	const (
+		// After resetting history, the record should contain only the current page entry
+		expectedInitialHistoryLength = 1
+		clickHTMLPath                = "fixtures/click.html"
+		inputHTMLPath                = "fixtures/input.html"
+	)
+
+	g := setup(t)
+
+	// Helper function for navigation
+	navigateTo := func(p *rod.Page, url string) {
+		wait := p.WaitNavigation(proto.PageLifecycleEventNameDOMContentLoaded)
+		p.MustNavigate(url)
+		wait()
+	}
+
+	// Initialize page with blank content
+	page := g.page.MustNavigate(g.blank())
+
+	// Navigate to multiple pages
+	navigateTo(page, g.srcFile(clickHTMLPath))
+	navigateTo(page, g.srcFile(inputHTMLPath))
+
+	// Verify navigation back functionality
+	wait := page.WaitNavigation(proto.PageLifecycleEventNameDOMContentLoaded)
+	page.MustNavigateBack()
+	wait()
+
+	g.Regex(`/`+clickHTMLPath, page.MustInfo().URL)
+
+	// Verify history has multiple entries
+	initialHistory, err := page.GetNavigationHistory()
+	g.E(err)
+	g.NotNil(initialHistory)
+	g.Gt(len(initialHistory.Entries), expectedInitialHistoryLength)
+
+	// Test resetting navigation history
+	err = page.ResetNavigationHistory()
+	g.E(err)
+
+	// Verify history is reset to initial state
+	resetHistory, err := page.GetNavigationHistory()
+	g.E(err)
+	g.NotNil(resetHistory)
+	g.Eq(len(resetHistory.Entries), expectedInitialHistoryLength)
+
+	// Navigate to another page
+	navigateTo(page, g.srcFile(inputHTMLPath))
+
+	// Test resetting history again
+	page.MustResetNavigationHistory()
+
+	// Verify history is reset again
+	finalHistory, err := page.GetNavigationHistory()
+	g.E(err)
+	g.NotNil(finalHistory)
+	g.Eq(len(finalHistory.Entries), expectedInitialHistoryLength)
+}