test(fix: Prevent page to scroll to top during data HMR) (#35744)

ijjk · web-flow · commit 050936c040f5 · 2022-03-30T11:20:50.000-05:00
* fix: Prevent page to scroll to top during data HMR

* Add test for scroll position with gssp refreshing
diff --git a/test/development/basic/gssp-ssr-change-reloading/pages/another/index.js b/test/development/basic/gssp-ssr-change-reloading/pages/another/index.js
@@ -9,6 +9,8 @@ export default function Gsp(props) {
     <>
       <p id="change">change me</p>
       <p id="props">{JSON.stringify(props)}</p>
+      <div style={{ height: 1000, width: 50, background: 'cyan' }}></div>
+      <p id="scroll-target">bottom</p>
     </>
   )
 }
diff --git a/test/development/basic/gssp-ssr-change-reloading/test/index.test.ts b/test/development/basic/gssp-ssr-change-reloading/test/index.test.ts
@@ -163,7 +163,44 @@ describe('GS(S)P Server-Side Change Reloading', () => {
       originalContent.replace('count = 1', 'count = 2')
     )
 
+    await check(
+      async () =>
+        JSON.parse(await browser.elementByCss('#props').text()).count + '',
+      '2'
+    )
+    expect(await browser.eval('window.beforeChange')).toBe('hi')
+    await next.patchFile(page, originalContent)
+  })
+
+  it('should keep scroll position when updating from change in getStaticProps', async () => {
+    const browser = await webdriver(next.url, '/another')
+    await browser.eval(
+      'document.getElementById("scroll-target").scrollIntoView()'
+    )
+    const scrollPosition = await browser.eval(
+      'document.documentElement.scrollTop'
+    )
+    await browser.eval(`window.beforeChange = 'hi'`)
+
+    const props = JSON.parse(await browser.elementByCss('#props').text())
+    expect(props.count).toBe(1)
+
+    const page = 'pages/another/index.js'
+    const originalContent = await next.readFile(page)
+    await next.patchFile(
+      page,
+      originalContent.replace('count = 1', 'count = 2')
+    )
+
+    await check(
+      async () =>
+        JSON.parse(await browser.elementByCss('#props').text()).count + '',
+      '2'
+    )
     expect(await browser.eval('window.beforeChange')).toBe('hi')
+    expect(await browser.eval('document.documentElement.scrollTop')).toBe(
+      scrollPosition
+    )
     await next.patchFile(page, originalContent)
   })
 

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@ export default function Gsp(props) {`
`9`	`9`	`<>`
`10`	`10`	`<p id="change">change me</p>`
`11`	`11`	`<p id="props">{JSON.stringify(props)}</p>`
	`12`	`+ <div style={{ height: 1000, width: 50, background: 'cyan' }}></div>`
	`13`	`+ <p id="scroll-target">bottom</p>`
`12`	`14`	`</>`
`13`	`15`	`)`
`14`	`16`	`}`