fix: establish groups pending join if epoch is 0 - WPB-22496 🍒 🍒

wire-ios-data-model/Source/MLS/MLSService.swift

@@ -50,7 +50,7 @@
 public final class MLSService: MLSServiceInterface {
 
     // MARK: - Properties
 
     private weak var context: NSManagedObjectContext?
     private var notificationContext: any NotificationContext
     private let coreCryptoProvider: CoreCryptoProviderProtocol
@@ -829,7 +829,7 @@
         pendingGroup: ZMConversation,
         context: NSManagedObjectContext
     ) async throws {
         let mlsUsers = await context.perform {
             pendingGroup.localParticipants.map {
                 MLSUser(from: $0, localDomain: self.localDomain)
             }
@@ -840,7 +840,7 @@
             with: mlsUsers
         )
 
         await context.perform {
             pendingGroup.ciphersuite = ciphersuite
             pendingGroup.mlsStatus = .ready
         }
@@ -862,19 +862,19 @@
 
         let needToSave = await withTaskGroup(of: Bool.self) { group in
             for pendingGroup in pendingGroups {
                 group.addTask {
                     guard let mlsGroupID = await context.perform({ pendingGroup.mlsGroupID }) else {
                         return false
                     }
 
                     do {
-                        let (epoch, isSelfConversation) = await context.perform {
-                            (pendingGroup.epoch, pendingGroup.isSelfConversation)
+                        let epoch = await context.perform {
+                            pendingGroup.epoch
                         }
                         let conversationExists = try await self.conversationExists(
                             groupID: mlsGroupID
                         )
-                        let shouldEstablishGroup = epoch == 0 && isSelfConversation && !conversationExists
+                        let shouldEstablishGroup = epoch == 0 && !conversationExists
 
                         if shouldEstablishGroup {
                             try await self.internalEstablishPendingGroup(
@@ -1077,7 +1077,7 @@
         in conversation: ZMConversation,
         context: NSManagedObjectContext
     ) async {
         await context.perform {
             conversation.appendNewPotentialGapSystemMessage(
                 users: conversation.localParticipants,
                 timestamp: Date()
@@ -1163,7 +1163,7 @@
             }
             return outOfSyncConversations
         }
         return await context.perform {
             conversations.compactMap {
                 if let groupId = $0.mlsGroupID {
                     (groupId, $0)
@@ -1183,11 +1183,11 @@
         var groupID: MLSGroupID?
         var epoch: UInt64?
 
         await context.perform {
             if let subgroup {
                 groupID = subgroup.groupID
                 epoch = UInt64(subgroup.epoch)
             } else {
                 groupID = conversation.mlsGroupID
                 epoch = conversation.epoch
             }
@@ -1317,7 +1317,7 @@
         var conversation: ZMConversation?
         var qualifiedID: QualifiedID?
         var epoch: UInt64 = 0
         await context.perform {
             conversation = ZMConversation.fetch(with: groupID, in: context)
             qualifiedID = conversation?.qualifiedID
             epoch = conversation?.epoch ?? 0
@@ -1911,7 +1911,7 @@
         for conversation in groupConversations {
 
             let (qualifiedID, members) = await context.perform {
                 (
                     conversation.qualifiedID,
                     conversation.localParticipants.map { MLSUser(from: $0, localDomain: self.localDomain) }
                 )
@@ -1936,7 +1936,7 @@
                     context: context.notificationContext
                 )
 
                 // create MLS group and update keying material
                 let mlsGroupID = await context.perform { conversation.mlsGroupID }
                 guard let mlsGroupID else {
                     logger.warn("failed to convert conversation \(qualifiedID), `mlsGroupID` is `nil`")

wire-ios-data-model/Tests/MLS/MLSServiceTests.swift

@@ -330,7 +330,7 @@
 
     func test_Decrypt_RepairsConversationOnWrongEpochError() async throws {
         // Given
         let conversation = await uiMOC.perform { self.createConversation(outOfSync: true).conversation }
         guard let groupID = await uiMOC.perform({ conversation.mlsGroupID }) else {
             XCTFail("no groupId")
             return
@@ -343,7 +343,7 @@
         let expectation = XCTestExpectation(description: "repaired conversation")
         await uiMOC.perform {
             self.setMocksForConversationRepair(
                 parentGroupID: groupID,
                 epoch: conversation.epoch - 1,
                 onJoinGroup: { joinedGroupID in
                     XCTAssertEqual(groupID, joinedGroupID)
@@ -361,7 +361,7 @@
         )
 
         // Then
         await fulfillment(of: [expectation], timeout: 1)
         _ = waitForAllGroupsToBeEmpty(withTimeout: 0.5)
     }
 
@@ -584,7 +584,7 @@
             conversation.mlsStatus = .pendingJoinAfterReset
             return conversation
         }
 
         let mlsSelfUser = await uiMOC.perform {
             MLSUser(from: self.selfUser, localDomain: self.localDomain)
         }
@@ -611,7 +611,7 @@
 
         // THEN
         try XCTAssertCount(mockActionsProvider.syncConversationQualifiedIDContext_Invocations, count: 1)
         await uiMOC.perform {
             XCTAssertEqual(conversation.mlsStatus, .ready)
         }
     }
@@ -788,7 +788,7 @@
         let futureCommitDate = Date().addingTimeInterval(2)
 
         await uiMOC.perform { [self] in
             // A group with pending proposal in the future
             conversation = createConversation(in: uiMOC)
             conversation.mlsGroupID = groupID
             conversation.commitPendingProposalDate = futureCommitDate
@@ -826,7 +826,7 @@
         // Then we committed pending proposals.
         XCTAssertEqual(mockCommitPendingProposalsArgument, [groupID])
 
         await uiMOC.perform {
             XCTAssertNil(conversation.commitPendingProposalDate)
         }
 
@@ -944,7 +944,7 @@
         let futureCommitDate = Date().addingTimeInterval(2)
 
         await uiMOC.perform { [self] in
             // A group with pending proposal in the future
             conversation = createConversation(in: uiMOC)
             conversation.mlsGroupID = groupID
             conversation.commitPendingProposalDate = futureCommitDate
@@ -975,7 +975,7 @@
         // Then we committed pending proposals.
         XCTAssertEqual(mockCommitPendingProposalsArgument, [groupID])
 
         await uiMOC.perform {
             XCTAssertNil(conversation.commitPendingProposalDate)
         }
 
@@ -1023,7 +1023,35 @@
 
     // MARK: - Joining conversations
 
-    func test_PerformPendingJoins_It_Establishes_Group() async throws {
+    func test_PerformPendingJoins_It_Establishes_Group_SelfConversation() async throws {
+        try await assert_PerformPendingJoins_It_Establishes_Group(
+            conversationType: .`self`,
+            file: #file,
+            line: #line
+        )
+    }
+
+    func test_PerformPendingJoins_It_Establishes_Group_OneOnOne() async throws {
+        try await assert_PerformPendingJoins_It_Establishes_Group(
+            conversationType: .oneOnOne,
+            file: #file,
+            line: #line
+        )
+    }
+
+    func test_PerformPendingJoins_It_Establishes_Group_Group() async throws {
+        try await assert_PerformPendingJoins_It_Establishes_Group(
+            conversationType: .group,
+            file: #file,
+            line: #line
+        )
+    }
+
+    func assert_PerformPendingJoins_It_Establishes_Group(
+        conversationType: ZMConversationType,
+        file: StaticString = #file,
+        line: UInt = #line
+    ) async throws {
         // Given
         let groupID = MLSGroupID.random()
         let conversationID = UUID.create()
@@ -1033,9 +1061,13 @@
             conversation.remoteIdentifier = conversationID
             conversation.domain = domain
             conversation.mlsGroupID = groupID
-            conversation.mlsStatus = .pendingJoin
-            conversation.conversationType = .`self`
             conversation.messageProtocol = .mls
+            conversation.mlsStatus = .pendingJoin
+            conversation.conversationType = conversationType
+
+            // Only epoch 0 leads to establishing group
+            conversation.epoch = 0
+
             return conversation
         }
 
@@ -1055,17 +1087,17 @@
         // it creates CC conversation
         let createCoreCryptoConversationInvocations = mockCoreCryptoContext
             .createConversationConversationIdCreatorCredentialTypeConfig_Invocations
-        XCTAssertEqual(createCoreCryptoConversationInvocations.count, 1)
+        XCTAssertEqual(createCoreCryptoConversationInvocations.count, 1, file: file, line: line)
 
         // it commits pending proposals
-        XCTAssertEqual(mockMLSActionExecutor.commitPendingProposalsCount, 1)
+        XCTAssertEqual(mockMLSActionExecutor.commitPendingProposalsCount, 1, file: file, line: line)
 
         // it updates key material
-        XCTAssertEqual(mockMLSActionExecutor.updateKeyMaterialCount, 1)
+        XCTAssertEqual(mockMLSActionExecutor.updateKeyMaterialCount, 1, file: file, line: line)
 
         // it sets conversation state to ready
         let conversationMLSStatus = await uiMOC.perform { conversation.mlsStatus }
-        XCTAssertEqual(conversationMLSStatus, .ready)
+        XCTAssertEqual(conversationMLSStatus, .ready, file: file, line: line)
     }
 
     func test_PerformPendingJoins_IsSuccessful() async throws {
@@ -1114,7 +1146,7 @@
         XCTAssertEqual(joinGroupArguments.first?.groupID, groupID)
         XCTAssertEqual(joinGroupArguments.first?.groupState, publicGroupState)
 
         // it sets conversation state to ready
         let conversationMLSStatus = await uiMOC.perform { conversation.mlsStatus }
         XCTAssertEqual(conversationMLSStatus, .ready)
     }
@@ -1180,7 +1212,7 @@
         // it asks executor to join group
         XCTAssertEqual(joinGroupCount, shouldRetry ? 2 : 1, file: file, line: line)
 
         // it sets conversation state to ready
         let conversationMLSStatus = await uiMOC.perform { conversation.mlsStatus }
         XCTAssertEqual(conversationMLSStatus, shouldRetry ? .ready : .pendingJoin, file: file, line: line)
     }
@@ -1266,7 +1298,7 @@
 
     func test_FetchAndRepairConversation_RejoinsOutOfSyncConversation() async throws {
         // GIVEN
         let conversation = await uiMOC.perform { self.createConversation(outOfSync: true).conversation }
         guard let groupID = await uiMOC.perform({ conversation.mlsGroupID }) else {
             XCTFail("missing groupID")
             return
@@ -1277,7 +1309,7 @@
 
         await uiMOC.perform { [self] in
             setMocksForConversationRepair(
                 parentGroupID: groupID,
                 epoch: conversation.epoch - 1,
                 onJoinGroup: { joinedGroupID in
                     XCTAssertEqual(groupID, joinedGroupID)
@@ -1297,7 +1329,7 @@
 
     func test_FetchAndRepairConversation_DoesNothingIfConversationIsNotOutOfSync() async throws {
         // GIVEN
         let conversation = await uiMOC.perform { self.createConversation(outOfSync: true).conversation }
         guard let groupID = await uiMOC.perform({ conversation.mlsGroupID }) else {
             XCTFail("missing groupID")
             return
@@ -1310,7 +1342,7 @@
 
         await uiMOC.perform { [self] in
             setMocksForConversationRepair(
                 parentGroupID: groupID,
                 epoch: conversation.epoch,
                 onJoinGroup: { _ in
                     expectation.fulfill()
@@ -1327,13 +1359,13 @@
 
     func test_FetchAndRepairConversation_RejoinsOutOfSyncSubgroup() async throws {
         // GIVEN
         let conversation = await uiMOC.perform { self.createConversation(outOfSync: true).conversation }
         guard let groupID = await uiMOC.perform({ conversation.mlsGroupID }) else {
             XCTFail("missing groupID")
             return
         }
         mockSyncDelegate.recoverWithIncrementalSync_MockMethod = {}
         let subgroupID = MLSGroupID.random()
         let qualifiedID = await uiMOC.perform { conversation.qualifiedID }
 
         let subgroup = MLSSubgroup(
@@ -1368,13 +1400,13 @@
 
     func test_FetchAndRepairConversation_DoesNothingIfSubgroupIsNotOutOfSync() async throws {
         // GIVEN
         let conversation = await uiMOC.perform { self.createConversation(outOfSync: true).conversation }
         guard let groupID = await uiMOC.perform({ conversation.mlsGroupID }) else {
             XCTFail("missing groupID")
             return
         }
         mockSyncDelegate.recoverWithIncrementalSync_MockMethod = {}
         let subgroupID = MLSGroupID.random()
         let qualifiedID = await uiMOC.perform { conversation.qualifiedID }
 
         let subgroup = MLSSubgroup(
@@ -2817,7 +2849,7 @@
         var conversation: ZMConversation!
 
         await uiMOC.perform { [self] in
             // A group with pending proposal in the future
             conversation = createConversation(in: uiMOC)
             conversation.mlsGroupID = groupID
             conversation.messageProtocol = .mls
@@ -2864,7 +2896,7 @@
         var conversation: ZMConversation!
 
         await uiMOC.perform { [self] in
             // A group with pending proposal in the future
             conversation = createConversation(in: uiMOC)
             conversation.mlsGroupID = groupID
             conversation.messageProtocol = .mls
@@ -2922,7 +2954,7 @@
             XCTestExpectation(description: "updateConversationProtocol must be called")
         mockActionsProvider
             .updateConversationProtocolQualifiedIDMessageProtocolContext_MockMethod =
             { [uiMOC] qualifiedID, messageProtocol, notificationContext in
                 XCTAssertEqual(qualifiedID, uiMOC.performAndWait { conversation.qualifiedID })
                 XCTAssertEqual(messageProtocol, .mixed)
                 XCTAssert(notificationContext === uiMOC.notificationContext)
@@ -2930,7 +2962,7 @@
             }
 
         let syncConversationExpectation = XCTestExpectation(description: "updateLocalConversation must be called")
         mockActionsProvider.syncConversationQualifiedIDContext_MockMethod = { [uiMOC] qualifiedID, _ in
             XCTAssertEqual(qualifiedID, uiMOC.performAndWait { conversation.qualifiedID })
             syncConversationExpectation.fulfill()
         }
@@ -2943,7 +2975,7 @@
             }
 
         let updateKeyMaterialExpectation = XCTestExpectation(description: "updateKeyMaterial must be called")
         mockMLSActionExecutor.mockUpdateKeyMaterial = { [self] mlsGroupID in
             XCTAssertEqual(mlsGroupID, uiMOC.performAndWait { conversation.mlsGroupID })
             updateKeyMaterialExpectation.fulfill()
         }