Output a x-gitbook-route-type header to distinguish static/dynamic (#2938)

Author: SamyPesse

packages/gitbook-v2/src/app/~gitbook/env/route.ts

@@ -0,0 +1,26 @@
+import { type NextRequest, NextResponse } from 'next/server';
+
+import {
+    GITBOOK_API_URL,
+    GITBOOK_APP_URL,
+    GITBOOK_ASSETS_URL,
+    GITBOOK_DISABLE_TRACKING,
+    GITBOOK_INTEGRATIONS_HOST,
+    GITBOOK_URL,
+    GITBOOK_USER_AGENT,
+} from '@v2/lib/env';
+
+/**
+ * Output the public environment variables for this deployment
+ */
+export async function GET(_req: NextRequest) {
+    return NextResponse.json({
+        GITBOOK_URL,
+        GITBOOK_APP_URL,
+        GITBOOK_API_URL,
+        GITBOOK_ASSETS_URL,
+        GITBOOK_USER_AGENT,
+        GITBOOK_INTEGRATIONS_HOST,
+        GITBOOK_DISABLE_TRACKING,
+    });
+}

packages/gitbook-v2/src/lib/env/globals.ts

@@ -14,17 +14,17 @@ export const GITBOOK_URL =
 export const GITBOOK_ASSETS_URL =
     process.env.NODE_ENV === 'development'
         ? 'http://localhost:3000'
-        : (process.env.GITBOOK_ASSETS_PREFIX ?? GITBOOK_URL);
+        : process.env.GITBOOK_ASSETS_PREFIX || GITBOOK_URL;
 
 /**
  * GitBook app URL.
  */
-export const GITBOOK_APP_URL = process.env.NEXT_PUBLIC_GITBOOK_APP_URL ?? 'https://app.gitbook.com';
+export const GITBOOK_APP_URL = process.env.NEXT_PUBLIC_GITBOOK_APP_URL || 'https://app.gitbook.com';
 
 /**
  * Default GitBook API URL endpoint.
  */
-export const GITBOOK_API_URL = process.env.GITBOOK_API_URL ?? 'https://api.gitbook.com';
+export const GITBOOK_API_URL = process.env.GITBOOK_API_URL || 'https://api.gitbook.com';
 
 /**
  * Default GitBook API token.
@@ -35,7 +35,7 @@ export const GITBOOK_API_TOKEN = process.env.GITBOOK_API_TOKEN ?? null;
 /**
  * User agent to use for API requests.
  */
-export const GITBOOK_USER_AGENT = process.env.GITBOOK_USER_AGENT ?? 'GitBook-Open/2.0.0';
+export const GITBOOK_USER_AGENT = process.env.GITBOOK_USER_AGENT || 'GitBook-Open/2.0.0';
 
 /**
  * Whether to disable tracking of events into site insights.
@@ -49,7 +49,7 @@ export const GITBOOK_DISABLE_TRACKING = Boolean(
  * Hostname serving the integrations.
  */
 export const GITBOOK_INTEGRATIONS_HOST =
-    process.env.GITBOOK_INTEGRATIONS_HOST ?? 'integrations.gitbook.com';
+    process.env.GITBOOK_INTEGRATIONS_HOST || 'integrations.gitbook.com';
 
 /**
  * Endpoint to use for resizing images.

packages/gitbook-v2/src/middleware.ts

@@ -108,11 +108,13 @@ async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
     requestHeaders.set('x-forwarded-host', request.nextUrl.host);
     requestHeaders.set('origin', request.nextUrl.origin);
 
+    const siteURL = `${url.host}${data.basePath}`;
+
     const route = [
         'sites',
         routeType,
         mode,
-        encodeURIComponent(url.host + data.basePath),
+        encodeURIComponent(siteURL),
         encodePathInSiteContent(data.pathname),
     ].join('/');
 
@@ -131,6 +133,9 @@ async function serveSiteByURL(request: NextRequest, urlWithMode: URLWithMode) {
     response.headers.set('strict-transport-security', 'max-age=31536000');
     response.headers.set('referrer-policy', 'no-referrer-when-downgrade');
     response.headers.set('x-content-type-options', 'nosniff');
+    // Debug header
+    response.headers.set('x-gitbook-route-type', routeType);
+    response.headers.set('x-gitbook-site-url', siteURL);
 
     if (visitorToken) {
         const cookies = getResponseCookiesForVisitorAuth(data.basePath, visitorToken);