Skip to content
187 linesCodeBlameRaw
1/**
2 * The notify service: live notifications, unread counts, and push to
3 * browsers (Web Push) and to the phone app (through Expo, src/expopush.ts).
4 * One feed per person (src/feed.ts).
5 *
6 * Reached through service bindings only: `POST /rpc/<method>` with
7 * snake_case bodies (`notifyClient` in @g1t/contracts), and `GET /live`,
8 * the person's feed socket, which the site forwards after checking the
9 * session (NOTIFY_VIEWER_HEADER), with the counts it read (NOTIFY_SEED_HEADER).
10 *
11 * Who sends what:
12 * - chat: `deliver`, for every message (counts for each person in the
13 * conversation, a notification for those it is for) and every read;
14 * - events: `notify`, for every inbox item, and `set_inbox`, the count after
15 * items arrive or are marked, naming the person by username;
16 * - the site: `subscribe`, `unsubscribe`, `status`, `set_preferences`,
17 * `test`, `presence` and `set_presence`, for the person signed in;
18 * `register_device` and `unregister_device`, for the phone app they
19 * signed in to (through `/-/notify`); and
20 * `last_visit` and `mark_visit`, when they were last on a workspace's
21 * Home page (src/visits.ts);
22 * - agents and the site: `workspace_presence`, how a workspace's people
23 * show now (away, in Do Not Disturb, offline, and their statuses);
24 * - integrations, later: `set_presence` with a status of `source`
25 * `calendar` or `integration`, for the person they act for;
26 * - events and actions: `repo_changed`, what changed in repositories,
27 * told to whoever watches their pages; and the site `watch_repo`, for a
28 * tab on a repository page whose person it checked may read it.
29 *
30 * Presence: each feed works out its person's from their tabs and tells
31 * one room per workspace (src/room.ts), which tells everyone there who is
32 * online. See docs.g1t.sh/guides/chat/, "Presence and status".
33 *
34 * Live repository pages: one topic per repository (src/topic.ts) keeps
35 * who is watching it, and hands each change to their feeds. See
36 * docs.g1t.sh/guides/notifications/, "Pages that update live".
37 */
38import {
39 NOTIFY_VIEWER_HEADER,
40 identityClient,
41 type FeedDelivery,
42 type ServiceBinding,
43 type Viewer,
44} from "@g1t/contracts";
45
46import { FEED_USERNAME_HEADER, FEED_USER_ID_HEADER, Feed, type FeedEnv } from "./feed.ts";
47import { onlyPeople } from "./presence.ts";
48import { visitWorkspace } from "./visits.ts";
49import { byRepo, cleanRepoId, cleanRepoPath } from "./watch.ts";
50
51export { Feed } from "./feed.ts";
52export { Room } from "./room.ts";
53export { Topic } from "./topic.ts";
54
55type Env = FeedEnv & {
56 IDENTITY: ServiceBinding;
57 FEEDS: DurableObjectNamespace<Feed>;
58};
59
60function feed(env: Env, userId: string) {
61 return env.FEEDS.get(env.FEEDS.idFromName(userId));
62}
63
64/** A user id from the arguments, or one looked up by username. */
65async function userIdOf(env: Env, given: { user_id?: unknown; username?: unknown; target?: unknown }): Promise<string | null> {
66 // Who it's for, at the top level or under `target` as the agents service sends it.
67 const target = given.target && typeof given.target === "object" ? (given.target as { user_id?: unknown; username?: unknown }) : null;
68 const args = { user_id: given.user_id ?? target?.user_id, username: given.username ?? target?.username };
69 if (typeof args.user_id === "string" && args.user_id) return args.user_id;
70 if (typeof args.username !== "string" || !args.username) return null;
71 const user = await identityClient(env.IDENTITY)
72 .userByUsername(args.username)
73 .catch(() => null);
74 return user?.id ?? null;
75}
76
77/** The most deliveries in one call; chat sends one per person in the conversation. */
78const MAX_DELIVERIES = 1000;
79
80async function answer(env: Env, method: string, args: any): Promise<Response> {
81 if (method === "workspace_presence") {
82 // For services: how a workspace's people show now, as its room keeps them.
83 const slug = typeof args?.workspace === "string" ? args.workspace.trim().toLowerCase() : "";
84 if (!slug || !env.ROOMS) return Response.json([]);
85 const everyone = await env.ROOMS.get(env.ROOMS.idFromName(slug)).people();
86 return Response.json(onlyPeople(everyone, Array.isArray(args.user_ids) ? args.user_ids : null));
87 }
88 if (method === "repo_changed") {
89 // For services: each repository's changes to its topic, which tells its watchers.
90 const topics = env.TOPICS;
91 if (!topics) return Response.json({ ok: true });
92 const grouped = byRepo(args?.changes);
93 const results = await Promise.allSettled([...grouped].map(([id, changes]) => topics.get(topics.idFromName(id)).changed(id, changes)));
94 for (const result of results) if (result.status === "rejected") console.error("notify: a repository's change was not told", result.reason);
95 return Response.json({ ok: true });
96 }
97 if (method === "deliver") {
98 const items = (Array.isArray(args?.items) ? args.items : []).slice(0, MAX_DELIVERIES) as FeedDelivery[];
99 const byUser = new Map<string, FeedDelivery[]>();
100 for (const item of items) {
101 if (typeof item?.user_id !== "string" || !item.user_id) continue;
102 byUser.set(item.user_id, [...(byUser.get(item.user_id) ?? []), item]);
103 }
104 const results = await Promise.allSettled([...byUser].map(([id, mine]) => feed(env, id).deliver(mine)));
105 for (const result of results) if (result.status === "rejected") console.error("notify: a delivery failed", result.reason);
106 return Response.json({ ok: true });
107 }
108 const userId = await userIdOf(env, args ?? {});
109 if (!userId) return Response.json({ ok: false });
110 const stub = feed(env, userId);
111 switch (method) {
112 case "notify":
113 return Response.json(await stub.notify(args.notification));
114 case "set_inbox":
115 return Response.json(await stub.setInbox(Number(args.unread)));
116 case "subscribe":
117 return Response.json(await stub.subscribe(args.subscription, typeof args.user_agent === "string" ? args.user_agent : null));
118 case "unsubscribe":
119 return Response.json(await stub.unsubscribe(String(args.endpoint ?? "")));
120 case "register_device":
121 return Response.json(await stub.registerDevice(args.device));
122 case "unregister_device":
123 return Response.json(await stub.unregisterDevice(String(args.token ?? "")));
124 case "status":
125 return Response.json(await stub.status(typeof args.endpoint === "string" ? args.endpoint : null));
126 case "set_preferences":
127 return Response.json(await stub.setPreferences(args.preferences));
128 case "last_visit":
129 case "mark_visit": {
130 const workspace = visitWorkspace(args.workspace);
131 if (!workspace) return Response.json({ seen_at: null });
132 return Response.json(method === "last_visit" ? await stub.lastVisit(workspace) : await stub.markVisit(workspace, args.at));
133 }
134 case "watch_repo": {
135 const repoId = cleanRepoId(args.repo_id);
136 const repo = cleanRepoPath(args.repo);
137 if (!repoId || !repo) return Response.json({ ok: false, until: null });
138 return Response.json(await stub.watchRepo(userId, repoId, repo));
139 }
140 case "test":
141 return Response.json(await stub.test(typeof args.username === "string" ? args.username : ""));
142 case "presence":
143 return Response.json(await stub.own({ user_id: userId, username: typeof args.username === "string" ? args.username : "" }));
144 case "set_presence":
145 return Response.json(
146 await stub.setPresence({ user_id: userId, username: typeof args.username === "string" ? args.username : "" }, args.change ?? {}),
147 );
148 default:
149 return new Response("Unknown method\n", { status: 404 });
150 }
151}
152
153/**
154 * `GET /live`, upgraded: the viewer comes in NOTIFY_VIEWER_HEADER, set by
155 * the site after checking the session; trusted only because this Worker
156 * is reachable through service bindings alone.
157 */
158async function live(request: Request, env: Env): Promise<Response> {
159 if (request.headers.get("upgrade")?.toLowerCase() !== "websocket") {
160 return new Response("Expected a WebSocket upgrade\n", { status: 426 });
161 }
162 let viewer: Viewer = null;
163 try {
164 viewer = JSON.parse(request.headers.get(NOTIFY_VIEWER_HEADER) ?? "null") as Viewer;
165 } catch {
166 viewer = null;
167 }
168 if (!viewer?.id) return new Response("Sign in first\n", { status: 401 });
169 const headers = new Headers(request.headers);
170 headers.delete(NOTIFY_VIEWER_HEADER);
171 // Who the feed is for, so it can name them to the presence rooms.
172 headers.set(FEED_USER_ID_HEADER, viewer.id);
173 headers.set(FEED_USERNAME_HEADER, viewer.username);
174 return feed(env, viewer.id).fetch(new Request(request.url, { method: "GET", headers }));
175}
176
177export default {
178 async fetch(request: Request, env: Env): Promise<Response> {
179 const url = new URL(request.url);
180 if (request.method === "GET" && url.pathname === "/live") return live(request, env);
181 const match = url.pathname.match(/^\/rpc\/([a-z_]+)$/);
182 if (request.method !== "POST" || !match) return new Response("Not found\n", { status: 404 });
183 const args = (await request.json().catch(() => ({}))) as any;
184 return answer(env, match[1], args);
185 },
186} satisfies ExportedHandler<Env>;
187