@abloatai/humans 0.37.0

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 (404) hide show
  1. package/README.md +52 -0
  2. package/dist/Ablo.d.ts +208 -0
  3. package/dist/Ablo.js +120 -0
  4. package/dist/client.d.ts +317 -0
  5. package/dist/client.js +13 -0
  6. package/dist/core.d.ts +35 -0
  7. package/dist/core.js +48 -0
  8. package/dist/humans.d.ts +28 -0
  9. package/dist/humans.js +34 -0
  10. package/dist/index.d.ts +10 -0
  11. package/dist/index.js +6 -0
  12. package/dist/local/BaseSyncedStore.d.ts +807 -0
  13. package/dist/local/BaseSyncedStore.js +1516 -0
  14. package/dist/local/Database.d.ts +322 -0
  15. package/dist/local/Database.js +1589 -0
  16. package/dist/local/InstanceCache.d.ts +255 -0
  17. package/dist/local/InstanceCache.js +1263 -0
  18. package/dist/local/LazyReferenceCollection.d.ts +177 -0
  19. package/dist/local/LazyReferenceCollection.js +461 -0
  20. package/dist/local/Model.d.ts +475 -0
  21. package/dist/local/Model.js +950 -0
  22. package/dist/local/ModelRegistry.d.ts +225 -0
  23. package/dist/local/ModelRegistry.js +539 -0
  24. package/dist/local/NetworkMonitor.d.ts +28 -0
  25. package/dist/local/NetworkMonitor.js +79 -0
  26. package/dist/local/RuntimeContext.d.ts +52 -0
  27. package/dist/local/RuntimeContext.js +80 -0
  28. package/dist/local/SyncClient.d.ts +516 -0
  29. package/dist/local/SyncClient.js +1754 -0
  30. package/dist/local/adapters/alwaysOnline.d.ts +14 -0
  31. package/dist/local/adapters/alwaysOnline.js +17 -0
  32. package/dist/local/adapters/inMemoryStorage.d.ts +37 -0
  33. package/dist/local/adapters/inMemoryStorage.js +122 -0
  34. package/dist/local/client/clientPrelude.d.ts +52 -0
  35. package/dist/local/client/clientPrelude.js +60 -0
  36. package/dist/local/client/consoleLogger.d.ts +35 -0
  37. package/dist/local/client/consoleLogger.js +44 -0
  38. package/dist/local/client/createInternalComponents.d.ts +50 -0
  39. package/dist/local/client/createInternalComponents.js +98 -0
  40. package/dist/local/client/createModelProxy.d.ts +248 -0
  41. package/dist/local/client/createModelProxy.js +880 -0
  42. package/dist/local/client/modelRegistration.d.ts +10 -0
  43. package/dist/local/client/modelRegistration.js +316 -0
  44. package/dist/local/client/options.d.ts +440 -0
  45. package/dist/local/client/options.js +7 -0
  46. package/dist/local/client/reactiveEngine.d.ts +53 -0
  47. package/dist/local/client/reactiveEngine.js +705 -0
  48. package/dist/local/client/resourceTypes.d.ts +12 -0
  49. package/dist/local/client/resourceTypes.js +10 -0
  50. package/dist/local/client/schemaConfig.d.ts +44 -0
  51. package/dist/local/client/schemaConfig.js +185 -0
  52. package/dist/local/client/storeCluster.d.ts +46 -0
  53. package/dist/local/client/storeCluster.js +133 -0
  54. package/dist/local/client/storeLifecycle.d.ts +61 -0
  55. package/dist/local/client/storeLifecycle.js +236 -0
  56. package/dist/local/client/validateAbloOptions.d.ts +42 -0
  57. package/dist/local/client/validateAbloOptions.js +43 -0
  58. package/dist/local/client/wsMutationExecutor.d.ts +27 -0
  59. package/dist/local/client/wsMutationExecutor.js +72 -0
  60. package/dist/local/context.d.ts +42 -0
  61. package/dist/local/context.js +81 -0
  62. package/dist/local/coordination/ClaimLog.d.ts +26 -0
  63. package/dist/local/coordination/ClaimLog.js +32 -0
  64. package/dist/local/interfaces/index.d.ts +311 -0
  65. package/dist/local/interfaces/index.js +9 -0
  66. package/dist/local/localModelContract.d.ts +14 -0
  67. package/dist/local/localModelContract.js +1 -0
  68. package/dist/local/logPosition.d.ts +31 -0
  69. package/dist/local/logPosition.js +53 -0
  70. package/dist/local/mutationPersistence.d.ts +6 -0
  71. package/dist/local/mutationPersistence.js +1 -0
  72. package/dist/local/mutators/RecordingMutation.d.ts +36 -0
  73. package/dist/local/mutators/RecordingMutation.js +182 -0
  74. package/dist/local/mutators/Transaction.d.ts +40 -0
  75. package/dist/local/mutators/Transaction.js +58 -0
  76. package/dist/local/mutators/UndoManager.d.ts +258 -0
  77. package/dist/local/mutators/UndoManager.js +665 -0
  78. package/dist/local/mutators/defineMutators.d.ts +60 -0
  79. package/dist/local/mutators/defineMutators.js +18 -0
  80. package/dist/local/mutators/inverseOp.d.ts +126 -0
  81. package/dist/local/mutators/inverseOp.js +71 -0
  82. package/dist/local/mutators/mutateActions.d.ts +45 -0
  83. package/dist/local/mutators/mutateActions.js +105 -0
  84. package/dist/local/mutators/readerActions.d.ts +33 -0
  85. package/dist/local/mutators/readerActions.js +57 -0
  86. package/dist/local/mutators/undoApply.d.ts +51 -0
  87. package/dist/local/mutators/undoApply.js +117 -0
  88. package/dist/local/persistence.d.ts +7 -0
  89. package/dist/local/persistence.js +9 -0
  90. package/dist/local/query/QueryProcessor.d.ts +75 -0
  91. package/dist/local/query/QueryProcessor.js +255 -0
  92. package/dist/local/query/client.d.ts +64 -0
  93. package/dist/local/query/client.js +138 -0
  94. package/dist/local/query/types.d.ts +85 -0
  95. package/dist/local/query/types.js +16 -0
  96. package/dist/local/schema/serialize.d.ts +1 -0
  97. package/dist/local/schema/serialize.js +1 -0
  98. package/dist/local/store/queryApi.d.ts +13 -0
  99. package/dist/local/store/queryApi.js +35 -0
  100. package/dist/local/storeContract.d.ts +145 -0
  101. package/dist/local/storeContract.js +12 -0
  102. package/dist/local/stores/DatabaseManager.d.ts +112 -0
  103. package/dist/local/stores/DatabaseManager.js +400 -0
  104. package/dist/local/stores/ObjectStore.d.ts +115 -0
  105. package/dist/local/stores/ObjectStore.js +393 -0
  106. package/dist/local/stores/ObjectStoreContract.d.ts +38 -0
  107. package/dist/local/stores/ObjectStoreContract.js +1 -0
  108. package/dist/local/stores/StoreManager.d.ts +114 -0
  109. package/dist/local/stores/StoreManager.js +304 -0
  110. package/dist/local/stores/SyncActionStore.d.ts +99 -0
  111. package/dist/local/stores/SyncActionStore.js +506 -0
  112. package/dist/local/stores/openIDBWithTimeout.d.ts +65 -0
  113. package/dist/local/stores/openIDBWithTimeout.js +153 -0
  114. package/dist/local/stores/persistenceCleanup.d.ts +7 -0
  115. package/dist/local/stores/persistenceCleanup.js +26 -0
  116. package/dist/local/stores/persistenceIdentity.d.ts +27 -0
  117. package/dist/local/stores/persistenceIdentity.js +38 -0
  118. package/dist/local/stores/syncAction.d.ts +26 -0
  119. package/dist/local/stores/syncAction.js +16 -0
  120. package/dist/local/stores/v1PersistenceDeletion.d.ts +8 -0
  121. package/dist/local/stores/v1PersistenceDeletion.js +16 -0
  122. package/dist/local/sync/BootstrapFetcher.d.ts +284 -0
  123. package/dist/local/sync/BootstrapFetcher.js +964 -0
  124. package/dist/local/sync/ConnectionManager.d.ts +8 -0
  125. package/dist/local/sync/ConnectionManager.js +8 -0
  126. package/dist/local/sync/OnDemandLoader.d.ts +231 -0
  127. package/dist/local/sync/OnDemandLoader.js +743 -0
  128. package/dist/local/sync/SubscriptionManager.d.ts +159 -0
  129. package/dist/local/sync/SubscriptionManager.js +243 -0
  130. package/dist/local/sync/SyncWebSocket.d.ts +173 -0
  131. package/dist/local/sync/SyncWebSocket.js +438 -0
  132. package/dist/local/sync/bootstrapApply.d.ts +73 -0
  133. package/dist/local/sync/bootstrapApply.js +73 -0
  134. package/dist/local/sync/commitFrames.d.ts +8 -0
  135. package/dist/local/sync/commitFrames.js +8 -0
  136. package/dist/local/sync/connectionManagerLifecycle.d.ts +23 -0
  137. package/dist/local/sync/connectionManagerLifecycle.js +126 -0
  138. package/dist/local/sync/contextPorts.d.ts +18 -0
  139. package/dist/local/sync/contextPorts.js +31 -0
  140. package/dist/local/sync/createClaimStream.d.ts +64 -0
  141. package/dist/local/sync/createClaimStream.js +475 -0
  142. package/dist/local/sync/createSnapshot.d.ts +29 -0
  143. package/dist/local/sync/createSnapshot.js +116 -0
  144. package/dist/local/sync/credentialLifecycle.d.ts +7 -0
  145. package/dist/local/sync/credentialLifecycle.js +7 -0
  146. package/dist/local/sync/deltaPipeline.d.ts +116 -0
  147. package/dist/local/sync/deltaPipeline.js +357 -0
  148. package/dist/local/sync/groupChange.d.ts +116 -0
  149. package/dist/local/sync/groupChange.js +244 -0
  150. package/dist/local/sync/initialize.d.ts +27 -0
  151. package/dist/local/sync/initialize.js +137 -0
  152. package/dist/local/sync/participants.d.ts +132 -0
  153. package/dist/local/sync/participants.js +342 -0
  154. package/dist/local/sync/persistedPrefix.d.ts +12 -0
  155. package/dist/local/sync/persistedPrefix.js +22 -0
  156. package/dist/local/sync/reconnect.d.ts +23 -0
  157. package/dist/local/sync/reconnect.js +55 -0
  158. package/dist/local/sync/schemaDrift.d.ts +55 -0
  159. package/dist/local/sync/schemaDrift.js +53 -0
  160. package/dist/local/sync/schemas.d.ts +71 -0
  161. package/dist/local/sync/schemas.js +94 -0
  162. package/dist/local/sync/socketEventWiring.d.ts +31 -0
  163. package/dist/local/sync/socketEventWiring.js +130 -0
  164. package/dist/local/sync/syncCursor.d.ts +40 -0
  165. package/dist/local/sync/syncCursor.js +55 -0
  166. package/dist/local/sync/syncPlan.d.ts +54 -0
  167. package/dist/local/sync/syncPlan.js +50 -0
  168. package/dist/local/sync/terminalSessionLifecycle.d.ts +20 -0
  169. package/dist/local/sync/terminalSessionLifecycle.js +50 -0
  170. package/dist/local/sync/wsFrameHandlers.d.ts +8 -0
  171. package/dist/local/sync/wsFrameHandlers.js +8 -0
  172. package/dist/local/transactions/databaseCommitOutbox.d.ts +15 -0
  173. package/dist/local/transactions/databaseCommitOutbox.js +16 -0
  174. package/dist/local/transactions/localMutation.d.ts +10 -0
  175. package/dist/local/transactions/localMutation.js +37 -0
  176. package/dist/local/transactions/mutations/MutationQueue.d.ts +511 -0
  177. package/dist/local/transactions/mutations/MutationQueue.js +1498 -0
  178. package/dist/local/transactions/mutations/MutationStore.d.ts +20 -0
  179. package/dist/local/transactions/mutations/MutationStore.js +53 -0
  180. package/dist/local/transactions/mutations/UnconfirmedWrites.d.ts +82 -0
  181. package/dist/local/transactions/mutations/UnconfirmedWrites.js +104 -0
  182. package/dist/local/transactions/mutations/batchProcessing.d.ts +64 -0
  183. package/dist/local/transactions/mutations/batchProcessing.js +349 -0
  184. package/dist/local/transactions/mutations/coalesceRules.d.ts +58 -0
  185. package/dist/local/transactions/mutations/coalesceRules.js +140 -0
  186. package/dist/local/transactions/mutations/commitApi.d.ts +19 -0
  187. package/dist/local/transactions/mutations/commitApi.js +74 -0
  188. package/dist/local/transactions/mutations/commitLane.d.ts +70 -0
  189. package/dist/local/transactions/mutations/commitLane.js +140 -0
  190. package/dist/local/transactions/mutations/commitLatency.d.ts +52 -0
  191. package/dist/local/transactions/mutations/commitLatency.js +130 -0
  192. package/dist/local/transactions/mutations/commitPayload.d.ts +165 -0
  193. package/dist/local/transactions/mutations/commitPayload.js +152 -0
  194. package/dist/local/transactions/mutations/commitTransport.d.ts +36 -0
  195. package/dist/local/transactions/mutations/commitTransport.js +104 -0
  196. package/dist/local/transactions/mutations/deltaConfirmation.d.ts +63 -0
  197. package/dist/local/transactions/mutations/deltaConfirmation.js +235 -0
  198. package/dist/local/transactions/mutations/durableCommitRestore.d.ts +17 -0
  199. package/dist/local/transactions/mutations/durableCommitRestore.js +95 -0
  200. package/dist/local/transactions/mutations/durableWriteStore.d.ts +14 -0
  201. package/dist/local/transactions/mutations/durableWriteStore.js +12 -0
  202. package/dist/local/transactions/mutations/executionSelection.d.ts +6 -0
  203. package/dist/local/transactions/mutations/executionSelection.js +42 -0
  204. package/dist/local/transactions/mutations/failureHandling.d.ts +16 -0
  205. package/dist/local/transactions/mutations/failureHandling.js +130 -0
  206. package/dist/local/transactions/mutations/failurePolicy.d.ts +13 -0
  207. package/dist/local/transactions/mutations/failurePolicy.js +48 -0
  208. package/dist/local/transactions/mutations/localMutation.d.ts +58 -0
  209. package/dist/local/transactions/mutations/localMutation.js +75 -0
  210. package/dist/local/transactions/mutations/modelOperations.d.ts +44 -0
  211. package/dist/local/transactions/mutations/modelOperations.js +144 -0
  212. package/dist/local/transactions/mutations/mutationPersistence.d.ts +25 -0
  213. package/dist/local/transactions/mutations/mutationPersistence.js +188 -0
  214. package/dist/local/transactions/mutations/pendingDrain.d.ts +33 -0
  215. package/dist/local/transactions/mutations/pendingDrain.js +112 -0
  216. package/dist/local/transactions/mutations/processingScheduler.d.ts +14 -0
  217. package/dist/local/transactions/mutations/processingScheduler.js +24 -0
  218. package/dist/local/transactions/mutations/queueCoalescing.d.ts +13 -0
  219. package/dist/local/transactions/mutations/queueCoalescing.js +35 -0
  220. package/dist/local/transactions/mutations/replayValidation.d.ts +187 -0
  221. package/dist/local/transactions/mutations/replayValidation.js +164 -0
  222. package/dist/local/transactions/reconnectDrain.d.ts +11 -0
  223. package/dist/local/transactions/reconnectDrain.js +13 -0
  224. package/dist/local/utils/mobxSetup.d.ts +53 -0
  225. package/dist/local/utils/mobxSetup.js +330 -0
  226. package/dist/local/views/QueryView.d.ts +79 -0
  227. package/dist/local/views/QueryView.js +218 -0
  228. package/dist/local/views/ViewRegistry.d.ts +20 -0
  229. package/dist/local/views/ViewRegistry.js +57 -0
  230. package/dist/local/views/incrementalView.d.ts +45 -0
  231. package/dist/local/views/incrementalView.js +69 -0
  232. package/dist/plugin.d.ts +285 -0
  233. package/dist/plugin.js +106 -0
  234. package/dist/presenceStream.d.ts +69 -0
  235. package/dist/presenceStream.js +200 -0
  236. package/dist/react/AbloProvider.d.ts +242 -0
  237. package/dist/react/AbloProvider.js +456 -0
  238. package/dist/react/ClientSideSuspense.d.ts +36 -0
  239. package/dist/react/ClientSideSuspense.js +17 -0
  240. package/dist/react/DefaultFallback.d.ts +24 -0
  241. package/dist/react/DefaultFallback.js +43 -0
  242. package/dist/react/context.d.ts +55 -0
  243. package/dist/react/context.js +29 -0
  244. package/dist/react/createAbloReact.d.ts +50 -0
  245. package/dist/react/createAbloReact.js +48 -0
  246. package/dist/react/internalContext.d.ts +33 -0
  247. package/dist/react/internalContext.js +3 -0
  248. package/dist/react/useAblo.d.ts +96 -0
  249. package/dist/react/useAblo.js +120 -0
  250. package/dist/react/useCurrentUserId.d.ts +2 -0
  251. package/dist/react/useCurrentUserId.js +12 -0
  252. package/dist/react/useErrorListener.d.ts +2 -0
  253. package/dist/react/useErrorListener.js +14 -0
  254. package/dist/react/useMutationFailureListener.d.ts +8 -0
  255. package/dist/react/useMutationFailureListener.js +19 -0
  256. package/dist/react/useMutators.d.ts +56 -0
  257. package/dist/react/useMutators.js +84 -0
  258. package/dist/react/useSyncStatus.d.ts +19 -0
  259. package/dist/react/useSyncStatus.js +37 -0
  260. package/dist/react/useUndoScope.d.ts +34 -0
  261. package/dist/react/useUndoScope.js +73 -0
  262. package/dist/react.d.ts +18 -0
  263. package/dist/react.js +14 -0
  264. package/dist/reactRuntime.d.ts +4 -0
  265. package/dist/reactRuntime.js +2 -0
  266. package/dist/surface.d.ts +36 -0
  267. package/dist/surface.js +77 -0
  268. package/dist/useReactive.d.ts +6 -0
  269. package/dist/useReactive.js +43 -0
  270. package/package.json +119 -0
  271. package/src/Ablo.ts +456 -0
  272. package/src/client.ts +374 -0
  273. package/src/core.ts +104 -0
  274. package/src/humans.ts +61 -0
  275. package/src/index.ts +40 -0
  276. package/src/local/BaseSyncedStore.ts +1991 -0
  277. package/src/local/Database.ts +2052 -0
  278. package/src/local/InstanceCache.ts +1503 -0
  279. package/src/local/LazyReferenceCollection.ts +563 -0
  280. package/src/local/Model.ts +1124 -0
  281. package/src/local/ModelRegistry.ts +762 -0
  282. package/src/local/NetworkMonitor.ts +88 -0
  283. package/src/local/RuntimeContext.ts +141 -0
  284. package/src/local/SyncClient.ts +2131 -0
  285. package/src/local/adapters/alwaysOnline.ts +20 -0
  286. package/src/local/adapters/inMemoryStorage.ts +141 -0
  287. package/src/local/client/clientPrelude.ts +112 -0
  288. package/src/local/client/consoleLogger.ts +60 -0
  289. package/src/local/client/createInternalComponents.ts +163 -0
  290. package/src/local/client/createModelProxy.ts +1390 -0
  291. package/src/local/client/modelRegistration.ts +350 -0
  292. package/src/local/client/options.ts +526 -0
  293. package/src/local/client/reactiveEngine.ts +935 -0
  294. package/src/local/client/resourceTypes.ts +37 -0
  295. package/src/local/client/schemaConfig.ts +194 -0
  296. package/src/local/client/storeCluster.ts +172 -0
  297. package/src/local/client/storeLifecycle.ts +343 -0
  298. package/src/local/client/validateAbloOptions.ts +95 -0
  299. package/src/local/client/wsMutationExecutor.ts +110 -0
  300. package/src/local/context.ts +96 -0
  301. package/src/local/coordination/ClaimLog.ts +39 -0
  302. package/src/local/interfaces/index.ts +468 -0
  303. package/src/local/localModelContract.ts +15 -0
  304. package/src/local/logPosition.ts +84 -0
  305. package/src/local/mutationPersistence.ts +7 -0
  306. package/src/local/mutators/RecordingMutation.ts +222 -0
  307. package/src/local/mutators/Transaction.ts +97 -0
  308. package/src/local/mutators/UndoManager.ts +741 -0
  309. package/src/local/mutators/defineMutators.ts +76 -0
  310. package/src/local/mutators/inverseOp.ts +83 -0
  311. package/src/local/mutators/mutateActions.ts +167 -0
  312. package/src/local/mutators/readerActions.ts +99 -0
  313. package/src/local/mutators/undoApply.ts +141 -0
  314. package/src/local/persistence.ts +16 -0
  315. package/src/local/query/QueryProcessor.ts +347 -0
  316. package/src/local/query/client.ts +197 -0
  317. package/src/local/query/types.ts +102 -0
  318. package/src/local/schema/serialize.ts +1 -0
  319. package/src/local/store/queryApi.ts +56 -0
  320. package/src/local/storeContract.ts +146 -0
  321. package/src/local/stores/DatabaseManager.ts +507 -0
  322. package/src/local/stores/ObjectStore.ts +449 -0
  323. package/src/local/stores/ObjectStoreContract.ts +48 -0
  324. package/src/local/stores/StoreManager.ts +388 -0
  325. package/src/local/stores/SyncActionStore.ts +579 -0
  326. package/src/local/stores/openIDBWithTimeout.ts +195 -0
  327. package/src/local/stores/persistenceCleanup.ts +43 -0
  328. package/src/local/stores/persistenceIdentity.ts +83 -0
  329. package/src/local/stores/syncAction.ts +21 -0
  330. package/src/local/stores/v1PersistenceDeletion.ts +21 -0
  331. package/src/local/sync/BootstrapFetcher.ts +1224 -0
  332. package/src/local/sync/ConnectionManager.ts +15 -0
  333. package/src/local/sync/OnDemandLoader.ts +927 -0
  334. package/src/local/sync/SubscriptionManager.ts +300 -0
  335. package/src/local/sync/SyncWebSocket.ts +584 -0
  336. package/src/local/sync/bootstrapApply.ts +130 -0
  337. package/src/local/sync/commitFrames.ts +16 -0
  338. package/src/local/sync/connectionManagerLifecycle.ts +158 -0
  339. package/src/local/sync/contextPorts.ts +37 -0
  340. package/src/local/sync/createClaimStream.ts +668 -0
  341. package/src/local/sync/createSnapshot.ts +160 -0
  342. package/src/local/sync/credentialLifecycle.ts +18 -0
  343. package/src/local/sync/deltaPipeline.ts +473 -0
  344. package/src/local/sync/groupChange.ts +343 -0
  345. package/src/local/sync/initialize.ts +205 -0
  346. package/src/local/sync/participants.ts +564 -0
  347. package/src/local/sync/persistedPrefix.ts +27 -0
  348. package/src/local/sync/reconnect.ts +88 -0
  349. package/src/local/sync/schemaDrift.ts +86 -0
  350. package/src/local/sync/schemas.ts +118 -0
  351. package/src/local/sync/socketEventWiring.ts +196 -0
  352. package/src/local/sync/syncCursor.ts +62 -0
  353. package/src/local/sync/syncPlan.ts +89 -0
  354. package/src/local/sync/terminalSessionLifecycle.ts +66 -0
  355. package/src/local/sync/wsFrameHandlers.ts +20 -0
  356. package/src/local/transactions/databaseCommitOutbox.ts +33 -0
  357. package/src/local/transactions/localMutation.ts +58 -0
  358. package/src/local/transactions/mutations/MutationQueue.ts +1998 -0
  359. package/src/local/transactions/mutations/MutationStore.ts +65 -0
  360. package/src/local/transactions/mutations/UnconfirmedWrites.ts +133 -0
  361. package/src/local/transactions/mutations/batchProcessing.ts +469 -0
  362. package/src/local/transactions/mutations/coalesceRules.ts +192 -0
  363. package/src/local/transactions/mutations/commitApi.ts +97 -0
  364. package/src/local/transactions/mutations/commitLane.ts +191 -0
  365. package/src/local/transactions/mutations/commitLatency.ts +164 -0
  366. package/src/local/transactions/mutations/commitPayload.ts +281 -0
  367. package/src/local/transactions/mutations/commitTransport.ts +174 -0
  368. package/src/local/transactions/mutations/deltaConfirmation.ts +298 -0
  369. package/src/local/transactions/mutations/durableCommitRestore.ts +128 -0
  370. package/src/local/transactions/mutations/durableWriteStore.ts +21 -0
  371. package/src/local/transactions/mutations/executionSelection.ts +42 -0
  372. package/src/local/transactions/mutations/failureHandling.ts +154 -0
  373. package/src/local/transactions/mutations/failurePolicy.ts +61 -0
  374. package/src/local/transactions/mutations/localMutation.ts +135 -0
  375. package/src/local/transactions/mutations/modelOperations.ts +210 -0
  376. package/src/local/transactions/mutations/mutationPersistence.ts +231 -0
  377. package/src/local/transactions/mutations/pendingDrain.ts +160 -0
  378. package/src/local/transactions/mutations/processingScheduler.ts +35 -0
  379. package/src/local/transactions/mutations/queueCoalescing.ts +45 -0
  380. package/src/local/transactions/mutations/replayValidation.ts +192 -0
  381. package/src/local/transactions/reconnectDrain.ts +24 -0
  382. package/src/local/utils/mobxSetup.ts +388 -0
  383. package/src/local/views/QueryView.ts +311 -0
  384. package/src/local/views/ViewRegistry.ts +61 -0
  385. package/src/local/views/incrementalView.ts +92 -0
  386. package/src/plugin.ts +396 -0
  387. package/src/presenceStream.ts +279 -0
  388. package/src/react/AbloProvider.tsx +744 -0
  389. package/src/react/ClientSideSuspense.tsx +57 -0
  390. package/src/react/DefaultFallback.tsx +60 -0
  391. package/src/react/context.ts +89 -0
  392. package/src/react/createAbloReact.ts +116 -0
  393. package/src/react/internalContext.ts +38 -0
  394. package/src/react/useAblo.ts +280 -0
  395. package/src/react/useCurrentUserId.ts +17 -0
  396. package/src/react/useErrorListener.ts +22 -0
  397. package/src/react/useMutationFailureListener.ts +34 -0
  398. package/src/react/useMutators.ts +184 -0
  399. package/src/react/useSyncStatus.ts +42 -0
  400. package/src/react/useUndoScope.ts +143 -0
  401. package/src/react.ts +69 -0
  402. package/src/reactRuntime.ts +10 -0
  403. package/src/surface.ts +106 -0
  404. package/src/useReactive.ts +51 -0
@@ -0,0 +1,192 @@
1
+ /**
2
+ * The queue's rules for coalescing operations that touch the same row, so their
3
+ * causal order is preserved. {@link MutationQueue} calls into these through a
4
+ * small store-shaped interface:
5
+ *
6
+ * - Create-then-delete cancellation ({@link takeUnsentCreateForModel}):
7
+ * deleting a row whose create never left the client cancels both locally.
8
+ * - The create barrier ({@link findCreateBarrierForDelete}) and deferred-delete
9
+ * parking ({@link deferDeleteUntilCreateSettles} /
10
+ * {@link releaseDeferredDeletesForCreate}): once a create has been sent, a
11
+ * delete must wait for it to settle, or the server could receive the delete
12
+ * before the create.
13
+ * - Update-payload merging ({@link mergeUpdateData}): collapses rapid updates
14
+ * to the same row into one wire operation.
15
+ *
16
+ * The queue keeps the `enqueue` and `delete` methods that orchestrate optimistic
17
+ * state and events; these functions hold only the coalescing rules.
18
+ */
19
+
20
+ import type { MutationInput, QueuedMutation } from './commitPayload.js';
21
+
22
+ /** The subset of {@link MutationStore} that the coalescing rules read. */
23
+ export interface MutationStoreLike {
24
+ get(id: string): QueuedMutation | undefined;
25
+ getByStatus(status: QueuedMutation['status']): QueuedMutation[];
26
+ }
27
+
28
+ export const entityKey = (modelName: string, modelId: string): string =>
29
+ `${modelName}:${modelId}`;
30
+
31
+ const isTransactionForModel = (
32
+ transaction: QueuedMutation,
33
+ modelName: string,
34
+ modelId: string,
35
+ ): boolean => transaction.modelName === modelName && transaction.modelId === modelId;
36
+
37
+ /**
38
+ * Finds and removes a create for the given model and id that has never been
39
+ * sent, searching the staging area, the execution queue, and the store's
40
+ * pending bucket in that order. It splices the match out of whichever queue
41
+ * held it, so the caller can cancel it rather than send a create followed by a
42
+ * delete.
43
+ */
44
+ export function takeUnsentCreateForModel(
45
+ staged: QueuedMutation[],
46
+ queued: QueuedMutation[],
47
+ store: Pick<MutationStoreLike, 'getByStatus'>,
48
+ modelName: string,
49
+ modelId: string,
50
+ ): QueuedMutation | undefined {
51
+ const isUnsentCreate = (tx: QueuedMutation): boolean =>
52
+ tx.type === 'create' &&
53
+ tx.status === 'pending' &&
54
+ tx.attempts === 0 &&
55
+ isTransactionForModel(tx, modelName, modelId);
56
+
57
+ const stagedIndex = staged.findIndex(isUnsentCreate);
58
+ if (stagedIndex >= 0) {
59
+ return staged.splice(stagedIndex, 1)[0];
60
+ }
61
+
62
+ const queuedIndex = queued.findIndex(isUnsentCreate);
63
+ if (queuedIndex >= 0) {
64
+ return queued.splice(queuedIndex, 1)[0];
65
+ }
66
+
67
+ return store.getByStatus('pending').find(isUnsentCreate);
68
+ }
69
+
70
+ /**
71
+ * Returns the most recent in-flight create for the given model and id that a
72
+ * delete must wait behind, or undefined if there is none. A pending create that
73
+ * has never been attempted is not a barrier, because it can be cancelled
74
+ * instead; once a create has been sent, even a retry-pending one is a barrier.
75
+ */
76
+ export function findCreateBarrierForDelete(
77
+ store: Pick<MutationStoreLike, 'getByStatus'>,
78
+ modelName: string,
79
+ modelId: string,
80
+ ): QueuedMutation | undefined {
81
+ const liveCreates = [
82
+ ...store.getByStatus('pending'),
83
+ ...store.getByStatus('executing'),
84
+ ...store.getByStatus('awaiting_delta'),
85
+ ].filter((tx) =>
86
+ tx.type === 'create' &&
87
+ isTransactionForModel(tx, modelName, modelId) &&
88
+ // A never-attempted pending create can be cancelled instead. Once the
89
+ // create has been sent, even a retry-pending state is a causal barrier:
90
+ // the server may already have applied it and only the response was lost.
91
+ (tx.status !== 'pending' || tx.attempts > 0)
92
+ );
93
+
94
+ return liveCreates.sort((a, b) => b.createdAt - a.createdAt)[0];
95
+ }
96
+
97
+ /**
98
+ * Parks a delete until the create for the same row settles, keyed by the
99
+ * create's model and id. {@link releaseDeferredDeletesForCreate} re-enqueues
100
+ * the parked deletes once that create completes.
101
+ */
102
+ export function deferDeleteUntilCreateSettles(
103
+ deferredDeletesByCreate: Map<string, QueuedMutation[]>,
104
+ createTransaction: QueuedMutation,
105
+ deleteTransaction: QueuedMutation,
106
+ ): void {
107
+ const key = entityKey(createTransaction.modelName, createTransaction.modelId);
108
+ const deferred = deferredDeletesByCreate.get(key) ?? [];
109
+ deferred.push(deleteTransaction);
110
+ deferredDeletesByCreate.set(key, deferred);
111
+ }
112
+
113
+ /**
114
+ * Re-enqueues the deletes parked behind a create once that create settles,
115
+ * skipping any whose status is no longer pending.
116
+ */
117
+ export function releaseDeferredDeletesForCreate(
118
+ deferredDeletesByCreate: Map<string, QueuedMutation[]>,
119
+ store: Pick<MutationStoreLike, 'get'>,
120
+ enqueue: (transaction: QueuedMutation) => void,
121
+ createTransaction: QueuedMutation,
122
+ ): void {
123
+ const key = entityKey(createTransaction.modelName, createTransaction.modelId);
124
+ const deferred = deferredDeletesByCreate.get(key);
125
+ if (!deferred || deferred.length === 0) return;
126
+
127
+ deferredDeletesByCreate.delete(key);
128
+
129
+ for (const deleteTransaction of deferred) {
130
+ if (store.get(deleteTransaction.id)?.status !== 'pending') continue;
131
+ enqueue(deleteTransaction);
132
+ }
133
+ }
134
+
135
+ /**
136
+ * Merges two update payloads for the same row into one. Later values win, with
137
+ * one exception: a `metadata` field is deep-merged as an object — parsing it
138
+ * first when it arrives as a JSON string — rather than replaced, so partial
139
+ * metadata updates accumulate instead of overwriting each other.
140
+ */
141
+ export function mergeUpdateData(
142
+ left: MutationInput | undefined,
143
+ right: MutationInput | undefined,
144
+ _modelName?: string
145
+ ): MutationInput {
146
+ const out: MutationInput = { ...(left || {}) };
147
+ const src = right || {};
148
+
149
+ for (const key of Object.keys(src)) {
150
+ // Special case: metadata payloads may be JSON strings; merge objects instead of clobbering
151
+ if (key === 'metadata') {
152
+ const l = out.metadata;
153
+ const r = src.metadata;
154
+
155
+ // If both sides undefined/null, continue
156
+ if (l == null && r == null) {
157
+ continue;
158
+ }
159
+
160
+ // Normalize to objects
161
+ const toObj = (v: unknown): Record<string, unknown> => {
162
+ if (v == null) return {};
163
+ if (typeof v === 'string') {
164
+ try {
165
+ return JSON.parse(v);
166
+ } catch {
167
+ return {};
168
+ }
169
+ }
170
+ if (typeof v === 'object') return v as Record<string, unknown>;
171
+ return {};
172
+ };
173
+
174
+ const lobj = toObj(l);
175
+ const robj = toObj(r);
176
+ const merged = { ...lobj, ...robj };
177
+ // Re-stringify to match schema input type
178
+ try {
179
+ out.metadata = JSON.stringify(merged);
180
+ } catch {
181
+ // Fallback to right-hand side if stringify fails
182
+ out.metadata = typeof r === 'string' ? r : JSON.stringify(robj || {});
183
+ }
184
+ continue;
185
+ }
186
+
187
+ // Default: shallow overwrite with right-hand value
188
+ out[key] = src[key];
189
+ }
190
+
191
+ return out;
192
+ }
@@ -0,0 +1,97 @@
1
+ import { AbloIdempotencyError } from '@abloatai/transaction/errors';
2
+ import type { ReadDependency, TrackDependency } from '@abloatai/transaction/coordination/schema';
3
+ import { stableStringify } from '@abloatai/transaction/utils/json';
4
+ import type { DurableCommitEnvelope } from '@abloatai/transaction/transactions/settlement/commitEnvelope';
5
+ import type { CommitTransaction } from './commitLane.js';
6
+ import type { SealDurableCommitInput } from './commitTransport.js';
7
+
8
+ export interface CommitApiContext {
9
+ readonly assertDurableReplayOpen: () => void;
10
+ readonly commitStore: Map<string, CommitTransaction>;
11
+ readonly commitLane: CommitTransaction[];
12
+ readonly replicationLagErrors: Map<string, Error>;
13
+ readonly clearReplicationLagState: (transactionId: string) => void;
14
+ readonly nextCommitSequence: () => number;
15
+ readonly sealDurableCommit: (input: SealDurableCommitInput) => Promise<DurableCommitEnvelope>;
16
+ readonly processCommitLane: () => Promise<void>;
17
+ readonly emitCommitLifecycle: (event: string, payload: object) => void;
18
+ }
19
+
20
+ export async function enqueueCommit(
21
+ ctx: CommitApiContext,
22
+ clientTxId: string,
23
+ operations: CommitTransaction['operations'],
24
+ options: { reads?: ReadDependency[] | null; track?: TrackDependency[] | null } = {},
25
+ ): Promise<void> {
26
+ ctx.assertDurableReplayOpen();
27
+ const existing = ctx.commitStore.get(clientTxId);
28
+ if (existing) {
29
+ await existing.sealPromise;
30
+ const existingIntent = stableStringify({
31
+ operations: existing.operations,
32
+ reads: existing.reads ?? null,
33
+ track: existing.track ?? null,
34
+ });
35
+ const incomingIntent = stableStringify({
36
+ operations,
37
+ reads: options.reads ?? null,
38
+ track: options.track ?? null,
39
+ });
40
+ if (existingIntent !== incomingIntent) {
41
+ throw new AbloIdempotencyError(
42
+ 'Idempotency key reused with a different atomic commit request',
43
+ { code: 'idempotency_conflict' },
44
+ );
45
+ }
46
+ if (existing.status === 'awaiting_delta' && ctx.replicationLagErrors.has(existing.id)) {
47
+ ctx.clearReplicationLagState(existing.id);
48
+ existing.status = 'pending';
49
+ ctx.commitLane.push(existing);
50
+ }
51
+ if (existing.status === 'pending') void ctx.processCommitLane();
52
+ return;
53
+ }
54
+
55
+ ctx.emitCommitLifecycle('commit:staging', { clientTxId, operations });
56
+ const now = Date.now();
57
+ const tx: CommitTransaction = {
58
+ id: clientTxId,
59
+ kind: 'commit',
60
+ operations: [...operations],
61
+ ...(options.reads ? { reads: options.reads } : {}),
62
+ ...(options.track ? { track: options.track } : {}),
63
+ status: 'pending',
64
+ createdAt: now,
65
+ attempts: 0,
66
+ sealedAt: now,
67
+ sequence: ctx.nextCommitSequence(),
68
+ };
69
+ ctx.commitStore.set(clientTxId, tx);
70
+ tx.sealPromise = ctx.sealDurableCommit({
71
+ idempotencyKey: tx.id,
72
+ origin: 'atomic_commit',
73
+ operations: tx.operations,
74
+ commitOptions: {
75
+ ...(tx.reads ? { reads: tx.reads } : {}),
76
+ ...(tx.track ? { track: tx.track } : {}),
77
+ },
78
+ createdAt: tx.createdAt,
79
+ sealedAt: tx.sealedAt,
80
+ sequence: tx.sequence,
81
+ }).then((envelope) => {
82
+ tx.durableEnvelope = envelope;
83
+ tx.operations = envelope.operations.map((operation) => ({ ...operation }));
84
+ });
85
+ try {
86
+ await tx.sealPromise;
87
+ } catch (error) {
88
+ ctx.commitStore.delete(clientTxId);
89
+ ctx.emitCommitLifecycle('commit:seal_failed', { clientTxId });
90
+ throw error;
91
+ } finally {
92
+ tx.sealPromise = undefined;
93
+ }
94
+ ctx.commitLane.push(tx);
95
+ ctx.emitCommitLifecycle('commit:created', { clientTxId, operations: tx.operations });
96
+ void ctx.processCommitLane();
97
+ }
@@ -0,0 +1,191 @@
1
+ import type { RuntimeContext } from '../../RuntimeContext.js';
2
+ import type { ReadDependency, TrackDependency, OnStaleMode, StaleNotification } from '@abloatai/transaction/coordination/schema';
3
+ import { AbloConnectionError } from '@abloatai/transaction/errors';
4
+ import type { MutationCommitResult } from '@abloatai/transaction/wire/commit';
5
+ import type {
6
+ DurableCommitEnvelope,
7
+ DurableCommitOperation,
8
+ } from '@abloatai/transaction/transactions/settlement/commitEnvelope';
9
+ import type { SealDurableCommitInput } from './commitTransport.js';
10
+
11
+ export interface CommitTransaction {
12
+ id: string;
13
+ kind: 'commit';
14
+ operations: {
15
+ type: DurableCommitOperation['type'];
16
+ model: string;
17
+ id: string;
18
+ input?: Record<string, unknown>;
19
+ transactionId?: string;
20
+ readAt?: number | null;
21
+ onStale?: OnStaleMode | null;
22
+ }[];
23
+ reads?: ReadDependency[] | null;
24
+ track?: TrackDependency[] | null;
25
+ status: 'pending' | 'executing' | 'awaiting_delta' | 'completed' | 'failed';
26
+ createdAt: number;
27
+ attempts: number;
28
+ transientAttempts?: number;
29
+ lastSyncId?: number;
30
+ correlationId?: string;
31
+ error?: Error;
32
+ sealedAt: number;
33
+ sequence: number;
34
+ sealPromise?: Promise<void>;
35
+ durableEnvelope?: DurableCommitEnvelope;
36
+ sourceMutationIds?: string[];
37
+ }
38
+
39
+ export interface CommitLaneContext {
40
+ readonly runtime: RuntimeContext;
41
+ readonly config: { maxRetries: number };
42
+ readonly commitLane: CommitTransaction[];
43
+ readonly commitNotifications: Map<string, StaleNotification[]>;
44
+ readonly commitMissingIds: Map<string, string[]>;
45
+ readonly commitProcessing: boolean;
46
+ readonly setCommitProcessing: (value: boolean) => void;
47
+ readonly durableReplayBlock: object | null;
48
+ readonly sealDurableCommit: (input: SealDurableCommitInput) => Promise<DurableCommitEnvelope>;
49
+ readonly assertEnvelopeInsideReplayWindow: (envelope: DurableCommitEnvelope) => void;
50
+ readonly dispatchCommit: (envelope: DurableCommitEnvelope) => Promise<MutationCommitResult>;
51
+ readonly persistDurableCommitAcceptance: (envelope: DurableCommitEnvelope, result: MutationCommitResult) => Promise<DurableCommitEnvelope>;
52
+ readonly removeDurableCommit: (idempotencyKey: string) => Promise<void>;
53
+ readonly queuedCommitEchoSyncId: (transaction: CommitTransaction) => number | undefined;
54
+ readonly completeQueuedCommit: (transaction: CommitTransaction, syncId: number) => void;
55
+ readonly scheduleReplicationLagTimeout: (transactionId: string, clientTxId: string, correlationId?: string) => void;
56
+ readonly noteAck: (syncId: number | undefined) => void;
57
+ readonly isDefinitiveRejection: (error: Error) => boolean;
58
+ readonly isPermanentError: (error: Error) => boolean;
59
+ readonly emitCommitLifecycle: (event: string, payload: object) => void;
60
+ }
61
+
62
+ export interface CommitReceiptContext {
63
+ readonly commitStore: Map<string, CommitTransaction>;
64
+ readonly commitNotifications: Map<string, StaleNotification[]>;
65
+ readonly commitMissingIds: Map<string, string[]>;
66
+ readonly replicationLagErrors: Map<string, Error>;
67
+ readonly on: (event: string, listener: (payload: object) => void) => void;
68
+ readonly off: (event: string, listener: (payload: object) => void) => void;
69
+ }
70
+
71
+ export function waitForCommitReceipt(
72
+ ctx: CommitReceiptContext,
73
+ clientTxId: string,
74
+ ): Promise<{ lastSyncId: number; notifications?: StaleNotification[]; missingIds?: string[] }> {
75
+ const drainNotifications = (): StaleNotification[] | undefined => {
76
+ const notifications = ctx.commitNotifications.get(clientTxId);
77
+ if (!notifications) return undefined;
78
+ ctx.commitNotifications.delete(clientTxId);
79
+ return notifications.length > 0 ? notifications : undefined;
80
+ };
81
+ const drainMissingIds = (): string[] | undefined => {
82
+ const ids = ctx.commitMissingIds.get(clientTxId);
83
+ if (!ids) return undefined;
84
+ ctx.commitMissingIds.delete(clientTxId);
85
+ return ids.length > 0 ? ids : undefined;
86
+ };
87
+ const receipt = (lastSyncId: number) => {
88
+ const missingIds = drainMissingIds();
89
+ return {
90
+ lastSyncId,
91
+ notifications: drainNotifications(),
92
+ ...(missingIds ? { missingIds } : {}),
93
+ };
94
+ };
95
+ return new Promise((resolve, reject) => {
96
+ const existing = ctx.commitStore.get(clientTxId);
97
+ if (existing?.status === 'completed') { resolve(receipt(existing.lastSyncId ?? 0)); return; }
98
+ if (existing?.status === 'failed' && existing.error) { reject(existing.error); return; }
99
+ const lagError = ctx.replicationLagErrors.get(clientTxId);
100
+ if (lagError) { reject(lagError); return; }
101
+ const onCompleted = (tx: object) => { cleanup(); resolve(receipt((tx as CommitTransaction).lastSyncId ?? 0)); };
102
+ const onFailed = (payload: object) => { cleanup(); reject((payload as { error: Error }).error); };
103
+ const onLagged = (payload: object) => { cleanup(); reject((payload as { error: Error }).error); };
104
+ const cleanup = () => {
105
+ ctx.off(`transaction:completed:${clientTxId}`, onCompleted);
106
+ ctx.off(`transaction:failed:${clientTxId}`, onFailed);
107
+ ctx.off(`transaction:confirmation_lagged:${clientTxId}`, onLagged);
108
+ };
109
+ ctx.on(`transaction:completed:${clientTxId}`, onCompleted);
110
+ ctx.on(`transaction:failed:${clientTxId}`, onFailed);
111
+ ctx.on(`transaction:confirmation_lagged:${clientTxId}`, onLagged);
112
+ });
113
+ }
114
+
115
+ export async function processCommitLane(ctx: CommitLaneContext): Promise<void> {
116
+ if (ctx.commitProcessing || ctx.durableReplayBlock) return;
117
+ ctx.setCommitProcessing(true);
118
+ try {
119
+ while (ctx.commitLane.length > 0) {
120
+ const tx = ctx.commitLane[0];
121
+ if (!tx) break;
122
+ if (tx.status !== 'pending') {
123
+ ctx.commitLane.shift();
124
+ continue;
125
+ }
126
+ tx.status = 'executing';
127
+ tx.attempts += 1;
128
+ let dispatchStarted = false;
129
+ try {
130
+ const durableEnvelope = tx.durableEnvelope ?? await ctx.sealDurableCommit({
131
+ idempotencyKey: tx.id,
132
+ origin: 'atomic_commit',
133
+ operations: tx.operations,
134
+ sourceMutationIds: tx.sourceMutationIds,
135
+ commitOptions: {
136
+ ...(tx.reads ? { reads: tx.reads } : {}),
137
+ ...(tx.track ? { track: tx.track } : {}),
138
+ },
139
+ createdAt: tx.createdAt,
140
+ sealedAt: tx.sealedAt,
141
+ sequence: tx.sequence,
142
+ });
143
+ tx.durableEnvelope = durableEnvelope;
144
+ ctx.assertEnvelopeInsideReplayWindow(durableEnvelope);
145
+ dispatchStarted = true;
146
+ const result = await ctx.dispatchCommit(durableEnvelope);
147
+ tx.durableEnvelope = await ctx.persistDurableCommitAcceptance(durableEnvelope, result);
148
+ tx.lastSyncId = result.lastSyncId;
149
+ if (result.notifications?.length) ctx.commitNotifications.set(tx.id, result.notifications);
150
+ if (result.missingIds?.length) ctx.commitMissingIds.set(tx.id, result.missingIds);
151
+ ctx.commitLane.shift();
152
+ if (result.status === 'queued') {
153
+ tx.correlationId = result.correlationId;
154
+ tx.status = 'awaiting_delta';
155
+ const echoSyncId = ctx.queuedCommitEchoSyncId(tx);
156
+ if (echoSyncId !== undefined) ctx.completeQueuedCommit(tx, echoSyncId);
157
+ else ctx.scheduleReplicationLagTimeout(tx.id, tx.id, result.correlationId);
158
+ } else {
159
+ await ctx.removeDurableCommit(tx.id);
160
+ ctx.noteAck(tx.lastSyncId);
161
+ tx.status = 'completed';
162
+ ctx.emitCommitLifecycle('transaction:completed', tx);
163
+ ctx.emitCommitLifecycle(`transaction:completed:${tx.id}`, tx);
164
+ }
165
+ } catch (cause) {
166
+ const error = cause instanceof Error ? cause : new Error(String(cause));
167
+ if (dispatchStarted && ctx.isDefinitiveRejection(error)) await ctx.removeDurableCommit(tx.id);
168
+ if (!(error instanceof AbloConnectionError)) tx.transientAttempts = (tx.transientAttempts ?? 0) + 1;
169
+ const exhausted = (tx.transientAttempts ?? 0) > ctx.config.maxRetries;
170
+ if (!ctx.isPermanentError(error) && !exhausted) {
171
+ tx.status = 'pending';
172
+ ctx.runtime.logger.debug('[MutationQueue] commit lane transient', {
173
+ txId: tx.id.slice(0, 12), attempts: tx.attempts,
174
+ transientAttempts: tx.transientAttempts ?? 0, message: error.message,
175
+ });
176
+ break;
177
+ }
178
+ tx.status = 'failed';
179
+ tx.error = error;
180
+ ctx.commitLane.shift();
181
+ ctx.runtime.logger.debug('[MutationQueue] commit lane permanent error', {
182
+ txId: tx.id.slice(0, 12), attempts: tx.attempts, message: error.message,
183
+ });
184
+ ctx.emitCommitLifecycle('transaction:failed', { transaction: tx, error, permanent: true });
185
+ ctx.emitCommitLifecycle(`transaction:failed:${tx.id}`, { error });
186
+ }
187
+ }
188
+ } finally {
189
+ ctx.setCommitProcessing(false);
190
+ }
191
+ }
@@ -0,0 +1,164 @@
1
+ /**
2
+ * Commit latency — how long a user's edit actually takes to land.
3
+ *
4
+ * The engine has never measured this. HUDs and dashboards reach for
5
+ * `window.fetch` timings, which the sync engine's WebSocket never touches, so
6
+ * the latency a user sees reported while editing has had nothing to do with
7
+ * the writes they are making. This module closes that gap without adding a
8
+ * single timestamp to the hot path: `MutationQueue` already emits the commit
9
+ * lifecycle, and the events already carry the correlation key.
10
+ *
11
+ * Three events, two intervals:
12
+ *
13
+ * commit:staging ──sealMs──▶ commit:created ──ackMs──▶ transaction:completed
14
+ *
15
+ * - `sealMs` is **local** — writing the durable envelope before the commit is
16
+ * allowed onto the wire. Slow here means durable storage, not network.
17
+ * - `ackMs` is **remote** — dispatch, round-trip, and server work. For a
18
+ * commit routed at a connected source this also spans the wait for the
19
+ * correlated echo that promotes `queued` to `confirmed`, so it answers
20
+ * "when did my edit become real" rather than raw socket round-trip. Read a
21
+ * large `ackMs` against a small `sealMs` as a network or replication cost.
22
+ *
23
+ * Correlation is by `clientTxId`: `MutationQueue` uses it as the transaction
24
+ * id verbatim, so the staging event and the completion event share one key.
25
+ */
26
+
27
+ /**
28
+ * The slice of an event emitter this module needs. Declared structurally so a
29
+ * plain object can stand in under test — `MutationQueue` satisfies it by
30
+ * extending `EventEmitter`.
31
+ */
32
+ export interface CommitEventSource {
33
+ on(event: string, listener: (payload: unknown) => void): unknown;
34
+ off(event: string, listener: (payload: unknown) => void): unknown;
35
+ }
36
+
37
+ /** One completed commit, broken into its local and remote halves. */
38
+ export interface CommitLatencySample {
39
+ /** The commit's `clientTxId`, identical to its transaction id. */
40
+ clientTxId: string;
41
+ /** Milliseconds sealing the durable envelope locally. */
42
+ sealMs: number;
43
+ /** Milliseconds from sealed envelope to acknowledgement. */
44
+ ackMs: number;
45
+ /** Milliseconds from staging to acknowledgement — `sealMs + ackMs`. */
46
+ totalMs: number;
47
+ }
48
+
49
+ interface PendingCommitTiming {
50
+ stagedAt: number;
51
+ /** Set when the envelope seals; null while the seal is still in flight. */
52
+ sealedAt: number | null;
53
+ }
54
+
55
+ /**
56
+ * Cap on commits awaiting completion. A commit whose completion never arrives
57
+ * (connection dropped mid-flight, retry abandoned) would otherwise pin its
58
+ * entry forever, so the map is bounded rather than trusted to drain.
59
+ */
60
+ const MAX_PENDING_COMMITS = 256;
61
+
62
+ function nowMs(): number {
63
+ return typeof performance !== 'undefined' ? performance.now() : Date.now();
64
+ }
65
+
66
+ /** Read `clientTxId` off a `commit:*` payload, or null if it isn't shaped so. */
67
+ function readClientTxId(payload: unknown): string | null {
68
+ if (typeof payload !== 'object' || payload === null) return null;
69
+ const { clientTxId } = payload as { clientTxId?: unknown };
70
+ return typeof clientTxId === 'string' ? clientTxId : null;
71
+ }
72
+
73
+ /** Read `id` off a transaction payload (`transaction:completed` sends the tx). */
74
+ function readTransactionId(payload: unknown): string | null {
75
+ if (typeof payload !== 'object' || payload === null) return null;
76
+ const { id } = payload as { id?: unknown };
77
+ return typeof id === 'string' ? id : null;
78
+ }
79
+
80
+ /** `transaction:failed` wraps the transaction rather than sending it bare. */
81
+ function readFailedTransactionId(payload: unknown): string | null {
82
+ if (typeof payload !== 'object' || payload === null) return null;
83
+ return readTransactionId((payload as { transaction?: unknown }).transaction);
84
+ }
85
+
86
+ /**
87
+ * Pair commit lifecycle events into latency samples. Returns an unsubscribe
88
+ * function that also drops any still-pending timings.
89
+ *
90
+ * `onSample` fires once per commit that completes, in completion order.
91
+ */
92
+ export function observeCommitLatency(
93
+ source: CommitEventSource,
94
+ onSample: (sample: CommitLatencySample) => void,
95
+ ): () => void {
96
+ const pending = new Map<string, PendingCommitTiming>();
97
+
98
+ const handleStaging = (payload: unknown): void => {
99
+ const id = readClientTxId(payload);
100
+ if (id === null) return;
101
+ // Map preserves insertion order, so the first key is the stalest entry.
102
+ if (pending.size >= MAX_PENDING_COMMITS) {
103
+ const oldest = pending.keys().next();
104
+ if (!oldest.done) pending.delete(oldest.value);
105
+ }
106
+ pending.set(id, { stagedAt: nowMs(), sealedAt: null });
107
+ };
108
+
109
+ const handleCreated = (payload: unknown): void => {
110
+ const id = readClientTxId(payload);
111
+ if (id === null) return;
112
+ const timing = pending.get(id);
113
+ if (timing === undefined) return;
114
+ timing.sealedAt = nowMs();
115
+ };
116
+
117
+ const handleCompleted = (payload: unknown): void => {
118
+ const id = readTransactionId(payload);
119
+ if (id === null) return;
120
+ const timing = pending.get(id);
121
+ // `transaction:completed` also fires for local (non-commit) transactions
122
+ // and for mutation-log replay. Only ids we staged are commits, so an
123
+ // absent entry is the normal way those are filtered out.
124
+ if (timing === undefined) return;
125
+ pending.delete(id);
126
+
127
+ const completedAt = nowMs();
128
+ // A commit can complete without an observed seal only if the listener was
129
+ // attached mid-flight; attributing the whole span to `ackMs` keeps
130
+ // `sealMs + ackMs === totalMs` true rather than reporting a bogus seal.
131
+ const sealedAt = timing.sealedAt ?? timing.stagedAt;
132
+ onSample({
133
+ clientTxId: id,
134
+ sealMs: sealedAt - timing.stagedAt,
135
+ ackMs: completedAt - sealedAt,
136
+ totalMs: completedAt - timing.stagedAt,
137
+ });
138
+ };
139
+
140
+ const handleSealFailed = (payload: unknown): void => {
141
+ const id = readClientTxId(payload);
142
+ if (id !== null) pending.delete(id);
143
+ };
144
+
145
+ const handleFailed = (payload: unknown): void => {
146
+ const id = readFailedTransactionId(payload);
147
+ if (id !== null) pending.delete(id);
148
+ };
149
+
150
+ source.on('commit:staging', handleStaging);
151
+ source.on('commit:created', handleCreated);
152
+ source.on('commit:seal_failed', handleSealFailed);
153
+ source.on('transaction:completed', handleCompleted);
154
+ source.on('transaction:failed', handleFailed);
155
+
156
+ return () => {
157
+ source.off('commit:staging', handleStaging);
158
+ source.off('commit:created', handleCreated);
159
+ source.off('commit:seal_failed', handleSealFailed);
160
+ source.off('transaction:completed', handleCompleted);
161
+ source.off('transaction:failed', handleFailed);
162
+ pending.clear();
163
+ };
164
+ }