@open-e2ee/signal-protocol-sdk 2.0.2 → 4.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 +14 -21
- package/ARCHITECTURE.md +1 -2
- package/CHANGELOG.md +90 -0
- package/LICENSE +11 -655
- package/LICENSE-APACHE +201 -0
- package/LICENSE-MIT +21 -0
- package/NOTICE +5 -7
- package/README.md +11 -11
- package/SECURITY.md +2 -2
- package/TROUBLESHOOTING.md +6 -10
- package/client/README.md +36 -18
- package/device/README.md +1 -1
- package/dist/blocking/manager.d.ts +2 -2
- package/dist/blocking/manager.d.ts.map +1 -1
- package/dist/blocking/manager.js.map +1 -1
- package/dist/client/client.d.ts +45 -34
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +178 -115
- package/dist/client/client.js.map +1 -1
- package/dist/client/compose.d.ts +7 -7
- package/dist/client/compose.d.ts.map +1 -1
- package/dist/client/compose.js +2 -2
- package/dist/client/compose.js.map +1 -1
- package/dist/client/config.d.ts +24 -28
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/content-adapter.d.ts +2 -0
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +4 -0
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/dual-store.d.ts +5 -5
- package/dist/client/dual-store.d.ts.map +1 -1
- package/dist/client/dual-store.js.map +1 -1
- package/dist/client/endorsement-manager.d.ts +6 -3
- package/dist/client/endorsement-manager.d.ts.map +1 -1
- package/dist/client/endorsement-manager.js +14 -6
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/files.d.ts +1 -1
- package/dist/client/files.js +1 -1
- package/dist/client/group-authority.d.ts +8 -0
- package/dist/client/group-authority.d.ts.map +1 -0
- package/dist/client/group-authority.js +2 -0
- package/dist/client/group-authority.js.map +1 -0
- package/dist/client/group-outbox.d.ts +4 -4
- package/dist/client/group-outbox.d.ts.map +1 -1
- package/dist/client/group-sealed-sender.d.ts +2 -2
- package/dist/client/group-sealed-sender.d.ts.map +1 -1
- package/dist/client/groups.d.ts +1 -1
- package/dist/client/groups.js +1 -1
- package/dist/client/headless.d.ts +11 -16
- package/dist/client/headless.d.ts.map +1 -1
- package/dist/client/headless.js +4 -9
- package/dist/client/headless.js.map +1 -1
- package/dist/client/hosted-anonymous-delivery.d.ts +32 -0
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -0
- package/dist/client/hosted-anonymous-delivery.js +239 -0
- package/dist/client/hosted-anonymous-delivery.js.map +1 -0
- package/dist/client/hosted-connection.d.ts +1 -1
- package/dist/client/hosted-connection.d.ts.map +1 -1
- package/dist/client/hosted-connection.js +18 -51
- package/dist/client/hosted-connection.js.map +1 -1
- package/dist/client/hosted-group-authority.d.ts +11 -0
- package/dist/client/hosted-group-authority.d.ts.map +1 -0
- package/dist/client/hosted-group-authority.js +96 -0
- package/dist/client/hosted-group-authority.js.map +1 -0
- package/dist/client/hosted-groups.d.ts +31 -0
- package/dist/client/hosted-groups.d.ts.map +1 -0
- package/dist/client/hosted-groups.js +217 -0
- package/dist/client/hosted-groups.js.map +1 -0
- package/dist/client/hosted-mailbox-subscription.d.ts +34 -0
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -0
- package/dist/client/hosted-mailbox-subscription.js +257 -0
- package/dist/client/hosted-mailbox-subscription.js.map +1 -0
- package/dist/client/hosted-prekey-publication.d.ts +51 -0
- package/dist/client/hosted-prekey-publication.d.ts.map +1 -0
- package/dist/client/hosted-prekey-publication.js +249 -0
- package/dist/client/hosted-prekey-publication.js.map +1 -0
- package/dist/client/hosted-push.d.ts +5 -6
- package/dist/client/hosted-push.d.ts.map +1 -1
- package/dist/client/hosted-push.js +22 -22
- package/dist/client/hosted-push.js.map +1 -1
- package/dist/client/hosted-transport.d.ts +62 -40
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +666 -341
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted-trust.d.ts +29 -0
- package/dist/client/hosted-trust.d.ts.map +1 -0
- package/dist/client/hosted-trust.js +28 -0
- package/dist/client/hosted-trust.js.map +1 -0
- package/dist/client/hosted.d.ts +26 -21
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +80 -36
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +15 -15
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +7 -7
- package/dist/client/index.js.map +1 -1
- package/dist/client/key-rotation-core.d.ts +16 -8
- package/dist/client/key-rotation-core.d.ts.map +1 -1
- package/dist/client/key-rotation-core.js +14 -3
- package/dist/client/key-rotation-core.js.map +1 -1
- package/dist/client/key-rotation.d.ts +3 -2
- package/dist/client/key-rotation.d.ts.map +1 -1
- package/dist/client/key-rotation.js +5 -5
- package/dist/client/key-rotation.js.map +1 -1
- package/dist/client/media-queue-persistence.d.ts +14 -0
- package/dist/client/media-queue-persistence.d.ts.map +1 -0
- package/dist/client/media-queue-persistence.js +123 -0
- package/dist/client/media-queue-persistence.js.map +1 -0
- package/dist/client/media-upload-budget.d.ts +3 -0
- package/dist/client/media-upload-budget.d.ts.map +1 -0
- package/dist/client/media-upload-budget.js +27 -0
- package/dist/client/media-upload-budget.js.map +1 -0
- package/dist/client/media.d.ts +51 -15
- package/dist/client/media.d.ts.map +1 -1
- package/dist/client/media.js +541 -73
- package/dist/client/media.js.map +1 -1
- package/dist/client/messages.d.ts +1 -1
- package/dist/client/messages.d.ts.map +1 -1
- package/dist/client/messages.js +14 -15
- package/dist/client/messages.js.map +1 -1
- package/dist/client/multi-device.d.ts +1 -1
- package/dist/client/multi-device.js +1 -1
- package/dist/client/prekeys.d.ts +1 -1
- package/dist/client/prekeys.d.ts.map +1 -1
- package/dist/client/prekeys.js +132 -44
- package/dist/client/prekeys.js.map +1 -1
- package/dist/client/relay-subscription.d.ts +5 -1
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +59 -26
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/retry.d.ts +3 -3
- package/dist/client/retry.d.ts.map +1 -1
- package/dist/client/retry.js +1 -1
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender.d.ts +5 -5
- package/dist/client/sealed-sender.d.ts.map +1 -1
- package/dist/client/sealed-sender.js.map +1 -1
- package/dist/client/sender-key-distribution.d.ts +8 -0
- package/dist/client/sender-key-distribution.d.ts.map +1 -0
- package/dist/client/sender-key-distribution.js +59 -0
- package/dist/client/sender-key-distribution.js.map +1 -0
- package/dist/client/sessions.d.ts +3 -3
- package/dist/client/sessions.d.ts.map +1 -1
- package/dist/client/sessions.js +1 -1
- package/dist/client/sessions.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +12 -8
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +41 -16
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/state.d.ts +1 -1
- package/dist/client/state.js +1 -1
- package/dist/client/types.d.ts +10 -10
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js +1 -1
- package/dist/device/connection.d.ts.map +1 -1
- package/dist/device/connection.js.map +1 -1
- package/dist/device/device-id.d.ts +2 -2
- package/dist/device/device-id.d.ts.map +1 -1
- package/dist/device/device-id.js.map +1 -1
- package/dist/device/{expo-metadata.d.ts → expo/index.d.ts} +3 -3
- package/dist/device/expo/index.d.ts.map +1 -0
- package/dist/device/{expo-metadata.js → expo/index.js} +2 -2
- package/dist/device/expo/index.js.map +1 -0
- package/dist/device/index.d.ts +1 -1
- package/dist/device/index.d.ts.map +1 -1
- package/dist/device/index.js +1 -1
- package/dist/device/index.js.map +1 -1
- package/dist/device/lifecycle/index.d.ts +1 -1
- package/dist/device/lifecycle/index.d.ts.map +1 -1
- package/dist/device/lifecycle/types.d.ts +8 -8
- package/dist/device/lifecycle/types.d.ts.map +1 -1
- package/dist/device/provisioning.d.ts +13 -13
- package/dist/device/provisioning.d.ts.map +1 -1
- package/dist/device/provisioning.js +1 -1
- package/dist/device/provisioning.js.map +1 -1
- package/dist/device/transfer.d.ts +13 -13
- package/dist/device/transfer.d.ts.map +1 -1
- package/dist/device/transfer.js.map +1 -1
- package/dist/device/types.d.ts +3 -3
- package/dist/device/types.d.ts.map +1 -1
- package/dist/groups/index.d.ts +1 -1
- package/dist/groups/index.d.ts.map +1 -1
- package/dist/groups/server.d.ts +10 -0
- package/dist/groups/server.d.ts.map +1 -0
- package/dist/groups/server.js +6 -0
- package/dist/groups/server.js.map +1 -0
- package/dist/hooks/use-connection-presence.d.ts +6 -8
- package/dist/hooks/use-connection-presence.d.ts.map +1 -1
- package/dist/hooks/use-connection-presence.js +2 -4
- package/dist/hooks/use-connection-presence.js.map +1 -1
- package/dist/hooks/use-group-membership.d.ts +2 -2
- package/dist/hooks/use-group-membership.d.ts.map +1 -1
- package/dist/hooks/use-group-membership.js.map +1 -1
- package/dist/hooks/use-key-rotation.d.ts +2 -2
- package/dist/hooks/use-key-rotation.d.ts.map +1 -1
- package/dist/hooks/use-session-health.d.ts +2 -2
- package/dist/hooks/use-session-health.d.ts.map +1 -1
- package/dist/index.d.ts +57 -55
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +27 -26
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts +4 -4
- package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
- package/dist/internal/groups/authority-certificate.d.ts +22 -0
- package/dist/internal/groups/authority-certificate.d.ts.map +1 -0
- package/dist/internal/groups/authority-certificate.js +99 -0
- package/dist/internal/groups/authority-certificate.js.map +1 -0
- package/dist/internal/groups/error-details.d.ts +9 -0
- package/dist/internal/groups/error-details.d.ts.map +1 -0
- package/dist/internal/groups/error-details.js +30 -0
- package/dist/internal/groups/error-details.js.map +1 -0
- package/dist/internal/groups/index.d.ts +1 -1
- package/dist/internal/groups/index.d.ts.map +1 -1
- package/dist/internal/groups/manager.d.ts +9 -4
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +3 -0
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/sdk-store.d.ts +4 -4
- package/dist/internal/groups/sdk-store.d.ts.map +1 -1
- package/dist/internal/groups/sdk-store.js.map +1 -1
- package/dist/internal/groups/server-engine.d.ts +9 -2
- package/dist/internal/groups/server-engine.d.ts.map +1 -1
- package/dist/internal/groups/server-engine.js +51 -19
- package/dist/internal/groups/server-engine.js.map +1 -1
- package/dist/internal/groups/wire.d.ts.map +1 -1
- package/dist/internal/groups/wire.js +10 -9
- package/dist/internal/groups/wire.js.map +1 -1
- package/dist/internal/manager/index.d.ts +2 -2
- package/dist/internal/manager/index.d.ts.map +1 -1
- package/dist/internal/manager/index.js +1 -1
- package/dist/internal/manager/index.js.map +1 -1
- package/dist/internal/manager/manager.d.ts +23 -23
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +40 -43
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts +9 -9
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +2 -2
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts +3 -3
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +4 -4
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +27 -14
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/authenticator.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/authenticator.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/index.d.ts +2 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/index.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/index.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/index.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +2 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +5 -5
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +4 -4
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts +3 -3
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
- package/dist/internal/sesame/device-registry.d.ts +16 -16
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +6 -6
- package/dist/internal/sesame/device-registry.js.map +1 -1
- package/dist/internal/sesame/index.d.ts +4 -4
- package/dist/internal/sesame/index.d.ts.map +1 -1
- package/dist/internal/sesame/index.js +2 -2
- package/dist/internal/sesame/index.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +10 -10
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +13 -13
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/sesame/types.d.ts +5 -5
- package/dist/internal/sesame/types.d.ts.map +1 -1
- package/dist/internal/session/cipher.d.ts +4 -4
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +31 -28
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/decryption.js.map +1 -1
- package/dist/internal/session/factory.d.ts +3 -3
- package/dist/internal/session/factory.d.ts.map +1 -1
- package/dist/internal/session/factory.js.map +1 -1
- package/dist/internal/session/handshake.d.ts +2 -2
- package/dist/internal/session/handshake.d.ts.map +1 -1
- package/dist/internal/session/handshake.js.map +1 -1
- package/dist/internal/session/ratchet.d.ts +4 -4
- package/dist/internal/session/ratchet.d.ts.map +1 -1
- package/dist/internal/session/ratchet.js.map +1 -1
- package/dist/internal/session/types.d.ts +5 -5
- package/dist/internal/session/types.d.ts.map +1 -1
- package/dist/internal/session/validation.d.ts +3 -3
- package/dist/internal/session/validation.d.ts.map +1 -1
- package/dist/internal/session/validation.js.map +1 -1
- package/dist/layers.d.ts +4 -4
- package/dist/layers.d.ts.map +1 -1
- package/dist/layers.js +12 -12
- package/dist/layers.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts +15 -9
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +29 -10
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/database-key.d.ts +5 -5
- package/dist/local/store/expo/database-key.d.ts.map +1 -1
- package/dist/local/store/expo/database-key.js.map +1 -1
- package/dist/local/store/expo/index.d.ts +3 -3
- package/dist/local/store/expo/index.d.ts.map +1 -1
- package/dist/local/store/expo/key-storage.d.ts +11 -5
- package/dist/local/store/expo/key-storage.d.ts.map +1 -1
- package/dist/local/store/expo/key-storage.js +82 -17
- package/dist/local/store/expo/key-storage.js.map +1 -1
- package/dist/local/store/expo/models/kyber-prekey-used.d.ts +1 -4
- package/dist/local/store/expo/models/kyber-prekey-used.d.ts.map +1 -1
- package/dist/local/store/expo/models/kyber-prekey-used.js +23 -9
- package/dist/local/store/expo/models/kyber-prekey-used.js.map +1 -1
- package/dist/local/store/expo/models/kyber-prekey.d.ts +4 -4
- package/dist/local/store/expo/models/kyber-prekey.d.ts.map +1 -1
- package/dist/local/store/expo/models/kyber-prekey.js +67 -26
- package/dist/local/store/expo/models/kyber-prekey.js.map +1 -1
- package/dist/local/store/expo/schema.d.ts +21 -2
- package/dist/local/store/expo/schema.d.ts.map +1 -1
- package/dist/local/store/expo/schema.js +10 -2
- package/dist/local/store/expo/schema.js.map +1 -1
- package/dist/local/store/index.d.ts +3 -3
- package/dist/local/store/index.d.ts.map +1 -1
- package/dist/local/store/index.js +1 -1
- package/dist/local/store/kyber-prekey-lifecycle.d.ts +46 -0
- package/dist/local/store/kyber-prekey-lifecycle.d.ts.map +1 -0
- package/dist/local/store/kyber-prekey-lifecycle.js +88 -0
- package/dist/local/store/kyber-prekey-lifecycle.js.map +1 -0
- package/dist/local/store/memory/adapter.d.ts +14 -6
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +114 -29
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/node/adapter.d.ts +9 -3
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +31 -13
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/database-file-commit.d.ts +8 -0
- package/dist/local/store/node/database-file-commit.d.ts.map +1 -0
- package/dist/local/store/node/database-file-commit.js +62 -0
- package/dist/local/store/node/database-file-commit.js.map +1 -0
- package/dist/local/store/node/database-key.d.ts +6 -1
- package/dist/local/store/node/database-key.d.ts.map +1 -1
- package/dist/local/store/node/database-key.js +79 -44
- package/dist/local/store/node/database-key.js.map +1 -1
- package/dist/local/store/node/database-lock.d.ts +8 -0
- package/dist/local/store/node/database-lock.d.ts.map +1 -0
- package/dist/local/store/node/database-lock.js +44 -0
- package/dist/local/store/node/database-lock.js.map +1 -0
- package/dist/local/store/node/database.d.ts +17 -16
- package/dist/local/store/node/database.d.ts.map +1 -1
- package/dist/local/store/node/database.js +197 -202
- package/dist/local/store/node/database.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts +10 -4
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +151 -66
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/received-content.d.ts +9 -0
- package/dist/local/store/received-content.d.ts.map +1 -0
- package/dist/local/store/received-content.js +46 -0
- package/dist/local/store/received-content.js.map +1 -0
- package/dist/local/store/reliability.d.ts +4 -4
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +7 -4
- package/dist/local/store/reliability.js.map +1 -1
- package/dist/local/store/web/adapter.d.ts +11 -5
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +207 -74
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/vault/expo-secure-store.d.ts +2 -2
- package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
- package/dist/local/vault/index.d.ts +1 -1
- package/dist/local/vault/index.d.ts.map +1 -1
- package/dist/logger.d.ts +4 -4
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js.map +1 -1
- package/dist/media/index.d.ts +71 -61
- package/dist/media/index.d.ts.map +1 -1
- package/dist/media/index.js +550 -386
- package/dist/media/index.js.map +1 -1
- package/dist/media/prepared-upload.d.ts +37 -0
- package/dist/media/prepared-upload.d.ts.map +1 -0
- package/dist/media/prepared-upload.js +46 -0
- package/dist/media/prepared-upload.js.map +1 -0
- package/dist/profile/contact-state.d.ts +2 -2
- package/dist/profile/contact-state.d.ts.map +1 -1
- package/dist/profile/contact-state.js.map +1 -1
- package/dist/profile/profile-key.d.ts +2 -2
- package/dist/profile/profile-key.d.ts.map +1 -1
- package/dist/profile/profile-key.js.map +1 -1
- package/dist/profile/update-service.d.ts +2 -2
- package/dist/profile/update-service.d.ts.map +1 -1
- package/dist/profile/update-service.js.map +1 -1
- package/dist/remote/object-store/convex-r2/server.d.ts +2 -1
- package/dist/remote/object-store/convex-r2/server.d.ts.map +1 -1
- package/dist/remote/object-store/convex-r2/server.js +4 -0
- package/dist/remote/object-store/convex-r2/server.js.map +1 -1
- package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
- package/dist/remote/object-store/convex-r2/storage.js +1 -0
- package/dist/remote/object-store/convex-r2/storage.js.map +1 -1
- package/dist/remote/object-store/index.d.ts +3 -1
- package/dist/remote/object-store/index.d.ts.map +1 -1
- package/dist/remote/object-store/index.js +1 -1
- package/dist/remote/object-store/index.js.map +1 -1
- package/dist/remote/object-store/s3/storage.d.ts +3 -1
- package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
- package/dist/remote/object-store/s3/storage.js +9 -2
- package/dist/remote/object-store/s3/storage.js.map +1 -1
- package/dist/remote/object-store/types.d.ts +33 -4
- package/dist/remote/object-store/types.d.ts.map +1 -1
- package/dist/remote/object-store/upload-error.d.ts +23 -0
- package/dist/remote/object-store/upload-error.d.ts.map +1 -0
- package/dist/remote/object-store/upload-error.js +33 -0
- package/dist/remote/object-store/upload-error.js.map +1 -0
- package/dist/remote/object-store/validation.d.ts +7 -1
- package/dist/remote/object-store/validation.d.ts.map +1 -1
- package/dist/remote/object-store/validation.js +39 -25
- package/dist/remote/object-store/validation.js.map +1 -1
- package/dist/remote/relay/index.d.ts +7 -14
- package/dist/remote/relay/index.d.ts.map +1 -1
- package/dist/remote/relay/index.js +6 -13
- package/dist/remote/relay/index.js.map +1 -1
- package/dist/remote/relay/memory/adapter.d.ts +5 -4
- package/dist/remote/relay/memory/adapter.d.ts.map +1 -1
- package/dist/remote/relay/memory/adapter.js +14 -4
- package/dist/remote/relay/memory/adapter.js.map +1 -1
- package/dist/remote/relay/types.d.ts +36 -25
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/remote/relay/types.js +1 -1
- package/dist/types/api.d.ts +59 -24
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/index.js +1 -1
- package/dist/types/index.js.map +1 -1
- package/dist/types/session.d.ts +6 -0
- package/dist/types/session.d.ts.map +1 -1
- package/dist/types/session.js.map +1 -1
- package/docs/ASSURANCE.md +7 -7
- package/docs/CLIENT_COMPOSITION.md +16 -23
- package/docs/DEVIATIONS.md +1 -1
- package/docs/DOCUMENTATION_STANDARDS.md +4 -0
- package/docs/ERROR_HANDLING.md +2 -2
- package/docs/GETTING_STARTED.md +23 -38
- package/docs/INTERFACES.md +36 -27
- package/docs/PACKAGE_SURFACE.md +9 -16
- package/docs/RECIPES.md +10 -23
- package/examples/browser/index.html +2 -2
- package/groups/README.md +4 -4
- package/local/store/README.md +22 -7
- package/local/store/expo/README.md +24 -20
- package/local/store/memory/README.md +1 -1
- package/local/store/node/README.md +31 -2
- package/local/store/react-native/README.md +1 -1
- package/local/store/web/README.md +1 -1
- package/local/vault/README.md +1 -1
- package/media/README.md +94 -0
- package/package.json +17 -27
- package/remote/README.md +24 -24
- package/remote/object-store/README.md +8 -0
- package/remote/object-store/s3/README.md +10 -1
- package/remote/relay/README.md +4 -3
- package/remote/relay/memory/README.md +1 -1
- package/types/README.md +2 -2
- package/COMMERCIAL.md +0 -56
- package/dist/device/expo-metadata.d.ts.map +0 -1
- package/dist/device/expo-metadata.js.map +0 -1
- package/dist/remote/relay/convex/backend.d.ts +0 -394
- package/dist/remote/relay/convex/backend.d.ts.map +0 -1
- package/dist/remote/relay/convex/backend.js +0 -678
- package/dist/remote/relay/convex/backend.js.map +0 -1
- package/dist/remote/relay/convex/component/_generated/api.d.ts +0 -58
- package/dist/remote/relay/convex/component/_generated/api.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/_generated/api.js +0 -31
- package/dist/remote/relay/convex/component/_generated/api.js.map +0 -1
- package/dist/remote/relay/convex/component/_generated/component.d.ts +0 -475
- package/dist/remote/relay/convex/component/_generated/component.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/_generated/component.js +0 -11
- package/dist/remote/relay/convex/component/_generated/component.js.map +0 -1
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +0 -46
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/_generated/dataModel.js +0 -11
- package/dist/remote/relay/convex/component/_generated/dataModel.js.map +0 -1
- package/dist/remote/relay/convex/component/_generated/server.d.ts +0 -129
- package/dist/remote/relay/convex/component/_generated/server.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/_generated/server.js +0 -79
- package/dist/remote/relay/convex/component/_generated/server.js.map +0 -1
- package/dist/remote/relay/convex/component/accounts.d.ts +0 -45
- package/dist/remote/relay/convex/component/accounts.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/accounts.js +0 -184
- package/dist/remote/relay/convex/component/accounts.js.map +0 -1
- package/dist/remote/relay/convex/component/certificates.d.ts +0 -10
- package/dist/remote/relay/convex/component/certificates.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/certificates.js +0 -126
- package/dist/remote/relay/convex/component/certificates.js.map +0 -1
- package/dist/remote/relay/convex/component/cleanup.d.ts +0 -32
- package/dist/remote/relay/convex/component/cleanup.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/cleanup.js +0 -146
- package/dist/remote/relay/convex/component/cleanup.js.map +0 -1
- package/dist/remote/relay/convex/component/convex.config.d.ts +0 -5
- package/dist/remote/relay/convex/component/convex.config.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/convex.config.js +0 -35
- package/dist/remote/relay/convex/component/convex.config.js.map +0 -1
- package/dist/remote/relay/convex/component/crons.d.ts +0 -3
- package/dist/remote/relay/convex/component/crons.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/crons.js +0 -10
- package/dist/remote/relay/convex/component/crons.js.map +0 -1
- package/dist/remote/relay/convex/component/devices.d.ts +0 -102
- package/dist/remote/relay/convex/component/devices.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/devices.js +0 -300
- package/dist/remote/relay/convex/component/devices.js.map +0 -1
- package/dist/remote/relay/convex/component/errors.d.ts +0 -22
- package/dist/remote/relay/convex/component/errors.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/errors.js +0 -17
- package/dist/remote/relay/convex/component/errors.js.map +0 -1
- package/dist/remote/relay/convex/component/groups.d.ts +0 -63
- package/dist/remote/relay/convex/component/groups.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/groups.js +0 -341
- package/dist/remote/relay/convex/component/groups.js.map +0 -1
- package/dist/remote/relay/convex/component/keys.d.ts +0 -130
- package/dist/remote/relay/convex/component/keys.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/keys.js +0 -578
- package/dist/remote/relay/convex/component/keys.js.map +0 -1
- package/dist/remote/relay/convex/component/messages.d.ts +0 -105
- package/dist/remote/relay/convex/component/messages.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/messages.js +0 -702
- package/dist/remote/relay/convex/component/messages.js.map +0 -1
- package/dist/remote/relay/convex/component/provisioning.d.ts +0 -92
- package/dist/remote/relay/convex/component/provisioning.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/provisioning.js +0 -360
- package/dist/remote/relay/convex/component/provisioning.js.map +0 -1
- package/dist/remote/relay/convex/component/runtime.d.ts +0 -18
- package/dist/remote/relay/convex/component/runtime.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/runtime.js +0 -144
- package/dist/remote/relay/convex/component/runtime.js.map +0 -1
- package/dist/remote/relay/convex/component/schema.d.ts +0 -358
- package/dist/remote/relay/convex/component/schema.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/schema.js +0 -288
- package/dist/remote/relay/convex/component/schema.js.map +0 -1
- package/dist/remote/relay/convex/component/zkAuth.d.ts +0 -18
- package/dist/remote/relay/convex/component/zkAuth.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/zkAuth.js +0 -86
- package/dist/remote/relay/convex/component/zkAuth.js.map +0 -1
- package/dist/remote/relay/convex/constants.d.ts +0 -3
- package/dist/remote/relay/convex/constants.d.ts.map +0 -1
- package/dist/remote/relay/convex/constants.js +0 -3
- package/dist/remote/relay/convex/constants.js.map +0 -1
- package/dist/remote/relay/convex/group-server.d.ts +0 -123
- package/dist/remote/relay/convex/group-server.d.ts.map +0 -1
- package/dist/remote/relay/convex/group-server.js +0 -184
- package/dist/remote/relay/convex/group-server.js.map +0 -1
- package/dist/remote/relay/convex/index.d.ts +0 -42
- package/dist/remote/relay/convex/index.d.ts.map +0 -1
- package/dist/remote/relay/convex/index.js +0 -38
- package/dist/remote/relay/convex/index.js.map +0 -1
- package/dist/remote/relay/convex/relay.d.ts +0 -323
- package/dist/remote/relay/convex/relay.d.ts.map +0 -1
- package/dist/remote/relay/convex/relay.js +0 -1144
- package/dist/remote/relay/convex/relay.js.map +0 -1
- package/dist/remote/relay/convex/types.d.ts +0 -24
- package/dist/remote/relay/convex/types.d.ts.map +0 -1
- package/dist/remote/relay/convex/types.js +0 -14
- package/dist/remote/relay/convex/types.js.map +0 -1
- package/remote/relay/convex/README.md +0 -61
- package/remote/relay/convex/component/README.md +0 -462
package/dist/client/media.js
CHANGED
|
@@ -1,18 +1,24 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
1
|
+
import { isRemoteObjectUploadFailureCode, remoteObjectUploadFailure, RemoteObjectUploadError, } from "../remote/object-store/upload-error.js";
|
|
2
|
+
import { matchesUploadReceipt } from "../remote/object-store/validation.js";
|
|
3
|
+
import { assertPreparedUploadByteLimit } from "./media-upload-budget.js";
|
|
4
|
+
import { MediaQueuePersistence, MediaQueueConcurrentUpdateError, } from "./media-queue-persistence.js";
|
|
5
|
+
import { bytesToBase64, sha256 } from "../internal/crypto/index.js";
|
|
6
|
+
import { createMediaAttachmentId, createMediaAttachmentPointer, executeMediaAttachmentJob, generateMediaAttachmentUploadRequestId, prepareMediaAttachmentUploadData, validateMediaAttachmentPolicy, MediaAttachmentError, MediaAttachmentErrorCode, MediaAttachmentJobExecutionStatus, MediaAttachmentJobOperation, MediaAttachmentJobPriority, MediaAttachmentJobSource, planMediaAttachmentCleanupJobs, planMediaAttachmentDownloadJob, planMediaAttachmentUploadJob, } from "../media/index.js";
|
|
7
|
+
import { preparedUploadFingerprint, preparedUploadCiphertextSize, samePreparedUploadIntent, } from "../media/prepared-upload.js";
|
|
8
|
+
const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_METADATA_KEY = "signal:mediaQueue:v1";
|
|
3
9
|
const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_JOBS_DEFAULT = 200;
|
|
4
10
|
const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_ATTEMPTS_DEFAULT = 5;
|
|
5
11
|
const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_BASE_RETRY_DELAY_MS_DEFAULT = 30_000;
|
|
6
12
|
const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_RETRY_DELAY_MS_DEFAULT = 60 * 60 * 1000;
|
|
7
13
|
const localOnlyObjectStore = {
|
|
8
14
|
async createUpload() {
|
|
9
|
-
throw new Error(
|
|
15
|
+
throw new Error("Signal Protocol media operation requires remoteObjectStore for upload");
|
|
10
16
|
},
|
|
11
17
|
async createDownload() {
|
|
12
|
-
throw new Error(
|
|
18
|
+
throw new Error("Signal Protocol media operation requires remoteObjectStore for download");
|
|
13
19
|
},
|
|
14
20
|
async deleteObject() {
|
|
15
|
-
throw new Error(
|
|
21
|
+
throw new Error("Signal Protocol media operation requires remoteObjectStore for remote delete");
|
|
16
22
|
},
|
|
17
23
|
};
|
|
18
24
|
function priorityRank(priority) {
|
|
@@ -35,7 +41,7 @@ function compareMediaAttachmentJobs(left, right) {
|
|
|
35
41
|
left.jobId.localeCompare(right.jobId));
|
|
36
42
|
}
|
|
37
43
|
function isRecord(value) {
|
|
38
|
-
return value !== null && typeof value ===
|
|
44
|
+
return value !== null && typeof value === "object" && !Array.isArray(value);
|
|
39
45
|
}
|
|
40
46
|
function isInteger(value) {
|
|
41
47
|
return Number.isSafeInteger(value);
|
|
@@ -44,18 +50,18 @@ function isMediaAttachmentJob(value) {
|
|
|
44
50
|
if (!isRecord(value)) {
|
|
45
51
|
return false;
|
|
46
52
|
}
|
|
47
|
-
return (typeof value.jobId ===
|
|
53
|
+
return (typeof value.jobId === "string" &&
|
|
48
54
|
Object.values(MediaAttachmentJobOperation).includes(value.operation) &&
|
|
49
55
|
Object.values(MediaAttachmentJobSource).includes(value.source) &&
|
|
50
56
|
Object.values(MediaAttachmentJobPriority).includes(value.priority) &&
|
|
51
|
-
typeof value.requiresNetwork ===
|
|
52
|
-
typeof value.attachmentId ===
|
|
57
|
+
typeof value.requiresNetwork === "boolean" &&
|
|
58
|
+
typeof value.attachmentId === "string" &&
|
|
53
59
|
isInteger(value.attempt) &&
|
|
54
60
|
isInteger(value.createdAt) &&
|
|
55
61
|
isInteger(value.notBefore) &&
|
|
56
|
-
(value.storageId === undefined || typeof value.storageId ===
|
|
57
|
-
(value.deliveryId === undefined || typeof value.deliveryId ===
|
|
58
|
-
(value.reason === undefined || typeof value.reason ===
|
|
62
|
+
(value.storageId === undefined || typeof value.storageId === "string") &&
|
|
63
|
+
(value.deliveryId === undefined || typeof value.deliveryId === "string") &&
|
|
64
|
+
(value.reason === undefined || typeof value.reason === "string"));
|
|
59
65
|
}
|
|
60
66
|
function normalizePointer(value) {
|
|
61
67
|
try {
|
|
@@ -67,14 +73,33 @@ function normalizePointer(value) {
|
|
|
67
73
|
}
|
|
68
74
|
function isStoredUpload(value) {
|
|
69
75
|
return (isRecord(value) &&
|
|
70
|
-
typeof value.localMediaId ===
|
|
76
|
+
typeof value.localMediaId === "string" &&
|
|
71
77
|
value.localMediaId.length > 0 &&
|
|
72
|
-
typeof value.requestId ===
|
|
78
|
+
typeof value.requestId === "string" &&
|
|
73
79
|
value.requestId.length > 0 &&
|
|
74
|
-
typeof value.contentType ===
|
|
80
|
+
typeof value.contentType === "string" &&
|
|
75
81
|
value.contentType.length > 0 &&
|
|
76
82
|
isInteger(value.size) &&
|
|
77
|
-
value.size >= 0
|
|
83
|
+
value.size >= 0 &&
|
|
84
|
+
(value.preparedFingerprint === undefined ||
|
|
85
|
+
typeof value.preparedFingerprint === "string") &&
|
|
86
|
+
(value.preparationStarted === undefined ||
|
|
87
|
+
value.preparationStarted === true) &&
|
|
88
|
+
(value.preparedAt === undefined ||
|
|
89
|
+
(isInteger(value.preparedAt) && value.preparedAt > 0)) &&
|
|
90
|
+
(value.abandonment === undefined ||
|
|
91
|
+
value.abandonment === "requested" ||
|
|
92
|
+
value.abandonment === "confirmed") &&
|
|
93
|
+
(value.remoteObjectId === undefined ||
|
|
94
|
+
(typeof value.remoteObjectId === "string" &&
|
|
95
|
+
value.remoteObjectId.length > 0)) &&
|
|
96
|
+
(value.transferCompletedAt === undefined ||
|
|
97
|
+
(isInteger(value.transferCompletedAt) &&
|
|
98
|
+
value.transferCompletedAt >= 0)) &&
|
|
99
|
+
(value.callbackDelivered === undefined ||
|
|
100
|
+
typeof value.callbackDelivered === "boolean") &&
|
|
101
|
+
(value.failureCode === undefined ||
|
|
102
|
+
isRemoteObjectUploadFailureCode(value.failureCode)));
|
|
78
103
|
}
|
|
79
104
|
function mergeJob(existing, incoming) {
|
|
80
105
|
if (priorityRank(incoming.priority) <= priorityRank(existing.priority)) {
|
|
@@ -98,16 +123,20 @@ function normalizeJobs(jobs, maxJobs) {
|
|
|
98
123
|
const deduped = new Map();
|
|
99
124
|
for (const job of jobs) {
|
|
100
125
|
if (!isMediaAttachmentJob(job)) {
|
|
101
|
-
|
|
126
|
+
throw new Error("The saved media queue contains an invalid job. Restore the local queue before retrying.");
|
|
102
127
|
}
|
|
103
128
|
const existing = deduped.get(job.jobId);
|
|
104
129
|
deduped.set(job.jobId, existing ? mergeJob(existing, job) : job);
|
|
105
130
|
}
|
|
106
|
-
|
|
131
|
+
if (deduped.size > maxJobs)
|
|
132
|
+
throw new Error("The media queue is full. Complete existing jobs before adding work.");
|
|
133
|
+
return [...deduped.values()].sort(compareMediaAttachmentJobs);
|
|
107
134
|
}
|
|
108
135
|
function nextRetryTimestamp(job, now, config) {
|
|
109
|
-
const baseDelay = config?.baseRetryDelayMs ??
|
|
110
|
-
|
|
136
|
+
const baseDelay = config?.baseRetryDelayMs ??
|
|
137
|
+
SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_BASE_RETRY_DELAY_MS_DEFAULT;
|
|
138
|
+
const maxDelay = config?.maxRetryDelayMs ??
|
|
139
|
+
SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_RETRY_DELAY_MS_DEFAULT;
|
|
111
140
|
const delay = Math.min(maxDelay, baseDelay * 2 ** Math.max(0, job.attempt));
|
|
112
141
|
return now + delay;
|
|
113
142
|
}
|
|
@@ -136,30 +165,48 @@ function uploadOptionsFromStoredUpload(upload) {
|
|
|
136
165
|
cdnNumber: upload.cdnNumber,
|
|
137
166
|
};
|
|
138
167
|
}
|
|
168
|
+
function preparedUploadMatchesQueue(upload, prepared) {
|
|
169
|
+
if (prepared.requestId !== upload.requestId ||
|
|
170
|
+
prepared.pointer.size !== upload.size ||
|
|
171
|
+
prepared.ciphertext.byteLength !==
|
|
172
|
+
preparedUploadCiphertextSize(upload.size) ||
|
|
173
|
+
prepared.pointer.ciphertextSize !== prepared.ciphertext.byteLength)
|
|
174
|
+
return false;
|
|
175
|
+
const pointer = prepared.pointer;
|
|
176
|
+
return Object.entries(uploadOptionsFromStoredUpload(upload)).every(([key, value]) => {
|
|
177
|
+
if (key === "requestId" ||
|
|
178
|
+
key === "policy" ||
|
|
179
|
+
(key === "clientUuid" && value === undefined))
|
|
180
|
+
return true;
|
|
181
|
+
return JSON.stringify(pointer[key]) === JSON.stringify(value);
|
|
182
|
+
});
|
|
183
|
+
}
|
|
139
184
|
/** @internal */
|
|
140
185
|
export class StorageBackedSignalProtocolClientMedia {
|
|
141
186
|
storage;
|
|
142
187
|
remoteObjectStore;
|
|
143
188
|
config;
|
|
144
189
|
storeLock = Promise.resolve();
|
|
190
|
+
queuePersistence;
|
|
145
191
|
constructor(options) {
|
|
146
192
|
this.storage = options.storage;
|
|
193
|
+
this.queuePersistence = new MediaQueuePersistence(options.storage, SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_METADATA_KEY);
|
|
147
194
|
this.remoteObjectStore = options.remoteObjectStore;
|
|
148
195
|
this.config = options.config;
|
|
149
196
|
}
|
|
150
197
|
async upload(input, options = {}) {
|
|
151
198
|
const job = await this.enqueueUploadJob(input);
|
|
152
199
|
const result = await this.processJob(job.jobId, options);
|
|
153
|
-
if (result.status ===
|
|
200
|
+
if (result.status === "completed" && result.execution.uploadedAttachment) {
|
|
154
201
|
return {
|
|
155
|
-
status:
|
|
202
|
+
status: "completed",
|
|
156
203
|
jobId: job.jobId,
|
|
157
204
|
attachment: result.execution.uploadedAttachment,
|
|
158
205
|
execution: result.execution,
|
|
159
206
|
};
|
|
160
207
|
}
|
|
161
|
-
if (result.status ===
|
|
162
|
-
return { status:
|
|
208
|
+
if (result.status === "completed") {
|
|
209
|
+
return { status: "failed", jobId: job.jobId };
|
|
163
210
|
}
|
|
164
211
|
return result;
|
|
165
212
|
}
|
|
@@ -168,26 +215,120 @@ export class StorageBackedSignalProtocolClientMedia {
|
|
|
168
215
|
if (!job) {
|
|
169
216
|
const attachment = createMediaAttachmentPointer(input.attachment);
|
|
170
217
|
return {
|
|
171
|
-
status:
|
|
172
|
-
reason:
|
|
218
|
+
status: "skipped",
|
|
219
|
+
reason: "not-needed",
|
|
173
220
|
attachmentId: createMediaAttachmentId(attachment),
|
|
174
221
|
};
|
|
175
222
|
}
|
|
176
223
|
const result = await this.processJob(job.jobId, options);
|
|
177
|
-
if (result.status ===
|
|
224
|
+
if (result.status === "completed" &&
|
|
225
|
+
result.execution.downloadedAttachment) {
|
|
178
226
|
return {
|
|
179
|
-
status:
|
|
227
|
+
status: "completed",
|
|
180
228
|
jobId: job.jobId,
|
|
181
229
|
attachmentId: job.attachmentId,
|
|
182
230
|
downloaded: result.execution.downloadedAttachment,
|
|
183
231
|
execution: result.execution,
|
|
184
232
|
};
|
|
185
233
|
}
|
|
186
|
-
if (result.status ===
|
|
187
|
-
return { status:
|
|
234
|
+
if (result.status === "completed") {
|
|
235
|
+
return { status: "failed", jobId: job.jobId };
|
|
188
236
|
}
|
|
189
237
|
return result;
|
|
190
238
|
}
|
|
239
|
+
async abandonUpload(jobId) {
|
|
240
|
+
return this.withStoreLock(() => this.abandonUploadLocked(jobId));
|
|
241
|
+
}
|
|
242
|
+
async abandonUploadLocked(jobId) {
|
|
243
|
+
const artifacts = this.config?.preparedUploads;
|
|
244
|
+
if (!artifacts)
|
|
245
|
+
throw new Error("Configure media.preparedUploads before abandoning a queued upload.");
|
|
246
|
+
const cancellation = await artifacts.withExclusiveAccess(async () => {
|
|
247
|
+
const state = await this.loadState();
|
|
248
|
+
const job = state.jobs.find((item) => item.jobId === jobId);
|
|
249
|
+
if (!job)
|
|
250
|
+
return undefined;
|
|
251
|
+
const upload = state.uploads.get(jobId);
|
|
252
|
+
if (job.operation !== MediaAttachmentJobOperation.Upload || !upload)
|
|
253
|
+
throw new Error("Only a queued upload can be abandoned.");
|
|
254
|
+
const completed = state.pointers.get(jobId);
|
|
255
|
+
if (completed)
|
|
256
|
+
return { completed };
|
|
257
|
+
state.activeJobId = jobId;
|
|
258
|
+
upload.abandonment ??= "requested";
|
|
259
|
+
delete upload.failureCode;
|
|
260
|
+
await this.saveState(state);
|
|
261
|
+
if (upload.preparationStarted && upload.preparedAt === undefined)
|
|
262
|
+
throw new Error("The preparation time is missing. Restore the original queue before abandonment.");
|
|
263
|
+
return {
|
|
264
|
+
requestId: upload.requestId,
|
|
265
|
+
preparedAt: upload.preparedAt,
|
|
266
|
+
confirmed: upload.abandonment === "confirmed",
|
|
267
|
+
};
|
|
268
|
+
});
|
|
269
|
+
if (!cancellation)
|
|
270
|
+
return { status: "not-found", jobId };
|
|
271
|
+
if (cancellation.completed !== undefined)
|
|
272
|
+
return { status: "completed", jobId, attachment: cancellation.completed };
|
|
273
|
+
if (!cancellation.confirmed && cancellation.preparedAt !== undefined) {
|
|
274
|
+
if (!this.remoteObjectStore?.abandonUpload)
|
|
275
|
+
throw new Error("The storage broker must support abandonment by original upload identity. The queue remains retained.");
|
|
276
|
+
try {
|
|
277
|
+
await this.remoteObjectStore.abandonUpload({
|
|
278
|
+
requestId: cancellation.requestId,
|
|
279
|
+
preparedAt: cancellation.preparedAt,
|
|
280
|
+
});
|
|
281
|
+
}
|
|
282
|
+
catch {
|
|
283
|
+
await this.scheduleAbandonmentRetry(jobId);
|
|
284
|
+
return { status: "pending", jobId };
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
try {
|
|
288
|
+
await artifacts.withExclusiveAccess(async () => {
|
|
289
|
+
const state = await this.loadState();
|
|
290
|
+
const job = state.jobs.find((item) => item.jobId === jobId);
|
|
291
|
+
if (!job)
|
|
292
|
+
return;
|
|
293
|
+
const upload = state.uploads.get(jobId);
|
|
294
|
+
if (upload?.requestId !== cancellation.requestId ||
|
|
295
|
+
upload.preparedAt !== cancellation.preparedAt ||
|
|
296
|
+
upload.abandonment === undefined)
|
|
297
|
+
throw new MediaQueueConcurrentUpdateError();
|
|
298
|
+
state.activeJobId = jobId;
|
|
299
|
+
upload.abandonment = "confirmed";
|
|
300
|
+
await this.saveState(state);
|
|
301
|
+
await artifacts.delete(upload.requestId);
|
|
302
|
+
state.jobs = state.jobs.filter((item) => item.jobId !== jobId);
|
|
303
|
+
this.deleteJobSidecarState(state, job);
|
|
304
|
+
await this.saveState(state);
|
|
305
|
+
});
|
|
306
|
+
return { status: "abandoned", jobId };
|
|
307
|
+
}
|
|
308
|
+
catch (error) {
|
|
309
|
+
if (error instanceof MediaQueueConcurrentUpdateError)
|
|
310
|
+
throw error;
|
|
311
|
+
await this.scheduleAbandonmentRetry(jobId);
|
|
312
|
+
return { status: "pending", jobId };
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
async scheduleAbandonmentRetry(jobId) {
|
|
316
|
+
await this.config.preparedUploads.withExclusiveAccess(async () => {
|
|
317
|
+
const state = await this.loadState();
|
|
318
|
+
const job = state.jobs.find((item) => item.jobId === jobId);
|
|
319
|
+
if (!job || state.uploads.get(jobId)?.abandonment === undefined)
|
|
320
|
+
return;
|
|
321
|
+
state.activeJobId = jobId;
|
|
322
|
+
state.jobs = state.jobs.map((item) => item.jobId === jobId
|
|
323
|
+
? {
|
|
324
|
+
...item,
|
|
325
|
+
attempt: item.attempt + 1,
|
|
326
|
+
notBefore: nextRetryTimestamp(item, Date.now(), this.config),
|
|
327
|
+
}
|
|
328
|
+
: item);
|
|
329
|
+
await this.saveState(state);
|
|
330
|
+
});
|
|
331
|
+
}
|
|
191
332
|
async cleanup(input, options = {}) {
|
|
192
333
|
const jobs = await this.enqueueCleanupJobs(input);
|
|
193
334
|
const results = [];
|
|
@@ -195,19 +336,46 @@ export class StorageBackedSignalProtocolClientMedia {
|
|
|
195
336
|
results.push(await this.processJob(job.jobId, options));
|
|
196
337
|
}
|
|
197
338
|
return {
|
|
198
|
-
status: results.every((result) => result.status ===
|
|
339
|
+
status: results.every((result) => result.status === "completed")
|
|
340
|
+
? "completed"
|
|
341
|
+
: "pending",
|
|
199
342
|
jobs: results,
|
|
200
343
|
};
|
|
201
344
|
}
|
|
202
345
|
async enqueueUploadJob(input) {
|
|
346
|
+
assertPreparedUploadByteLimit(this.config?.maxPreparedUploadBytes);
|
|
203
347
|
const job = planMediaAttachmentUploadJob(input);
|
|
204
348
|
const requestId = input.requestId ?? (await generateMediaAttachmentUploadRequestId());
|
|
205
349
|
await this.updateState((state) => {
|
|
206
|
-
const existingUpload = state.uploads.get(job.jobId)
|
|
350
|
+
const existingUpload = state.uploads.get(job.jobId) ??
|
|
351
|
+
[...state.uploads.values()].find((upload) => upload.localMediaId === input.localMediaId ||
|
|
352
|
+
upload.requestId === input.requestId);
|
|
353
|
+
if (existingUpload) {
|
|
354
|
+
if (existingUpload.abandonment !== undefined)
|
|
355
|
+
throw new Error("This upload is being abandoned. Complete its cleanup before starting another upload.");
|
|
356
|
+
if (existingUpload.localMediaId !== input.localMediaId)
|
|
357
|
+
throw new Error("The queued upload request ID belongs to another local attachment.");
|
|
358
|
+
const incoming = {
|
|
359
|
+
...uploadOptionsFromStoredUpload({
|
|
360
|
+
...input,
|
|
361
|
+
requestId: input.requestId ?? existingUpload.requestId,
|
|
362
|
+
}),
|
|
363
|
+
size: input.size,
|
|
364
|
+
};
|
|
365
|
+
const existing = {
|
|
366
|
+
...uploadOptionsFromStoredUpload(existingUpload),
|
|
367
|
+
size: existingUpload.size,
|
|
368
|
+
};
|
|
369
|
+
if (JSON.stringify(incoming) !== JSON.stringify(existing)) {
|
|
370
|
+
throw new Error("The queued upload changed. Retry with the original upload input.");
|
|
371
|
+
}
|
|
372
|
+
state.jobs = this.normalizeJobs([...state.jobs, job]);
|
|
373
|
+
return;
|
|
374
|
+
}
|
|
207
375
|
state.jobs = this.normalizeJobs([...state.jobs, job]);
|
|
208
376
|
state.uploads.set(job.jobId, {
|
|
209
377
|
localMediaId: input.localMediaId,
|
|
210
|
-
requestId
|
|
378
|
+
requestId,
|
|
211
379
|
contentType: input.contentType,
|
|
212
380
|
size: input.size,
|
|
213
381
|
policy: input.policy,
|
|
@@ -255,32 +423,77 @@ export class StorageBackedSignalProtocolClientMedia {
|
|
|
255
423
|
async processPendingLocked(options) {
|
|
256
424
|
const now = options.now ?? Date.now();
|
|
257
425
|
const limit = options.limit ?? 5;
|
|
258
|
-
const maxAttempts = this.config?.maxAttempts ??
|
|
426
|
+
const maxAttempts = this.config?.maxAttempts ??
|
|
427
|
+
SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_ATTEMPTS_DEFAULT;
|
|
428
|
+
const initial = await this.loadState();
|
|
429
|
+
const cancellations = initial.jobs
|
|
430
|
+
.filter((job) => job.notBefore <= now &&
|
|
431
|
+
initial.uploads.get(job.jobId)?.abandonment !== undefined)
|
|
432
|
+
.slice(0, limit);
|
|
433
|
+
let abandoned = 0;
|
|
434
|
+
for (const job of cancellations) {
|
|
435
|
+
try {
|
|
436
|
+
const result = await this.abandonUploadLocked(job.jobId);
|
|
437
|
+
if (result.status === "abandoned" || result.status === "not-found")
|
|
438
|
+
abandoned++;
|
|
439
|
+
}
|
|
440
|
+
catch (error) {
|
|
441
|
+
if (error instanceof MediaQueueConcurrentUpdateError)
|
|
442
|
+
throw error;
|
|
443
|
+
await this.scheduleAbandonmentRetry(job.jobId);
|
|
444
|
+
}
|
|
445
|
+
}
|
|
259
446
|
const state = await this.loadState();
|
|
260
|
-
const dueJobs = state.jobs
|
|
261
|
-
|
|
447
|
+
const dueJobs = state.jobs
|
|
448
|
+
.filter((job) => job.notBefore <= now &&
|
|
449
|
+
job.attempt < maxAttempts &&
|
|
450
|
+
state.uploads.get(job.jobId)?.abandonment === undefined &&
|
|
451
|
+
state.uploads.get(job.jobId)?.failureCode === undefined)
|
|
452
|
+
.slice(0, Math.max(0, limit - cancellations.length));
|
|
453
|
+
const result = await this.processJobsLocked(state, dueJobs, options, now, maxAttempts);
|
|
454
|
+
return {
|
|
455
|
+
...result,
|
|
456
|
+
attempted: result.attempted + cancellations.length,
|
|
457
|
+
failed: result.failed + cancellations.length - abandoned,
|
|
458
|
+
abandoned,
|
|
459
|
+
};
|
|
262
460
|
}
|
|
263
461
|
async processJob(jobId, options) {
|
|
264
462
|
return this.withStoreLock(async () => {
|
|
265
463
|
const now = options.now ?? Date.now();
|
|
266
|
-
const maxAttempts = this.config?.maxAttempts ??
|
|
464
|
+
const maxAttempts = this.config?.maxAttempts ??
|
|
465
|
+
SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_ATTEMPTS_DEFAULT;
|
|
267
466
|
const state = await this.loadState();
|
|
268
467
|
const job = state.jobs.find((candidate) => candidate.jobId === jobId);
|
|
269
468
|
if (!job) {
|
|
270
|
-
return { status:
|
|
469
|
+
return { status: "failed", jobId };
|
|
271
470
|
}
|
|
272
471
|
if (job.notBefore > now) {
|
|
273
|
-
return { status:
|
|
472
|
+
return { status: "pending", jobId };
|
|
473
|
+
}
|
|
474
|
+
// Only an explicit upload call retries a retained broker refusal.
|
|
475
|
+
const savedUpload = state.uploads.get(jobId);
|
|
476
|
+
if (savedUpload?.abandonment !== undefined)
|
|
477
|
+
throw new Error("This upload is being abandoned. Retry cleanup with processPending().");
|
|
478
|
+
state.activeJobId = jobId;
|
|
479
|
+
if (savedUpload?.failureCode !== undefined) {
|
|
480
|
+
delete savedUpload.failureCode;
|
|
481
|
+
await this.saveState(state);
|
|
274
482
|
}
|
|
275
483
|
const result = await this.processJobsLocked(state, [job], options, now, maxAttempts);
|
|
276
484
|
const execution = result.results.find((candidate) => candidate.job.jobId === jobId);
|
|
277
485
|
if (execution?.status === MediaAttachmentJobExecutionStatus.Completed) {
|
|
278
|
-
return { status:
|
|
486
|
+
return { status: "completed", jobId, execution };
|
|
279
487
|
}
|
|
280
488
|
if (execution?.status === MediaAttachmentJobExecutionStatus.Skipped) {
|
|
281
|
-
return { status:
|
|
489
|
+
return { status: "skipped", jobId, execution };
|
|
282
490
|
}
|
|
283
|
-
|
|
491
|
+
const uploadFailure = result.uploadFailures.find((candidate) => candidate.jobId === jobId);
|
|
492
|
+
if (uploadFailure)
|
|
493
|
+
return { status: "failed", jobId, failure: uploadFailure.failure };
|
|
494
|
+
return result.expired > 0
|
|
495
|
+
? { status: "failed", jobId }
|
|
496
|
+
: { status: "pending", jobId };
|
|
284
497
|
});
|
|
285
498
|
}
|
|
286
499
|
async processJobsLocked(state, jobs, options, now, maxAttempts) {
|
|
@@ -290,14 +503,45 @@ export class StorageBackedSignalProtocolClientMedia {
|
|
|
290
503
|
let skipped = 0;
|
|
291
504
|
let failed = 0;
|
|
292
505
|
let expired = 0;
|
|
506
|
+
const uploadFailures = state.jobs.flatMap((job) => {
|
|
507
|
+
const code = state.uploads.get(job.jobId)?.failureCode;
|
|
508
|
+
return code === undefined
|
|
509
|
+
? []
|
|
510
|
+
: [{ jobId: job.jobId, failure: remoteObjectUploadFailure(code) }];
|
|
511
|
+
});
|
|
293
512
|
if (jobs.length === 0) {
|
|
294
|
-
return {
|
|
513
|
+
return {
|
|
514
|
+
attempted: 0,
|
|
515
|
+
abandoned: 0,
|
|
516
|
+
completed,
|
|
517
|
+
skipped,
|
|
518
|
+
failed,
|
|
519
|
+
expired,
|
|
520
|
+
results,
|
|
521
|
+
uploadFailures,
|
|
522
|
+
};
|
|
295
523
|
}
|
|
296
524
|
for (const job of jobs) {
|
|
525
|
+
state.activeJobId = job.jobId;
|
|
526
|
+
// Persist progress from each job before external effects for the next job.
|
|
527
|
+
state.jobs = [...retained.values()];
|
|
528
|
+
if (job.operation === MediaAttachmentJobOperation.Upload &&
|
|
529
|
+
!this.config?.preparedUploads) {
|
|
530
|
+
throw new Error("Configure media.preparedUploads with durable local file storage before uploading.");
|
|
531
|
+
}
|
|
532
|
+
if (job.operation === MediaAttachmentJobOperation.Upload)
|
|
533
|
+
assertPreparedUploadByteLimit(this.config?.maxPreparedUploadBytes);
|
|
297
534
|
try {
|
|
298
535
|
const execution = await executeMediaAttachmentJob(job, this.createExecutionOptions(job, state, options));
|
|
299
|
-
results.push(execution);
|
|
300
536
|
if (execution.status === MediaAttachmentJobExecutionStatus.Completed) {
|
|
537
|
+
if (job.operation === MediaAttachmentJobOperation.Upload) {
|
|
538
|
+
const upload = state.uploads.get(job.jobId);
|
|
539
|
+
if (upload?.preparedFingerprint)
|
|
540
|
+
await this.config.preparedUploads.withExclusiveAccess(async () => {
|
|
541
|
+
await this.saveState(state);
|
|
542
|
+
await this.config.preparedUploads.delete(upload.requestId);
|
|
543
|
+
});
|
|
544
|
+
}
|
|
301
545
|
completed += 1;
|
|
302
546
|
retained.delete(job.jobId);
|
|
303
547
|
this.deleteJobSidecarState(state, job);
|
|
@@ -307,12 +551,35 @@ export class StorageBackedSignalProtocolClientMedia {
|
|
|
307
551
|
retained.delete(job.jobId);
|
|
308
552
|
this.deleteJobSidecarState(state, job);
|
|
309
553
|
}
|
|
554
|
+
results.push(execution);
|
|
310
555
|
}
|
|
311
|
-
catch {
|
|
556
|
+
catch (error) {
|
|
557
|
+
if (error instanceof MediaQueueConcurrentUpdateError)
|
|
558
|
+
throw error;
|
|
312
559
|
failed += 1;
|
|
560
|
+
const upload = state.uploads.get(job.jobId);
|
|
561
|
+
if (job.operation === MediaAttachmentJobOperation.Upload &&
|
|
562
|
+
upload &&
|
|
563
|
+
error instanceof RemoteObjectUploadError) {
|
|
564
|
+
upload.failureCode = error.code;
|
|
565
|
+
uploadFailures.push({
|
|
566
|
+
jobId: job.jobId,
|
|
567
|
+
failure: remoteObjectUploadFailure(error.code),
|
|
568
|
+
});
|
|
569
|
+
retained.set(job.jobId, { ...job, attempt: job.attempt + 1 });
|
|
570
|
+
state.jobs = [...retained.values()];
|
|
571
|
+
await this.saveState(state);
|
|
572
|
+
continue;
|
|
573
|
+
}
|
|
313
574
|
const nextAttempt = job.attempt + 1;
|
|
314
575
|
if (nextAttempt >= maxAttempts) {
|
|
315
576
|
expired += 1;
|
|
577
|
+
// The artifact can commit before its reply or queue fingerprint persists.
|
|
578
|
+
if (job.operation === MediaAttachmentJobOperation.Upload &&
|
|
579
|
+
(upload?.preparationStarted || upload?.preparedFingerprint)) {
|
|
580
|
+
retained.set(job.jobId, { ...job, attempt: nextAttempt });
|
|
581
|
+
continue;
|
|
582
|
+
}
|
|
316
583
|
retained.delete(job.jobId);
|
|
317
584
|
this.deleteJobSidecarState(state, job);
|
|
318
585
|
continue;
|
|
@@ -323,32 +590,131 @@ export class StorageBackedSignalProtocolClientMedia {
|
|
|
323
590
|
notBefore: nextRetryTimestamp(job, now, this.config),
|
|
324
591
|
});
|
|
325
592
|
}
|
|
593
|
+
state.jobs = [...retained.values()];
|
|
594
|
+
await this.saveState(state);
|
|
326
595
|
}
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
uploads: state.uploads,
|
|
330
|
-
pointers: state.pointers,
|
|
331
|
-
});
|
|
596
|
+
state.jobs = this.normalizeJobs([...retained.values()]);
|
|
597
|
+
await this.saveState(state);
|
|
332
598
|
return {
|
|
333
599
|
attempted: jobs.length,
|
|
600
|
+
abandoned: 0,
|
|
334
601
|
completed,
|
|
335
602
|
skipped,
|
|
336
603
|
failed,
|
|
337
604
|
expired,
|
|
338
605
|
results,
|
|
606
|
+
uploadFailures,
|
|
607
|
+
};
|
|
608
|
+
}
|
|
609
|
+
/** Persist broker identity before the transfer code receives its short-lived URL. */
|
|
610
|
+
uploadBrokerForJob(job, state, broker) {
|
|
611
|
+
return {
|
|
612
|
+
createUpload: async (input) => {
|
|
613
|
+
const upload = state.uploads.get(job.jobId);
|
|
614
|
+
if (!upload?.preparedFingerprint ||
|
|
615
|
+
input.requestId !== upload.requestId) {
|
|
616
|
+
throw new MediaAttachmentError("The upload has no matching durable preparation.", MediaAttachmentErrorCode.UploadIdentityChanged);
|
|
617
|
+
}
|
|
618
|
+
const grant = await broker.createUpload(input);
|
|
619
|
+
if (typeof grant.objectId !== "string" ||
|
|
620
|
+
grant.objectId.length === 0 ||
|
|
621
|
+
(upload.remoteObjectId !== undefined &&
|
|
622
|
+
upload.remoteObjectId !== grant.objectId)) {
|
|
623
|
+
throw new MediaAttachmentError("The broker changed the saved upload identity.", MediaAttachmentErrorCode.UploadIdentityChanged);
|
|
624
|
+
}
|
|
625
|
+
upload.remoteObjectId = grant.objectId;
|
|
626
|
+
// Repeat this write after an uncertain result, including retries within one invocation.
|
|
627
|
+
await this.saveState(state);
|
|
628
|
+
return grant;
|
|
629
|
+
},
|
|
630
|
+
createDownload: (input) => broker.createDownload(input),
|
|
631
|
+
...(broker.reconcileUpload
|
|
632
|
+
? {
|
|
633
|
+
reconcileUpload: async (input) => {
|
|
634
|
+
if (state.uploads.get(job.jobId)?.remoteObjectId !== input.objectId) {
|
|
635
|
+
throw new MediaAttachmentError("The reconciliation request differs from the saved upload identity.", MediaAttachmentErrorCode.UploadIdentityChanged);
|
|
636
|
+
}
|
|
637
|
+
return broker.reconcileUpload(input);
|
|
638
|
+
},
|
|
639
|
+
}
|
|
640
|
+
: {}),
|
|
641
|
+
completeUpload: async (input) => {
|
|
642
|
+
const upload = state.uploads.get(job.jobId);
|
|
643
|
+
if (!upload?.remoteObjectId ||
|
|
644
|
+
input.objectId !== upload.remoteObjectId) {
|
|
645
|
+
throw new MediaAttachmentError("The completion request differs from the saved upload identity.", MediaAttachmentErrorCode.UploadIdentityChanged);
|
|
646
|
+
}
|
|
647
|
+
upload.transferCompletedAt ??= Date.now();
|
|
648
|
+
// Persist successful transfer before completion can change the remote state.
|
|
649
|
+
await this.saveState(state);
|
|
650
|
+
await broker.completeUpload?.(input);
|
|
651
|
+
},
|
|
652
|
+
...(broker.deleteObject
|
|
653
|
+
? { deleteObject: (input) => broker.deleteObject(input) }
|
|
654
|
+
: {}),
|
|
339
655
|
};
|
|
340
656
|
}
|
|
657
|
+
async recoverCompletedUpload(job, state, broker, options) {
|
|
658
|
+
const completed = state.pointers.get(job.jobId);
|
|
659
|
+
if (completed)
|
|
660
|
+
return completed;
|
|
661
|
+
const upload = state.uploads.get(job.jobId);
|
|
662
|
+
if (!upload?.remoteObjectId)
|
|
663
|
+
return null;
|
|
664
|
+
if (upload.transferCompletedAt === undefined && !broker.reconcileUpload)
|
|
665
|
+
return null;
|
|
666
|
+
if (options.signal?.aborted)
|
|
667
|
+
throw new MediaAttachmentError("Media attachment operation cancelled", MediaAttachmentErrorCode.Cancelled);
|
|
668
|
+
const prepared = await this.config.preparedUploads.load(upload.requestId);
|
|
669
|
+
if (!prepared ||
|
|
670
|
+
!preparedUploadMatchesQueue(upload, prepared) ||
|
|
671
|
+
(await preparedUploadFingerprint(prepared)) !==
|
|
672
|
+
upload.preparedFingerprint ||
|
|
673
|
+
prepared.ciphertext.length !== prepared.pointer.ciphertextSize ||
|
|
674
|
+
bytesToBase64(await sha256(prepared.ciphertext)) !==
|
|
675
|
+
prepared.pointer.digest) {
|
|
676
|
+
throw new Error("The saved upload preparation changed. Restore its original local record.");
|
|
677
|
+
}
|
|
678
|
+
const completedAt = upload.transferCompletedAt ?? Date.now();
|
|
679
|
+
const attachment = validateMediaAttachmentPolicy({
|
|
680
|
+
...prepared.pointer,
|
|
681
|
+
storageId: upload.remoteObjectId,
|
|
682
|
+
uploadTimestamp: completedAt,
|
|
683
|
+
}, upload.policy ?? options.policy);
|
|
684
|
+
if (upload.transferCompletedAt === undefined) {
|
|
685
|
+
const receipt = await broker.reconcileUpload({
|
|
686
|
+
objectId: upload.remoteObjectId,
|
|
687
|
+
});
|
|
688
|
+
if (receipt === null)
|
|
689
|
+
return null;
|
|
690
|
+
if (!matchesUploadReceipt(receipt, {
|
|
691
|
+
objectId: upload.remoteObjectId,
|
|
692
|
+
contentLength: prepared.ciphertext.length,
|
|
693
|
+
digest: await sha256(prepared.ciphertext),
|
|
694
|
+
})) {
|
|
695
|
+
throw new MediaAttachmentError("The stored upload differs from its immutable preparation.", MediaAttachmentErrorCode.UploadIdentityChanged);
|
|
696
|
+
}
|
|
697
|
+
upload.transferCompletedAt = completedAt;
|
|
698
|
+
await this.saveState(state);
|
|
699
|
+
}
|
|
700
|
+
if (options.signal?.aborted)
|
|
701
|
+
throw new MediaAttachmentError("Media attachment operation cancelled", MediaAttachmentErrorCode.Cancelled);
|
|
702
|
+
await broker.completeUpload?.({ objectId: attachment.storageId });
|
|
703
|
+
return attachment;
|
|
704
|
+
}
|
|
341
705
|
createExecutionOptions(job, state, options) {
|
|
342
706
|
const remoteObjectStore = this.remoteObjectStore ?? localOnlyObjectStore;
|
|
343
707
|
if (!this.remoteObjectStore &&
|
|
344
708
|
(job.operation === MediaAttachmentJobOperation.Upload ||
|
|
345
709
|
job.operation === MediaAttachmentJobOperation.Download ||
|
|
346
710
|
job.operation === MediaAttachmentJobOperation.DeleteRemote)) {
|
|
347
|
-
throw new Error(
|
|
348
|
-
|
|
711
|
+
throw new Error("Cannot process Signal Protocol media operation: remoteObjectStore is not " +
|
|
712
|
+
"configured on SignalProtocolClient.");
|
|
349
713
|
}
|
|
350
714
|
return {
|
|
351
|
-
remoteObjectStore
|
|
715
|
+
remoteObjectStore: job.operation === MediaAttachmentJobOperation.Upload
|
|
716
|
+
? this.uploadBrokerForJob(job, state, remoteObjectStore)
|
|
717
|
+
: remoteObjectStore,
|
|
352
718
|
transfer: options.transfer,
|
|
353
719
|
retry: options.retry,
|
|
354
720
|
policy: options.policy,
|
|
@@ -357,32 +723,93 @@ export class StorageBackedSignalProtocolClientMedia {
|
|
|
357
723
|
onCheckpoint: options.onCheckpoint,
|
|
358
724
|
loadUploadData: async (job) => {
|
|
359
725
|
const upload = state.uploads.get(job.jobId);
|
|
360
|
-
if (!upload
|
|
726
|
+
if (!upload) {
|
|
361
727
|
return null;
|
|
362
728
|
}
|
|
363
|
-
const
|
|
729
|
+
const preparedUploads = this.config?.preparedUploads;
|
|
730
|
+
if (!preparedUploads)
|
|
731
|
+
throw new Error("Configure media.preparedUploads with durable local file storage before uploading.");
|
|
732
|
+
let prepared = await preparedUploads.load(upload.requestId);
|
|
733
|
+
if (prepared) {
|
|
734
|
+
if (!preparedUploadMatchesQueue(upload, prepared) ||
|
|
735
|
+
(upload.preparedFingerprint !== undefined &&
|
|
736
|
+
(await preparedUploadFingerprint(prepared)) !==
|
|
737
|
+
upload.preparedFingerprint)) {
|
|
738
|
+
throw new Error("The saved upload preparation changed. Restore its original local record.");
|
|
739
|
+
}
|
|
740
|
+
if (upload.preparedFingerprint === undefined) {
|
|
741
|
+
upload.preparedFingerprint =
|
|
742
|
+
await preparedUploadFingerprint(prepared);
|
|
743
|
+
await this.saveState(state);
|
|
744
|
+
}
|
|
745
|
+
return { prepared, options: uploadOptionsFromStoredUpload(upload) };
|
|
746
|
+
}
|
|
747
|
+
else if (upload.preparedFingerprint !== undefined) {
|
|
748
|
+
throw new Error("The saved upload preparation is missing. Restore its original local record.");
|
|
749
|
+
}
|
|
750
|
+
if (!this.config?.loadLocalAttachment)
|
|
751
|
+
return null;
|
|
752
|
+
const draft = { ...upload, job };
|
|
753
|
+
delete draft.preparedFingerprint;
|
|
754
|
+
delete draft.preparationStarted;
|
|
755
|
+
delete draft.preparedAt;
|
|
756
|
+
delete draft.abandonment;
|
|
757
|
+
delete draft.remoteObjectId;
|
|
758
|
+
delete draft.transferCompletedAt;
|
|
759
|
+
delete draft.callbackDelivered;
|
|
760
|
+
const loaded = normalizeLoadedLocalAttachment(await this.config.loadLocalAttachment(draft));
|
|
364
761
|
if (!loaded) {
|
|
365
762
|
return null;
|
|
366
763
|
}
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
options
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
764
|
+
const storedOptions = uploadOptionsFromStoredUpload(upload);
|
|
765
|
+
for (const key of Object.keys(storedOptions)) {
|
|
766
|
+
if (loaded.options?.[key] !== undefined &&
|
|
767
|
+
JSON.stringify(loaded.options[key]) !==
|
|
768
|
+
JSON.stringify(storedOptions[key])) {
|
|
769
|
+
throw new Error("The attachment loader changed the queued upload input.");
|
|
770
|
+
}
|
|
771
|
+
}
|
|
772
|
+
if (loaded.data.length !== upload.size)
|
|
773
|
+
throw new Error("The attachment length differs from the queued upload.");
|
|
774
|
+
await this.saveState(state);
|
|
775
|
+
const candidate = await prepareMediaAttachmentUploadData(loaded.data, {
|
|
776
|
+
...loaded.options,
|
|
777
|
+
...storedOptions,
|
|
778
|
+
signal: options.signal,
|
|
779
|
+
onProgress: options.onProgress,
|
|
780
|
+
});
|
|
781
|
+
// Preserve intent if artifact persistence succeeds but its result is lost.
|
|
782
|
+
prepared = await preparedUploads.withExclusiveAccess(async () => {
|
|
783
|
+
upload.preparationStarted = true;
|
|
784
|
+
upload.preparedAt = candidate.preparedAt;
|
|
785
|
+
await this.saveState(state);
|
|
786
|
+
return preparedUploads.createIfAbsent(candidate);
|
|
787
|
+
});
|
|
788
|
+
if (!samePreparedUploadIntent(candidate, prepared, upload.clientUuid !== undefined)) {
|
|
789
|
+
throw new Error("The stored preparation belongs to different upload input.");
|
|
790
|
+
}
|
|
791
|
+
upload.preparedFingerprint = await preparedUploadFingerprint(prepared);
|
|
792
|
+
await this.saveState(state);
|
|
793
|
+
return { prepared, options: { ...loaded.options, ...storedOptions } };
|
|
374
794
|
},
|
|
795
|
+
loadUploadedAttachment: (job) => this.recoverCompletedUpload(job, state, remoteObjectStore, options),
|
|
375
796
|
loadAttachmentPointer: async (job) => state.pointers.get(job.jobId) ?? null,
|
|
376
797
|
saveUploadedAttachment: async (job, attachment) => {
|
|
377
798
|
const upload = state.uploads.get(job.jobId);
|
|
378
799
|
if (!upload) {
|
|
379
800
|
return;
|
|
380
801
|
}
|
|
802
|
+
if (upload.callbackDelivered)
|
|
803
|
+
return;
|
|
804
|
+
state.pointers.set(job.jobId, createMediaAttachmentPointer(attachment));
|
|
805
|
+
await this.saveState(state);
|
|
381
806
|
await this.config?.saveUploadedAttachment?.({
|
|
382
807
|
job,
|
|
383
808
|
localMediaId: upload.localMediaId,
|
|
384
809
|
attachment,
|
|
385
810
|
});
|
|
811
|
+
upload.callbackDelivered = true;
|
|
812
|
+
await this.saveState(state);
|
|
386
813
|
},
|
|
387
814
|
saveDownloadedAttachment: async (job, downloaded) => {
|
|
388
815
|
await this.config?.saveDownloadedAttachment?.({
|
|
@@ -408,7 +835,8 @@ export class StorageBackedSignalProtocolClientMedia {
|
|
|
408
835
|
state.pointers.delete(job.jobId);
|
|
409
836
|
}
|
|
410
837
|
normalizeJobs(jobs) {
|
|
411
|
-
return normalizeJobs(jobs, this.config?.maxJobs ??
|
|
838
|
+
return normalizeJobs(jobs, this.config?.maxJobs ??
|
|
839
|
+
SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_JOBS_DEFAULT);
|
|
412
840
|
}
|
|
413
841
|
async withStoreLock(operation) {
|
|
414
842
|
const previous = this.storeLock;
|
|
@@ -426,26 +854,44 @@ export class StorageBackedSignalProtocolClientMedia {
|
|
|
426
854
|
}
|
|
427
855
|
async updateState(mutator) {
|
|
428
856
|
await this.withStoreLock(async () => {
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
857
|
+
for (let attempt = 0; attempt < 16; attempt++) {
|
|
858
|
+
const state = await this.loadState();
|
|
859
|
+
mutator(state);
|
|
860
|
+
try {
|
|
861
|
+
await this.saveState(state);
|
|
862
|
+
return;
|
|
863
|
+
}
|
|
864
|
+
catch (error) {
|
|
865
|
+
if (!(error instanceof MediaQueueConcurrentUpdateError))
|
|
866
|
+
throw error;
|
|
867
|
+
}
|
|
868
|
+
}
|
|
869
|
+
throw new MediaQueueConcurrentUpdateError();
|
|
432
870
|
});
|
|
433
871
|
}
|
|
434
872
|
async loadState() {
|
|
435
873
|
const raw = await this.storage.getMetadata(SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_METADATA_KEY);
|
|
436
874
|
if (!raw) {
|
|
437
|
-
|
|
875
|
+
const state = { jobs: [], uploads: new Map(), pointers: new Map() };
|
|
876
|
+
this.queuePersistence.capture(state, raw);
|
|
877
|
+
return state;
|
|
438
878
|
}
|
|
439
879
|
try {
|
|
440
880
|
const parsed = JSON.parse(raw);
|
|
441
881
|
if (parsed.version !== 1) {
|
|
442
|
-
|
|
882
|
+
throw new Error("Invalid media queue version.");
|
|
443
883
|
}
|
|
884
|
+
if (!Array.isArray(parsed.jobs) ||
|
|
885
|
+
!isRecord(parsed.uploads) ||
|
|
886
|
+
!isRecord(parsed.pointers))
|
|
887
|
+
throw new Error("Invalid media queue structure.");
|
|
444
888
|
const uploads = new Map();
|
|
445
889
|
for (const [jobId, upload] of Object.entries(parsed.uploads ?? {})) {
|
|
446
890
|
if (isStoredUpload(upload)) {
|
|
447
891
|
uploads.set(jobId, upload);
|
|
448
892
|
}
|
|
893
|
+
else
|
|
894
|
+
throw new Error("Invalid media upload record.");
|
|
449
895
|
}
|
|
450
896
|
const pointers = new Map();
|
|
451
897
|
for (const [jobId, pointer] of Object.entries(parsed.pointers ?? {})) {
|
|
@@ -453,24 +899,46 @@ export class StorageBackedSignalProtocolClientMedia {
|
|
|
453
899
|
if (normalized) {
|
|
454
900
|
pointers.set(jobId, normalized);
|
|
455
901
|
}
|
|
902
|
+
else
|
|
903
|
+
throw new Error("Invalid media pointer record.");
|
|
456
904
|
}
|
|
457
|
-
|
|
458
|
-
|
|
905
|
+
for (const job of parsed.jobs) {
|
|
906
|
+
if (job.operation === MediaAttachmentJobOperation.Upload) {
|
|
907
|
+
const upload = uploads.get(job.jobId);
|
|
908
|
+
if (!upload ||
|
|
909
|
+
(upload.remoteObjectId !== undefined &&
|
|
910
|
+
!upload.preparedFingerprint) ||
|
|
911
|
+
(upload.transferCompletedAt !== undefined &&
|
|
912
|
+
!upload.remoteObjectId) ||
|
|
913
|
+
(pointers.has(job.jobId) &&
|
|
914
|
+
(upload.transferCompletedAt === undefined ||
|
|
915
|
+
pointers.get(job.jobId).storageId !==
|
|
916
|
+
upload.remoteObjectId)) ||
|
|
917
|
+
(upload.callbackDelivered && !pointers.has(job.jobId))) {
|
|
918
|
+
throw new Error("Incomplete media upload record.");
|
|
919
|
+
}
|
|
920
|
+
}
|
|
921
|
+
}
|
|
922
|
+
const state = {
|
|
923
|
+
jobs: this.normalizeJobs(parsed.jobs),
|
|
459
924
|
uploads,
|
|
460
925
|
pointers,
|
|
461
926
|
};
|
|
927
|
+
this.queuePersistence.capture(state, raw);
|
|
928
|
+
return state;
|
|
462
929
|
}
|
|
463
930
|
catch {
|
|
464
|
-
|
|
931
|
+
throw new Error("The saved media queue is invalid. Restore its original local state before retrying.");
|
|
465
932
|
}
|
|
466
933
|
}
|
|
467
934
|
async saveState(state) {
|
|
468
|
-
await this.
|
|
935
|
+
await this.queuePersistence.save(state, JSON.stringify({
|
|
469
936
|
version: 1,
|
|
470
937
|
jobs: this.normalizeJobs(state.jobs),
|
|
471
938
|
uploads: Object.fromEntries(state.uploads),
|
|
472
939
|
pointers: Object.fromEntries(state.pointers),
|
|
473
|
-
})
|
|
940
|
+
}), this.config?.maxJobs ??
|
|
941
|
+
SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_JOBS_DEFAULT, state.activeJobId, this.config?.maxPreparedUploadBytes);
|
|
474
942
|
}
|
|
475
943
|
}
|
|
476
944
|
//# sourceMappingURL=media.js.map
|