From 603476f95cf2220c8ea0d1b52ad1a5501382e673 Mon Sep 17 00:00:00 2001
From: Lawrence Forooghian <lawrence@forooghian.com>
Date: Wed, 13 Nov 2024 10:43:35 -0300
Subject: [PATCH] Split attachment & detachment cycles into methods
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

We’ll use these when we implement the RETRY operation in #51.

References to CHA-RL5* points are based on spec at 8ff947d.
---
 Sources/AblyChat/RoomLifecycleManager.swift | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/Sources/AblyChat/RoomLifecycleManager.swift b/Sources/AblyChat/RoomLifecycleManager.swift
index a6dc72bc..de1dedf8 100644
--- a/Sources/AblyChat/RoomLifecycleManager.swift
+++ b/Sources/AblyChat/RoomLifecycleManager.swift
@@ -532,7 +532,7 @@ internal actor DefaultRoomLifecycleManager<Contributor: RoomLifecycleContributor
 
     /// Whether the room lifecycle manager currently has a room lifecycle operation in progress.
     ///
-    /// - Warning: I haven’t yet figured out the exact meaning of “has an operation in progress” — at what point is an operation considered to be no longer in progress? Is it the point at which the operation has updated the manager’s status to one that no longer indicates an in-progress operation (this is the meaning currently used by `hasOperationInProgress`)? Or is it the point at which the `bodyOf*Operation` method for that operation exits (i.e. the point at which ``performAnOperation(_:)`` considers the operation to have completed)? Does it matter? I’ve chosen to not think about this very much right now, but might need to revisit. See TODO against `emitPendingDiscontinuityEvents` in `bodyOfDetachOperation` for an example of something where these two notions of “has an operation in progress” are not equivalent.
+    /// - Warning: I haven’t yet figured out the exact meaning of “has an operation in progress” — at what point is an operation considered to be no longer in progress? Is it the point at which the operation has updated the manager’s status to one that no longer indicates an in-progress operation (this is the meaning currently used by `hasOperationInProgress`)? Or is it the point at which the `bodyOf*Operation` method for that operation exits (i.e. the point at which ``performAnOperation(_:)`` considers the operation to have completed)? Does it matter? I’ve chosen to not think about this very much right now, but might need to revisit. See TODO against `emitPendingDiscontinuityEvents` in `performAttachmentCycle` for an example of something where these two notions of “has an operation in progress” are not equivalent.
     private var hasOperationInProgress: Bool {
         status.operationID != nil
     }
@@ -687,6 +687,11 @@ internal actor DefaultRoomLifecycleManager<Contributor: RoomLifecycleContributor
         // CHA-RL1e
         changeStatus(to: .attachingDueToAttachOperation(attachOperationID: operationID))
 
+        try await performAttachmentCycle()
+    }
+
+    /// Performs the “CHA-RL1e attachment cycle”, to use the terminology of CHA-RL5f.
+    private func performAttachmentCycle() async throws {
         // CHA-RL1f
         for contributor in contributors {
             do {
@@ -806,6 +811,11 @@ internal actor DefaultRoomLifecycleManager<Contributor: RoomLifecycleContributor
         clearTransientDisconnectTimeouts()
         changeStatus(to: .detaching(detachOperationID: operationID))
 
+        try await performDetachmentCycle()
+    }
+
+    /// Performs the “CHA-RL2f detachment cycle”, to use the terminology of CHA-RL5a.
+    private func performDetachmentCycle() async throws {
         // CHA-RL2f
         var firstDetachError: Error?
         for contributor in contributors {