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

[CI] Prominent error message for check_error_codes #73807

Merged
merged 2 commits into from
Dec 11, 2024

Conversation

gaojude
Copy link
Contributor

@gaojude gaojude commented Dec 11, 2024

This pull request adds a more prominent error message to the CI build failure message when a new error message is added through new Error(...) but pnpm build has not been run locally to update errors.json.

Example

CleanShot 2024-12-11 at 13 38 52@2x

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team. type: next labels Dec 11, 2024
@gaojude gaojude requested a review from devjiwonchoi December 11, 2024 18:40
@gaojude gaojude changed the title actionable error message for check_error_codes [CI] Prominent error message for check_error_codes Dec 11, 2024
@gaojude gaojude requested review from eps1lon and huozhi December 11, 2024 18:42
@ijjk
Copy link
Member

ijjk commented Dec 11, 2024

Stats from current PR

Default Build (Increase detected ⚠️)
General
vercel/next.js canary vercel/next.js jude/better-error-msg Change
buildDuration 22.6s 19.7s N/A
buildDurationCached 18.2s 15.6s N/A
nodeModulesSize 409 MB 409 MB
nextStartRea..uration (ms) 523ms 519ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js jude/better-error-msg Change
1187-HASH.js gzip 50.7 kB 50.7 kB N/A
8276.HASH.js gzip 169 B 168 B N/A
8377-HASH.js gzip 5.36 kB 5.36 kB N/A
bccd1874-HASH.js gzip 53 kB 53 kB N/A
framework-HASH.js gzip 57.5 kB 57.5 kB N/A
main-app-HASH.js gzip 232 B 235 B N/A
main-HASH.js gzip 34 kB 34 kB N/A
webpack-HASH.js gzip 1.71 kB 1.71 kB N/A
Overall change 0 B 0 B
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js jude/better-error-msg 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 jude/better-error-msg Change
_app-HASH.js gzip 193 B 193 B
_error-HASH.js gzip 193 B 193 B
amp-HASH.js gzip 512 B 510 B N/A
css-HASH.js gzip 343 B 342 B N/A
dynamic-HASH.js gzip 1.84 kB 1.84 kB
edge-ssr-HASH.js gzip 265 B 265 B
head-HASH.js gzip 363 B 362 B N/A
hooks-HASH.js gzip 393 B 392 B N/A
image-HASH.js gzip 4.49 kB 4.49 kB N/A
index-HASH.js gzip 268 B 268 B
link-HASH.js gzip 2.35 kB 2.34 kB N/A
routerDirect..HASH.js gzip 328 B 328 B
script-HASH.js gzip 397 B 397 B
withRouter-HASH.js gzip 323 B 326 B N/A
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 3.59 kB 3.59 kB
Client Build Manifests
vercel/next.js canary vercel/next.js jude/better-error-msg Change
_buildManifest.js gzip 747 B 746 B N/A
Overall change 0 B 0 B
Rendered Page Sizes
vercel/next.js canary vercel/next.js jude/better-error-msg Change
index.html gzip 524 B 524 B
link.html gzip 539 B 539 B
withRouter.html gzip 520 B 520 B
Overall change 1.58 kB 1.58 kB
Edge SSR bundle Size
vercel/next.js canary vercel/next.js jude/better-error-msg Change
edge-ssr.js gzip 128 kB 128 kB N/A
page.js gzip 203 kB 203 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary vercel/next.js jude/better-error-msg Change
middleware-b..fest.js gzip 671 B 667 B N/A
middleware-r..fest.js gzip 155 B 156 B N/A
middleware.js gzip 31.2 kB 31.2 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 jude/better-error-msg Change
523-experime...dev.js gzip 322 B 322 B
523.runtime.dev.js gzip 314 B 314 B
app-page-exp...dev.js gzip 323 kB 323 kB
app-page-exp..prod.js gzip 127 kB 127 kB
app-page-tur..prod.js gzip 140 kB 140 kB
app-page-tur..prod.js gzip 135 kB 135 kB
app-page.run...dev.js gzip 313 kB 313 kB
app-page.run..prod.js gzip 123 kB 123 kB
app-route-ex...dev.js gzip 37.3 kB 37.3 kB
app-route-ex..prod.js gzip 25.4 kB 25.4 kB
app-route-tu..prod.js gzip 25.4 kB 25.4 kB
app-route-tu..prod.js gzip 25.2 kB 25.2 kB
app-route.ru...dev.js gzip 38.9 kB 38.9 kB
app-route.ru..prod.js gzip 25.2 kB 25.2 kB
pages-api-tu..prod.js gzip 9.67 kB 9.67 kB
pages-api.ru...dev.js gzip 11.6 kB 11.6 kB
pages-api.ru..prod.js gzip 9.66 kB 9.66 kB
pages-turbo...prod.js gzip 21.7 kB 21.7 kB
pages.runtim...dev.js gzip 27.4 kB 27.4 kB
pages.runtim..prod.js gzip 21.7 kB 21.7 kB
server.runti..prod.js gzip 916 kB 916 kB
Overall change 2.36 MB 2.36 MB
build cache Overall increase ⚠️
vercel/next.js canary vercel/next.js jude/better-error-msg Change
0.pack gzip 2.05 MB 2.05 MB ⚠️ +506 B
index.pack gzip 72 kB 72.3 kB ⚠️ +284 B
Overall change 2.12 MB 2.12 MB ⚠️ +790 B
Diff details
Diff for main-HASH.js

Diff too large to display

Commit: 5135429

@@ -2720,6 +2720,12 @@ export async function check_error_codes(task, opts) {
})
} catch (err) {
if (process.env.CI) {
Copy link
Member

Choose a reason for hiding this comment

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

Why do we only fail in CI? By failing locally, you avoid one roundtrip to CI because you get the failure early. That way you also avoid the potential confusion when local tests fail due to missing error codes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

pnpm build would have already updated errors.json for you if you ran that locally.
This failure in CI covers the case where people forgot to run pnpm build locally at all.

Copy link
Member

Choose a reason for hiding this comment

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

pnpm build would have already updated errors.json for you if you ran that locally.

So we can remove the if (CI) conditional then?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This code is inside pnpm build, so removing the check would fail that command instead of updating errors.json. The update is done by the command afterwards -> https://github.com/vercel/next.js/pull/73807/files#diff-9d85a2d25346a67c95d98aa8d81b4d677b90708bdc40e03488ce0586edaade7eR2731

@gaojude gaojude merged commit 1651994 into canary Dec 11, 2024
107 of 112 checks passed
@gaojude gaojude deleted the jude/better-error-msg branch December 11, 2024 19:13
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 26, 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.

4 participants