make Page.WaitStable more stable

go-rod · Jul 12, 2023 · ba218fa · ba218fa
1 parent cc4f51f
commit ba218fa
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 97 deletions.
diff --git a/fixtures/page-wait-stable.html b/fixtures/page-wait-stable.html
@@ -1,89 +1,19 @@
 <!DOCTYPE html>
 <html>
- <head>
- <title>PageWaitStable</title>
- <style>
- /* 进度条的样式 */
- progress[value] {
- display: block;
- width: 100%;
- margin-top: 20px;
- -webkit-appearance: none;
- appearance: none;
- height: 10px;
- background-color: #ddd;
- }
-
- progress[value]::-webkit-progress-bar {
- background-color: #ddd;
- }
-
- progress[value]::-webkit-progress-value {
- background-color: #0078ff;
- }
-
- /* loading 动画的样式 */
- .loading {
- display: block;
- position: fixed;
- top: 50%;
- left: 50%;
- transform: translate(-50%, -50%);
- z-index: 9999;
- }
- </style>
- </head>
-
  <body>
- <!-- 进度条 -->
- <progress id="progressBar" value="0" max="100"></progress>
-
- <!-- loading 动画 -->
- <div id="loading" class="loading">
- <img src="path-to-loading-gif" alt="loading" />
- </div>
-
- <!-- Your other HTML content here -->
-
- <!-- 页面加载完成时的弹窗 -->
- <div
- id="popup"
- style="
- display: none;
- position: fixed;
- top: 50%;
- left: 50%;
- transform: translate(-50%, -50%);
- background-color: #fff;
- padding: 20px;
- border-radius: 10px;
- box-shadow: 2px 2px 10px #888;
- "
- >
- <h1 style="text-align: center">Page loading and rendering complete</h1>
- </div>
+ <div id="progress"></div>
 
  <script>
- /* 页面加载时触发的函数 */
  window.onload = function () {
- /* 获取进度条和 loading 动画元素 */
- var progressBar = document.getElementById('progressBar')
- var loading = document.getElementById('loading')
- var popup = document.getElementById('popup')
- var progress = 0
- /* 定时器，每 50ms 触发一次 */
- var timer = setInterval(function () {
- /* 如果进度条已满，则隐藏 loading 动画，并显示弹窗 */
- if (progress === 100) {
- clearInterval(timer)
- loading.style.display = 'none'
- popup.style.display = 'block'
- } else {
- /* 否则，增加进度，更新进度条 */
- progress += 1
- progressBar.value = progress
- }
- }, 50)
+ var pg = document.getElementById('progress')
+ var count = 0
+ function tick() {
+ count += 1
+ pg.textContent = count + '%'
+
+ if (count < 100) setTimeout(tick, 10)
+ }
+ tick()
  }
  </script>
  </body>

diff --git a/must.go b/must.go
@@ -427,7 +427,7 @@ func (p *Page) MustWaitIdle() *Page {
 
 // MustWaitStable is similar to Page.WaitStable
 func (p *Page) MustWaitStable() *Page {
- p.e(p.WaitStable(800*time.Millisecond, 1))
+ p.e(p.WaitStable(time.Second, 0))
  return p
 }
 

diff --git a/page.go b/page.go
@@ -629,13 +629,11 @@ func (p *Page) WaitRequestIdle(d time.Duration, includes, excludes []string) fun
  }
 }
 
-// WaitStable like "Element.WaitStable". WaitStable polling the changes
-// of the DOM tree in `d` duration,until the similarity equal or more than simThreshold.
-// `simThreshold` is the similarity threshold,it's scope in [0,1].
-// Be careful,d is not the max wait timeout, it's the least stable time.
+// WaitStable waits until the change of the DOM tree is less or equal than diff percent for d duration.
+// Be careful, d is not the max wait timeout, it's the least stable time.
 // If you want to set a timeout you can use the "Page.Timeout" function.
-func (p *Page) WaitStable(d time.Duration, similarity float32) error {
- defer p.tryTrace(TraceTypeWait, "stable")
+func (p *Page) WaitStable(d time.Duration, diff float64) error {
+ defer p.tryTrace(TraceTypeWait, "stable")()
 
  domSnapshot, err := p.CaptureDOMSnapshot()
  if err != nil {
@@ -659,10 +657,10 @@ func (p *Page) WaitStable(d time.Duration, similarity float32) error {
 
  xs := lcs.NewWords(domSnapshot.Strings)
  ys := lcs.NewWords(currentDomSnapshot.Strings)
- diff := xs.YadLCS(p.ctx, ys)
+ lcs := xs.YadLCS(p.ctx, ys)
 
- sim := float32(len(diff)) / float32(len(ys))
- if sim >= similarity {
+ df := 1 - float64(len(lcs))/float64(len(ys))
+ if df <= diff {
  break
  }
 

diff --git a/page_test.go b/page_test.go
@@ -525,14 +525,16 @@ func TestPageCaptureDOMSnapshot(t *testing.T) {
 func TestPageWaitStable(t *testing.T) {
  g := setup(t)
 
- p := g.page.MustNavigate(g.srcFile("fixtures/page-wait-stable.html"))
- // wait for p loading and rending complete
- p.MustWaitStable()
+ {
+ p := g.page.MustNavigate(g.srcFile("fixtures/page-wait-stable.html"))
+ p.MustWaitStable()
+ }
 
- // for waitStable timeout
- timeOutPage := p.Timeout(1 * time.Second)
- err := timeOutPage.WaitStable(2*time.Second, 1)
- g.Is(err, context.DeadlineExceeded)
+ {
+ p := g.page.MustNavigate(g.srcFile("fixtures/page-wait-stable.html"))
+ err := p.Timeout(time.Second).WaitStable(time.Second, 0)
+ g.Is(err, context.DeadlineExceeded)
+ }
 
  {
  g.Panic(func() {