Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecation warning for config.analyticsId #60677

Conversation

feugy
Copy link
Member

@feugy feugy commented Jan 15, 2024

 🧐 What's in there?

config.analyticsId is a rarely-used mechanism, initially intended to Next.js users hosting their application themselves and willing to report Core Web Vitals to Vercel Speed Insights.

This platform specific mechanism can be replaced with the built-in useReportWebVitals.

🧪 How to test?

  1. make a new Next.js app
  2. define env variable VERCEL_ANALYTICS_ID to a dummy value
  3. start your application in dev mode:
    ⚠ config.analyticsId is deprecated and will be removed in next major version. Read more: https://nextjs.org/docs/messages/deprecated-analyticsid
    
       ▲ Next.js 14.0.5-canary.58
       - Local:        http://localhost:3000
     ✓ Ready in 917ms
  4. build your application:
       ▲ Next.js 14.0.5-canary.58
    
       Creating an optimized production build ...
     ✓ Compiled successfully
       Linting and checking validity of types  .
     ⚠ The Next.js plugin was not detected in your ESLint configuration. See https://nextjs.org/docs/basic-features/eslint#migrating-existing-config
     ✓ Linting and checking validity of types
     ✓ Collecting page data
     ✓ Generating static pages (4/4)
     ⚠ `config.analyticsId` is deprecated and will be removed in next major version. Read more: https://nextjs.org/docs/messages/deprecated-analyticsid
  5. remove the env variable, add a next.config.js file with a dummy analyticsId variable:
    module.exports = { analyticsId: "UA-12345678-9" };
  6. start your application in dev mode: it'll issue the same warning.
  7. build your application: it'll issue the same warning.

@ijjk
Copy link
Member

ijjk commented Jan 15, 2024

Allow CI Workflow Run

  • approve CI run for commit: 7e6bc1a

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

1 similar comment
@ijjk
Copy link
Member

ijjk commented Jan 15, 2024

Allow CI Workflow Run

  • approve CI run for commit: 7e6bc1a

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@ijjk
Copy link
Member

ijjk commented Jan 15, 2024

Allow CI Workflow Run

  • approve CI run for commit: 69a8a82

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@feugy feugy marked this pull request as ready for review January 15, 2024 17:21
@feugy feugy changed the title [Work in progress]: deprecate analyticsId and au Deprecation warning for config.analyticsId Jan 15, 2024
@feugy feugy force-pushed the damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights branch from 7e6bc1a to b6e5838 Compare January 16, 2024 14:29
@feugy feugy force-pushed the damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights branch from b6e5838 to c315662 Compare January 16, 2024 15:11
@feugy feugy requested review from a team as code owners January 16, 2024 15:11
@feugy feugy requested review from manovotny and leerob and removed request for a team January 16, 2024 15:12
@feugy feugy force-pushed the damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights branch from c315662 to 3a6a146 Compare January 16, 2024 15:16
@feugy feugy force-pushed the damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights branch from 3a6a146 to 69a8a82 Compare January 17, 2024 07:39
Copy link
Member

@timneutkens timneutkens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a test suite for the env var: https://github.com/vercel/next.js/blob/e35033cfbc1e8f6d089726e594d6cfb26c3ba1e4/test/e2e/app-dir/app/vercel-speed-insights.test.ts

You can add a test there for stdout / stderr to make sure the warning is logged correctly in both environments 👍

@ijjk
Copy link
Member

ijjk commented Jan 19, 2024

Tests Passed

@ijjk
Copy link
Member

ijjk commented Jan 19, 2024

Stats from current PR

Default Build
General Overall increase ⚠️
vercel/next.js canary feugy/next.js damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights Change
buildDuration 11.8s 11.7s N/A
buildDurationCached 6s 5s N/A
nodeModulesSize 200 MB 200 MB ⚠️ +1.94 kB
nextStartRea..uration (ms) 429ms 432ms N/A
Client Bundles (main, webpack)
vercel/next.js canary feugy/next.js damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights Change
193.HASH.js gzip 181 B 182 B N/A
3f784ff6-HASH.js gzip 53.4 kB 53.4 kB
433-HASH.js gzip 29 kB 29 kB N/A
framework-HASH.js gzip 45.2 kB 45.2 kB
main-app-HASH.js gzip 239 B 243 B N/A
main-HASH.js gzip 31.8 kB 31.8 kB N/A
webpack-HASH.js gzip 1.7 kB 1.7 kB N/A
Overall change 98.6 kB 98.6 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary feugy/next.js damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary feugy/next.js damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights Change
_app-HASH.js gzip 194 B 195 B N/A
_error-HASH.js gzip 183 B 181 B N/A
amp-HASH.js gzip 504 B 502 B N/A
css-HASH.js gzip 321 B 321 B
dynamic-HASH.js gzip 2.5 kB 2.5 kB N/A
edge-ssr-HASH.js gzip 255 B 253 B N/A
head-HASH.js gzip 350 B 349 B N/A
hooks-HASH.js gzip 369 B 369 B
image-HASH.js gzip 4.18 kB 4.18 kB N/A
index-HASH.js gzip 255 B 256 B N/A
link-HASH.js gzip 2.61 kB 2.61 kB
routerDirect..HASH.js gzip 312 B 311 B N/A
script-HASH.js gzip 385 B 383 B N/A
withRouter-HASH.js gzip 307 B 308 B N/A
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 3.4 kB 3.4 kB
Client Build Manifests
vercel/next.js canary feugy/next.js damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights Change
_buildManifest.js gzip 484 B 485 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary feugy/next.js damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights Change
index.html gzip 528 B 528 B
link.html gzip 540 B 540 B
withRouter.html gzip 523 B 523 B
Overall change 1.59 kB 1.59 kB
Edge SSR bundle Size
vercel/next.js canary feugy/next.js damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights Change
edge-ssr.js gzip 94 kB 94 kB N/A
page.js gzip 148 kB 148 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary feugy/next.js damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights Change
middleware-b..fest.js gzip 625 B 627 B N/A
middleware-r..fest.js gzip 151 B 151 B
middleware.js gzip 37.5 kB 37.5 kB N/A
edge-runtime..pack.js gzip 1.92 kB 1.92 kB
Overall change 2.07 kB 2.07 kB
Next Runtimes
vercel/next.js canary feugy/next.js damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights Change
app-page-exp...dev.js gzip 169 kB 169 kB
app-page-exp..prod.js gzip 95.6 kB 95.6 kB
app-page-tur..prod.js gzip 96.3 kB 96.3 kB
app-page-tur..prod.js gzip 90.8 kB 90.8 kB
app-page.run...dev.js gzip 142 kB 142 kB
app-page.run..prod.js gzip 90.2 kB 90.2 kB
app-route-ex...dev.js gzip 24.2 kB 24.2 kB
app-route-ex..prod.js gzip 16.8 kB 16.8 kB
app-route-tu..prod.js gzip 16.8 kB 16.8 kB
app-route-tu..prod.js gzip 16.4 kB 16.4 kB
app-route.ru...dev.js gzip 23.6 kB 23.6 kB
app-route.ru..prod.js gzip 16.4 kB 16.4 kB
pages-api-tu..prod.js gzip 9.39 kB 9.39 kB
pages-api.ru...dev.js gzip 9.67 kB 9.67 kB
pages-api.ru..prod.js gzip 9.39 kB 9.39 kB
pages-turbo...prod.js gzip 22 kB 22 kB
pages.runtim...dev.js gzip 22.6 kB 22.6 kB
pages.runtim..prod.js gzip 22 kB 22 kB
server.runti..prod.js gzip 49.7 kB 49.7 kB
Overall change 943 kB 943 kB
Diff details
Diff for 433-HASH.js

Diff too large to display

Diff for main-HASH.js

Diff too large to display

Commit: bc1538c

@feugy feugy force-pushed the damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights branch from f127228 to bc1538c Compare January 19, 2024 13:14
@timneutkens timneutkens merged commit 8218492 into vercel:canary Jan 19, 2024
66 checks passed
@feugy feugy deleted the damien/aly-1157-add-deprecation-notice-for-the-automatic-speed-insights branch January 19, 2024 13:45
kodiakhq bot pushed a commit to vercel/vercel that referenced this pull request Jan 19, 2024
…11048)

### 🧐 What's in there?

With the recent release of [`@vercel/speed-insights`](https://vercel.com/docs/speed-insights/package) own package (like [`@vercel/analytics`](https://vercel.com/docs/analytics/package)), it's time to encourage users to migrate.

With the availability of `@vercel/speed-insights`, users will have to opt-in explicitly by installing the package. Their benefit is a better and fine-grained control of the reporting (in particular, per-application sample rate).

### ❗ Note to reviewers

I used `console.warn` and hope it will stands out in the build logs. I'm happy to use anything else if you have better suggestions.

There's also a deprecation warning in Next.js, which covers a related but slightly different case, when users explicitly pass analyticsId in their configuration. vercel/next.js#60677
@github-actions github-actions bot added the locked label Feb 3, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants