Fix incorrect `_document.js` error when `disableStaticImages: true` #30768

styfle · 2021-11-01T23:11:37Z

Fixes #30600

errors/custom-document-image-import.md

Co-authored-by: JJ Kasper <[email protected]>

ijjk · 2021-11-01T23:41:16Z

Failing test suites

Commit: d13d1df

test/integration/invalid-document-image-import/test/index.test.js

Invalid static image import in _document > Should build without error when disableStaticImages in next.config.js

Expand output

● Invalid static image import in _document › Should build without error when disableStaticImages in next.config.js

command failed with code 1
info  - Checking validity of types...
info  - Creating an optimized production build...
Failed to compile.

./public/test.jpg
Images cannot be imported within pages/_document.js. Please move image imports that need to be displayed on every page into pages/_app.js.
Read more: https://nextjs.org/docs/messages/custom-document-image-import
Location: pages/_document.js

Import trace for requested module:
./pages/_document.js

./public/test.jpg
Module build failed: Error: Final loader (../../../packages/next/dist/build/webpack/loaders/error-loader.js) didn't return a Buffer or String

  53074 | 			if (!Buffer.isBuffer(source) && typeof source !== "string") {
  53075 | 				const currentLoader = this.getCurrentLoader(loaderContext, 0);
> 53076 | 				const err = new Error(
        | 				            ^
  53077 | 					`Final loader (${
  53078 | 						currentLoader
  53079 | 							? compilation.runtimeTemplate.requestShortener.shorten(

  at processResult (../packages/next/dist/compiled/webpack/bundle5.js:53076:17)
  at ../packages/next/dist/compiled/webpack/bundle5.js:53162:5
  at ../packages/next/dist/compiled/webpack/bundle5.js:138606:3
  at iterateNormalLoaders (../packages/next/dist/compiled/webpack/bundle5.js:138432:10)
  at iterateNormalLoaders (../packages/next/dist/compiled/webpack/bundle5.js:138439:10)
  at ../packages/next/dist/compiled/webpack/bundle5.js:138454:3
  at runSyncOrAsync (../packages/next/dist/compiled/webpack/bundle5.js:138337:12)
  at iterateNormalLoaders (../packages/next/dist/compiled/webpack/bundle5.js:138450:2)
  at ../packages/next/dist/compiled/webpack/bundle5.js:138423:4
  at ../packages/next/dist/compiled/webpack/bundle5.js:53136:15
  Import trace for requested module:
  ./pages/_document.js
  > Build failed because of webpack errors
  at ChildProcess.<anonymous> (lib/next-test-utils.js:183:11)

ijjk · 2021-11-02T20:08:47Z

Stats from current PR

Default Build

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
buildDuration	23.7s	24.1s	⚠️ +346ms
buildDurationCached	5s	5s	-16ms
nodeModulesSize	293 MB	293 MB	⚠️ +496 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.99	3.889	-0.1
/ avg req/sec	626.53	642.91	+16.38
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.194	2.225	⚠️ +0.03
/error-in-render avg req/sec	1139.56	1123.81	⚠️ -15.75

Client Bundles (main, webpack, commons)

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
450.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	28 kB	28 kB	✓
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	71.9 kB	71.9 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
_app-HASH.js gzip	1.23 kB	1.23 kB	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	312 B	312 B	✓
css-HASH.js gzip	327 B	327 B	✓
dynamic-HASH.js gzip	2.38 kB	2.38 kB	✓
head-HASH.js gzip	350 B	350 B	✓
hooks-HASH.js gzip	635 B	635 B	✓
image-HASH.js gzip	4.44 kB	4.44 kB	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	1.87 kB	1.87 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	✓
334f979574ae..6f4.css gzip	106 B	106 B	✓
Overall change	13.1 kB	13.1 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
_buildManifest.js gzip	459 B	459 B	✓
Overall change	459 B	459 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
index.html gzip	521 B	521 B	✓
link.html gzip	533 B	533 B	✓
withRouter.html gzip	515 B	515 B	✓
Overall change	1.57 kB	1.57 kB	✓

Default Build with SWC (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
buildDuration	26.4s	26.4s	-27ms
buildDurationCached	5s	5.1s	⚠️ +34ms
nodeModulesSize	293 MB	293 MB	⚠️ +496 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.931	3.966	⚠️ +0.04
/ avg req/sec	635.94	630.34	⚠️ -5.6
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.194	2.148	-0.05
/error-in-render avg req/sec	1139.65	1163.84	+24.19

Client Bundles (main, webpack, commons)

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
450.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.3 kB	42.3 kB	✓
main-HASH.js gzip	28.2 kB	28.2 kB	✓
webpack-HASH.js gzip	1.43 kB	1.43 kB	✓
Overall change	72.1 kB	72.1 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
_app-HASH.js gzip	1.22 kB	1.22 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.38 kB	2.38 kB	✓
head-HASH.js gzip	342 B	342 B	✓
hooks-HASH.js gzip	622 B	622 B	✓
image-HASH.js gzip	4.46 kB	4.46 kB	✓
index-HASH.js gzip	256 B	256 B	✓
link-HASH.js gzip	1.91 kB	1.91 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	✓
334f979574ae..6f4.css gzip	106 B	106 B	✓
Overall change	13.1 kB	13.1 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
_buildManifest.js gzip	460 B	460 B	✓
Overall change	460 B	460 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js fix-next-disable-image-import-document	Change
index.html gzip	521 B	521 B	✓
link.html gzip	534 B	534 B	✓
withRouter.html gzip	516 B	516 B	✓
Overall change	1.57 kB	1.57 kB	✓

Commit: 628f597

Fix incorrect _document.js error when disableStaticImages: true

d83e763

styfle requested a review from sokra November 1, 2021 23:11

styfle requested review from huozhi, ijjk, padmaia, shuding and timneutkens as code owners November 1, 2021 23:11

ijjk added created-by: Next.js team PRs by the Next.js team. type: documentation type: next labels Nov 1, 2021

ijjk reviewed Nov 1, 2021

View reviewed changes

errors/custom-document-image-import.md Outdated Show resolved Hide resolved

Apply suggestion from JJ

d13d1df

Co-authored-by: JJ Kasper <[email protected]>

ijjk previously approved these changes Nov 1, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

timneutkens previously approved these changes Nov 2, 2021

View reviewed changes

styfle mentioned this pull request Nov 2, 2021

next 12: False-Positive Build Error: "Images cannot be imported within pages/_document.js" #30600

Closed

Fix bug

34258bb

styfle dismissed stale reviews from timneutkens and ijjk via 34258bb November 2, 2021 19:12

styfle requested review from ijjk and timneutkens November 2, 2021 19:16

This comment has been minimized.

Sign in to view

ijjk approved these changes Nov 2, 2021

View reviewed changes

Merge branch 'canary' into fix-next-disable-image-import-document

628f597

kodiakhq bot merged commit 14841c9 into canary Nov 2, 2021

kodiakhq bot deleted the fix-next-disable-image-import-document branch November 2, 2021 20:25

vercel locked as resolved and limited conversation to collaborators Jan 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix incorrect `_document.js` error when `disableStaticImages: true` #30768

Fix incorrect `_document.js` error when `disableStaticImages: true` #30768

styfle commented Nov 1, 2021

This comment has been minimized.

ijjk commented Nov 1, 2021

This comment has been minimized.

ijjk commented Nov 2, 2021

Fix incorrect _document.js error when disableStaticImages: true #30768

Fix incorrect _document.js error when disableStaticImages: true #30768

Conversation

styfle commented Nov 1, 2021

This comment has been minimized.

ijjk commented Nov 1, 2021

Failing test suites

This comment has been minimized.

ijjk commented Nov 2, 2021

Stats from current PR

Fix incorrect `_document.js` error when `disableStaticImages: true` #30768

Fix incorrect `_document.js` error when `disableStaticImages: true` #30768