Dev tracing: include page visibility when reporting HMR (#55247)

Since browsers throttle JavaScript execution when pages (tabs) aren't visible, this can impact the accuracy of this metric. Test Plan: Tested with page visible and not, and verified the request body reflected this. Closes WEB-1536
vercel · Sep 14, 2023 · 423d66b · 423d66b
1 parent 055b5df
commit 423d66b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/packages/next/src/client/dev/error-overlay/hot-dev-client.ts b/packages/next/src/client/dev/error-overlay/hot-dev-client.ts
@@ -221,6 +221,9 @@ function onFastRefresh(updatedModules: string[]) {
         endTime: endLatency,
         page: window.location.pathname,
         updatedModules,
+        // Whether the page (tab) was hidden at the time the event occurred.
+        // This can impact the accuracy of the event's timing.
+        isPageHidden: document.visibilityState === 'hidden',
       })
     )
     if (self.__NEXT_HMR_LATENCY_CB) {

diff --git a/packages/next/src/server/dev/hot-reloader-webpack.ts b/packages/next/src/server/dev/hot-reloader-webpack.ts
@@ -408,6 +408,7 @@ export default class HotReloader implements NextJsHotReloaderInterface {
                     m.replace(/^\.\//, '[project]/')
                   ),
                   page: payload.page,
+                  isPageHidden: payload.isPageHidden,
                 },
               }
               break
-Original file line number
+Diff line change
@@ Expand Up @@
                         m.replace(/^\.\//, '[project]/')
                       ),
                       page: payload.page,
+                      isPageHidden: payload.isPageHidden,
                     },
                   }
                   break
@@ Expand Down @@