review fix

Author: Nicolas Dorseuil

.changeset/slow-walls-allow.md

@@ -2,4 +2,6 @@
 "@opennextjs/aws": minor
 ---
 
-Add an option to keep the data cache persistent between deployments
+Add an option to keep the data cache persistent between deployments.
+
+BREAKING CHANGE: Incremental cache keys are now an object of type `CacheKey` instead of a string. The new type includes properties like `baseKey`, `buildId`, and `cacheType`. Build_id is automatically provided according to the cache type and the `dangerous.persistentDataCache` option. Up to the Incremental Cache implementation to use it as they see fit.

packages/open-next/src/adapters/cache.ts

@@ -55,8 +55,7 @@ export default class Cache {
 
     const softTags = typeof options === "object" ? options.softTags : [];
     const tags = typeof options === "object" ? options.tags : [];
-    const isDataCache = isFetchCache(options);
-    return isDataCache
+    return isFetchCache(options)
       ? this.getFetchCache(baseKey, softTags, tags)
       : this.getIncrementalCache(baseKey);
   }

packages/open-next/src/adapters/composable-cache.ts

@@ -2,7 +2,7 @@ import type { ComposableCacheEntry, ComposableCacheHandler } from "types/cache";
 import type { CacheKey } from "types/overrides";
 import { writeTags } from "utils/cache";
 import { fromReadableStream, toReadableStream } from "utils/stream";
-import { debug } from "./logger";
+import { debug, warn } from "./logger";
 
 const pendingWritePromiseMap = new Map<string, Promise<ComposableCacheEntry>>();
 /**
@@ -22,7 +22,7 @@ function getComposableCacheKey(key: string): CacheKey<"composable"> {
       baseKey: JSON.stringify(rest),
     } as CacheKey<"composable">;
   } catch (e) {
-    debug("Error while parsing composable cache key", e);
+    warn("Error while parsing composable cache key", e);
     // If we fail to parse the key, we just return it as is
     // This is not ideal, but we don't want to crash the application
     return {

packages/open-next/src/overrides/incrementalCache/s3-lite.ts

@@ -33,9 +33,8 @@ const awsFetch = async (key: string, options: RequestInit) => {
 };
 
 function buildS3Key(key: CacheKey) {
-  const { CACHE_BUCKET_KEY_PREFIX } = process.env;
   return path.posix.join(
-    CACHE_BUCKET_KEY_PREFIX ?? "",
+    process.env.CACHE_BUCKET_KEY_PREFIX ?? "",
     key.cacheType === "fetch" ? "__fetch" : "",
     key.cacheType === "fetch"
       ? key.baseKey

packages/open-next/src/types/overrides.ts

@@ -117,6 +117,10 @@ export type CacheValue<CacheType extends CacheEntryType> =
 export type CacheKey<CacheType extends CacheEntryType = CacheEntryType> = {
   cacheType: CacheType;
   buildId: CacheType extends "cache" ? string : string | undefined;
+  /**
+   * The base key is the main identifier for the cache entry.
+   * It never depends on the build ID, and is used to identify the cache entry.
+   */
   baseKey: string;
 };