@open-pencil/cloud 0.17.0-beta.2 → 0.17.0-beta.5

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 (339) hide show
  1. package/README.md +3 -2
  2. package/dist/bin/server.mjs +1 -1
  3. package/dist/bin/server.mjs.map +1 -1
  4. package/dist/bin/{ai-relay.mjs → services.mjs} +9 -9
  5. package/dist/bin/services.mjs.map +1 -0
  6. package/dist/client.d.ts +525 -66
  7. package/dist/client.d.ts.map +1 -1
  8. package/dist/client.js +1257 -654
  9. package/dist/client.js.map +1 -1
  10. package/dist/contract.d.ts +2 -2
  11. package/dist/contract.js +2 -2
  12. package/dist/contract2.js +1028 -481
  13. package/dist/contract2.js.map +1 -1
  14. package/dist/email.d.ts +1780 -31
  15. package/dist/email.d.ts.map +1 -1
  16. package/dist/email.js +3556 -325
  17. package/dist/email.js.map +1 -1
  18. package/dist/errors.d.ts +2 -0
  19. package/dist/errors.js +48 -0
  20. package/dist/errors.js.map +1 -0
  21. package/dist/index.d.ts +929 -72
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index2.d.ts +35 -0
  24. package/dist/index2.d.ts.map +1 -0
  25. package/dist/listen.mjs +802 -927
  26. package/dist/listen.mjs.map +1 -1
  27. package/dist/runtime-cloudflare.d.ts +89 -0
  28. package/dist/runtime-cloudflare.d.ts.map +1 -0
  29. package/dist/runtime-cloudflare.js +15667 -0
  30. package/dist/runtime-cloudflare.js.map +1 -0
  31. package/dist/runtime-node.d.mts +7166 -3101
  32. package/dist/runtime-node.d.mts.map +1 -1
  33. package/dist/runtime-node.mjs +6 -5
  34. package/dist/runtime-node.mjs.map +1 -1
  35. package/dist/server.d.ts +6525 -2205
  36. package/dist/server.d.ts.map +1 -1
  37. package/dist/server.js +12500 -7613
  38. package/dist/server.js.map +1 -1
  39. package/dist/server.mjs +8625 -2878
  40. package/dist/server.mjs.map +1 -1
  41. package/dist/server2.mjs +101 -79
  42. package/dist/server2.mjs.map +1 -1
  43. package/package.json +27 -9
  44. package/src/admin/api/routes.ts +59 -0
  45. package/src/admin/audit/service.ts +27 -8
  46. package/src/admin/documents/service.ts +431 -0
  47. package/src/admin/errors.ts +9 -1
  48. package/src/admin/index.ts +6 -0
  49. package/src/admin/operations/service.ts +7 -0
  50. package/src/admin/reports/service.ts +153 -0
  51. package/src/admin/schema.ts +6 -0
  52. package/src/client/api.ts +28 -461
  53. package/src/client/auth/client.ts +22 -3
  54. package/src/client/auth/navigation.ts +6 -5
  55. package/src/client/billing.ts +80 -0
  56. package/src/client/community.ts +40 -0
  57. package/src/client/discovery.ts +35 -9
  58. package/src/client/documents.ts +160 -0
  59. package/src/client/index.ts +14 -7
  60. package/src/client/portal/account.ts +79 -2
  61. package/src/client/portal/administration.ts +56 -0
  62. package/src/client/portal/request.ts +2 -0
  63. package/src/client/response.ts +21 -0
  64. package/src/client/schema.ts +8 -0
  65. package/src/client/services.ts +118 -0
  66. package/src/client/sharing.ts +262 -0
  67. package/src/client/versions.ts +104 -0
  68. package/src/contract/account.ts +108 -2
  69. package/src/contract/admin/index.ts +67 -3
  70. package/src/contract/billing.ts +166 -0
  71. package/src/contract/collaboration.ts +11 -1
  72. package/src/contract/community.ts +60 -0
  73. package/src/contract/discovery.ts +83 -4
  74. package/src/contract/documents.ts +27 -0
  75. package/src/contract/entitlements.ts +12 -2
  76. package/src/contract/index.ts +114 -39
  77. package/src/contract/links.ts +57 -4
  78. package/src/contract/locale.ts +27 -0
  79. package/src/contract/portal.ts +12 -1
  80. package/src/contract/relay.ts +6 -0
  81. package/src/contract/reports.ts +42 -0
  82. package/src/contract/routes.ts +10 -0
  83. package/src/contract/services.ts +235 -0
  84. package/src/contract/sharing.ts +3 -9
  85. package/src/email/i18n.ts +174 -0
  86. package/src/email/index.ts +13 -2
  87. package/src/email/locales/ar.json +141 -0
  88. package/src/email/locales/de.json +141 -0
  89. package/src/email/locales/es.json +141 -0
  90. package/src/email/locales/fr.json +141 -0
  91. package/src/email/locales/it.json +141 -0
  92. package/src/email/locales/ja.json +141 -0
  93. package/src/email/locales/pl.json +141 -0
  94. package/src/email/locales/pt-br.json +141 -0
  95. package/src/email/locales/ru.json +141 -0
  96. package/src/email/locales/zh-cn.json +141 -0
  97. package/src/email/messages.ts +200 -0
  98. package/src/email/render.ts +138 -246
  99. package/src/email/samples.ts +115 -0
  100. package/src/email/schema.ts +79 -5
  101. package/src/email/templates/BrandEmail.vue +54 -0
  102. package/src/email/templates/DocumentBlocked.vue +45 -0
  103. package/src/email/templates/DocumentInvitation.vue +24 -0
  104. package/src/email/templates/DocumentReport.vue +32 -0
  105. package/src/email/templates/DocumentReportDecided.vue +36 -0
  106. package/src/email/templates/DocumentReportReceived.vue +18 -0
  107. package/src/email/templates/DocumentRestored.vue +24 -0
  108. package/src/email/templates/EmailChangeRequested.vue +24 -0
  109. package/src/email/templates/EmailRoot.vue +19 -0
  110. package/src/email/templates/EmailText.vue +9 -0
  111. package/src/email/templates/EmailVerification.vue +38 -0
  112. package/src/email/templates/EnrollmentNotification.vue +24 -0
  113. package/src/email/templates/EnrollmentUpdate.vue +52 -0
  114. package/src/email/templates/NewSignIn.vue +37 -0
  115. package/src/email/templates/PasswordChanged.vue +22 -0
  116. package/src/email/templates/PasswordReset.vue +23 -0
  117. package/src/email/templates/StorageLimitReached.vue +28 -0
  118. package/src/email/templates/TwoStepChanged.vue +32 -0
  119. package/src/email/templates/WaitlistConfirmation.vue +29 -0
  120. package/src/email/templates/WorkspaceInvitation.vue +28 -0
  121. package/src/email/templates/brand.ts +9 -61
  122. package/src/email/templates/localization.ts +17 -0
  123. package/src/errors/index.ts +6 -0
  124. package/src/errors/posthog.ts +80 -0
  125. package/src/global.d.ts +7 -0
  126. package/src/runtime/cloudflare/environment.ts +22 -11
  127. package/src/runtime/cloudflare/index.ts +1 -1
  128. package/src/runtime/cloudflare/logging.ts +15 -0
  129. package/src/runtime/cloudflare/maintenance.ts +31 -0
  130. package/src/runtime/cloudflare/relay/index.ts +69 -15
  131. package/src/runtime/cloudflare/tsconfig.json +2 -1
  132. package/src/runtime/cloudflare/worker.ts +46 -13
  133. package/src/runtime/node/application.ts +5 -3
  134. package/src/runtime/node/bootstrap.ts +15 -4
  135. package/src/runtime/node/cleanup.ts +20 -3
  136. package/src/runtime/node/email/transport.ts +13 -10
  137. package/src/runtime/node/entitlements/main.ts +14 -11
  138. package/src/runtime/node/index.ts +1 -1
  139. package/src/runtime/node/main.ts +1 -1
  140. package/src/runtime/node/migrate.ts +5 -1
  141. package/src/runtime/node/relay.ts +8 -2
  142. package/src/runtime/node/request-id.ts +13 -0
  143. package/src/runtime/node/server.ts +50 -16
  144. package/src/runtime/node/{ai-relay → services}/main.ts +7 -7
  145. package/src/runtime/node/{ai-relay → services}/server.ts +18 -18
  146. package/src/runtime/postgres/database.ts +20 -1
  147. package/src/runtime/posthog/errors.ts +15 -30
  148. package/src/runtime/s3/objects.ts +41 -1
  149. package/src/runtime/site/community.ts +101 -0
  150. package/src/runtime/site/server.ts +49 -6
  151. package/src/server/account/actions.ts +5 -0
  152. package/src/server/account/deletion.ts +304 -0
  153. package/src/server/account/routes.ts +281 -206
  154. package/src/server/account/terms.ts +42 -0
  155. package/src/server/account/tokens.ts +57 -0
  156. package/src/server/api/router.ts +32 -5
  157. package/src/server/api/types.ts +2 -0
  158. package/src/server/app/checks.ts +84 -0
  159. package/src/server/app/editors.ts +20 -0
  160. package/src/server/app/index.ts +128 -0
  161. package/src/server/app/indexing.ts +40 -0
  162. package/src/server/app/limiters.ts +53 -0
  163. package/src/server/app/routes.ts +114 -0
  164. package/src/server/app/services.ts +185 -0
  165. package/src/server/auth/access-control.ts +63 -0
  166. package/src/server/auth/access-tokens.ts +62 -0
  167. package/src/server/auth/adapter.ts +32 -1
  168. package/src/server/auth/email.ts +4 -1
  169. package/src/server/auth/endpoints.ts +5 -1
  170. package/src/server/auth/enrollment.ts +116 -0
  171. package/src/server/auth/factory.ts +116 -132
  172. package/src/server/auth/index.ts +10 -1
  173. package/src/server/auth/logger.ts +23 -0
  174. package/src/server/auth/mfa-assurance.ts +51 -0
  175. package/src/server/auth/passwords.ts +43 -0
  176. package/src/server/auth/session.ts +2 -0
  177. package/src/server/billing/index.ts +6 -0
  178. package/src/server/billing/routes.ts +27 -0
  179. package/src/server/billing/tokens.ts +37 -0
  180. package/src/server/cleanup/configured.ts +27 -7
  181. package/src/server/cleanup/documents.ts +165 -71
  182. package/src/server/cleanup/revisions.ts +16 -5
  183. package/src/server/cleanup/uploads.ts +8 -2
  184. package/src/server/cleanup/worker.ts +15 -3
  185. package/src/server/collaboration/relay/connection.ts +4 -3
  186. package/src/server/collaboration/relay/documents.ts +13 -10
  187. package/src/server/collaboration/relay/hub.ts +77 -122
  188. package/src/server/collaboration/relay/log.ts +5 -2
  189. package/src/server/collaboration/relay/room.ts +154 -0
  190. package/src/server/collaboration/service.ts +48 -33
  191. package/src/server/community/index.ts +2 -0
  192. package/src/server/community/routes.ts +93 -0
  193. package/src/server/community/service.ts +134 -0
  194. package/src/server/config/deployment.ts +41 -9
  195. package/src/server/config/index.ts +1 -1
  196. package/src/server/config/public.ts +11 -4
  197. package/src/server/config/schema.ts +91 -277
  198. package/src/server/config/toml/schema.ts +307 -0
  199. package/src/server/db/expressions.ts +15 -1
  200. package/src/server/db/index.ts +1 -0
  201. package/src/server/db/migrate.ts +46 -116
  202. package/src/server/db/migrations/001_accounts.ts +79 -0
  203. package/src/server/db/migrations/002_workspaces.ts +48 -0
  204. package/src/server/db/migrations/003_storage.ts +44 -0
  205. package/src/server/db/migrations/004_documents.ts +193 -0
  206. package/src/server/db/migrations/005_sharing.ts +95 -0
  207. package/src/server/db/migrations/006_operations.ts +110 -0
  208. package/src/server/db/migrations/007_trash.ts +33 -0
  209. package/src/server/db/migrations/008_terms.ts +18 -0
  210. package/src/server/db/migrations/009_access_tokens.ts +47 -0
  211. package/src/server/db/migrations/010_storage_limit_notices.ts +50 -0
  212. package/src/server/db/migrations/011_account_ids.ts +30 -0
  213. package/src/server/db/migrations/012_email_locales.ts +34 -0
  214. package/src/server/db/migrations/013_document_block_emails.ts +40 -0
  215. package/src/server/db/migrations/014_report_replies.ts +28 -0
  216. package/src/server/db/migrations/schema.ts +96 -0
  217. package/src/server/db/tables.ts +82 -4
  218. package/src/server/db/users.ts +22 -0
  219. package/src/server/documents/access.ts +66 -55
  220. package/src/server/documents/errors.ts +7 -0
  221. package/src/server/documents/images.ts +2 -1
  222. package/src/server/documents/index.ts +1 -1
  223. package/src/server/documents/limits.ts +14 -8
  224. package/src/server/documents/purge.ts +75 -0
  225. package/src/server/documents/repository.ts +2 -0
  226. package/src/server/documents/routes.ts +26 -0
  227. package/src/server/documents/service.ts +30 -406
  228. package/src/server/documents/summary.ts +1 -0
  229. package/src/server/documents/trash.ts +203 -0
  230. package/src/server/documents/uploads.ts +450 -0
  231. package/src/server/documents/versions/checkpoint.ts +2 -1
  232. package/src/server/documents/versions/history.ts +11 -7
  233. package/src/server/documents/versions/service.ts +94 -28
  234. package/src/server/email/invitations.ts +1 -0
  235. package/src/server/email/service.ts +31 -4
  236. package/src/server/email/types.ts +12 -0
  237. package/src/server/errors/index.ts +51 -16
  238. package/src/server/index.ts +52 -16
  239. package/src/server/internal/index.ts +3 -3
  240. package/src/server/internal/routes.ts +7 -10
  241. package/src/server/internal/schema.ts +1 -1
  242. package/src/server/internal/service.ts +17 -23
  243. package/src/server/invitations/budget.ts +66 -0
  244. package/src/server/invitations/index.ts +1 -0
  245. package/src/server/invitations/types.ts +5 -1
  246. package/src/server/logging.ts +76 -0
  247. package/src/server/objects/types.ts +5 -0
  248. package/src/server/pictures/service.ts +2 -1
  249. package/src/server/policy/configured.ts +9 -3
  250. package/src/server/policy/database.ts +52 -27
  251. package/src/server/policy/index.ts +2 -1
  252. package/src/server/policy/keys.ts +5 -2
  253. package/src/server/policy/policy.ts +40 -12
  254. package/src/server/policy/schema.ts +2 -2
  255. package/src/server/policy/service.ts +78 -56
  256. package/src/server/policy/static.ts +5 -5
  257. package/src/server/policy/storage.ts +33 -0
  258. package/src/server/policy/workspace.ts +41 -0
  259. package/src/server/quota/index.ts +6 -0
  260. package/src/server/quota/notices.ts +121 -0
  261. package/src/server/quota/reconcile.ts +2 -0
  262. package/src/server/quota/storage.ts +74 -31
  263. package/src/server/rate-limit/cleanup.ts +17 -5
  264. package/src/server/rate-limit/middleware.ts +6 -2
  265. package/src/server/reports/index.ts +9 -0
  266. package/src/server/reports/replies.ts +55 -0
  267. package/src/server/reports/routes.ts +39 -0
  268. package/src/server/reports/service.ts +145 -0
  269. package/src/server/services/errors.ts +7 -0
  270. package/src/server/services/index.ts +8 -0
  271. package/src/server/{ai → services}/keys.ts +11 -11
  272. package/src/server/services/routes.ts +47 -0
  273. package/src/server/{ai/service.ts → services/tokens.ts} +23 -20
  274. package/src/server/sharing/capabilities/service.ts +68 -23
  275. package/src/server/sharing/grants/service.ts +11 -18
  276. package/src/server/sharing/http.ts +4 -0
  277. package/src/server/sharing/invitations/service.ts +35 -15
  278. package/src/server/sharing/policy.ts +9 -14
  279. package/src/server/sharing/routes.ts +0 -16
  280. package/src/server/sharing/service.ts +1 -17
  281. package/src/server/validation.ts +4 -0
  282. package/src/server/workspaces/index.ts +1 -0
  283. package/src/server/workspaces/members.ts +91 -52
  284. package/src/server/workspaces/repository.ts +2 -1
  285. package/src/server/workspaces/routes.ts +4 -0
  286. package/src/{ai-relay → services}/app.ts +46 -44
  287. package/src/{ai-relay → services}/config.ts +26 -19
  288. package/src/services/db/index.ts +10 -0
  289. package/src/services/db/migrate.ts +37 -0
  290. package/src/{ai-relay/db/migrations/001_usage.ts → services/db/migrations/001_baseline.ts} +18 -7
  291. package/src/services/db/schema.ts +22 -0
  292. package/src/services/index.ts +18 -0
  293. package/src/{ai-relay → services}/metering.ts +2 -2
  294. package/src/{ai-relay → services}/usage.ts +35 -19
  295. package/dist/bin/ai-relay.mjs.map +0 -1
  296. package/src/ai-relay/db/index.ts +0 -10
  297. package/src/ai-relay/db/migrate.ts +0 -32
  298. package/src/ai-relay/db/schema.ts +0 -20
  299. package/src/ai-relay/index.ts +0 -18
  300. package/src/client/ai.ts +0 -96
  301. package/src/contract/ai.ts +0 -150
  302. package/src/email/templates/document-invitation.ts +0 -35
  303. package/src/email/templates/enrollment.ts +0 -27
  304. package/src/email/templates/layout.ts +0 -18
  305. package/src/server/ai/errors.ts +0 -7
  306. package/src/server/ai/index.ts +0 -4
  307. package/src/server/ai/routes.ts +0 -43
  308. package/src/server/app.ts +0 -379
  309. package/src/server/auth/workspace-access.ts +0 -23
  310. package/src/server/db/migrations/001_foundation.ts +0 -164
  311. package/src/server/db/migrations/002_upload_cleanup_claims.ts +0 -34
  312. package/src/server/db/migrations/003_document_cleanup_claims.ts +0 -23
  313. package/src/server/db/migrations/004_document_sharing.ts +0 -82
  314. package/src/server/db/migrations/005_document_collaboration_epoch.ts +0 -13
  315. package/src/server/db/migrations/006_invitation_continuation.ts +0 -27
  316. package/src/server/db/migrations/007_collaboration_state.ts +0 -25
  317. package/src/server/db/migrations/008_storage_reservations.ts +0 -37
  318. package/src/server/db/migrations/009_workspace_entitlements.ts +0 -22
  319. package/src/server/db/migrations/010_upload_finalization.ts +0 -22
  320. package/src/server/db/migrations/011_upload_finalization_lease.ts +0 -12
  321. package/src/server/db/migrations/012_transactional_email.ts +0 -48
  322. package/src/server/db/migrations/013_admin_enrollment.ts +0 -54
  323. package/src/server/db/migrations/014_enrollment_email_kinds.ts +0 -30
  324. package/src/server/db/migrations/015_cloud_rate_limit.ts +0 -22
  325. package/src/server/db/migrations/016_auth_schema.ts +0 -16
  326. package/src/server/db/migrations/017_authentication_email_kinds.ts +0 -32
  327. package/src/server/db/migrations/018_authentication_mfa.ts +0 -78
  328. package/src/server/db/migrations/019_better_auth_account_issuer.ts +0 -42
  329. package/src/server/db/migrations/020_workspace_invitations.ts +0 -57
  330. package/src/server/db/migrations/021_document_versions.ts +0 -66
  331. package/src/server/db/migrations/022_entitlement_external_version.ts +0 -17
  332. package/src/server/db/migrations/023_document_images.ts +0 -61
  333. package/src/server/db/migrations/024_account_activity.ts +0 -66
  334. package/src/server/db/migrations/025_table_names.ts +0 -58
  335. package/src/server/db/migrations/026_user_picture.ts +0 -30
  336. package/src/server/db/migrations/027_document_kind.ts +0 -19
  337. package/src/server/db/migrations/028_collaboration_updates.ts +0 -84
  338. package/src/server/db/migrations/helpers.ts +0 -78
  339. /package/dist/bin/{ai-relay.d.mts → services.d.mts} +0 -0
@@ -1,13 +1,11 @@
1
1
  import {
2
2
  COLLAB_ACTIONS,
3
- encodeSyncReply,
4
- decodeRoomUpdate,
5
3
  MAX_COLLAB_MESSAGE_BYTES,
6
4
  RELAY_CLOSE,
7
5
  RELAY_SERVER_PEER,
8
- relayServerMessages,
9
6
  type RelayServerFrame
10
7
  } from '#cloud/contract'
8
+ import { logCloud, loggedError } from '#cloud/server/logging'
11
9
  import * as Y from 'yjs'
12
10
 
13
11
  import type { RelayAuthorization } from './authorize'
@@ -20,9 +18,20 @@ import {
20
18
  type RelayRoomFrame,
21
19
  type RelaySocket
22
20
  } from './connection'
23
- import { openRoomLog, type RoomLog } from './log'
21
+ import { openRoomLog } from './log'
24
22
  import type { CollaborationStateStore } from './persistence'
25
23
  import type { RelayPeerState } from './resume'
24
+ import {
25
+ answerAsServer,
26
+ applyToRoom,
27
+ needsDocument,
28
+ newRoom,
29
+ send,
30
+ sendAll,
31
+ updatesDocument,
32
+ type Room,
33
+ type RoomContent
34
+ } from './room'
26
35
 
27
36
  export type { RelayConnection, RelaySocket } from './connection'
28
37
 
@@ -36,9 +45,14 @@ export type CollaborationRelayOptions = {
36
45
  documentId?: string
37
46
  /**
38
47
  * The most one socket message may carry. An editor's larger frames arrive as fragments joined
39
- * up to `MAX_COLLAB_MESSAGE_BYTES`; anyone else's frame must fit in one message.
48
+ * up to `maximumRoomBytes`; anyone else's frame must fit in one message.
40
49
  */
41
50
  maximumMessageBytes: number
51
+ /**
52
+ * The most a room's document may hold, and so the most one editor's update may carry:
53
+ * `MAX_COLLAB_MESSAGE_BYTES` unless the runtime holds rooms in less memory.
54
+ */
55
+ maximumRoomBytes?: number
42
56
  maximumConnectionsPerRoom: number
43
57
  /** The participant limit policy sets for a document, or null for none. */
44
58
  maximumParticipants?: (documentId: string) => Promise<number | null>
@@ -65,24 +79,6 @@ export type CollaborationRelayOptions = {
65
79
  /** Messages a viewer may send; their document writes never leave the relay. */
66
80
  const VIEWER_ACTIONS = new Set<string>([COLLAB_ACTIONS.syncStep1, COLLAB_ACTIONS.awareness])
67
81
 
68
- type Peer = RelayPeer
69
-
70
- /** A room's document and the log its saves go to, loaded when a message first needs them. */
71
- type RoomContent = { document: Y.Doc; log: RoomLog }
72
-
73
- type Room = {
74
- id: string
75
- identity: { documentId: string; roomEpoch: number }
76
- peers: Map<string, Peer>
77
- persistTimer: ReturnType<typeof setTimeout> | null
78
- /**
79
- * Null until a message needs the document: peers resumed after the runtime woke the relay
80
- * exchange presence without it, so a wake for presence alone loads nothing from the store.
81
- */
82
- content: RoomContent | null
83
- loading: Promise<RoomContent> | null
84
- }
85
-
86
82
  export type CollaborationRelay = ReturnType<typeof createCollaborationRelay>
87
83
 
88
84
  /**
@@ -103,17 +99,14 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
103
99
  updates: options.compactAfterUpdates ?? 500,
104
100
  bytes: options.compactAfterBytes ?? 4 * 1024 * 1024
105
101
  }
102
+ const maximumRoomBytes = Math.min(
103
+ options.maximumRoomBytes ?? MAX_COLLAB_MESSAGE_BYTES,
104
+ MAX_COLLAB_MESSAGE_BYTES
105
+ )
106
106
  const authTimeoutMs = options.authTimeoutMs ?? 10_000
107
- const report = options.onError ?? ((message, error) => console.error(`[Cloud] ${message}`, error))
108
-
109
- function send(socket: RelaySocket, frame: RelayServerFrame) {
110
- for (const message of relayServerMessages(frame)) socket.send(message)
111
- }
112
-
113
- function sendAll(sockets: Iterable<RelaySocket>, frame: RelayServerFrame) {
114
- const messages = relayServerMessages(frame)
115
- for (const socket of sockets) for (const message of messages) socket.send(message)
116
- }
107
+ const report =
108
+ options.onError ??
109
+ ((message, error) => logCloud('error', message, { source: 'relay', error: loggedError(error) }))
117
110
 
118
111
  async function openRoom(authorization: RelayAuthorization): Promise<Room> {
119
112
  const existing = rooms.get(authorization.roomId)
@@ -140,16 +133,18 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
140
133
  }
141
134
  }
142
135
 
143
- function newRoom(id: string, identity: Room['identity']): Room {
144
- return { id, identity, peers: new Map(), persistTimer: null, content: null, loading: null }
145
- }
146
-
147
136
  /** The room's document and log, loaded from the store the first time something needs them. */
148
137
  function contentOf(room: Room): Promise<RoomContent> {
149
138
  if (room.content) return Promise.resolve(room.content)
150
139
  room.loading ??= openRoomLog(options.store, room.identity, logLimits).then(
151
- (content) => {
152
- content.document.on('update', () => schedulePersist(room))
140
+ ({ document, log, savedBytes }) => {
141
+ document.on('update', () => schedulePersist(room))
142
+ // The saved log may hold deletions, so the first time the bound reaches the limit, it is
143
+ // measured.
144
+ const content: RoomContent = { document, log, bytes: savedBytes, deletedSinceMeasure: true }
145
+ document.on('afterTransaction', (transaction: Y.Transaction) => {
146
+ if (transaction.deleteSet.clients.size > 0) content.deletedSinceMeasure = true
147
+ })
153
148
  room.content = content
154
149
  return content
155
150
  },
@@ -173,7 +168,7 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
173
168
  await log.save({ closing })
174
169
  return true
175
170
  } catch (error) {
176
- report('Saving a collaboration room failed:', error)
171
+ report('Saving a collaboration room failed', error)
177
172
  // The room holds edits the store doesn't have; save again without waiting for another edit.
178
173
  // A closing room retries through `saveAndClose`.
179
174
  if (!closing && rooms.get(room.id) === room) {
@@ -187,36 +182,9 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
187
182
  room.persistTimer ??= setTimeout(() => void persist(room), persistDelayMs)
188
183
  }
189
184
 
190
- /**
191
- * Applies a peer's V2 update to the room, inflated first for a sync reply. Rooms are saved as
192
- * V1 updates; only what peers exchange is V2.
193
- */
194
- function applyToRoom(
195
- document: Y.Doc,
196
- peer: Peer,
197
- namespace: string,
198
- payload: Uint8Array
199
- ): boolean {
200
- try {
201
- const update = decodeRoomUpdate(payload, {
202
- limit: MAX_COLLAB_MESSAGE_BYTES,
203
- compressed: namespace === COLLAB_ACTIONS.syncReply
204
- })
205
- if (!update) {
206
- peer.socket.close(RELAY_CLOSE.messageTooLarge, 'Collaboration update is too large')
207
- return false
208
- }
209
- Y.applyUpdateV2(document, update, peer.id)
210
- return true
211
- } catch {
212
- peer.socket.close(RELAY_CLOSE.protocol, 'Malformed document update')
213
- return false
214
- }
215
- }
216
-
217
185
  function forward(
218
186
  room: Room,
219
- from: Peer,
187
+ from: RelayPeer,
220
188
  namespace: string,
221
189
  target: string | null,
222
190
  payload: Uint8Array
@@ -228,42 +196,10 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
228
196
  sendAll(deliverable(recipients.flatMap((peer) => (peer ? [peer] : []))), frame)
229
197
  }
230
198
 
231
- function handleServerMessage(
232
- document: Y.Doc,
233
- peer: Peer,
234
- namespace: string,
235
- payload: Uint8Array
236
- ) {
237
- if (namespace === COLLAB_ACTIONS.syncStep1) {
238
- let reply: Uint8Array
239
- try {
240
- reply = encodeSyncReply(document, payload)
241
- } catch {
242
- peer.socket.close(RELAY_CLOSE.protocol, 'Malformed state vector')
243
- return
244
- }
245
- send(peer.socket, {
246
- type: 'message',
247
- namespace: COLLAB_ACTIONS.syncReply,
248
- from: RELAY_SERVER_PEER,
249
- payload: reply
250
- })
251
- } else if (namespace === COLLAB_ACTIONS.syncReply) {
252
- applyToRoom(document, peer, namespace, payload)
253
- }
254
- }
255
-
256
- /** Whether handling a message reads or writes the room's document. */
257
- function needsDocument(namespace: string, target: string | null): boolean {
258
- if (namespace === COLLAB_ACTIONS.yjsUpdate || namespace === COLLAB_ACTIONS.syncReply)
259
- return true
260
- return target === RELAY_SERVER_PEER && namespace === COLLAB_ACTIONS.syncStep1
261
- }
262
-
263
199
  function handleMessage(
264
200
  room: Room,
265
- document: Y.Doc | null,
266
- peer: Peer,
201
+ content: RoomContent | null,
202
+ peer: RelayPeer,
267
203
  namespace: string,
268
204
  target: string | null,
269
205
  payload: Uint8Array
@@ -288,12 +224,12 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
288
224
  }
289
225
 
290
226
  if (target === RELAY_SERVER_PEER) {
291
- if (document) handleServerMessage(document, peer, namespace, payload)
227
+ if (content) answerAsServer(content, peer, namespace, payload, maximumRoomBytes)
292
228
  return
293
229
  }
294
230
  if (
295
- (namespace === COLLAB_ACTIONS.yjsUpdate || namespace === COLLAB_ACTIONS.syncReply) &&
296
- !(document && applyToRoom(document, peer, namespace, payload))
231
+ updatesDocument(namespace) &&
232
+ !(content && applyToRoom(content, peer, namespace, payload, maximumRoomBytes))
297
233
  ) {
298
234
  return
299
235
  }
@@ -305,18 +241,18 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
305
241
  * the relay hears from the peer and before it sends the peer anything, never by a timer, so a
306
242
  * runtime can set an idle relay aside while sockets stay open.
307
243
  */
308
- function current(peer: Peer): boolean {
244
+ function current(peer: RelayPeer): boolean {
309
245
  if (Date.now() < peer.authorization.expiresAt) return true
310
246
  peer.socket.close(RELAY_CLOSE.expired, 'Collaboration ticket expired')
311
247
  return false
312
248
  }
313
249
 
314
250
  /** The sockets of peers whose tickets still hold. */
315
- function deliverable(peers: Iterable<Peer>): RelaySocket[] {
251
+ function deliverable(peers: Iterable<RelayPeer>): RelaySocket[] {
316
252
  return [...peers].filter(current).map((peer) => peer.socket)
317
253
  }
318
254
 
319
- function remember(peer: Peer) {
255
+ function remember(peer: RelayPeer) {
320
256
  peer.socket.remember?.({
321
257
  peerId: peer.id,
322
258
  authorization: peer.authorization,
@@ -325,7 +261,7 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
325
261
  }
326
262
 
327
263
  /** Handles a room message from an admitted peer; a promise while the room's document loads. */
328
- function deliver(peer: Peer, frame: RelayRoomFrame): Promise<void> | undefined {
264
+ function deliver(peer: RelayPeer, frame: RelayRoomFrame): Promise<void> | undefined {
329
265
  const room = rooms.get(peer.authorization.roomId)
330
266
  if (!room) {
331
267
  peer.socket.close(RELAY_CLOSE.unauthorized, 'Expected a collaboration ticket')
@@ -334,18 +270,18 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
334
270
  if (!current(peer)) return undefined
335
271
  const { namespace, target, payload } = frame
336
272
  if (room.content || !needsDocument(namespace, target)) {
337
- handleMessage(room, room.content?.document ?? null, peer, namespace, target, payload)
273
+ handleMessage(room, room.content, peer, namespace, target, payload)
338
274
  return undefined
339
275
  }
340
276
  return contentOf(room).then(
341
- ({ document }) => {
342
- // The peer may have left while the document loaded.
343
- if (room.peers.get(peer.id) !== peer) return undefined
344
- handleMessage(room, document, peer, namespace, target, payload)
277
+ (content) => {
278
+ // The peer may have left, or its ticket lapsed, while the document loaded.
279
+ if (room.peers.get(peer.id) !== peer || !current(peer)) return undefined
280
+ handleMessage(room, content, peer, namespace, target, payload)
345
281
  return undefined
346
282
  },
347
283
  (error: unknown) => {
348
- report('Loading a collaboration room failed:', error)
284
+ report('Loading a collaboration room failed', error)
349
285
  peer.socket.close(RELAY_CLOSE.protocol, 'Could not open the collaboration room')
350
286
  }
351
287
  )
@@ -354,14 +290,16 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
354
290
  async function admit(
355
291
  socket: RelaySocket,
356
292
  authorization: RelayAuthorization
357
- ): Promise<Peer | null> {
358
- const limit = await options.maximumParticipants?.(authorization.documentId)
293
+ ): Promise<RelayPeer | null> {
359
294
  let room: Room
295
+ let limit: number | null | undefined
360
296
  let epoch: number | null | undefined
361
- // The room's last peer may have left while it opened, or a restore ended it; a closed room
362
- // takes no newcomers. The epoch is read once the room is open, so a restore cannot slip between.
297
+ // The room's last peer may have left while it opened, or a restore or takedown ended it; a
298
+ // closed room takes no newcomers. The limit and epoch are read once the room is open, so
299
+ // neither a restore nor a takedown can slip between.
363
300
  do {
364
301
  room = await openRoom(authorization)
302
+ limit = await options.maximumParticipants?.(authorization.documentId)
365
303
  epoch = await options.currentRoomEpoch?.(authorization.documentId)
366
304
  } while (rooms.get(room.id) !== room)
367
305
  if (epoch != null && authorization.roomEpoch < epoch) {
@@ -375,7 +313,7 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
375
313
  if (room.peers.size === 0) await leaveRoom(room)
376
314
  return null
377
315
  }
378
- const peer: Peer = {
316
+ const peer: RelayPeer = {
379
317
  id: crypto.randomUUID(),
380
318
  socket,
381
319
  authorization,
@@ -427,7 +365,7 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
427
365
  }
428
366
  }
429
367
 
430
- function depart(peer: Peer) {
368
+ function depart(peer: RelayPeer) {
431
369
  const room = rooms.get(peer.authorization.roomId)
432
370
  if (!room?.peers.delete(peer.id)) return
433
371
  sendAll(deliverable(room.peers.values()), { type: 'leave', peerId: peer.id })
@@ -442,6 +380,7 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
442
380
  authSecret: options.authSecret,
443
381
  documentId: options.documentId,
444
382
  maximumMessageBytes: options.maximumMessageBytes,
383
+ maximumUpdateBytes: maximumRoomBytes,
445
384
  authTimeoutMs,
446
385
  admit,
447
386
  refreshed: remember,
@@ -468,7 +407,7 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
468
407
  room = newRoom(authorization.roomId, identity)
469
408
  rooms.set(room.id, room)
470
409
  }
471
- const peer: Peer = {
410
+ const peer: RelayPeer = {
472
411
  id: saved.peerId,
473
412
  socket,
474
413
  authorization,
@@ -499,6 +438,22 @@ export function createCollaborationRelay(options: CollaborationRelayOptions) {
499
438
  }
500
439
  },
501
440
 
441
+ /**
442
+ * Ends a taken-down document's rooms for everyone in them, saving what each room holds, so
443
+ * a restore opens them again with every edit. Nobody gets back in meanwhile: tickets are
444
+ * issued only for documents people can reach.
445
+ */
446
+ closeDocument(documentId: string) {
447
+ for (const room of rooms.values()) {
448
+ if (room.identity.documentId !== documentId) continue
449
+ for (const peer of room.peers.values()) {
450
+ peer.socket.close(RELAY_CLOSE.unauthorized, 'The document was taken down')
451
+ }
452
+ room.peers.clear()
453
+ void leaveRoom(room)
454
+ }
455
+ },
456
+
502
457
  /** Tells everyone in a document's rooms that its version history changed. */
503
458
  announceVersions(documentId: string) {
504
459
  const frame: RelayServerFrame = {
@@ -22,7 +22,7 @@ export async function openRoomLog(
22
22
  store: CollaborationStateStore,
23
23
  room: CollaborationRoomIdentity,
24
24
  limits: RoomLogLimits
25
- ): Promise<{ document: Y.Doc; log: RoomLog }> {
25
+ ): Promise<{ document: Y.Doc; log: RoomLog; savedBytes: number }> {
26
26
  const saved = await store.load(room)
27
27
  const document = new Y.Doc()
28
28
  if (saved.snapshot) Y.applyUpdate(document, saved.snapshot)
@@ -72,5 +72,8 @@ export async function openRoomLog(
72
72
  return run
73
73
  }
74
74
  }
75
- return { document, log }
75
+ const savedBytes =
76
+ (saved.snapshot?.byteLength ?? 0) +
77
+ saved.updates.reduce((total, update) => total + update.byteLength, 0)
78
+ return { document, log, savedBytes }
76
79
  }
@@ -0,0 +1,154 @@
1
+ import {
2
+ COLLAB_ACTIONS,
3
+ decodeRoomUpdate,
4
+ encodeSyncReply,
5
+ RELAY_CLOSE,
6
+ RELAY_SERVER_PEER,
7
+ relayServerMessages,
8
+ type RelayServerFrame
9
+ } from '#cloud/contract'
10
+ import * as Y from 'yjs'
11
+
12
+ import type { RelayPeer, RelaySocket } from './connection'
13
+ import type { RoomLog } from './log'
14
+
15
+ /**
16
+ * A room's document and the log its saves go to, loaded when a message first needs them, with an
17
+ * upper bound on the document's size: what was saved plus every update since. The bound is
18
+ * measured again only once it reaches `maximumRoomBytes` after something was deleted, since only
19
+ * a deletion can leave the document smaller than the bound.
20
+ */
21
+ export type RoomContent = {
22
+ document: Y.Doc
23
+ log: RoomLog
24
+ bytes: number
25
+ deletedSinceMeasure: boolean
26
+ }
27
+
28
+ export type Room = {
29
+ id: string
30
+ identity: { documentId: string; roomEpoch: number }
31
+ peers: Map<string, RelayPeer>
32
+ persistTimer: ReturnType<typeof setTimeout> | null
33
+ /**
34
+ * Null until a message needs the document: peers resumed after the runtime woke the relay
35
+ * exchange presence without it, so a wake for presence alone loads nothing from the store.
36
+ */
37
+ content: RoomContent | null
38
+ loading: Promise<RoomContent> | null
39
+ }
40
+
41
+ /** A room with no peers whose document has not been loaded. */
42
+ export function newRoom(id: string, identity: Room['identity']): Room {
43
+ return { id, identity, peers: new Map(), persistTimer: null, content: null, loading: null }
44
+ }
45
+
46
+ /** Sends a frame to one socket, split into fragments as the relay sends every frame. */
47
+ export function send(socket: RelaySocket, frame: RelayServerFrame) {
48
+ for (const message of relayServerMessages(frame)) socket.send(message)
49
+ }
50
+
51
+ /** Sends one frame to every socket, encoding it once. */
52
+ export function sendAll(sockets: Iterable<RelaySocket>, frame: RelayServerFrame) {
53
+ const messages = relayServerMessages(frame)
54
+ for (const socket of sockets) for (const message of messages) socket.send(message)
55
+ }
56
+
57
+ /** Whether a room message carries a document update the room applies. */
58
+ export const updatesDocument = (namespace: string) =>
59
+ namespace === COLLAB_ACTIONS.yjsUpdate || namespace === COLLAB_ACTIONS.syncReply
60
+
61
+ /** Whether handling a message reads or writes the room's document. */
62
+ export function needsDocument(namespace: string, target: string | null): boolean {
63
+ if (updatesDocument(namespace)) return true
64
+ return target === RELAY_SERVER_PEER && namespace === COLLAB_ACTIONS.syncStep1
65
+ }
66
+
67
+ /** Whether `update` adds nothing and deletes only content `document` already holds. */
68
+ function deletesOnlyKnown(document: Y.Doc, update: Uint8Array): boolean {
69
+ const { from, to } = Y.parseUpdateMetaV2(update)
70
+ if (![...to].every(([client, clock]) => from.get(client) === clock)) return false
71
+ const { ds } = Y.decodeUpdateV2(update)
72
+ for (const [client, deletions] of ds.clients) {
73
+ const held = Y.getState(document.store, client)
74
+ if (deletions.some((deletion) => deletion.clock + deletion.len > held)) return false
75
+ }
76
+ return true
77
+ }
78
+
79
+ /**
80
+ * Whether the room's document stays within `limit` after `update`. An update that only deletes
81
+ * what the room holds shrinks it, so it always fits; one that deletes what the room has not
82
+ * received waits in the document, so it counts like any other. Otherwise the bound grows by the
83
+ * update; past the limit, the document is measured only if a deletion may have shrunk it since
84
+ * the last measure, so edits near the limit never encode the whole document each time.
85
+ */
86
+ function fits(content: RoomContent, update: Uint8Array, limit: number): boolean {
87
+ if (deletesOnlyKnown(content.document, update)) return true
88
+ if (content.bytes + update.byteLength <= limit) return true
89
+ if (!content.deletedSinceMeasure) return false
90
+ content.bytes = Y.encodeStateAsUpdateV2(content.document).byteLength
91
+ content.deletedSinceMeasure = false
92
+ return content.bytes + update.byteLength <= limit
93
+ }
94
+
95
+ /**
96
+ * Applies a peer's V2 update to the room, inflated first for a sync reply, closing the peer's
97
+ * socket when it is malformed or would grow the document past `limit`. Rooms are saved as V1
98
+ * updates; only what peers exchange is V2.
99
+ */
100
+ export function applyToRoom(
101
+ content: RoomContent,
102
+ peer: RelayPeer,
103
+ namespace: string,
104
+ payload: Uint8Array,
105
+ limit: number
106
+ ): boolean {
107
+ const { document } = content
108
+ try {
109
+ const update = decodeRoomUpdate(payload, {
110
+ limit,
111
+ compressed: namespace === COLLAB_ACTIONS.syncReply
112
+ })
113
+ if (!update || !fits(content, update, limit)) {
114
+ peer.socket.close(RELAY_CLOSE.messageTooLarge, 'Collaboration update is too large')
115
+ return false
116
+ }
117
+ Y.applyUpdateV2(document, update, peer.id)
118
+ content.bytes += update.byteLength
119
+ return true
120
+ } catch {
121
+ peer.socket.close(RELAY_CLOSE.protocol, 'Malformed document update')
122
+ return false
123
+ }
124
+ }
125
+
126
+ /**
127
+ * Handles a message addressed to the relay's own peer: a sync request is answered from the
128
+ * room's document, and a sync reply is applied to it.
129
+ */
130
+ export function answerAsServer(
131
+ content: RoomContent,
132
+ peer: RelayPeer,
133
+ namespace: string,
134
+ payload: Uint8Array,
135
+ limit: number
136
+ ) {
137
+ if (namespace === COLLAB_ACTIONS.syncStep1) {
138
+ let reply: Uint8Array
139
+ try {
140
+ reply = encodeSyncReply(content.document, payload)
141
+ } catch {
142
+ peer.socket.close(RELAY_CLOSE.protocol, 'Malformed state vector')
143
+ return
144
+ }
145
+ send(peer.socket, {
146
+ type: 'message',
147
+ namespace: COLLAB_ACTIONS.syncReply,
148
+ from: RELAY_SERVER_PEER,
149
+ payload: reply
150
+ })
151
+ } else if (namespace === COLLAB_ACTIONS.syncReply) {
152
+ applyToRoom(content, peer, namespace, payload, limit)
153
+ }
154
+ }