Merge pull request #1847 from ably/fix/1177-RSH8b-RSH3g2a

Proper RSH8b and RSH3g2a behavior.

Source/ARTAuth.m

@@ -21,6 +21,8 @@
 #import "ARTPushActivationState.h"
 #import "ARTFormEncode.h"
 #import "ARTInternalLog.h"
+#import "ARTLocalDeviceStorage.h"
+#import "ARTLocalDevice+Private.h"
 
 @implementation ARTAuth {
     ARTQueuedDealloc *_dealloc;
@@ -824,6 +826,7 @@ - (void)setLocalDeviceClientId_nosync:(NSString *)clientId {
         return;
     }
     [_rest.device_nosync setClientId:clientId];
+    [_rest.storage setObject:clientId forKey:ARTClientIdKey];
     [_rest.push getActivationMachine:^(ARTPushActivationStateMachine *stateMachine) {
         if (![stateMachine.current_nosync isKindOfClass:[ARTPushActivationStateNotActivated class]]) {
             [stateMachine sendEvent:[[ARTPushActivationEventGotPushDeviceDetails alloc] init]];

Source/ARTLocalDevice.m

@@ -30,6 +30,7 @@
 NSString *const ARTDeviceSecretKey = @"ARTDeviceSecret";
 NSString *const ARTDeviceIdentityTokenKey = @"ARTDeviceIdentityToken";
 NSString *const ARTAPNSDeviceTokenKey = @"ARTAPNSDeviceToken";
+NSString *const ARTClientIdKey = @"ARTClientId";
 
 NSString *const ARTAPNSDeviceDefaultTokenType = @"default";
 NSString *const ARTAPNSDeviceLocationTokenType = @"location";
@@ -46,17 +47,24 @@ @interface ARTLocalDevice ()
 
 @implementation ARTLocalDevice
 
-- (instancetype)initWithClientId:(NSString *)clientId storage:(id<ARTDeviceStorage>)storage logger:(nullable ARTInternalLog *)logger {
+- (instancetype)initWithStorage:(id<ARTDeviceStorage>)storage logger:(nullable ARTInternalLog *)logger {
     if (self = [super init]) {
-        self.clientId = clientId;
         self.storage = storage;
         _logger = logger;
     }
     return self;
 }
 
-+ (ARTLocalDevice *)load:(NSString *)clientId storage:(id<ARTDeviceStorage>)storage logger:(nullable ARTInternalLog *)logger {
-    ARTLocalDevice *device = [[ARTLocalDevice alloc] initWithClientId:clientId storage:storage logger:logger];
+- (void)generateAndPersistPairOfDeviceIdAndSecret {
+    self.id = [self.class generateId];
+    self.secret = [self.class generateSecret];
+
+    [_storage setObject:self.id forKey:ARTDeviceIdKey];
+    [_storage setSecret:self.secret forDevice:self.id];
+}
+
++ (instancetype)deviceWithStorage:(id<ARTDeviceStorage>)storage logger:(nullable ARTInternalLog *)logger {
+    ARTLocalDevice *device = [[ARTLocalDevice alloc] initWithStorage:storage logger:logger];
     device.platform = ARTDevicePlatform;
     #if TARGET_OS_IOS
     switch ([[UIDevice currentDevice] userInterfaceIdiom]) {
@@ -75,21 +83,25 @@ + (ARTLocalDevice *)load:(NSString *)clientId storage:(id<ARTDeviceStorage>)stor
     NSString *deviceId = [storage objectForKey:ARTDeviceIdKey];
     NSString *deviceSecret = deviceId == nil ? nil : [storage secretForDevice:deviceId];
 
-    if (deviceId == nil || deviceSecret == nil) { // generate both at the same time
-        deviceId = [self generateId];
-        deviceSecret = [self generateSecret];
-        
-        [storage setObject:deviceId forKey:ARTDeviceIdKey];
-        [storage setSecret:deviceSecret forDevice:deviceId];
+    if (deviceId == nil || deviceSecret == nil) {
+        [device generateAndPersistPairOfDeviceIdAndSecret]; // Should be removed later once spec issue #180 resolved.
+    }
+    else {
+        device.id = deviceId;
+        device.secret = deviceSecret;
     }
-
-    device.id = deviceId;
-    device.secret = deviceSecret;
 
     id identityTokenDetailsInfo = [storage objectForKey:ARTDeviceIdentityTokenKey];
     ARTDeviceIdentityTokenDetails *identityTokenDetails = [ARTDeviceIdentityTokenDetails unarchive:identityTokenDetailsInfo withLogger:logger];
     device->_identityTokenDetails = identityTokenDetails;
 
+    NSString *clientId = [storage objectForKey:ARTClientIdKey];
+    if (clientId == nil && identityTokenDetails.clientId != nil) {
+        clientId = identityTokenDetails.clientId; // Older versions of the SDK did not persist clientId, so as a fallback when loading data persisted by these versions we use the clientId of the stored identity token
+        [storage setObject:clientId forKey:ARTClientIdKey];
+    }
+    device.clientId = clientId;
+
     NSArray *supportedTokenTypes = @[
         ARTAPNSDeviceDefaultTokenType,
         ARTAPNSDeviceLocationTokenType
@@ -102,6 +114,34 @@ + (ARTLocalDevice *)load:(NSString *)clientId storage:(id<ARTDeviceStorage>)stor
     return device;
 }
 
+- (void)setupDetailsWithClientId:(NSString *)clientId {
+    NSString *deviceId = self.id;
+    NSString *deviceSecret = self.secret;
+
+    if (deviceId == nil || deviceSecret == nil) {
+        [self generateAndPersistPairOfDeviceIdAndSecret];
+    }
+
+    self.clientId = clientId;
+    [_storage setObject:clientId forKey:ARTClientIdKey];
+}
+
+- (void)resetDetails {
+    // Should be replaced later to resetting device's id/secret once spec issue #180 resolved.
+    [self generateAndPersistPairOfDeviceIdAndSecret];
+
+    self.clientId = nil;
+    [_storage setObject:nil forKey:ARTClientIdKey];
+    [self setAndPersistIdentityTokenDetails:nil];
+    NSArray *supportedTokenTypes = @[
+        ARTAPNSDeviceDefaultTokenType,
+        ARTAPNSDeviceLocationTokenType
+    ];
+    for (NSString *tokenType in supportedTokenTypes) {
+        [self setAndPersistAPNSDeviceToken:nil tokenType:tokenType];
+    }
+}
+
 + (NSString *)generateId {
     return [NSUUID new].UUIDString;
 }
@@ -146,16 +186,12 @@ - (void)setAndPersistIdentityTokenDetails:(ARTDeviceIdentityTokenDetails *)token
     _identityTokenDetails = tokenDetails;
     if (self.clientId == nil) {
         self.clientId = tokenDetails.clientId;
+        [self.storage setObject:tokenDetails.clientId forKey:ARTClientIdKey];
     }
 }
 
 - (BOOL)isRegistered {
     return _identityTokenDetails != nil;
 }
 
-- (void)clearIdentityTokenDetailsAndClientId {
-    [self setAndPersistIdentityTokenDetails:nil];
-    self.clientId = nil;
-}
-
 @end

Source/ARTPushActivationState.m

@@ -102,6 +102,8 @@ @implementation ARTPushActivationPersistentState
     } else if ([local apnsDeviceToken]) {
         [machine sendEvent:[ARTPushActivationEventGotPushDeviceDetails new]];
     }
+    [machine.rest setupLocalDevice_nosync];
+    [machine registerForAPNS];
     #endif
 
     return [ARTPushActivationStateWaitingForPushDeviceDetails newWithMachine:machine logger:logger];
@@ -116,7 +118,6 @@ - (ARTPushActivationState *)transition:(ARTPushActivationEvent *)event {
         return self;
     }
     else if ([event isKindOfClass:[ARTPushActivationEventCalledActivate class]]) {
-        [self.machine registerForAPNS];
         return validateAndSync(self.machine, event, self.logger);
     }
     return nil;
@@ -274,8 +275,7 @@ - (ARTPushActivationState *)transition:(ARTPushActivationEvent *)event {
     }
     else if ([event isKindOfClass:[ARTPushActivationEventDeregistered class]]) {
         #if TARGET_OS_IOS
-        ARTLocalDevice *local = self.machine.rest.device_nosync;
-        [local clearIdentityTokenDetailsAndClientId];
+        [self.machine.rest resetLocalDevice_nosync];
         #endif
         [self.machine callDeactivatedCallback:nil];
         return [ARTPushActivationStateNotActivated newWithMachine:self.machine logger:self.logger];

Source/ARTRest.m

@@ -744,10 +744,9 @@ - (ARTLocalDevice *)device {
 }
 
 - (ARTLocalDevice *)device_nosync {
-    NSString *clientId = self.auth.clientId_nosync;
     __block ARTLocalDevice *ret;
-    dispatch_sync(ARTRestInternal.deviceAccessQueue, ^{
-        ret = [self deviceWithClientId_onlyCallOnDeviceAccessQueue:clientId];
+    dispatch_sync([ARTRestInternal deviceAccessQueue], ^{
+        ret = [self sharedDevice_onlyCallOnDeviceAccessQueue];
     });
     return ret;
 }
@@ -765,7 +764,7 @@ + (dispatch_queue_t)deviceAccessQueue {
 
 static BOOL sharedDeviceNeedsLoading_onlyAccessOnDeviceAccessQueue = YES;
 
-- (ARTLocalDevice *)deviceWithClientId_onlyCallOnDeviceAccessQueue:(NSString *)clientId {
+- (ARTLocalDevice *)sharedDevice_onlyCallOnDeviceAccessQueue {
     // The device is shared in a static variable because it's a reflection
     // of what's persisted. Having a device instance per ARTRest instance
     // could leave some instances in a stale state, if, through another
@@ -776,12 +775,27 @@ - (ARTLocalDevice *)deviceWithClientId_onlyCallOnDeviceAccessQueue:(NSString *)c
 
     static id device;
     if (sharedDeviceNeedsLoading_onlyAccessOnDeviceAccessQueue) {
-        device = [ARTLocalDevice load:clientId storage:self.storage logger:self.logger];
+        device = [ARTLocalDevice deviceWithStorage:self.storage logger:self.logger];
         sharedDeviceNeedsLoading_onlyAccessOnDeviceAccessQueue = NO;
     }
     return device;
 }
 
+- (void)setupLocalDevice_nosync {
+    ARTLocalDevice *device = [self device_nosync];
+    NSString *clientId = self.auth.clientId_nosync;
+    dispatch_sync([ARTRestInternal deviceAccessQueue], ^{
+        [device setupDetailsWithClientId:clientId];
+    });
+}
+
+- (void)resetLocalDevice_nosync {
+    ARTLocalDevice *device = [self device_nosync];
+    dispatch_sync([ARTRestInternal deviceAccessQueue], ^{
+        [device resetDetails];
+    });
+}
+
 - (void)resetDeviceSingleton {
     dispatch_sync([ARTRestInternal deviceAccessQueue], ^{
         sharedDeviceNeedsLoading_onlyAccessOnDeviceAccessQueue = YES;

Source/PrivateHeaders/Ably/ARTLocalDevice+Private.h

@@ -9,6 +9,7 @@ extern NSString *const ARTDeviceIdKey;
 extern NSString *const ARTDeviceSecretKey;
 extern NSString *const ARTDeviceIdentityTokenKey;
 extern NSString *const ARTAPNSDeviceTokenKey;
+extern NSString *const ARTClientIdKey;
 
 extern NSString *const ARTAPNSDeviceDefaultTokenType;
 extern NSString *const ARTAPNSDeviceLocationTokenType;
@@ -19,18 +20,19 @@ NSString* ARTAPNSDeviceTokenKeyOfType(NSString * _Nullable tokenType);
 
 @property (nonatomic) id<ARTDeviceStorage> storage;
 
-+ (ARTLocalDevice *)load:(NSString *)clientId storage:(id<ARTDeviceStorage>)storage logger:(nullable ARTInternalLog *)logger;
++ (instancetype)deviceWithStorage:(id<ARTDeviceStorage>)storage logger:(nullable ARTInternalLog *)logger;
 - (nullable NSString *)apnsDeviceToken;
 - (void)setAndPersistAPNSDeviceToken:(nullable NSString *)deviceToken tokenType:(NSString *)tokenType;
 - (void)setAndPersistAPNSDeviceToken:(nullable NSString *)deviceToken;
 - (void)setAndPersistIdentityTokenDetails:(nullable ARTDeviceIdentityTokenDetails *)tokenDetails;
 - (BOOL)isRegistered;
-- (void)clearIdentityTokenDetailsAndClientId;
+- (void)resetDetails;
+- (void)setupDetailsWithClientId:(nullable NSString *)clientId;
 
 + (NSString *)generateId;
 + (NSString *)generateSecret;
 
-+ (NSString *)apnsDeviceTokenOfType:(nullable NSString *)tokenType fromStorage:(id<ARTDeviceStorage>)storage;
++ (nullable NSString *)apnsDeviceTokenOfType:(nullable NSString *)tokenType fromStorage:(id<ARTDeviceStorage>)storage;
 
 @end
 

Source/PrivateHeaders/Ably/ARTRest+Private.h

@@ -76,6 +76,9 @@ NS_ASSUME_NONNULL_BEGIN
 - (nullable NSObject<ARTCancellable> *)internetIsUp:(void (^)(BOOL isUp))cb;
 
 #if TARGET_OS_IOS
+- (void)setupLocalDevice_nosync;
+- (void)resetLocalDevice_nosync;
+
 // This is only intended to be called from test code.
 - (void)resetDeviceSingleton;