Rename vital hook

vercel · Dec 9, 2021 · 0bd9ac7 · 0bd9ac7
1 parent 4d4f309
commit 0bd9ac7
Show file tree

Hide file tree

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

diff --git a/packages/next/taskfile.js b/packages/next/taskfile.js
@@ -1099,14 +1099,6 @@ export async function client(task, opts) {
   notify('Compiled client files')
 }
 
-export async function vitals(task, opts) {
-  await task
-    .source(opts.src || 'vitals/**/*.+(js|ts|tsx)')
-    .swc('vitals', { dev: opts.dev })
-    .target('dist/vitals')
-  notify('Compiled vitals files')
-}
-
 // export is a reserved keyword for functions
 export async function nextbuildstatic(task, opts) {
   await task

diff --git a/packages/next/vitals.d.ts b/packages/next/vitals.d.ts
@@ -1 +1 @@
-export { useExperimentalWebVitalsReport } from './dist/vitals/index'
+export { unstable_useWebVitalsReport } from './dist/vitals/index'
diff --git a/packages/next/vitals.js b/packages/next/vitals.js
@@ -1,4 +1,4 @@
 module.exports = {
-  useExperimentalWebVitalsReport: require('./dist/client/vitals')
-    .useExperimentalWebVitalsReport,
+  unstable_useWebVitalsReport: require('./dist/client/vitals')
+    .unstable_useWebVitalsReport,
 }
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 { useExperimentalWebVitalsReport } from 'next/vitals'
+import { unstable_useWebVitalsReport } 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.
-  ///* useExperimentalWebVitalsReport
-  useExperimentalWebVitalsReport((data) => {
+  ///* unstable_useWebVitalsReport
+  unstable_useWebVitalsReport((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)
   })
-  // useExperimentalWebVitalsReport */
+  // unstable_useWebVitalsReport */
 
   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('///* useExperimentalWebVitalsReport', '/*')
-    indexPage.replace('// useExperimentalWebVitalsReport */', '*/')
+    indexPage.replace('///* unstable_useWebVitalsReport', '/*')
+    indexPage.replace('// unstable_useWebVitalsReport */', '*/')
     await buildApp()
   })
   afterAll(async () => {