D1 next mode tag cache (#464)

conico974 · web-flow · commit acfc7f35a387 · 2025-03-19T13:36:55.000+01:00
* Simple D1 next mode tag cache

* add e2e tests

* don't crash on get

* changeset

* review

* fix broken lockfile
diff --git a/.changeset/ten-mice-clean.md b/.changeset/ten-mice-clean.md
@@ -0,0 +1,5 @@
+---
+"@opennextjs/cloudflare": patch
+---
+
+Implement next mode for d1 tag cache that will reduce write
diff --git a/examples/common/apps.ts b/examples/common/apps.ts
@@ -12,6 +12,8 @@ const apps = [
   "app-pages-router",
   "app-router",
   "pages-router",
+  // overrides
+  "d1-tag-next",
   // bugs
   "gh-119",
   "gh-219",
diff --git a/examples/common/config-e2e.ts b/examples/common/config-e2e.ts
@@ -13,6 +13,8 @@ export function configurePlaywright(
     isWorker = true,
     // Tests with multiple browsers
     multipleBrowsers = false,
+    // Whether to run tests in single file in parallel
+    parallel = true,
   } = {}
 ) {
   const port = getAppPort(app, { isWorker });
@@ -60,7 +62,7 @@ export function configurePlaywright(
     /* ignore runtime specific tests */
     testIgnore: isWorker ? "*next.spec.ts" : "*cloudflare.spec.ts",
     /* Run tests in files in parallel */
-    fullyParallel: true,
+    fullyParallel: parallel,
     /* Fail the build on CI if you accidentally left test.only in the source code. */
     forbidOnly: isCI,
     /* Retry on CI only */
diff --git a/examples/overrides/d1-tag-next/.gitignore b/examples/overrides/d1-tag-next/.gitignore
@@ -0,0 +1,47 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# env files (can opt-in for committing if needed)
+.env*
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+# playwright
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
diff --git a/examples/overrides/d1-tag-next/app/action.ts b/examples/overrides/d1-tag-next/app/action.ts
@@ -0,0 +1,11 @@
+"use server";
+
+import { revalidatePath, revalidateTag } from "next/cache";
+
+export async function revalidateTagAction() {
+  revalidateTag("date");
+}
+
+export async function revalidatePathAction() {
+  revalidatePath("/");
+}
diff --git a/examples/overrides/d1-tag-next/app/components/revalidationButtons.tsx b/examples/overrides/d1-tag-next/app/components/revalidationButtons.tsx
@@ -0,0 +1,27 @@
+"use client";
+
+import { revalidateTagAction, revalidatePathAction } from "../action";
+
+export default function RevalidationButtons() {
+  return (
+    <div>
+      <button
+        data-testid="revalidate-tag"
+        onClick={async () => {
+          await revalidateTagAction();
+        }}
+      >
+        Invalidate tag
+      </button>
+
+      <button
+        data-testid="revalidate-path"
+        onClick={async () => {
+          await revalidatePathAction();
+        }}
+      >
+        Invalidate Path
+      </button>
+    </div>
+  );
+}
diff --git a/examples/overrides/d1-tag-next/app/favicon.ico b/examples/overrides/d1-tag-next/app/favicon.ico
diff --git a/examples/overrides/d1-tag-next/app/globals.css b/examples/overrides/d1-tag-next/app/globals.css
@@ -0,0 +1,14 @@
+html,
+body {
+  max-width: 100vw;
+  overflow-x: hidden;
+  height: 100vh;
+  display: flex;
+  flex-direction: column;
+}
+
+footer {
+  padding: 1rem;
+  display: flex;
+  justify-content: end;
+}
diff --git a/examples/overrides/d1-tag-next/app/layout.tsx b/examples/overrides/d1-tag-next/app/layout.tsx
@@ -0,0 +1,28 @@
+import type { Metadata } from "next";
+import "./globals.css";
+
+import { getCloudflareContext } from "@opennextjs/cloudflare";
+
+export const metadata: Metadata = {
+  title: "SSG App",
+  description: "An app in which all the routes are SSG'd",
+};
+
+export default async function RootLayout({
+  children,
+}: Readonly<{
+  children: React.ReactNode;
+}>) {
+  const cloudflareContext = await getCloudflareContext({
+    async: true,
+  });
+
+  return (
+    <html lang="en">
+      <body>
+        {children}
+        <footer data-testid="app-version">{cloudflareContext.env.APP_VERSION}</footer>
+      </body>
+    </html>
+  );
+}
diff --git a/examples/overrides/d1-tag-next/app/page.module.css b/examples/overrides/d1-tag-next/app/page.module.css
@@ -0,0 +1,17 @@
+.page {
+  display: grid;
+  grid-template-rows: 20px 1fr 20px;
+  align-items: center;
+  justify-items: center;
+  flex: 1;
+  border: 3px solid gray;
+  margin: 1rem;
+  margin-block-end: 0;
+}
+
+.main {
+  display: flex;
+  flex-direction: column;
+  gap: 32px;
+  grid-row-start: 2;
+}
diff --git a/examples/overrides/d1-tag-next/app/page.tsx b/examples/overrides/d1-tag-next/app/page.tsx
@@ -0,0 +1,26 @@
+import { unstable_cache } from "next/cache";
+import styles from "./page.module.css";
+import RevalidationButtons from "./components/revalidationButtons";
+
+const fetchedDateCb = unstable_cache(
+  async () => {
+    return Date.now();
+  },
+  ["date"],
+  { tags: ["date"] }
+);
+
+export default async function Home() {
+  const fetchedDate = await fetchedDateCb();
+  return (
+    <div className={styles.page}>
+      <main className={styles.main}>
+        <h1>Hello from a Statically generated page</h1>
+        <p data-testid="date-local">{Date.now()}</p>
+        <p data-testid="date-fetched">{fetchedDate}</p>
+
+        <RevalidationButtons />
+      </main>
+    </div>
+  );
+}
diff --git a/examples/overrides/d1-tag-next/e2e/base.spec.ts b/examples/overrides/d1-tag-next/e2e/base.spec.ts
@@ -0,0 +1,47 @@
+import { test, expect } from "@playwright/test";
+
+test.describe("d1-tag-next", () => {
+  test("the index page should work", async ({ page }) => {
+    await page.goto("/");
+    await expect(page.getByText("Hello from a Statically generated page")).toBeVisible();
+  });
+
+  test("the index page should keep the same date on reload", async ({ page }) => {
+    await page.goto("/");
+    const date = await page.getByTestId("date-local").textContent();
+    expect(date).not.toBeNull();
+    await page.reload();
+    const newDate = await page.getByTestId("date-local").textContent();
+    expect(date).toEqual(newDate);
+  });
+
+  test("the index page should revalidate the date on click on revalidateTag", async ({ page }) => {
+    await page.goto("/");
+    const date = await page.getByTestId("date-fetched").textContent();
+    await page.getByTestId("revalidate-tag").click();
+    await page.waitForTimeout(100);
+    const newDate = await page.getByTestId("date-fetched").textContent();
+    expect(date).not.toEqual(newDate);
+  });
+
+  test("the index page should revalidate the date on click on revalidatePath", async ({ page }) => {
+    await page.goto("/");
+    const date = await page.getByTestId("date-fetched").textContent();
+    await page.getByTestId("revalidate-path").click();
+    await page.waitForTimeout(100);
+    const newDate = await page.getByTestId("date-fetched").textContent();
+    expect(date).not.toEqual(newDate);
+  });
+
+  test("the index page should keep the same date on reload after revalidation", async ({ page }) => {
+    await page.goto("/");
+    const initialDate = await page.getByTestId("date-fetched").textContent();
+    await page.getByTestId("revalidate-tag").click();
+    await page.waitForTimeout(100);
+    const date = await page.getByTestId("date-fetched").textContent();
+    expect(initialDate).not.toEqual(date);
+    await page.reload();
+    const newDate = await page.getByTestId("date-fetched").textContent();
+    expect(date).toEqual(newDate);
+  });
+});
diff --git a/examples/overrides/d1-tag-next/e2e/playwright.config.ts b/examples/overrides/d1-tag-next/e2e/playwright.config.ts
@@ -0,0 +1,4 @@
+import { configurePlaywright } from "../../../common/config-e2e";
+
+// Here we don't want to run the tests in parallel
+export default configurePlaywright("d1-tag-next", { isCI: !!process.env.CI, parallel: false });
diff --git a/examples/overrides/d1-tag-next/next.config.ts b/examples/overrides/d1-tag-next/next.config.ts
@@ -0,0 +1,11 @@
+import type { NextConfig } from "next";
+import { initOpenNextCloudflareForDev } from "@opennextjs/cloudflare";
+
+initOpenNextCloudflareForDev();
+
+const nextConfig: NextConfig = {
+  typescript: { ignoreBuildErrors: true },
+  eslint: { ignoreDuringBuilds: true },
+};
+
+export default nextConfig;
diff --git a/examples/overrides/d1-tag-next/open-next.config.ts b/examples/overrides/d1-tag-next/open-next.config.ts
@@ -0,0 +1,8 @@
+import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+import kvIncrementalCache from "@opennextjs/cloudflare/kv-cache";
+import d1NextTagCache from "@opennextjs/cloudflare/d1-next-tag-cache";
+
+export default defineCloudflareConfig({
+  incrementalCache: kvIncrementalCache,
+  tagCache: d1NextTagCache,
+});
diff --git a/examples/overrides/d1-tag-next/package.json b/examples/overrides/d1-tag-next/package.json
@@ -0,0 +1,30 @@
+{
+  "name": "d1-tag-next",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint",
+    "d1:clean": "wrangler d1 execute NEXT_CACHE_D1 --command \"DROP TABLE IF EXISTS revalidations\"",
+    "d1:setup": "wrangler d1 execute NEXT_CACHE_D1 --command \"CREATE TABLE IF NOT EXISTS revalidations (tag TEXT NOT NULL, revalidatedAt INTEGER NOT NULL, UNIQUE(tag) ON CONFLICT REPLACE);\"",
+    "build:worker": "opennextjs-cloudflare && pnpm d1:clean && pnpm d1:setup",
+    "preview": "pnpm build:worker && pnpm wrangler dev",
+    "e2e": "playwright test -c e2e/playwright.config.ts"
+  },
+  "dependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "next": "15.1.7"
+  },
+  "devDependencies": {
+    "@opennextjs/cloudflare": "workspace:*",
+    "@playwright/test": "catalog:",
+    "@types/node": "catalog:",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "typescript": "catalog:",
+    "wrangler": "catalog:"
+  }
+}
diff --git a/examples/overrides/d1-tag-next/tsconfig.json b/examples/overrides/d1-tag-next/tsconfig.json
@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "ES2017",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}
diff --git a/examples/overrides/d1-tag-next/wrangler.jsonc b/examples/overrides/d1-tag-next/wrangler.jsonc
@@ -0,0 +1,27 @@
+{
+  "$schema": "node_modules/wrangler/config-schema.json",
+  "main": ".open-next/worker.js",
+  "name": "ssg-app",
+  "compatibility_date": "2025-02-04",
+  "compatibility_flags": ["nodejs_compat"],
+  "assets": {
+    "directory": ".open-next/assets",
+    "binding": "ASSETS"
+  },
+  "vars": {
+    "APP_VERSION": "1.2.345"
+  },
+  "kv_namespaces": [
+    {
+      "binding": "NEXT_CACHE_WORKERS_KV",
+      "id": "<BINDING_ID>"
+    }
+  ],
+  "d1_databases": [
+    {
+      "binding": "NEXT_CACHE_D1",
+      "database_id": "NEXT_CACHE_D1",
+      "database_name": "NEXT_CACHE_D1"
+    }
+  ]
+}
diff --git a/packages/cloudflare/src/api/constants.ts b/packages/cloudflare/src/api/constants.ts
@@ -0,0 +1 @@
+export const DEFAULT_NEXT_CACHE_D1_REVALIDATIONS_TABLE = "revalidations";
diff --git a/packages/cloudflare/src/api/d1-next-tag-cache.ts b/packages/cloudflare/src/api/d1-next-tag-cache.ts
diff --git a/packages/cloudflare/src/api/d1-tag-cache.ts b/packages/cloudflare/src/api/d1-tag-cache.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@opennextjs/cloudflare": patch
 +---
++
 +Implement next mode for d1 tag cache that will reduce write