Skip to content

Commit 59a4432

Browse files
huozhiijjkkodiakhq[bot]
authored
Rename experimental vital hook (#32343)
* Rename vital hook * update taskfile * disable hook rule for unstable prefix * rename at exports * fix typing Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
1 parent adbe237 commit 59a4432

6 files changed

Lines changed: 10 additions & 22 deletions

File tree

‎packages/next/client/vitals.ts‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ export function trackWebVitalMetric(metric: NextWebVitalsMetric) {
1010
webVitalsCallbacks.forEach((callback) => callback(metric))
1111
}
1212

13-
export function useExperimentalWebVitalsReport(
14-
callback: ReportWebVitalsCallback
15-
) {
13+
export function useWebVitalsReport(callback: ReportWebVitalsCallback) {
1614
const metricIndexRef = useRef(0)
1715

1816
useEffect(() => {

‎packages/next/taskfile.js‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,7 +1036,6 @@ export async function compile(task, opts) {
10361036
'pages',
10371037
'lib',
10381038
'client',
1039-
'vitals',
10401039
'telemetry',
10411040
'trace',
10421041
'shared',
@@ -1099,14 +1098,6 @@ export async function client(task, opts) {
10991098
notify('Compiled client files')
11001099
}
11011100

1102-
export async function vitals(task, opts) {
1103-
await task
1104-
.source(opts.src || 'vitals/**/*.+(js|ts|tsx)')
1105-
.swc('vitals', { dev: opts.dev })
1106-
.target('dist/vitals')
1107-
notify('Compiled vitals files')
1108-
}
1109-
11101101
// export is a reserved keyword for functions
11111102
export async function nextbuildstatic(task, opts) {
11121103
await task
@@ -1181,7 +1172,6 @@ export default async function (task) {
11811172
await task.watch('build/**/*.+(js|ts|tsx)', 'nextbuild', opts)
11821173
await task.watch('export/**/*.+(js|ts|tsx)', 'nextbuildstatic', opts)
11831174
await task.watch('client/**/*.+(js|ts|tsx)', 'client', opts)
1184-
await task.watch('vitals/**/*.+(js|ts|tsx)', 'vitals', opts)
11851175
await task.watch('lib/**/*.+(js|ts|tsx)', 'lib', opts)
11861176
await task.watch('cli/**/*.+(js|ts|tsx)', 'cli', opts)
11871177
await task.watch('telemetry/**/*.+(js|ts|tsx)', 'telemetry', opts)

‎packages/next/vitals.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
export { useExperimentalWebVitalsReport } from './dist/vitals/index'
1+
export { useWebVitalsReport as unstable_useWebVitalsReport } from './dist/client/vitals'

‎packages/next/vitals.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
module.exports = {
2-
useExperimentalWebVitalsReport: require('./dist/client/vitals')
3-
.useExperimentalWebVitalsReport,
2+
unstable_useWebVitalsReport: require('./dist/client/vitals')
3+
.useWebVitalsReport,
44
}

‎test/integration/relay-analytics/pages/index.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* global localStorage */
2-
import { useExperimentalWebVitalsReport } from 'next/vitals'
2+
import { unstable_useWebVitalsReport } from 'next/vitals'
33

44
if (typeof navigator !== 'undefined') {
55
window.__BEACONS = window.__BEACONS || []
@@ -21,8 +21,8 @@ if (typeof navigator !== 'undefined') {
2121

2222
export default () => {
2323
// Below comment will be used for replacing exported report method with hook based one.
24-
///* useExperimentalWebVitalsReport
25-
useExperimentalWebVitalsReport((data) => {
24+
///* unstable_useWebVitalsReport
25+
unstable_useWebVitalsReport((data) => {
2626
const name = data.name || data.entryType
2727
localStorage.setItem(
2828
name,
@@ -31,7 +31,7 @@ export default () => {
3131
const countMap = window.__BEACONS_COUNT
3232
countMap.set(name, (countMap.get(name) || 0) + 1)
3333
})
34-
// useExperimentalWebVitalsReport */
34+
// unstable_useWebVitalsReport */
3535

3636
return (
3737
<div>

‎test/integration/relay-analytics/test/index.test.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ async function killServer() {
3535
describe('Analytics relayer with exported method', () => {
3636
beforeAll(async () => {
3737
// Keep app exported reporting and comment the hook one
38-
indexPage.replace('///* useExperimentalWebVitalsReport', '/*')
39-
indexPage.replace('// useExperimentalWebVitalsReport */', '*/')
38+
indexPage.replace('///* unstable_useWebVitalsReport', '/*')
39+
indexPage.replace('// unstable_useWebVitalsReport */', '*/')
4040
await buildApp()
4141
})
4242
afterAll(async () => {

0 commit comments

Comments
 (0)