Feat Automatic cdn invalidation (#665)

conico974 · web-flow · commit ae7fb9c5d24e · 2025-01-17T15:49:30.000+01:00
* basic implementation

* install and biome fix

* cloudfront implementation

* review fix

* fix &amp; comment

* update to use initialPath when needed

* fix build

* fix linting

* changeset

* review fix
diff --git a/.changeset/thin-feet-love.md b/.changeset/thin-feet-love.md
@@ -0,0 +1,5 @@
+---
+"@opennextjs/aws": minor
+---
+
+Add an override to automatically invalidate the CDN (not enabled by default)
diff --git a/packages/open-next/package.json b/packages/open-next/package.json
@@ -34,6 +34,7 @@
     "README.md"
   ],
   "dependencies": {
+    "@aws-sdk/client-cloudfront": "3.398.0",
     "@aws-sdk/client-dynamodb": "^3.398.0",
     "@aws-sdk/client-lambda": "^3.398.0",
     "@aws-sdk/client-s3": "^3.398.0",
diff --git a/packages/open-next/src/adapters/cache.ts b/packages/open-next/src/adapters/cache.ts
@@ -433,6 +433,32 @@ export default class Cache {
 
         // Update all keys with the given tag with revalidatedAt set to now
         await globalThis.tagCache.writeTags(toInsert);
+
+        // We can now invalidate all paths in the CDN
+        // This only applies to `revalidateTag`, not to `res.revalidate()`
+        const uniquePaths = Array.from(
+          new Set(
+            toInsert
+              // We need to filter fetch cache key as they are not in the CDN
+              .filter((t) => t.tag.startsWith("_N_T_/"))
+              .map((t) => `/${t.path}`),
+          ),
+        );
+        if (uniquePaths.length > 0) {
+          await globalThis.cdnInvalidationHandler.invalidatePaths(
+            uniquePaths.map((path) => ({
+              initialPath: path,
+              rawPath: path,
+              resolvedRoutes: [
+                {
+                  route: path,
+                  // TODO: ideally here we should check if it's an app router page or route
+                  type: "app",
+                },
+              ],
+            })),
+          );
+        }
       }
     } catch (e) {
       error("Failed to revalidate tag", e);
diff --git a/packages/open-next/src/core/createMainHandler.ts b/packages/open-next/src/core/createMainHandler.ts
@@ -4,6 +4,7 @@ import { debug } from "../adapters/logger";
 import { generateUniqueId } from "../adapters/util";
 import { openNextHandler } from "./requestHandler";
 import {
+  resolveCdnInvalidation,
   resolveConverter,
   resolveIncrementalCache,
   resolveProxyRequest,
@@ -38,6 +39,10 @@ export async function createMainHandler() {
     thisFunction.override?.proxyExternalRequest,
   );
 
+  globalThis.cdnInvalidationHandler = await resolveCdnInvalidation(
+    thisFunction.override?.cdnInvalidation,
+  );
+
   globalThis.lastModified = {};
 
   // From the config, we create the converter
diff --git a/packages/open-next/src/core/requestHandler.ts b/packages/open-next/src/core/requestHandler.ts
@@ -118,7 +118,14 @@ export async function openNextHandler(
         // response is used only in the streaming case
         if (responseStreaming) {
           const response = createServerResponse(
-            internalEvent,
+            {
+              internalEvent,
+              isExternalRewrite: false,
+              isISR: false,
+              resolvedRoutes: [],
+              origin: false,
+              initialPath: internalEvent.rawPath,
+            },
             headers,
             responseStreaming,
           );
@@ -162,7 +169,7 @@ export async function openNextHandler(
 
       const req = new IncomingMessage(reqProps);
       const res = createServerResponse(
-        preprocessedEvent,
+        routingResult,
         overwrittenResponseHeaders,
         responseStreaming,
       );
diff --git a/packages/open-next/src/core/resolve.ts b/packages/open-next/src/core/resolve.ts
@@ -141,3 +141,16 @@ export async function resolveProxyRequest(
   const m_1 = await import("../overrides/proxyExternalRequest/node.js");
   return m_1.default;
 }
+
+/**
+ * @__PURE__
+ */
+export async function resolveCdnInvalidation(
+  cdnInvalidation: OverrideOptions["cdnInvalidation"],
+) {
+  if (typeof cdnInvalidation === "function") {
+    return cdnInvalidation();
+  }
+  const m_1 = await import("../overrides/cdnInvalidation/dummy.js");
+  return m_1.default;
+}
diff --git a/packages/open-next/src/core/routing/util.ts b/packages/open-next/src/core/routing/util.ts
@@ -10,6 +10,7 @@ import type { MiddlewareManifest } from "types/next-types";
 import type {
   InternalEvent,
   InternalResult,
+  RoutingResult,
   StreamCreator,
 } from "types/open-next.js";
 
@@ -403,10 +404,11 @@ export function fixISRHeaders(headers: OutgoingHttpHeaders) {
  * @__PURE__
  */
 export function createServerResponse(
-  internalEvent: InternalEvent,
+  routingResult: RoutingResult,
   headers: Record<string, string | string[] | undefined>,
   responseStream?: StreamCreator,
 ) {
+  const internalEvent = routingResult.internalEvent;
   return new OpenNextNodeResponse(
     (_headers) => {
       fixCacheHeaderForHtmlPages(internalEvent, _headers);
@@ -420,8 +422,30 @@ export function createServerResponse(
         internalEvent.rawPath,
         _headers,
       );
+      await invalidateCDNOnRequest(routingResult, _headers);
     },
     responseStream,
     headers,
   );
 }
+
+// This function is used only for `res.revalidate()`
+export async function invalidateCDNOnRequest(
+  params: RoutingResult,
+  headers: OutgoingHttpHeaders,
+) {
+  const { internalEvent, initialPath, resolvedRoutes } = params;
+  const isIsrRevalidation = internalEvent.headers["x-isr"] === "1";
+  if (
+    !isIsrRevalidation &&
+    headers[CommonHeaders.NEXT_CACHE] === "REVALIDATED"
+  ) {
+    await globalThis.cdnInvalidationHandler.invalidatePaths([
+      {
+        initialPath,
+        rawPath: internalEvent.rawPath,
+        resolvedRoutes,
+      },
+    ]);
+  }
+}
diff --git a/packages/open-next/src/overrides/cdnInvalidation/cloudfront.ts b/packages/open-next/src/overrides/cdnInvalidation/cloudfront.ts
@@ -0,0 +1,37 @@
+import {
+  CloudFrontClient,
+  CreateInvalidationCommand,
+} from "@aws-sdk/client-cloudfront";
+import type { CDNInvalidationHandler } from "types/overrides";
+
+const cloudfront = new CloudFrontClient({});
+export default {
+  name: "cloudfront",
+  invalidatePaths: async (paths) => {
+    const constructedPaths = paths.flatMap(
+      ({ initialPath, resolvedRoutes }) => {
+        const isAppRouter = resolvedRoutes.some(
+          (route) => route.type === "app",
+        );
+        // revalidateTag doesn't have any leading slash, remove it just to be sure
+        const path = initialPath.replace(/^\//, "");
+        return isAppRouter
+          ? [`/${path}`, `/${path}?_rsc=*`]
+          : [
+              `/${path}`,
+              `/_next/data/${process.env.NEXT_BUILD_ID}${path === "/" ? "/index" : `/${path}`}.json*`,
+            ];
+      },
+    );
+    await cloudfront.send(
+      new CreateInvalidationCommand({
+        DistributionId: process.env.CLOUDFRONT_DISTRIBUTION_ID!,
+        InvalidationBatch: {
+          // Do we need to limit the number of paths? Or batch them into multiple commands?
+          Paths: { Quantity: constructedPaths.length, Items: constructedPaths },
+          CallerReference: `${Date.now()}`,
+        },
+      }),
+    );
+  },
+} satisfies CDNInvalidationHandler;
diff --git a/packages/open-next/src/overrides/cdnInvalidation/dummy.ts b/packages/open-next/src/overrides/cdnInvalidation/dummy.ts
@@ -0,0 +1,8 @@
+import type { CDNInvalidationHandler } from "types/overrides";
+
+export default {
+  name: "dummy",
+  invalidatePaths: (_) => {
+    return Promise.resolve();
+  },
+} satisfies CDNInvalidationHandler;
diff --git a/packages/open-next/src/plugins/resolve.ts b/packages/open-next/src/plugins/resolve.ts
@@ -28,6 +28,7 @@ export interface IPluginSettings {
       | IncludedOriginResolver;
     warmer?: LazyLoadedOverride<Warmer> | IncludedWarmer;
     proxyExternalRequest?: OverrideOptions["proxyExternalRequest"];
+    cdnInvalidation?: OverrideOptions["cdnInvalidation"];
   };
   fnName?: string;
 }
@@ -53,6 +54,7 @@ const nameToFolder = {
   originResolver: "originResolver",
   warmer: "warmer",
   proxyExternalRequest: "proxyExternalRequest",
+  cdnInvalidation: "cdnInvalidation",
 };
 
 const defaultOverrides = {
@@ -65,6 +67,7 @@ const defaultOverrides = {
   originResolver: "pattern-env",
   warmer: "aws-lambda",
   proxyExternalRequest: "node",
+  cdnInvalidation: "dummy",
 };
 
 /**
diff --git a/packages/open-next/src/types/global.ts b/packages/open-next/src/types/global.ts
@@ -2,6 +2,7 @@ import type { AsyncLocalStorage } from "node:async_hooks";
 import type { OutgoingHttpHeaders } from "node:http";
 
 import type {
+  CDNInvalidationHandler,
   IncrementalCache,
   ProxyExternalRequest,
   Queue,
@@ -206,4 +207,11 @@ declare global {
    * Defined in `createMainHandler`.
    */
   var proxyExternalRequest: ProxyExternalRequest;
+
+  /**
+   * The function that will be called when the CDN needs invalidating (either from `revalidateTag` or from `res.revalidate`)
+   * Available in main functions
+   * Defined in `createMainHandler`
+   */
+  var cdnInvalidationHandler: CDNInvalidationHandler;
 }
diff --git a/packages/open-next/src/types/open-next.ts b/packages/open-next/src/types/open-next.ts
@@ -3,6 +3,7 @@ import type { ReadableStream } from "node:stream/web";
 import type { Writable } from "node:stream";
 import type { WarmerEvent, WarmerResponse } from "../adapters/warmer-function";
 import type {
+  CDNInvalidationHandler,
   Converter,
   ImageLoader,
   IncrementalCache,
@@ -157,6 +158,8 @@ export type IncludedWarmer = "aws-lambda" | "dummy";
 
 export type IncludedProxyExternalRequest = "node" | "fetch" | "dummy";
 
+export type IncludedCDNInvalidationHandler = "cloudfront" | "dummy";
+
 export interface DefaultOverrideOptions<
   E extends BaseEventOrResult = InternalEvent,
   R extends BaseEventOrResult = InternalResult,
@@ -208,6 +211,14 @@ export interface OverrideOptions extends DefaultOverrideOptions {
   proxyExternalRequest?:
     | IncludedProxyExternalRequest
     | LazyLoadedOverride<ProxyExternalRequest>;
+
+  /**
+   * Add possibility to override the default cdn invalidation for On Demand Revalidation
+   * @default "dummy"
+   */
+  cdnInvalidation?:
+    | IncludedCDNInvalidationHandler
+    | LazyLoadedOverride<CDNInvalidationHandler>;
 }
 
 export interface InstallOptions {
diff --git a/packages/open-next/src/types/overrides.ts b/packages/open-next/src/types/overrides.ts
@@ -8,6 +8,7 @@ import type {
   InternalEvent,
   InternalResult,
   Origin,
+  ResolvedRoute,
   StreamCreator,
 } from "./open-next";
 
@@ -139,3 +140,13 @@ export type OriginResolver = BaseOverride & {
 export type ProxyExternalRequest = BaseOverride & {
   proxy: (event: InternalEvent) => Promise<InternalResult>;
 };
+
+type CDNPath = {
+  initialPath: string;
+  rawPath: string;
+  resolvedRoutes: ResolvedRoute[];
+};
+
+export type CDNInvalidationHandler = BaseOverride & {
+  invalidatePaths: (paths: CDNPath[]) => Promise<void>;
+};
diff --git a/packages/tests-unit/tests/adapters/cache.test.ts b/packages/tests-unit/tests/adapters/cache.test.ts
@@ -4,6 +4,7 @@ import { vi } from "vitest";
 
 declare global {
   var disableIncrementalCache: boolean;
+  var disableDynamoDBCache: boolean;
   var isNextAfter15: boolean;
 }
 
@@ -39,6 +40,12 @@ describe("CacheHandler", () => {
   };
   globalThis.tagCache = tagCache;
 
+  const invalidateCdnHandler = {
+    name: "mock",
+    invalidatePaths: vi.fn(),
+  };
+  globalThis.cdnInvalidationHandler = invalidateCdnHandler;
+
   globalThis.__openNextAls = {
     getStore: vi.fn().mockReturnValue({
       requestId: "123",
@@ -470,4 +477,72 @@ describe("CacheHandler", () => {
       ).not.toThrow();
     });
   });
+
+  describe("revalidateTag", () => {
+    beforeEach(() => {
+      globalThis.disableDynamoDBCache = false;
+      globalThis.disableIncrementalCache = false;
+    });
+    it("Should do nothing if disableIncrementalCache is true", async () => {
+      globalThis.disableIncrementalCache = true;
+
+      await cache.revalidateTag("tag");
+
+      expect(tagCache.writeTags).not.toHaveBeenCalled();
+    });
+
+    it("Should do nothing if disableTagCache is true", async () => {
+      globalThis.disableDynamoDBCache = true;
+
+      await cache.revalidateTag("tag");
+
+      expect(tagCache.writeTags).not.toHaveBeenCalled();
+    });
+
+    it("Should call tagCache.writeTags", async () => {
+      globalThis.tagCache.getByTag.mockResolvedValueOnce(["/path"]);
+      await cache.revalidateTag("tag");
+
+      expect(globalThis.tagCache.getByTag).toHaveBeenCalledWith("tag");
+
+      expect(tagCache.writeTags).toHaveBeenCalledTimes(1);
+      expect(tagCache.writeTags).toHaveBeenCalledWith([
+        {
+          path: "/path",
+          tag: "tag",
+        },
+      ]);
+    });
+
+    it("Should call invalidateCdnHandler.invalidatePaths", async () => {
+      globalThis.tagCache.getByTag.mockResolvedValueOnce(["/path"]);
+      globalThis.tagCache.getByPath.mockResolvedValueOnce([]);
+      await cache.revalidateTag("_N_T_/path");
+
+      expect(tagCache.writeTags).toHaveBeenCalledTimes(1);
+      expect(tagCache.writeTags).toHaveBeenCalledWith([
+        {
+          path: "/path",
+          tag: "_N_T_/path",
+        },
+      ]);
+
+      expect(invalidateCdnHandler.invalidatePaths).toHaveBeenCalled();
+    });
+
+    it("Should not call invalidateCdnHandler.invalidatePaths for fetch cache key ", async () => {
+      globalThis.tagCache.getByTag.mockResolvedValueOnce(["123456"]);
+      await cache.revalidateTag("tag");
+
+      expect(tagCache.writeTags).toHaveBeenCalledTimes(1);
+      expect(tagCache.writeTags).toHaveBeenCalledWith([
+        {
+          path: "123456",
+          tag: "tag",
+        },
+      ]);
+
+      expect(invalidateCdnHandler.invalidatePaths).not.toHaveBeenCalled();
+    });
+  });
 });
diff --git a/packages/tests-unit/tests/core/routing/util.test.ts b/packages/tests-unit/tests/core/routing/util.test.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@opennextjs/aws": minor
 +---
++
 +Add an override to automatically invalidate the CDN (not enabled by default)