Skip to content
Sign up

flagon-io/g1t

public
0
251 linesCodeBlameRaw
1import { createRequestHandler } from "react-router";
2
3import { identityClient, isNamespaceShaped } from "@g1t/contracts";
4
5import { hardenRegistryHeaders } from "../app/lib/content-safety";
6import { withSiteHeaders } from "../app/lib/page-headers";
7import { finishResponse, withRequestPerf } from "../app/lib/perf.server";
8import { goImport } from "../app/lib/go-get";
9import { repositoryOfPage, stillPublic } from "../app/lib/public-cache";
10import { registryWorkspace, servicePath } from "../app/lib/registry-paths";
11
12const requestHandler = createRequestHandler(
13 () => import("virtual:react-router/server-build"),
14 import.meta.env.MODE,
15);
16
17/** An uploaded avatar, by the SHA-256 of its bytes. */
18const AVATAR_PATH = /^\/avatars\/([0-9a-f]{64})$/;
19/** The only types identity stores, having checked each image's bytes. */
20const AVATAR_TYPES = new Set(["image/png", "image/jpeg", "image/webp", "image/gif"]);
21const DOCS = "https://docs.g1t.sh";
22
23/** Where the documentation pages that used to live under /docs are now. */
24const MOVED_DOCS: Record<string, string> = {
25 "/docs": "/quickstart/",
26 "/docs/concepts": "/concepts/overview/",
27 "/docs/authentication": "/guides/authentication/",
28 "/docs/git": "/guides/git/",
29 "/docs/g1t-agents": "/guides/working-with-g1t/",
30 "/docs/agents": "/guides/bring-your-own-agent/",
31 "/docs/api": "/reference/api/",
32 "/docs/api/reference": "/reference/api/",
33};
34
35export default {
36 async fetch(request, env, ctx) {
37 // Every answer: no sniffing, a referrer of the origin alone, and no
38 // framing of pages (app/lib/page-headers.ts).
39 return withSiteHeaders(await site(request, env, ctx));
40 },
41} satisfies ExportedHandler<Env>;
42
43async function site(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
44 const { pathname } = new URL(request.url);
45 // Git over HTTPS shares this hostname but belongs to the repos service.
46 // Its answer goes back to the git client as it is: a repository under a
47 // renamed workspace's old name answers with a 301, which git follows and
48 // must see, so the redirect is never followed here.
49 // The container registry (`docker login g1t.sh`) and the npm registry
50 // (`g1t.sh/-/npm/`) are the packages
51 // service's, handed over the same way.
52 // `go get g1t.sh/<workspace>/<repo>`: where its code is, from the
53 // address alone, so it costs nothing and caches.
54 const go = request.method === "GET" ? goImport(new URL(request.url)) : null;
55 if (go) {
56 return new Response(go, {
57 headers: { "content-type": "text/html; charset=utf-8", "cache-control": "public, max-age=3600" },
58 });
59 }
60 const service = servicePath(pathname);
61 if (service === "git") {
62 return proxyGit(env, request);
63 }
64 if (service === "packages") {
65 return proxyPackages(env, request);
66 }
67 const avatar = AVATAR_PATH.exec(pathname);
68 if (avatar) {
69 return serveAvatar(env, ctx, request, avatar[1]);
70 }
71 // The documentation is its own site.
72 if (pathname === "/docs" || pathname.startsWith("/docs/")) {
73 const page = pathname.endsWith("/") ? pathname.slice(0, -1) : pathname;
74 const target = MOVED_DOCS[page] ?? "/";
75 return Response.redirect(DOCS + target, 301);
76 }
77 // Every page and data request says where its time went (Server-Timing)
78 // and keeps the reader's D1 bookmarks (app/lib/perf.server.ts).
79 const render = () => withRequestPerf(request, async () => finishResponse(request, await requestHandler(request)));
80 if (anonymousPage(request, pathname)) return servePublic(env, request, ctx, render);
81 return render();
82}
83
84/**
85 * Public pages as someone signed out sees them: the same for every such
86 * visitor, so kept in this data centre's cache. Reserved first segments
87 * (settings, sign-in, invitations and the like) and workspace pages (`-`)
88 * are never kept; docs/PERFORMANCE.md lists the rules. A repository's kept
89 * page is served only while repos says the repository is still public: one
90 * made private or deleted is never served from any data centre's copy.
91 */
92const PUBLIC_TOP = /^\/(?:|_root\.data|pricing|explore|security|support|policies(?:\/[a-z-]+)?)(?:\.data)?$/;
93const PUBLIC_PROJECT =
94 /^\/(?!(?:settings|u|auth|oauth|integrations|new|invite|workspaces|device|verify|confirm-email|login|register|logout|forgot|reset|search|status|avatars|docs)\/)[^/]+\/(?!-\/|-$)[^/]+(?:\/(?:code|commits|issues|pulls|pull\/\d+|issues\/\d+|commit\/[0-9a-f]+|tree\/.+|blob\/.+))?(?:\.data)?$/;
95/** Fresh for this long; then served once more while a new copy is made. */
96const PUBLIC_FRESH_SECONDS = 30;
97const PUBLIC_STALE_SECONDS = 300;
98
99function anonymousPage(request: Request, pathname: string): boolean {
100 if (request.method !== "GET") return false;
101 if (/(?:^|;\s*)g1t_session=/.test(request.headers.get("cookie") ?? "")) return false;
102 return PUBLIC_TOP.test(pathname) || PUBLIC_PROJECT.test(pathname);
103}
104
105async function servePublic(env: Env, request: Request, ctx: ExecutionContext, render: () => Promise<Response>): Promise<Response> {
106 const cache = (caches as unknown as { default: Cache }).default;
107 const key = new Request(request.url, { method: "GET" });
108 const repository = PUBLIC_PROJECT.test(new URL(request.url).pathname) ? repositoryOfPage(new URL(request.url).pathname) : null;
109 // Asked alongside the cache, so a hit waits for one indexed read at most.
110 const [cached, visible] = await Promise.all([cache.match(key), repository ? isStillPublic(env, repository) : Promise.resolve(true)]);
111 if (cached && !visible) {
112 ctx.waitUntil(cache.delete(key).then(() => undefined, () => undefined));
113 return render();
114 }
115 const keptAt = Number(cached?.headers.get("x-g1t-kept-at") ?? 0);
116 const age = Math.round((Date.now() - keptAt) / 1000);
117 const refresh = async () => {
118 const fresh = await render();
119 // Only a plain answer for everyone: nothing that sets a cookie or says
120 // it is private.
121 const cacheable =
122 (fresh.status === 200 || fresh.status === 404) &&
123 !fresh.headers.has("set-cookie") &&
124 !/private|no-store/.test(fresh.headers.get("cache-control") ?? "");
125 if (cacheable) {
126 const copy = new Response(fresh.clone().body, fresh);
127 copy.headers.set("x-g1t-kept-at", String(Date.now()));
128 copy.headers.set("cache-control", `public, max-age=${PUBLIC_STALE_SECONDS}`);
129 ctx.waitUntil(cache.put(key, copy));
130 }
131 return fresh;
132 };
133 if (cached && keptAt > 0 && age < PUBLIC_STALE_SECONDS) {
134 if (age >= PUBLIC_FRESH_SECONDS) ctx.waitUntil(refresh().then(() => undefined, () => undefined));
135 const answer = new Response(cached.body, cached);
136 answer.headers.delete("x-g1t-kept-at");
137 answer.headers.delete("cache-control");
138 answer.headers.set("server-timing", `cache;desc="hit, ${age}s old"`);
139 return answer;
140 }
141 return refresh();
142}
143
144/** Whether the repository is there and public; anything else, including no answer, is no. */
145async function isStillPublic(env: Env, repository: string): Promise<boolean> {
146 try {
147 const answer = await env.REPOS.fetch("https://service/rpc/visibility", {
148 method: "POST",
149 headers: { "content-type": "application/json" },
150 body: JSON.stringify({ paths: [repository] }),
151 });
152 return answer.ok && stillPublic(await answer.json(), repository);
153 } catch {
154 return false;
155 }
156}
157
158/**
159 * A git request, answered by the repos service. Its `Server-Timing` header
160 * gains `repos`: how long the answer took to start from here, so the time
161 * between this Worker and the repos service shows beside the steps the
162 * repos service reports.
163 */
164async function proxyGit(env: Env, request: Request): Promise<Response> {
165 const started = Date.now();
166 const answer = await env.REPOS.fetch(new Request(request, { redirect: "manual" }));
167 const response = new Response(answer.body, answer);
168 response.headers.append("server-timing", `repos;dur=${Date.now() - started}`);
169 return response;
170}
171
172/**
173 * A registry request, answered by the packages service as it is: its
174 * redirects (a large blob sent to storage) go back to the client, which
175 * follows them itself. One that found nothing under a workspace's old name
176 * or an alias staff set (`g1t` for `flagon-io`) is sent to the same path
177 * under the workspace's name: only the not-found answer pays for the lookup.
178 * Every answer runs nothing in a browser (app/lib/content-safety.ts): what
179 * a registry serves is its publisher's, on this origin.
180 */
181async function proxyPackages(env: Env, request: Request): Promise<Response> {
182 const started = Date.now();
183 const answer = await env.PACKAGES.fetch(new Request(request, { redirect: "manual" }));
184 const moved = answer.status === 404 ? await registryMoved(env, request) : null;
185 const response = moved ?? new Response(answer.body, answer);
186 hardenRegistryHeaders(response.headers);
187 response.headers.append("server-timing", `packages;dur=${Date.now() - started}`);
188 return response;
189}
190
191/** Where a registry request under an alias or old name goes now, or null. */
192async function registryMoved(env: Env, request: Request): Promise<Response | null> {
193 const url = new URL(request.url);
194 const named = registryWorkspace(url.pathname);
195 if (!named || !isNamespaceShaped(named.slug)) return null;
196 let current: string | null = null;
197 try {
198 current = await identityClient(env.IDENTITY).resolveSlug(named.slug);
199 } catch {
200 return null;
201 }
202 if (!current || current === named.slug) return null;
203 const get = request.method === "GET" || request.method === "HEAD";
204 // 308 keeps a publish a PUT, for the clients that follow it.
205 return new Response(null, { status: get ? 301 : 308, headers: { location: named.under(current) + url.search } });
206}
207
208/**
209 * An uploaded avatar. Its address is its hash, so it never changes and is
210 * kept for good. It is served as nothing but an image: the stored type,
211 * no sniffing, and a policy that lets nothing in it run.
212 */
213/**
214 * An uploaded icon. Its address is its content's hash, so it never changes:
215 * each data centre keeps it in its cache after the first view, and storage
216 * is read about once per place, not once per visitor.
217 */
218async function serveAvatar(env: Env, ctx: ExecutionContext, request: Request, hash: string): Promise<Response> {
219 const method = request.method;
220 if (method !== "GET" && method !== "HEAD") {
221 return new Response("Method not allowed", { status: 405, headers: { allow: "GET, HEAD" } });
222 }
223 // The Workers runtime's own cache, which the DOM types do not know.
224 const cache = (caches as unknown as { default: Cache }).default;
225 const key = new Request(new URL(`/avatars/${hash}`, request.url).toString(), { method: "GET" });
226 const cached = await cache.match(key);
227 if (cached) {
228 return method === "HEAD" ? new Response(null, { headers: cached.headers }) : cached;
229 }
230 const { value, metadata } = await env.AVATARS.getWithMetadata<{ contentType?: string }>(hash, {
231 type: "arrayBuffer",
232 cacheTtl: 86400,
233 });
234 const contentType = metadata?.contentType;
235 if (!value || !contentType || !AVATAR_TYPES.has(contentType)) {
236 return new Response("Not found", {
237 status: 404,
238 headers: { "cache-control": "public, max-age=60" },
239 });
240 }
241 const headers = {
242 "content-type": contentType,
243 "content-length": String(value.byteLength),
244 "cache-control": "public, max-age=31536000, immutable",
245 "x-content-type-options": "nosniff",
246 "content-security-policy": "default-src 'none'; sandbox",
247 "cross-origin-resource-policy": "cross-origin",
248 };
249 ctx.waitUntil(cache.put(key, new Response(value, { headers })));
250 return new Response(method === "HEAD" ? null : value, { headers });
251}