opennextjs · james-elicx · Apr 8, 2025 · Apr 7, 2025 · Apr 7, 2025 · Apr 7, 2025
diff --git a/.changeset/yellow-eyes-reflect.md b/.changeset/yellow-eyes-reflect.md
@@ -0,0 +1,5 @@
+---
+"@opennextjs/cloudflare": patch
+---
+
+feat: static assets incremental cache
diff --git a/examples/common/apps.ts b/examples/common/apps.ts
@@ -15,6 +15,7 @@ const apps = [
   "d1-tag-next",
   "memory-queue",
   "r2-incremental-cache",
+  "static-assets-incremental-cache",
   // bugs
   "gh-119",
   "gh-219",

diff --git a/examples/overrides/static-assets-incremental-cache/.gitignore b/examples/overrides/static-assets-incremental-cache/.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/static-assets-incremental-cache/app/action.ts b/examples/overrides/static-assets-incremental-cache/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/static-assets-incremental-cache/app/components/revalidationButtons.tsx b/examples/overrides/static-assets-incremental-cache/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/static-assets-incremental-cache/app/favicon.ico b/examples/overrides/static-assets-incremental-cache/app/favicon.ico
diff --git a/examples/overrides/static-assets-incremental-cache/app/globals.css b/examples/overrides/static-assets-incremental-cache/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/static-assets-incremental-cache/app/layout.tsx b/examples/overrides/static-assets-incremental-cache/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/static-assets-incremental-cache/app/page.module.css b/examples/overrides/static-assets-incremental-cache/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/static-assets-incremental-cache/app/page.tsx b/examples/overrides/static-assets-incremental-cache/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/static-assets-incremental-cache/e2e/base.spec.ts b/examples/overrides/static-assets-incremental-cache/e2e/base.spec.ts
@@ -0,0 +1,41 @@
+import { test, expect } from "@playwright/test";
+
+test.describe("static-assets-incremental-cache", () => {
+  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 keep the same data on reload when trying to use revalidateTag", async ({
+    page,
+  }) => {
+    await page.goto("/");
+    const date = await page.getByTestId("date-fetched").textContent();
+    await page.getByTestId("revalidate-tag").click();
+    await page.waitForTimeout(100);
+    await page.reload();
+    const newDate = await page.getByTestId("date-fetched").textContent();
+    expect(date).toEqual(newDate);
+  });
+
+  test("the index page should keep the same data on reload when trying to use revalidatePath", async ({
+    page,
+  }) => {
+    await page.goto("/");
+    const date = await page.getByTestId("date-fetched").textContent();
+    await page.getByTestId("revalidate-path").click();
+    await page.waitForTimeout(100);
+    await page.reload();
+    const newDate = await page.getByTestId("date-fetched").textContent();
+    expect(date).toEqual(newDate);
+  });
+});
diff --git a/examples/overrides/static-assets-incremental-cache/e2e/playwright.config.ts b/examples/overrides/static-assets-incremental-cache/e2e/playwright.config.ts
@@ -0,0 +1,7 @@
+import { configurePlaywright } from "../../../common/config-e2e";
+
+// Here we don't want to run the tests in parallel
+export default configurePlaywright("static-assets-incremental-cache", {
+  isCI: !!process.env.CI,
+  parallel: false,
+});
diff --git a/examples/overrides/static-assets-incremental-cache/next-env.d.ts b/examples/overrides/static-assets-incremental-cache/next-env.d.ts
@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.
diff --git a/examples/overrides/static-assets-incremental-cache/next.config.ts b/examples/overrides/static-assets-incremental-cache/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/static-assets-incremental-cache/open-next.config.ts b/examples/overrides/static-assets-incremental-cache/open-next.config.ts
@@ -0,0 +1,6 @@
+import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+import staticAssetsIncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/static-assets-incremental-cache";
+
+export default defineCloudflareConfig({
+  incrementalCache: staticAssetsIncrementalCache,
+});
diff --git a/examples/overrides/static-assets-incremental-cache/package.json b/examples/overrides/static-assets-incremental-cache/package.json
@@ -0,0 +1,29 @@
+{
+  "name": "static-assets-incremental-cache",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint",
+    "build:worker": "pnpm opennextjs-cloudflare build",
+    "preview:worker": "pnpm opennextjs-cloudflare preview",
+    "preview": "pnpm build:worker && pnpm preview:worker",
+    "e2e": "playwright test -c e2e/playwright.config.ts"
+  },
+  "dependencies": {
+    "react": "catalog:e2e",
+    "react-dom": "catalog:e2e",
+    "next": "catalog:e2e"
+  },
+  "devDependencies": {
+    "@opennextjs/cloudflare": "workspace:*",
+    "@playwright/test": "catalog:",
+    "@types/node": "catalog:",
+    "@types/react": "catalog:e2e",
+    "@types/react-dom": "catalog:e2e",
+    "typescript": "catalog:",
+    "wrangler": "catalog:"
+  }
+}
diff --git a/examples/overrides/static-assets-incremental-cache/tsconfig.json b/examples/overrides/static-assets-incremental-cache/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/static-assets-incremental-cache/wrangler.jsonc b/examples/overrides/static-assets-incremental-cache/wrangler.jsonc
@@ -0,0 +1,17 @@
+{
+  "$schema": "node_modules/wrangler/config-schema.json",
+  "main": ".open-next/worker.js",
+  "name": "static-assets-incremental-cache",
+  "compatibility_date": "2025-02-04",
+  "compatibility_flags": ["nodejs_compat"],
+  "assets": {
+    "directory": ".open-next/assets",
+    "binding": "ASSETS"
+  },
+  "services": [
+    {
+      "binding": "WORKER_SELF_REFERENCE",
+      "service": "static-assets-incremental-cache"
+    }
+  ]
+}
diff --git a/examples/ssg-app/open-next.config.ts b/examples/ssg-app/open-next.config.ts
@@ -1,6 +1,6 @@
 import { defineCloudflareConfig } from "@opennextjs/cloudflare";
-import kvIncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/kv-incremental-cache";
+import staticAssetsIncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/static-assets-incremental-cache";
 
 export default defineCloudflareConfig({
-  incrementalCache: kvIncrementalCache,
+  incrementalCache: staticAssetsIncrementalCache,
 });
diff --git a/examples/ssg-app/wrangler.jsonc b/examples/ssg-app/wrangler.jsonc
@@ -8,12 +8,6 @@
     "directory": ".open-next/assets",
     "binding": "ASSETS"
   },
-  "kv_namespaces": [
-    {
-      "binding": "NEXT_INC_CACHE_KV",
-      "id": "<BINDING_ID>"
-    }
-  ],
   "vars": {
     "APP_VERSION": "1.2.345"
   }