Investigate issue where icons and ogimage would occasionally fail. (#3099)

Author: emmerich

packages/gitbook-v2/src/lib/links.ts

@@ -72,6 +72,17 @@ export function createLinker(
 
     const siteBasePath = withTrailingSlash(withLeadingSlash(servedOn.siteBasePath));
     const spaceBasePath = withTrailingSlash(withLeadingSlash(servedOn.spaceBasePath));
+    const protocol = (() => {
+        if (servedOn.protocol) {
+            return servedOn.protocol;
+        }
+
+        if (servedOn.host) {
+            return servedOn.host.startsWith('localhost') ? 'http:' : 'https:';
+        }
+
+        return 'https:';
+    })();
 
     const linker: GitBookLinker = {
         toPathInSpace(relativePath: string): string {
@@ -97,7 +108,7 @@ export function createLinker(
                 return absolutePath;
             }
 
-            return `${servedOn.protocol ?? 'https:'}//${joinPaths(servedOn.host, absolutePath)}`;
+            return `${protocol}//${joinPaths(servedOn.host, absolutePath)}`;
         },
 
         toPathForPage({ pages, page, anchor }) {

packages/gitbook/src/app/middleware/(site)/(core)/~gitbook/icon/route.tsx

@@ -7,8 +7,21 @@ import { serveIcon } from '@/routes/icon';
 export const runtime = 'edge';
 
 export async function GET(req: NextRequest) {
-    const pointer = await getSiteContentPointer();
-    const context = await fetchV1ContextForSitePointer(pointer);
+    try {
+        console.log('icon: getSiteContentPointer');
+        const pointer = await getSiteContentPointer();
+        console.log('icon: fetchV1context');
+        const context = await fetchV1ContextForSitePointer(pointer);
 
-    return serveIcon(context, req);
+        // biome-ignore lint/suspicious/noConsole: we want to log here
+        console.log(`serving icon for ${context.site.id}`);
+
+        return await serveIcon(context, req);
+    } catch (err) {
+        if (err instanceof Error) {
+            console.error(`icon: ${err.toString()}`, err.stack);
+        }
+
+        throw err;
+    }
 }

packages/gitbook/src/lib/cache/cloudflare-do.ts

@@ -26,7 +26,12 @@ export const cloudflareDOCache: CacheBackend = {
                     return null;
                 }
 
-                return (await stub.get<CacheEntry>(key)) ?? null;
+                try {
+                    return (await stub.get<CacheEntry>(key)) ?? null;
+                } catch (err) {
+                    console.error('cloudflareDO.get', err);
+                    return null;
+                }
             }
         );
     },

packages/gitbook/src/lib/v1.ts

@@ -285,6 +285,7 @@ async function getDataFetcherV1(): Promise<GitBookDataFetcher> {
 export async function fetchV1ContextForSitePointer(pointer: SiteContentPointer) {
     const baseContext = await getV1BaseContext();
 
+    console.log('icon: baseContext success');
     const context = await fetchSiteContextByIds(baseContext, {
         organization: pointer.organizationId,
         site: pointer.siteId,
@@ -295,8 +296,10 @@ export async function fetchV1ContextForSitePointer(pointer: SiteContentPointer)
         changeRequest: pointer.changeRequestId,
         revision: pointer.revisionId,
     });
+    console.log('icon: context inner success');
 
     context.customization = await getDynamicCustomizationSettings(context.customization);
+    console.log('icon: customization success');
 
     return context;
 }

packages/gitbook/src/routes/icon.tsx

@@ -27,6 +27,7 @@ const SIZES = {
  * Generate an icon for a site content.
  */
 export async function serveIcon(context: GitBookSiteContext, req: Request) {
+    console.log('icon: serveIcon', req.url);
     const options = getOptions(req.url);
     const size = SIZES[options.size];