@preventive/triage 1.0.0-alpha.3 → 1.0.0-alpha.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/LICENSE-APACHE +202 -0
  2. package/api/reap.ts +17 -0
  3. package/cli.js +6 -0
  4. package/client/finding-link.js +305 -0
  5. package/client/linked-findings.d.ts +1 -0
  6. package/client/linked-findings.js +111 -0
  7. package/common/bundle-commit.d.ts +1 -0
  8. package/common/bundle-commit.js +4 -0
  9. package/common/bundle-metadata.d.ts +10 -0
  10. package/common/bundle-metadata.js +182 -0
  11. package/common/bundle-reasons.d.ts +2 -0
  12. package/common/bundle-reasons.js +21 -0
  13. package/common/bundle-source-links.d.ts +5 -0
  14. package/common/bundle-source-links.js +82 -0
  15. package/common/bundle-sources.d.ts +3 -0
  16. package/common/bundle-sources.js +284 -0
  17. package/common/bundle-stats.js +41 -0
  18. package/common/bundle-tabs.js +1 -0
  19. package/common/code-language.js +51 -0
  20. package/common/default-scan-models.ts +30 -0
  21. package/common/finding-id.js +47 -0
  22. package/common/github-issue-labels.d.ts +1 -0
  23. package/common/github-issue-labels.js +11 -0
  24. package/common/github-pr.ts +56 -0
  25. package/common/managed/comments.ts +34 -0
  26. package/common/managed/permissions.ts +35 -0
  27. package/common/managed/report-content.ts +42 -0
  28. package/common/managed/report-filter.ts +108 -0
  29. package/common/managed/roles.ts +28 -0
  30. package/common/managed/routes.d.ts +2 -0
  31. package/common/managed/routes.js +124 -0
  32. package/common/managed/scan-models.ts +6 -0
  33. package/common/managed/triage.ts +83 -0
  34. package/common/save-error-reason.ts +20 -7
  35. package/common/scan-server.ts +13 -0
  36. package/common/server-info.ts +35 -0
  37. package/common/utf8.d.ts +3 -0
  38. package/common/utf8.js +45 -0
  39. package/out/brotli-fallback.js +3 -3
  40. package/out/client-managed-import.js +81 -0
  41. package/out/client-managed.js +167 -0
  42. package/out/client-sync.js +16 -13
  43. package/out/github-issue-authorized.html +3 -0
  44. package/out/github-issue-authorized.js +1 -0
  45. package/out/graph.js +30 -4
  46. package/out/index.html +55 -8
  47. package/out/prism.js +2 -2
  48. package/out/stasis.svg +20 -0
  49. package/out/terminal.js +273 -39
  50. package/out/view.css +1 -1
  51. package/out/view.js +259 -63
  52. package/package.json +205 -57
  53. package/server-common/database-config.ts +16 -0
  54. package/server-common/initialize.ts +18 -0
  55. package/server-common/npm-advisories.ts +101 -0
  56. package/{server → server-common}/origin.ts +5 -5
  57. package/server-common/reap.ts +48 -0
  58. package/server-common/scan-config.ts +19 -0
  59. package/server-common/standalone.ts +29 -0
  60. package/server-common/storage-crypto.ts +182 -0
  61. package/server-common/storage-log.ts +38 -0
  62. package/server-common/vercel-blob.ts +102 -0
  63. package/server-e2e/app.ts +486 -0
  64. package/{server → server-e2e}/auth.ts +5 -1
  65. package/{server → server-e2e}/bus-receiver.ts +2 -1
  66. package/{server → server-e2e}/cli.js +9 -4
  67. package/{server → server-e2e}/config.ts +56 -35
  68. package/{server → server-e2e}/db-neon.ts +2 -2
  69. package/{server → server-e2e}/db-revision-sql.ts +1 -1
  70. package/{server → server-e2e}/db-stmt.ts +2 -2
  71. package/{server → server-e2e}/db.ts +7 -7
  72. package/{server → server-e2e}/http.ts +110 -12
  73. package/{server → server-e2e}/hub.ts +40 -9
  74. package/server-e2e/index.ts +17 -0
  75. package/server-e2e/lifecycle.ts +95 -0
  76. package/{server → server-e2e}/neon-driver.ts +2 -2
  77. package/{server → server-e2e}/npm-proxy.ts +11 -144
  78. package/{server → server-e2e}/objstore/blob-fs.ts +2 -2
  79. package/{server → server-e2e}/objstore/blob-vercel.ts +13 -117
  80. package/{server → server-e2e}/objstore/blob.ts +9 -2
  81. package/server-e2e/objstore/fetch-mint-guard.ts +74 -0
  82. package/{server → server-e2e}/objstore/handlers.ts +9 -8
  83. package/{server → server-e2e}/objstore/init.ts +35 -18
  84. package/{server → server-e2e}/objstore/reaper.ts +31 -11
  85. package/server-e2e/objstore/rest-deny.ts +28 -0
  86. package/server-e2e/objstore/rest-mint.ts +224 -0
  87. package/{server → server-e2e}/objstore/rest.ts +58 -33
  88. package/{server → server-e2e}/objstore/sign.ts +105 -0
  89. package/{server → server-e2e}/objstore/store-neon.ts +6 -10
  90. package/{server → server-e2e}/objstore/store.ts +7 -7
  91. package/{server → server-e2e}/objstore/tokens.ts +1 -1
  92. package/{server → server-e2e}/pubsub.ts +12 -9
  93. package/{server → server-e2e}/sign.ts +4 -4
  94. package/{server → server-e2e}/sse-server.ts +102 -68
  95. package/{server → server-e2e}/sse-session.ts +28 -8
  96. package/{server → server-e2e}/static.ts +31 -21
  97. package/server-e2e/sync-handlers.ts +408 -0
  98. package/{server → server-e2e}/util.ts +9 -0
  99. package/{server → server-e2e}/ws-server.ts +20 -9
  100. package/server-managed/activity.ts +231 -0
  101. package/server-managed/avatar-store.ts +12 -0
  102. package/server-managed/blob-store.ts +17 -0
  103. package/server-managed/brotli.ts +10 -0
  104. package/server-managed/bundle-advisories.ts +53 -0
  105. package/server-managed/bundle-advisory-inventory.ts +75 -0
  106. package/server-managed/bundle-build-diagnostics.d.ts +10 -0
  107. package/server-managed/bundle-build-diagnostics.js +23 -0
  108. package/server-managed/bundle-build-leases.ts +41 -0
  109. package/server-managed/bundle-build-worker.js +54 -0
  110. package/server-managed/bundle-build.ts +168 -0
  111. package/server-managed/bundle-cache.ts +166 -0
  112. package/server-managed/bundle-catalog.ts +29 -0
  113. package/server-managed/bundle-store.ts +24 -0
  114. package/server-managed/bundle-summary-cache.ts +116 -0
  115. package/server-managed/bundle.ts +104 -0
  116. package/server-managed/cache-storage.ts +19 -0
  117. package/server-managed/cli.js +21 -0
  118. package/server-managed/combined.ts +46 -0
  119. package/server-managed/comments.ts +151 -0
  120. package/server-managed/config.ts +149 -0
  121. package/server-managed/content-access.ts +15 -0
  122. package/server-managed/crypto.ts +25 -0
  123. package/server-managed/db-methods.ts +1517 -0
  124. package/server-managed/db-neon.ts +277 -0
  125. package/server-managed/db-schema.ts +206 -0
  126. package/server-managed/db-table-names.ts +22 -0
  127. package/server-managed/db.ts +120 -0
  128. package/server-managed/github-app.ts +385 -0
  129. package/server-managed/github-errors.ts +49 -0
  130. package/server-managed/github-issue-oauth.ts +48 -0
  131. package/server-managed/github-issues.ts +152 -0
  132. package/server-managed/github-metadata.ts +98 -0
  133. package/server-managed/github-oauth.ts +199 -0
  134. package/server-managed/github-pulls.ts +227 -0
  135. package/server-managed/http-response.ts +18 -0
  136. package/server-managed/http.ts +2350 -0
  137. package/server-managed/import-triage.ts +51 -0
  138. package/server-managed/index.ts +175 -0
  139. package/server-managed/managed-issues.ts +47 -0
  140. package/server-managed/management-catalog.ts +45 -0
  141. package/server-managed/management.ts +86 -0
  142. package/server-managed/object-storage-disk.ts +144 -0
  143. package/server-managed/object-storage-vercel.ts +60 -0
  144. package/server-managed/object-storage.ts +71 -0
  145. package/server-managed/package-entry-points.ts +51 -0
  146. package/server-managed/public-workspace.ts +146 -0
  147. package/server-managed/repo-path.ts +21 -0
  148. package/server-managed/report-migration.ts +35 -0
  149. package/server-managed/report-query.ts +10 -0
  150. package/server-managed/report-response.ts +16 -0
  151. package/server-managed/report-sources.ts +166 -0
  152. package/server-managed/repository-browser.ts +139 -0
  153. package/server-managed/repository-discovery.ts +82 -0
  154. package/server-managed/repository-policy.ts +27 -0
  155. package/server-managed/revisions.ts +35 -0
  156. package/server-managed/session.ts +78 -0
  157. package/server-managed/slugs.ts +38 -0
  158. package/server-managed/solidity-entry-points.ts +69 -0
  159. package/server-managed/sql-postgres.ts +31 -0
  160. package/server-managed/sql.ts +72 -0
  161. package/server-managed/static.ts +28 -0
  162. package/server-managed/storage-command.ts +16 -0
  163. package/server-managed/storage-db.ts +175 -0
  164. package/server-managed/storage-encryption.ts +211 -0
  165. package/server-managed/storage-maintenance.ts +223 -0
  166. package/server-managed/storage-payload.ts +72 -0
  167. package/server-managed/storage-stores.ts +81 -0
  168. package/server-managed/storage.ts +58 -0
  169. package/server-managed/team-catalog.ts +7 -0
  170. package/server-managed/team-feed.ts +173 -0
  171. package/server-managed/team-reports.ts +219 -0
  172. package/server-managed/triage-response.ts +16 -0
  173. package/server-managed/uploads.ts +65 -0
  174. package/server-managed/workspace-shares.ts +162 -0
  175. package/server.ts +50 -0
  176. package/server/index.ts +0 -477
  177. package/server/lifecycle.ts +0 -204
  178. package/server/sync-handlers.ts +0 -320
  179. /package/{LICENSE → LICENSE-MIT} +0 -0
  180. /package/{server → server-e2e}/config.example.json +0 -0
  181. /package/{server → server-e2e}/objstore/fs.ts +0 -0
  182. /package/{server → server-e2e}/peer.ts +0 -0
  183. /package/{server → server-e2e}/validation.ts +0 -0
package/server/index.ts DELETED
@@ -1,477 +0,0 @@
1
- #!/usr/bin/env node
2
- // DeepView triage-sync relay server. WebSocket front-end, SQLite
3
- // backing store. Implements the protocol described in
4
- // `client/triage-sync.js` (and `server/sign.ts` for the canonical
5
- // signature payloads):
6
- //
7
- // server → client challenge { nonce } — emitted on every
8
- // accept, BEFORE any client
9
- // frame; per-socket random
10
- // 128-bit value the client
11
- // must bind into every
12
- // `workspace-subscribe`
13
- // signature (round-9 H2)
14
- // client → server workspace-save { workspaceTag, base,
15
- // keyframe, nonce, ciphertext,
16
- // signature } — `keyframe` is
17
- // a boolean (`true` exactly,
18
- // else falsy), bound into the
19
- // signed canonical
20
- // client → server workspace-subscribe { workspaceTag, from,
21
- // signature } — `from` is the
22
- // last revision id the client
23
- // claims to have applied (or
24
- // null for fresh)
25
- // client → server ping — heartbeat
26
- // server → client pong — heartbeat reply
27
- // server → client workspace-save-ack { workspaceTag, base, id }
28
- // server → client workspace-save-error { workspaceTag, base, reason }
29
- // — explicit failure surface for
30
- // the legit-signer case where
31
- // the server rejects a signed
32
- // save (e.g. `too-large` past
33
- // MAX_CIPHERTEXT_LEN). Sent
34
- // AFTER sig verify so the
35
- // response only reaches a
36
- // legitimate seed holder; shape
37
- // attacks still drop silently.
38
- // server → client workspace-subscribed { workspaceTag } — explicit
39
- // handshake-complete ack so
40
- // the client can flip its
41
- // status from `connecting` to
42
- // `online` only after the
43
- // server registered it as a
44
- // peer (not just on socket
45
- // open)
46
- // server → client workspace-state { workspaceTag, revisions:
47
- // [{ base, id, keyframe,
48
- // nonce, ciphertext,
49
- // signature }, ...] }
50
- //
51
- // Authentication: every signed message is checked against the
52
- // `workspaceTag` (= base64url Ed25519 public key) before any
53
- // state mutation. Unsigned / bad-sig messages are dropped silently
54
- // — the legitimate signer will retry, and an attacker who learns
55
- // the tag without holding the seed can't get past the verify.
56
- //
57
- // Content opacity: `nonce` and `ciphertext` are opaque to the
58
- // server. We store and forward them; we never inspect.
59
- //
60
- // Subscriber tracking: `subscribers: Map<workspaceTag, Set<socket>>`.
61
- // A socket joins the set ONLY via an explicit, signature-verified
62
- // `workspace-subscribe` (sole call site of `subscribe()` is in
63
- // `handleSubscribe`, gated by the per-connection challenge nonce
64
- // bound into the signature and a post-await `readyState` check).
65
- // It leaves on disconnect. Broadcasts go to every subscriber for
66
- // the workspaceTag except the originator.
67
- //
68
- // `workspace-save` deliberately does NOT auto-attach the sender,
69
- // even on a valid signature — see the audit note in `handleSave`
70
- // (round-9 H1): auto-subscribe-on-save let a passive observer
71
- // replay any captured save frame from any TCP connection to attach
72
- // as a silent mirror, since the duplicate-id path returns ack-only
73
- // and would not reject the attaching socket.
74
-
75
- import { type WebSocket, WebSocketServer } from 'ws'
76
- import { errMsg, errStack } from './util.ts'
77
- import type { PeerRegistry } from './peer.ts'
78
- import { LOOPBACK_HOSTS, createOriginGate } from './origin.ts'
79
- import { createHub } from './hub.ts'
80
- import { createAuth } from './auth.ts'
81
- import { createSyncHandlers } from './sync-handlers.ts'
82
- import { WS_UPGRADE_PATH, createHttpServer } from './http.ts'
83
- import { installWsServer } from './ws-server.ts'
84
- import { SSE_OPEN_PATH, installSseServer } from './sse-server.ts'
85
- import { createLifecycle } from './lifecycle.ts'
86
- import { loadConfig } from './config.ts'
87
- import { type Handle, openDb } from './db.ts'
88
- import { openNeonDb } from './db-neon.ts'
89
- import { initObjstore } from './objstore/init.ts'
90
- import { type Handle as ObjstoreHandle, listLive, objectMetaWire, openObjstore } from './objstore/store.ts'
91
- import { openNeonObjstore } from './objstore/store-neon.ts'
92
- import { openVercelBlobBackend } from './objstore/blob-vercel.ts'
93
- import {
94
- type NeonClientCtor, type PubSub,
95
- createNeonPubSub, createNoopPubSub,
96
- } from './pubsub.ts'
97
- import { createBusReceiver } from './bus-receiver.ts'
98
-
99
- // All external inputs (env vars + optional config.json) are parsed
100
- // and validated in ./config.ts; destructure into the uppercase names
101
- // the rest of this module uses.
102
- const config = loadConfig()
103
- const {
104
- port: PORT, host: HOST, dbPath: DB_PATH, objstoreDir: OBJSTORE_DIR,
105
- reapIntervalMs: OBJSTORE_REAP_INTERVAL_MS,
106
- maxInflightPerSocket: MAX_INFLIGHT_PER_SOCKET, debug: DEBUG,
107
- neonUrl: NEON_URL, blobToken: BLOB_TOKEN, tokenSecret: TOKEN_SECRET,
108
- password: CONFIG_PASSWORD, trustProxyEnv: TRUST_PROXY_ENV,
109
- } = config
110
-
111
- // Same-origin gate for the WS upgrade and REST data plane (see
112
- // ./origin.ts). `TRUST_PROXY_ENV` also feeds the boot-time
113
- // misconfiguration fail-fast below.
114
- const { trustProxy: TRUST_PROXY, isOriginAllowed } = createOriginGate(HOST, TRUST_PROXY_ENV)
115
-
116
- // Per-socket buffered-bytes cap. `socket.send` returns synchronously
117
- // even when the kernel/ws library can't drain to the wire fast
118
- // enough; the unsent payload accumulates in `bufferedAmount`. A
119
- // slow / blackholed peer on a high-volume workspace can hold many
120
- // MB of fan-out broadcasts in this buffer with no backpressure on
121
- // the broadcast loop. Drop the message when the buffer crosses the
122
- // cap; the heartbeat will eventually close a peer that never
123
- // drains. Transport audit `server/index.ts:225`.
124
- const MAX_BUFFERED_BYTES = 16 * 1024 * 1024
125
- // Per-socket in-flight async-handler cap (MAX_INFLIGHT_PER_SOCKET,
126
- // env-validated in config). Each inbound text frame spawns a
127
- // `track(handler)` IIFE; an authorised peer firing valid frames could
128
- // otherwise grow the set without bound, stretching SIGTERM drain time.
129
- // Saves dropped at the cap surface as a typed `busy` NACK. Transport
130
- // audit `server/index.ts:590`.
131
-
132
- // Per-connection state registry. One `Peer` per accepted socket holds
133
- // the challenge nonce, auth flag, heartbeat liveness, in-flight count,
134
- // and subscribed tags (see ./peer.ts). The connection handler holds
135
- // the Peer in a closure for the hot paths; cross-function call sites
136
- // resolve it via `peers.get(socket)`.
137
- const peers: PeerRegistry = new WeakMap()
138
-
139
- // REST PUT idle-body timeout. A slow-loris client trickling bytes
140
- // within the declared Content-Length holds the staging fd and an
141
- // inFlightSids slot until the global staging TTL reaps it. Aborting
142
- // the per-chunk-idle period closes that window. Transport audit
143
- // `server/objstore/rest.ts:218`.
144
- const REST_PUT_IDLE_TIMEOUT_MS = 30_000
145
-
146
- // Server-driven WS heartbeat. Every `HEARTBEAT_INTERVAL_MS` we walk
147
- // `wss.clients`, terminate anyone who didn't pong since the last
148
- // tick, and ping the rest. The client-initiated `{type:'ping'}` /
149
- // `{type:'pong'}` JSON heartbeat the protocol already had only
150
- // catches the case where the CLIENT notices the socket's gone — it
151
- // can't recover an FD when the client itself has wandered off
152
- // (battery-killed background tab, mid-transfer NAT timeout, a
153
- // hostile non-browser client that opens the socket and never
154
- // speaks again). The same-origin upgrade gate allows missing
155
- // Origin headers through (legitimate non-browser callers), so a
156
- // hostile CLI can stack arbitrarily many idle sockets without it.
157
- // Kernel TCP keepalive is hours by default; without this interval
158
- // each abandoned socket pins its `wss.clients` Set entry, its `Peer`
159
- // state, and an FD until the kernel reclaims it. Two ticks max
160
- // from silence to termination, so the longest a dead socket
161
- // survives is ~2 × HEARTBEAT_INTERVAL_MS.
162
- const HEARTBEAT_INTERVAL_MS = 30_000
163
-
164
- // Backend selection. Both planes (workspace_revision DB + the
165
- // v1.objstore byte store) are picked from config at boot. Two
166
- // supported pairings:
167
- // 1. DATABASE_URL set → Neon (workspace_revision + objstore
168
- // tables) + Vercel Blob Private Storage (bytes). Requires
169
- // BLOB_READ_WRITE_TOKEN — fail fast at boot if missing, since
170
- // a local-FS byte plane can't back a multi-replica deployment
171
- // (one replica's writes wouldn't be visible to another).
172
- // 2. DATABASE_URL absent → SQLite + local FS bytes. Single-
173
- // process; the only pairing the SQLite plane supports.
174
- // The Neon / Vercel files import their peer deps lazily inside the
175
- // open functions, so static imports here are safe even on a SQLite-
176
- // only install where the optional peer deps aren't present. Explicit
177
- // branch (not a ternary) so the SQLite path keeps its `SqliteHandle`
178
- // narrowing — `sqliteHandle.db` is a non-optional `DatabaseSync` that
179
- // `openObjstore` accepts without a non-null assertion.
180
- let handle: Handle
181
- let objstoreHandle: ObjstoreHandle
182
- let objstoreBanner: string
183
- if (NEON_URL) {
184
- if (!BLOB_TOKEN) {
185
- console.error('DATABASE_URL is set but BLOB_READ_WRITE_TOKEN is not.')
186
- console.error('The Neon DB plane requires the Vercel Blob byte plane (local-FS bytes cannot back a multi-replica deployment).')
187
- console.error('Set BLOB_READ_WRITE_TOKEN to your Vercel Blob R/W token, or unset DATABASE_URL to fall back to SQLite + local FS.')
188
- process.exit(1)
189
- }
190
- if (!TOKEN_SECRET) {
191
- console.error('DATABASE_URL is set but OBJSTORE_TOKEN_SECRET is not.')
192
- console.error('Multi-replica deployments need a shared HMAC secret so REST bearer tokens minted on one replica validate on any other.')
193
- console.error('Generate one with: node -e \'console.log(require("crypto").randomBytes(32).toString("base64"))\'')
194
- process.exit(1)
195
- }
196
- handle = await openNeonDb(NEON_URL)
197
- const blob = await openVercelBlobBackend({ token: BLOB_TOKEN })
198
- objstoreHandle = await openNeonObjstore(NEON_URL, blob)
199
- objstoreBanner = 'objstore: vercel-blob (private)'
200
- } else {
201
- const sqliteHandle = openDb(DB_PATH)
202
- handle = sqliteHandle
203
- objstoreHandle = openObjstore(sqliteHandle.db, OBJSTORE_DIR)
204
- objstoreBanner = `objstore: ${OBJSTORE_DIR}`
205
- }
206
- // Multi-replica deployments behind a load balancer / TLS terminator
207
- // (the typical Vercel + Neon shape) need TRUST_PROXY=1 to honour
208
- // X-Forwarded-Host when computing the same-origin gate's expected
209
- // origin. Otherwise the gate derives the origin from the internal
210
- // container hostname and rejects every browser request as a
211
- // cross-origin attempt — silently from the operator's perspective
212
- // until users report 403s. Fail fast (parallels the
213
- // BLOB_READ_WRITE_TOKEN / OBJSTORE_TOKEN_SECRET checks above) so
214
- // a misconfigured deploy doesn't ship a 100%-403 fleet. An
215
- // operator who genuinely terminates TLS in the container without
216
- // X-Forwarded-* (rare) can set `TRUST_PROXY=0` to acknowledge.
217
- if (NEON_URL && !TRUST_PROXY && !LOOPBACK_HOSTS.has(HOST) && TRUST_PROXY_ENV !== '0' && TRUST_PROXY_ENV !== 'false') {
218
- console.error(`DATABASE_URL is set and HOST=${HOST} is not loopback, but TRUST_PROXY is not enabled.`)
219
- console.error('Browser requests through a load balancer / TLS terminator will be rejected by the same-origin gate (all 403).')
220
- console.error('Set TRUST_PROXY=1 to honour X-Forwarded-Host / X-Forwarded-Proto from the upstream proxy.')
221
- console.error('Set TRUST_PROXY=0 if you really terminate TLS in the container without X-Forwarded-* headers (no proxy).')
222
- process.exit(1)
223
- }
224
-
225
- // "Workspace exists on the server" gate. The auth requirement only
226
- // kicks in for the FIRST action against a never-before-seen tag —
227
- // once any row lands (triage revision or objstore object), the
228
- // workspace is considered established and signature-gated. Checks
229
- // both planes so the gate stays consistent regardless of which
230
- // action the user picks first (workspace-save in the common case;
231
- // objstore-put-begin for a bundle-first flow).
232
- async function workspaceExists(tag: string): Promise<boolean> {
233
- if (await handle.headFor.get(tag)) return true
234
- const c = await objstoreHandle.countLive.get(tag)
235
- return (c?.c ?? 0) > 0
236
- }
237
-
238
- // WS fan-out hub: subscriber registry + backpressure-aware send /
239
- // broadcast (see ./hub.ts).
240
- const hub = createHub({ peers, maxBufferedBytes: MAX_BUFFERED_BYTES, debug: DEBUG })
241
- const { send, broadcast, subscribe, unsubscribeAll, broadcastLocalRaw } = hub
242
-
243
- // Cross-instance pub/sub for live broadcasts (see ./pubsub.ts). SQLite
244
- // mode is single-process by construction so it gets a no-op; Neon mode
245
- // uses Postgres LISTEN/NOTIFY on a dedicated long-lived Client
246
- // connection (separate from the HTTP `neon()` callable the queries flow
247
- // over — LISTEN needs a session-bound socket, the HTTP path is
248
- // stateless). The bus carries lookup hints, not the full wire payload:
249
- // the `workspace-state` broadcast's ciphertext alone can exceed the
250
- // ~8 KB NOTIFY payload cap, so the receiver re-fetches from the shared
251
- // DB to construct the wire frame. The bus is best-effort fan-out, not a
252
- // durability layer — the DB itself is the source of truth, and a
253
- // dropped publish only means peers on other instances miss the live
254
- // push (they still catch up via the chain on their next subscribe).
255
- let pubsub: PubSub = createNoopPubSub()
256
- if (NEON_URL) {
257
- // Dynamic import: the Client export lives in the same optional peer
258
- // dep as the HTTP `neon()` callable (see ./neon-driver.ts), but the
259
- // dep itself is only present on a Neon-mode deploy. The wrapper path
260
- // also lets tests swap in a PGlite-backed shim (`tests/pubsub.test.js`).
261
- const mod = (await import('./neon-driver.ts')) as unknown as { Client?: NeonClientCtor }
262
- if (!mod.Client) {
263
- console.error('DATABASE_URL is set but the @neondatabase/serverless Client export is not available.')
264
- console.error('Cross-instance broadcasts require the WebSocket-based Client (the HTTP `neon()` callable cannot LISTEN).')
265
- console.error('Reinstall the peer dep: pnpm add @neondatabase/serverless')
266
- process.exit(1)
267
- }
268
- const NeonClientImpl = mod.Client
269
- pubsub = createNeonPubSub({
270
- newClient: () => new NeonClientImpl(NEON_URL),
271
- debug: DEBUG,
272
- })
273
- }
274
-
275
- // Password gate (see ./auth.ts) — HMAC derivation + the `authenticate`
276
- // handshake.
277
- const auth = createAuth({ peers, password: CONFIG_PASSWORD, send, debug: DEBUG })
278
- const { requiresAuth, handleAuthenticate, sendUnauthorized } = auth
279
-
280
- // Triage-sync protocol handlers (see ./sync-handlers.ts). `getNonce`
281
- // resolves a socket's challenge nonce and is shared with the objstore
282
- // wiring below; `sendSaveError` is reused by the dispatcher's `busy`
283
- // inflight-cap NACK path.
284
- const getNonce = (socket: WebSocket): string | undefined => peers.get(socket)?.challenge
285
- const publishRevision = (tag: string, revisionId: string): void => {
286
- pubsub.publish({ kind: 'rev', tag, id: revisionId })
287
- }
288
- const publishObjPut = (tag: string, resourceTag: string): void => {
289
- pubsub.publish({ kind: 'objput', tag, res: resourceTag })
290
- }
291
- const publishObjDeleted = (tag: string, resourceTag: string, version: number): void => {
292
- pubsub.publish({ kind: 'objdel', tag, res: resourceTag, ver: version })
293
- }
294
-
295
- const { handleSave, handleSubscribe, sendSaveError } = createSyncHandlers({
296
- handle, send, broadcast, publishRevision, subscribe, getNonce,
297
- requiresAuth, sendUnauthorized, workspaceExists,
298
- // Folds the objstore inventory into the `workspace-subscribed` ack.
299
- // The objstore store keeps its own richer `Handle`, so we wire the
300
- // query here where both handles exist rather than coupling
301
- // sync-handlers to the store type.
302
- objstoreResources: async (tag) => (await listLive(objstoreHandle, tag)).map(objectMetaWire),
303
- debug: DEBUG,
304
- })
305
-
306
- const { handlers: objstore, restDeps: objstoreRestDeps, startupReap, stopReaper } = initObjstore({
307
- handle: objstoreHandle, reapIntervalMs: OBJSTORE_REAP_INTERVAL_MS,
308
- send, broadcast, publishObjPut, publishObjDeleted,
309
- getNonce, debug: DEBUG,
310
- // Auth gate for the FIRST objstore-put-begin against a workspace
311
- // that doesn't yet exist on the server. Mirrors handleSave's gate
312
- // below; handlers.ts calls this AFTER sig verify so the
313
- // `unauthorized` frame only reaches a legitimate signer. Returns
314
- // `false` to allow, `true` to deny — handlers.ts emits the
315
- // `unauthorized` frame and bails on `true`.
316
- authGate: async (socket, tag) => requiresAuth(socket) && !await workspaceExists(tag),
317
- sendUnauthorized,
318
- // `tokenSecret` is set only when OBJSTORE_TOKEN_SECRET was
319
- // provided in env (see TOKEN_SECRET resolution above). Omitted
320
- // → initObjstore mints a fresh per-process secret (fine for
321
- // single-replica).
322
- ...(TOKEN_SECRET ? { tokenSecret: TOKEN_SECRET } : {}),
323
- })
324
-
325
- // 4 MiB cap leaves headroom above MAX_CIPHERTEXT_LEN (2 MiB) for
326
- // the JSON envelope + base64 overhead. `ws` defaults to 100 MiB
327
- // which any unauthenticated peer could spam — every connection
328
- // accepts and JSON.parses up to that before the signature-fail drops
329
- // the frame.
330
- const wss = new WebSocketServer({ noServer: true, maxPayload: 4 * 1024 * 1024 })
331
-
332
- // Process lifecycle (see ./lifecycle.ts): `track` (in-flight request
333
- // drain) and `isShuttingDown` (the new-work gate) are consumed by the
334
- // HTTP + WS planes below; the teardown is `installLifecycle`d once
335
- // every server object exists.
336
- const { track, isShuttingDown, install: installLifecycle } = createLifecycle()
337
-
338
- // Shared per-connection dispatch surface. Both the WS plane
339
- // (installWsServer below) and the SSE+POST fallback (installSseServer
340
- // below) drive `setupPeerConnection` with this; one Peer per accepted
341
- // connection, one message-handler tree.
342
- const peerConnectionDeps = {
343
- peers, send, unsubscribeAll,
344
- handleSave, handleSubscribe, handleAuthenticate, sendSaveError, objstore,
345
- track, isShuttingDown,
346
- maxInflightPerSocket: MAX_INFLIGHT_PER_SOCKET,
347
- debug: DEBUG,
348
- }
349
-
350
- // SSE+POST fallback transport (see ./sse-server.ts). The WS upgrade is
351
- // the preferred path; clients fall back to SSE when `new WebSocket(…)`
352
- // fails to open (corporate proxies that strip the Upgrade header,
353
- // hostile network middleboxes, etc.). Same protocol on the wire — only
354
- // the byte transport differs.
355
- const sseServer = installSseServer({
356
- peerDeps: peerConnectionDeps, isShuttingDown,
357
- // Same cap shape as `wss` (no explicit per-process cap; OS FD limits
358
- // are the upstream bound). 1024 leaves room above the typical web
359
- // session count without being a soft DoS hammer.
360
- maxSessions: 1024,
361
- // Mirror the WS `maxPayload` so the SSE plane can't accept frames
362
- // the WS plane would reject.
363
- maxBodyBytes: 4 * 1024 * 1024,
364
- // 90s idle ceiling. The client's JSON ping/pong is 15s; this is ~6
365
- // missed pings before we close — well past any transient network
366
- // hiccup, much shorter than the kernel's hours-long TCP keepalive.
367
- sessionIdleMs: 90_000,
368
- debug: DEBUG,
369
- })
370
-
371
- // HTTP plane: REST byte-transfer routing + SSE fallback + the WS
372
- // upgrade gate (see ./http.ts). Built after the lifecycle state above
373
- // because the REST shutdown gate reads `shuttingDown` and the request
374
- // drain uses `track`. The WS connection handler is wired on `wss`
375
- // below.
376
- const httpServer = createHttpServer({
377
- wss, restDeps: objstoreRestDeps, sseServer, isOriginAllowed,
378
- isShuttingDown, track,
379
- restPutIdleTimeoutMs: REST_PUT_IDLE_TIMEOUT_MS, debug: DEBUG,
380
- })
381
-
382
- // WS runtime: per-connection handler + message dispatch + heartbeat
383
- // sweep (see ./ws-server.ts). Returns the heartbeat timer so shutdown
384
- // can clear it.
385
- const { heartbeatTimer } = installWsServer({
386
- wss, heartbeatIntervalMs: HEARTBEAT_INTERVAL_MS,
387
- ...peerConnectionDeps,
388
- })
389
-
390
- httpServer.on('listening', () => {
391
- // Read the actual bound port from `httpServer.address()` rather
392
- // than the `PORT` env constant. Operators (and the test harness)
393
- // can boot with `PORT=0` to get an OS-assigned ephemeral port;
394
- // the log line then carries the real bound number, not `0`.
395
- // Server-side bind failure took the error path above, so
396
- // `address()` is always a populated AddressInfo here.
397
- const addr = httpServer.address()
398
- const boundPort = typeof addr === 'object' && addr ? addr.port : PORT
399
- // Differentiate the storage banner by backend so the log line
400
- // doesn't claim a misleading DB_PATH under Neon, or a misleading
401
- // OBJSTORE_DIR under Vercel Blob.
402
- const dbBanner = NEON_URL ? 'db: neon-postgres' : `db: ${DB_PATH}`
403
- console.log(`DeepView triage-sync server: ws://${HOST}:${boundPort}${WS_UPGRADE_PATH} (sse fallback http://${HOST}:${boundPort}${SSE_OPEN_PATH}) http://${HOST}:${boundPort}/api/objstore/{workspaceTag}/{resourceTag} (${dbBanner}, ${objstoreBanner})`)
404
- })
405
-
406
- // Cross-instance bus receiver (see ./bus-receiver.ts): a remote NOTIFY
407
- // lands here, we re-fetch any data the bus payload only hinted at,
408
- // then broadcast to local peers via `broadcastLocalRaw`. Extracted so
409
- // the rev / objput / objdel mapping (including the keyframe boolean
410
- // coercion and the `objectMetaWire` shape) is testable without the
411
- // full server bring-up.
412
- const onBusMessage = createBusReceiver({
413
- handle, objstoreHandle, broadcastLocalRaw, debug: DEBUG,
414
- })
415
-
416
- // Kick off the LISTEN loop in the background. `pubsub.start` resolves
417
- // only after the FIRST successful connect, and the internal reconnect
418
- // loop retries indefinitely on transport / LISTEN failure — awaiting
419
- // it here would convert a transient Neon WS hiccup at boot into a
420
- // server that never binds (and a `.catch` that never runs). Instead
421
- // the server binds immediately and the bus comes up async; publishes
422
- // during the down window drop silently (best-effort semantics
423
- // documented in pubsub.ts). The SQLite no-op resolves immediately,
424
- // so the behaviour is identical in that mode.
425
- void pubsub.start(onBusMessage).catch((err) => {
426
- console.warn('pubsub: startup error:', errStack(err))
427
- })
428
-
429
- // App-specific shutdown step (run after the in-flight drain), wired
430
- // into the lifecycle teardown below.
431
- const closeDb = async (): Promise<void> => {
432
- // Stop the bus first so a publish from a still-draining handler
433
- // can't fire into a half-closed Client. The in-flight drain runs
434
- // before this (see lifecycle.ts), so by here all `broadcast` →
435
- // `publish*` calls are settled.
436
- try { await pubsub.stop() } catch (err) { console.warn('pubsub close error:', errMsg(err)) }
437
- // objstoreHandle has no close(): SQLite shares this DatabaseSync and
438
- // Neon has no persistent connection; `handle.close()` covers both.
439
- try { await handle.close() } catch (err) { console.warn('DB close error:', errMsg(err)) }
440
- }
441
- // Wire graceful shutdown + the signal / error / process-catchall
442
- // handlers (see ./lifecycle.ts). Installed last, once httpServer, wss,
443
- // and the heartbeat timer all exist.
444
- installLifecycle({
445
- httpServer, wss, heartbeatTimer, stopReaper,
446
- sseSessions: sseServer.sessions,
447
- closeDb,
448
- })
449
-
450
- // Bind only after the startup orphan sweep finishes — otherwise a
451
- // fresh boot could serve traffic against tags whose on-disk state
452
- // still has residue from a prior crash. `startupReap` already
453
- // resolves on any error (the reaper's own catch logs the failure
454
- // unconditionally and returns void), so no outer `.catch` is
455
- // needed here.
456
- await startupReap
457
-
458
- // Bind the HTTP/WS plane on the configured PORT/HOST. Exported so a
459
- // launcher (server/cli.js — the triage-server bin) or any `import`er can
460
- // start serving. The top-level `await startupReap` above means the server
461
- // is fully ready — DB open, DDL bootstrapped, objstore reaper swept — by
462
- // the time the import resolves.
463
- export function start(): void {
464
- httpServer.listen(PORT, HOST)
465
- }
466
-
467
- export { httpServer, wss }
468
-
469
- // Library mode: when this module is `import`ed (rather than run as the
470
- // entry script) skip the auto-start so consumers can own the bind — e.g.
471
- // wrap CF Access / framework-preset shims around the assembled
472
- // `httpServer`, or just call `start()` when ready. Direct invocation via
473
- // `node server/index.ts` (or the `triage-server` bin) still listens.
474
- if (import.meta.main) {
475
- start()
476
- }
477
-