Skip to content

Revert "Serve the correct status code for not found and redirects 👌" #2587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 26, 2024
Merged

Revert "Serve the correct status code for not found and redirects 👌" #2587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified bun.lockb
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion packages/gitbook/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"katex": "^0.16.9",
"mathjax": "^3.2.2",
"memoizee": "^0.4.15",
"next": "14.2.18",
"next": "14.2.15",
"next-themes": "^0.2.1",
"nuqs": "^1.17.4",
"object-hash": "^3.0.0",
Expand Down
28 changes: 28 additions & 0 deletions packages/gitbook/src/app/(site)/(content)/[[...pathname]]/loading.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { SkeletonHeading, SkeletonParagraph } from '@/components/primitives';
import { tcls } from '@/lib/tailwind';

/**
* Placeholder when loading a page.
*/
export default function PageSkeleton() {
return (
<div
className={tcls(
'flex',
'flex-row',
'flex-1',
'relative',
'py-8',
'lg:px-16',
'xl:mr-56',
'items-center',
'lg:items-start',
)}
>
<div className={tcls('flex-1', 'max-w-3xl', 'mx-auto', 'page-full-width:mx-0')}>
<SkeletonHeading style={tcls('mb-8')} />
<SkeletonParagraph style={tcls('mb-4')} />
</div>
</div>
);
}
145 changes: 51 additions & 94 deletions packages/gitbook/src/app/(site)/(content)/[[...pathname]]/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
import { CustomizationHeaderPreset, CustomizationThemeMode } from '@gitbook/api';
import { Metadata, Viewport } from 'next';
import { headers } from 'next/headers';
import { notFound, redirect } from 'next/navigation';
import React, { Suspense } from 'react';
import React from 'react';

import { PageAside } from '@/components/PageAside';
import { PageBody, PageCover } from '@/components/PageBody';
import { SkeletonHeading, SkeletonParagraph } from '@/components/primitives';
import { PageHrefContext, absoluteHref, pageHref } from '@/lib/links';
import { getPagePath, resolveFirstDocument } from '@/lib/pages';
import { ContentRefContext } from '@/lib/references';
Expand All @@ -19,23 +17,15 @@ import { PagePathParams, fetchPageData, getPathnameParam, normalizePathname } fr

export const runtime = 'edge';

type PageProps = {
/**
* Fetch and render a page.
*/
export default async function Page(props: {
params: PagePathParams;
searchParams: { fallback?: string };
};

export default async function Page(props: PageProps) {
// We wrap the page in Suspense to enable streaming at page level
// it's only enabled in "navigation" mode
return (
<Suspense fallback={<PageSkeleton />}>
<PageContent {...props} />
</Suspense>
);
}
}) {
const { params, searchParams } = props;

async function PageContent(props: PageProps) {
const data = await getPageDataWithFallback(props, { redirectOnFallback: true });
const {
content: contentPointer,
contentTarget,
Expand All @@ -46,7 +36,26 @@ async function PageContent(props: PageProps) {
pages,
page,
document,
} = data;
} = await getPageDataWithFallback({
pagePathParams: params,
searchParams,
redirectOnFallback: true,
});

const linksContext: PageHrefContext = {};
const rawPathname = getPathnameParam(params);
if (!page) {
const pathname = normalizePathname(rawPathname);
if (pathname !== rawPathname) {
// If the pathname was not normalized, redirect to the normalized version
// before trying to resolve the page again
redirect(absoluteHref(pathname));
} else {
notFound();
}
} else if (getPagePath(pages, page) !== rawPathname) {
redirect(pageHref(pages, page, linksContext));
}

const withTopHeader = customization.header.preset !== CustomizationHeaderPreset.None;
const withFullPageCover = !!(
Expand All @@ -69,8 +78,6 @@ async function PageContent(props: PageProps) {

return (
<>
{/* Title is displayed by the browser, except in navigation mode */}
<title>{getTitle(data)}</title>
{withFullPageCover && page.cover ? (
<PageCover as="full" page={page} cover={page.cover} context={contentRefContext} />
) : null}
Expand Down Expand Up @@ -110,30 +117,7 @@ async function PageContent(props: PageProps) {
);
}

function PageSkeleton() {
return (
<div
className={tcls(
'flex',
'flex-row',
'flex-1',
'relative',
'py-8',
'lg:px-16',
'xl:mr-56',
'items-center',
'lg:items-start',
)}
>
<div className={tcls('flex-1', 'max-w-3xl', 'mx-auto', 'page-full-width:mx-0')}>
<SkeletonHeading style={tcls('mb-8')} />
<SkeletonParagraph style={tcls('mb-4')} />
</div>
</div>
);
}

export async function generateViewport({ params }: PageProps): Promise<Viewport> {
export async function generateViewport({ params }: { params: PagePathParams }): Promise<Viewport> {
const { customization } = await fetchPageData(params);
return {
colorScheme: customization.themes.toggeable
Expand All @@ -144,25 +128,26 @@ export async function generateViewport({ params }: PageProps): Promise<Viewport>
};
}

function getTitle(input: Awaited<ReturnType<typeof getPageDataWithFallback>>) {
const { page, space, customization, site } = input;
return [page.title, getContentTitle(space, customization, site ?? null)]
.filter(Boolean)
.join(' | ');
}
export async function generateMetadata({
params,
searchParams,
}: {
params: PagePathParams;
searchParams: { fallback?: string };
}): Promise<Metadata> {
const { space, pages, page, customization, site, ancestors } = await getPageDataWithFallback({
pagePathParams: params,
searchParams,
});

export async function generateMetadata(props: PageProps): Promise<Metadata> {
// We only generate metadata in navigation mode. Else we let the browser handle it.
if (await checkIsInAppNavigation()) {
return {};
if (!page) {
notFound();
}

const data = await getPageDataWithFallback(props, { redirectOnFallback: false });

const { page, pages, space, customization, site, ancestors } = data;

return {
title: getTitle(data),
title: [page.title, getContentTitle(space, customization, site ?? null)]
.filter(Boolean)
.join(' | '),
description: page.description ?? '',
alternates: {
canonical: absoluteHref(getPagePath(pages, page), true),
Expand All @@ -180,30 +165,17 @@ export async function generateMetadata(props: PageProps): Promise<Metadata> {
};
}

/**
* Check if the navigation is in-app, meaning the user clicks on a link.
*/
async function checkIsInAppNavigation() {
const headerList = await headers();
const fetchMode = headerList.get('sec-fetch-mode');

return fetchMode === 'cors';
}

/**
* Fetches the page data matching the requested pathname and fallback to root page when page is not found.
*/
async function getPageDataWithFallback(
props: PageProps,
behaviour: {
redirectOnFallback: boolean;
},
) {
await new Promise((resolve) => setTimeout(resolve, 2000));
const { params, searchParams } = props;
const { redirectOnFallback } = behaviour;
async function getPageDataWithFallback(args: {
pagePathParams: PagePathParams;
searchParams: { fallback?: string };
redirectOnFallback?: boolean;
}) {
const { pagePathParams, searchParams, redirectOnFallback = false } = args;

const { pages, page: targetPage, ...otherPageData } = await fetchPageData(params);
const { pages, page: targetPage, ...otherPageData } = await fetchPageData(pagePathParams);

let page = targetPage;
const canFallback = !!searchParams.fallback;
Expand All @@ -217,21 +189,6 @@ async function getPageDataWithFallback(
page = rootPage?.page;
}

const linksContext: PageHrefContext = {};
const rawPathname = getPathnameParam(params);
if (!page) {
const pathname = normalizePathname(rawPathname);
if (pathname !== rawPathname) {
// If the pathname was not normalized, redirect to the normalized version
// before trying to resolve the page again
redirect(absoluteHref(pathname));
} else {
notFound();
}
} else if (getPagePath(pages, page) !== rawPathname) {
redirect(pageHref(pages, page, linksContext));
}

return {
...otherPageData,
pages,
Expand Down
Loading