Changes encoding on cache.body from utf8 to base64 (#329)

* changes encoding on cache.body from utf8 to base64 * retain utf8 for json content-type * opting for less greedy base64 * use isBinaryContentType * changeset --------- Co-authored-by: Dorseuil Nicolas <[email protected]>
opennextjs · Jan 5, 2024 · fd90b26 · fd90b26 · vercel · Jan 5, 2024
1 parent eb08980
commit fd90b26
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 6 deletions.
diff --git a/.changeset/wicked-comics-trade.md b/.changeset/wicked-comics-trade.md
@@ -0,0 +1,5 @@
+---
+"open-next": patch
+---
+
+Changes encoding on cache.body for binary data
diff --git a/packages/open-next/src/adapters/cache.ts b/packages/open-next/src/adapters/cache.ts
@@ -13,6 +13,7 @@ import {
 } from "@aws-sdk/client-s3";
 import path from "path";
 
+import { isBinaryContentType } from "./binary.js";
 import { MAX_DYNAMO_BATCH_WRITE_ITEM_COUNT } from "./constants.js";
 import { debug, error, warn } from "./logger.js";
 import { chunk } from "./util.js";
@@ -226,7 +227,12 @@ export default class S3Cache {
           lastModified: LastModified?.getTime(),
           value: {
             kind: "ROUTE",
-            body: Buffer.from(cacheData.body ?? Buffer.alloc(0)),
+            body: Buffer.from(
+              cacheData.body ?? Buffer.alloc(0),
+              isBinaryContentType(String(meta?.headers?.["content-type"]))
+                ? "base64"
+                : "utf8",
+            ),
             status: meta?.status,
             headers: meta?.headers,
           },
@@ -276,7 +282,11 @@ export default class S3Cache {
         "cache",
         JSON.stringify({
           type: "route",
-          body: body.toString("utf8"),
+          body: body.toString(
+            isBinaryContentType(String(headers["content-type"]))
+              ? "base64"
+              : "utf8",
+          ),
           meta: {
             status,
             headers,

diff --git a/packages/open-next/src/build.ts b/packages/open-next/src/build.ts
@@ -10,6 +10,7 @@ import {
   buildSync,
 } from "esbuild";
 
+import { isBinaryContentType } from "./adapters/binary.js";
 import logger from "./logger.js";
 import { minifyAll } from "./minimize-js.js";
 import openNextPlugin from "./plugin.js";
@@ -494,17 +495,26 @@ function createCacheAssets(monorepoRoot: string, disableDynamoDBCache = false) {
 
   // Generate cache file
   Object.entries(cacheFilesPath).forEach(([cacheFilePath, files]) => {
+    const cacheFileMeta = files.meta
+      ? JSON.parse(fs.readFileSync(files.meta, "utf8"))
+      : undefined;
     const cacheFileContent = {
       type: files.body ? "route" : files.json ? "page" : "app",
-      meta: files.meta
-        ? JSON.parse(fs.readFileSync(files.meta, "utf8"))
-        : undefined,
+      meta: cacheFileMeta,
       html: files.html ? fs.readFileSync(files.html, "utf8") : undefined,
       json: files.json
         ? JSON.parse(fs.readFileSync(files.json, "utf8"))
         : undefined,
       rsc: files.rsc ? fs.readFileSync(files.rsc, "utf8") : undefined,
-      body: files.body ? fs.readFileSync(files.body, "utf8") : undefined,
+      body: files.body
+        ? fs
+            .readFileSync(files.body)
+            .toString(
+              isBinaryContentType(cacheFileMeta.headers["content-type"])
+                ? "base64"
+                : "utf8",
+            )
+        : undefined,
     };
     fs.writeFileSync(cacheFilePath, JSON.stringify(cacheFileContent));
   });