Import progress for room keys with Crypto V2

MatrixSDK/Crypto/KeyBackup/Engine/MXCryptoKeyBackupEngine.swift

@@ -21,11 +21,21 @@ import Foundation
 import MatrixSDKCrypto
 
 class MXCryptoKeyBackupEngine: NSObject, MXKeyBackupEngine {
+    // Batch size chosen arbitrarily, will be moved to CryptoSDK
+    private static let ImportBatchSize = 1000
+
+    struct EncryptedSession {
+        let roomId: String
+        let sessionId: String
+        let keyBackup: MXKeyBackupData
+    }
+
     enum Error: Swift.Error {
         case unknownBackupVersion
         case invalidData
         case invalidPrivateKey
         case algorithmNotSupported(String)
+        case importAlreadyInProgress
     }
 
     var enabled: Bool {
@@ -43,6 +53,7 @@ class MXCryptoKeyBackupEngine: NSObject, MXKeyBackupEngine {
     private let backup: MXCryptoBackup
     private let roomEventDecryptor: MXRoomEventDecrypting
     private let log = MXNamedLog(name: "MXCryptoKeyBackupEngine")
+    private var activeImportProgress: Progress?
 
     init(backup: MXCryptoBackup, roomEventDecryptor: MXRoomEventDecrypting) {
         self.backup = backup
@@ -221,8 +232,11 @@ class MXCryptoKeyBackupEngine: NSObject, MXKeyBackupEngine {
 
         let progress = Progress(totalUnitCount: counts.total)
         progress.completedUnitCount = counts.backedUp
-
-        log.debug("Backed up \(progress.completedUnitCount) out of \(progress.totalUnitCount) keys")
+        if progress.isFinished {
+            log.debug("All keys are backed up")
+        } else {
+            log.debug("Backed up \(progress.completedUnitCount) out of \(progress.totalUnitCount) keys")
+        }
         return progress
     }
 
@@ -254,62 +268,68 @@ class MXCryptoKeyBackupEngine: NSObject, MXKeyBackupEngine {
         success: @escaping (UInt, UInt) -> Void,
         failure: @escaping (Swift.Error) -> Void
     ) {
+        guard activeImportProgress == nil else {
+            log.failure("Another import is already ongoing")
+            failure(Error.importAlreadyInProgress)
+            return
+        }
+
+        let recoveryKey: BackupRecoveryKey
+        do {
+            let key = MXRecoveryKey.encode(privateKey)
+            recoveryKey = try BackupRecoveryKey.fromBase58(key: key)
+        } catch {
+            log.error("Failed creating recovery key")
+            failure(Error.invalidPrivateKey)
+            return
+        }
+
         Task(priority: .medium) {
-
-            let count = keysBackupData.rooms
-                .map { roomId, room in
-                    room.sessions.count
+            let encryptedSessions = keysBackupData.rooms.flatMap { roomId, room in
+                room.sessions.map { sessionId, keyBackup in
+                    EncryptedSession(roomId: roomId, sessionId: sessionId, keyBackup: keyBackup)
                 }
-                .reduce(0, +)
+            }
 
+            let count = encryptedSessions.count
+            activeImportProgress = Progress(totalUnitCount: Int64(count))
             log.debug("Importing \(count) encrypted sessions")
 
-            let recoveryKey: BackupRecoveryKey
-            do {
-                let key = MXRecoveryKey.encode(privateKey)
-                recoveryKey = try BackupRecoveryKey.fromBase58(key: key)
-            } catch {
-                log.error("Failed creating recovery key")
-                failure(Error.invalidPrivateKey)
-                return
-            }
-
-            let date1 = Date()
+            let date = Date()
 
-            let sessions = keysBackupData.rooms
-                .flatMap { roomId, room in
-                    room.sessions
-                        .compactMap { sessionId, keyBackup in
-                            decrypt(
-                                keyBackupData:keyBackup,
-                                keyBackupVersion: keyBackupVersion,
-                                recoveryKey: recoveryKey,
-                                forSession: sessionId,
-                                inRoom: roomId
-                            )
-                        }
+            for batchIndex in stride(from: 0, to: count, by: Self.ImportBatchSize) {
+                log.debug("Decrypting and importing batch \(batchIndex)")
+                let endIndex = min(batchIndex + Self.ImportBatchSize, count)
+                let batch = encryptedSessions[batchIndex ..< endIndex]
+
+                autoreleasepool {
+                    let sessions = batch.compactMap {
+                        decrypt(
+                            keyBackupData: $0.keyBackup,
+                            keyBackupVersion: keyBackupVersion,
+                            recoveryKey: recoveryKey,
+                            forSession: $0.sessionId,
+                            inRoom: $0.roomId
+                        )
+                    }
+
+                    do {
+                        let result = try backup.importDecryptedKeys(roomKeys: sessions, progressListener: self)
+                        activeImportProgress?.completedUnitCount += Int64(result.imported)
+                    } catch {
+                        log.error("Failed importing batch of sessions", context: error)
+                    }
                 }
+                await roomEventDecryptor.retryUndecryptedEvents(sessionIds: batch.map(\.sessionId))
+            }
 
-            let duration1 = Date().timeIntervalSince(date1) * 1000
-            log.debug("Decrypted \(sessions.count) sessions in \(duration1) ms")
-
-            let date2 = Date()
+            let imported = activeImportProgress?.completedUnitCount ?? 0
+            let duration = Date().timeIntervalSince(date) * 1000
+            log.debug("Successfully imported \(imported) out of \(count) sessions in \(duration) ms")
+            activeImportProgress = nil
 
-            do {
-                let result = try backup.importDecryptedKeys(roomKeys: sessions, progressListener: self)
-                await roomEventDecryptor.retryUndecryptedEvents(sessionIds: sessions.map(\.sessionId))
-
-                let duration2 = Date().timeIntervalSince(date2) * 1000
-                log.debug("Successfully imported \(result.imported) out of \(result.total) sessions in \(duration2) ms")
-
-                await MainActor.run {
-                    success(UInt(result.total), UInt(result.imported))
-                }
-            } catch {
-                log.error("Failed importing sessions", context: error)
-                await MainActor.run {
-                    failure(error)
-                }
+            await MainActor.run {
+                success(UInt(count), UInt(imported))
             }
         }
     }
@@ -362,6 +382,10 @@ class MXCryptoKeyBackupEngine: NSObject, MXKeyBackupEngine {
         return try backup.exportRoomKeys(passphrase: passphrase)
     }
 
+    func importProgress() -> Progress? {
+        return activeImportProgress
+    }
+
     func importRoomKeys(_ data: Data, passphrase: String) async throws -> KeysImportResult {
         let result = try backup.importRoomKeys(data, passphrase: passphrase, progressListener: self)
         let sessionIds = result.keys
@@ -388,7 +412,7 @@ class MXCryptoKeyBackupEngine: NSObject, MXKeyBackupEngine {
 
 extension MXCryptoKeyBackupEngine: ProgressListener {
     func onProgress(progress: Int32, total: Int32) {
-        log.debug("Backup / export progress \(progress) of \(total) total")
+        // Progress loggged manually via `activeImportProgress`
     }
 }
 

MatrixSDK/Crypto/KeyBackup/Engine/MXKeyBackupEngine.h

@@ -125,7 +125,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (BOOL)hasKeysToBackup;
 
 /**
- The ratio of total vs backed up keys
+ The ratio of backed up vs total keys
  */
 - (NSProgress *)backupProgress;
 
@@ -135,6 +135,11 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)backupKeysWithSuccess:(void (^)(void))success
                       failure:(void (^)(NSError *error))failure;
 
+/**
+ The ratio of imported vs total keys or nil if not actively importing keys
+ */
+- (nullable NSProgress *)importProgress;
+
 /**
  Import encypted backup keys
  */

MatrixSDK/Crypto/KeyBackup/Engine/MXNativeKeyBackupEngine.m

@@ -531,6 +531,12 @@ - (void)backupKeysWithSuccess:(void (^)(void))success
     } failure:failure];
 }
 
+- (NSProgress *)importProgress
+{
+    // Not implemented for legacy backup
+    return nil;
+}
+
 - (void)importKeysWithKeysBackupData:(MXKeysBackupData *)keysBackupData
                           privateKey:(NSData *)privateKey
                     keyBackupVersion:(MXKeyBackupVersion *)keyBackupVersion

MatrixSDK/Crypto/KeyBackup/MXKeyBackup.h

@@ -305,6 +305,10 @@ FOUNDATION_EXPORT NSString *const kMXKeyBackupDidStateChangeNotification;
 */
 @property (nonatomic, readonly) BOOL hasPrivateKeyInCryptoStore;
 
+/**
+ The ratio of imported vs total keys or nil if not actively importing keys
+ */
+@property (nullable, nonatomic, readonly) NSProgress *importProgress;
 
 #pragma mark - Backup trust
 

MatrixSDK/Crypto/KeyBackup/MXKeyBackup.m

@@ -859,6 +859,11 @@ - (BOOL)hasPrivateKeyInCryptoStore
     return self.engine.privateKey != nil;
 }
 
+- (NSProgress *)importProgress
+{
+    return self.engine.importProgress;
+}
+
 #pragma mark - Backup trust
 
 - (void)trustForKeyBackupVersion:(MXKeyBackupVersion *)keyBackupVersion onComplete:(void (^)(MXKeyBackupVersionTrust * _Nonnull))onComplete

changelog.d/pr-1637.change

@@ -0,0 +1 @@
+CryptoV2: Import progress for room keys