Update opennext and leverage "use cache" on CF (#3204)

Co-authored-by: Nicolas Dorseuil <nicolas@gitbook.io>
2026-09-23 02:53:29 +00:00 · 2025-05-16 13:58:35 +01:00
parent 3460b78b45
commit 2c85a302fc
8 changed files with 449 additions and 1019 deletions
@@ -145,6 +145,7 @@
      "dependencies": {
        "@gitbook/api": "^0.115.0",
        "@gitbook/cache-tags": "workspace:*",
+        "@opennextjs/cloudflare": "https://pkg.pr.new/@opennextjs/cloudflare@666",
        "@sindresorhus/fnv1a": "^3.1.0",
        "assert-never": "^1.2.1",
        "jwt-decode": "^4.0.0",
@@ -156,7 +157,6 @@
        "warn-once": "^0.1.1",
      },
      "devDependencies": {
-        "@opennextjs/cloudflare": "^1.0.0-beta.3",
        "@types/rison": "^0.0.9",
        "gitbook": "*",
        "postcss": "^8",
@@ -791,9 +791,9 @@

    "@nodelib/fs.walk": ["@nodelib/fs.walk@1.2.8", "", { "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" } }, "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg=="],

-    "@opennextjs/aws": ["@opennextjs/aws@3.5.7", "", { "dependencies": { "@ast-grep/napi": "^0.35.0", "@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", "@aws-sdk/client-sqs": "^3.398.0", "@node-minify/core": "^8.0.6", "@node-minify/terser": "^8.0.6", "@tsconfig/node18": "^1.0.1", "aws4fetch": "^1.0.18", "chalk": "^5.3.0", "esbuild": "0.19.2", "express": "5.0.1", "path-to-regexp": "^6.3.0", "urlpattern-polyfill": "^10.0.0", "yaml": "^2.7.0" }, "bin": { "open-next": "dist/index.js" } }, "sha512-YjyHJrkIHI7YwQRCp8GjDOudu86oOc1RiwxvBBpPHrplsS18H4ZmkzGggAKhK6B4myGsJQ/q9kNP2TraoZiNzg=="],
+    "@opennextjs/aws": ["@opennextjs/aws@3.6.1", "", { "dependencies": { "@ast-grep/napi": "^0.35.0", "@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", "@aws-sdk/client-sqs": "^3.398.0", "@node-minify/core": "^8.0.6", "@node-minify/terser": "^8.0.6", "@tsconfig/node18": "^1.0.1", "aws4fetch": "^1.0.18", "chalk": "^5.3.0", "esbuild": "0.19.2", "express": "5.0.1", "path-to-regexp": "^6.3.0", "urlpattern-polyfill": "^10.0.0", "yaml": "^2.7.0" }, "bin": { "open-next": "dist/index.js" } }, "sha512-RYU9K58vEUPXqc3pZO6kr9vBy1MmJZFQZLe0oXBskC005oGju/m4e3DCCP4eZ/Q/HdYQXCoqNXgSGi8VCAYgew=="],

-    "@opennextjs/cloudflare": ["@opennextjs/cloudflare@1.0.0-beta.3", "", { "dependencies": { "@dotenvx/dotenvx": "1.31.0", "@opennextjs/aws": "3.5.7", "enquirer": "^2.4.1", "glob": "^11.0.0", "ts-tqdm": "^0.8.6" }, "peerDependencies": { "wrangler": "^3.114.3 || ^4.7.0" }, "bin": { "opennextjs-cloudflare": "dist/cli/index.js" } }, "sha512-qKBXQZhUeQ+iGvfJeF7PO30g59LHnPOlRVZd77zxwn6Uc9C+c0LSwo8N28XRIWyQPkY007rKk9pSIxOrP4MHtQ=="],
+    "@opennextjs/cloudflare": ["@opennextjs/cloudflare@https://pkg.pr.new/@opennextjs/cloudflare@666", { "dependencies": { "@dotenvx/dotenvx": "1.31.0", "@opennextjs/aws": "^3.6.1", "enquirer": "^2.4.1", "glob": "^11.0.0", "ts-tqdm": "^0.8.6" }, "peerDependencies": { "wrangler": "^4.14.0" }, "bin": { "opennextjs-cloudflare": "dist/cli/index.js" } }],

    "@opentelemetry/api": ["@opentelemetry/api@1.9.0", "", {}, "sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg=="],

@@ -7,7 +7,7 @@
        "turbo": "^2.5.0",
        "vercel": "^39.3.0"
    },
-    "packageManager": "bun@1.2.8",
+    "packageManager": "bun@1.2.11",
    "overrides": {
        "@codemirror/state": "6.4.1",
        "@gitbook/api": "^0.115.0",
@@ -3,16 +3,27 @@ import r2IncrementalCache from '@opennextjs/cloudflare/overrides/incremental-cac
 import { withRegionalCache } from '@opennextjs/cloudflare/overrides/incremental-cache/regional-cache';
 import doQueue from '@opennextjs/cloudflare/overrides/queue/do-queue';
 import doShardedTagCache from '@opennextjs/cloudflare/overrides/tag-cache/do-sharded-tag-cache';
+import {
+    softTagFilter,
+    withFilter,
+} from '@opennextjs/cloudflare/overrides/tag-cache/tag-cache-filter';

 export default defineCloudflareConfig({
    incrementalCache: withRegionalCache(r2IncrementalCache, { mode: 'long-lived' }),
-    tagCache: doShardedTagCache({
-        baseShardSize: 12,
-        regionalCache: true,
-        shardReplication: {
-            numberOfSoftReplicas: 2,
-            numberOfHardReplicas: 1,
-        },
+    tagCache: withFilter({
+        tagCache: doShardedTagCache({
+            baseShardSize: 12,
+            regionalCache: true,
+            shardReplication: {
+                numberOfSoftReplicas: 2,
+                numberOfHardReplicas: 1,
+            },
+        }),
+        // We don't use `revalidatePath`, so we filter out soft tags
+        filterFn: softTagFilter,
    }),
    queue: doQueue,
+
+    // Performance improvements as we don't use PPR
+    enableCacheInterception: true,
 });
@@ -5,6 +5,7 @@
    "dependencies": {
        "@gitbook/api": "^0.115.0",
        "@gitbook/cache-tags": "workspace:*",
+        "@opennextjs/cloudflare": "https://pkg.pr.new/@opennextjs/cloudflare@666",
        "@sindresorhus/fnv1a": "^3.1.0",
        "assert-never": "^1.2.1",
        "jwt-decode": "^4.0.0",
@@ -17,7 +18,6 @@
    },
    "devDependencies": {
        "gitbook": "*",
-        "@opennextjs/cloudflare": "^1.0.0-beta.3",
        "@types/rison": "^0.0.9",
        "tailwindcss": "^3.4.0",
        "postcss": "^8"
@@ -2,7 +2,11 @@
    "main": ".open-next/worker.js",
    "name": "gitbook-open-v2",
    "compatibility_date": "2025-04-14",
-    "compatibility_flags": ["nodejs_compat", "allow_importable_env"],
+    "compatibility_flags": [
+        "nodejs_compat",
+        "allow_importable_env",
+        "global_fetch_strictly_public"
+    ],
    "assets": {
        "directory": ".open-next/assets",
        "binding": "ASSETS"
@@ -1,5 +1,4 @@
 import { parseOpenAPI } from '@gitbook/openapi-parser';
-import { unstable_cache } from 'next/cache';

 import { type CacheFunctionOptions, cache, noCacheFetchOptions } from '@/lib/cache';
 import type {
@@ -10,7 +9,6 @@ import type {
 } from '@/lib/openapi/types';
 import { getCloudflareRequestGlobal } from '@v2/lib/data/cloudflare';
 import { withCacheKey, withoutConcurrentExecution } from '@v2/lib/data/memoize';
-import { GITBOOK_RUNTIME } from '@v2/lib/env';
 import { assert } from 'ts-essentials';
 import { resolveContentRef } from '../references';
 import { isV2 } from '../v2';
@@ -71,18 +69,8 @@ const fetchFilesystemV1 = cache({
 });

 const fetchFilesystemV2 = withCacheKey(
-    withoutConcurrentExecution(getCloudflareRequestGlobal, async (cacheKey, url: string) => {
-        if (GITBOOK_RUNTIME !== 'cloudflare') {
-            return fetchFilesystemUseCache(url);
-        }
-
-        // FIXME: OpenNext doesn't support 'use cache' yet
-        const uncached = unstable_cache(async () => fetchFilesystemUncached(url), [cacheKey], {
-            revalidate: 60 * 60 * 24,
-        });
-
-        const response = await uncached();
-        return response;
+    withoutConcurrentExecution(getCloudflareRequestGlobal, async (_cacheKey, url: string) => {
+        return fetchFilesystemUseCache(url);
    })
 );

@@ -28,19 +28,19 @@ export async function trace<T>(
    };

    const start = now();
-    let failed = false;
+    let traceError: null | Error = null;
    try {
        return await fn(span);
    } catch (error) {
        span.setAttribute('error', true);
-        failed = true;
+        traceError = error as Error;
        throw error;
    } finally {
        if (process.env.SILENT !== 'true' && process.env.NODE_ENV !== 'development') {
            const end = now();
            // biome-ignore lint/suspicious/noConsole: we want to log performance data
            console.log(
-                `trace ${completeName} ${failed ? 'failed' : 'succeeded'} in ${end - start}ms`,
+                `trace ${completeName} ${traceError ? `failed with ${traceError.message}` : 'succeeded'} in ${end - start}ms`,
                attributes
            );
        }