fix: should allow optional properties for `images` option #28709

catnose99 · 2021-09-01T14:17:35Z

Bug

Fixes type images?: ImageOption on next.config.js does not allow optional properties. #28708
Related issues linked using fixes #number

styfle

Thanks!

packages/next/server/config-shared.ts

catnose99 · 2021-09-02T01:19:30Z

@ijjk @styfle

I made some changes to NextConfigComplete and ImageConfig.

To solve type errors caused by difference in required props between next.config.js and NextConfigComplete,
I newly defined ImageConfigComplete.

Feel free to close this PR if these changes are not following the project convention.
Thanks.

packages/next/server/config-shared.ts

Co-authored-by: Steven <steven@ceriously.com>

ijjk · 2021-09-07T09:04:51Z

Failing test suites

Commit: 0e96e44

test/integration/required-server-files/test/index.test.js

Required Server Files > should output required-server-files manifest correctly
Required Server Files > should render SSR page correctly
Required Server Files > should render dynamic SSR page correctly
Required Server Files > should render fallback page correctly
Required Server Files > should render SSR page correctly with x-matched-path
Required Server Files > should render dynamic SSR page correctly with x-matched-path
Required Server Files > should render fallback page correctly with x-matched-path and routes-matches
Required Server Files > should return data correctly with x-matched-path
Required Server Files > should render fallback optional catch-all route correctly with x-matched-path and routes-matches
Required Server Files > should return data correctly with x-matched-path for optional catch-all route
Required Server Files > should not apply trailingSlash redirect
Required Server Files > should normalize catch-all rewrite query values correctly
Required Server Files > should bubble error correctly for gip page
Required Server Files > should bubble error correctly for gssp page
Required Server Files > should bubble error correctly for gsp page
Required Server Files > should bubble error correctly for API page
Required Server Files > should normalize optional values correctly for SSP page
Required Server Files > should normalize optional values correctly for SSG page
Required Server Files > should normalize optional values correctly for SSG page with encoded slash
Required Server Files > should normalize optional values correctly for API page
Required Server Files > should match the index page correctly
Required Server Files > should match the root dyanmic page correctly

Expand output

● Required Server Files › should output required-server-files manifest correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render SSR page correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render dynamic SSR page correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render fallback page correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render SSR page correctly with x-matched-path

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render dynamic SSR page correctly with x-matched-path

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render fallback page correctly with x-matched-path and routes-matches

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should return data correctly with x-matched-path

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should render fallback optional catch-all route correctly with x-matched-path and routes-matches

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should return data correctly with x-matched-path for optional catch-all route

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should not apply trailingSlash redirect

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should normalize catch-all rewrite query values correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should bubble error correctly for gip page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should bubble error correctly for gssp page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should bubble error correctly for gsp page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should bubble error correctly for API page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should normalize optional values correctly for SSP page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should normalize optional values correctly for SSG page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should normalize optional values correctly for SSG page with encoded slash

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should normalize optional values correctly for API page

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should match the index page correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

● Required Server Files › should match the root dyanmic page correctly

Command failed with exit code 1 (EPERM): yarn install

  42 |     await fs.writeFile(
  43 |       join(workDir, 'package.json'),
> 44 |       JSON.stringify({
     |         ^
  45 |         dependencies: {
  46 |           next: packagePath,
  47 |           react: 'latest',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at integration/required-server-files/test/index.test.js:44:9

ijjk · 2021-09-08T21:40:42Z

Stats from current PR

Default Build (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
buildDuration	11.9s	11.9s	⚠️ +22ms
buildDurationCached	3.1s	3s	-92ms
nodeModulesSize	48.2 MB	48.2 MB	⚠️ +154 B

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.348	2.358	⚠️ +0.01
/ avg req/sec	1064.9	1060.32	⚠️ -4.58
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.255	1.283	⚠️ +0.03
/error-in-render avg req/sec	1992.16	1949.21	⚠️ -42.95

Client Bundles (main, webpack, commons)

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
745.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	23.3 kB	23.3 kB	✓
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	67.2 kB	67.2 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
_app-HASH.js gzip	979 B	979 B	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	312 B	312 B	✓
css-HASH.js gzip	329 B	329 B	✓
dynamic-HASH.js gzip	2.67 kB	2.67 kB	✓
head-HASH.js gzip	351 B	351 B	✓
hooks-HASH.js gzip	918 B	918 B	✓
image-HASH.js gzip	4.14 kB	4.14 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	318 B	318 B	✓
script-HASH.js gzip	387 B	387 B	✓
withRouter-HASH.js gzip	320 B	320 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	13 kB	13 kB	✓

Client Build Manifests

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
_buildManifest.js gzip	492 B	492 B	✓
Overall change	492 B	492 B	✓

Rendered Page Sizes

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
index.html gzip	539 B	539 B	✓
link.html gzip	552 B	552 B	✓
withRouter.html gzip	533 B	533 B	✓
Overall change	1.62 kB	1.62 kB	✓

Webpack 4 Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
buildDuration	9.6s	9.6s	-12ms
buildDurationCached	4s	4s	-38ms
nodeModulesSize	48.2 MB	48.2 MB	⚠️ +154 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.353	2.342	-0.01
/ avg req/sec	1062.58	1067.6	+5.02
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.28	1.254	-0.03
/error-in-render avg req/sec	1952.8	1993.21	+40.41

Client Bundles (main, webpack, commons)

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
16.HASH.js gzip	186 B	186 B	✓
677f882d2ed8..HASH.js gzip	14.1 kB	14.1 kB	✓
framework.HASH.js gzip	41.9 kB	41.9 kB	✓
main-HASH.js gzip	10.7 kB	10.7 kB	✓
webpack-HASH.js gzip	1.19 kB	1.19 kB	✓
Overall change	68.1 kB	68.1 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
_app-HASH.js gzip	964 B	964 B	✓
_error-HASH.js gzip	3.8 kB	3.8 kB	✓
amp-HASH.js gzip	552 B	552 B	✓
css-HASH.js gzip	333 B	333 B	✓
dynamic-HASH.js gzip	2.87 kB	2.87 kB	✓
head-HASH.js gzip	3.06 kB	3.06 kB	✓
hooks-HASH.js gzip	924 B	924 B	✓
index-HASH.js gzip	231 B	231 B	✓
link-HASH.js gzip	1.64 kB	1.64 kB	✓
routerDirect..HASH.js gzip	298 B	298 B	✓
script-HASH.js gzip	3.03 kB	3.03 kB	✓
withRouter-HASH.js gzip	295 B	295 B	✓
30809af5c834..565.css gzip	125 B	125 B	✓
Overall change	18.1 kB	18.1 kB	✓

Client Build Manifests

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
_buildManifest.js gzip	500 B	500 B	✓
Overall change	500 B	500 B	✓

Rendered Page Sizes

	vercel/next.js canary	catnose99/next.js fix-images-type	Change
index.html gzip	585 B	585 B	✓
link.html gzip	597 B	597 B	✓
withRouter.html gzip	578 B	578 B	✓
Overall change	1.76 kB	1.76 kB	✓

Commit: 399e301

* canary: fix: should allow optional properties for `images` option (vercel#28709) chore(examples): switch to Script component on the google analytics example (vercel#27674)

fix: should allow partial ImageConfig for images option

68a13f5

catnose99 requested review from huozhi, ijjk, padmaia, shuding, styfle and timneutkens as code owners September 1, 2021 14:17

ijjk added the type: next label Sep 1, 2021

catnose99 mentioned this pull request Sep 1, 2021

type images?: ImageOption on next.config.js does not allow optional properties. #28708

Closed

styfle previously approved these changes Sep 1, 2021

View reviewed changes

ijjk previously approved these changes Sep 1, 2021

View reviewed changes

ijjk reviewed Sep 1, 2021

View reviewed changes

packages/next/server/config-shared.ts Outdated Show resolved Hide resolved

catnose99 and others added 2 commits September 2, 2021 06:54

Merge branch 'canary' into fix-images-type

997c0f5

fix: type errors for ImageConfig

52e1cca

catnose99 dismissed stale reviews from ijjk and styfle via 52e1cca September 2, 2021 01:10

catnose99 requested review from ijjk and styfle September 2, 2021 01:19

catnose99 commented Sep 2, 2021

View reviewed changes

packages/next/server/config-shared.ts Show resolved Hide resolved

catnose99 commented Sep 2, 2021

View reviewed changes

packages/next/server/config-shared.ts Outdated Show resolved Hide resolved

Merge branch 'canary' into fix-images-type

cf33483

This comment has been minimized.

Sign in to view

Merge branch 'canary' into fix-images-type

b7529ee

styfle reviewed Sep 3, 2021

View reviewed changes

packages/next/server/config-shared.ts Outdated Show resolved Hide resolved

catnose99 and others added 2 commits September 4, 2021 08:42

fix: use type alias for NextConfigComplete

26356cf

Co-authored-by: Steven <steven@ceriously.com>

Merge branch 'canary' into fix-images-type

f3ae4e6

catnose99 requested a review from styfle September 5, 2021 00:41

catnose99 added 2 commits September 5, 2021 09:41

Merge branch 'canary' into fix-images-type

a3a723e

Merge branch 'canary' into fix-images-type

37d2af2

styfle approved these changes Sep 6, 2021

View reviewed changes

Merge branch 'canary' into fix-images-type

d5b717f

This comment has been minimized.

Sign in to view

Merge branch 'canary' into fix-images-type

7f3ddea

This comment has been minimized.

Sign in to view

Merge branch 'canary' into fix-images-type

745b6f5

This comment has been minimized.

Sign in to view

catnose99 and others added 3 commits September 7, 2021 15:37

Merge branch 'canary' into fix-images-type

69d15ce

Merge branch 'canary' into fix-images-type

0d57ba6

Merge branch 'canary' into fix-images-type

0e96e44

This comment has been minimized.

Sign in to view

Merge branch 'canary' into fix-images-type

ba2352b

This comment has been minimized.

Sign in to view

Merge branch 'canary' into fix-images-type

399e301

kodiakhq bot merged commit 1389339 into vercel:canary Sep 8, 2021

catnose99 deleted the fix-images-type branch September 8, 2021 22:48

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: should allow optional properties for `images` option #28709

fix: should allow optional properties for `images` option #28709

catnose99 commented Sep 1, 2021 •

edited

Loading

styfle left a comment

catnose99 commented Sep 2, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ijjk commented Sep 7, 2021

This comment has been minimized.

ijjk commented Sep 8, 2021

fix: should allow optional properties for images option #28709

fix: should allow optional properties for images option #28709

Conversation

catnose99 commented Sep 1, 2021 • edited Loading

Bug

styfle left a comment

Choose a reason for hiding this comment

catnose99 commented Sep 2, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ijjk commented Sep 7, 2021

Failing test suites

This comment has been minimized.

ijjk commented Sep 8, 2021

Stats from current PR

fix: should allow optional properties for `images` option #28709

fix: should allow optional properties for `images` option #28709

catnose99 commented Sep 1, 2021 •

edited

Loading