From e5216ffe7cf8abc51f382872ad4293e00066687d Mon Sep 17 00:00:00 2001
From: Niels Andriesse <andriesseniels@gmail.com>
Date: Fri, 16 Apr 2021 09:40:54 +1000
Subject: [PATCH] Add documentation

---
 .../MessageReceiver+Handling.swift             | 18 ++++++++++++++----
 .../MessageSender+ClosedGroups.swift           |  2 +-
 2 files changed, 15 insertions(+), 5 deletions(-)

diff --git a/SessionMessagingKit/Sending & Receiving/MessageReceiver+Handling.swift b/SessionMessagingKit/Sending & Receiving/MessageReceiver+Handling.swift
index 80843b0e4..a85e4b45c 100644
--- a/SessionMessagingKit/Sending & Receiving/MessageReceiver+Handling.swift	
+++ b/SessionMessagingKit/Sending & Receiving/MessageReceiver+Handling.swift	
@@ -411,6 +411,8 @@ extension MessageReceiver {
         let _ = PushNotificationAPI.performOperation(.subscribe, for: groupPublicKey, publicKey: getUserHexEncodedPublicKey())
     }
 
+    /// Extracts and adds the new encryption key pair to our list of key pairs if there is one for our public key, AND the message was
+    /// sent by the group admin.
     private static func handleClosedGroupEncryptionKeyPair(_ message: ClosedGroupControlMessage, using transaction: Any) {
         // Prepare
         guard case let .encryptionKeyPair(explicitGroupPublicKey, wrappers) = message.kind,
@@ -482,6 +484,9 @@ extension MessageReceiver {
             let newGroupModel = TSGroupModel(title: group.groupName, memberIds: [String](members), image: nil, groupId: groupID, groupType: .closedGroup, adminIds: group.groupAdminIds)
             thread.setGroupModel(newGroupModel, with: transaction)
             // Send the latest encryption key pair to the added members if the current user is the admin of the group
+            // FIXME: Is this still needed? I believe this was to fix a race condition, where someone might add a
+            // member to a group when they don't have the latest key pair. The admin would then be able to send the
+            // added user the latest key pair later. Not sure if that race condition still exists though.
             let isCurrentUserAdmin = group.groupAdminIds.contains(getUserHexEncodedPublicKey())
             if isCurrentUserAdmin {
                 for member in membersAsData.map({ $0.toHexString() }) {
@@ -496,6 +501,11 @@ extension MessageReceiver {
         }
     }
  
+    /// Removes the given members from the group IF
+    /// • it wasn't the admin that was removed (that should happen through a `MEMBER_LEFT` message).
+    /// • the admin sent the message (only the admin can truly remove members).
+    /// If we're among the users that were removed, delete all encryption key pairs and the group public key, unsubscribe
+    /// from push notifications for this closed group, and remove the given members from the zombie list for this group.
     private static func handleClosedGroupMembersRemoved(_ message: ClosedGroupControlMessage, using transaction: Any) {
         guard case let .membersRemoved(membersAsData) = message.kind else { return }
         let transaction = transaction as! YapDatabaseReadWriteTransaction
@@ -534,6 +544,10 @@ extension MessageReceiver {
         }
     }
     
+    /// If a regular member left:
+    /// • Mark them as a zombie (to be removed by the admin later).
+    /// If the admin left:
+    /// • Unsubscribe from PNs, delete the group public key, etc. as the group will be disbanded.
     private static func handleClosedGroupMemberLeft(_ message: ClosedGroupControlMessage, using transaction: Any) {
         guard case .memberLeft = message.kind else { return }
         let transaction = transaction as! YapDatabaseReadWriteTransaction
@@ -541,10 +555,6 @@ extension MessageReceiver {
         performIfValid(for: message, using: transaction) { groupID, thread, group in
             let didAdminLeave = group.groupAdminIds.contains(message.sender!)
             let members: Set<String> = didAdminLeave ? [] : Set(group.groupMemberIds).subtracting([ message.sender! ]) // If the admin leaves the group is disbanded
-            // If a regular member left:
-            // • Mark them as a zombie (to be removed by the admin later)
-            // If the admin left:
-            // • Unsubscribe from PNs, delete the group public key, etc. as the group will be disbanded
             if didAdminLeave {
                 // Remove the group from the database and unsubscribe from PNs
                 Storage.shared.removeAllClosedGroupEncryptionKeyPairs(for: groupPublicKey, using: transaction)
diff --git a/SessionMessagingKit/Sending & Receiving/MessageSender+ClosedGroups.swift b/SessionMessagingKit/Sending & Receiving/MessageSender+ClosedGroups.swift
index 066afc7dd..622e2e22b 100644
--- a/SessionMessagingKit/Sending & Receiving/MessageSender+ClosedGroups.swift	
+++ b/SessionMessagingKit/Sending & Receiving/MessageSender+ClosedGroups.swift	
@@ -296,6 +296,7 @@ extension MessageSender {
         let closedGroupControlMessage = ClosedGroupControlMessage(kind: .encryptionKeyPairRequest)
         MessageSender.send(closedGroupControlMessage, in: thread, using: transaction)
     }
+     */
     
     public static func sendLatestEncryptionKeyPair(to publicKey: String, for groupPublicKey: String, using transaction: YapDatabaseReadWriteTransaction) {
         // Check that the user in question is part of the closed group
@@ -321,5 +322,4 @@ extension MessageSender {
         let closedGroupControlMessage = ClosedGroupControlMessage(kind: .encryptionKeyPair(publicKey: Data(hex: groupPublicKey), wrappers: [ wrapper ]))
         MessageSender.send(closedGroupControlMessage, in: contactThread, using: transaction)
     }
-     */
 }