Merge pull request #1952 from ably/fix/1951-RSH3a3a

[ECO-4886] respect RSH3a3a
ably · Jul 25, 2024 · 3b07d51 · 3b07d51
2 parents 5a79a49 + 9a3b4ab
commit 3b07d51
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/Source/ARTPushActivationState.m b/Source/ARTPushActivationState.m
@@ -135,6 +135,9 @@ - (ARTPushActivationState *)transition:(ARTPushActivationEvent *)event {
     else if ([event isKindOfClass:[ARTPushActivationEventCalledActivate class]]) {
         return validateAndSync(self.machine, event, self.logger);
     }
+    else if ([event isKindOfClass:[ARTPushActivationEventGotPushDeviceDetails class]]) {
+        return self; // Consuming event (RSH3a3a)
+    }
     return nil;
 }
 

diff --git a/Source/ARTPushActivationStateMachine.m b/Source/ARTPushActivationStateMachine.m
@@ -37,6 +37,7 @@ @implementation ARTPushActivationStateMachine {
     ARTPushActivationState *_current;
     dispatch_queue_t _queue;
     dispatch_queue_t _userQueue;
+    NSMutableArray<ARTPushActivationEvent *> *_pendingEvents;
 }
 
 - (instancetype)initWithRest:(ARTRestInternal *const)rest
@@ -76,6 +77,14 @@ - (instancetype)initWithRest:(ARTRestInternal *const)rest
     return self;
 }
 
+- (NSArray<ARTPushActivationEvent *> *)pendingEvents {
+    __block NSArray<ARTPushActivationEvent *> *ret;
+    dispatch_sync(_queue, ^{
+        ret = [self->_pendingEvents copy];
+    });
+    return ret;
+}
+
 - (ARTPushActivationEvent *)lastEvent {
     __block ARTPushActivationEvent *ret;
     dispatch_sync(_queue, ^{
@@ -132,7 +141,7 @@ - (void)handleEvent:(nonnull ARTPushActivationEvent *)event {
         if (maybeNext == nil) {
             break;
         }
-        [_pendingEvents art_dequeue];
+        [_pendingEvents art_dequeue]; // consuming event
 
         ARTLogDebug(_logger, @"%@: transition: %@ -> %@", NSStringFromClass(self.class), NSStringFromClass(_current.class), NSStringFromClass(maybeNext.class));
         if (self.transitions) self.transitions(event, _current, maybeNext);

diff --git a/Source/PrivateHeaders/Ably/ARTPushActivationStateMachine.h b/Source/PrivateHeaders/Ably/ARTPushActivationStateMachine.h
@@ -13,7 +13,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @property (readonly, nonatomic) ARTPushActivationEvent *lastEvent;
 @property (readonly, nonatomic) ARTPushActivationState *current;
-@property (readonly, nonatomic) NSMutableArray<ARTPushActivationEvent *> *pendingEvents;
+@property (readonly, nonatomic) NSArray<ARTPushActivationEvent *> *pendingEvents;
 
 - (instancetype)init NS_UNAVAILABLE;
 + (instancetype)new NS_UNAVAILABLE;

diff --git a/Test/Tests/PushActivationStateMachineTests.swift b/Test/Tests/PushActivationStateMachineTests.swift
@@ -203,7 +203,9 @@ class PushActivationStateMachineTests: XCTestCase {
         beforeEach__Activation_state_machine__State_NotActivated()
 
         stateMachine.send(ARTPushActivationEventGotPushDeviceDetails())
+
         expect(stateMachine.current).to(beAKindOf(ARTPushActivationStateNotActivated.self))
+        XCTAssertEqual(stateMachine.pendingEvents.count, 0)
     }
 
     // RSH3b
@@ -982,7 +984,7 @@ class PushActivationStateMachineTests: XCTestCase {
         expect(stateMachine.pendingEvents).toEventually(haveCount(1), timeout: testTimeout)
         stateMachine.transitions = nil
 
-        let pendingEvent = try XCTUnwrap(stateMachine.pendingEvents.firstObject, "Pending event is missing")
+        let pendingEvent = try XCTUnwrap(stateMachine.pendingEvents.first, "Pending event is missing")
         expect(pendingEvent).to(beAKindOf(ARTPushActivationEventCalledActivate.self))
 
         waitUntil(timeout: testTimeout) { done in