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