changeset and lint

Author: conico974

.changeset/neat-hornets-call.md

@@ -0,0 +1,5 @@
+---
+"@opennextjs/cloudflare": patch
+---
+
+Add a new `withFilter` tag cache to allow to filter the tag cache used

packages/cloudflare/src/api/overrides/tag-cache/tag-cache-filter.spec.ts

@@ -1,7 +1,7 @@
 import { NextModeTagCache } from "@opennextjs/aws/types/overrides";
-import {beforeEach, describe, expect, it, vi } from "vitest";
+import { beforeEach, describe, expect, it, vi } from "vitest";
 
-import { softTagFilter,withFilter } from "./tag-cache-filter";
+import { softTagFilter, withFilter } from "./tag-cache-filter";
 
 const mockedTagCache = {
   name: "mocked",
@@ -28,17 +28,17 @@ describe("withFilter", () => {
 
     await tagCache.writeTags(tags);
     expect(mockedTagCache.writeTags).toHaveBeenCalledWith(["valid_tag"]);
-  })
+  });
 
-  it('should not call writeTags if no tags are valid', async () => {
+  it("should not call writeTags if no tags are valid", async () => {
     const tagCache = withFilter({
       originalTagCache: mockedTagCache,
       filterFn,
     });
     const tags = ["invalid_tag"];
     await tagCache.writeTags(tags);
     expect(mockedTagCache.writeTags).not.toHaveBeenCalled();
-  })
+  });
 
   it("should filter out tags based on hasBeenRevalidated", async () => {
     const tagCache = withFilter({
@@ -51,10 +51,9 @@ describe("withFilter", () => {
 
     await tagCache.hasBeenRevalidated(tags, lastModified);
     expect(mockedTagCache.hasBeenRevalidated).toHaveBeenCalledWith(["valid_tag"], lastModified);
-  }
-  )
+  });
 
-  it('should not call hasBeenRevalidated if no tags are valid', async () => {
+  it("should not call hasBeenRevalidated if no tags are valid", async () => {
     const tagCache = withFilter({
       originalTagCache: mockedTagCache,
       filterFn,
@@ -63,7 +62,7 @@ describe("withFilter", () => {
     const lastModified = Date.now();
     await tagCache.hasBeenRevalidated(tags, lastModified);
     expect(mockedTagCache.hasBeenRevalidated).not.toHaveBeenCalled();
-  })
+  });
 
   it("should filter out tags based on getPathsByTags", async () => {
     const tagCache = withFilter({
@@ -75,28 +74,26 @@ describe("withFilter", () => {
 
     await tagCache.getPathsByTags?.(tags);
     expect(mockedTagCache.getPathsByTags).toHaveBeenCalledWith(["valid_tag"]);
-  }
-  )
+  });
 
-  it('should not call getPathsByTags if no tags are valid', async () => {
+  it("should not call getPathsByTags if no tags are valid", async () => {
     const tagCache = withFilter({
       originalTagCache: mockedTagCache,
       filterFn,
     });
     const tags = ["invalid_tag"];
     await tagCache.getPathsByTags?.(tags);
     expect(mockedTagCache.getPathsByTags).not.toHaveBeenCalled();
-  })
+  });
 
-  it('should return the correct name', () => {
+  it("should return the correct name", () => {
     const tagCache = withFilter({
       originalTagCache: mockedTagCache,
       filterFn,
     });
 
-    expect(tagCache.name).toBe('filtered-mocked');
-  }
-  )
+    expect(tagCache.name).toBe("filtered-mocked");
+  });
 
   it("should not create a function if getPathsByTags is not defined", async () => {
     const tagCache = withFilter({
@@ -108,8 +105,7 @@ describe("withFilter", () => {
     });
 
     expect(tagCache.getPathsByTags).toBeUndefined();
-  }
-  )
+  });
 
   it("should properly filter soft tags", () => {
     const tagCache = withFilter({
@@ -119,5 +115,5 @@ describe("withFilter", () => {
 
     tagCache.writeTags(["valid_tag", "_N_T_/", "_N_T_/test", "_N_T_/layout"]);
     expect(mockedTagCache.writeTags).toHaveBeenCalledWith(["valid_tag"]);
-  })
-});
+  });
+});

packages/cloudflare/src/api/overrides/tag-cache/tag-cache-filter.ts

@@ -18,20 +18,19 @@ interface WithFilterOptions {
  * Creates a new tag cache that filters tags based on the provided filter function.
  * This is usefult to remove tags that are not used by the app, this could reduce the number of request to the underlying tag cache.
  */
-export function withFilter({
-  originalTagCache,
-  filterFn,
-}: WithFilterOptions): NextModeTagCache {
+export function withFilter({ originalTagCache, filterFn }: WithFilterOptions): NextModeTagCache {
   return {
     name: `filtered-${originalTagCache.name}`,
     mode: "nextMode",
-    getPathsByTags: originalTagCache.getPathsByTags ? async (tags) => {
-      const filteredTags = tags.filter(filterFn);
-      if (filteredTags.length === 0) {
-        return [];
-      }
-      return originalTagCache.getPathsByTags!(filteredTags)
-    } : undefined,
+    getPathsByTags: originalTagCache.getPathsByTags
+      ? async (tags) => {
+          const filteredTags = tags.filter(filterFn);
+          if (filteredTags.length === 0) {
+            return [];
+          }
+          return originalTagCache.getPathsByTags!(filteredTags);
+        }
+      : undefined,
     hasBeenRevalidated: async (tags, lastModified) => {
       const filteredTags = tags.filter(filterFn);
       if (filteredTags.length === 0) {
@@ -45,7 +44,7 @@ export function withFilter({
         return;
       }
       return originalTagCache.writeTags(filteredTags);
-    }, 
+    },
   };
 }
 
@@ -56,4 +55,4 @@ export function withFilter({
  */
 export function softTagFilter(tag: string): boolean {
   return !tag.startsWith("_N_T_");
-}
+}