Skip to content
New issue

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

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

Already on GitHub? # to your account

[dev-overlay] deprecate devIndicators options appIsrStatus and buildActivity #76067

Conversation

devjiwonchoi
Copy link
Member

@devjiwonchoi devjiwonchoi commented Feb 14, 2025

Why?

Since the new dev indicator supersedes the existing appIsrStatus (Static Route Indicator) and buildActivity (Compilation Indicator), deprecate them before we fully remove the old overlay.

Follow Up

After removing the old overlay's sources, we can remove any logic that appIsrStatus and buildActivity were holding for the old overlay.

Closes NDX-836

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team. type: next labels Feb 14, 2025
@ijjk
Copy link
Member

ijjk commented Feb 14, 2025

Tests Passed

@ijjk
Copy link
Member

ijjk commented Feb 14, 2025

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary vercel/next.js 02-15-_dev-overlay_deprecate_devindicators.appisrstatus_buildactivity Change
buildDuration 28.1s 28.6s ⚠️ +476ms
buildDurationCached 24.9s 23.8s N/A
nodeModulesSize 393 MB 393 MB ⚠️ +9.09 kB
nextStartRea..uration (ms) 753ms 844ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js 02-15-_dev-overlay_deprecate_devindicators.appisrstatus_buildactivity Change
5306-HASH.js gzip 55.3 kB 55.3 kB N/A
7048.HASH.js gzip 168 B 168 B
8377-HASH.js gzip 5.46 kB 5.46 kB N/A
bccd1874-HASH.js gzip 53 kB 53 kB
framework-HASH.js gzip 57.5 kB 57.5 kB N/A
main-app-HASH.js gzip 245 B 245 B
main-HASH.js gzip 34.9 kB 34.9 kB N/A
webpack-HASH.js gzip 1.71 kB 1.71 kB
Overall change 55.1 kB 55.1 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js 02-15-_dev-overlay_deprecate_devindicators.appisrstatus_buildactivity Change
polyfills-HASH.js gzip 39.4 kB 39.4 kB
Overall change 39.4 kB 39.4 kB
Client Pages
vercel/next.js canary vercel/next.js 02-15-_dev-overlay_deprecate_devindicators.appisrstatus_buildactivity Change
_app-HASH.js gzip 194 B 194 B
_error-HASH.js gzip 193 B 192 B N/A
amp-HASH.js gzip 513 B 511 B N/A
css-HASH.js gzip 342 B 342 B
dynamic-HASH.js gzip 1.84 kB 1.84 kB N/A
edge-ssr-HASH.js gzip 265 B 264 B N/A
head-HASH.js gzip 363 B 360 B N/A
hooks-HASH.js gzip 393 B 390 B N/A
image-HASH.js gzip 4.59 kB 4.59 kB N/A
index-HASH.js gzip 268 B 266 B N/A
link-HASH.js gzip 2.35 kB 2.35 kB
routerDirect..HASH.js gzip 327 B 326 B N/A
script-HASH.js gzip 397 B 397 B
withRouter-HASH.js gzip 325 B 325 B
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 3.72 kB 3.72 kB
Client Build Manifests
vercel/next.js canary vercel/next.js 02-15-_dev-overlay_deprecate_devindicators.appisrstatus_buildactivity Change
_buildManifest.js gzip 749 B 747 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary vercel/next.js 02-15-_dev-overlay_deprecate_devindicators.appisrstatus_buildactivity Change
index.html gzip 522 B 522 B
link.html gzip 538 B 536 B N/A
withRouter.html gzip 519 B 518 B N/A
Overall change 522 B 522 B
Edge SSR bundle Size
vercel/next.js canary vercel/next.js 02-15-_dev-overlay_deprecate_devindicators.appisrstatus_buildactivity Change
edge-ssr.js gzip 130 kB 130 kB N/A
page.js gzip 211 kB 211 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary vercel/next.js 02-15-_dev-overlay_deprecate_devindicators.appisrstatus_buildactivity Change
middleware-b..fest.js gzip 677 B 674 B N/A
middleware-r..fest.js gzip 155 B 156 B N/A
middleware.js gzip 31.4 kB 31.4 kB N/A
edge-runtime..pack.js gzip 844 B 844 B
Overall change 844 B 844 B
Next Runtimes
vercel/next.js canary vercel/next.js 02-15-_dev-overlay_deprecate_devindicators.appisrstatus_buildactivity Change
app-page-exp...dev.js gzip 395 kB 395 kB
app-page-exp..prod.js gzip 133 kB 133 kB
app-page-tur..prod.js gzip 145 kB 145 kB
app-page-tur..prod.js gzip 141 kB 141 kB
app-page.run...dev.js gzip 384 kB 384 kB
app-page.run..prod.js gzip 129 kB 129 kB
app-route-ex...dev.js gzip 39.4 kB 39.4 kB
app-route-ex..prod.js gzip 25.7 kB 25.7 kB
app-route-tu..prod.js gzip 25.7 kB 25.7 kB
app-route-tu..prod.js gzip 25.5 kB 25.5 kB
app-route.ru...dev.js gzip 39.1 kB 39.1 kB
app-route.ru..prod.js gzip 25.5 kB 25.5 kB
dist_client_...dev.js gzip 356 B 356 B
dist_client_...dev.js gzip 349 B 349 B
pages-api-tu..prod.js gzip 9.72 kB 9.72 kB
pages-api.ru...dev.js gzip 11.8 kB 11.8 kB
pages-api.ru..prod.js gzip 9.72 kB 9.72 kB
pages-turbo...prod.js gzip 22 kB 22 kB
pages.runtim...dev.js gzip 31.6 kB 31.6 kB
pages.runtim..prod.js gzip 22 kB 22 kB
server.runti..prod.js gzip 61.2 kB 61.2 kB
Overall change 1.68 MB 1.68 MB
build cache Overall increase ⚠️
vercel/next.js canary vercel/next.js 02-15-_dev-overlay_deprecate_devindicators.appisrstatus_buildactivity Change
0.pack gzip 2.11 MB 2.12 MB ⚠️ +2.69 kB
index.pack gzip 76.9 kB 76.8 kB N/A
Overall change 2.11 MB 2.12 MB ⚠️ +2.69 kB
Diff details
Diff for page.js

Diff too large to display

Diff for edge-ssr.js

Diff too large to display

Diff for main-HASH.js

Diff too large to display

Commit: 1830ad7

@@ -52,7 +52,7 @@ let devOutput
await renderViaHTTP(appPort, '/', {})
const errors = devOutput.stderr
.split('\n')
.filter((line) => line && !line.trim().startsWith('⚠'))
.filter((line) => line && !line.trim().startsWith('⚠'))
Copy link
Member Author

Choose a reason for hiding this comment

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

Found it during testing, sneaking in.

@devjiwonchoi devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators._appisrstatus_buildactivity_ branch 2 times, most recently from d9e5cea to 8e3d476 Compare February 15, 2025 09:27
@devjiwonchoi devjiwonchoi marked this pull request as ready for review February 15, 2025 10:44
Copy link

vercel bot commented Feb 15, 2025

Notifying the following users due to files changed in this PR based on this repo's notify modifiers:

@timneutkens, @ijjk, @shuding, @huozhi:

packages/next/src/server/config.ts

@devjiwonchoi devjiwonchoi changed the title [dev-overlay] deprecate devIndicators.(appIsrStatus|buildActivity) [dev-overlay] deprecate devIndicators options appIsrStatus and buildActivity Feb 15, 2025
@devjiwonchoi devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators._appisrstatus_buildactivity_ branch from f32897b to 1830ad7 Compare February 17, 2025 07:51
@devjiwonchoi devjiwonchoi merged commit 2c3cb02 into canary Feb 17, 2025
132 checks passed
Copy link
Member Author

Merge activity

  • Feb 17, 3:24 AM EST: A user merged this pull request with Graphite.

@devjiwonchoi devjiwonchoi deleted the 02-15-_dev-overlay_deprecate_devindicators._appisrstatus_buildactivity_ branch February 17, 2025 08:24
devjiwonchoi added a commit that referenced this pull request Feb 17, 2025
…ame to `position` (#76069)

### Why?

Since the `buildActivity` is deprecated at #76067, `buildActivityPosition` may also be deprecated. However, we are planning to preserve the option to position the dev indicator. Therefore, this PR adds a new option `position` and deprecates and aliases the `buildActivityPosition` to `position`.

### Success Criteria

Deprecation:

- [x] Does using `buildActivityPosition` show a deprecation warning?
- [x] Does `buildActivityPosition` have a deprecation in JSDoc?

Alias:

> Is it backward compatible with the old overlay?

- [x] Does setting `buildActivityPosition` correctly set the build activity indicator position?
- [x] Does it warn if `buildActivityPosition` is set instead of `position`?
- [x] Does `buildActivityPosition` supersede `position` value to prevent breaking change?
- [x] Does setting the `position` correctly set the build activity indicator position?

### Follow Up

In the following PRs, we will add the behavior for `position` to adjust the dev indicator's position. After removing the old overlay's sources, we can remove any logic that `buildActivityPosition` was holding for the old overlay and make it fully an alias for backwards compatibility.

Closes NDX-837
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants