Unverified Commit da8d1984 authored by Steven's avatar Steven Committed by GitHub

Add experimental wildcard `remotePatterns` config for upstream images (#36245)

## Description 
This PR implements a new configuration object in `next.config.js` called `experimental.images.remotePatterns`.

This will eventually deprecate `images.domains` because it covers the same use cases and more by allowing wildcard pattern matching on `hostname` and `pathname` and also allows restricting `protocol` and `port`.

## Feature

- [x] Implements an existing feature request.
- [x] Related issues linked
- [x] Unit tests added
- [x] Integration tests added
- [x] Documentation added
- [x] Telemetry added. In case of a feature if it's used or not.
- [x] Errors have helpful link attached, see `contributing.md`

## Related 

- Fixes #27925 
- Closes #18429 
- Closes #18632
- Closes #18730
- Closes #27345
parent 0dd62111
...@@ -16,6 +16,7 @@ description: Enable Image Optimization with the built-in Image component. ...@@ -16,6 +16,7 @@ description: Enable Image Optimization with the built-in Image component.
| Version | Changes | | Version | Changes |
| --------- | ----------------------------------------------------------------------------------------------------- | | --------- | ----------------------------------------------------------------------------------------------------- |
| `v12.1.7` | Experimental `remotePatterns` configuration added. |
| `v12.1.1` | `style` prop added. Experimental[\*](#experimental-raw-layout-mode) support for `layout="raw"` added. | | `v12.1.1` | `style` prop added. Experimental[\*](#experimental-raw-layout-mode) support for `layout="raw"` added. |
| `v12.1.0` | `dangerouslyAllowSVG` and `contentSecurityPolicy` configuration added. | | `v12.1.0` | `dangerouslyAllowSVG` and `contentSecurityPolicy` configuration added. |
| `v12.0.9` | `lazyRoot` prop added. | | `v12.0.9` | `lazyRoot` prop added. |
...@@ -313,9 +314,64 @@ Other properties on the `<Image />` component will be passed to the underlying ...@@ -313,9 +314,64 @@ Other properties on the `<Image />` component will be passed to the underlying
## Configuration Options ## Configuration Options
### Remote Patterns
> Note: The `remotePatterns` configuration is currently **experimental** and subject to change. Please use [`domains`](#domains) for production use cases.
To protect your application from malicious users, configuration is required in order to use external images. This ensures that only external images from your account can be served from the Next.js Image Optimization API. These external images can be configured with the `remotePatterns` property in your `next.config.js` file, as shown below:
```js
module.exports = {
experimental: {
images: {
remotePatterns: [
{
protocol: 'https',
hostname: 'example.com',
port: '',
pathname: '/account123/**',
},
],
},
},
}
```
> Note: The example above will ensure the `src` property of `next/image` must start with `https://example.com/account123/`. Any other protocol, hostname, port, or unmatched path will respond with 400 Bad Request.
Below is another example of the `remotePatterns` property in the `next.config.js` file:
```js
module.exports = {
experimental: {
images: {
remotePatterns: [
{
protocol: 'https',
hostname: '**.example.com',
},
],
},
},
}
```
> Note: The example above will ensure the `src` property of `next/image` must start with `https://img1.example.com` or `https://me.avatar.example.com` or any number of subdomains. Any other protocol or unmatched hostname will respond with 400 Bad Request.
Wildcard patterns can be used for both `pathname` and `hostname` and have the following syntax:
- `*` match a single path segment or subdomain
- `**` match any number of path segments at the end or subdomains at the beginning
The `**` syntax does not work in the middle of the pattern.
### Domains ### Domains
To protect your application from malicious users, you must define a list of image provider domains that you want to be served from the Next.js Image Optimization API. This is configured in with the `domains` property in your `next.config.js` file, as shown below: Similar to [`remotePatterns`](#remote-patterns), the `domains` configuration can be used to provide a list of allowed hostnames for external images.
However, the `domains` configuration does not support wildcard pattern matching and it cannot restrict protocol, port, or pathname.
Below is an example of the `domains` property in the `next.config.js` file:
```js ```js
module.exports = { module.exports = {
......
...@@ -66,7 +66,7 @@ function Home() { ...@@ -66,7 +66,7 @@ function Home() {
### Remote Images ### Remote Images
To use a remote image, the `src` property should be a URL string, which can be [relative](#loaders) or [absolute](#domains). Because Next.js does not have access to remote files during the build process, you'll need to provide the [`width`](/docs/api-reference/next/image.md#width), [`height`](/docs/api-reference/next/image.md#height) and optional [`blurDataURL`](/docs/api-reference/next/image.md#blurdataurl) props manually: To use a remote image, the `src` property should be a URL string, which can be [relative](#loaders) or [absolute](/docs/api-reference/next/image.md#domains). Because Next.js does not have access to remote files during the build process, you'll need to provide the [`width`](/docs/api-reference/next/image.md#width), [`height`](/docs/api-reference/next/image.md#height) and optional [`blurDataURL`](/docs/api-reference/next/image.md#blurdataurl) props manually:
```jsx ```jsx
import Image from 'next/image' import Image from 'next/image'
...@@ -93,15 +93,9 @@ export default function Home() { ...@@ -93,15 +93,9 @@ export default function Home() {
Sometimes you may want to access a remote image, but still use the built-in Next.js Image Optimization API. To do this, leave the `loader` at its default setting and enter an absolute URL for the Image `src`. Sometimes you may want to access a remote image, but still use the built-in Next.js Image Optimization API. To do this, leave the `loader` at its default setting and enter an absolute URL for the Image `src`.
To protect your application from malicious users, you must define a list of remote domains that you intend to access this way. This is configured in your `next.config.js` file, as shown below: To protect your application from malicious users, you must define a list of remote hostnames you intend to allow remote access.
```js > Learn more about [`domains`](/docs/api-reference/next/image.md#domains) configuration.
module.exports = {
images: {
domains: ['example.com', 'example2.com'],
},
}
```
### Loaders ### Loaders
...@@ -207,7 +201,7 @@ For examples of the Image component used with the various fill modes, see the [I ...@@ -207,7 +201,7 @@ For examples of the Image component used with the various fill modes, see the [I
## Configuration ## Configuration
The `next/image` component and Next.js Image Optimization API can be configured in the [`next.config.js` file](/docs/api-reference/next.config.js/introduction.md). These configurations allow you to [enable remote domains](/docs/api-reference/next/image.md#domains), [define custom image breakpoints](/docs/api-reference/next/image.md#device-sizes), [change caching behavior](/docs/api-reference/next/image.md#caching-behavior) and more. The `next/image` component and Next.js Image Optimization API can be configured in the [`next.config.js` file](/docs/api-reference/next.config.js/introduction.md). These configurations allow you to [enable remote images](/docs/api-reference/next/image.md#domains), [define custom image breakpoints](/docs/api-reference/next/image.md#device-sizes), [change caching behavior](/docs/api-reference/next/image.md#caching-behavior) and more.
[**Read the full image configuration documentation for more information.**](/docs/api-reference/next/image.md#configuration-options) [**Read the full image configuration documentation for more information.**](/docs/api-reference/next/image.md#configuration-options)
......
...@@ -17,6 +17,8 @@ module.exports = { ...@@ -17,6 +17,8 @@ module.exports = {
imageSizes: [16, 32, 48, 64, 96, 128, 256, 384], imageSizes: [16, 32, 48, 64, 96, 128, 256, 384],
// limit of 50 domains values // limit of 50 domains values
domains: [], domains: [],
// limit of 50 objects
remotePatterns: [],
// path prefix for Image Optimization API, useful with `loader` // path prefix for Image Optimization API, useful with `loader`
path: '/_next/image', path: '/_next/image',
// loader can be 'default', 'imgix', 'cloudinary', 'akamai', or 'custom' // loader can be 'default', 'imgix', 'cloudinary', 'akamai', or 'custom'
......
...@@ -2132,6 +2132,8 @@ export default async function build( ...@@ -2132,6 +2132,8 @@ export default async function build(
const images = { ...config.images } const images = { ...config.images }
const { deviceSizes, imageSizes } = images const { deviceSizes, imageSizes } = images
;(images as any).sizes = [...deviceSizes, ...imageSizes] ;(images as any).sizes = [...deviceSizes, ...imageSizes]
;(images as any).remotePatterns =
config?.experimental?.images?.remotePatterns || []
await promises.writeFile( await promises.writeFile(
path.join(distDir, IMAGES_MANIFEST), path.join(distDir, IMAGES_MANIFEST),
......
...@@ -1467,6 +1467,8 @@ export default async function getBaseWebpackConfig( ...@@ -1467,6 +1467,8 @@ export default async function getBaseWebpackConfig(
? { ? {
// pass domains in development to allow validating on the client // pass domains in development to allow validating on the client
domains: config.images.domains, domains: config.images.domains,
experimentalRemotePatterns:
config.experimental?.images?.remotePatterns,
} }
: {}), : {}),
}), }),
......
...@@ -18,8 +18,8 @@ import { ImageConfigContext } from '../shared/lib/image-config-context' ...@@ -18,8 +18,8 @@ import { ImageConfigContext } from '../shared/lib/image-config-context'
import { warnOnce } from '../shared/lib/utils' import { warnOnce } from '../shared/lib/utils'
import { normalizePathTrailingSlash } from './normalize-trailing-slash' import { normalizePathTrailingSlash } from './normalize-trailing-slash'
const experimentalLayoutRaw = (process.env.__NEXT_IMAGE_OPTS as any) const { experimentalLayoutRaw = false, experimentalRemotePatterns = [] } =
?.experimentalLayoutRaw (process.env.__NEXT_IMAGE_OPTS as any) || {}
const configEnv = process.env.__NEXT_IMAGE_OPTS as any as ImageConfigComplete const configEnv = process.env.__NEXT_IMAGE_OPTS as any as ImageConfigComplete
const loadedImageURLs = new Set<string>() const loadedImageURLs = new Set<string>()
const allImgs = new Map< const allImgs = new Map<
...@@ -1063,7 +1063,10 @@ function defaultLoader({ ...@@ -1063,7 +1063,10 @@ function defaultLoader({
) )
} }
if (!src.startsWith('/') && config.domains) { if (
!src.startsWith('/') &&
(config.domains || experimentalRemotePatterns)
) {
let parsedSrc: URL let parsedSrc: URL
try { try {
parsedSrc = new URL(src) parsedSrc = new URL(src)
...@@ -1074,14 +1077,15 @@ function defaultLoader({ ...@@ -1074,14 +1077,15 @@ function defaultLoader({
) )
} }
if ( if (process.env.NODE_ENV !== 'test') {
process.env.NODE_ENV !== 'test' && // We use dynamic require because this should only error in development
!config.domains.includes(parsedSrc.hostname) const { hasMatch } = require('../shared/lib/match-remote-pattern')
) { if (!hasMatch(config.domains, experimentalRemotePatterns, parsedSrc)) {
throw new Error( throw new Error(
`Invalid src prop (${src}) on \`next/image\`, hostname "${parsedSrc.hostname}" is not configured under images in your \`next.config.js\`\n` + `Invalid src prop (${src}) on \`next/image\`, hostname "${parsedSrc.hostname}" is not configured under images in your \`next.config.js\`\n` +
`See more info: https://nextjs.org/docs/messages/next-image-unconfigured-host` `See more info: https://nextjs.org/docs/messages/next-image-unconfigured-host`
) )
}
} }
} }
} }
......
...@@ -5,6 +5,7 @@ import { ...@@ -5,6 +5,7 @@ import {
ImageConfig, ImageConfig,
ImageConfigComplete, ImageConfigComplete,
imageConfigDefault, imageConfigDefault,
RemotePattern,
} from '../shared/lib/image-config' } from '../shared/lib/image-config'
export type PageRuntime = 'nodejs' | 'edge' | undefined export type PageRuntime = 'nodejs' | 'edge' | undefined
...@@ -115,6 +116,7 @@ export interface ExperimentalConfig { ...@@ -115,6 +116,7 @@ export interface ExperimentalConfig {
outputStandalone?: boolean outputStandalone?: boolean
images?: { images?: {
layoutRaw: boolean layoutRaw: boolean
remotePatterns: RemotePattern[]
} }
middlewareSourceMaps?: boolean middlewareSourceMaps?: boolean
emotion?: emotion?:
...@@ -501,6 +503,7 @@ export const defaultConfig: NextConfig = { ...@@ -501,6 +503,7 @@ export const defaultConfig: NextConfig = {
outputStandalone: !!process.env.NEXT_PRIVATE_STANDALONE, outputStandalone: !!process.env.NEXT_PRIVATE_STANDALONE,
images: { images: {
layoutRaw: false, layoutRaw: false,
remotePatterns: [],
}, },
}, },
} }
......
...@@ -234,6 +234,43 @@ function assignDefaults(userConfig: { [key: string]: any }) { ...@@ -234,6 +234,43 @@ function assignDefaults(userConfig: { [key: string]: any }) {
) )
} }
} }
const remotePatterns = result.experimental?.images?.remotePatterns
if (remotePatterns) {
if (!Array.isArray(remotePatterns)) {
throw new Error(
`Specified images.remotePatterns should be an Array received ${typeof remotePatterns}.\nSee more info here: https://nextjs.org/docs/messages/invalid-images-config`
)
}
if (remotePatterns.length > 50) {
throw new Error(
`Specified images.remotePatterns exceeds length of 50, received length (${remotePatterns.length}), please reduce the length of the array to continue.\nSee more info here: https://nextjs.org/docs/messages/invalid-images-config`
)
}
const validProps = new Set(['protocol', 'hostname', 'pathname', 'port'])
const requiredProps = ['hostname']
const invalidPatterns = remotePatterns.filter(
(d: unknown) =>
!d ||
typeof d !== 'object' ||
Object.entries(d).some(
([k, v]) => !validProps.has(k) || typeof v !== 'string'
) ||
requiredProps.some((k) => !(k in d))
)
if (invalidPatterns.length > 0) {
throw new Error(
`Invalid images.remotePatterns values:\n${invalidPatterns
.map((item) => JSON.stringify(item))
.join(
'\n'
)}\n\nremotePatterns value must follow format { protocol: 'https', hostname: 'example.com', port: '', pathname: '/imgs/**' }.\nSee more info here: https://nextjs.org/docs/messages/invalid-images-config`
)
}
}
if (images.deviceSizes) { if (images.deviceSizes) {
const { deviceSizes } = images const { deviceSizes } = images
if (!Array.isArray(deviceSizes)) { if (!Array.isArray(deviceSizes)) {
......
...@@ -17,6 +17,7 @@ import chalk from 'next/dist/compiled/chalk' ...@@ -17,6 +17,7 @@ import chalk from 'next/dist/compiled/chalk'
import { NextUrlWithParsedQuery } from './request-meta' import { NextUrlWithParsedQuery } from './request-meta'
import { IncrementalCacheEntry, IncrementalCacheValue } from './response-cache' import { IncrementalCacheEntry, IncrementalCacheValue } from './response-cache'
import { mockRequest } from './lib/mock-request' import { mockRequest } from './lib/mock-request'
import { hasMatch } from '../shared/lib/match-remote-pattern'
type XCacheHeader = 'MISS' | 'HIT' | 'STALE' type XCacheHeader = 'MISS' | 'HIT' | 'STALE'
...@@ -75,6 +76,7 @@ export class ImageOptimizerCache { ...@@ -75,6 +76,7 @@ export class ImageOptimizerCache {
minimumCacheTTL = 60, minimumCacheTTL = 60,
formats = ['image/webp'], formats = ['image/webp'],
} = imageData } = imageData
const remotePatterns = nextConfig.experimental.images?.remotePatterns || []
const { url, w, q } = query const { url, w, q } = query
let href: string let href: string
...@@ -104,7 +106,7 @@ export class ImageOptimizerCache { ...@@ -104,7 +106,7 @@ export class ImageOptimizerCache {
return { errorMessage: '"url" parameter is invalid' } return { errorMessage: '"url" parameter is invalid' }
} }
if (!domains || !domains.includes(hrefParsed.hostname)) { if (!hasMatch(domains, remotePatterns, hrefParsed)) {
return { errorMessage: '"url" parameter is not allowed' } return { errorMessage: '"url" parameter is not allowed' }
} }
} }
......
...@@ -8,6 +8,33 @@ export const VALID_LOADERS = [ ...@@ -8,6 +8,33 @@ export const VALID_LOADERS = [
export type LoaderValue = typeof VALID_LOADERS[number] export type LoaderValue = typeof VALID_LOADERS[number]
export type RemotePattern = {
/**
* Must be `http` or `https`.
*/
protocol?: 'http' | 'https'
/**
* Can be literal or wildcard.
* Single `*` matches a single subdomain.
* Double `**` matches any number of subdomains.
*/
hostname: string
/**
* Can be literal port such as `8080` or empty string
* meaning no port.
*/
port?: string
/**
* Can be literal or wildcard.
* Single `*` matches a single path segment.
* Double `**` matches any number of path segments.
*/
pathname?: string
}
type ImageFormat = 'image/avif' | 'image/webp' type ImageFormat = 'image/avif' | 'image/webp'
/** /**
...@@ -28,7 +55,9 @@ export type ImageConfigComplete = { ...@@ -28,7 +55,9 @@ export type ImageConfigComplete = {
/** @see [Image loader configuration](https://nextjs.org/docs/api-reference/next/image#loader-configuration) */ /** @see [Image loader configuration](https://nextjs.org/docs/api-reference/next/image#loader-configuration) */
path: string path: string
/** @see [Image domains configuration](https://nextjs.org/docs/basic-features/image-optimization#domains) */ /**
* @see [Image domains configuration](https://nextjs.org/docs/api-reference/next/image#domains)
*/
domains: string[] domains: string[]
/** @see [Cache behavior](https://nextjs.org/docs/api-reference/next/image#caching-behavior) */ /** @see [Cache behavior](https://nextjs.org/docs/api-reference/next/image#caching-behavior) */
......
import type { RemotePattern } from './image-config'
export function matchRemotePattern(pattern: RemotePattern, url: URL): boolean {
if (pattern.protocol !== undefined) {
const actualProto = url.protocol.slice(0, -1)
if (pattern.protocol !== actualProto) {
return false
}
}
if (pattern.port !== undefined) {
if (pattern.port !== url.port) {
return false
}
}
if (pattern.pathname !== undefined) {
const patternParts = pattern.pathname.split('/')
const actualParts = url.pathname.split('/')
const len = Math.max(patternParts.length, actualParts.length)
for (let i = 0; i < len; i++) {
if (patternParts[i] === '**' && actualParts[i] !== undefined) {
// Double asterisk means "match everything until the end of the path"
// so we can break the loop early. But we throw
// if the double asterisk is not the last part.
if (patternParts.length - 1 > i) {
throw new Error(
`Pattern can only contain ** at end of pathname but found "${pattern.pathname}"`
)
}
break
}
if (patternParts[i] === '*') {
// Single asterisk means "match this part" so we can
// continue to the next part of the loop
continue
}
if (patternParts[i] !== actualParts[i]) {
return false
}
}
}
if (pattern.hostname === undefined) {
throw new Error(
`Pattern should define hostname but found\n${JSON.stringify(pattern)}`
)
} else {
const patternParts = pattern.hostname.split('.').reverse()
const actualParts = url.hostname.split('.').reverse()
const len = Math.max(patternParts.length, actualParts.length)
for (let i = 0; i < len; i++) {
if (patternParts[i] === '**' && actualParts[i] !== undefined) {
// Double asterisk means "match every subdomain"
// so we can break the loop early. But we throw
// if the double asterisk is not the last part.
if (patternParts.length - 1 > i) {
throw new Error(
`Pattern can only contain ** at start of hostname but found "${pattern.hostname}"`
)
}
break
}
if (patternParts[i] === '*') {
// Single asterisk means "match this subdomain" so we can
// continue to the next part of the loop
continue
}
if (patternParts[i] !== actualParts[i]) {
return false
}
}
}
return true
}
export function hasMatch(
domains: string[],
remotePatterns: RemotePattern[],
url: URL
): boolean {
return (
domains.some((domain) => url.hostname === domain) ||
remotePatterns.some((p) => matchRemotePattern(p, url))
)
}
...@@ -21,6 +21,7 @@ type EventCliSessionStarted = { ...@@ -21,6 +21,7 @@ type EventCliSessionStarted = {
localeDomainsCount: number | null localeDomainsCount: number | null
localeDetectionEnabled: boolean | null localeDetectionEnabled: boolean | null
imageDomainsCount: number | null imageDomainsCount: number | null
imageRemotePatternsCount: number | null
imageSizes: string | null imageSizes: string | null
imageLoader: string | null imageLoader: string | null
imageFormats: string | null imageFormats: string | null
...@@ -65,6 +66,7 @@ export function eventCliSession( ...@@ -65,6 +66,7 @@ export function eventCliSession(
| 'localeDomainsCount' | 'localeDomainsCount'
| 'localeDetectionEnabled' | 'localeDetectionEnabled'
| 'imageDomainsCount' | 'imageDomainsCount'
| 'imageRemotePatternsCount'
| 'imageSizes' | 'imageSizes'
| 'imageLoader' | 'imageLoader'
| 'imageFormats' | 'imageFormats'
...@@ -77,7 +79,7 @@ export function eventCliSession( ...@@ -77,7 +79,7 @@ export function eventCliSession(
return [] return []
} }
const { images, i18n } = nextConfig || {} const { images, i18n, experimental } = nextConfig || {}
const payload: EventCliSessionStarted = { const payload: EventCliSessionStarted = {
nextVersion: process.env.__NEXT_VERSION, nextVersion: process.env.__NEXT_VERSION,
...@@ -97,6 +99,9 @@ export function eventCliSession( ...@@ -97,6 +99,9 @@ export function eventCliSession(
localeDomainsCount: i18n?.domains ? i18n.domains.length : null, localeDomainsCount: i18n?.domains ? i18n.domains.length : null,
localeDetectionEnabled: !i18n ? null : i18n.localeDetection !== false, localeDetectionEnabled: !i18n ? null : i18n.localeDetection !== false,
imageDomainsCount: images?.domains ? images.domains.length : null, imageDomainsCount: images?.domains ? images.domains.length : null,
imageRemotePatternsCount: experimental?.images?.remotePatterns
? experimental.images.remotePatterns.length
: null,
imageSizes: images?.imageSizes ? images.imageSizes.join(',') : null, imageSizes: images?.imageSizes ? images.imageSizes.join(',') : null,
imageLoader: images?.loader, imageLoader: images?.loader,
imageFormats: images?.formats ? images.formats.join(',') : null, imageFormats: images?.formats ? images.formats.join(',') : null,
......
module.exports = { module.exports = {
assetPrefix: 'https://example.com/pre', assetPrefix: 'https://example.com/pre',
// Intentionally omit `domains` and `remotePatterns`
} }
module.exports = { module.exports = {
images: { experimental: {
domains: ['image-optimization-test.vercel.app'], images: {
remotePatterns: [{ hostname: 'image-optimization-test.vercel.app' }],
},
}, },
} }
...@@ -48,6 +48,89 @@ describe('Image Optimizer', () => { ...@@ -48,6 +48,89 @@ describe('Image Optimizer', () => {
) )
}) })
it('should error when remotePatterns length exceeds 50', async () => {
await nextConfig.replace(
'{ /* replaceme */ }',
JSON.stringify({
experimental: {
images: {
remotePatterns: Array.from({ length: 51 }).map((_) => ({
hostname: 'example.com',
})),
},
},
})
)
let stderr = ''
app = await launchApp(appDir, await findPort(), {
onStderr(msg) {
stderr += msg || ''
},
})
await waitFor(1000)
await killApp(app).catch(() => {})
await nextConfig.restore()
expect(stderr).toContain(
'Specified images.remotePatterns exceeds length of 50, received length (51), please reduce the length of the array to continue'
)
})
it('should error when remotePatterns has invalid prop', async () => {
await nextConfig.replace(
'{ /* replaceme */ }',
JSON.stringify({
experimental: {
images: {
remotePatterns: [{ hostname: 'example.com', foo: 'bar' }],
},
},
})
)
let stderr = ''
app = await launchApp(appDir, await findPort(), {
onStderr(msg) {
stderr += msg || ''
},
})
await waitFor(1000)
await killApp(app).catch(() => {})
await nextConfig.restore()
expect(stderr).toContain(
'Invalid images.remotePatterns values:\n{"hostname":"example.com","foo":"bar"}'
)
})
it('should error when remotePatterns is missing hostname', async () => {
await nextConfig.replace(
'{ /* replaceme */ }',
JSON.stringify({
experimental: {
images: {
remotePatterns: [{ protocol: 'https' }],
},
},
})
)
let stderr = ''
app = await launchApp(appDir, await findPort(), {
onStderr(msg) {
stderr += msg || ''
},
})
await waitFor(1000)
await killApp(app).catch(() => {})
await nextConfig.restore()
expect(stderr).toContain(
'Invalid images.remotePatterns values:\n{"protocol":"https"}'
)
})
it('should error when sizes length exceeds 25', async () => { it('should error when sizes length exceeds 25', async () => {
await nextConfig.replace( await nextConfig.replace(
'{ /* replaceme */ }', '{ /* replaceme */ }',
......
...@@ -136,7 +136,7 @@ export function runTests(ctx) { ...@@ -136,7 +136,7 @@ export function runTests(ctx) {
slowImageServer.stop() slowImageServer.stop()
}) })
if (ctx.domains.includes('localhost')) { if (ctx.domains?.length > 0) {
it('should normalize invalid status codes', async () => { it('should normalize invalid status codes', async () => {
const url = `http://localhost:${ const url = `http://localhost:${
slowImageServer.port slowImageServer.port
...@@ -583,7 +583,7 @@ export function runTests(ctx) { ...@@ -583,7 +583,7 @@ export function runTests(ctx) {
}) })
} }
if (ctx.domains.includes('localhost')) { if (ctx.domains?.length > 0) {
it('should resize absolute url from localhost', async () => { it('should resize absolute url from localhost', async () => {
const url = `http://localhost:${ctx.appPort}/test.png` const url = `http://localhost:${ctx.appPort}/test.png`
const query = { url, w: ctx.w, q: 80 } const query = { url, w: ctx.w, q: 80 }
...@@ -762,7 +762,7 @@ export function runTests(ctx) { ...@@ -762,7 +762,7 @@ export function runTests(ctx) {
) )
}) })
if (ctx.domains.includes('localhost')) { if (ctx.domains?.length > 0) {
it('should fail when url fails to load an image', async () => { it('should fail when url fails to load an image', async () => {
const url = `http://localhost:${ctx.appPort}/not-an-image` const url = `http://localhost:${ctx.appPort}/not-an-image`
const query = { w: ctx.w, url, q: 100 } const query = { w: ctx.w, url, q: 100 }
...@@ -1119,7 +1119,7 @@ export function runTests(ctx) { ...@@ -1119,7 +1119,7 @@ export function runTests(ctx) {
expect(await res.text()).toBe("The requested resource isn't a valid image.") expect(await res.text()).toBe("The requested resource isn't a valid image.")
}) })
if (ctx.domains.length) { if (ctx.domains?.length > 0) {
it('should handle concurrent requests', async () => { it('should handle concurrent requests', async () => {
await cleanImagesDir(ctx) await cleanImagesDir(ctx)
const delay = 500 const delay = 500
......
...@@ -3,7 +3,12 @@ module.exports = phase => { ...@@ -3,7 +3,12 @@ module.exports = phase => {
images: { images: {
formats: ['image/avif', 'image/webp'], formats: ['image/avif', 'image/webp'],
imageSizes: [64, 128, 256, 512, 1024], imageSizes: [64, 128, 256, 512, 1024],
domains: ['example.com'], domains: ['example.com', 'another.com'],
},
experimental: {
images: {
remotePatterns: [{ protocol: 'https', hostname: '**.example.com' }],
},
}, },
i18n: { i18n: {
locales: ['en','nl','fr'], locales: ['en','nl','fr'],
......
...@@ -502,7 +502,8 @@ describe('Telemetry CLI', () => { ...@@ -502,7 +502,8 @@ describe('Telemetry CLI', () => {
expect(event1).toMatch(/"locales": "en,nl,fr"/) expect(event1).toMatch(/"locales": "en,nl,fr"/)
expect(event1).toMatch(/"localeDomainsCount": 2/) expect(event1).toMatch(/"localeDomainsCount": 2/)
expect(event1).toMatch(/"localeDetectionEnabled": true/) expect(event1).toMatch(/"localeDetectionEnabled": true/)
expect(event1).toMatch(/"imageDomainsCount": 1/) expect(event1).toMatch(/"imageDomainsCount": 2/)
expect(event1).toMatch(/"imageRemotePatternsCount": 1/)
expect(event1).toMatch(/"imageSizes": "64,128,256,512,1024"/) expect(event1).toMatch(/"imageSizes": "64,128,256,512,1024"/)
expect(event1).toMatch(/"imageFormats": "image\/avif,image\/webp"/) expect(event1).toMatch(/"imageFormats": "image\/avif,image\/webp"/)
expect(event1).toMatch(/"trailingSlashEnabled": false/) expect(event1).toMatch(/"trailingSlashEnabled": false/)
...@@ -538,7 +539,8 @@ describe('Telemetry CLI', () => { ...@@ -538,7 +539,8 @@ describe('Telemetry CLI', () => {
expect(event2).toMatch(/"locales": "en,nl,fr"/) expect(event2).toMatch(/"locales": "en,nl,fr"/)
expect(event2).toMatch(/"localeDomainsCount": 2/) expect(event2).toMatch(/"localeDomainsCount": 2/)
expect(event2).toMatch(/"localeDetectionEnabled": true/) expect(event2).toMatch(/"localeDetectionEnabled": true/)
expect(event2).toMatch(/"imageDomainsCount": 1/) expect(event2).toMatch(/"imageDomainsCount": 2/)
expect(event2).toMatch(/"imageRemotePatternsCount": 1/)
expect(event2).toMatch(/"imageSizes": "64,128,256,512,1024"/) expect(event2).toMatch(/"imageSizes": "64,128,256,512,1024"/)
expect(event2).toMatch(/"trailingSlashEnabled": false/) expect(event2).toMatch(/"trailingSlashEnabled": false/)
expect(event2).toMatch(/"reactStrictMode": false/) expect(event2).toMatch(/"reactStrictMode": false/)
......
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment