@abloatai/ablo 0.36.0 → 0.37.1
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.
- package/AGENTS.md +2 -2
- package/CHANGELOG.md +55 -2014
- package/NOTICE +2 -2
- package/README.md +45 -63
- package/assets/banner.png +0 -0
- package/dist/auth.d.ts +2 -0
- package/dist/auth.d.ts.map +1 -0
- package/dist/auth.js +2 -0
- package/dist/auth.js.map +1 -0
- package/dist/client.d.ts +3 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +3 -0
- package/dist/client.js.map +1 -0
- package/dist/coordination.d.ts +2 -0
- package/dist/coordination.d.ts.map +1 -0
- package/dist/coordination.js +2 -0
- package/dist/coordination.js.map +1 -0
- package/dist/index.d.ts +3 -114
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -163
- package/dist/index.js.map +1 -0
- package/dist/react.d.ts +4 -0
- package/dist/react.d.ts.map +1 -0
- package/dist/react.js +3 -0
- package/dist/react.js.map +1 -0
- package/dist/schema.d.ts +2 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/schema.js +2 -0
- package/dist/schema.js.map +1 -0
- package/dist/server.d.ts +2 -0
- package/dist/server.d.ts.map +1 -0
- package/dist/server.js +2 -0
- package/dist/server.js.map +1 -0
- package/dist/source-conformance.d.ts +2 -0
- package/dist/source-conformance.d.ts.map +1 -0
- package/dist/source-conformance.js +2 -0
- package/dist/source-conformance.js.map +1 -0
- package/dist/source-drizzle.d.ts +2 -0
- package/dist/source-drizzle.d.ts.map +1 -0
- package/dist/source-drizzle.js +2 -0
- package/dist/source-drizzle.js.map +1 -0
- package/dist/source-kysely.d.ts +2 -0
- package/dist/source-kysely.d.ts.map +1 -0
- package/dist/source-kysely.js +2 -0
- package/dist/source-kysely.js.map +1 -0
- package/dist/source-next.d.ts +2 -0
- package/dist/source-next.d.ts.map +1 -0
- package/dist/source-next.js +2 -0
- package/dist/source-next.js.map +1 -0
- package/dist/source.d.ts +2 -0
- package/dist/source.d.ts.map +1 -0
- package/dist/source.js +2 -0
- package/dist/source.js.map +1 -0
- package/dist/wire.d.ts +2 -0
- package/dist/wire.d.ts.map +1 -0
- package/dist/wire.js +2 -0
- package/dist/wire.js.map +1 -0
- package/docs/agents.md +1 -1
- package/docs/api-keys.md +7 -6
- package/docs/api.md +10 -10
- package/docs/client-behavior.md +5 -5
- package/docs/coordination.md +52 -62
- package/docs/data-sources.md +1 -1
- package/docs/examples/agent-human.md +4 -4
- package/docs/examples/ai-sdk-tool.md +1 -1
- package/docs/examples/existing-python-backend.md +15 -4
- package/docs/examples/nextjs.md +27 -6
- package/docs/examples/server-agent.md +2 -2
- package/docs/how-it-works.md +4 -4
- package/docs/identity.md +2 -1
- package/docs/integration-guide.md +24 -13
- package/docs/internal/README.md +18 -0
- package/docs/internal/agent-fleet-coordination-design.md +171 -0
- package/docs/internal/agent-orchestration.md +58 -0
- package/docs/internal/commit-identifiers.md +91 -0
- package/docs/internal/concurrency-open-decisions.md +37 -0
- package/docs/internal/data-source-reverse-channel.md +150 -0
- package/docs/internal/per-field-conflict-detection.md +165 -0
- package/docs/internal/postgres-replication.md +64 -0
- package/docs/internal/serializable-schema.md +119 -0
- package/docs/internal/structure.md +32 -0
- package/docs/mcp.md +2 -2
- package/docs/migration.md +3 -3
- package/docs/quickstart.md +2 -2
- package/docs/react.md +5 -5
- package/docs/schema-contract.md +3 -3
- package/docs/sessions.md +91 -37
- package/examples/README.md +2 -2
- package/examples/data-source/README.md +1 -1
- package/examples/data-source/ablo-driver.ts +1 -1
- package/examples/data-source/customer-server.ts +1 -1
- package/examples/data-source/run.ts +1 -1
- package/examples/data-source/schema.ts +1 -1
- package/examples/quickstart.ts +2 -2
- package/llms.txt +8 -8
- package/package.json +63 -166
- package/bin/ablo.cjs +0 -39
- package/dist/BaseSyncedStore.d.ts +0 -843
- package/dist/BaseSyncedStore.js +0 -1971
- package/dist/Database.d.ts +0 -323
- package/dist/Database.js +0 -1502
- package/dist/InstanceCache.d.ts +0 -237
- package/dist/InstanceCache.js +0 -1166
- package/dist/LazyReferenceCollection.d.ts +0 -177
- package/dist/LazyReferenceCollection.js +0 -461
- package/dist/Model.d.ts +0 -454
- package/dist/Model.js +0 -919
- package/dist/ModelRegistry.d.ts +0 -225
- package/dist/ModelRegistry.js +0 -539
- package/dist/NetworkMonitor.d.ts +0 -28
- package/dist/NetworkMonitor.js +0 -79
- package/dist/RuntimeContext.d.ts +0 -52
- package/dist/RuntimeContext.js +0 -80
- package/dist/SyncClient.d.ts +0 -541
- package/dist/SyncClient.js +0 -2202
- package/dist/adapters/alwaysOnline.d.ts +0 -14
- package/dist/adapters/alwaysOnline.js +0 -17
- package/dist/adapters/inMemoryStorage.d.ts +0 -31
- package/dist/adapters/inMemoryStorage.js +0 -110
- package/dist/ai-sdk/coordinatedTool.d.ts +0 -120
- package/dist/ai-sdk/coordinatedTool.js +0 -134
- package/dist/ai-sdk/coordinationContext.d.ts +0 -46
- package/dist/ai-sdk/coordinationContext.js +0 -106
- package/dist/ai-sdk/index.d.ts +0 -121
- package/dist/ai-sdk/index.js +0 -121
- package/dist/ai-sdk/wrap.d.ts +0 -65
- package/dist/ai-sdk/wrap.js +0 -39
- package/dist/auth/index.d.ts +0 -1
- package/dist/auth/index.js +0 -8
- package/dist/batching/index.d.ts +0 -55
- package/dist/batching/index.js +0 -147
- package/dist/client/Ablo.d.ts +0 -231
- package/dist/client/Ablo.js +0 -160
- package/dist/client/abloClient.d.ts +0 -309
- package/dist/client/abloClient.js +0 -13
- package/dist/client/clientPrelude.d.ts +0 -52
- package/dist/client/clientPrelude.js +0 -60
- package/dist/client/consoleLogger.d.ts +0 -35
- package/dist/client/consoleLogger.js +0 -44
- package/dist/client/coreClient.d.ts +0 -60
- package/dist/client/coreClient.js +0 -118
- package/dist/client/createInternalComponents.d.ts +0 -50
- package/dist/client/createInternalComponents.js +0 -98
- package/dist/client/createModelProxy.d.ts +0 -248
- package/dist/client/createModelProxy.js +0 -884
- package/dist/client/humans.d.ts +0 -69
- package/dist/client/humans.js +0 -78
- package/dist/client/modelRegistration.d.ts +0 -10
- package/dist/client/modelRegistration.js +0 -312
- package/dist/client/options.d.ts +0 -461
- package/dist/client/options.js +0 -7
- package/dist/client/reactiveEngine.d.ts +0 -53
- package/dist/client/reactiveEngine.js +0 -688
- package/dist/client/resourceTypes.d.ts +0 -12
- package/dist/client/resourceTypes.js +0 -10
- package/dist/client/schemaConfig.d.ts +0 -44
- package/dist/client/schemaConfig.js +0 -185
- package/dist/client/storeCluster.d.ts +0 -47
- package/dist/client/storeCluster.js +0 -118
- package/dist/client/storeLifecycle.d.ts +0 -61
- package/dist/client/storeLifecycle.js +0 -231
- package/dist/client/validateAbloOptions.d.ts +0 -42
- package/dist/client/validateAbloOptions.js +0 -43
- package/dist/client/wsMutationExecutor.d.ts +0 -27
- package/dist/client/wsMutationExecutor.js +0 -72
- package/dist/context.d.ts +0 -42
- package/dist/context.js +0 -81
- package/dist/coordination/ClaimLog.d.ts +0 -26
- package/dist/coordination/ClaimLog.js +0 -32
- package/dist/coordination/index.d.ts +0 -1
- package/dist/coordination/index.js +0 -8
- package/dist/core/index.d.ts +0 -33
- package/dist/core/index.js +0 -48
- package/dist/docs/catalog.d.ts +0 -72
- package/dist/docs/catalog.js +0 -230
- package/dist/docs/index.d.ts +0 -10
- package/dist/docs/index.js +0 -10
- package/dist/environment.d.ts +0 -1
- package/dist/environment.js +0 -8
- package/dist/interfaces/index.d.ts +0 -311
- package/dist/interfaces/index.js +0 -9
- package/dist/keys/index.d.ts +0 -1
- package/dist/keys/index.js +0 -8
- package/dist/mutators/RecordingMutation.d.ts +0 -36
- package/dist/mutators/RecordingMutation.js +0 -182
- package/dist/mutators/Transaction.d.ts +0 -40
- package/dist/mutators/Transaction.js +0 -58
- package/dist/mutators/UndoManager.d.ts +0 -258
- package/dist/mutators/UndoManager.js +0 -658
- package/dist/mutators/defineMutators.d.ts +0 -60
- package/dist/mutators/defineMutators.js +0 -18
- package/dist/mutators/inverseOp.d.ts +0 -126
- package/dist/mutators/inverseOp.js +0 -71
- package/dist/mutators/mutateActions.d.ts +0 -45
- package/dist/mutators/mutateActions.js +0 -105
- package/dist/mutators/readerActions.d.ts +0 -33
- package/dist/mutators/readerActions.js +0 -57
- package/dist/mutators/undoApply.d.ts +0 -51
- package/dist/mutators/undoApply.js +0 -117
- package/dist/policy/index.d.ts +0 -21
- package/dist/policy/index.js +0 -20
- package/dist/query/QueryProcessor.d.ts +0 -75
- package/dist/query/QueryProcessor.js +0 -255
- package/dist/query/client.d.ts +0 -64
- package/dist/query/client.js +0 -138
- package/dist/query/types.d.ts +0 -85
- package/dist/query/types.js +0 -16
- package/dist/react/AbloProvider.d.ts +0 -242
- package/dist/react/AbloProvider.js +0 -458
- package/dist/react/ClientSideSuspense.d.ts +0 -36
- package/dist/react/ClientSideSuspense.js +0 -17
- package/dist/react/DefaultFallback.d.ts +0 -24
- package/dist/react/DefaultFallback.js +0 -43
- package/dist/react/context.d.ts +0 -55
- package/dist/react/context.js +0 -29
- package/dist/react/createAbloReact.d.ts +0 -56
- package/dist/react/createAbloReact.js +0 -51
- package/dist/react/index.d.ts +0 -62
- package/dist/react/index.js +0 -69
- package/dist/react/internalContext.d.ts +0 -33
- package/dist/react/internalContext.js +0 -3
- package/dist/react/useAblo.d.ts +0 -82
- package/dist/react/useAblo.js +0 -120
- package/dist/react/useCurrentUserId.d.ts +0 -22
- package/dist/react/useCurrentUserId.js +0 -34
- package/dist/react/useErrorListener.d.ts +0 -20
- package/dist/react/useErrorListener.js +0 -38
- package/dist/react/useMutationFailureListener.d.ts +0 -26
- package/dist/react/useMutationFailureListener.js +0 -38
- package/dist/react/useMutators.d.ts +0 -56
- package/dist/react/useMutators.js +0 -84
- package/dist/react/useReactive.d.ts +0 -35
- package/dist/react/useReactive.js +0 -123
- package/dist/react/useSyncStatus.d.ts +0 -59
- package/dist/react/useSyncStatus.js +0 -76
- package/dist/react/useUndoScope.d.ts +0 -34
- package/dist/react/useUndoScope.js +0 -81
- package/dist/schema/coordination.d.ts +0 -112
- package/dist/schema/coordination.js +0 -133
- package/dist/schema/ddl.d.ts +0 -97
- package/dist/schema/ddl.js +0 -491
- package/dist/schema/ddlLock.d.ts +0 -35
- package/dist/schema/ddlLock.js +0 -46
- package/dist/schema/diff.d.ts +0 -225
- package/dist/schema/diff.js +0 -289
- package/dist/schema/generate.d.ts +0 -19
- package/dist/schema/generate.js +0 -86
- package/dist/schema/index.d.ts +0 -42
- package/dist/schema/index.js +0 -80
- package/dist/schema/queries.d.ts +0 -201
- package/dist/schema/queries.js +0 -144
- package/dist/schema/select.d.ts +0 -40
- package/dist/schema/select.js +0 -90
- package/dist/schema/serialize.d.ts +0 -115
- package/dist/schema/serialize.js +0 -265
- package/dist/schema/sugar.d.ts +0 -109
- package/dist/schema/sugar.js +0 -83
- package/dist/schema/syncDeltaRow.d.ts +0 -6
- package/dist/schema/syncDeltaRow.js +0 -6
- package/dist/server/adapter.d.ts +0 -173
- package/dist/server/adapter.js +0 -18
- package/dist/server/commit.d.ts +0 -107
- package/dist/server/commit.js +0 -1
- package/dist/server/index.d.ts +0 -14
- package/dist/server/index.js +0 -2
- package/dist/server/readConfig.d.ts +0 -80
- package/dist/server/readConfig.js +0 -8
- package/dist/server/storageMode.d.ts +0 -23
- package/dist/server/storageMode.js +0 -17
- package/dist/source/adapter.d.ts +0 -83
- package/dist/source/adapter.js +0 -24
- package/dist/source/adapters/drizzle.d.ts +0 -48
- package/dist/source/adapters/drizzle.js +0 -219
- package/dist/source/adapters/kysely.d.ts +0 -42
- package/dist/source/adapters/kysely.js +0 -205
- package/dist/source/adapters/kyselyMutationCore.d.ts +0 -76
- package/dist/source/adapters/kyselyMutationCore.js +0 -125
- package/dist/source/adapters/memory.d.ts +0 -13
- package/dist/source/adapters/memory.js +0 -130
- package/dist/source/adapters/prisma.d.ts +0 -63
- package/dist/source/adapters/prisma.js +0 -202
- package/dist/source/conformance.d.ts +0 -37
- package/dist/source/conformance.js +0 -215
- package/dist/source/connector.d.ts +0 -95
- package/dist/source/connector.js +0 -266
- package/dist/source/connectorProtocol.d.ts +0 -154
- package/dist/source/connectorProtocol.js +0 -163
- package/dist/source/contract.d.ts +0 -195
- package/dist/source/contract.js +0 -164
- package/dist/source/factory.d.ts +0 -92
- package/dist/source/factory.js +0 -286
- package/dist/source/idempotency.d.ts +0 -61
- package/dist/source/idempotency.js +0 -144
- package/dist/source/index.d.ts +0 -23
- package/dist/source/index.js +0 -30
- package/dist/source/migrations.d.ts +0 -21
- package/dist/source/migrations.js +0 -103
- package/dist/source/next.d.ts +0 -32
- package/dist/source/next.js +0 -25
- package/dist/source/pushQueue.d.ts +0 -134
- package/dist/source/pushQueue.js +0 -256
- package/dist/source/signing.d.ts +0 -92
- package/dist/source/signing.js +0 -162
- package/dist/source/types.d.ts +0 -401
- package/dist/source/types.js +0 -59
- package/dist/storeContract.d.ts +0 -145
- package/dist/storeContract.js +0 -12
- package/dist/stores/DatabaseManager.d.ts +0 -107
- package/dist/stores/DatabaseManager.js +0 -388
- package/dist/stores/ObjectStore.d.ts +0 -115
- package/dist/stores/ObjectStore.js +0 -393
- package/dist/stores/ObjectStoreContract.d.ts +0 -38
- package/dist/stores/ObjectStoreContract.js +0 -1
- package/dist/stores/StoreManager.d.ts +0 -114
- package/dist/stores/StoreManager.js +0 -304
- package/dist/stores/SyncActionStore.d.ts +0 -99
- package/dist/stores/SyncActionStore.js +0 -506
- package/dist/stores/openIDBWithTimeout.d.ts +0 -65
- package/dist/stores/openIDBWithTimeout.js +0 -153
- package/dist/stores/syncAction.d.ts +0 -26
- package/dist/stores/syncAction.js +0 -16
- package/dist/surface.d.ts +0 -36
- package/dist/surface.js +0 -75
- package/dist/sync/BootstrapFetcher.d.ts +0 -284
- package/dist/sync/BootstrapFetcher.js +0 -964
- package/dist/sync/ConnectionManager.d.ts +0 -8
- package/dist/sync/ConnectionManager.js +0 -8
- package/dist/sync/OnDemandLoader.d.ts +0 -231
- package/dist/sync/OnDemandLoader.js +0 -743
- package/dist/sync/SubscriptionManager.d.ts +0 -159
- package/dist/sync/SubscriptionManager.js +0 -243
- package/dist/sync/SyncWebSocket.d.ts +0 -173
- package/dist/sync/SyncWebSocket.js +0 -438
- package/dist/sync/awaitClaimGrant.d.ts +0 -6
- package/dist/sync/awaitClaimGrant.js +0 -6
- package/dist/sync/bootstrapApply.d.ts +0 -73
- package/dist/sync/bootstrapApply.js +0 -73
- package/dist/sync/commitFrames.d.ts +0 -8
- package/dist/sync/commitFrames.js +0 -8
- package/dist/sync/contextPorts.d.ts +0 -18
- package/dist/sync/contextPorts.js +0 -31
- package/dist/sync/createClaimStream.d.ts +0 -7
- package/dist/sync/createClaimStream.js +0 -7
- package/dist/sync/createPresenceStream.d.ts +0 -69
- package/dist/sync/createPresenceStream.js +0 -200
- package/dist/sync/createSnapshot.d.ts +0 -29
- package/dist/sync/createSnapshot.js +0 -118
- package/dist/sync/credentialLifecycle.d.ts +0 -7
- package/dist/sync/credentialLifecycle.js +0 -7
- package/dist/sync/deltaPipeline.d.ts +0 -114
- package/dist/sync/deltaPipeline.js +0 -278
- package/dist/sync/groupChange.d.ts +0 -116
- package/dist/sync/groupChange.js +0 -244
- package/dist/sync/participants.d.ts +0 -132
- package/dist/sync/participants.js +0 -346
- package/dist/sync/persistedPrefix.d.ts +0 -12
- package/dist/sync/persistedPrefix.js +0 -22
- package/dist/sync/schemaDrift.d.ts +0 -55
- package/dist/sync/schemaDrift.js +0 -53
- package/dist/sync/schemas.d.ts +0 -71
- package/dist/sync/schemas.js +0 -94
- package/dist/sync/syncCursor.d.ts +0 -40
- package/dist/sync/syncCursor.js +0 -55
- package/dist/sync/syncPlan.d.ts +0 -54
- package/dist/sync/syncPlan.js +0 -50
- package/dist/sync/wsFrameHandlers.d.ts +0 -8
- package/dist/sync/wsFrameHandlers.js +0 -8
- package/dist/syncLog/contract.d.ts +0 -20
- package/dist/syncLog/contract.js +0 -19
- package/dist/syncLog/index.d.ts +0 -1
- package/dist/syncLog/index.js +0 -1
- package/dist/transaction/ablo.d.ts +0 -88
- package/dist/transaction/ablo.js +0 -33
- package/dist/transaction/auth/apiKey.d.ts +0 -152
- package/dist/transaction/auth/apiKey.js +0 -419
- package/dist/transaction/auth/bootstrapScope.d.ts +0 -15
- package/dist/transaction/auth/bootstrapScope.js +0 -1
- package/dist/transaction/auth/capability.d.ts +0 -212
- package/dist/transaction/auth/capability.js +0 -224
- package/dist/transaction/auth/credentialEndpoint.d.ts +0 -61
- package/dist/transaction/auth/credentialEndpoint.js +0 -86
- package/dist/transaction/auth/credentialPolicy.d.ts +0 -148
- package/dist/transaction/auth/credentialPolicy.js +0 -125
- package/dist/transaction/auth/credentialSource.d.ts +0 -30
- package/dist/transaction/auth/credentialSource.js +0 -55
- package/dist/transaction/auth/hostedEndpoints.d.ts +0 -21
- package/dist/transaction/auth/hostedEndpoints.js +0 -21
- package/dist/transaction/auth/identity.d.ts +0 -55
- package/dist/transaction/auth/identity.js +0 -210
- package/dist/transaction/auth/index.d.ts +0 -162
- package/dist/transaction/auth/index.js +0 -304
- package/dist/transaction/auth/schemas.d.ts +0 -59
- package/dist/transaction/auth/schemas.js +0 -85
- package/dist/transaction/auth/sessionMint.d.ts +0 -28
- package/dist/transaction/auth/sessionMint.js +0 -85
- package/dist/transaction/coordination/awaitClaimGrant.d.ts +0 -56
- package/dist/transaction/coordination/awaitClaimGrant.js +0 -124
- package/dist/transaction/coordination/claimHeartbeatLoop.d.ts +0 -84
- package/dist/transaction/coordination/claimHeartbeatLoop.js +0 -108
- package/dist/transaction/coordination/claimMeta.d.ts +0 -49
- package/dist/transaction/coordination/claimMeta.js +0 -52
- package/dist/transaction/coordination/createClaimStream.d.ts +0 -64
- package/dist/transaction/coordination/createClaimStream.js +0 -475
- package/dist/transaction/coordination/events.d.ts +0 -74
- package/dist/transaction/coordination/events.js +0 -7
- package/dist/transaction/coordination/index.d.ts +0 -19
- package/dist/transaction/coordination/index.js +0 -45
- package/dist/transaction/coordination/locator.d.ts +0 -104
- package/dist/transaction/coordination/locator.js +0 -102
- package/dist/transaction/coordination/schema.d.ts +0 -1536
- package/dist/transaction/coordination/schema.js +0 -1177
- package/dist/transaction/coordination/targetConflict.d.ts +0 -2
- package/dist/transaction/coordination/targetConflict.js +0 -107
- package/dist/transaction/coordination/trace.d.ts +0 -78
- package/dist/transaction/coordination/trace.js +0 -138
- package/dist/transaction/durableWrites.d.ts +0 -62
- package/dist/transaction/durableWrites.js +0 -71
- package/dist/transaction/environment.d.ts +0 -105
- package/dist/transaction/environment.js +0 -108
- package/dist/transaction/errorCodes.d.ts +0 -403
- package/dist/transaction/errorCodes.js +0 -484
- package/dist/transaction/errors.d.ts +0 -428
- package/dist/transaction/errors.js +0 -686
- package/dist/transaction/footprint.d.ts +0 -111
- package/dist/transaction/footprint.js +0 -0
- package/dist/transaction/index.d.ts +0 -20
- package/dist/transaction/index.js +0 -20
- package/dist/transaction/keys/index.d.ts +0 -87
- package/dist/transaction/keys/index.js +0 -207
- package/dist/transaction/log/syncDeltaRow.d.ts +0 -158
- package/dist/transaction/log/syncDeltaRow.js +0 -95
- package/dist/transaction/logPosition.d.ts +0 -97
- package/dist/transaction/logPosition.js +0 -125
- package/dist/transaction/logger.d.ts +0 -16
- package/dist/transaction/logger.js +0 -7
- package/dist/transaction/observability.d.ts +0 -53
- package/dist/transaction/observability.js +0 -19
- package/dist/transaction/persistence.d.ts +0 -12
- package/dist/transaction/persistence.js +0 -11
- package/dist/transaction/plugin.d.ts +0 -285
- package/dist/transaction/plugin.js +0 -106
- package/dist/transaction/policy/types.d.ts +0 -217
- package/dist/transaction/policy/types.js +0 -126
- package/dist/transaction/resources/functionalUpdate.d.ts +0 -79
- package/dist/transaction/resources/functionalUpdate.js +0 -87
- package/dist/transaction/resources/httpResources.d.ts +0 -321
- package/dist/transaction/resources/httpResources.js +0 -7
- package/dist/transaction/resources/modelOperations.d.ts +0 -427
- package/dist/transaction/resources/modelOperations.js +0 -12
- package/dist/transaction/resources/mutationOptions.d.ts +0 -66
- package/dist/transaction/resources/mutationOptions.js +0 -9
- package/dist/transaction/resources/where.d.ts +0 -101
- package/dist/transaction/resources/where.js +0 -115
- package/dist/transaction/resources/writeOptionsSchema.d.ts +0 -47
- package/dist/transaction/resources/writeOptionsSchema.js +0 -73
- package/dist/transaction/schema/field.d.ts +0 -120
- package/dist/transaction/schema/field.js +0 -265
- package/dist/transaction/schema/fieldRef.d.ts +0 -38
- package/dist/transaction/schema/fieldRef.js +0 -11
- package/dist/transaction/schema/loadStrategy.d.ts +0 -45
- package/dist/transaction/schema/loadStrategy.js +0 -46
- package/dist/transaction/schema/model.d.ts +0 -379
- package/dist/transaction/schema/model.js +0 -123
- package/dist/transaction/schema/openapi.d.ts +0 -58
- package/dist/transaction/schema/openapi.js +0 -501
- package/dist/transaction/schema/relation.d.ts +0 -204
- package/dist/transaction/schema/relation.js +0 -104
- package/dist/transaction/schema/residency.d.ts +0 -29
- package/dist/transaction/schema/residency.js +0 -25
- package/dist/transaction/schema/roles.d.ts +0 -249
- package/dist/transaction/schema/roles.js +0 -230
- package/dist/transaction/schema/schema.d.ts +0 -351
- package/dist/transaction/schema/schema.js +0 -325
- package/dist/transaction/schema/tenancy.d.ts +0 -139
- package/dist/transaction/schema/tenancy.js +0 -190
- package/dist/transaction/transactionLayer.d.ts +0 -82
- package/dist/transaction/transactionLayer.js +0 -24
- package/dist/transaction/transactions/settlement/commitEnvelope.d.ts +0 -143
- package/dist/transaction/transactions/settlement/commitEnvelope.js +0 -161
- package/dist/transaction/transactions/settlement/httpCommitEnvelope.d.ts +0 -53
- package/dist/transaction/transactions/settlement/httpCommitEnvelope.js +0 -207
- package/dist/transaction/transactions/settlement/idempotencyKey.d.ts +0 -10
- package/dist/transaction/transactions/settlement/idempotencyKey.js +0 -9
- package/dist/transaction/transactions/settlement/pendingWrite.d.ts +0 -112
- package/dist/transaction/transactions/settlement/pendingWrite.js +0 -20
- package/dist/transaction/transport/commitFrames.d.ts +0 -90
- package/dist/transaction/transport/commitFrames.js +0 -134
- package/dist/transaction/transport/connectionManager.d.ts +0 -215
- package/dist/transaction/transport/connectionManager.js +0 -673
- package/dist/transaction/transport/credentialLifecycle.d.ts +0 -177
- package/dist/transaction/transport/credentialLifecycle.js +0 -324
- package/dist/transaction/transport/heartbeat.d.ts +0 -65
- package/dist/transaction/transport/heartbeat.js +0 -93
- package/dist/transaction/transport/httpClient.d.ts +0 -131
- package/dist/transaction/transport/httpClient.js +0 -146
- package/dist/transaction/transport/httpOptions.d.ts +0 -33
- package/dist/transaction/transport/httpOptions.js +0 -12
- package/dist/transaction/transport/httpTransport.d.ts +0 -8
- package/dist/transaction/transport/httpTransport.js +0 -1388
- package/dist/transaction/transport/networkProbe.d.ts +0 -84
- package/dist/transaction/transport/networkProbe.js +0 -207
- package/dist/transaction/transport/wsFrameHandlers.d.ts +0 -128
- package/dist/transaction/transport/wsFrameHandlers.js +0 -429
- package/dist/transaction/transport/wsTransport.d.ts +0 -574
- package/dist/transaction/transport/wsTransport.js +0 -1023
- package/dist/transaction/types/assertExact.d.ts +0 -17
- package/dist/transaction/types/assertExact.js +0 -1
- package/dist/transaction/types/global.d.ts +0 -107
- package/dist/transaction/types/global.js +0 -40
- package/dist/transaction/types/index.d.ts +0 -205
- package/dist/transaction/types/index.js +0 -56
- package/dist/transaction/types/modelData.d.ts +0 -10
- package/dist/transaction/types/modelData.js +0 -9
- package/dist/transaction/types/participant.d.ts +0 -20
- package/dist/transaction/types/participant.js +0 -10
- package/dist/transaction/types/streams.d.ts +0 -550
- package/dist/transaction/types/streams.js +0 -11
- package/dist/transaction/utils/asyncIterator.d.ts +0 -34
- package/dist/transaction/utils/asyncIterator.js +0 -135
- package/dist/transaction/utils/duration.d.ts +0 -50
- package/dist/transaction/utils/duration.js +0 -77
- package/dist/transaction/utils/json.d.ts +0 -57
- package/dist/transaction/utils/json.js +0 -276
- package/dist/transaction/wire/accountResponses.d.ts +0 -420
- package/dist/transaction/wire/accountResponses.js +0 -290
- package/dist/transaction/wire/auth.d.ts +0 -56
- package/dist/transaction/wire/auth.js +0 -63
- package/dist/transaction/wire/bootstrapReason.d.ts +0 -9
- package/dist/transaction/wire/bootstrapReason.js +0 -8
- package/dist/transaction/wire/claimEvent.d.ts +0 -76
- package/dist/transaction/wire/claimEvent.js +0 -73
- package/dist/transaction/wire/claims.d.ts +0 -530
- package/dist/transaction/wire/claims.js +0 -327
- package/dist/transaction/wire/commit.d.ts +0 -603
- package/dist/transaction/wire/commit.js +0 -321
- package/dist/transaction/wire/delta.d.ts +0 -250
- package/dist/transaction/wire/delta.js +0 -147
- package/dist/transaction/wire/errorEnvelope.d.ts +0 -72
- package/dist/transaction/wire/errorEnvelope.js +0 -123
- package/dist/transaction/wire/feedCursor.d.ts +0 -60
- package/dist/transaction/wire/feedCursor.js +0 -82
- package/dist/transaction/wire/feedEvent.d.ts +0 -204
- package/dist/transaction/wire/feedEvent.js +0 -65
- package/dist/transaction/wire/frames.d.ts +0 -194
- package/dist/transaction/wire/frames.js +0 -50
- package/dist/transaction/wire/inboundFrames.d.ts +0 -562
- package/dist/transaction/wire/inboundFrames.js +0 -116
- package/dist/transaction/wire/index.d.ts +0 -54
- package/dist/transaction/wire/index.js +0 -83
- package/dist/transaction/wire/listEnvelope.d.ts +0 -37
- package/dist/transaction/wire/listEnvelope.js +0 -42
- package/dist/transaction/wire/modelMutations.d.ts +0 -31
- package/dist/transaction/wire/modelMutations.js +0 -52
- package/dist/transaction/wire/modelResponses.d.ts +0 -85
- package/dist/transaction/wire/modelResponses.js +0 -43
- package/dist/transaction/wire/modelShape.d.ts +0 -78
- package/dist/transaction/wire/modelShape.js +0 -74
- package/dist/transaction/wire/protocol.d.ts +0 -38
- package/dist/transaction/wire/protocol.js +0 -38
- package/dist/transaction/wire/protocolVersion.d.ts +0 -73
- package/dist/transaction/wire/protocolVersion.js +0 -83
- package/dist/transactions/mutations/MutationQueue.d.ts +0 -661
- package/dist/transactions/mutations/MutationQueue.js +0 -2807
- package/dist/transactions/mutations/MutationStore.d.ts +0 -20
- package/dist/transactions/mutations/MutationStore.js +0 -53
- package/dist/transactions/mutations/UnconfirmedWrites.d.ts +0 -82
- package/dist/transactions/mutations/UnconfirmedWrites.js +0 -104
- package/dist/transactions/mutations/coalesceRules.d.ts +0 -58
- package/dist/transactions/mutations/coalesceRules.js +0 -140
- package/dist/transactions/mutations/commitLatency.d.ts +0 -52
- package/dist/transactions/mutations/commitLatency.js +0 -130
- package/dist/transactions/mutations/commitOutboxStore.d.ts +0 -28
- package/dist/transactions/mutations/commitOutboxStore.js +0 -26
- package/dist/transactions/mutations/commitPayload.d.ts +0 -165
- package/dist/transactions/mutations/commitPayload.js +0 -152
- package/dist/transactions/mutations/deltaConfirmation.d.ts +0 -63
- package/dist/transactions/mutations/deltaConfirmation.js +0 -235
- package/dist/transactions/mutations/durableWriteStore.d.ts +0 -14
- package/dist/transactions/mutations/durableWriteStore.js +0 -12
- package/dist/transactions/mutations/optimisticApply.d.ts +0 -49
- package/dist/transactions/mutations/optimisticApply.js +0 -65
- package/dist/transactions/mutations/replayValidation.d.ts +0 -187
- package/dist/transactions/mutations/replayValidation.js +0 -164
- package/dist/utils/mobxSetup.d.ts +0 -53
- package/dist/utils/mobxSetup.js +0 -330
- package/dist/views/QueryView.d.ts +0 -79
- package/dist/views/QueryView.js +0 -218
- package/dist/views/ViewRegistry.d.ts +0 -20
- package/dist/views/ViewRegistry.js +0 -55
- package/dist/views/incrementalView.d.ts +0 -45
- package/dist/views/incrementalView.js +0 -69
- package/dist/webhooks/events.d.ts +0 -43
- package/dist/webhooks/events.js +0 -42
- package/dist/webhooks/index.d.ts +0 -8
- package/dist/webhooks/index.js +0 -8
- package/dist/wire/index.d.ts +0 -1
- package/dist/wire/index.js +0 -8
|
@@ -1,177 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Keeps the short-lived access credential fresh. It owns the re-mint hook, a
|
|
3
|
-
* single-flight guard that stops concurrent triggers from minting more than
|
|
4
|
-
* once, and a browser-only proactive refresh — a timer plus an OS-wake listener
|
|
5
|
-
* — that renews the credential ahead of expiry. It reaches the rest of the
|
|
6
|
-
* client only through the small {@link CredentialLifecycleContext} interface,
|
|
7
|
-
* so the two can reference each other without an import cycle.
|
|
8
|
-
*/
|
|
9
|
-
import type { RecoveryClass } from '../errorCodes.js';
|
|
10
|
-
import { type Logger } from '../logger.js';
|
|
11
|
-
/**
|
|
12
|
-
* Tri-state outcome of a credential re-mint, mirroring the `getToken`
|
|
13
|
-
* contract (see {@link CredentialLifecycle.refresh}).
|
|
14
|
-
*/
|
|
15
|
-
export type CredentialRefreshOutcome = 'refreshed' | 'session_error' | 'network_error';
|
|
16
|
-
/**
|
|
17
|
-
* What an auth-rejected transport should do after recovery has run. `'retry'`
|
|
18
|
-
* means a fresh credential is now in place — replay the request once. `'stop'`
|
|
19
|
-
* means don't replay: either the session is gone for good, the rejection is one
|
|
20
|
-
* a re-mint can't cure, or the mint failed transiently and the caller's own
|
|
21
|
-
* retry path will recover later.
|
|
22
|
-
*/
|
|
23
|
-
export type CredentialRecoveryOutcome = 'retry' | 'stop';
|
|
24
|
-
/**
|
|
25
|
-
* What a credential refresher may resolve with. The plain-string form returns
|
|
26
|
-
* just the token. The object form also carries the mint response's `expiresAt`
|
|
27
|
-
* (an ISO string, epoch milliseconds, or a `Date`), which lets the proactive
|
|
28
|
-
* pre-roll schedule against the credential's real lifetime rather than assume
|
|
29
|
-
* the server's default expiry.
|
|
30
|
-
*/
|
|
31
|
-
export type CredentialRefreshResult = string | {
|
|
32
|
-
readonly token: string;
|
|
33
|
-
readonly expiresAt?: string | number | Date;
|
|
34
|
-
} | null;
|
|
35
|
-
/** A credential re-mint hook. `Promise<string | null>` resolvers remain
|
|
36
|
-
* assignable — the widened result type is a superset. */
|
|
37
|
-
export type CredentialRefresher = () => Promise<CredentialRefreshResult>;
|
|
38
|
-
/** The fallback pre-roll interval, and also its ceiling: 10 minutes, which sits
|
|
39
|
-
* comfortably inside the server's 15-minute default credential lifetime. Used
|
|
40
|
-
* as-is when the refresher reports no expiry. */
|
|
41
|
-
export declare const DEFAULT_PREROLL_INTERVAL_MS: number;
|
|
42
|
-
/** Floor so a very short (or already-elapsed) TTL can't hot-loop the mint. */
|
|
43
|
-
export declare const MIN_PREROLL_DELAY_MS: number;
|
|
44
|
-
/**
|
|
45
|
-
* Computes how long to wait before pre-rolling a credential that expires at
|
|
46
|
-
* `expiresAtMs`: about two-thirds of the remaining lifetime (a 15-minute
|
|
47
|
-
* credential yields 10 minutes), clamped to
|
|
48
|
-
* [{@link MIN_PREROLL_DELAY_MS}, {@link DEFAULT_PREROLL_INTERVAL_MS}]. An
|
|
49
|
-
* unknown expiry (`null`) falls back to the 10-minute interval. Exported for
|
|
50
|
-
* unit tests.
|
|
51
|
-
*/
|
|
52
|
-
export declare function computePrerollDelayMs(expiresAtMs: number | null, nowMs: number): number;
|
|
53
|
-
/**
|
|
54
|
-
* The callbacks this lifecycle needs back from the surrounding client. It is
|
|
55
|
-
* deliberately minimal — three callbacks, each resolved lazily at call time,
|
|
56
|
-
* because the connection machinery behind two of them isn't constructed until
|
|
57
|
-
* the sync connection is set up.
|
|
58
|
-
*/
|
|
59
|
-
export interface CredentialLifecycleContext {
|
|
60
|
-
/** Push a freshly-minted access token into the shared credential source
|
|
61
|
-
* (no-op when the deployment wired no credential source). */
|
|
62
|
-
setAuthToken(token: string): void;
|
|
63
|
-
/** Nudge the connection to re-probe using the credential now in place. */
|
|
64
|
-
nudgeReconnect(): void;
|
|
65
|
-
/** Report that the long-lived login is gone, so the connection can move to
|
|
66
|
-
* its signed-out state. */
|
|
67
|
-
reportSessionExpired(): void;
|
|
68
|
-
}
|
|
69
|
-
export declare class CredentialLifecycle {
|
|
70
|
-
private readonly ctx;
|
|
71
|
-
private readonly logger;
|
|
72
|
-
/**
|
|
73
|
-
* The hook that mints a fresh short-lived access credential (the `ek_`/`rk_`
|
|
74
|
-
* key). An integrator wires it from their own token endpoint: this lifecycle
|
|
75
|
-
* decides when to refresh (a stale-credential probe or an external nudge),
|
|
76
|
-
* and the hook decides how to mint. It follows the same contract as a
|
|
77
|
-
* `getToken` function — it resolves a token string on success, `null` when
|
|
78
|
-
* the long-lived login is gone (a terminal state), and throws on a transient
|
|
79
|
-
* or offline failure. Used by {@link refresh}. When it is absent there is no
|
|
80
|
-
* silent re-mint, as with a static `apiKey` whose credential source is
|
|
81
|
-
* refreshed elsewhere.
|
|
82
|
-
*/
|
|
83
|
-
private credentialRefresher;
|
|
84
|
-
/** Single-flight guard so a wake nudge + an in-flight request + a probe don't
|
|
85
|
-
* all mint at once (the classic "token thrash → random logout" bug). */
|
|
86
|
-
private inFlightCredentialRefresh;
|
|
87
|
-
/** Tears down the proactive credential lifecycle (the refresh timer and the
|
|
88
|
-
* OS-wake listener) installed by {@link start}; cleared when the client
|
|
89
|
-
* disconnects. Null when no refresher is wired. */
|
|
90
|
-
private credentialLifecycleTeardown;
|
|
91
|
-
/** Epoch milliseconds at which the current credential expires, when the
|
|
92
|
-
* refresher reports it (the object form of {@link CredentialRefreshResult}).
|
|
93
|
-
* `null` for the string-form resolver, in which case the pre-roll uses its
|
|
94
|
-
* fixed interval. */
|
|
95
|
-
private credentialExpiresAtMs;
|
|
96
|
-
/** Re-arms the proactive pre-roll timer (set by {@link start}). Called after
|
|
97
|
-
* every successful mint, so a refresh triggered reactively (by a probe, an
|
|
98
|
-
* OS wake, or the first mint) re-anchors the schedule to the fresh
|
|
99
|
-
* credential's real expiry instead of a stale fixed delay. */
|
|
100
|
-
private prerollReschedule;
|
|
101
|
-
constructor(ctx: CredentialLifecycleContext, logger?: Logger);
|
|
102
|
-
/**
|
|
103
|
-
* Registers the re-mint hook for the access credential — a function that
|
|
104
|
-
* mints a fresh `ek_`/`rk_` key, typically the integrator's `getToken`. See
|
|
105
|
-
* {@link credentialRefresher}.
|
|
106
|
-
*/
|
|
107
|
-
setRefresher(refresher: CredentialRefresher | null): void;
|
|
108
|
-
/**
|
|
109
|
-
* Re-mints the short-lived access credential, pushes it into the credential
|
|
110
|
-
* source, and reports a three-way outcome the connection layer acts on:
|
|
111
|
-
* - a token string → `'refreshed'` (the fresh key is in place; re-probe and reconnect)
|
|
112
|
-
* - `null` → `'session_error'` (the login itself is gone — terminal, sign out)
|
|
113
|
-
* - a thrown error → `'network_error'` (the mint endpoint was unreachable — transient)
|
|
114
|
-
*
|
|
115
|
-
* The call is single-flight: concurrent triggers (an OS wake, an in-flight
|
|
116
|
-
* request, a probe) share one in-flight promise, so the credential is never
|
|
117
|
-
* minted twice at once. This avoids the failure where every rejected request
|
|
118
|
-
* mints a new token and the resulting thrash logs the user out.
|
|
119
|
-
*
|
|
120
|
-
* With no refresher wired, it resolves `'refreshed'` as a no-op re-probe: a
|
|
121
|
-
* static-`apiKey` client has no session to mint from and its credential
|
|
122
|
-
* source is refreshed elsewhere, so it simply re-probes with what it holds.
|
|
123
|
-
*/
|
|
124
|
-
refresh(): Promise<CredentialRefreshOutcome>;
|
|
125
|
-
/**
|
|
126
|
-
* Interprets a refresh outcome and drives the connection accordingly. This is
|
|
127
|
-
* the single place the three-way outcome is acted on, shared by the proactive
|
|
128
|
-
* pre-roll, the OS-wake nudge, and the HTTP auth-recovery path, so every
|
|
129
|
-
* trigger converges on the same behavior.
|
|
130
|
-
*/
|
|
131
|
-
private routeRefreshOutcome;
|
|
132
|
-
/**
|
|
133
|
-
* The shared recovery path for a request rejected on authentication, over any
|
|
134
|
-
* transport. The WebSocket probe already routes its own 401s; HTTP callers
|
|
135
|
-
* call this instead of inventing their own handling, so every path shares one
|
|
136
|
-
* single-flight mint, one outcome routing, and one taxonomy. It classifies
|
|
137
|
-
* the same recovery codes the connection probe does:
|
|
138
|
-
* - `access_credential_expiry` — the routine case, an expired `ek_`/`rk_`:
|
|
139
|
-
* silently re-mint through the single-flight {@link refresh} and tell the
|
|
140
|
-
* caller to replay once on success. This never signs out on its own; the
|
|
141
|
-
* only terminal path is the mint resolving `null`.
|
|
142
|
-
* - `session_expiry` — the login is gone: report it (which drives sign-out)
|
|
143
|
-
* and stop, since replaying is pointless.
|
|
144
|
-
* - `auth_blocked`, `permission`, and everything else — re-minting would
|
|
145
|
-
* produce the same rejected credential, so stop and leave the connection
|
|
146
|
-
* alone.
|
|
147
|
-
*/
|
|
148
|
-
recoverFromAuthRejection(recovery: RecoveryClass): Promise<CredentialRecoveryOutcome>;
|
|
149
|
-
/**
|
|
150
|
-
* Installs the credential lifecycle. It has two parts:
|
|
151
|
-
* 1. Reactive — registers `getToken` as the re-mint hook the connection
|
|
152
|
-
* calls when a probe finds the key stale, or on a nudge.
|
|
153
|
-
* 2. Proactive — keeps the short-lived key fresh ahead of expiry with a
|
|
154
|
-
* refresh timer inside the credential's lifetime, plus a re-mint on OS
|
|
155
|
-
* wake. The whole proactive block is browser-gated on `typeof window`,
|
|
156
|
-
* because a server render has no socket to keep warm and the resolver is
|
|
157
|
-
* browser-oriented; arming it under Node would fire a relative-URL fetch
|
|
158
|
-
* and throw. (Agents pass a static `apiKey` with no resolver, so this
|
|
159
|
-
* method is never called for them.)
|
|
160
|
-
*
|
|
161
|
-
* Refreshing is automatic — a consumer never calls a refresh method. The call
|
|
162
|
-
* is idempotent: a second call replaces the first, and it is torn down when
|
|
163
|
-
* the client disconnects.
|
|
164
|
-
*
|
|
165
|
-
* `opts.proactiveInNode` arms the refresh timer on a windowless host as well.
|
|
166
|
-
* Set it for agent or system participants — long-lived server sockets whose
|
|
167
|
-
* `rk_`/`ek_` must renew before the server's keepalive check closes them.
|
|
168
|
-
* Node timers are `unref`ed, so a finishing script is never held alive by the
|
|
169
|
-
* pre-roll. The OS-wake listener stays browser-only regardless, since there
|
|
170
|
-
* is no `window` to listen on.
|
|
171
|
-
*/
|
|
172
|
-
start(getToken: CredentialRefresher, opts?: {
|
|
173
|
-
proactiveInNode?: boolean;
|
|
174
|
-
}): void;
|
|
175
|
-
/** Tear down the proactive credential lifecycle (idempotent). */
|
|
176
|
-
stop(): void;
|
|
177
|
-
}
|
|
@@ -1,324 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Keeps the short-lived access credential fresh. It owns the re-mint hook, a
|
|
3
|
-
* single-flight guard that stops concurrent triggers from minting more than
|
|
4
|
-
* once, and a browser-only proactive refresh — a timer plus an OS-wake listener
|
|
5
|
-
* — that renews the credential ahead of expiry. It reaches the rest of the
|
|
6
|
-
* client only through the small {@link CredentialLifecycleContext} interface,
|
|
7
|
-
* so the two can reference each other without an import cycle.
|
|
8
|
-
*/
|
|
9
|
-
import { noopLogger } from '../logger.js';
|
|
10
|
-
/** The fallback pre-roll interval, and also its ceiling: 10 minutes, which sits
|
|
11
|
-
* comfortably inside the server's 15-minute default credential lifetime. Used
|
|
12
|
-
* as-is when the refresher reports no expiry. */
|
|
13
|
-
export const DEFAULT_PREROLL_INTERVAL_MS = 10 * 60 * 1000;
|
|
14
|
-
/** Floor so a very short (or already-elapsed) TTL can't hot-loop the mint. */
|
|
15
|
-
export const MIN_PREROLL_DELAY_MS = 30 * 1000;
|
|
16
|
-
/**
|
|
17
|
-
* Computes how long to wait before pre-rolling a credential that expires at
|
|
18
|
-
* `expiresAtMs`: about two-thirds of the remaining lifetime (a 15-minute
|
|
19
|
-
* credential yields 10 minutes), clamped to
|
|
20
|
-
* [{@link MIN_PREROLL_DELAY_MS}, {@link DEFAULT_PREROLL_INTERVAL_MS}]. An
|
|
21
|
-
* unknown expiry (`null`) falls back to the 10-minute interval. Exported for
|
|
22
|
-
* unit tests.
|
|
23
|
-
*/
|
|
24
|
-
export function computePrerollDelayMs(expiresAtMs, nowMs) {
|
|
25
|
-
if (expiresAtMs === null || !Number.isFinite(expiresAtMs)) {
|
|
26
|
-
return DEFAULT_PREROLL_INTERVAL_MS;
|
|
27
|
-
}
|
|
28
|
-
const remaining = expiresAtMs - nowMs;
|
|
29
|
-
if (remaining <= 0)
|
|
30
|
-
return MIN_PREROLL_DELAY_MS;
|
|
31
|
-
const twoThirds = Math.floor((remaining * 2) / 3);
|
|
32
|
-
return Math.min(Math.max(twoThirds, MIN_PREROLL_DELAY_MS), DEFAULT_PREROLL_INTERVAL_MS);
|
|
33
|
-
}
|
|
34
|
-
/** Narrow a refresher-supplied `expiresAt` to epoch ms, or `null` when
|
|
35
|
-
* absent/unparseable (→ fallback cadence, never a crash). */
|
|
36
|
-
function normalizeExpiresAtMs(expiresAt) {
|
|
37
|
-
if (expiresAt === undefined)
|
|
38
|
-
return null;
|
|
39
|
-
const ms = expiresAt instanceof Date
|
|
40
|
-
? expiresAt.getTime()
|
|
41
|
-
: typeof expiresAt === 'number'
|
|
42
|
-
? expiresAt
|
|
43
|
-
: Date.parse(expiresAt);
|
|
44
|
-
return Number.isFinite(ms) ? ms : null;
|
|
45
|
-
}
|
|
46
|
-
export class CredentialLifecycle {
|
|
47
|
-
ctx;
|
|
48
|
-
logger;
|
|
49
|
-
/**
|
|
50
|
-
* The hook that mints a fresh short-lived access credential (the `ek_`/`rk_`
|
|
51
|
-
* key). An integrator wires it from their own token endpoint: this lifecycle
|
|
52
|
-
* decides when to refresh (a stale-credential probe or an external nudge),
|
|
53
|
-
* and the hook decides how to mint. It follows the same contract as a
|
|
54
|
-
* `getToken` function — it resolves a token string on success, `null` when
|
|
55
|
-
* the long-lived login is gone (a terminal state), and throws on a transient
|
|
56
|
-
* or offline failure. Used by {@link refresh}. When it is absent there is no
|
|
57
|
-
* silent re-mint, as with a static `apiKey` whose credential source is
|
|
58
|
-
* refreshed elsewhere.
|
|
59
|
-
*/
|
|
60
|
-
credentialRefresher = null;
|
|
61
|
-
/** Single-flight guard so a wake nudge + an in-flight request + a probe don't
|
|
62
|
-
* all mint at once (the classic "token thrash → random logout" bug). */
|
|
63
|
-
inFlightCredentialRefresh = null;
|
|
64
|
-
/** Tears down the proactive credential lifecycle (the refresh timer and the
|
|
65
|
-
* OS-wake listener) installed by {@link start}; cleared when the client
|
|
66
|
-
* disconnects. Null when no refresher is wired. */
|
|
67
|
-
credentialLifecycleTeardown = null;
|
|
68
|
-
/** Epoch milliseconds at which the current credential expires, when the
|
|
69
|
-
* refresher reports it (the object form of {@link CredentialRefreshResult}).
|
|
70
|
-
* `null` for the string-form resolver, in which case the pre-roll uses its
|
|
71
|
-
* fixed interval. */
|
|
72
|
-
credentialExpiresAtMs = null;
|
|
73
|
-
/** Re-arms the proactive pre-roll timer (set by {@link start}). Called after
|
|
74
|
-
* every successful mint, so a refresh triggered reactively (by a probe, an
|
|
75
|
-
* OS wake, or the first mint) re-anchors the schedule to the fresh
|
|
76
|
-
* credential's real expiry instead of a stale fixed delay. */
|
|
77
|
-
prerollReschedule = null;
|
|
78
|
-
constructor(ctx, logger = noopLogger) {
|
|
79
|
-
this.ctx = ctx;
|
|
80
|
-
this.logger = logger;
|
|
81
|
-
}
|
|
82
|
-
/**
|
|
83
|
-
* Registers the re-mint hook for the access credential — a function that
|
|
84
|
-
* mints a fresh `ek_`/`rk_` key, typically the integrator's `getToken`. See
|
|
85
|
-
* {@link credentialRefresher}.
|
|
86
|
-
*/
|
|
87
|
-
setRefresher(refresher) {
|
|
88
|
-
this.credentialRefresher = refresher;
|
|
89
|
-
}
|
|
90
|
-
/**
|
|
91
|
-
* Re-mints the short-lived access credential, pushes it into the credential
|
|
92
|
-
* source, and reports a three-way outcome the connection layer acts on:
|
|
93
|
-
* - a token string → `'refreshed'` (the fresh key is in place; re-probe and reconnect)
|
|
94
|
-
* - `null` → `'session_error'` (the login itself is gone — terminal, sign out)
|
|
95
|
-
* - a thrown error → `'network_error'` (the mint endpoint was unreachable — transient)
|
|
96
|
-
*
|
|
97
|
-
* The call is single-flight: concurrent triggers (an OS wake, an in-flight
|
|
98
|
-
* request, a probe) share one in-flight promise, so the credential is never
|
|
99
|
-
* minted twice at once. This avoids the failure where every rejected request
|
|
100
|
-
* mints a new token and the resulting thrash logs the user out.
|
|
101
|
-
*
|
|
102
|
-
* With no refresher wired, it resolves `'refreshed'` as a no-op re-probe: a
|
|
103
|
-
* static-`apiKey` client has no session to mint from and its credential
|
|
104
|
-
* source is refreshed elsewhere, so it simply re-probes with what it holds.
|
|
105
|
-
*/
|
|
106
|
-
async refresh() {
|
|
107
|
-
const refresher = this.credentialRefresher;
|
|
108
|
-
if (!refresher)
|
|
109
|
-
return 'refreshed';
|
|
110
|
-
if (this.inFlightCredentialRefresh)
|
|
111
|
-
return this.inFlightCredentialRefresh;
|
|
112
|
-
const run = (async () => {
|
|
113
|
-
try {
|
|
114
|
-
const result = await refresher();
|
|
115
|
-
const token = typeof result === 'string' ? result : result?.token;
|
|
116
|
-
if (!token) {
|
|
117
|
-
// null = the long-lived login is gone (the mint endpoint answered
|
|
118
|
-
// 401/403). Terminal — this routes to sign-out.
|
|
119
|
-
return 'session_error';
|
|
120
|
-
}
|
|
121
|
-
// Object-form resolvers carry the mint's actual expiry; remember it so
|
|
122
|
-
// the proactive pre-roll schedules off the real TTL (string-form
|
|
123
|
-
// resolvers leave it null → fixed fallback cadence).
|
|
124
|
-
this.credentialExpiresAtMs =
|
|
125
|
-
typeof result === 'object' && result !== null
|
|
126
|
-
? normalizeExpiresAtMs(result.expiresAt)
|
|
127
|
-
: null;
|
|
128
|
-
this.ctx.setAuthToken(token);
|
|
129
|
-
// Re-anchor the proactive pre-roll to the fresh credential's expiry.
|
|
130
|
-
this.prerollReschedule?.();
|
|
131
|
-
return 'refreshed';
|
|
132
|
-
}
|
|
133
|
-
catch (error) {
|
|
134
|
-
// A throw = transient (offline / mint endpoint unreachable / 5xx). The
|
|
135
|
-
// login may be perfectly valid; never sign out for this — back off and
|
|
136
|
-
// retry. Mirrors the `getToken` throw-vs-null contract end-to-end.
|
|
137
|
-
const message = error?.message ?? String(error);
|
|
138
|
-
// A relative-URL resolver invoked on the server (Node's fetch has no
|
|
139
|
-
// origin to resolve against) throws the opaque "Failed to parse URL" or
|
|
140
|
-
// "Only absolute URLs are supported". Translate it into something
|
|
141
|
-
// actionable rather than a mystery transient blip: the proactive
|
|
142
|
-
// refresh is browser-only, so reaching here means the resolver fired
|
|
143
|
-
// from a server render or a server route.
|
|
144
|
-
if (typeof window === 'undefined' && /parse URL|absolute URLs?/i.test(message)) {
|
|
145
|
-
this.logger.warn('credential resolver ran on the server with a relative URL — Node fetch needs an absolute URL. ' +
|
|
146
|
-
'Refresh the Ablo client in the browser, or build an absolute URL server-side ' +
|
|
147
|
-
"(e.g. new URL('/api/ablo-session', process.env.NEXT_PUBLIC_APP_URL)).", { error: message });
|
|
148
|
-
}
|
|
149
|
-
else {
|
|
150
|
-
this.logger.debug('access-credential re-mint failed (transient)', { error: message });
|
|
151
|
-
}
|
|
152
|
-
return 'network_error';
|
|
153
|
-
}
|
|
154
|
-
})();
|
|
155
|
-
this.inFlightCredentialRefresh = run;
|
|
156
|
-
try {
|
|
157
|
-
return await run;
|
|
158
|
-
}
|
|
159
|
-
finally {
|
|
160
|
-
this.inFlightCredentialRefresh = null;
|
|
161
|
-
}
|
|
162
|
-
}
|
|
163
|
-
/**
|
|
164
|
-
* Interprets a refresh outcome and drives the connection accordingly. This is
|
|
165
|
-
* the single place the three-way outcome is acted on, shared by the proactive
|
|
166
|
-
* pre-roll, the OS-wake nudge, and the HTTP auth-recovery path, so every
|
|
167
|
-
* trigger converges on the same behavior.
|
|
168
|
-
*/
|
|
169
|
-
routeRefreshOutcome(outcome) {
|
|
170
|
-
if (outcome === 'refreshed') {
|
|
171
|
-
// Fresh key already pushed into the credential source by `refresh`;
|
|
172
|
-
// nudge a parked connection to re-probe with it.
|
|
173
|
-
this.ctx.nudgeReconnect();
|
|
174
|
-
return 'retry';
|
|
175
|
-
}
|
|
176
|
-
if (outcome === 'session_error') {
|
|
177
|
-
// The long-lived login is gone (the mint answered 401/403). Report it;
|
|
178
|
-
// this is harmless in connection states that don't accept the event,
|
|
179
|
-
// which converge on sign-out anyway.
|
|
180
|
-
this.ctx.reportSessionExpired();
|
|
181
|
-
return 'stop';
|
|
182
|
-
}
|
|
183
|
-
// 'network_error' → transient (offline or a mint hiccup); the next proactive
|
|
184
|
-
// tick or the connection's own probe retries. Never sign out, never replay now.
|
|
185
|
-
return 'stop';
|
|
186
|
-
}
|
|
187
|
-
/**
|
|
188
|
-
* The shared recovery path for a request rejected on authentication, over any
|
|
189
|
-
* transport. The WebSocket probe already routes its own 401s; HTTP callers
|
|
190
|
-
* call this instead of inventing their own handling, so every path shares one
|
|
191
|
-
* single-flight mint, one outcome routing, and one taxonomy. It classifies
|
|
192
|
-
* the same recovery codes the connection probe does:
|
|
193
|
-
* - `access_credential_expiry` — the routine case, an expired `ek_`/`rk_`:
|
|
194
|
-
* silently re-mint through the single-flight {@link refresh} and tell the
|
|
195
|
-
* caller to replay once on success. This never signs out on its own; the
|
|
196
|
-
* only terminal path is the mint resolving `null`.
|
|
197
|
-
* - `session_expiry` — the login is gone: report it (which drives sign-out)
|
|
198
|
-
* and stop, since replaying is pointless.
|
|
199
|
-
* - `auth_blocked`, `permission`, and everything else — re-minting would
|
|
200
|
-
* produce the same rejected credential, so stop and leave the connection
|
|
201
|
-
* alone.
|
|
202
|
-
*/
|
|
203
|
-
async recoverFromAuthRejection(recovery) {
|
|
204
|
-
switch (recovery) {
|
|
205
|
-
case 'access_credential_expiry':
|
|
206
|
-
return this.routeRefreshOutcome(await this.refresh());
|
|
207
|
-
case 'session_expiry':
|
|
208
|
-
this.ctx.reportSessionExpired();
|
|
209
|
-
return 'stop';
|
|
210
|
-
default:
|
|
211
|
-
return 'stop';
|
|
212
|
-
}
|
|
213
|
-
}
|
|
214
|
-
/**
|
|
215
|
-
* Installs the credential lifecycle. It has two parts:
|
|
216
|
-
* 1. Reactive — registers `getToken` as the re-mint hook the connection
|
|
217
|
-
* calls when a probe finds the key stale, or on a nudge.
|
|
218
|
-
* 2. Proactive — keeps the short-lived key fresh ahead of expiry with a
|
|
219
|
-
* refresh timer inside the credential's lifetime, plus a re-mint on OS
|
|
220
|
-
* wake. The whole proactive block is browser-gated on `typeof window`,
|
|
221
|
-
* because a server render has no socket to keep warm and the resolver is
|
|
222
|
-
* browser-oriented; arming it under Node would fire a relative-URL fetch
|
|
223
|
-
* and throw. (Agents pass a static `apiKey` with no resolver, so this
|
|
224
|
-
* method is never called for them.)
|
|
225
|
-
*
|
|
226
|
-
* Refreshing is automatic — a consumer never calls a refresh method. The call
|
|
227
|
-
* is idempotent: a second call replaces the first, and it is torn down when
|
|
228
|
-
* the client disconnects.
|
|
229
|
-
*
|
|
230
|
-
* `opts.proactiveInNode` arms the refresh timer on a windowless host as well.
|
|
231
|
-
* Set it for agent or system participants — long-lived server sockets whose
|
|
232
|
-
* `rk_`/`ek_` must renew before the server's keepalive check closes them.
|
|
233
|
-
* Node timers are `unref`ed, so a finishing script is never held alive by the
|
|
234
|
-
* pre-roll. The OS-wake listener stays browser-only regardless, since there
|
|
235
|
-
* is no `window` to listen on.
|
|
236
|
-
*/
|
|
237
|
-
start(getToken, opts) {
|
|
238
|
-
this.stop();
|
|
239
|
-
this.setRefresher(getToken);
|
|
240
|
-
// Re-mint through the same single-flight path the reactive probe uses
|
|
241
|
-
// (`refresh`) rather than calling `getToken()` directly. This gives two
|
|
242
|
-
// things: the mint stays single-flight, so an OS wake, an in-flight probe,
|
|
243
|
-
// and this proactive roll share one in-flight promise instead of thrashing;
|
|
244
|
-
// and the three-way outcome is honored, so a `null` result (the login is
|
|
245
|
-
// gone) actually drives expiry instead of being dropped, which would leave a
|
|
246
|
-
// zombie session that re-mints on every tab focus.
|
|
247
|
-
const refresh = async () => {
|
|
248
|
-
// Same outcome routing as every other trigger (see routeRefreshOutcome):
|
|
249
|
-
// refreshed → nudge, session_error → report, network_error → wait for
|
|
250
|
-
// the next tick / the FSM's own probe. Never sign out for a transient.
|
|
251
|
-
this.routeRefreshOutcome(await this.refresh());
|
|
252
|
-
};
|
|
253
|
-
const teardowns = [];
|
|
254
|
-
// The proactive pre-roll arms in the browser, or under Node when the host
|
|
255
|
-
// opts in (`proactiveInNode`, for agent or system participants). The
|
|
256
|
-
// default Node posture stays reactive-only, because a server render can
|
|
257
|
-
// construct user-kind clients whose resolver is browser-oriented (a
|
|
258
|
-
// relative-URL `fetch('/api/ablo-session')`); arming a timer there fires
|
|
259
|
-
// that resolver under Node, where fetch has no origin for a relative URL and
|
|
260
|
-
// throws "Failed to parse URL" on every tick. Long-lived server
|
|
261
|
-
// participants are the opposite case: their socket must outlive the
|
|
262
|
-
// credential's lifetime, so they get the timer. The reactive re-mint hook
|
|
263
|
-
// (`setRefresher` above) stays unconditional: it only fires on a real
|
|
264
|
-
// connection probe, which can't happen during a bare server-side module
|
|
265
|
-
// evaluation.
|
|
266
|
-
if (typeof window !== 'undefined' || opts?.proactiveInNode === true) {
|
|
267
|
-
// A missed tick (throttled in the background) is recovered by the next
|
|
268
|
-
// one, or by the reactive probe. This timer is the only proactive
|
|
269
|
-
// pre-roll — it keeps the key warm ahead of expiry even while the socket
|
|
270
|
-
// sits healthy and connected, a state the connection never probes. The
|
|
271
|
-
// delay comes from the minted credential's real `expiresAt` when the
|
|
272
|
-
// refresher reports one (about two-thirds of the remaining lifetime), with
|
|
273
|
-
// the 10-minute value as both ceiling and fallback, so a deployment that
|
|
274
|
-
// mints shorter-lived keys still pre-rolls in time rather than dropping to
|
|
275
|
-
// reactive-only recovery.
|
|
276
|
-
let timer = null;
|
|
277
|
-
const scheduleNext = () => {
|
|
278
|
-
if (timer !== null)
|
|
279
|
-
clearTimeout(timer); // idempotent re-arm
|
|
280
|
-
const delay = computePrerollDelayMs(this.credentialExpiresAtMs, Date.now());
|
|
281
|
-
timer = setTimeout(() => {
|
|
282
|
-
// `.finally` keeps the chain alive after a transient failure; a
|
|
283
|
-
// successful mint has already re-armed via `prerollReschedule` (the
|
|
284
|
-
// clearTimeout above makes the double-arm a no-op).
|
|
285
|
-
void refresh().finally(scheduleNext);
|
|
286
|
-
}, delay);
|
|
287
|
-
// Node: never keep a finishing process alive just for the pre-roll
|
|
288
|
-
// (browser timers have no unref — optional call is a no-op there).
|
|
289
|
-
timer.unref?.();
|
|
290
|
-
};
|
|
291
|
-
scheduleNext();
|
|
292
|
-
this.prerollReschedule = scheduleNext;
|
|
293
|
-
teardowns.push(() => {
|
|
294
|
-
if (timer !== null)
|
|
295
|
-
clearTimeout(timer);
|
|
296
|
-
timer = null;
|
|
297
|
-
this.prerollReschedule = null;
|
|
298
|
-
});
|
|
299
|
-
// OS-wake, on desktop only: the Electron shell bridges `powerMonitor`
|
|
300
|
-
// 'resume' to this DOM event. It is the one event trigger this lifecycle
|
|
301
|
-
// still owns, because `visibilitychange` does not fire on wake-from-sleep
|
|
302
|
-
// and the connection's own browser listeners don't cover wake. It is
|
|
303
|
-
// browser-gated separately from the timer, since a `proactiveInNode` host
|
|
304
|
-
// has no `window` to listen on and no OS sleep to wake from. Coming back
|
|
305
|
-
// online and regaining tab visibility are handled elsewhere — the
|
|
306
|
-
// connection already re-probes through this same credential path — so
|
|
307
|
-
// listening for them here too would only fire a second, redundant mint.
|
|
308
|
-
if (typeof window !== 'undefined') {
|
|
309
|
-
const onWake = () => void refresh();
|
|
310
|
-
window.addEventListener('ablo:wake', onWake);
|
|
311
|
-
teardowns.push(() => { window.removeEventListener('ablo:wake', onWake); });
|
|
312
|
-
}
|
|
313
|
-
}
|
|
314
|
-
this.credentialLifecycleTeardown = () => {
|
|
315
|
-
for (const t of teardowns)
|
|
316
|
-
t();
|
|
317
|
-
};
|
|
318
|
-
}
|
|
319
|
-
/** Tear down the proactive credential lifecycle (idempotent). */
|
|
320
|
-
stop() {
|
|
321
|
-
this.credentialLifecycleTeardown?.();
|
|
322
|
-
this.credentialLifecycleTeardown = null;
|
|
323
|
-
}
|
|
324
|
-
}
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Application-level heartbeat for the sync WebSocket.
|
|
3
|
-
*
|
|
4
|
-
* The browser WebSocket API hides RFC 6455 protocol-level ping and pong frames
|
|
5
|
-
* from JavaScript, so the server's keepalive cannot be observed by client
|
|
6
|
-
* code. That leaves the client unable to tell a healthy idle connection apart
|
|
7
|
-
* from a "zombie" socket whose underlying TCP connection has silently broken
|
|
8
|
-
* (laptop sleep, NAT timeout, mobile handoff). To close the gap, the client
|
|
9
|
-
* sends an application-level `{ type: 'ping' }` every 30 seconds and
|
|
10
|
-
* force-closes the socket if no inbound traffic arrives within 10 seconds. Any
|
|
11
|
-
* inbound message counts as proof the connection is alive; the explicit `pong`
|
|
12
|
-
* merely guarantees that something arrives even on an otherwise idle stream.
|
|
13
|
-
*/
|
|
14
|
-
import { type TransportObservability } from '../observability.js';
|
|
15
|
-
/**
|
|
16
|
-
* The interval between application-level pings, shared with both sides of the
|
|
17
|
-
* connection: the client pings at the same {@link PING_INTERVAL_MS} the server
|
|
18
|
-
* uses for its own keepalive, and the claim lease window is derived from the
|
|
19
|
-
* same constant.
|
|
20
|
-
*/
|
|
21
|
-
export declare const HEARTBEAT_INTERVAL_MS = 30000;
|
|
22
|
-
export declare const HEARTBEAT_TIMEOUT_MS = 10000;
|
|
23
|
-
/**
|
|
24
|
-
* The narrow slice of the socket the heartbeat depends on. Keeping it small
|
|
25
|
-
* lets the {@link HeartbeatController} work without depending on the full
|
|
26
|
-
* WebSocket transport.
|
|
27
|
-
*/
|
|
28
|
-
export interface HeartbeatTransport {
|
|
29
|
-
/** True only while the underlying socket is open. */
|
|
30
|
-
isSocketOpen(): boolean;
|
|
31
|
-
/** Sends the `{ type: 'ping' }` frame; throws when the socket is already dead. */
|
|
32
|
-
sendPing(): void;
|
|
33
|
-
/**
|
|
34
|
-
* Closes the socket from the client side with a private 4xxx code, so the
|
|
35
|
-
* socket's close event fires and the owner's reconnect or handshake-failure
|
|
36
|
-
* handling runs.
|
|
37
|
-
*/
|
|
38
|
-
forceClose(reason: string): void;
|
|
39
|
-
}
|
|
40
|
-
/**
|
|
41
|
-
* Runs the application-level heartbeat for one socket. While the socket is
|
|
42
|
-
* open, it sends a `{ type: 'ping' }` frame every {@link HEARTBEAT_INTERVAL_MS}
|
|
43
|
-
* and arms a {@link HEARTBEAT_TIMEOUT_MS} watchdog. Any inbound frame clears
|
|
44
|
-
* the watchdog — the owner calls {@link HeartbeatController.clearHeartbeatTimeout}
|
|
45
|
-
* from its message handler. If the watchdog fires first, the connection is
|
|
46
|
-
* treated as a zombie and force-closed, which lets the owner's reconnect path
|
|
47
|
-
* run.
|
|
48
|
-
*
|
|
49
|
-
* The heartbeat exists because the client cannot see the protocol-level
|
|
50
|
-
* keepalive: browsers answer the server's pings automatically but never expose
|
|
51
|
-
* those frames to JavaScript. On a half-open connection (laptop wake, NAT
|
|
52
|
-
* timeout, mobile handoff) the socket can report itself open for minutes
|
|
53
|
-
* before the operating system surfaces the break, so observable application
|
|
54
|
-
* traffic is the only reliable signal.
|
|
55
|
-
*/
|
|
56
|
-
export declare class HeartbeatController {
|
|
57
|
-
private readonly transport;
|
|
58
|
-
private readonly observability;
|
|
59
|
-
private heartbeatTimer;
|
|
60
|
-
private heartbeatTimeoutTimer;
|
|
61
|
-
constructor(transport: HeartbeatTransport, observability?: TransportObservability);
|
|
62
|
-
start(): void;
|
|
63
|
-
stop(): void;
|
|
64
|
-
clearHeartbeatTimeout(): void;
|
|
65
|
-
}
|
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Application-level heartbeat for the sync WebSocket.
|
|
3
|
-
*
|
|
4
|
-
* The browser WebSocket API hides RFC 6455 protocol-level ping and pong frames
|
|
5
|
-
* from JavaScript, so the server's keepalive cannot be observed by client
|
|
6
|
-
* code. That leaves the client unable to tell a healthy idle connection apart
|
|
7
|
-
* from a "zombie" socket whose underlying TCP connection has silently broken
|
|
8
|
-
* (laptop sleep, NAT timeout, mobile handoff). To close the gap, the client
|
|
9
|
-
* sends an application-level `{ type: 'ping' }` every 30 seconds and
|
|
10
|
-
* force-closes the socket if no inbound traffic arrives within 10 seconds. Any
|
|
11
|
-
* inbound message counts as proof the connection is alive; the explicit `pong`
|
|
12
|
-
* merely guarantees that something arrives even on an otherwise idle stream.
|
|
13
|
-
*/
|
|
14
|
-
import { PING_INTERVAL_MS } from '../wire/protocol.js';
|
|
15
|
-
import { noopSocketObservability, } from '../observability.js';
|
|
16
|
-
/**
|
|
17
|
-
* The interval between application-level pings, shared with both sides of the
|
|
18
|
-
* connection: the client pings at the same {@link PING_INTERVAL_MS} the server
|
|
19
|
-
* uses for its own keepalive, and the claim lease window is derived from the
|
|
20
|
-
* same constant.
|
|
21
|
-
*/
|
|
22
|
-
export const HEARTBEAT_INTERVAL_MS = PING_INTERVAL_MS;
|
|
23
|
-
export const HEARTBEAT_TIMEOUT_MS = 10_000;
|
|
24
|
-
/**
|
|
25
|
-
* Runs the application-level heartbeat for one socket. While the socket is
|
|
26
|
-
* open, it sends a `{ type: 'ping' }` frame every {@link HEARTBEAT_INTERVAL_MS}
|
|
27
|
-
* and arms a {@link HEARTBEAT_TIMEOUT_MS} watchdog. Any inbound frame clears
|
|
28
|
-
* the watchdog — the owner calls {@link HeartbeatController.clearHeartbeatTimeout}
|
|
29
|
-
* from its message handler. If the watchdog fires first, the connection is
|
|
30
|
-
* treated as a zombie and force-closed, which lets the owner's reconnect path
|
|
31
|
-
* run.
|
|
32
|
-
*
|
|
33
|
-
* The heartbeat exists because the client cannot see the protocol-level
|
|
34
|
-
* keepalive: browsers answer the server's pings automatically but never expose
|
|
35
|
-
* those frames to JavaScript. On a half-open connection (laptop wake, NAT
|
|
36
|
-
* timeout, mobile handoff) the socket can report itself open for minutes
|
|
37
|
-
* before the operating system surfaces the break, so observable application
|
|
38
|
-
* traffic is the only reliable signal.
|
|
39
|
-
*/
|
|
40
|
-
export class HeartbeatController {
|
|
41
|
-
transport;
|
|
42
|
-
observability;
|
|
43
|
-
heartbeatTimer = null;
|
|
44
|
-
heartbeatTimeoutTimer = null;
|
|
45
|
-
constructor(transport, observability = noopSocketObservability) {
|
|
46
|
-
this.transport = transport;
|
|
47
|
-
this.observability = observability;
|
|
48
|
-
}
|
|
49
|
-
start() {
|
|
50
|
-
this.stop();
|
|
51
|
-
this.heartbeatTimer = setInterval(() => {
|
|
52
|
-
if (!this.transport.isSocketOpen())
|
|
53
|
-
return;
|
|
54
|
-
// Send the ping. If it throws, the socket is already dead, so
|
|
55
|
-
// force-close it to let the close event drive the reconnect cycle.
|
|
56
|
-
try {
|
|
57
|
-
this.transport.sendPing();
|
|
58
|
-
}
|
|
59
|
-
catch (err) {
|
|
60
|
-
this.observability.captureWebSocketError({
|
|
61
|
-
context: 'heartbeat-send-failed',
|
|
62
|
-
error: err instanceof Error ? err.message : String(err),
|
|
63
|
-
});
|
|
64
|
-
this.transport.forceClose('heartbeat-send-failed');
|
|
65
|
-
return;
|
|
66
|
-
}
|
|
67
|
-
// Arm the timeout. Any inbound message clears it; an explicit `pong` is
|
|
68
|
-
// not required, since a delta or any other frame is equally good proof
|
|
69
|
-
// that the connection is alive.
|
|
70
|
-
if (this.heartbeatTimeoutTimer)
|
|
71
|
-
clearTimeout(this.heartbeatTimeoutTimer);
|
|
72
|
-
this.heartbeatTimeoutTimer = setTimeout(() => {
|
|
73
|
-
this.observability.captureWebSocketError({
|
|
74
|
-
context: 'heartbeat-timeout',
|
|
75
|
-
});
|
|
76
|
-
this.transport.forceClose('heartbeat-timeout');
|
|
77
|
-
}, HEARTBEAT_TIMEOUT_MS);
|
|
78
|
-
}, HEARTBEAT_INTERVAL_MS);
|
|
79
|
-
}
|
|
80
|
-
stop() {
|
|
81
|
-
if (this.heartbeatTimer) {
|
|
82
|
-
clearInterval(this.heartbeatTimer);
|
|
83
|
-
this.heartbeatTimer = null;
|
|
84
|
-
}
|
|
85
|
-
this.clearHeartbeatTimeout();
|
|
86
|
-
}
|
|
87
|
-
clearHeartbeatTimeout() {
|
|
88
|
-
if (this.heartbeatTimeoutTimer) {
|
|
89
|
-
clearTimeout(this.heartbeatTimeoutTimer);
|
|
90
|
-
this.heartbeatTimeoutTimer = null;
|
|
91
|
-
}
|
|
92
|
-
}
|
|
93
|
-
}
|