Skip to content
246 linesCodeBlameRaw
1import { waitUntil } from "cloudflare:workers";
2import { Box, Lock } from "lucide-react";
3import type { ReactNode } from "react";
4import { Link, Outlet, type ShouldRevalidateFunctionArgs, data, useLocation, useRouteLoaderData } from "react-router";
5
6import type { Project } from "@g1t/contracts";
7
8import type { Route } from "./+types/layout";
9import { Topics } from "../../components/topics";
10import { page } from "../../lib/meta";
11import { type Tab as PageTab, tabsFor } from "../../lib/project-nav";
12import { Pill, SoonPill } from "../../components/ui";
13import { Hint } from "../../components/ui/hint";
14import { TabStrip } from "../../components/ui/tab-strip";
15import { ProjectStrip } from "../../components/mobile";
16import { seesSettings } from "../../lib/access";
17import { WatchMenu } from "../../components/notifications";
18import { PinButton } from "../../components/pin-button";
19import { StarButton } from "../../components/star-button";
20import { ArchivedBanner } from "../../components/repo-lifecycle";
21import { WelcomeBanner } from "../../components/welcome";
22import { clearWelcome, welcomes } from "../../lib/invites";
23import { notFound } from "../../lib/not-found.server";
24import { redirectIfRenamed, redirectIfTransferred } from "../../lib/renamed.server";
25import { accessFor, countsFor, projectFor, repoFor } from "../../lib/access.server";
26import { inbox, projects, repos } from "../../lib/services.server";
27import { getViewer, roleIn, unwrap } from "../../lib/session.server";
28
29export function meta({ loaderData: loaded, params, ...args }: Route.MetaArgs) {
30 return page(args, { title: `${loaded?.project?.name ?? params.repo} · ${params.owner} · g1t` });
31}
32
33export async function loader({ params, context, request }: Route.LoaderArgs) {
34 const viewer = getViewer(context);
35 const path = { namespace: params.owner, name: params.repo };
36 // Members pin the workspace's projects, and what they open is their Recent.
37 const member = viewer ? roleIn(viewer, params.owner) != null : false;
38 const [repo, counts, found, watching, shortcuts, stars] = await Promise.all([
39 repoFor(context, params),
40 countsFor(context, params),
41 projectFor(context, params),
42 // How the person watches it, for the header's Watch menu, as soon as
43 // the repository is known.
44 viewer
45 ? repoFor(context, params).then((found) => (found.ok ? inbox.watching(viewer.username, found.value.id).catch(() => null) : null))
46 : null,
47 // Whether they pinned it, for the header's Pin button.
48 member ? projects.shortcuts(params.owner, viewer).catch(() => null) : null,
49 // How many starred it and whether they did, for the header's Star button.
50 repos.stars(path, viewer).then((found) => (found.ok ? found.value : null)).catch(() => null),
51 ]);
52 if (!repo.ok && !found.ok) {
53 // Under a workspace's old name, after a rename: the project is at the new one.
54 await redirectIfRenamed(request, params.owner);
55 // A repository transferred to another workspace: it is there now.
56 await redirectIfTransferred(request, params.owner, params.repo, viewer);
57 throw notFound("project");
58 }
59 let project: Project | null = found.ok ? found.value : null;
60 // A repository made a moment ago, before its project: make it now.
61 if (!project && repo.ok && !repo.value.forkOf) {
62 const own = await projects.byRepo(repo.value.id);
63 project = own.find((p) => p.slug === params.repo.toLowerCase()) ?? own[0] ?? null;
64 }
65 // Opened just now: it leads their Recent, recorded after the page is sent.
66 if (member && project) waitUntil(projects.visited(viewer!, project.id).catch(() => undefined));
67 const value = unwrap(repo);
68 // The viewer's role on the repository and what it lets them do, for the
69 // pages under it and the sidebar.
70 const access = accessFor(viewer, value);
71 // Just given access with an invite: welcomed once (routes/invite.tsx).
72 const welcome = Boolean(access.role) && welcomes(request.headers.get("cookie"), `${value.namespace}/${value.name}`);
73 const headers = welcome ? { "Set-Cookie": clearWelcome(new URL(request.url).protocol === "https:") } : undefined;
74 return data({
75 welcome,
76 repo: value,
77 project,
78 open: counts.ok ? counts.value : { issues: 0, pulls: 0 },
79 access,
80 member: access.insider,
81 watching,
82 // Null for a pull request's working copy, or when it could not be read.
83 stars: value.forkOf ? null : stars,
84 signedIn: Boolean(viewer),
85 // Null when they cannot pin it: not one of their workspaces.
86 pinned: member && project ? (shortcuts?.pinned ?? []).some((pinned) => pinned.id === project.id) : null,
87 }, { headers });
88}
89
90/**
91 * The project's header, tabs and the viewer's role change with the project
92 * or after something was submitted, not from one page of it to the next,
93 * nor when a page refreshes itself.
94 */
95export function shouldRevalidate({ currentParams, nextParams, formMethod, defaultShouldRevalidate }: ShouldRevalidateFunctionArgs) {
96 if (formMethod && formMethod !== "GET") return defaultShouldRevalidate;
97 return currentParams.owner !== nextParams.owner || currentParams.repo !== nextParams.repo;
98}
99
100/** The project the page is in, for the pages under it. */
101export function useProject() {
102 return useRouteLoaderData<typeof loader>("routes/repo/layout");
103}
104
105/** A repository's topics, each a way into Explore. */
106function Header({ project, isPrivate, archived, namespace, name, description, large, actions }: {
107 project: Project | null;
108 isPrivate: boolean;
109 namespace: string;
110 name: string;
111 description: string | null;
112 archived?: boolean;
113 large?: boolean;
114 /** At the end of the row: Pin, Watch and Star. */
115 actions?: ReactNode;
116}) {
117 const base = `/${namespace}/${name}`;
118 return (
119 <div className="flex flex-wrap items-center gap-x-3 gap-y-1">
120 <span
121 className={`flex shrink-0 items-center justify-center rounded-md bg-raised text-muted ring-1 ring-line ${large ? "size-8" : "size-6"}`}
122 >
123 {isPrivate ? <Lock size={large ? 15 : 13} /> : <Box size={large ? 15 : 13} />}
124 </span>
125 <h1 className={large ? "text-lg" : "text-[0.9375rem]"}>
126 <Link to={`/${namespace}`} className="font-mono text-muted hover:text-fg">
127 {namespace}
128 </Link>
129 <span className="mx-1.5 text-faint">/</span>
130 <Link to={base} className="font-semibold hover:underline">
131 {project?.name ?? name}
132 </Link>
133 </h1>
134 <Pill>{isPrivate ? "private" : "public"}</Pill>
135 {archived && <Pill>archived</Pill>}
136 {/* On a phone, on its own line under the name and the Watch menu. */}
137 {description && <p className="order-last min-w-0 basis-full truncate text-sm text-muted sm:order-none sm:basis-0 sm:flex-1">{description}</p>}
138 {actions && <div className="ml-auto flex shrink-0 items-center gap-2">{actions}</div>}
139 </div>
140 );
141}
142
143/**
144 * The views of the page the project is on, as tabs across its top: Files,
145 * Commits and what is coming under Code, and so on. Soon tabs open their
146 * roadmap page, under the same tabs.
147 */
148function PageTabs({ base, tabs }: { base: string; tabs: PageTab[] }) {
149 const { pathname } = useLocation();
150 const rest = pathname.slice(base.length + 1);
151 const current = (tab: PageTab) =>
152 [tab.path, ...(tab.also ?? [])].some((path) => rest === path || (!tab.exact && rest.startsWith(`${path}/`)));
153 return (
154 <TabStrip label="Views" className="-mb-px gap-1">
155 {tabs.map((tab) => (
156 <Hint key={tab.path} label={tab.about}>
157 <Link
158 to={`${base}/${tab.path}`}
159 prefetch="intent"
160 // Current by the tab's own rule: a link's address alone would also
161 // mark Overview current on every page under it.
162 aria-current={current(tab) ? "page" : undefined}
163 data-active={current(tab) || undefined}
164 className={`flex items-center gap-1.5 border-b-2 px-3 pt-1 pb-2.5 text-sm transition-colors ${
165 current(tab)
166 ? "border-accent font-medium text-fg"
167 : tab.soon
168 ? "border-transparent text-faint hover:text-muted"
169 : "border-transparent text-muted hover:text-fg"
170 }`}
171 >
172 {tab.label}
173 {tab.soon && <SoonPill />}
174 </Link>
175 </Hint>
176 ))}
177 </TabStrip>
178 );
179}
180
181export default function ProjectLayout({ loaderData }: Route.ComponentProps) {
182 const { repo, project, member, access, welcome, watching, pinned, stars, signedIn } = loaderData;
183 const base = `/${repo.namespace}/${repo.name}`;
184 // The project's own description, else the repository's as it is now.
185 const description = (project && !project.descriptionInherited ? project.description : null) ?? repo.description;
186 const { pathname } = useLocation();
187 const tabs = tabsFor(pathname.slice(base.length + 1), member, access.can);
188 // The files' own About says what it is and its topics, as the one place.
189 const filesPage = /^(code|tree|blob|commits?|branches|tags|releases|compare)(\/|$)/.test(pathname.slice(base.length + 1));
190 // Everyone, signed in or not, finds the project's pages in the sidebar;
191 // the page shows its name, and the views of the page it is on as tabs.
192 return (
193 <>
194 <div className="border-b border-line">
195 <div className={`mx-auto max-w-6xl px-4 sm:px-6 ${tabs ? "pt-3" : "py-3"}`}>
196 <Header
197 project={project}
198 isPrivate={repo.isPrivate}
199 archived={Boolean(repo.archivedAt)}
200 namespace={repo.namespace}
201 name={repo.name}
202 // The files' own About says it there, as the one place.
203 description={filesPage ? null : description}
204 actions={
205 watching || stars || (project && pinned != null) ? (
206 <>
207 {project && pinned != null && (
208 <PinButton workspace={project.workspace} slug={project.slug} name={project.name} pinned={pinned} />
209 )}
210 {watching && <WatchMenu action={`${base}/notifications`} level={watching.level} events={watching.events} />}
211 {stars && <StarButton base={base} name={`${repo.namespace}/${repo.name}`} stars={stars} signedIn={signedIn} />}
212 </>
213 ) : null
214 }
215 />
216 {/* On the files' pages, About shows them. */}
217 {!filesPage && <Topics topics={repo.topics} />}
218 {/* A phone: the project's pages, which the sidebar lists from 768px. */}
219 <div className="mt-3 md:hidden">
220 <ProjectStrip base={base} member={member} can={access.can} settings={seesSettings(access)} counts={loaderData.open} />
221 </div>
222 {tabs && (
223 <div className="mt-3">
224 <PageTabs base={base} tabs={tabs} />
225 </div>
226 )}
227 </div>
228 </div>
229 <div className="mx-auto max-w-6xl px-4 py-6 sm:px-6">
230 {welcome && (
231 <div className="mb-6">
232 <WelcomeBanner title={`You're in ${repo.namespace}/${repo.name}`}>
233 You have the {access.role} role on it now. Its code, issues and pull requests are yours to work on.
234 </WelcomeBanner>
235 </div>
236 )}
237 {repo.archivedAt && (
238 <div className="mb-6">
239 <ArchivedBanner base={base} owner={access.can.administer} settings={/^settings(\/|$)/.test(pathname.slice(base.length + 1))} />
240 </div>
241 )}
242 <Outlet />
243 </div>
244 </>
245 );
246}