[dev-overlay] deprecate `devIndicators.buildActivityPosition` and rename to `position` #76069

devjiwonchoi · 2025-02-14T21:25:42Z

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:

Does using buildActivityPosition show a deprecation warning?
Does buildActivityPosition have a deprecation in JSDoc?

Alias:

Is it backward compatible with the old overlay?

Does setting buildActivityPosition correctly set the build activity indicator position?
Does it warn if buildActivityPosition is set instead of position?
Does buildActivityPosition supersede position value to prevent breaking change?
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

devjiwonchoi · 2025-02-14T21:26:07Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

ijjk · 2025-02-14T22:23:30Z

Tests Passed

ijjk · 2025-02-14T22:31:09Z

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js 02-15-dev-overlay_deprecate_devindicators.buildactivityposition_and_rename_to_position	Change
buildDuration	19.9s	17.9s	N/A
buildDurationCached	16.9s	14.6s	N/A
nodeModulesSize	393 MB	393 MB	⚠️ +13.6 kB
nextStartRea..uration (ms)	465ms	464ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js 02-15-dev-overlay_deprecate_devindicators.buildactivityposition_and_rename_to_position	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.buildactivityposition_and_rename_to_position	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.buildactivityposition_and_rename_to_position	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.buildactivityposition_and_rename_to_position	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.buildactivityposition_and_rename_to_position	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.buildactivityposition_and_rename_to_position	Change
edge-ssr.js gzip	130 kB	130 kB	✓
page.js gzip	211 kB	211 kB	N/A
Overall change	130 kB	130 kB	✓

Middleware size

	vercel/next.js canary	vercel/next.js 02-15-dev-overlay_deprecate_devindicators.buildactivityposition_and_rename_to_position	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.buildactivityposition_and_rename_to_position	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.buildactivityposition_and_rename_to_position	Change
0.pack gzip	2.12 MB	2.11 MB	N/A
index.pack gzip	75.5 kB	76.9 kB	⚠️ +1.42 kB
Overall change	75.5 kB	76.9 kB	⚠️ +1.42 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: 4718b68

vercel · 2025-02-15T11:45:51Z

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 · 2025-02-15T12:31:32Z

packages/next/src/server/config.ts

+    result.devIndicators.buildActivityPosition !== result.devIndicators.position
+  ) {
+    Log.warnOnce(
+      `The \`devIndicators\` option \`buildActivityPosition\` ("${result.devIndicators.buildActivityPosition}") conflicts with \`position\` ("${result.devIndicators.position}"). Using \`buildActivityPosition\` ("${result.devIndicators.buildActivityPosition}") for backward compatibility.`


For those who're curious how it'd look like:

…ame to `position`

devjiwonchoi · 2025-02-17T08:54:54Z

Merge activity

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

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

devjiwonchoi mentioned this pull request Feb 14, 2025

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

Merged

devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators.buildactivityposition_and_rename_to_position_ branch from 9f722ef to b8d7395 Compare February 14, 2025 21:49

ijjk added tests Turbopack Related to Turbopack with Next.js. labels Feb 14, 2025

devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators._appisrstatus_buildactivity_ branch from fb6da06 to d9e5cea Compare February 14, 2025 22:04

devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators.buildactivityposition_and_rename_to_position_ branch from b7cd72b to 6dc94ee Compare February 14, 2025 22:04

devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators._appisrstatus_buildactivity_ branch from d9e5cea to 8e3d476 Compare February 15, 2025 09:27

devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators.buildactivityposition_and_rename_to_position_ branch 2 times, most recently from 5dcee13 to 38a5abb Compare February 15, 2025 10:37

devjiwonchoi marked this pull request as ready for review February 15, 2025 11:45

devjiwonchoi commented Feb 15, 2025

View reviewed changes

devjiwonchoi requested review from ztanner, huozhi, eps1lon and gaojude February 15, 2025 13:34

gaojude approved these changes Feb 15, 2025

View reviewed changes

This was referenced Feb 15, 2025

[dev-overlay] change dev indicator position by next config option #76077

Merged

[dev-overlay] add false option to disable dev indicator #76079

Merged

devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators._appisrstatus_buildactivity_ branch from f32897b to 1830ad7 Compare February 17, 2025 07:51

devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators.buildactivityposition_and_rename_to_position_ branch from 1b3dd49 to 77db582 Compare February 17, 2025 07:51

devjiwonchoi mentioned this pull request Feb 17, 2025

test: replace explicit padding-bottom with devIndicators: false for scroll position testing #76105

Merged

devjiwonchoi changed the base branch from 02-15-_dev-overlay_deprecate_devindicators._appisrstatus_buildactivity_ to graphite-base/76069 February 17, 2025 08:24

devjiwonchoi added 2 commits February 17, 2025 08:25

[dev-overlay] deprecate devIndicators.buildActivityPosition and ren…

7891dcc

…ame to `position`

update few

c85080d

devjiwonchoi added 8 commits February 17, 2025 08:25

update errors.json

9642d1d

update

105c6bb

backwardscompatibility

7094dec

remove warnOptionHasBeenRenamed

e01e465

add default to jsdoc

dfdcdd2

nextConfig.json default bottom-left for position

44dd446

update

e1c256d

no breaking change of behavior

3ac43a6

devjiwonchoi force-pushed the graphite-base/76069 branch from 1830ad7 to 2c3cb02 Compare February 17, 2025 08:25

devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators.buildactivityposition_and_rename_to_position_ branch from 77db582 to 65fc568 Compare February 17, 2025 08:25

devjiwonchoi changed the base branch from graphite-base/76069 to canary February 17, 2025 08:25

Improve dev indicators position warning message

4718b68

devjiwonchoi force-pushed the 02-15-_dev-overlay_deprecate_devindicators.buildactivityposition_and_rename_to_position_ branch from 65fc568 to 4718b68 Compare February 17, 2025 08:25

devjiwonchoi merged commit 4b8bf68 into canary Feb 17, 2025
130 of 131 checks passed

devjiwonchoi deleted the 02-15-_dev-overlay_deprecate_devindicators.buildactivityposition_and_rename_to_position_ branch February 17, 2025 08:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[dev-overlay] deprecate `devIndicators.buildActivityPosition` and rename to `position` #76069

[dev-overlay] deprecate `devIndicators.buildActivityPosition` and rename to `position` #76069

devjiwonchoi commented Feb 14, 2025 •

edited

Loading

devjiwonchoi commented Feb 14, 2025 •

edited

Loading

ijjk commented Feb 14, 2025 •

edited

Loading

ijjk commented Feb 14, 2025 •

edited

Loading

vercel bot commented Feb 15, 2025 •

edited

Loading

devjiwonchoi Feb 15, 2025

devjiwonchoi commented Feb 17, 2025

[dev-overlay] deprecate devIndicators.buildActivityPosition and rename to position #76069

[dev-overlay] deprecate devIndicators.buildActivityPosition and rename to position #76069

Conversation

devjiwonchoi commented Feb 14, 2025 • edited Loading

Why?

Success Criteria

Follow Up

devjiwonchoi commented Feb 14, 2025 • edited Loading

ijjk commented Feb 14, 2025 • edited Loading

Tests Passed

ijjk commented Feb 14, 2025 • edited Loading

Stats from current PR

vercel bot commented Feb 15, 2025 • edited Loading

devjiwonchoi Feb 15, 2025

Choose a reason for hiding this comment

devjiwonchoi commented Feb 17, 2025

Merge activity

[dev-overlay] deprecate `devIndicators.buildActivityPosition` and rename to `position` #76069

[dev-overlay] deprecate `devIndicators.buildActivityPosition` and rename to `position` #76069

devjiwonchoi commented Feb 14, 2025 •

edited

Loading

devjiwonchoi commented Feb 14, 2025 •

edited

Loading

ijjk commented Feb 14, 2025 •

edited

Loading

ijjk commented Feb 14, 2025 •

edited

Loading

vercel bot commented Feb 15, 2025 •

edited

Loading