matrix-js-sdk 42.3.0 → 42.4.0

package/lib/rust-crypto/rust-crypto.js

@@ -179,12 +179,12 @@ export class RustCrypto extends TypedEventEmitter {
   async decryptEvent(event) {
     const roomId = event.getRoomId();
     if (!roomId) {
-      // presumably, a to-device message. These are normally decrypted in preprocessToDeviceMessages
+      // presumably, a to-device message. These are normally decrypted in processSyncChanges
       // so the fact it has come back here suggests that decryption failed.
       //
       // once we drop support for the libolm crypto implementation, we can stop passing to-device messages
       // through decryptEvent and hence get rid of this case.
-      throw new Error("to-device event was not decrypted in preprocessToDeviceMessages");
+      throw new Error("to-device event was not decrypted in processSyncChanges");
     }
     return await this.eventDecryptor.attemptEventDecryption(event, this.deviceIsolationMode);
   }
@@ -1353,33 +1353,26 @@ export class RustCrypto extends TypedEventEmitter {
   ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
   /**
-   * Apply sync changes to the olm machine
-   * @param events - the received to-device messages
-   * @param oneTimeKeysCounts - the received one time key counts
-   * @param unusedFallbackKeys - the received unused fallback keys
-   * @param devices - the received device list updates
-   * @returns A list of processed to-device messages.
+   * Implementation of {@link SyncCryptoCallbacks.processSyncChanges}.
+   *
+   * Passes all of the encryption-relevant data from a sync response to the OlmMachine in a single call, and
+   * post-processes the resulting to-device messages.
    */
-  async receiveSyncChanges({
-    events,
-    oneTimeKeysCounts = new Map(),
+  async processSyncChanges({
+    toDeviceEvents,
+    deviceLists,
+    oneTimeKeysCounts,
     unusedFallbackKeys,
-    devices = new RustSdkCryptoJs.DeviceLists()
+    useMsc4186 = false
   }) {
-    return await this.olmMachine.receiveSyncChanges(events ? JSON.stringify(events) : "[]", devices, oneTimeKeysCounts, unusedFallbackKeys);
-  }
-
-  /** called by the sync loop to preprocess incoming to-device messages
-   *
-   * @param events - the received to-device messages
-   * @returns A list of preprocessed to-device messages.
-   */
-  async preprocessToDeviceMessages(events) {
-    // send the received to-device messages into receiveSyncChanges. We have no info on device-list changes,
-    // one-time-keys, or fallback keys, so just pass empty data.
-    const processed = await this.receiveSyncChanges({
-      events
-    });
+    const events = JSON.stringify(toDeviceEvents);
+    const devices = new RustSdkCryptoJs.DeviceLists(deviceLists?.changed?.map(userId => new RustSdkCryptoJs.UserId(userId)), deviceLists?.left?.map(userId => new RustSdkCryptoJs.UserId(userId)));
+    const counts = new Map(Object.entries(oneTimeKeysCounts ?? {}));
+    const fallbackKeys = unusedFallbackKeys && new Set(unusedFallbackKeys);
+
+    // The two variants differ only in how they treat a missing one-time key count: zero keys on the server (sync
+    // v2) versus unchanged (sliding sync).
+    const processed = useMsc4186 ? await this.olmMachine.receiveSyncChangesMsc4186(events, devices, counts, fallbackKeys) : await this.olmMachine.receiveSyncChanges(events, devices, counts, fallbackKeys);
     const received = [];
     for (const message of processed) {
       const parsedMessage = JSON.parse(message.rawEvent);
@@ -1450,34 +1443,6 @@ export class RustCrypto extends TypedEventEmitter {
     return received;
   }
 
-  /** called by the sync loop to process one time key counts and unused fallback keys
-   *
-   * @param oneTimeKeysCounts - the received one time key counts
-   * @param unusedFallbackKeys - the received unused fallback keys
-   */
-  async processKeyCounts(oneTimeKeysCounts, unusedFallbackKeys) {
-    const mapOneTimeKeysCount = oneTimeKeysCounts && new Map(Object.entries(oneTimeKeysCounts));
-    const setUnusedFallbackKeys = unusedFallbackKeys && new Set(unusedFallbackKeys);
-    if (mapOneTimeKeysCount !== undefined || setUnusedFallbackKeys !== undefined) {
-      await this.receiveSyncChanges({
-        oneTimeKeysCounts: mapOneTimeKeysCount,
-        unusedFallbackKeys: setUnusedFallbackKeys
-      });
-    }
-  }
-
-  /** called by the sync loop to process the notification that device lists have
-   * been changed.
-   *
-   * @param deviceLists - device_lists field from /sync
-   */
-  async processDeviceLists(deviceLists) {
-    const devices = new RustSdkCryptoJs.DeviceLists(deviceLists.changed?.map(userId => new RustSdkCryptoJs.UserId(userId)), deviceLists.left?.map(userId => new RustSdkCryptoJs.UserId(userId)));
-    await this.receiveSyncChanges({
-      devices
-    });
-  }
-
   /** called by the sync loop on m.room.encryption events
    *
    * @param room - in which the event was received