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

Update `next/future/image` to use svg blur placeholder during `next dev` (#39992)

This PR updates the `next/future/image` component so that CSS `filter` is never needed. Previously, we used SVG to blur for prod and CSS to blur for dev, but now we use SVG for both.

This required a shared function `getImageBlurSvg()` used between both client and server because `next dev` doesn't create Data URIs and instead defers blur generation until request time. So we also need to defer svg generation to request time (on the server) during next dev.

This is the first step to removing `<noscript>` completely (see #39736).
parent fdb629d0
...@@ -32,14 +32,6 @@ function nextImageLoader(content) { ...@@ -32,14 +32,6 @@ function nextImageLoader(content) {
let blurHeight let blurHeight
if (VALID_BLUR_EXT.includes(extension)) { if (VALID_BLUR_EXT.includes(extension)) {
if (isDev) {
const prefix = 'http://localhost'
const url = new URL(`${basePath || ''}/_next/image`, prefix)
url.searchParams.set('url', outputPath)
url.searchParams.set('w', BLUR_IMG_SIZE)
url.searchParams.set('q', BLUR_QUALITY)
blurDataURL = url.href.slice(prefix.length)
} else {
// Shrink the image's largest dimension // Shrink the image's largest dimension
if (imageSize.width >= imageSize.height) { if (imageSize.width >= imageSize.height) {
blurWidth = BLUR_IMG_SIZE blurWidth = BLUR_IMG_SIZE
...@@ -53,6 +45,17 @@ function nextImageLoader(content) { ...@@ -53,6 +45,17 @@ function nextImageLoader(content) {
blurHeight = BLUR_IMG_SIZE blurHeight = BLUR_IMG_SIZE
} }
if (isDev) {
// During `next dev`, we don't want to generate blur placeholders with webpack
// because it can delay starting the dev server. Instead, we inline a
// special url to lazily generate the blur placeholder at request time.
const prefix = 'http://localhost'
const url = new URL(`${basePath || ''}/_next/image`, prefix)
url.searchParams.set('url', outputPath)
url.searchParams.set('w', blurWidth)
url.searchParams.set('q', BLUR_QUALITY)
blurDataURL = url.href.slice(prefix.length)
} else {
const resizeImageSpan = imageLoaderSpan.traceChild('image-resize') const resizeImageSpan = imageLoaderSpan.traceChild('image-resize')
const resizedImage = await resizeImageSpan.traceAsyncFn(() => const resizedImage = await resizeImageSpan.traceAsyncFn(() =>
resizeImage(content, blurWidth, blurHeight, extension, BLUR_QUALITY) resizeImage(content, blurWidth, blurHeight, extension, BLUR_QUALITY)
......
...@@ -7,6 +7,7 @@ import React, { ...@@ -7,6 +7,7 @@ import React, {
useState, useState,
} from 'react' } from 'react'
import Head from '../../shared/lib/head' import Head from '../../shared/lib/head'
import { getImageBlurSvg } from '../../shared/lib/image-blur-svg'
import { import {
ImageConfigComplete, ImageConfigComplete,
imageConfigDefault, imageConfigDefault,
...@@ -794,13 +795,6 @@ export default function Image({ ...@@ -794,13 +795,6 @@ export default function Image({
showAltText ? {} : { color: 'transparent' }, showAltText ? {} : { color: 'transparent' },
style style
) )
const std = blurWidth && blurHeight ? '1' : '20'
const svgWidth = blurWidth || widthInt
const svgHeight = blurHeight || heightInt
const feComponentTransfer = blurDataURL?.startsWith('data:image/jpeg')
? `%3CfeComponentTransfer%3E%3CfeFuncA type='discrete' tableValues='1 1'/%3E%3C/feComponentTransfer%3E%`
: ''
const svgBlurPlaceholder = `url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http%3A//www.w3.org/2000/svg' viewBox='0 0 ${svgWidth} ${svgHeight}'%3E%3Cfilter id='b' color-interpolation-filters='sRGB'%3E%3CfeGaussianBlur stdDeviation='${std}'/%3E${feComponentTransfer}%3C/filter%3E%3Cimage filter='url(%23b)' x='0' y='0' height='100%25' width='100%25' href='${blurDataURL}'/%3E%3C/svg%3E")`
const blurStyle = const blurStyle =
placeholder === 'blur' && blurDataURL && !blurComplete placeholder === 'blur' && blurDataURL && !blurComplete
...@@ -808,17 +802,27 @@ export default function Image({ ...@@ -808,17 +802,27 @@ export default function Image({
backgroundSize: imgStyle.objectFit || 'cover', backgroundSize: imgStyle.objectFit || 'cover',
backgroundPosition: imgStyle.objectPosition || '50% 50%', backgroundPosition: imgStyle.objectPosition || '50% 50%',
backgroundRepeat: 'no-repeat', backgroundRepeat: 'no-repeat',
...(blurDataURL.startsWith('data:image') && svgWidth && svgHeight backgroundImage: `url("data:image/svg+xml;charset=utf-8,${getImageBlurSvg(
? { {
backgroundImage: svgBlurPlaceholder, widthInt,
heightInt,
blurWidth,
blurHeight,
blurDataURL,
} }
: { )}")`,
filter: 'blur(20px)',
backgroundImage: `url("${blurDataURL}")`,
}),
} }
: {} : {}
if (process.env.NODE_ENV === 'development') {
if (blurStyle.backgroundImage && blurDataURL?.startsWith('/')) {
// During `next dev`, we don't want to generate blur placeholders with webpack
// because it can delay starting the dev server. Instead, `next-image-loader.js`
// will inline a special url to lazily generate the blur placeholder at request time.
blurStyle.backgroundImage = `url("${blurDataURL}")`
}
}
const imgAttributes = generateImgAttrs({ const imgAttributes = generateImgAttrs({
config, config,
src, src,
......
...@@ -9,7 +9,12 @@ import contentDisposition from 'next/dist/compiled/content-disposition' ...@@ -9,7 +9,12 @@ import contentDisposition from 'next/dist/compiled/content-disposition'
import { join } from 'path' import { join } from 'path'
import nodeUrl, { UrlWithParsedQuery } from 'url' import nodeUrl, { UrlWithParsedQuery } from 'url'
import { NextConfigComplete } from './config-shared' import { NextConfigComplete } from './config-shared'
import { processBuffer, decodeBuffer, Operation } from './lib/squoosh/main' import {
processBuffer,
decodeBuffer,
Operation,
getMetadata,
} from './lib/squoosh/main'
import { sendEtagResponse } from './send-payload' import { sendEtagResponse } from './send-payload'
import { getContentType, getExtension } from './serve-static' import { getContentType, getExtension } from './serve-static'
import chalk from 'next/dist/compiled/chalk' import chalk from 'next/dist/compiled/chalk'
...@@ -17,6 +22,7 @@ import { NextUrlWithParsedQuery } from './request-meta' ...@@ -17,6 +22,7 @@ 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' import { hasMatch } from '../shared/lib/match-remote-pattern'
import { getImageBlurSvg } from '../shared/lib/image-blur-svg'
type XCacheHeader = 'MISS' | 'HIT' | 'STALE' type XCacheHeader = 'MISS' | 'HIT' | 'STALE'
...@@ -30,6 +36,7 @@ const CACHE_VERSION = 3 ...@@ -30,6 +36,7 @@ const CACHE_VERSION = 3
const ANIMATABLE_TYPES = [WEBP, PNG, GIF] const ANIMATABLE_TYPES = [WEBP, PNG, GIF]
const VECTOR_TYPES = [SVG] const VECTOR_TYPES = [SVG]
const BLUR_IMG_SIZE = 8 // should match `next-image-loader` const BLUR_IMG_SIZE = 8 // should match `next-image-loader`
const BLUR_QUALITY = 70 // should match `next-image-loader`
let sharp: let sharp:
| (( | ((
...@@ -215,7 +222,10 @@ export class ImageOptimizerCache { ...@@ -215,7 +222,10 @@ export class ImageOptimizerCache {
sizes.push(BLUR_IMG_SIZE) sizes.push(BLUR_IMG_SIZE)
} }
if (!sizes.includes(width)) { const isValidSize =
sizes.includes(width) || (isDev && width <= BLUR_IMG_SIZE)
if (!isValidSize) {
return { return {
errorMessage: `"w" parameter (width) of ${width} is not allowed`, errorMessage: `"w" parameter (width) of ${width} is not allowed`,
} }
...@@ -385,6 +395,7 @@ export async function imageOptimizer( ...@@ -385,6 +395,7 @@ export async function imageOptimizer(
_res: ServerResponse, _res: ServerResponse,
paramsResult: ImageParamsResult, paramsResult: ImageParamsResult,
nextConfig: NextConfigComplete, nextConfig: NextConfigComplete,
isDev: boolean | undefined,
handleRequest: ( handleRequest: (
newReq: IncomingMessage, newReq: IncomingMessage,
newRes: ServerResponse, newRes: ServerResponse,
...@@ -602,6 +613,21 @@ export async function imageOptimizer( ...@@ -602,6 +613,21 @@ export async function imageOptimizer(
// End Squoosh transformation logic // End Squoosh transformation logic
} }
if (optimizedBuffer) { if (optimizedBuffer) {
if (isDev && width <= BLUR_IMG_SIZE && quality === BLUR_QUALITY) {
// During `next dev`, we don't want to generate blur placeholders with webpack
// because it can delay starting the dev server. Instead, `next-image-loader.js`
// will inline a special url to lazily generate the blur placeholder at request time.
const meta = await getMetadata(optimizedBuffer)
const opts = {
blurWidth: meta.width,
blurHeight: meta.height,
blurDataURL: `data:${contentType};base64,${optimizedBuffer.toString(
'base64'
)}`,
}
optimizedBuffer = Buffer.from(unescape(getImageBlurSvg(opts)))
contentType = 'image/svg+xml'
}
return { return {
buffer: optimizedBuffer, buffer: optimizedBuffer,
contentType, contentType,
......
...@@ -28,6 +28,14 @@ const getWorker = execOnce( ...@@ -28,6 +28,14 @@ const getWorker = execOnce(
}) })
) )
export async function getMetadata(
buffer: Buffer
): Promise<{ width: number; height: number }> {
const worker: typeof import('./impl') = getWorker() as any
const { width, height } = await worker.decodeBuffer(buffer)
return { width, height }
}
export async function processBuffer( export async function processBuffer(
buffer: Buffer, buffer: Buffer,
operations: Operation[], operations: Operation[],
......
...@@ -787,6 +787,7 @@ export default class NextNodeServer extends BaseServer { ...@@ -787,6 +787,7 @@ export default class NextNodeServer extends BaseServer {
res.originalResponse, res.originalResponse,
paramsResult, paramsResult,
this.nextConfig, this.nextConfig,
this.renderOpts.dev,
(newReq, newRes, newParsedUrl) => (newReq, newRes, newParsedUrl) =>
this.getRequestHandler()( this.getRequestHandler()(
new NodeNextRequest(newReq), new NodeNextRequest(newReq),
......
/**
* A shared function, used on both client and server, to generate a SVG blur placeholder.
*/
export function getImageBlurSvg({
widthInt,
heightInt,
blurWidth,
blurHeight,
blurDataURL,
}: {
widthInt?: number
heightInt?: number
blurWidth?: number
blurHeight?: number
blurDataURL: string
}): string {
const std = blurWidth && blurHeight ? '1' : '20'
const svgWidth = blurWidth || widthInt
const svgHeight = blurHeight || heightInt
const feComponentTransfer = blurDataURL.startsWith('data:image/jpeg')
? `%3CfeComponentTransfer%3E%3CfeFuncA type='discrete' tableValues='1 1'/%3E%3C/feComponentTransfer%3E%`
: ''
return `%3Csvg xmlns='http%3A//www.w3.org/2000/svg' viewBox='0 0 ${svgWidth} ${svgHeight}'%3E%3Cfilter id='b' color-interpolation-filters='sRGB'%3E%3CfeGaussianBlur stdDeviation='${std}'/%3E${feComponentTransfer}%3C/filter%3E%3Cimage filter='url(%23b)' x='0' y='0' height='100%25' width='100%25' href='${blurDataURL}'/%3E%3C/svg%3E`
}
...@@ -79,7 +79,7 @@ const runTests = (isDev) => { ...@@ -79,7 +79,7 @@ const runTests = (isDev) => {
const style = $('#basic-static').attr('style') const style = $('#basic-static').attr('style')
if (isDev) { if (isDev) {
expect(style).toBe( expect(style).toBe(
`color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;filter:blur(20px);background-image:url("/docs/_next/image?url=%2Fdocs%2F_next%2Fstatic%2Fmedia%2Ftest-rect.f323a148.jpg&w=8&q=70")` `color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;background-image:url("/docs/_next/image?url=%2Fdocs%2F_next%2Fstatic%2Fmedia%2Ftest-rect.f323a148.jpg&w=8&q=70")`
) )
} else { } else {
expect(style).toBe( expect(style).toBe(
...@@ -92,7 +92,7 @@ const runTests = (isDev) => { ...@@ -92,7 +92,7 @@ const runTests = (isDev) => {
const style = $('#blur-png').attr('style') const style = $('#blur-png').attr('style')
if (isDev) { if (isDev) {
expect(style).toBe( expect(style).toBe(
`color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;filter:blur(20px);background-image:url("/docs/_next/image?url=%2Fdocs%2F_next%2Fstatic%2Fmedia%2Ftest.3f1a293b.png&w=8&q=70")` `color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;background-image:url("/docs/_next/image?url=%2Fdocs%2F_next%2Fstatic%2Fmedia%2Ftest.3f1a293b.png&w=8&q=70")`
) )
} else { } else {
expect(style).toBe( expect(style).toBe(
......
...@@ -84,7 +84,7 @@ const runTests = (isDev) => { ...@@ -84,7 +84,7 @@ const runTests = (isDev) => {
const style = $('#basic-static').attr('style') const style = $('#basic-static').attr('style')
if (isDev) { if (isDev) {
expect(style).toBe( expect(style).toBe(
`color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;filter:blur(20px);background-image:url("/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Ftest-rect.f323a148.jpg&w=8&q=70")` `color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;background-image:url("/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Ftest-rect.f323a148.jpg&w=8&q=70")`
) )
} else { } else {
expect(style).toBe( expect(style).toBe(
...@@ -97,7 +97,7 @@ const runTests = (isDev) => { ...@@ -97,7 +97,7 @@ const runTests = (isDev) => {
const style = $('#blur-png').attr('style') const style = $('#blur-png').attr('style')
if (isDev) { if (isDev) {
expect(style).toBe( expect(style).toBe(
`color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;filter:blur(20px);background-image:url("/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Ftest.3f1a293b.png&w=8&q=70")` `color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;background-image:url("/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Ftest.3f1a293b.png&w=8&q=70")`
) )
} else { } else {
expect(style).toBe( expect(style).toBe(
...@@ -110,7 +110,7 @@ const runTests = (isDev) => { ...@@ -110,7 +110,7 @@ const runTests = (isDev) => {
const style = $('#blur-png-fill').attr('style') const style = $('#blur-png-fill').attr('style')
if (isDev) { if (isDev) {
expect(style).toBe( expect(style).toBe(
`position:absolute;height:100%;width:100%;left:0;top:0;right:0;bottom:0;color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;filter:blur(20px);background-image:url("/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Ftest.3f1a293b.png&w=8&q=70")` `position:absolute;height:100%;width:100%;left:0;top:0;right:0;bottom:0;color:transparent;background-size:cover;background-position:50% 50%;background-repeat:no-repeat;background-image:url("/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Ftest.3f1a293b.png&w=8&q=70")`
) )
} else { } else {
expect(style).toBe( expect(style).toBe(
......
...@@ -449,6 +449,38 @@ export function runTests(ctx) { ...@@ -449,6 +449,38 @@ export function runTests(ctx) {
) )
}) })
it('should emit blur svg when width is 8 in dev but not prod', async () => {
const query = { url: '/test.png', w: 8, q: 70 }
const opts = { headers: { accept: 'image/webp' } }
const res = await fetchViaHTTP(ctx.appPort, '/_next/image', query, opts)
if (isDev) {
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/svg+xml')
expect(await res.text()).toMatch(
`<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 8'><filter id='b' color-interpolation-filters='sRGB'><feGaussianBlur stdDeviation='1'/></filter><image filter='url(#b)' x='0' y='0' height='100%' width='100%' href='data:image/webp;base64`
)
} else {
expect(res.status).toBe(400)
expect(await res.text()).toBe(`"w" parameter (width) of 8 is not allowed`)
}
})
it('should emit blur svg when width is less than 8 in dev but not prod', async () => {
const query = { url: '/test.png', w: 3, q: 70 }
const opts = { headers: { accept: 'image/webp' } }
const res = await fetchViaHTTP(ctx.appPort, '/_next/image', query, opts)
if (isDev) {
expect(res.status).toBe(200)
expect(res.headers.get('Content-Type')).toBe('image/svg+xml')
expect(await res.text()).toMatch(
`<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 3 3'><filter id='b' color-interpolation-filters='sRGB'><feGaussianBlur stdDeviation='1'/></filter><image filter='url(#b)' x='0' y='0' height='100%' width='100%' href='data:image/webp;base64`
)
} else {
expect(res.status).toBe(400)
expect(await res.text()).toBe(`"w" parameter (width) of 3 is not allowed`)
}
})
it('should resize relative url and webp Firefox accept header', async () => { it('should resize relative url and webp Firefox accept header', async () => {
const query = { url: '/test.png', w: ctx.w, q: 80 } const query = { url: '/test.png', w: ctx.w, q: 80 }
const opts = { headers: { accept: 'image/webp,*/*' } } const opts = { headers: { accept: 'image/webp,*/*' } }
......
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