Better debugging of GitBook v1s revalidate endpoint. (#3097)

Author: emmerich

.changeset/old-rats-guess.md

@@ -0,0 +1,5 @@
+---
+"gitbook": patch
+---
+
+Improve the error message returned by the revalidate endpoint.

packages/gitbook/src/app/(global)/~gitbook/revalidate/route.ts

@@ -14,7 +14,15 @@ interface JsonBody {
  * The body should be a JSON with { tags: string[] }
  */
 export async function POST(req: NextRequest) {
-    const json = (await req.json()) as JsonBody;
+    let json: JsonBody;
+
+    try {
+        json = await req.json();
+    } catch (err) {
+        return NextResponse.json({
+            error: `invalid json body: ${err}`,
+        });
+    }
 
     if (!json.tags || !Array.isArray(json.tags)) {
         return NextResponse.json(
@@ -32,16 +40,12 @@ export async function POST(req: NextRequest) {
             stats: result.stats,
         });
     } catch (err: unknown) {
-        const message = [
-            err instanceof Error ? err.name : 'Internal Server Error',
-            ...(err instanceof Error && err.message ? [err.message] : []),
-            ...(err instanceof Error && err.cause ? [err.cause] : []),
-            ...(err instanceof Error && err.stack ? [err.stack] : []),
-        ].join('\n');
-
-        return new NextResponse(null, {
-            status: 500,
-            statusText: message,
-        });
+        return NextResponse.json(
+            {
+                error: `unexpected error ${err}`,
+                stack: err instanceof Error ? err.stack : null,
+            },
+            { status: 500 }
+        );
     }
 }

packages/gitbook/src/lib/cache/revalidateTags.ts

@@ -36,18 +36,25 @@ export async function revalidateTags(tags: string[]): Promise<{
 
     await Promise.all(
         cacheBackends.map(async (backend, backendIndex) => {
-            const { entries: addedEntries } = await backend.revalidateTags(tags);
+            try {
+                const { entries: addedEntries } = await backend.revalidateTags(tags);
 
-            addedEntries.forEach(({ key, tag }) => {
-                stats[key] = stats[key] ?? {
-                    tag,
-                    backends: {},
-                };
-                stats[key].backends[backend.name] = { set: true };
+                addedEntries.forEach(({ key, tag }) => {
+                    stats[key] = stats[key] ?? {
+                        tag,
+                        backends: {},
+                    };
+                    stats[key].backends[backend.name] = { set: true };
 
-                entries.set(key, { tag, key });
-                keysByBackend.set(backendIndex, [...(keysByBackend.get(backendIndex) ?? []), key]);
-            });
+                    entries.set(key, { tag, key });
+                    keysByBackend.set(backendIndex, [
+                        ...(keysByBackend.get(backendIndex) ?? []),
+                        key,
+                    ]);
+                });
+            } catch (err) {
+                throw new Error(`error revalidating tags on backend ${backend.name}: ${err}`);
+            }
         })
     );
 
@@ -71,7 +78,8 @@ export async function revalidateTags(tags: string[]): Promise<{
                             return;
                         }
                     }
-                    throw error;
+
+                    throw new Error(`error deleting entries on backend ${backend.name}: ${error}`);
                 }
             }
         })