Merge remote-tracking branch 'origin/main' into stevenh/update-scalar-client

.github/workflows/ci.yaml

@@ -1,5 +1,9 @@
-on: [push]
 name: CI
+on:
+    pull_request:
+    push:
+        branches:
+            - main
 
 jobs:
     deploy:

README.md

@@ -75,7 +75,7 @@ GitBook's rendering engine is fully open-source and built on top of [Next.js](ht
 
 ### Types of contributions
 
-We encourage you to contribute to GitBook to help us build the best tool for doucmenting techincal knowledge. If you're looking for some quick ways to contribute, continue reading to learn more about popular contributions.
+We encourage you to contribute to GitBook to help us build the best tool for documenting technical knowledge. If you're looking for some quick ways to contribute, continue reading to learn more about popular contributions.
 
 #### Translations
 
@@ -92,7 +92,7 @@ Encounter a bug or find an issue you'd like to fix? Helping us fix issues relate
 >
 > _Looking to add a specific feature in GitBook? Head to our [contributing guide](/.github/CONTRIBUTING.md) to get started._
 >
-> Self-hosting this project puts the responsibility of maintaining and merging future updates on **you**. We cannot guarantee support, maintainance, or updates to forked and self-hosted instances of this project.
+> Self-hosting this project puts the responsibility of maintaining and merging future updates on **you**. We cannot guarantee support, maintenance, or updates to forked and self-hosted instances of this project.
 >
 > We want to make it as easy as possible for our community to collaborate and push the future of GitBook, which is why we encourage you to contribute to our product directly instead of creating your own version.
 

src/components/TableOfContents/TableOfContents.tsx

@@ -75,7 +75,7 @@ export function TableOfContents(props: {
                     'dark:group-hover:[&::-webkit-scrollbar-thumb]:bg-light/3',
                     'navigation-open:flex', // can be auto height animated as such https://stackoverflow.com/a/76944290
                     'lg:-ml-5',
-                    customization.trademark.enabled ? 'lg:pb-16' : 'lg:pb-4',
+                    customization.trademark.enabled ? 'lg:pb-20' : 'lg:pb-4',
                 )}
             >
                 <PagesList

src/components/TableOfContents/Trademark.tsx

@@ -84,16 +84,20 @@ export function TrademarkLink(props: {
                 'flex-row',
                 'items-center',
                 'hover:bg-dark/1',
+                'bg-light',
+                'dark:bg-dark',
                 'px-4',
-                'py-2',
-                'rounded-md',
+                'py-4',
+                'rounded-lg',
                 'straight-corners:rounded-none',
                 'hover:backdrop-blur-sm',
                 'lg:ring-0',
                 'tracking-[-0.016em]',
                 'dark:hover:bg-light/1',
                 'dark:ring-light/1',
-                'dark:font-normal',
+                'border',
+                'border-dark/2',
+                'dark:border-light/2',
             )}
         >
             <IconLogo className={tcls('w-5', 'h-5', 'mr-3')} />

src/lib/visitor-auth.test.ts

@@ -2,6 +2,7 @@ import { it, describe, expect } from 'bun:test';
 import { NextRequest } from 'next/server';
 
 import {
+    VisitorAuthCookieValue,
     getVisitorAuthCookieName,
     getVisitorAuthCookieValue,
     getVisitorAuthToken,
@@ -17,14 +18,18 @@ describe('getVisitorAuthToken', () => {
         const request = nextRequest('https://example.com', {
             [getVisitorAuthCookieName('/')]: { value: getVisitorAuthCookieValue('/', '123') },
         });
-        expect(getVisitorAuthToken(request, request.nextUrl)).toEqual('123');
+        const visitorAuth = getVisitorAuthToken(request, request.nextUrl);
+        assertVisitorAuthCookieValue(visitorAuth);
+        expect(visitorAuth.token).toEqual('123');
     });
 
     it('should return the token from the cookie root basepath for a sub-path', () => {
         const request = nextRequest('https://example.com/hello/world', {
             [getVisitorAuthCookieName('/')]: { value: getVisitorAuthCookieValue('/', '123') },
         });
-        expect(getVisitorAuthToken(request, request.nextUrl)).toEqual('123');
+        const visitorAuth = getVisitorAuthToken(request, request.nextUrl);
+        assertVisitorAuthCookieValue(visitorAuth);
+        expect(visitorAuth.token).toEqual('123');
     });
 
     it('should return the closest token from the path', () => {
@@ -34,7 +39,9 @@ describe('getVisitorAuthToken', () => {
                 value: getVisitorAuthCookieValue('/hello/', '123'),
             },
         });
-        expect(getVisitorAuthToken(request, request.nextUrl)).toEqual('123');
+        const visitorAuth = getVisitorAuthToken(request, request.nextUrl);
+        assertVisitorAuthCookieValue(visitorAuth);
+        expect(visitorAuth.token).toEqual('123');
     });
 
     it('should return the token from the cookie in a collection type url', () => {
@@ -43,7 +50,9 @@ describe('getVisitorAuthToken', () => {
                 value: getVisitorAuthCookieValue('/hello/v/space1/', '123'),
             },
         });
-        expect(getVisitorAuthToken(request, request.nextUrl)).toEqual('123');
+        const visitorAuth = getVisitorAuthToken(request, request.nextUrl);
+        assertVisitorAuthCookieValue(visitorAuth);
+        expect(visitorAuth.token).toEqual('123');
     });
 
     it('should return undefined if no cookie and no query param', () => {
@@ -52,6 +61,14 @@ describe('getVisitorAuthToken', () => {
     });
 });
 
+function assertVisitorAuthCookieValue(value: unknown): asserts value is VisitorAuthCookieValue {
+    if (value && typeof value === 'object' && 'token' in value) {
+        return;
+    }
+
+    throw new Error('Expected a VisitorAuthCookieValue');
+}
+
 function nextRequest(url: string, cookies: Record<string, { value: string }> = {}) {
     const nextUrl = new URL(url);
     // @ts-ignore

src/lib/visitor-auth.ts

@@ -16,7 +16,10 @@ export type VisitorAuthCookieValue = {
  * Get the visitor authentication token for the request. This token can either be in the
  * query parameters or stored as a cookie.
  */
-export function getVisitorAuthToken(request: NextRequest, url: URL): string | undefined {
+export function getVisitorAuthToken(
+    request: NextRequest,
+    url: URL,
+): string | VisitorAuthCookieValue | undefined {
     return url.searchParams.get(VISITOR_AUTH_PARAM) ?? getVisitorAuthTokenFromCookies(request, url);
 }
 
@@ -68,7 +71,10 @@ function getUrlBasePathCombinations(url: URL): string[] {
  * checking all cookies for a matching "visitor authentication cookie" and returning the
  * best possible match for the current URL.
  */
-function getVisitorAuthTokenFromCookies(request: NextRequest, url: URL): string | undefined {
+function getVisitorAuthTokenFromCookies(
+    request: NextRequest,
+    url: URL,
+): VisitorAuthCookieValue | undefined {
     const urlBasePaths = getUrlBasePathCombinations(url);
     // Try to find a visitor authentication token for the current URL. The request
     // for the content could be hosted on a base path like `/foo/v/bar` or `/foo` or just `/`
@@ -90,14 +96,17 @@ function getVisitorAuthTokenFromCookies(request: NextRequest, url: URL): string
 function findVisitorAuthCookieForBasePath(
     request: NextRequest,
     basePath: string,
-): string | undefined {
-    return Array.from(request.cookies).reduce<string | undefined>((acc, [name, cookie]) => {
-        if (name === getVisitorAuthCookieName(basePath)) {
-            const value = JSON.parse(cookie.value) as VisitorAuthCookieValue;
-            if (value.basePath === basePath) {
-                acc = value.token;
+): VisitorAuthCookieValue | undefined {
+    return Array.from(request.cookies).reduce<VisitorAuthCookieValue | undefined>(
+        (acc, [name, cookie]) => {
+            if (name === getVisitorAuthCookieName(basePath)) {
+                const value = JSON.parse(cookie.value) as VisitorAuthCookieValue;
+                if (value.basePath === basePath) {
+                    acc = value;
+                }
             }
-        }
-        return acc;
-    }, undefined);
+            return acc;
+        },
+        undefined,
+    );
 }

src/middleware.ts

@@ -22,6 +22,7 @@ import { buildVersion } from '@/lib/build';
 import { createContentSecurityPolicyNonce, getContentSecurityPolicy } from '@/lib/csp';
 import { getURLLookupAlternatives, normalizeURL } from '@/lib/middleware';
 import {
+    VisitorAuthCookieValue,
     getVisitorAuthCookieName,
     getVisitorAuthCookieValue,
     getVisitorAuthToken,
@@ -588,7 +589,7 @@ async function lookupSpaceInMultiPathMode(request: NextRequest, url: URL): Promi
  */
 async function lookupSpaceByAPI(
     lookupURL: URL,
-    visitorAuthToken: string | undefined,
+    visitorAuthToken: ReturnType<typeof getVisitorAuthToken>,
 ): Promise<LookupResult> {
     const url = stripURLSearch(lookupURL);
     const lookup = getURLLookupAlternatives(url);
@@ -598,9 +599,17 @@ async function lookupSpaceByAPI(
     );
 
     const result = await race(lookup.urls, async (alternative, { signal }) => {
-        const data = await getPublishedContentByUrl(alternative.url, visitorAuthToken, {
-            signal,
-        });
+        const data = await getPublishedContentByUrl(
+            alternative.url,
+            typeof visitorAuthToken === 'undefined'
+                ? undefined
+                : typeof visitorAuthToken === 'string'
+                  ? visitorAuthToken
+                  : visitorAuthToken.token,
+            {
+                signal,
+            },
+        );
 
         if ('error' in data) {
             if (alternative.primary) {
@@ -672,22 +681,36 @@ async function lookupSpaceByAPI(
  */
 function getLookupResultForVisitorAuth(
     basePath: string,
-    visitorAuthToken: string,
+    visitorAuthToken: string | VisitorAuthCookieValue,
 ): Partial<LookupResult> {
     return {
         // No caching for content served with visitor auth
         cacheMaxAge: undefined,
         cacheTags: [],
         cookies: {
-            [getVisitorAuthCookieName(basePath)]: {
-                value: getVisitorAuthCookieValue(basePath, visitorAuthToken),
-                options: {
-                    httpOnly: true,
-                    sameSite: 'none',
-                    secure: process.env.NODE_ENV === 'production',
-                    maxAge: 7 * 24 * 60 * 60,
-                },
-            },
+            /**
+             * If the visitorAuthToken has been retrieved from a cookie, we set it back only
+             * if the basePath matches the current one. This is to avoid setting cookie for
+             * different base paths.
+             */
+            ...(typeof visitorAuthToken === 'string' || visitorAuthToken.basePath === basePath
+                ? {
+                      [getVisitorAuthCookieName(basePath)]: {
+                          value: getVisitorAuthCookieValue(
+                              basePath,
+                              typeof visitorAuthToken === 'string'
+                                  ? visitorAuthToken
+                                  : visitorAuthToken.token,
+                          ),
+                          options: {
+                              httpOnly: true,
+                              sameSite: 'none',
+                              secure: process.env.NODE_ENV === 'production',
+                              maxAge: 7 * 24 * 60 * 60,
+                          },
+                      },
+                  }
+                : {}),
         },
     };
 }