feat: add experimental imgOptSequentialRead config (#72411)

This setting was originally added in PR #44881 and then removed in PR #65846 however it seems like it may still be useful in some cases. The [sharp docs](https://sharp.pixelplumbing.com/api-constructor) are not very clear: > false to use random access, true to use sequential reads. Some operations will do this automatically. Let's add it back as an experimental setting so we can measure performance.
vercel · Nov 6, 2024 · 1c219b1 · 1c219b1
1 parent 93a720f
commit 1c219b1
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/packages/next/src/server/config-schema.ts b/packages/next/src/server/config-schema.ts
@@ -317,6 +317,7 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() =>
         imgOptConcurrency: z.number().int().optional().nullable(),
         imgOptTimeoutInSeconds: z.number().int().optional(),
         imgOptMaxInputPixels: z.number().int().optional(),
+        imgOptSequentialRead: z.boolean().optional().nullable(),
         internal_disableSyncDynamicAPIWarnings: z.boolean().optional(),
         isrFlushToDisk: z.boolean().optional(),
         largePageDataBytes: z.number().optional(),

diff --git a/packages/next/src/server/config-shared.ts b/packages/next/src/server/config-shared.ts
@@ -289,6 +289,7 @@ export interface ExperimentalConfig {
   imgOptConcurrency?: number | null
   imgOptTimeoutInSeconds?: number
   imgOptMaxInputPixels?: number
+  imgOptSequentialRead?: boolean | null
   optimisticClientCache?: boolean
   /**
    * @deprecated use config.expireTime instead
@@ -1101,6 +1102,7 @@ export const defaultConfig: NextConfig = {
     imgOptConcurrency: null,
     imgOptTimeoutInSeconds: 7,
     imgOptMaxInputPixels: 268_402_689, // https://sharp.pixelplumbing.com/api-constructor#:~:text=%5Boptions.limitInputPixels%5D
+    imgOptSequentialRead: null,
     isrFlushToDisk: true,
     workerThreads: false,
     proxyTimeout: undefined,

diff --git a/packages/next/src/server/image-optimizer.ts b/packages/next/src/server/image-optimizer.ts
@@ -514,6 +514,7 @@ export async function optimizeImage({
   height,
   concurrency,
   limitInputPixels,
+  sequentialRead,
   timeoutInSeconds,
 }: {
   buffer: Buffer
@@ -523,11 +524,13 @@ export async function optimizeImage({
   height?: number
   concurrency?: number | null
   limitInputPixels?: number
+  sequentialRead?: boolean | null
   timeoutInSeconds?: number
 }): Promise<Buffer> {
   const sharp = getSharp(concurrency)
   const transformer = sharp(buffer, {
     limitInputPixels,
+    sequentialRead: sequentialRead ?? undefined,
   })
     .timeout({
       seconds: timeoutInSeconds ?? 7,
@@ -645,7 +648,10 @@ export async function imageOptimizer(
   nextConfig: {
     experimental: Pick<
       NextConfigComplete['experimental'],
-      'imgOptConcurrency' | 'imgOptMaxInputPixels' | 'imgOptTimeoutInSeconds'
+      | 'imgOptConcurrency'
+      | 'imgOptMaxInputPixels'
+      | 'imgOptSequentialRead'
+      | 'imgOptTimeoutInSeconds'
     >
     images: Pick<
       NextConfigComplete['images'],
@@ -753,6 +759,7 @@ export async function imageOptimizer(
       width,
       concurrency: nextConfig.experimental.imgOptConcurrency,
       limitInputPixels: nextConfig.experimental.imgOptMaxInputPixels,
+      sequentialRead: nextConfig.experimental.imgOptSequentialRead,
       timeoutInSeconds: nextConfig.experimental.imgOptTimeoutInSeconds,
     })
     if (optimizedBuffer) {