@open-e2ee/signal-protocol-sdk 10.1.0 → 12.0.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.
- package/ADAPTERS.md +4 -4
- package/ARCHITECTURE.md +6 -8
- package/CHANGELOG.md +1413 -0
- package/README.md +1 -1
- package/SECURITY.md +2 -2
- package/TROUBLESHOOTING.md +1 -1
- package/client/README.md +84 -37
- package/device/README.md +39 -85
- package/dist/client/client.d.ts +342 -62
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +1195 -179
- package/dist/client/client.js.map +1 -1
- package/dist/client/config.d.ts +40 -32
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/constants.d.ts +42 -8
- package/dist/client/constants.d.ts.map +1 -1
- package/dist/client/constants.js +48 -3
- package/dist/client/constants.js.map +1 -1
- package/dist/client/content-adapter.d.ts +80 -0
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +225 -12
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/delivery-error.d.ts +150 -0
- package/dist/client/delivery-error.d.ts.map +1 -0
- package/dist/client/delivery-error.js +226 -0
- package/dist/client/delivery-error.js.map +1 -0
- package/dist/client/delivery-status.d.ts +32 -6
- package/dist/client/delivery-status.d.ts.map +1 -1
- package/dist/client/delivery-status.js +61 -13
- package/dist/client/delivery-status.js.map +1 -1
- package/dist/client/device-set-reconciliation.d.ts +196 -0
- package/dist/client/device-set-reconciliation.d.ts.map +1 -0
- package/dist/client/device-set-reconciliation.js +282 -0
- package/dist/client/device-set-reconciliation.js.map +1 -0
- package/dist/client/distribution-records.d.ts +29 -0
- package/dist/client/distribution-records.d.ts.map +1 -0
- package/dist/client/distribution-records.js +33 -0
- package/dist/client/distribution-records.js.map +1 -0
- package/dist/client/event-hooks.d.ts +308 -6
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +9 -0
- package/dist/client/event-hooks.js.map +1 -1
- package/dist/client/group-device-set.d.ts +47 -0
- package/dist/client/group-device-set.d.ts.map +1 -0
- package/dist/client/group-device-set.js +65 -0
- package/dist/client/group-device-set.js.map +1 -0
- package/dist/client/group-fetcher.d.ts +116 -0
- package/dist/client/group-fetcher.d.ts.map +1 -0
- package/dist/client/group-fetcher.js +598 -0
- package/dist/client/group-fetcher.js.map +1 -0
- package/dist/client/group-outbox.d.ts +172 -10
- package/dist/client/group-outbox.d.ts.map +1 -1
- package/dist/client/group-outbox.js +915 -74
- package/dist/client/group-outbox.js.map +1 -1
- package/dist/client/group-receive-authorization.d.ts +127 -4
- package/dist/client/group-receive-authorization.d.ts.map +1 -1
- package/dist/client/group-receive-authorization.js +270 -20
- package/dist/client/group-receive-authorization.js.map +1 -1
- package/dist/client/group-sealed-sender.d.ts +3 -0
- package/dist/client/group-sealed-sender.d.ts.map +1 -1
- package/dist/client/group-sealed-sender.js +1 -0
- package/dist/client/group-sealed-sender.js.map +1 -1
- package/dist/client/group-sender-key-operations.d.ts +14 -3
- package/dist/client/group-sender-key-operations.d.ts.map +1 -1
- package/dist/client/group-sender-key-operations.js +26 -5
- package/dist/client/group-sender-key-operations.js.map +1 -1
- package/dist/client/groups.d.ts +5 -5
- package/dist/client/groups.d.ts.map +1 -1
- package/dist/client/groups.js +5 -4
- package/dist/client/groups.js.map +1 -1
- package/dist/client/hosted-anonymous-delivery.d.ts +61 -9
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
- package/dist/client/hosted-anonymous-delivery.js +242 -48
- package/dist/client/hosted-anonymous-delivery.js.map +1 -1
- package/dist/client/hosted-assertion-id.d.ts +7 -0
- package/dist/client/hosted-assertion-id.d.ts.map +1 -0
- package/dist/client/hosted-assertion-id.js +51 -0
- package/dist/client/hosted-assertion-id.js.map +1 -0
- package/dist/client/hosted-device-standing.d.ts +52 -0
- package/dist/client/hosted-device-standing.d.ts.map +1 -0
- package/dist/client/hosted-device-standing.js +74 -0
- package/dist/client/hosted-device-standing.js.map +1 -0
- package/dist/client/hosted-mailbox-subscription.d.ts +48 -3
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
- package/dist/client/hosted-mailbox-subscription.js +288 -74
- package/dist/client/hosted-mailbox-subscription.js.map +1 -1
- package/dist/client/hosted-push.d.ts +22 -4
- package/dist/client/hosted-push.d.ts.map +1 -1
- package/dist/client/hosted-push.js +75 -22
- package/dist/client/hosted-push.js.map +1 -1
- package/dist/client/hosted-transport.d.ts +22 -28
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +167 -69
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted.d.ts +22 -5
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +122 -45
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +6 -4
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +3 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/messages.d.ts +25 -3
- package/dist/client/messages.d.ts.map +1 -1
- package/dist/client/messages.js +118 -17
- package/dist/client/messages.js.map +1 -1
- package/dist/client/one-time-prekey-refill.d.ts +7 -0
- package/dist/client/one-time-prekey-refill.d.ts.map +1 -1
- package/dist/client/one-time-prekey-refill.js +5 -1
- package/dist/client/one-time-prekey-refill.js.map +1 -1
- package/dist/client/receive-admission.d.ts +58 -0
- package/dist/client/receive-admission.d.ts.map +1 -0
- package/dist/client/receive-admission.js +78 -0
- package/dist/client/receive-admission.js.map +1 -0
- package/dist/client/receive-expiry.d.ts +31 -0
- package/dist/client/receive-expiry.d.ts.map +1 -0
- package/dist/client/receive-expiry.js +35 -0
- package/dist/client/receive-expiry.js.map +1 -0
- package/dist/client/receive-hook-bound.d.ts +50 -0
- package/dist/client/receive-hook-bound.d.ts.map +1 -0
- package/dist/client/receive-hook-bound.js +115 -0
- package/dist/client/receive-hook-bound.js.map +1 -0
- package/dist/client/receive-queue.d.ts +299 -0
- package/dist/client/receive-queue.d.ts.map +1 -0
- package/dist/client/receive-queue.js +1420 -0
- package/dist/client/receive-queue.js.map +1 -0
- package/dist/client/receive-work-seed.d.ts +54 -0
- package/dist/client/receive-work-seed.d.ts.map +1 -0
- package/dist/client/receive-work-seed.js +116 -0
- package/dist/client/receive-work-seed.js.map +1 -0
- package/dist/client/recovery-driver.d.ts +25 -0
- package/dist/client/recovery-driver.d.ts.map +1 -0
- package/dist/client/recovery-driver.js +121 -0
- package/dist/client/recovery-driver.js.map +1 -0
- package/dist/client/relay-acceptance.d.ts +30 -0
- package/dist/client/relay-acceptance.d.ts.map +1 -1
- package/dist/client/relay-acceptance.js +55 -0
- package/dist/client/relay-acceptance.js.map +1 -1
- package/dist/client/relay-device-refusal.d.ts +18 -0
- package/dist/client/relay-device-refusal.d.ts.map +1 -1
- package/dist/client/relay-device-refusal.js +31 -0
- package/dist/client/relay-device-refusal.js.map +1 -1
- package/dist/client/relay-sealed-route.d.ts +36 -0
- package/dist/client/relay-sealed-route.d.ts.map +1 -0
- package/dist/client/relay-sealed-route.js +45 -0
- package/dist/client/relay-sealed-route.js.map +1 -0
- package/dist/client/relay-subscription.d.ts +56 -13
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +220 -150
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/resendable-content.d.ts +98 -0
- package/dist/client/resendable-content.d.ts.map +1 -0
- package/dist/client/resendable-content.js +136 -0
- package/dist/client/resendable-content.js.map +1 -0
- package/dist/client/retry-family.d.ts +68 -19
- package/dist/client/retry-family.d.ts.map +1 -1
- package/dist/client/retry-family.js +59 -17
- package/dist/client/retry-family.js.map +1 -1
- package/dist/client/retry-request-envelope.d.ts +145 -18
- package/dist/client/retry-request-envelope.d.ts.map +1 -1
- package/dist/client/retry-request-envelope.js +301 -64
- package/dist/client/retry-request-envelope.js.map +1 -1
- package/dist/client/retry-request-lifecycle.d.ts +157 -0
- package/dist/client/retry-request-lifecycle.d.ts.map +1 -0
- package/dist/client/retry-request-lifecycle.js +437 -0
- package/dist/client/retry-request-lifecycle.js.map +1 -0
- package/dist/client/retry-terminal-recovery.d.ts +100 -0
- package/dist/client/retry-terminal-recovery.d.ts.map +1 -0
- package/dist/client/retry-terminal-recovery.js +164 -0
- package/dist/client/retry-terminal-recovery.js.map +1 -0
- package/dist/client/retry-utils.d.ts +27 -0
- package/dist/client/retry-utils.d.ts.map +1 -1
- package/dist/client/retry-utils.js +46 -0
- package/dist/client/retry-utils.js.map +1 -1
- package/dist/client/retry.d.ts +106 -18
- package/dist/client/retry.d.ts.map +1 -1
- package/dist/client/retry.js +687 -139
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender.d.ts +23 -6
- package/dist/client/sealed-sender.d.ts.map +1 -1
- package/dist/client/sealed-sender.js +30 -6
- package/dist/client/sealed-sender.js.map +1 -1
- package/dist/client/sessions.d.ts +2 -2
- package/dist/client/sessions.js +2 -2
- package/dist/client/signal-service-cipher.d.ts +726 -19
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +2265 -343
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/state.d.ts +5 -0
- package/dist/client/state.d.ts.map +1 -1
- package/dist/client/state.js +11 -1
- package/dist/client/state.js.map +1 -1
- package/dist/client/storage-protection.d.ts +64 -0
- package/dist/client/storage-protection.d.ts.map +1 -0
- package/dist/client/storage-protection.js +150 -0
- package/dist/client/storage-protection.js.map +1 -0
- package/dist/client/types.d.ts +149 -15
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/device/constants.d.ts +0 -5
- package/dist/device/constants.d.ts.map +1 -1
- package/dist/device/constants.js +0 -5
- package/dist/device/constants.js.map +1 -1
- package/dist/device/expo/index.d.ts +4 -17
- package/dist/device/expo/index.d.ts.map +1 -1
- package/dist/device/expo/index.js +4 -23
- package/dist/device/expo/index.js.map +1 -1
- package/dist/device/index.d.ts +0 -2
- package/dist/device/index.d.ts.map +1 -1
- package/dist/device/index.js +0 -7
- package/dist/device/index.js.map +1 -1
- package/dist/device/lifecycle/manager.d.ts +5 -4
- package/dist/device/lifecycle/manager.d.ts.map +1 -1
- package/dist/device/lifecycle/manager.js +16 -16
- package/dist/device/lifecycle/manager.js.map +1 -1
- package/dist/device/lifecycle/types.d.ts +2 -2
- package/dist/device/lifecycle/types.d.ts.map +1 -1
- package/dist/device/react-native/index.d.ts +4 -15
- package/dist/device/react-native/index.d.ts.map +1 -1
- package/dist/device/react-native/index.js +4 -21
- package/dist/device/react-native/index.js.map +1 -1
- package/dist/device/types.d.ts +1 -1
- package/dist/groups/index.d.ts +1 -1
- package/dist/groups/index.d.ts.map +1 -1
- package/dist/index.d.ts +8 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts +0 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.js +0 -1
- package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
- package/dist/internal/crypto/validation.d.ts +2 -2
- package/dist/internal/groups/index.d.ts +1 -0
- package/dist/internal/groups/index.d.ts.map +1 -1
- package/dist/internal/groups/index.js +1 -0
- package/dist/internal/groups/index.js.map +1 -1
- package/dist/internal/groups/manager.d.ts +37 -16
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +46 -1
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/receive-record.d.ts +78 -0
- package/dist/internal/groups/receive-record.d.ts.map +1 -0
- package/dist/internal/groups/receive-record.js +43 -0
- package/dist/internal/groups/receive-record.js.map +1 -0
- package/dist/internal/groups/sdk-store.d.ts +27 -3
- package/dist/internal/groups/sdk-store.d.ts.map +1 -1
- package/dist/internal/groups/sdk-store.js +151 -19
- package/dist/internal/groups/sdk-store.js.map +1 -1
- package/dist/internal/groups/wire.d.ts +12 -1
- package/dist/internal/groups/wire.d.ts.map +1 -1
- package/dist/internal/groups/wire.js +36 -0
- package/dist/internal/groups/wire.js.map +1 -1
- package/dist/internal/manager/index.d.ts +1 -1
- package/dist/internal/manager/manager.d.ts +20 -19
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +56 -39
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts +4 -18
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.js +23 -74
- package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/index.d.ts +1 -1
- package/dist/internal/protocol/double-ratchet/index.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/index.js +1 -1
- package/dist/internal/protocol/double-ratchet/index.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +5 -7
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.js +4 -6
- package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js +2 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.d.ts +6 -8
- package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.js +8 -9
- package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
- package/dist/internal/protocol/sender-keys/handoff-ledger.d.ts +110 -0
- package/dist/internal/protocol/sender-keys/handoff-ledger.d.ts.map +1 -0
- package/dist/internal/protocol/sender-keys/handoff-ledger.js +124 -0
- package/dist/internal/protocol/sender-keys/handoff-ledger.js.map +1 -0
- package/dist/internal/protocol/sender-keys/manager.d.ts +71 -62
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +228 -175
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/index.d.ts +2 -2
- package/dist/internal/protocol/spqr/index.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/index.js +2 -2
- package/dist/internal/protocol/spqr/index.js.map +1 -1
- package/dist/internal/protocol/spqr/serialize.d.ts +9 -1
- package/dist/internal/protocol/spqr/serialize.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/serialize.js +56 -16
- package/dist/internal/protocol/spqr/serialize.js.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +1 -14
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js +54 -42
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/spqr/validate.d.ts +26 -6
- package/dist/internal/protocol/spqr/validate.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/validate.js +49 -21
- package/dist/internal/protocol/spqr/validate.js.map +1 -1
- package/dist/internal/sesame/index.d.ts +1 -1
- package/dist/internal/sesame/index.d.ts.map +1 -1
- package/dist/internal/sesame/index.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +66 -13
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +221 -87
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/sesame/types.d.ts +95 -17
- package/dist/internal/sesame/types.d.ts.map +1 -1
- package/dist/internal/sesame/types.js +17 -0
- package/dist/internal/sesame/types.js.map +1 -1
- package/dist/internal/session/builder.d.ts +5 -5
- package/dist/internal/session/builder.d.ts.map +1 -1
- package/dist/internal/session/builder.js +12 -17
- package/dist/internal/session/builder.js.map +1 -1
- package/dist/internal/session/cipher.d.ts +13 -11
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +40 -22
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/factory.d.ts +5 -5
- package/dist/internal/session/factory.d.ts.map +1 -1
- package/dist/internal/session/factory.js +4 -4
- package/dist/internal/session/factory.js.map +1 -1
- package/dist/internal/session/handshake.d.ts +14 -16
- package/dist/internal/session/handshake.d.ts.map +1 -1
- package/dist/internal/session/handshake.js +18 -75
- package/dist/internal/session/handshake.js.map +1 -1
- package/dist/internal/session/index.d.ts +1 -1
- package/dist/internal/session/index.js +1 -1
- package/dist/internal/session/record-locks.d.ts +17 -6
- package/dist/internal/session/record-locks.d.ts.map +1 -1
- package/dist/internal/session/record-locks.js +43 -7
- package/dist/internal/session/record-locks.js.map +1 -1
- package/dist/internal/session/session-resolver.d.ts +1 -1
- package/dist/internal/session/session-resolver.js +1 -1
- package/dist/internal/session/state.d.ts +2 -2
- package/dist/internal/session/state.js +1 -1
- package/dist/internal/session/types.d.ts +4 -12
- package/dist/internal/session/types.d.ts.map +1 -1
- package/dist/internal/session/types.js +1 -1
- package/dist/keys/generation.d.ts +2 -2
- package/dist/keys/generation.js +2 -2
- package/dist/keys/types.d.ts +5 -5
- package/dist/keys/types.d.ts.map +1 -1
- package/dist/keys/types.js +1 -1
- package/dist/layers.d.ts +1 -1
- package/dist/layers.js +2 -2
- package/dist/layers.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +12 -8
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/key-value/adapter.d.ts +76 -10
- package/dist/local/store/key-value/adapter.d.ts.map +1 -1
- package/dist/local/store/key-value/adapter.js +367 -61
- package/dist/local/store/key-value/adapter.js.map +1 -1
- package/dist/local/store/key-value/backend-conformance.d.ts.map +1 -1
- package/dist/local/store/key-value/backend-conformance.js +74 -0
- package/dist/local/store/key-value/backend-conformance.js.map +1 -1
- package/dist/local/store/key-value/batch.d.ts +2 -0
- package/dist/local/store/key-value/batch.d.ts.map +1 -1
- package/dist/local/store/key-value/batch.js +26 -0
- package/dist/local/store/key-value/batch.js.map +1 -1
- package/dist/local/store/key-value/receive-work.d.ts +55 -0
- package/dist/local/store/key-value/receive-work.d.ts.map +1 -0
- package/dist/local/store/key-value/receive-work.js +162 -0
- package/dist/local/store/key-value/receive-work.js.map +1 -0
- package/dist/local/store/key-value/send-log.d.ts +61 -0
- package/dist/local/store/key-value/send-log.d.ts.map +1 -0
- package/dist/local/store/key-value/send-log.js +430 -0
- package/dist/local/store/key-value/send-log.js.map +1 -0
- package/dist/local/store/key-value/sender-key-handoff.d.ts +68 -0
- package/dist/local/store/key-value/sender-key-handoff.d.ts.map +1 -0
- package/dist/local/store/key-value/sender-key-handoff.js +189 -0
- package/dist/local/store/key-value/sender-key-handoff.js.map +1 -0
- package/dist/local/store/key-value/storage.d.ts +15 -0
- package/dist/local/store/key-value/storage.d.ts.map +1 -1
- package/dist/local/store/keyed-index.d.ts +23 -0
- package/dist/local/store/keyed-index.d.ts.map +1 -0
- package/dist/local/store/keyed-index.js +41 -0
- package/dist/local/store/keyed-index.js.map +1 -0
- package/dist/local/store/memory/adapter.d.ts +44 -12
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +197 -46
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/memory/send-log.d.ts +42 -0
- package/dist/local/store/memory/send-log.d.ts.map +1 -0
- package/dist/local/store/memory/send-log.js +190 -0
- package/dist/local/store/memory/send-log.js.map +1 -0
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +8 -6
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +12 -8
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/receive-work.d.ts +87 -0
- package/dist/local/store/receive-work.d.ts.map +1 -0
- package/dist/local/store/receive-work.js +204 -0
- package/dist/local/store/receive-work.js.map +1 -0
- package/dist/local/store/received-content.d.ts +3 -3
- package/dist/local/store/received-content.d.ts.map +1 -1
- package/dist/local/store/received-content.js +2 -11
- package/dist/local/store/received-content.js.map +1 -1
- package/dist/local/store/reliability.d.ts +411 -14
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +532 -58
- package/dist/local/store/reliability.js.map +1 -1
- package/dist/local/store/send-log-order.d.ts +15 -0
- package/dist/local/store/send-log-order.d.ts.map +1 -0
- package/dist/local/store/send-log-order.js +24 -0
- package/dist/local/store/send-log-order.js.map +1 -0
- package/dist/local/store/sender-key-handoff-index.d.ts +38 -0
- package/dist/local/store/sender-key-handoff-index.d.ts.map +1 -0
- package/dist/local/store/sender-key-handoff-index.js +101 -0
- package/dist/local/store/sender-key-handoff-index.js.map +1 -0
- package/dist/local/store/sender-key-handoff-table.d.ts +29 -0
- package/dist/local/store/sender-key-handoff-table.d.ts.map +1 -0
- package/dist/local/store/sender-key-handoff-table.js +97 -0
- package/dist/local/store/sender-key-handoff-table.js.map +1 -0
- package/dist/local/store/sqlite/encryption.d.ts +8 -1
- package/dist/local/store/sqlite/encryption.d.ts.map +1 -1
- package/dist/local/store/sqlite/encryption.js +9 -0
- package/dist/local/store/sqlite/encryption.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/index.d.ts +25 -4
- package/dist/local/store/sqlite/key-storage/index.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/index.js +68 -7
- package/dist/local/store/sqlite/key-storage/index.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/message-records.d.ts +16 -4
- package/dist/local/store/sqlite/key-storage/message-records.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/message-records.js +49 -6
- package/dist/local/store/sqlite/key-storage/message-records.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/metadata.d.ts +8 -7
- package/dist/local/store/sqlite/key-storage/metadata.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/metadata.js +17 -15
- package/dist/local/store/sqlite/key-storage/metadata.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/receive-work.d.ts +27 -0
- package/dist/local/store/sqlite/key-storage/receive-work.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/receive-work.js +98 -0
- package/dist/local/store/sqlite/key-storage/receive-work.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/send-log.d.ts +27 -0
- package/dist/local/store/sqlite/key-storage/send-log.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/send-log.js +178 -0
- package/dist/local/store/sqlite/key-storage/send-log.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts +27 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.js +75 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/session-trust.d.ts +2 -2
- package/dist/local/store/sqlite/key-storage/session-trust.js +5 -5
- package/dist/local/store/sqlite/key-storage/session-trust.js.map +1 -1
- package/dist/local/store/sqlite/migrations.d.ts.map +1 -1
- package/dist/local/store/sqlite/migrations.js +101 -0
- package/dist/local/store/sqlite/migrations.js.map +1 -1
- package/dist/local/store/sqlite/models/index.d.ts +2 -1
- package/dist/local/store/sqlite/models/index.d.ts.map +1 -1
- package/dist/local/store/sqlite/models/index.js +5 -1
- package/dist/local/store/sqlite/models/index.js.map +1 -1
- package/dist/local/store/sqlite/models/message-record.d.ts +15 -0
- package/dist/local/store/sqlite/models/message-record.d.ts.map +1 -1
- package/dist/local/store/sqlite/models/message-record.js +24 -0
- package/dist/local/store/sqlite/models/message-record.js.map +1 -1
- package/dist/local/store/sqlite/models/send-log.d.ts +51 -0
- package/dist/local/store/sqlite/models/send-log.d.ts.map +1 -0
- package/dist/local/store/sqlite/models/send-log.js +206 -0
- package/dist/local/store/sqlite/models/send-log.js.map +1 -0
- package/dist/local/store/sqlite/open-store.d.ts +9 -1
- package/dist/local/store/sqlite/open-store.d.ts.map +1 -1
- package/dist/local/store/sqlite/open-store.js +20 -1
- package/dist/local/store/sqlite/open-store.js.map +1 -1
- package/dist/local/store/sqlite/schema.d.ts +34 -1
- package/dist/local/store/sqlite/schema.d.ts.map +1 -1
- package/dist/local/store/sqlite/schema.js +14 -0
- package/dist/local/store/sqlite/schema.js.map +1 -1
- package/dist/local/store/sqlite/store.d.ts +61 -11
- package/dist/local/store/sqlite/store.d.ts.map +1 -1
- package/dist/local/store/sqlite/store.js +191 -27
- package/dist/local/store/sqlite/store.js.map +1 -1
- package/dist/local/store/web/adapter.d.ts +76 -8
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +579 -127
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/store/web/receive-work.d.ts +57 -0
- package/dist/local/store/web/receive-work.d.ts.map +1 -0
- package/dist/local/store/web/receive-work.js +99 -0
- package/dist/local/store/web/receive-work.js.map +1 -0
- package/dist/local/store/web/send-log.d.ts +92 -0
- package/dist/local/store/web/send-log.d.ts.map +1 -0
- package/dist/local/store/web/send-log.js +267 -0
- package/dist/local/store/web/send-log.js.map +1 -0
- package/dist/local/store/web/sender-key-handoff.d.ts +81 -0
- package/dist/local/store/web/sender-key-handoff.d.ts.map +1 -0
- package/dist/local/store/web/sender-key-handoff.js +156 -0
- package/dist/local/store/web/sender-key-handoff.js.map +1 -0
- package/dist/local/store/web-sqlite/adapter.d.ts +2 -0
- package/dist/local/store/web-sqlite/adapter.d.ts.map +1 -1
- package/dist/local/store/web-sqlite/adapter.js +12 -6
- package/dist/local/store/web-sqlite/adapter.js.map +1 -1
- package/dist/local/vault/custody.d.ts +8 -0
- package/dist/local/vault/custody.d.ts.map +1 -0
- package/dist/local/vault/custody.js +9 -0
- package/dist/local/vault/custody.js.map +1 -0
- package/dist/local/vault/electron-safe-storage.d.ts +3 -1
- package/dist/local/vault/electron-safe-storage.d.ts.map +1 -1
- package/dist/local/vault/electron-safe-storage.js +2 -0
- package/dist/local/vault/electron-safe-storage.js.map +1 -1
- package/dist/local/vault/expo-secure-store.d.ts +3 -1
- package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
- package/dist/local/vault/expo-secure-store.js +2 -0
- package/dist/local/vault/expo-secure-store.js.map +1 -1
- package/dist/local/vault/indexed-db.d.ts +3 -1
- package/dist/local/vault/indexed-db.d.ts.map +1 -1
- package/dist/local/vault/indexed-db.js +2 -0
- package/dist/local/vault/indexed-db.js.map +1 -1
- package/dist/local/vault/react-native-keychain.d.ts +3 -1
- package/dist/local/vault/react-native-keychain.d.ts.map +1 -1
- package/dist/local/vault/react-native-keychain.js +2 -0
- package/dist/local/vault/react-native-keychain.js.map +1 -1
- package/dist/remote/relay/device-set.d.ts +94 -0
- package/dist/remote/relay/device-set.d.ts.map +1 -0
- package/dist/remote/relay/device-set.js +156 -0
- package/dist/remote/relay/device-set.js.map +1 -0
- package/dist/remote/relay/types.d.ts +104 -110
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/safety/core.d.ts +15 -6
- package/dist/safety/core.d.ts.map +1 -1
- package/dist/safety/core.js +41 -27
- package/dist/safety/core.js.map +1 -1
- package/dist/safety/index.d.ts +2 -1
- package/dist/safety/index.d.ts.map +1 -1
- package/dist/safety/index.js +12 -18
- package/dist/safety/index.js.map +1 -1
- package/dist/types/api.d.ts +707 -62
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +14 -33
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +14 -24
- package/dist/types/errors.js.map +1 -1
- package/dist/types/messages.d.ts +2 -2
- package/dist/types/messages.js +1 -1
- package/dist/types/protocol-config.d.ts +175 -42
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +19 -38
- package/dist/types/protocol-config.js.map +1 -1
- package/dist/types/protocol-constants.d.ts +6 -6
- package/dist/types/protocol-constants.js +6 -6
- package/dist/types/session.d.ts +7 -7
- package/dist/types/session.d.ts.map +1 -1
- package/dist/types/session.js +39 -21
- package/dist/types/session.js.map +1 -1
- package/dist/username/link.d.ts +2 -2
- package/dist/username/link.js +2 -2
- package/dist/utils/origin-lock.d.ts +45 -0
- package/dist/utils/origin-lock.d.ts.map +1 -0
- package/dist/utils/origin-lock.js +80 -0
- package/dist/utils/origin-lock.js.map +1 -0
- package/dist/utils/retry.d.ts +2 -0
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +7 -0
- package/dist/utils/retry.js.map +1 -1
- package/docs/ASSURANCE.md +6 -6
- package/docs/CLIENT_COMPOSITION.md +2 -2
- package/docs/DEVIATIONS.md +677 -182
- package/docs/E2EE.md +1 -1
- package/docs/ERROR_HANDLING.md +235 -2
- package/docs/GETTING_STARTED.md +7 -4
- package/docs/INTERFACES.md +1 -1
- package/docs/PACKAGE_SURFACE.md +6 -5
- package/docs/PROTOCOL_POLICY.md +102 -22
- package/docs/RECIPES.md +3 -15
- package/docs/SECURITY.md +90 -5
- package/keys/README.md +3 -3
- package/local/store/README.md +78 -14
- package/local/store/key-value/README.md +14 -3
- package/local/store/node/README.md +8 -3
- package/local/store/web/README.md +9 -0
- package/local/store/web-sqlite/README.md +14 -2
- package/local/vault/README.md +21 -0
- package/package.json +1 -6
- package/remote/README.md +0 -1
- package/remote/relay/README.md +2 -2
- package/dist/device/provisioning.d.ts +0 -242
- package/dist/device/provisioning.d.ts.map +0 -1
- package/dist/device/provisioning.js +0 -421
- package/dist/device/provisioning.js.map +0 -1
- package/dist/internal/protocol/x3dh/index.d.ts +0 -15
- package/dist/internal/protocol/x3dh/index.d.ts.map +0 -1
- package/dist/internal/protocol/x3dh/index.js +0 -13
- package/dist/internal/protocol/x3dh/index.js.map +0 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts +0 -131
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +0 -1
- package/dist/internal/protocol/x3dh/x3dh.js +0 -261
- package/dist/internal/protocol/x3dh/x3dh.js.map +0 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"retry-request-lifecycle.d.ts","sourceRoot":"","sources":["../../client/retry-request-lifecycle.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAKL,iBAAiB,EAIlB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAE/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAKL,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EAExB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAEL,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC7B,MAAM,2BAA2B,CAAC;AAEnC,KAAK,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,CAAC;AAEtF;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAG/F;AAED,4EAA4E;AAC5E,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,yBAAyB,GAAG,SAAS,CAAC;IACtD,4DAA4D;IAC5D,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;IACnC,gEAAgE;IAChE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,kEAAkE;IAClE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,8EAA8E;IAC9E,KAAK,IAAI,OAAO,CAAC;IACjB,4EAA4E;IAC5E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IACtE;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE;QACxB,wEAAwE;QACxE,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;QAClC,sDAAsD;QACtD,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;QAC5B,2EAA2E;QAC3E,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;QAChC,iEAAiE;QACjE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAC1B,mFAAmF;QACnF,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;KACpC,CAAC;IACF;;;;OAIG;IACH,aAAa,CAAC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACzD,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IACtD;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,iFAAiF;IACjF,QAAQ,CAAC,KAAK,EAAE,uBAAuB,GAAG,SAAS,CAAC;CACrD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,yBAAyB,EAClC,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC,CAwBf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,kBAAkB,EAC1B,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,mBAAmB,CAAC,CA2G9B;AAcD;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,yBAAyB,GAAG,SAAS,CAAC;IACtD,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;IACnC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IACtE,iFAAiF;IACjF,QAAQ,CAAC,KAAK,EAAE,uBAAuB,GAAG,SAAS,CAAC;CACrD"}
|
|
@@ -0,0 +1,437 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The lifecycle of a retry request on the requester device.
|
|
3
|
+
*
|
|
4
|
+
* The request record of a failed envelope owns its retry request from the
|
|
5
|
+
* first post to the answer or to a terminal state. A redelivery of the
|
|
6
|
+
* failed envelope posts nothing while the record exists. A post that fails
|
|
7
|
+
* with a retryable class is posted again by the scheduler at its next
|
|
8
|
+
* attempt time. A post that fails with a conclusive class, the deadline of
|
|
9
|
+
* the record, a failed resend of the last answered attempt, and an
|
|
10
|
+
* exhausted abuse allowance end the request. Each end calls the
|
|
11
|
+
* `onRetryTerminal` hook at least once: the record is marked emitted only
|
|
12
|
+
* after the hook returns. Each request and each scheduler pass also checks
|
|
13
|
+
* the delivery error of the record, as `reportDeliveryError` tells. Each
|
|
14
|
+
* scheduler pass also runs a recovery that the hook did not mark, as
|
|
15
|
+
* `reportDeliveryRecovered` tells.
|
|
16
|
+
*/
|
|
17
|
+
import { getProcessedEnvelope, getRetryRequest, listRetryRequestIds, RETRY_REQUEST_DEADLINE_MS, storeRetryRequest, updateRetryRequest, withProcessedEnvelopeLock, } from '../local/store/reliability.js';
|
|
18
|
+
import { generateUuidV4 } from '../internal/crypto/index.js';
|
|
19
|
+
import { reportDeliveryError, reportDeliveryRecovered } from './delivery-error.js';
|
|
20
|
+
import { answeredLastRetryAttempt, postRetryRequest, postStoredRetryRequest, readRetryRequestEnvelope, } from './retry-request-envelope.js';
|
|
21
|
+
import { rethrowRelayWorkStopped } from './relay-work.js';
|
|
22
|
+
import { resetRetryTerminalSession, } from './retry-terminal-recovery.js';
|
|
23
|
+
/**
|
|
24
|
+
* Tell whether the receive path acknowledges a failed envelope after its
|
|
25
|
+
* retry request. A failed envelope is acknowledged once a record owns its
|
|
26
|
+
* request. A member is acknowledged only when its request attempt is posted
|
|
27
|
+
* or ended, so a member that waits is delivered again.
|
|
28
|
+
*/
|
|
29
|
+
export function acknowledgesRetryRequest(outcome, member) {
|
|
30
|
+
if (outcome === 'deferred' || outcome === 'skipped')
|
|
31
|
+
return false;
|
|
32
|
+
return !member || outcome === 'posted' || outcome === 'terminal';
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Call the `onRetryTerminal` hook for the terminal state of a request
|
|
36
|
+
* record, once. It reads the record, and when the terminal state is not
|
|
37
|
+
* emitted, it first resets the session of an `expired-content` end with
|
|
38
|
+
* `resetRetryTerminalSession`. It then calls the hook and stores the state
|
|
39
|
+
* as emitted. The other classes reset nothing.
|
|
40
|
+
*
|
|
41
|
+
* The hook is called directly, not through `callHook`, so a hook that
|
|
42
|
+
* throws, and the RelayWorkStopped of a stop or of the reset, propagate and
|
|
43
|
+
* leave the state not emitted. The rule is: mark only after the hook
|
|
44
|
+
* returns, and keep the caller alive. The scheduler logs the error and goes
|
|
45
|
+
* on with the next record, and the receive path does not acknowledge the
|
|
46
|
+
* failed envelope. The next scheduler pass, at the next start or the next
|
|
47
|
+
* armed time, or the redelivery continues the reset from its stored steps
|
|
48
|
+
* and calls the hook again. The record holds no emit count, so a hook that
|
|
49
|
+
* keeps throwing runs once each pass until the record expires.
|
|
50
|
+
*/
|
|
51
|
+
export async function emitRetryTerminal(context, failedEnvelopeId) {
|
|
52
|
+
const { storage, hooks } = context;
|
|
53
|
+
const record = await resetRetryTerminalSession(context, failedEnvelopeId);
|
|
54
|
+
const terminal = record?.terminal;
|
|
55
|
+
if (!record || !terminal || terminal.emitted)
|
|
56
|
+
return;
|
|
57
|
+
const hook = hooks?.onRetryTerminal;
|
|
58
|
+
if (hook) {
|
|
59
|
+
const { recovery } = record;
|
|
60
|
+
await hook({
|
|
61
|
+
class: terminal.class,
|
|
62
|
+
failedEnvelopeId,
|
|
63
|
+
...(recovery?.nullMessage && {
|
|
64
|
+
recovery: {
|
|
65
|
+
userId: recovery.userId,
|
|
66
|
+
deviceId: recovery.deviceId,
|
|
67
|
+
senderKey: recovery.senderKey,
|
|
68
|
+
nullMessage: recovery.nullMessage.outcome,
|
|
69
|
+
},
|
|
70
|
+
}),
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
await updateRetryRequest(storage, failedEnvelopeId, record.retryId, record.attempt, {
|
|
74
|
+
terminal: { ...terminal, emitted: true },
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Ask for a resend after a failed decrypt, through the retry family of the
|
|
79
|
+
* envelope.
|
|
80
|
+
*
|
|
81
|
+
* - A failed envelope with a record posts nothing and gives `owned`. It
|
|
82
|
+
* only calls the hook for a terminal state that is not emitted. The rate
|
|
83
|
+
* limit does not count it.
|
|
84
|
+
* - A failed envelope with no record spends one request of the rate limit.
|
|
85
|
+
* A refusal stores a record that ends as `abuse-allowance-exhausted`.
|
|
86
|
+
* - A member of a request that ended posts nothing and gives `terminal`.
|
|
87
|
+
* - A member whose stored attempt is answered and is the last attempt, as
|
|
88
|
+
* `answeredLastRetryAttempt` tells, ends the request as
|
|
89
|
+
* `attempts-exhausted` and gives `terminal`. The rate limit does not
|
|
90
|
+
* count it.
|
|
91
|
+
* - A member whose stored attempt is answered, or that has no record,
|
|
92
|
+
* spends one request of the rate limit, unless an earlier refusal set a
|
|
93
|
+
* next attempt time that has not come. A refusal sets that time to the
|
|
94
|
+
* end of the limit window and gives `deferred`.
|
|
95
|
+
* - A member whose stored attempt is not answered posts it again, with no
|
|
96
|
+
* rate limit.
|
|
97
|
+
*
|
|
98
|
+
* After a post, a terminal outcome calls the hook, and any other outcome
|
|
99
|
+
* arms the scheduler for the record. Then, for each failed envelope with
|
|
100
|
+
* an ID, it runs `onDeliveryError` when the error of the record is due,
|
|
101
|
+
* and arms the scheduler for an error that is due later.
|
|
102
|
+
*/
|
|
103
|
+
export async function requestRetryInFamily(family, fingerprint, source) {
|
|
104
|
+
const { storage, hooks, logger } = source;
|
|
105
|
+
const refused = () => {
|
|
106
|
+
logger.warn('Retry rate limit exceeded for sender', {
|
|
107
|
+
category: 'E2EE',
|
|
108
|
+
data: { senderId: source.senderUserId, windowMs: source.windowMs },
|
|
109
|
+
});
|
|
110
|
+
};
|
|
111
|
+
const sender = { userId: source.senderUserId, deviceId: source.senderDeviceId };
|
|
112
|
+
const request = async (failed) => {
|
|
113
|
+
const failedEnvelopeId = failed.id;
|
|
114
|
+
const { stored } = failed;
|
|
115
|
+
if (failedEnvelopeId === undefined) {
|
|
116
|
+
if (!source.allow()) {
|
|
117
|
+
refused();
|
|
118
|
+
return 'skipped';
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
else if (failed.member === undefined) {
|
|
122
|
+
if (stored) {
|
|
123
|
+
await emitRetryTerminal(source, failedEnvelopeId);
|
|
124
|
+
return 'owned';
|
|
125
|
+
}
|
|
126
|
+
if (!source.allow()) {
|
|
127
|
+
refused();
|
|
128
|
+
const now = Date.now();
|
|
129
|
+
const own = source.failedEnvelope;
|
|
130
|
+
await storeRetryRequest(storage, {
|
|
131
|
+
failedEnvelopeId,
|
|
132
|
+
retryId: await generateUuidV4(),
|
|
133
|
+
attempt: 1,
|
|
134
|
+
requestedAt: now,
|
|
135
|
+
...(failed.fingerprint !== undefined && { fingerprint: failed.fingerprint }),
|
|
136
|
+
answered: false,
|
|
137
|
+
...(own?.groupMessage && { groupMessage: true }),
|
|
138
|
+
...(own?.clientMessageId !== undefined && {
|
|
139
|
+
failedClientMessageId: own.clientMessageId,
|
|
140
|
+
}),
|
|
141
|
+
...(failedGroupId(source) !== undefined && { groupId: failedGroupId(source) }),
|
|
142
|
+
receivedAt: now,
|
|
143
|
+
...(own?.contentHint !== undefined && { contentHint: own.contentHint }),
|
|
144
|
+
failedSender: sender,
|
|
145
|
+
deadlineAt: now + RETRY_REQUEST_DEADLINE_MS,
|
|
146
|
+
terminal: { class: 'abuse-allowance-exhausted', at: now, emitted: false },
|
|
147
|
+
});
|
|
148
|
+
await emitRetryTerminal(source, failedEnvelopeId);
|
|
149
|
+
return 'terminal';
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
else if (stored?.terminal) {
|
|
153
|
+
await emitRetryTerminal(source, failedEnvelopeId);
|
|
154
|
+
return 'terminal';
|
|
155
|
+
}
|
|
156
|
+
else if (stored && answeredLastRetryAttempt(stored)) {
|
|
157
|
+
// The post ends the request, so it spends no request of the rate limit.
|
|
158
|
+
}
|
|
159
|
+
else if (!stored || stored.answered) {
|
|
160
|
+
const now = Date.now();
|
|
161
|
+
if (stored?.lastFailureClass === 'rate-refusal' && (stored.nextAttemptAt ?? 0) > now) {
|
|
162
|
+
return 'deferred';
|
|
163
|
+
}
|
|
164
|
+
if (!source.allow()) {
|
|
165
|
+
refused();
|
|
166
|
+
if (stored) {
|
|
167
|
+
await updateRetryRequest(storage, failedEnvelopeId, stored.retryId, stored.attempt, {
|
|
168
|
+
nextAttemptAt: now + source.windowMs,
|
|
169
|
+
lastFailureClass: 'rate-refusal',
|
|
170
|
+
});
|
|
171
|
+
}
|
|
172
|
+
return 'deferred';
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
if (!source.send) {
|
|
176
|
+
logger.warn('Cannot send retry request: no relay or callback', { category: 'E2EE' });
|
|
177
|
+
return 'skipped';
|
|
178
|
+
}
|
|
179
|
+
const own = failed.member === undefined ? source.failedEnvelope : undefined;
|
|
180
|
+
const groupId = failed.member === undefined ? failedGroupId(source) : undefined;
|
|
181
|
+
const senderKey = failed.member === undefined ? own?.senderKey === true : stored?.groupMessage === true;
|
|
182
|
+
const outcome = await postRetryRequest(storage, {
|
|
183
|
+
...failed,
|
|
184
|
+
...(own?.groupMessage && { groupMessage: true }),
|
|
185
|
+
...(own?.clientMessageId !== undefined && { clientMessageId: own.clientMessageId }),
|
|
186
|
+
...(groupId !== undefined && { groupId }),
|
|
187
|
+
...(own?.contentHint !== undefined && { contentHint: own.contentHint }),
|
|
188
|
+
sender,
|
|
189
|
+
}, () => source.createRequest(senderKey), source.local, source.send);
|
|
190
|
+
if (failedEnvelopeId === undefined)
|
|
191
|
+
return outcome;
|
|
192
|
+
if (outcome === 'terminal') {
|
|
193
|
+
await emitRetryTerminal(source, failedEnvelopeId);
|
|
194
|
+
}
|
|
195
|
+
else {
|
|
196
|
+
const record = await getRetryRequest(storage, failedEnvelopeId);
|
|
197
|
+
if (record && !record.terminal)
|
|
198
|
+
source.schedule?.(record.nextAttemptAt ?? record.deadlineAt);
|
|
199
|
+
}
|
|
200
|
+
return outcome;
|
|
201
|
+
};
|
|
202
|
+
return family.requestRetry(fingerprint, async (failed) => {
|
|
203
|
+
const outcome = await request(failed);
|
|
204
|
+
if (failed.id !== undefined) {
|
|
205
|
+
const errorAt = await reportDeliveryError(storage, hooks, failed.id);
|
|
206
|
+
if (errorAt !== Infinity)
|
|
207
|
+
source.schedule?.(errorAt);
|
|
208
|
+
}
|
|
209
|
+
return outcome;
|
|
210
|
+
});
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* The raw group ID of the failed envelope of a new record: the group that
|
|
214
|
+
* the receive resolved, or else the group of the sender key that the
|
|
215
|
+
* envelope names.
|
|
216
|
+
*/
|
|
217
|
+
function failedGroupId(source) {
|
|
218
|
+
return source.groupId ?? source.failedEnvelope?.groupId;
|
|
219
|
+
}
|
|
220
|
+
/** The longest delay that a timer takes. */
|
|
221
|
+
const MAX_TIMER_DELAY_MS = 2 ** 31 - 1;
|
|
222
|
+
/**
|
|
223
|
+
* Posts each stored retry request whose next attempt time has come, ends
|
|
224
|
+
* each request at its deadline, also when its stored attempt is answered,
|
|
225
|
+
* and calls the hook for each terminal state that is not emitted. A request
|
|
226
|
+
* whose failed envelope is fulfilled has its content, so the scheduler
|
|
227
|
+
* neither posts nor ends it. It then runs `onDeliveryError` for each record whose
|
|
228
|
+
* error is due, and `onDeliveryRecovered` for each fulfilled record whose
|
|
229
|
+
* recovery the hook did not mark. A hook error for one record is logged,
|
|
230
|
+
* the record keeps the time of its next attempt or deadline, and the pass
|
|
231
|
+
* goes on with the next record. A pass runs at start() and at
|
|
232
|
+
* the earliest next attempt
|
|
233
|
+
* time, deadline or error time of the records. Each pass is relay work, so a
|
|
234
|
+
* client stop stops it. Each record is read and posted under the processed
|
|
235
|
+
* lock of its failed envelope, as a receive does.
|
|
236
|
+
*
|
|
237
|
+
* @internal
|
|
238
|
+
*/
|
|
239
|
+
export class RetryRequestScheduler {
|
|
240
|
+
relayWork;
|
|
241
|
+
pass;
|
|
242
|
+
timer;
|
|
243
|
+
armedAt = Infinity;
|
|
244
|
+
running;
|
|
245
|
+
again = false;
|
|
246
|
+
stopped = true;
|
|
247
|
+
constructor(relayWork, pass) {
|
|
248
|
+
this.relayWork = relayWork;
|
|
249
|
+
this.pass = pass;
|
|
250
|
+
}
|
|
251
|
+
/** Run a pass now, and arm the timer after it. The promise never rejects. */
|
|
252
|
+
start() {
|
|
253
|
+
this.stopped = false;
|
|
254
|
+
return this.run();
|
|
255
|
+
}
|
|
256
|
+
/** Clear the timer. No pass starts until the next start(). */
|
|
257
|
+
stop() {
|
|
258
|
+
this.stopped = true;
|
|
259
|
+
this.clear();
|
|
260
|
+
}
|
|
261
|
+
/** Arm the timer for the given time when it is earlier than the armed time. */
|
|
262
|
+
schedule(at) {
|
|
263
|
+
if (this.stopped || at >= this.armedAt)
|
|
264
|
+
return;
|
|
265
|
+
this.clear();
|
|
266
|
+
this.armedAt = at;
|
|
267
|
+
const delay = Math.min(MAX_TIMER_DELAY_MS, Math.max(0, at - Date.now()));
|
|
268
|
+
const timer = setTimeout(() => {
|
|
269
|
+
if (this.timer !== timer)
|
|
270
|
+
return;
|
|
271
|
+
this.timer = undefined;
|
|
272
|
+
this.armedAt = Infinity;
|
|
273
|
+
void this.run();
|
|
274
|
+
}, delay);
|
|
275
|
+
timer.unref?.();
|
|
276
|
+
this.timer = timer;
|
|
277
|
+
}
|
|
278
|
+
clear() {
|
|
279
|
+
if (this.timer !== undefined)
|
|
280
|
+
clearTimeout(this.timer);
|
|
281
|
+
this.timer = undefined;
|
|
282
|
+
this.armedAt = Infinity;
|
|
283
|
+
}
|
|
284
|
+
/** Run a pass. A call during a pass runs one more pass after it. */
|
|
285
|
+
run() {
|
|
286
|
+
if (this.running) {
|
|
287
|
+
this.again = true;
|
|
288
|
+
return this.running;
|
|
289
|
+
}
|
|
290
|
+
const running = (async () => {
|
|
291
|
+
do {
|
|
292
|
+
this.again = false;
|
|
293
|
+
if (this.stopped)
|
|
294
|
+
return;
|
|
295
|
+
// A pass logs its own failures. RelayWorkStopped ends the run.
|
|
296
|
+
await this.relayWork.run((work) => this.runPass(work)).catch(() => undefined);
|
|
297
|
+
} while (this.again);
|
|
298
|
+
})().finally(() => {
|
|
299
|
+
this.running = undefined;
|
|
300
|
+
});
|
|
301
|
+
this.running = running;
|
|
302
|
+
return running;
|
|
303
|
+
}
|
|
304
|
+
async runPass(work) {
|
|
305
|
+
const pass = this.pass(work);
|
|
306
|
+
const { storage, logger } = pass;
|
|
307
|
+
let ids;
|
|
308
|
+
try {
|
|
309
|
+
ids = await listRetryRequestIds(storage);
|
|
310
|
+
}
|
|
311
|
+
catch (error) {
|
|
312
|
+
rethrowRelayWorkStopped(error);
|
|
313
|
+
logger.warn('The retry request scheduler failed to list the stored requests', {
|
|
314
|
+
category: 'E2EE',
|
|
315
|
+
data: { behavior: 'RETRY_REQUEST_SCHEDULE_FAILED', error: error.message },
|
|
316
|
+
});
|
|
317
|
+
return;
|
|
318
|
+
}
|
|
319
|
+
let next = Infinity;
|
|
320
|
+
for (const failedEnvelopeId of ids) {
|
|
321
|
+
work.proceed();
|
|
322
|
+
try {
|
|
323
|
+
const at = await withProcessedEnvelopeLock(storage, failedEnvelopeId, () => this.passRecord(pass, failedEnvelopeId));
|
|
324
|
+
next = Math.min(next, at);
|
|
325
|
+
}
|
|
326
|
+
catch (error) {
|
|
327
|
+
rethrowRelayWorkStopped(error);
|
|
328
|
+
logger.warn('A stored retry request failed in the scheduler', {
|
|
329
|
+
category: 'E2EE',
|
|
330
|
+
data: {
|
|
331
|
+
failedEnvelopeId,
|
|
332
|
+
behavior: 'RETRY_REQUEST_SCHEDULE_FAILED',
|
|
333
|
+
error: error.message,
|
|
334
|
+
},
|
|
335
|
+
});
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
if (next !== Infinity)
|
|
339
|
+
this.schedule(next);
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* Handle one record. It returns the time of the next pass for the record.
|
|
343
|
+
* A delivery hook that throws is logged for the record, and the record
|
|
344
|
+
* keeps the time of its next attempt or deadline. The next pass runs the
|
|
345
|
+
* hook again.
|
|
346
|
+
*/
|
|
347
|
+
async passRecord(pass, failedEnvelopeId) {
|
|
348
|
+
const next = await this.attemptRecord(pass, failedEnvelopeId);
|
|
349
|
+
let errorAt = Infinity;
|
|
350
|
+
try {
|
|
351
|
+
errorAt = await reportDeliveryError(pass.storage, pass.hooks, failedEnvelopeId);
|
|
352
|
+
}
|
|
353
|
+
catch (error) {
|
|
354
|
+
hookFailed(pass, failedEnvelopeId, 'onDeliveryError', error);
|
|
355
|
+
}
|
|
356
|
+
try {
|
|
357
|
+
await reportDeliveryRecovered(pass.storage, pass.hooks, failedEnvelopeId);
|
|
358
|
+
}
|
|
359
|
+
catch (error) {
|
|
360
|
+
hookFailed(pass, failedEnvelopeId, 'onDeliveryRecovered', error);
|
|
361
|
+
}
|
|
362
|
+
return Math.min(next, errorAt);
|
|
363
|
+
}
|
|
364
|
+
/** Post or end the request of one record. It returns the time of its next attempt. */
|
|
365
|
+
async attemptRecord(pass, failedEnvelopeId) {
|
|
366
|
+
const { storage, send } = pass;
|
|
367
|
+
const record = await getRetryRequest(storage, failedEnvelopeId);
|
|
368
|
+
if (record?.terminal) {
|
|
369
|
+
await emitRetryTerminal(pass, failedEnvelopeId);
|
|
370
|
+
return Infinity;
|
|
371
|
+
}
|
|
372
|
+
if (!record || !send)
|
|
373
|
+
return Infinity;
|
|
374
|
+
const now = Date.now();
|
|
375
|
+
if ((await getProcessedEnvelope(storage, failedEnvelopeId, now))?.fulfilled)
|
|
376
|
+
return Infinity;
|
|
377
|
+
if (now >= record.deadlineAt) {
|
|
378
|
+
await updateRetryRequest(storage, failedEnvelopeId, record.retryId, record.attempt, {
|
|
379
|
+
terminal: { class: 'expired-content', at: now, emitted: false },
|
|
380
|
+
nextAttemptAt: undefined,
|
|
381
|
+
});
|
|
382
|
+
await emitRetryTerminal(pass, failedEnvelopeId);
|
|
383
|
+
return Infinity;
|
|
384
|
+
}
|
|
385
|
+
// An answered attempt waits for its resend, or for its deadline.
|
|
386
|
+
if (record.answered)
|
|
387
|
+
return record.deadlineAt;
|
|
388
|
+
// With no next attempt time, the Relay holds the stored attempt.
|
|
389
|
+
if (record.nextAttemptAt === undefined || record.nextAttemptAt > now) {
|
|
390
|
+
return Math.min(record.nextAttemptAt ?? Infinity, record.deadlineAt);
|
|
391
|
+
}
|
|
392
|
+
const outcome = await postStoredRetryRequest(storage, record, () => storedRequest(record), pass.local, send);
|
|
393
|
+
if (outcome === 'terminal') {
|
|
394
|
+
await emitRetryTerminal(pass, failedEnvelopeId);
|
|
395
|
+
return Infinity;
|
|
396
|
+
}
|
|
397
|
+
const after = await getRetryRequest(storage, failedEnvelopeId);
|
|
398
|
+
if (!after || after.terminal)
|
|
399
|
+
return Infinity;
|
|
400
|
+
if (after.answered)
|
|
401
|
+
return after.deadlineAt;
|
|
402
|
+
return Math.min(after.nextAttemptAt ?? Infinity, after.deadlineAt);
|
|
403
|
+
}
|
|
404
|
+
}
|
|
405
|
+
/**
|
|
406
|
+
* Log a delivery hook that failed in a scheduler pass. A stop still ends the
|
|
407
|
+
* pass.
|
|
408
|
+
*/
|
|
409
|
+
function hookFailed(pass, failedEnvelopeId, hook, error) {
|
|
410
|
+
rethrowRelayWorkStopped(error);
|
|
411
|
+
pass.logger.warn(`The ${hook} hook failed`, {
|
|
412
|
+
category: 'E2EE',
|
|
413
|
+
data: {
|
|
414
|
+
failedEnvelopeId,
|
|
415
|
+
behavior: hook === 'onDeliveryError'
|
|
416
|
+
? 'DELIVERY_ERROR_HOOK_FAILED'
|
|
417
|
+
: 'DELIVERY_RECOVERED_HOOK_FAILED',
|
|
418
|
+
error: error.message,
|
|
419
|
+
},
|
|
420
|
+
});
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* The request of a new attempt for a stored record, from its stored
|
|
424
|
+
* envelope, with the time of now. The scheduler has no failed envelope, so
|
|
425
|
+
* it asks for the same message again.
|
|
426
|
+
*/
|
|
427
|
+
async function storedRequest(record) {
|
|
428
|
+
const envelope = record.envelope;
|
|
429
|
+
const read = readRetryRequestEnvelope(envelope, {
|
|
430
|
+
userId: envelope.targetUserId,
|
|
431
|
+
deviceId: envelope.targetDeviceId,
|
|
432
|
+
});
|
|
433
|
+
if (!read.ok)
|
|
434
|
+
throw new Error(`The stored retry request does not decode: ${read.cause}`);
|
|
435
|
+
return { ...read.request, timestamp: Date.now() };
|
|
436
|
+
}
|
|
437
|
+
//# sourceMappingURL=retry-request-lifecycle.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"retry-request-lifecycle.js","sourceRoot":"","sources":["../../client/retry-request-lifecycle.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAMH,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,GAE1B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhF,OAAO,EACL,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,wBAAwB,GAIzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,uBAAuB,EAAyC,MAAM,cAAc,CAAC;AAC9F,OAAO,EACL,yBAAyB,GAG1B,MAAM,2BAA2B,CAAC;AAiBnC;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAA4B,EAAE,MAAe;IACpF,IAAI,OAAO,KAAK,UAAU,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAClE,OAAO,CAAC,MAAM,IAAI,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,UAAU,CAAC;AACnE,CAAC;AAsDD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAkC,EAClC,gBAAwB;IAExB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACnC,MAAM,MAAM,GAAG,MAAM,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAC1E,MAAM,QAAQ,GAAG,MAAM,EAAE,QAAQ,CAAC;IAClC,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,OAAO;QAAE,OAAO;IACrD,MAAM,IAAI,GAAG,KAAK,EAAE,eAAe,CAAC;IACpC,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,MAAM,IAAI,CAAC;YACT,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,gBAAgB;YAChB,GAAG,CAAC,QAAQ,EAAE,WAAW,IAAI;gBAC3B,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ,CAAC,MAAM;oBACvB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;oBAC3B,SAAS,EAAE,QAAQ,CAAC,SAAS;oBAC7B,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC,OAAO;iBAC1C;aACF,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IACD,MAAM,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;QAClF,QAAQ,EAAE,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;KACzC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAA0B,EAC1B,WAA+B,EAC/B,MAA0B;IAE1B,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC1C,MAAM,OAAO,GAAG,GAAS,EAAE;QACzB,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE;YAClD,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE;SACnE,CAAC,CAAC;IACL,CAAC,CAAC;IACF,MAAM,MAAM,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC;IAChF,MAAM,OAAO,GAAG,KAAK,EAAE,MAA2B,EAAgC,EAAE;QAClF,MAAM,gBAAgB,GAAG,MAAM,CAAC,EAAE,CAAC;QACnC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;gBACpB,OAAO,EAAE,CAAC;gBACV,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;gBAClD,OAAO,OAAO,CAAC;YACjB,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;gBACpB,OAAO,EAAE,CAAC;gBACV,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACvB,MAAM,GAAG,GAAG,MAAM,CAAC,cAAc,CAAC;gBAClC,MAAM,iBAAiB,CAAC,OAAO,EAAE;oBAC/B,gBAAgB;oBAChB,OAAO,EAAE,MAAM,cAAc,EAAE;oBAC/B,OAAO,EAAE,CAAC;oBACV,WAAW,EAAE,GAAG;oBAChB,GAAG,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC;oBAC5E,QAAQ,EAAE,KAAK;oBACf,GAAG,CAAC,GAAG,EAAE,YAAY,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;oBAChD,GAAG,CAAC,GAAG,EAAE,eAAe,KAAK,SAAS,IAAI;wBACxC,qBAAqB,EAAE,GAAG,CAAC,eAAe;qBAC3C,CAAC;oBACF,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC9E,UAAU,EAAE,GAAG;oBACf,GAAG,CAAC,GAAG,EAAE,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC;oBACvE,YAAY,EAAE,MAAM;oBACpB,UAAU,EAAE,GAAG,GAAG,yBAAyB;oBAC3C,QAAQ,EAAE,EAAE,KAAK,EAAE,2BAA2B,EAAE,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE;iBAC1E,CAAC,CAAC;gBACH,MAAM,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;gBAClD,OAAO,UAAU,CAAC;YACpB,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,EAAE,QAAQ,EAAE,CAAC;YAC5B,MAAM,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;YAClD,OAAO,UAAU,CAAC;QACpB,CAAC;aAAM,IAAI,MAAM,IAAI,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;YACtD,wEAAwE;QAC1E,CAAC;aAAM,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,IAAI,MAAM,EAAE,gBAAgB,KAAK,cAAc,IAAI,CAAC,MAAM,CAAC,aAAa,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC;gBACrF,OAAO,UAAU,CAAC;YACpB,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;gBACpB,OAAO,EAAE,CAAC;gBACV,IAAI,MAAM,EAAE,CAAC;oBACX,MAAM,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;wBAClF,aAAa,EAAE,GAAG,GAAG,MAAM,CAAC,QAAQ;wBACpC,gBAAgB,EAAE,cAAc;qBACjC,CAAC,CAAC;gBACL,CAAC;gBACD,OAAO,UAAU,CAAC;YACpB,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,iDAAiD,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;YACrF,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5E,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAChF,MAAM,SAAS,GACb,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAC;QACxF,MAAM,OAAO,GAAG,MAAM,gBAAgB,CACpC,OAAO,EACP;YACE,GAAG,MAAM;YACT,GAAG,CAAC,GAAG,EAAE,YAAY,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;YAChD,GAAG,CAAC,GAAG,EAAE,eAAe,KAAK,SAAS,IAAI,EAAE,eAAe,EAAE,GAAG,CAAC,eAAe,EAAE,CAAC;YACnF,GAAG,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,CAAC;YACzC,GAAG,CAAC,GAAG,EAAE,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC;YACvE,MAAM;SACP,EACD,GAAG,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,EACrC,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,IAAI,CACZ,CAAC;QACF,IAAI,gBAAgB,KAAK,SAAS;YAAE,OAAO,OAAO,CAAC;QACnD,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;YAC3B,MAAM,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACpD,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAChE,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ;gBAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,aAAa,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC;QAC/F,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IACF,OAAO,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACvD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;YACrE,IAAI,OAAO,KAAK,QAAQ;gBAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,MAA0B;IAC/C,OAAO,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,cAAc,EAAE,OAAO,CAAC;AAC1D,CAAC;AAED,4CAA4C;AAC5C,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAiBvC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,qBAAqB;IAQb,SAAS;IACT,IAAI;IARf,KAAK,CAA4C;IACjD,OAAO,GAAG,QAAQ,CAAC;IACnB,OAAO,CAA4B;IACnC,KAAK,GAAG,KAAK,CAAC;IACd,OAAO,GAAG,IAAI,CAAC;IAEvB,YACmB,SAA2B,EAC3B,IAA2C;yBAD3C,SAAS;oBACT,IAAI;IACpB,CAAC;IAEJ,6EAA6E;IAC7E,KAAK;QACH,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;IACpB,CAAC;IAED,8DAA8D;IAC9D,IAAI;QACF,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,+EAA+E;IAC/E,QAAQ,CAAC,EAAU;QACjB,IAAI,IAAI,CAAC,OAAO,IAAI,EAAE,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QAC/C,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACzE,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK;gBAAE,OAAO;YACjC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACvB,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;YACxB,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;QAClB,CAAC,EAAE,KAAK,CAAC,CAAC;QACT,KAAgC,CAAC,KAAK,EAAE,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEO,KAAK;QACX,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS;YAAE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;IAC1B,CAAC;IAED,oEAAoE;IAC5D,GAAG;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;QACD,MAAM,OAAO,GAAG,CAAC,KAAK,IAAI,EAAE;YAC1B,GAAG,CAAC;gBACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;gBACnB,IAAI,IAAI,CAAC,OAAO;oBAAE,OAAO;gBACzB,+DAA+D;gBAC/D,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAChF,CAAC,QAAQ,IAAI,CAAC,KAAK,EAAE;QACvB,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;YAChB,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,IAAe;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACjC,IAAI,GAAa,CAAC;QAClB,IAAI,CAAC;YACH,GAAG,GAAG,MAAM,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,uBAAuB,CAAC,KAAK,CAAC,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,gEAAgE,EAAE;gBAC5E,QAAQ,EAAE,MAAM;gBAChB,IAAI,EAAE,EAAE,QAAQ,EAAE,+BAA+B,EAAE,KAAK,EAAG,KAAe,CAAC,OAAO,EAAE;aACrF,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QACD,IAAI,IAAI,GAAG,QAAQ,CAAC;QACpB,KAAK,MAAM,gBAAgB,IAAI,GAAG,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,CAAC;gBACH,MAAM,EAAE,GAAG,MAAM,yBAAyB,CAAC,OAAO,EAAE,gBAAgB,EAAE,GAAG,EAAE,CACzE,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,gBAAgB,CAAC,CACxC,CAAC;gBACF,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC5B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,uBAAuB,CAAC,KAAK,CAAC,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,gDAAgD,EAAE;oBAC5D,QAAQ,EAAE,MAAM;oBAChB,IAAI,EAAE;wBACJ,gBAAgB;wBAChB,QAAQ,EAAE,+BAA+B;wBACzC,KAAK,EAAG,KAAe,CAAC,OAAO;qBAChC;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,IAAI,IAAI,KAAK,QAAQ;YAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,UAAU,CAAC,IAAsB,EAAE,gBAAwB;QACvE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QAC9D,IAAI,OAAO,GAAG,QAAQ,CAAC;QACvB,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;QAClF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,UAAU,CAAC,IAAI,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC;YACH,MAAM,uBAAuB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;QAC5E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,UAAU,CAAC,IAAI,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,KAAK,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAED,sFAAsF;IAC9E,KAAK,CAAC,aAAa,CAAC,IAAsB,EAAE,gBAAwB;QAC1E,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAC/B,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,QAAQ,EAAE,CAAC;YACrB,MAAM,iBAAiB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;YAChD,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI;YAAE,OAAO,QAAQ,CAAC;QACtC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,MAAM,oBAAoB,CAAC,OAAO,EAAE,gBAAgB,EAAE,GAAG,CAAC,CAAC,EAAE,SAAS;YAAE,OAAO,QAAQ,CAAC;QAC7F,IAAI,GAAG,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YAC7B,MAAM,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;gBAClF,QAAQ,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE;gBAC/D,aAAa,EAAE,SAAS;aACzB,CAAC,CAAC;YACH,MAAM,iBAAiB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;YAChD,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,iEAAiE;QACjE,IAAI,MAAM,CAAC,QAAQ;YAAE,OAAO,MAAM,CAAC,UAAU,CAAC;QAC9C,iEAAiE;QACjE,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,IAAI,MAAM,CAAC,aAAa,GAAG,GAAG,EAAE,CAAC;YACrE,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QACvE,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,sBAAsB,CAC1C,OAAO,EACP,MAAM,EACN,GAAG,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,EAC3B,IAAI,CAAC,KAAK,EACV,IAAI,CACL,CAAC;QACF,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;YAC3B,MAAM,iBAAiB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;YAChD,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAC/D,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ;YAAE,OAAO,QAAQ,CAAC;QAC9C,IAAI,KAAK,CAAC,QAAQ;YAAE,OAAO,KAAK,CAAC,UAAU,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,aAAa,IAAI,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IACrE,CAAC;CACF;AAED;;;GAGG;AACH,SAAS,UAAU,CACjB,IAAsB,EACtB,gBAAwB,EACxB,IAA+C,EAC/C,KAAc;IAEd,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,cAAc,EAAE;QAC1C,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE;YACJ,gBAAgB;YAChB,QAAQ,EACN,IAAI,KAAK,iBAAiB;gBACxB,CAAC,CAAC,4BAA4B;gBAC9B,CAAC,CAAC,gCAAgC;YACtC,KAAK,EAAG,KAAe,CAAC,OAAO;SAChC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,aAAa,CAAC,MAA0B;IACrD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAS,CAAC;IAClC,MAAM,IAAI,GAAG,wBAAwB,CAAC,QAAQ,EAAE;QAC9C,MAAM,EAAE,QAAQ,CAAC,YAAY;QAC7B,QAAQ,EAAE,QAAQ,CAAC,cAAc;KAClC,CAAC,CAAC;IACH,IAAI,CAAC,IAAI,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,6CAA6C,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IACzF,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;AACpD,CAAC"}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The session reset of the requester after a retry request ends as
|
|
3
|
+
* `expired-content`.
|
|
4
|
+
*
|
|
5
|
+
* The request got no answer before its deadline, so the session with the
|
|
6
|
+
* device that sent the failed envelope can be out of step. The requester
|
|
7
|
+
* archives that session, deletes its sender-key handoff rows for each device
|
|
8
|
+
* of that account in every group, and sends one null message to the
|
|
9
|
+
* device, at most once an hour for each device. The null message, or else
|
|
10
|
+
* the next ordinary message, starts a new session with the device. The
|
|
11
|
+
* other terminal classes and a retryable post failure reset nothing.
|
|
12
|
+
*
|
|
13
|
+
* Each step is stored on the request record when it ends, so a replay of
|
|
14
|
+
* the terminal state after a restart or a client stop does not archive a
|
|
15
|
+
* newer session.
|
|
16
|
+
*/
|
|
17
|
+
import type { Logger } from '../logger.js';
|
|
18
|
+
import { getRetryRequest, type StoredRetryRequest } from '../local/store/reliability.js';
|
|
19
|
+
import { type SignalProtocolClientHooks } from './event-hooks.js';
|
|
20
|
+
type RetryRecordStore = Parameters<typeof getRetryRequest>[0];
|
|
21
|
+
/** The device that sent a failed envelope. */
|
|
22
|
+
export interface RetryTerminalDevice {
|
|
23
|
+
readonly userId: string;
|
|
24
|
+
readonly deviceId: number;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* The session reset steps. The client gives them, bound to the relay work
|
|
28
|
+
* that runs the reset.
|
|
29
|
+
*/
|
|
30
|
+
export interface RetryTerminalResetSteps {
|
|
31
|
+
/**
|
|
32
|
+
* Wait for each decrypt from the device that is in progress, and then
|
|
33
|
+
* archive the session with the device in the protocol store and in its
|
|
34
|
+
* device record. The next send to the user reads its device list again.
|
|
35
|
+
*/
|
|
36
|
+
archiveSession(device: RetryTerminalDevice): Promise<void>;
|
|
37
|
+
/**
|
|
38
|
+
* Delete the sender-key handoff rows of every device of the account in
|
|
39
|
+
* every group, with no rotation, so the next send of each group gives the
|
|
40
|
+
* current key to each of those devices. With the raw group ID of the
|
|
41
|
+
* failed envelope, the delete runs in the sender-key turn of that group.
|
|
42
|
+
* True when the requester has a sender key for that group, false when it
|
|
43
|
+
* has none or no group is given. A client stop does not stop it, so a
|
|
44
|
+
* stop does not split the archive from the invalidation.
|
|
45
|
+
*/
|
|
46
|
+
invalidateAccountSenderKeyHandoffs(userId: string, groupId: string | undefined): Promise<boolean>;
|
|
47
|
+
/**
|
|
48
|
+
* Start a session with the device when there is none, and post one null
|
|
49
|
+
* message to it with the implicit content hint.
|
|
50
|
+
*/
|
|
51
|
+
sendNullMessage(device: RetryTerminalDevice): Promise<void>;
|
|
52
|
+
}
|
|
53
|
+
/** What the reset of one terminal state uses. */
|
|
54
|
+
export interface RetryTerminalResetContext {
|
|
55
|
+
readonly storage: RetryRecordStore;
|
|
56
|
+
readonly logger: Required<Logger>;
|
|
57
|
+
readonly hooks: SignalProtocolClientHooks | undefined;
|
|
58
|
+
/** Without them, the terminal state resets nothing. */
|
|
59
|
+
readonly reset: RetryTerminalResetSteps | undefined;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Reset the session with the sender device of an `expired-content` request
|
|
63
|
+
* whose terminal state is not emitted. Another class, an emitted state, and
|
|
64
|
+
* a context with no reset steps do nothing.
|
|
65
|
+
*
|
|
66
|
+
* The steps run in this order. A step that a stored marker shows as done
|
|
67
|
+
* does not run again.
|
|
68
|
+
*
|
|
69
|
+
* 1. The session with the device is archived, after its decrypts that are
|
|
70
|
+
* in progress end.
|
|
71
|
+
* 2. The handoff rows of each device of the account in every group are
|
|
72
|
+
* deleted, after the archive, as one Signal client does at an automatic
|
|
73
|
+
* session reset. The step runs for a group message and for a
|
|
74
|
+
* pairwise message. The next send of each group gives its current key to
|
|
75
|
+
* each device of the account, and to the device through the new session.
|
|
76
|
+
* 3. The record stores the archived device and the sender key outcome,
|
|
77
|
+
* and the `onSessionArchived` hook runs.
|
|
78
|
+
* 4. Under one lock for each device, a null message goes to the device
|
|
79
|
+
* when no other request sent one to it in the last hour. The record
|
|
80
|
+
* stores the outcome.
|
|
81
|
+
*
|
|
82
|
+
* A RelayWorkStopped while the archive waits for the decrypt lock
|
|
83
|
+
* propagates, and the replay runs the reset again. A failure of steps 1 to
|
|
84
|
+
* 3 also propagates. A crash between the archive and its stored marker
|
|
85
|
+
* archives again at the replay. A failed null message is stored as
|
|
86
|
+
* `failed`.
|
|
87
|
+
*
|
|
88
|
+
* @returns The stored record after the reset.
|
|
89
|
+
*/
|
|
90
|
+
export declare function resetRetryTerminalSession(context: RetryTerminalResetContext, failedEnvelopeId: string): Promise<StoredRetryRequest | null>;
|
|
91
|
+
/**
|
|
92
|
+
* Attach the raw group ID of a group message to an error that its decrypt
|
|
93
|
+
* threw. The retry request record of the failed envelope then keeps the
|
|
94
|
+
* group, so an `expired-content` end marks the sender key of that group.
|
|
95
|
+
*/
|
|
96
|
+
export declare function attachFailedGroup(error: unknown, groupId: string): void;
|
|
97
|
+
/** The raw group ID that `attachFailedGroup` attached to an error. */
|
|
98
|
+
export declare function failedGroupOf(error: unknown): string | undefined;
|
|
99
|
+
export {};
|
|
100
|
+
//# sourceMappingURL=retry-terminal-recovery.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"retry-terminal-recovery.d.ts","sourceRoot":"","sources":["../../client/retry-terminal-recovery.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EACL,eAAe,EAMf,KAAK,kBAAkB,EACxB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAY,KAAK,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAGzE,KAAK,gBAAgB,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;AAE9D,8CAA8C;AAC9C,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,cAAc,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D;;;;;;;;OAQG;IACH,kCAAkC,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAClG;;;OAGG;IACH,eAAe,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D;AAED,iDAAiD;AACjD,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACnC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,yBAAyB,GAAG,SAAS,CAAC;IACtD,uDAAuD;IACvD,QAAQ,CAAC,KAAK,EAAE,uBAAuB,GAAG,SAAS,CAAC;CACrD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,yBAAyB,CAC7C,OAAO,EAAE,yBAAyB,EAClC,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAkDpC;AAkED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAEvE;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAEhE"}
|