rename to useExperimentalWebVitalsReport

vercel · Sep 24, 2021 · fc65092 · fc65092
1 parent 4a7404c
commit fc65092
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 8 deletions.
diff --git a/packages/next/vitals/index.ts b/packages/next/vitals/index.ts
@@ -1 +1 @@
-export { useWebVitalsReport } from './vitals'
+export { useExperimentalWebVitalsReport } from './vitals'
diff --git a/packages/next/vitals/vitals.ts b/packages/next/vitals/vitals.ts
@@ -10,7 +10,9 @@ export function trackWebVitalMetric(metric: NextWebVitalsMetric) {
   webVitalsCallbacks.forEach((callback) => callback(metric))
 }
 
-export function useWebVitalsReport(callback: ReportWebVitalsCallback) {
+export function useExperimentalWebVitalsReport(
+  callback: ReportWebVitalsCallback
+) {
   const metricIndexRef = useRef(0)
 
   useEffect(() => {

diff --git a/test/integration/relay-analytics/pages/index.js b/test/integration/relay-analytics/pages/index.js
@@ -1,5 +1,5 @@
 /* global localStorage */
-import { useWebVitalsReport } from 'next/vitals'
+import { useExperimentalWebVitalsReport } from 'next/vitals'
 
 if (typeof navigator !== 'undefined') {
   window.__BEACONS = window.__BEACONS || []
@@ -21,8 +21,8 @@ if (typeof navigator !== 'undefined') {
 
 export default () => {
   // Below comment will be used for replacing exported report method with hook based one.
-  ///* useWebVitalsReport
-  useWebVitalsReport((data) => {
+  ///* useExperimentalWebVitalsReport
+  useExperimentalWebVitalsReport((data) => {
     const name = data.name || data.entryType
     localStorage.setItem(
       name,
@@ -31,7 +31,7 @@ export default () => {
     const countMap = window.__BEACONS_COUNT
     countMap.set(name, (countMap.get(name) || 0) + 1)
   })
-  // useWebVitalsReport */
+  // useExperimentalWebVitalsReport */
 
   return (
     <div>

diff --git a/test/integration/relay-analytics/test/index.test.js b/test/integration/relay-analytics/test/index.test.js
@@ -35,8 +35,8 @@ async function killServer() {
 describe('Analytics relayer with exported method', () => {
   beforeAll(async () => {
     // Keep app exported reporting and comment the hook one
-    indexPage.replace('///* useWebVitalsReport', '/*')
-    indexPage.replace('// useWebVitalsReport */', '*/')
+    indexPage.replace('///* useExperimentalWebVitalsReport', '/*')
+    indexPage.replace('// useExperimentalWebVitalsReport */', '*/')
     await buildApp()
   })
   afterAll(async () => {