refactor(subscribe): wait for subscribe cancellation before other sub…

…scribe actions
pubnub · Jun 26, 2024 · 74c7af1 · 74c7af1
1 parent 8561b9d
commit 74c7af1
Show file tree

Hide file tree

Showing 8 changed files with 71 additions and 501 deletions.
diff --git a/PubNub/Core/PubNub+Core.m b/PubNub/Core/PubNub+Core.m
@@ -94,6 +94,8 @@ @interface PubNub () <PN_CORE_PROTOCOLS>
 
 #pragma mark - Properties
 
+// Handler which will be called when subscribe request will be cancelled.
+@property(strong, nullable, nonatomic) dispatch_block_t subscribeCancellationHandler;
 /// Resources access lock.
 @property(strong, nonatomic) PNLock *lock;
 #ifndef PUBNUB_DISABLE_LOGGER
@@ -318,7 +320,7 @@ - (void)copyWithConfiguration:(PNConfiguration *)configuration
 
     if ([self.subscriberManager allObjects].count) {
         // Stop any interactions on subscription loop.
-        [self cancelSubscribeOperations];
+        [self cancelSubscribeOperationsWithCompletion:nil];
 
         BOOL uuidChanged = ![configuration.userID isEqualToString:self.configuration.userID];
         BOOL authKeyChanged = ((self.configuration.authKey && !configuration.authKey) ||
@@ -402,8 +404,9 @@ - (void)prepareReachability {
             #pragma clang diagnostic push
             #pragma clang diagnostic ignored "-Warc-repeated-use-of-weak"
             [weakSelf.reachability stopServicePing];
-            [weakSelf cancelSubscribeOperations];
-            [weakSelf.subscriberManager restoreSubscriptionCycleIfRequiredWithCompletion:nil];
+            [weakSelf cancelSubscribeOperationsWithCompletion:^{
+                [weakSelf.subscriberManager restoreSubscriptionCycleIfRequiredWithCompletion:nil];
+            }];
             #pragma clang diagnostic pop
         }
     }];

diff --git a/PubNub/Core/PubNub+CorePrivate.h b/PubNub/Core/PubNub+CorePrivate.h
@@ -48,6 +48,9 @@ typedef void(^PNParsedRequestCompletionBlock)(PNTransportRequest *,
 
 #pragma mark - Properties
 
+// Handler which will be called when subscribe request will be cancelled.
+@property(strong, nullable, nonatomic) dispatch_block_t subscribeCancellationHandler;
+
 /// Recent client state (whether it was connected or not).
 @property (nonatomic, readonly, assign) PNStatusCategory recentClientStatus;
 

diff --git a/PubNub/Core/PubNub+Presence.m b/PubNub/Core/PubNub+Presence.m
@@ -412,13 +412,14 @@ - (void)setConnected:(BOOL)connected
             [self heartbeatWithCompletion:block];
             [self.heartbeatManager startHeartbeatIfRequired];
         } else {
-            [self cancelSubscribeOperations];
-            [self.subscriberManager unsubscribeFromChannels:presenceChannels
-                                                     groups:presenceChannelGroups
-                                        withQueryParameters:nil
-                                      listenersNotification:NO
-                                                 completion:^(PNSubscribeStatus *status) {
-                if (block) block((id)status);
+            [self cancelSubscribeOperationsWithCompletion:^{
+                [self.subscriberManager unsubscribeFromChannels:presenceChannels
+                                                         groups:presenceChannelGroups
+                                            withQueryParameters:nil
+                                          listenersNotification:NO
+                                                     completion:^(PNSubscribeStatus *status) {
+                    if (block) block((id)status);
+                }];
             }];
         }
     } else {

diff --git a/PubNub/Core/PubNub+Subscribe.m b/PubNub/Core/PubNub+Subscribe.m
@@ -202,8 +202,9 @@ - (void)setFilterExpression:(NSString *)filterExpression {
 #pragma mark - Subscription
 
 - (void)subscribeWithRequest:(PNSubscribeRequest *)request {
-    [self cancelSubscribeOperations];
-    [self.subscriberManager subscribeWithRequest:request];
+    [self cancelSubscribeOperationsWithCompletion:^{
+        [self.subscriberManager subscribeWithRequest:request];
+    }];
 }
 
 - (void)subscribeWithRequest:(PNSubscribeRequest *)userRequest completion:(PNSubscriberCompletionBlock)handleBlock {
@@ -221,8 +222,14 @@ - (void)subscribeWithRequest:(PNSubscribeRequest *)userRequest completion:(PNSub
         PNStrongify(self);
 
         result.status.initialSubscription = [userRequest.timetoken isEqualToNumber:@0];
-
-        [self callBlock:block status:YES withResult:nil andStatus:result.status];
+        [self.lock writeAccessWithBlock:^{
+            if (self.subscribeCancellationHandler) {
+                self.subscribeCancellationHandler();
+                self.subscribeCancellationHandler = nil;
+            }
+
+            [self callBlock:block status:YES withResult:nil andStatus:result.status];
+        }];
     };
 
     [self performRequest:userRequest withParser:responseParser completion:handler];
@@ -316,8 +323,9 @@ - (void)subscribeToPresenceChannels:(NSArray<NSString *> *)channels withQueryPar
 - (void)unsubscribeWithRequest:(PNPresenceLeaveRequest *)request {
     if (request.channels.count == 0 && request.channelGroups.count == 0) return;
 
-    [self cancelSubscribeOperations];
-    [self.subscriberManager unsubscribeWithRequest:request completion:nil];
+    [self cancelSubscribeOperationsWithCompletion:^{
+        [self.subscriberManager unsubscribeWithRequest:request completion:nil];
+    }];
 }
 
 - (void)unsubscribeWithRequest:(PNPresenceLeaveRequest *)userRequest
@@ -367,8 +375,9 @@ - (void)unsubscribeFromChannels:(NSArray<NSString *> *)channels
     request.observePresence = shouldObservePresence;
 
     if (request.channels.count || request.channelGroups.count) {
-        [self cancelSubscribeOperations];
-        [self.subscriberManager unsubscribeWithRequest:request completion:block];
+        [self cancelSubscribeOperationsWithCompletion:^{
+            [self.subscriberManager unsubscribeWithRequest:request completion:block];
+        }];
     } else if (block) {
         pn_dispatch_async(self.callbackQueue, ^{
             block(nil);
@@ -396,18 +405,39 @@ - (void)unsubscribeFromAllWithCompletion:(PNStatusBlock)block {
 }
 
 - (void)unsubscribeFromAllWithQueryParameters:(NSDictionary *)queryParameters completion:(PNStatusBlock)block {
-    [self cancelSubscribeOperations];
-    [self.subscriberManager unsubscribeFromAllWithQueryParameters:queryParameters completion:block];
+    [self cancelSubscribeOperationsWithCompletion:^{
+        [self.subscriberManager unsubscribeFromAllWithQueryParameters:queryParameters completion:block];
+    }];
 }
 
 
 #pragma mark - Misc
 
-- (void)cancelSubscribeOperations {
+- (void)cancelSubscribeOperationsWithCompletion:(dispatch_block_t)block {
     [self.subscriptionNetwork requestsWithBlock:^(NSArray<PNTransportRequest *> *requests) {
+        BOOL hasSubscribeRequests = NO;
+
         for(PNTransportRequest *request in requests) {
-            if ([request.path hasPrefix:kPNSubscribeAPIPrefix]) request.cancel();
+            if (!hasSubscribeRequests && [request.path hasPrefix:kPNSubscribeAPIPrefix]) {
+                hasSubscribeRequests = YES;
+                break;
+            }
         }
+
+        dispatch_block_t cancelRequests = ^{
+            for(PNTransportRequest *request in requests) {
+                if ([request.path hasPrefix:kPNSubscribeAPIPrefix]) request.cancel();
+            }
+        };
+
+        if (hasSubscribeRequests) {
+            if (block) {
+                [self.lock writeAccessWithBlock:^{
+                    self.subscribeCancellationHandler = [block copy];
+                    cancelRequests();
+                }];
+            } else cancelRequests();
+        } else if (block) block();
     }];
 }
 

diff --git a/PubNub/Core/PubNub+SubscribePrivate.h b/PubNub/Core/PubNub+SubscribePrivate.h
@@ -90,7 +90,9 @@ NS_ASSUME_NONNULL_BEGIN
 #pragma mark - Misc
 
 /// Cancel any active long-polling subscribe operations scheduled for processing.
-- (void)cancelSubscribeOperations;
+///
+/// - Parameter block: Subscribe request cancellatation handler block.
+- (void)cancelSubscribeOperationsWithCompletion:(nullable dispatch_block_t)block;
 
 #pragma mark -
 

diff --git a/PubNub/Data/Managers/PNSubscriber.m b/PubNub/Data/Managers/PNSubscriber.m
@@ -839,10 +839,11 @@ - (void)subscribe:(BOOL)initialSubscribe
         [self updateStateTo:PNDisconnectedSubscriberState
                  withStatus:(PNSubscribeStatus *)status
                  completion:^(PNStatusCategory category) {
-            [self.client cancelSubscribeOperations];
-            [status updateCategory:category];
-
-            [self.client callBlock:nil status:YES withResult:nil andStatus:status];
+            [self.client cancelSubscribeOperationsWithCompletion:^{
+                [status updateCategory:category];
+
+                [self.client callBlock:nil status:YES withResult:nil andStatus:status];
+            }];
         }];
     }
     #pragma clang diagnostic pop

diff --git a/Tests/Podfile.lock b/Tests/Podfile.lock
@@ -1,9 +1,9 @@
 PODS:
   - Cucumberish (1.4.0)
   - OCMock (3.6)
-  - PubNub (5.4.1):
-    - PubNub/Core (= 5.4.1)
-  - PubNub/Core (5.4.1)
+  - PubNub (5.5.0):
+    - PubNub/Core (= 5.5.0)
+  - PubNub/Core (5.5.0)
   - YAHTTPVCR (1.5.0)
 
 DEPENDENCIES:
@@ -32,7 +32,7 @@ CHECKOUT OPTIONS:
 SPEC CHECKSUMS:
   Cucumberish: 6cbd0c1f50306b369acebfe7d9f514c9c287d26c
   OCMock: 5ea90566be239f179ba766fd9fbae5885040b992
-  PubNub: b9d51645534909e74c3407857049732f817d3a8e
+  PubNub: 17b22578c960a206863289c3662d0ccc803c71f7
   YAHTTPVCR: cb7a710d4289ee9b038fd708d2fb8df4e6521bc0
 
 PODFILE CHECKSUM: fb38a10e9ab7ec6c9e4fe43e6a3b6ffc35154550