-
Notifications
You must be signed in to change notification settings - Fork 26.8k
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
Warn in dev mode when stylesheets are added using next/head #34004
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a development mode warning in the console if you try to include <link rel="stylesheet"> tags in next/head, e.g. ``` <Head> <link ref="stylesheet" href="..." /> </Head> ``` The warning message explains that this pattern will not work well with Suspense/streaming and recommends using a custom Document component instead.
kara
requested review from
huozhi,
ijjk,
shuding and
timneutkens
as code owners
February 4, 2022 18:41
ijjk
added
area: documentation
created-by: Chrome Aurora
PRs by the Google Chrome team: https://web.dev/aurora
type: next
labels
Feb 4, 2022
huozhi
reviewed
Feb 4, 2022
This comment has been minimized.
This comment has been minimized.
ijjk
reviewed
Feb 4, 2022
huozhi
previously approved these changes
Feb 4, 2022
This comment has been minimized.
This comment has been minimized.
ijjk
approved these changes
Feb 4, 2022
Stats from current PRDefault Build (Decrease detected ✓)General Overall increase
|
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
buildDuration | 14.8s | 14.5s | -240ms |
buildDurationCached | 5.6s | 6s | |
nodeModulesSize | 359 MB | 359 MB |
Page Load Tests Overall decrease ⚠️
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
/ failed reqs | 0 | 0 | ✓ |
/ total time (seconds) | 2.564 | 2.581 | |
/ avg req/sec | 974.88 | 968.49 | |
/error-in-render failed reqs | 0 | 0 | ✓ |
/error-in-render total time (seconds) | 1.322 | 1.351 | |
/error-in-render avg req/sec | 1891.44 | 1850.58 |
Client Bundles (main, webpack, commons)
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
450.HASH.js gzip | 179 B | 179 B | ✓ |
framework-HASH.js gzip | 42.2 kB | 42.2 kB | ✓ |
main-HASH.js gzip | 27.4 kB | 27.4 kB | ✓ |
webpack-HASH.js gzip | 1.44 kB | 1.44 kB | ✓ |
Overall change | 71.2 kB | 71.2 kB | ✓ |
Legacy Client Bundles (polyfills)
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
polyfills-HASH.js gzip | 31 kB | 31 kB | ✓ |
Overall change | 31 kB | 31 kB | ✓ |
Client Pages
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
_app-HASH.js gzip | 1.36 kB | 1.36 kB | ✓ |
_error-HASH.js gzip | 194 B | 194 B | ✓ |
amp-HASH.js gzip | 312 B | 312 B | ✓ |
css-HASH.js gzip | 326 B | 326 B | ✓ |
dynamic-HASH.js gzip | 2.37 kB | 2.37 kB | ✓ |
head-HASH.js gzip | 350 B | 350 B | ✓ |
hooks-HASH.js gzip | 919 B | 919 B | ✓ |
image-HASH.js gzip | 4.94 kB | 4.94 kB | ✓ |
index-HASH.js gzip | 263 B | 263 B | ✓ |
link-HASH.js gzip | 2.19 kB | 2.19 kB | ✓ |
routerDirect..HASH.js gzip | 321 B | 321 B | ✓ |
script-HASH.js gzip | 383 B | 383 B | ✓ |
withRouter-HASH.js gzip | 318 B | 318 B | ✓ |
85e02e95b279..7e3.css gzip | 107 B | 107 B | ✓ |
Overall change | 14.3 kB | 14.3 kB | ✓ |
Client Build Manifests
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
_buildManifest.js gzip | 459 B | 459 B | ✓ |
Overall change | 459 B | 459 B | ✓ |
Rendered Page Sizes
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
index.html gzip | 532 B | 532 B | ✓ |
link.html gzip | 546 B | 546 B | ✓ |
withRouter.html gzip | 527 B | 527 B | ✓ |
Overall change | 1.6 kB | 1.6 kB | ✓ |
Diffs
Diff for main-HASH.js
@@ -3826,8 +3826,8 @@
return /*#__PURE__*/ _react.default.cloneElement(c, newProps);
}
}
- // TODO(kara): warn for stylesheets as well as scripts
if (false) {
+ var srcMessage;
}
return /*#__PURE__*/ _react.default.cloneElement(c, {
key: key
Diff for index.html
@@ -19,7 +19,7 @@
defer=""
></script>
<script
- src="/_next/static/chunks/main-1fa20499f1cb366a.js"
+ src="/_next/static/chunks/main-59dd6fd6d9afacd0.js"
defer=""
></script>
<script
Diff for link.html
@@ -19,7 +19,7 @@
defer=""
></script>
<script
- src="/_next/static/chunks/main-1fa20499f1cb366a.js"
+ src="/_next/static/chunks/main-59dd6fd6d9afacd0.js"
defer=""
></script>
<script
Diff for withRouter.html
@@ -19,7 +19,7 @@
defer=""
></script>
<script
- src="/_next/static/chunks/main-1fa20499f1cb366a.js"
+ src="/_next/static/chunks/main-59dd6fd6d9afacd0.js"
defer=""
></script>
<script
Default Build with SWC (Decrease detected ✓)
General Overall increase ⚠️
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
buildDuration | 17.5s | 18.3s | |
buildDurationCached | 5.6s | 6s | |
nodeModulesSize | 359 MB | 359 MB |
Page Load Tests Overall decrease ⚠️
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
/ failed reqs | 0 | 0 | ✓ |
/ total time (seconds) | 2.699 | 2.709 | |
/ avg req/sec | 926.26 | 922.77 | |
/error-in-render failed reqs | 0 | 0 | ✓ |
/error-in-render total time (seconds) | 1.363 | 1.387 | |
/error-in-render avg req/sec | 1833.56 | 1802.08 |
Client Bundles (main, webpack, commons)
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
450.HASH.js gzip | 179 B | 179 B | ✓ |
framework-HASH.js gzip | 42.3 kB | 42.3 kB | ✓ |
main-HASH.js gzip | 27.4 kB | 27.4 kB | ✓ |
webpack-HASH.js gzip | 1.44 kB | 1.44 kB | ✓ |
Overall change | 71.3 kB | 71.3 kB | ✓ |
Legacy Client Bundles (polyfills)
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
polyfills-HASH.js gzip | 31 kB | 31 kB | ✓ |
Overall change | 31 kB | 31 kB | ✓ |
Client Pages
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
_app-HASH.js gzip | 1.35 kB | 1.35 kB | ✓ |
_error-HASH.js gzip | 180 B | 180 B | ✓ |
amp-HASH.js gzip | 305 B | 305 B | ✓ |
css-HASH.js gzip | 321 B | 321 B | ✓ |
dynamic-HASH.js gzip | 2.36 kB | 2.36 kB | ✓ |
head-HASH.js gzip | 342 B | 342 B | ✓ |
hooks-HASH.js gzip | 911 B | 911 B | ✓ |
image-HASH.js gzip | 4.97 kB | 4.97 kB | ✓ |
index-HASH.js gzip | 256 B | 256 B | ✓ |
link-HASH.js gzip | 2.21 kB | 2.21 kB | ✓ |
routerDirect..HASH.js gzip | 314 B | 314 B | ✓ |
script-HASH.js gzip | 375 B | 375 B | ✓ |
withRouter-HASH.js gzip | 309 B | 309 B | ✓ |
85e02e95b279..7e3.css gzip | 107 B | 107 B | ✓ |
Overall change | 14.3 kB | 14.3 kB | ✓ |
Client Build Manifests
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
_buildManifest.js gzip | 459 B | 459 B | ✓ |
Overall change | 459 B | 459 B | ✓ |
Rendered Page Sizes
vercel/next.js canary | kara/next.js styles-warning | Change | |
---|---|---|---|
index.html gzip | 532 B | 532 B | ✓ |
link.html gzip | 546 B | 546 B | ✓ |
withRouter.html gzip | 527 B | 527 B | ✓ |
Overall change | 1.6 kB | 1.6 kB | ✓ |
Diffs
Diff for main-HASH.js
@@ -3826,8 +3826,8 @@
return /*#__PURE__*/ _react.default.cloneElement(c, newProps);
}
}
- // TODO(kara): warn for stylesheets as well as scripts
if (false) {
+ var srcMessage;
}
return /*#__PURE__*/ _react.default.cloneElement(c, {
key: key
Diff for index.html
@@ -19,7 +19,7 @@
defer=""
></script>
<script
- src="/_next/static/chunks/main-1fa20499f1cb366a.js"
+ src="/_next/static/chunks/main-59dd6fd6d9afacd0.js"
defer=""
></script>
<script
Diff for link.html
@@ -19,7 +19,7 @@
defer=""
></script>
<script
- src="/_next/static/chunks/main-1fa20499f1cb366a.js"
+ src="/_next/static/chunks/main-59dd6fd6d9afacd0.js"
defer=""
></script>
<script
Diff for withRouter.html
@@ -19,7 +19,7 @@
defer=""
></script>
<script
- src="/_next/static/chunks/main-1fa20499f1cb366a.js"
+ src="/_next/static/chunks/main-59dd6fd6d9afacd0.js"
defer=""
></script>
<script
natew
pushed a commit
to natew/next.js
that referenced
this pull request
Feb 16, 2022
…4004) This commit adds a development mode warning in the console if you try to include <link rel="stylesheet"> tags in next/head, e.g. ``` <Head> <link ref="stylesheet" href="..." /> </Head> ``` The warning message explains that this pattern will not work well with Suspense/streaming and recommends using a custom Document component instead. ## Feature - [x] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [x] Integration tests added - [x] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [x] Errors have helpful link attached, see `contributing.md` Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
3 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds a development mode warning in the console
if you try to include tags in
next/head, e.g.
The warning message explains that this pattern will not
work well with Suspense/streaming and recommends using a
custom Document component instead.
Feature
fixes #number
contributing.md