RTP17b

Source/ARTConstants.m

@@ -8,5 +8,5 @@
 
 #import "ARTConstants.h"
 
-NSString *const ARTHttpHeaderFieldErrorCodeKey = @"X-Ably-Errorcode";
-NSString *const ARTHttpHeaderFieldErrorMessageKey = @"X-Ably-Errormessage";
+NSString *const ARTHttpHeaderFieldErrorCodeKey = @"x-ably-errorcode";
+NSString *const ARTHttpHeaderFieldErrorMessageKey = @"x-ably-errormessage";

Source/ARTHTTPPaginatedResponse+Private.h

@@ -8,12 +8,16 @@
 
 #import <Ably/ARTHTTPPaginatedResponse.h>
 
+#import <Ably/ARTPaginatedResult+Private.h>
+
 @class ARTRest;
 
 NS_ASSUME_NONNULL_BEGIN
 
 @interface ARTHTTPPaginatedResponse ()
 
+@property (nonatomic, strong) NSHTTPURLResponse *response;
+
 + (void)executePaginated:(ARTRest *)rest withRequest:(NSMutableURLRequest *)request andResponseProcessor:(ARTPaginatedResultResponseProcessor)responseProcessor callback:(void (^)(ARTPaginatedResult * _Nullable, ARTErrorInfo * _Nullable))callback UNAVAILABLE_ATTRIBUTE;
 
 + (void)executePaginated:(ARTRest *)rest withRequest:(NSMutableURLRequest *)request callback:(void (^)(ARTHTTPPaginatedResponse *_Nullable result, ARTErrorInfo *_Nullable error))callback;

Source/ARTHTTPPaginatedResponse.h

@@ -20,10 +20,10 @@ NS_ASSUME_NONNULL_BEGIN
 /// Returns true when the HTTP status code indicates success i.e. 200 <= statusCode < 300
 @property (nonatomic, readonly) BOOL success;
 
-/// Returns the error code if the X-Ably-Errorcode HTTP header is sent in the response
+/// Returns the error code if the X-Ably-ErrorCode HTTP header is sent in the response
 @property (nonatomic, readonly) NSInteger errorCode;
 
-/// Returns error message if the X-Ably-Errormessage HTTP header is sent in the response
+/// Returns error message if the X-Ably-ErrorMessage HTTP header is sent in the response
 @property (nullable, nonatomic, readonly) NSString *errorMessage;
 
 /// Returns a dictionary containing all the HTTP header fields of the response header.

Source/ARTHTTPPaginatedResponse.m

@@ -6,7 +6,7 @@
 //  Copyright © 2018 Ably. All rights reserved.
 //
 
-#import "ARTHTTPPaginatedResponse.h"
+#import "ARTHTTPPaginatedResponse+Private.h"
 
 #import "ARTHttp.h"
 #import "ARTAuth.h"
@@ -17,9 +17,7 @@
 #import "ARTEncoder.h"
 #import "ARTConstants.h"
 
-@implementation ARTHTTPPaginatedResponse {
-    NSHTTPURLResponse *_response;
-}
+@implementation ARTHTTPPaginatedResponse
 
 - (instancetype)initWithResponse:(NSHTTPURLResponse *)response
                            items:(NSArray *)items

Source/ARTHttp.m

@@ -46,7 +46,6 @@ - (void)executeRequest:(NSMutableURLRequest *)request completion:(void (^)(NSHTT
 
     [_urlSession get:request completion:^(NSHTTPURLResponse *response, NSData *data, NSError *error) {
         NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
-
         if (error) {
             [self.logger error:@"%@ %@: error %@", request.HTTPMethod, request.URL.absoluteString, error];
         } else {

Source/ARTLog.h

@@ -26,6 +26,7 @@ typedef NS_ENUM(NSUInteger, ARTLogLevel) {
 @property (nonatomic, assign) ARTLogLevel logLevel;
 
 - (void)log:(NSString *)message withLevel:(ARTLogLevel)level;
+- (void)logWithError:(ARTErrorInfo *)error;
 
 - (ARTLog *)verboseMode;
 - (ARTLog *)debugMode;

Source/ARTLog.m

@@ -149,6 +149,10 @@ - (void)log:(NSString *)message level:(ARTLogLevel)level {
     });
 }
 
+- (void)logWithError:(ARTErrorInfo *)error {
+    [self log:error.message withLevel:ARTLogLevelError];
+}
+
 - (NSArray<ARTLogLine *> *)history {
     return _history;
 }

Source/ARTPresenceMap.m

@@ -78,7 +78,7 @@ - (instancetype)initWithQueue:(_Nonnull dispatch_queue_t)queue logger:(ARTLog *)
 
 - (BOOL)add:(ARTPresenceMessage *)message {
     ARTPresenceMessage *latest = [_members objectForKey:message.memberKey];
-    if ([self isNewestPresence:message comparingWith:latest]) {
+    if ([message isNewerThan:latest]) {
         ARTPresenceMessage *messageCopy = [message copy];
         switch (message.action) {
             case ARTPresenceEnter:
@@ -96,6 +96,7 @@ - (BOOL)add:(ARTPresenceMessage *)message {
         }
         return YES;
     }
+    [_logger debug:__FILE__ line:__LINE__ message:@"Presence member \"%@\" with action %@ has been ignored", message.memberKey, ARTPresenceActionToStr(message.action)];
     latest.syncSessionId = _syncSessionId;
     return NO;
 }
@@ -108,7 +109,7 @@ - (void)internalAdd:(ARTPresenceMessage *)message withSessionId:(NSUInteger)sess
     message.syncSessionId = sessionId;
     [_members setObject:message forKey:message.memberKey];
     // Local member
-    if ([message.connectionId isEqualToString:[self.delegate connectionId]]) {
+    if ([message.connectionId isEqualToString:self.delegate.connectionId]) {
         [_localMembers addObject:message];
         [_logger debug:__FILE__ line:__LINE__ message:@"local member %@ added", message.memberKey];
     }
@@ -119,6 +120,10 @@ - (void)internalRemove:(ARTPresenceMessage *)message {
 }
 
 - (void)internalRemove:(ARTPresenceMessage *)message force:(BOOL)force {
+    if ([message.connectionId isEqualToString:self.delegate.connectionId] && !message.isSynthesized) {
+        [_localMembers removeObject:message];
+    }
+
     if (!force && self.syncInProgress) {
         message.action = ARTPresenceAbsent;
         // Should be removed after Sync ends
@@ -130,46 +135,6 @@ - (void)internalRemove:(ARTPresenceMessage *)message force:(BOOL)force {
     }
 }
 
-- (BOOL)isNewestPresence:(nonnull ARTPresenceMessage *)received comparingWith:(ARTPresenceMessage *)latest  __attribute__((warn_unused_result)) {
-    if (latest == nil) {
-        return YES;
-    }
-
-    NSArray<NSString *> *receivedMessageIdParts = [received.id componentsSeparatedByCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@":"]];
-    if (receivedMessageIdParts.count != 3) {
-        [_logger error:@"Received presence message id is invalid %@", received.id];
-        return !received.timestamp ||
-            [latest.timestamp timeIntervalSince1970] <= [received.timestamp timeIntervalSince1970];
-    }
-    NSString *receivedConnectionId = [receivedMessageIdParts objectAtIndex:0];
-    NSInteger receivedMsgSerial = [[receivedMessageIdParts objectAtIndex:1] integerValue];
-    NSInteger receivedIndex = [[receivedMessageIdParts objectAtIndex:2] integerValue];
-
-    if ([receivedConnectionId isEqualToString:received.connectionId]) {
-        NSArray<NSString *> *latestRegisteredIdParts = [latest.id componentsSeparatedByCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@":"]];
-        if (latestRegisteredIdParts.count != 3) {
-            [_logger error:@"Latest registered presence message id is invalid %@", latest.id];
-            return !received.timestamp ||
-                [latest.timestamp timeIntervalSince1970] <= [received.timestamp timeIntervalSince1970];
-        }
-        NSInteger latestRegisteredMsgSerial = [[latestRegisteredIdParts objectAtIndex:1] integerValue];
-        NSInteger latestRegisteredIndex = [[latestRegisteredIdParts objectAtIndex:2] integerValue];
-
-        if (receivedMsgSerial > latestRegisteredMsgSerial) {
-            return YES;
-        }
-        else if (receivedMsgSerial == latestRegisteredMsgSerial && receivedIndex > latestRegisteredIndex) {
-            return YES;
-        }
-
-        [_logger debug:__FILE__ line:__LINE__ message:@"Presence member \"%@\" with action %@ has been ignored", received.memberKey, ARTPresenceActionToStr(received.action)];
-        return NO;
-    }
-
-    return !received.timestamp ||
-        [latest.timestamp timeIntervalSince1970] <= [received.timestamp timeIntervalSince1970];
-}
-
 - (void)cleanUpAbsentMembers {
     NSSet<NSString *> *filteredMembers = [_members keysOfEntriesPassingTest:^BOOL(NSString *key, ARTPresenceMessage *message, BOOL *stop) {
         return message.action == ARTPresenceAbsent;

Source/ARTPresenceMessage+Private.h

@@ -12,4 +12,13 @@
 
 @property (readwrite, assign, nonatomic) NSUInteger syncSessionId;
 
+/**
+ Returns whether this presenceMessage is synthesized, i.e. was not actually sent by the connection (usually means a leave event sent 15s after a disconnection). This is useful because synthesized messages cannot be compared for newness by id lexicographically - RTP2b1.
+ */
+- (BOOL)isSynthesized;
+
+- (nonnull NSArray<NSString *> *)parseId;
+- (NSInteger)msgSerialFromId;
+- (NSInteger)indexFromId;
+
 @end

Source/ARTPresenceMessage.h

@@ -31,6 +31,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (BOOL)isEqualToPresenceMessage:(nonnull ARTPresenceMessage *)presence;
 
+- (BOOL)isNewerThan:(ARTPresenceMessage *)latest __attribute__((warn_unused_result));
+
 @end
 
 #pragma mark - ARTEvent

Source/ARTPresenceMessage.m

@@ -8,6 +8,9 @@
 
 #import "ARTPresenceMessage+Private.h"
 
+NSString *const ARTPresenceMessageException = @"ARTPresenceMessageException";
+NSString *const ARTAblyMessageInvalidPresenceId = @"Received presence message id is invalid %@";
+
 @implementation ARTPresenceMessage
 
 - (instancetype)init {
@@ -52,6 +55,54 @@ - (BOOL)isEqualToPresenceMessage:(ARTPresenceMessage *)presence {
     return haveEqualConnectionId && haveEqualCliendId;
 }
 
+- (NSArray<NSString *> *)parseId {
+    if (!self.id) {
+        return nil;
+    }
+    NSArray<NSString *> *idParts = [self.id componentsSeparatedByCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@":"]];
+    if (idParts.count != 3) {
+        [ARTException raise:ARTPresenceMessageException format:ARTAblyMessageInvalidPresenceId, self.id];
+    }
+    return idParts;
+}
+
+- (BOOL)isSynthesized {
+    NSString *connectionId = [[self parseId] objectAtIndex:0];
+    return ![connectionId isEqualToString:self.connectionId];
+}
+
+- (NSInteger)msgSerialFromId {
+    NSInteger msgSerial = [[[self parseId] objectAtIndex:1] integerValue];
+    return msgSerial;
+}
+
+- (NSInteger)indexFromId {
+    NSInteger index = [[[self parseId] objectAtIndex:2] integerValue];
+    return index;
+}
+
+- (BOOL)isNewerThan:(ARTPresenceMessage *)latest {
+    if (latest == nil) {
+        return YES;
+    }
+
+    if ([self isSynthesized] || [latest isSynthesized]) {
+        return !self.timestamp || [latest.timestamp timeIntervalSince1970] <= [self.timestamp timeIntervalSince1970];
+    }
+
+    NSInteger currentMsgSerial = [self msgSerialFromId];
+    NSInteger currentIndex = [self indexFromId];
+    NSInteger latestMsgSerial = [latest msgSerialFromId];
+    NSInteger latestIndex = [latest indexFromId];
+
+    if (currentMsgSerial == latestMsgSerial) {
+        return currentIndex > latestIndex;
+    }
+    else {
+        return currentMsgSerial > latestMsgSerial;
+    }
+}
+
 #pragma mark - NSObject
 
 - (BOOL)isEqual:(id)object {

Source/ARTRealtime.m

@@ -550,12 +550,6 @@ - (ARTEventListener *)transitionSideEffects:(ARTConnectionStateChange *)stateCha
 
     if ([self shouldSendEvents]) {
         [self sendQueuedMessages];
-        // For every Channel
-        for (ARTRealtimeChannel* channel in self.channels.nosyncIterable) {
-            if (channel.state_nosync == ARTRealtimeChannelSuspended) {
-                [channel _attach:nil];
-            }
-        }
     } else if (![self shouldQueueEvents]) {
         ARTStatus *channelStatus = status;
         if (!channelStatus) {

Source/ARTRealtimeChannel+Private.h

@@ -76,6 +76,8 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)broadcastPresence:(ARTPresenceMessage *)pm;
 - (void)detachChannel:(ARTStatus *)status;
 
+- (void)sync;
+- (void)sync:(nullable void (^)(ARTErrorInfo *_Nullable))callback;
 - (void)requestContinueSync;
 
 @end

Source/ARTRealtimeChannel.m

@@ -164,6 +164,59 @@ - (void)internalPostMessages:(id)data callback:(void (^)(ARTErrorInfo *__art_nul
 } ART_TRY_OR_MOVE_TO_FAILED_END
 }
 
+- (void)sync {
+    [self sync:nil];
+}
+
+- (void)sync:(void (^)(ARTErrorInfo *__art_nullable error))callback {
+    if (callback) {
+        void (^userCallback)(ARTErrorInfo *__art_nullable error) = callback;
+        callback = ^(ARTErrorInfo *__art_nullable error) {
+            ART_EXITING_ABLY_CODE(self->_realtime.rest);
+            dispatch_async(self->_userQueue, ^{
+                userCallback(error);
+            });
+        };
+    }
+
+ART_TRY_OR_MOVE_TO_FAILED_START(_realtime) {
+    switch (self.state) {
+        case ARTRealtimeChannelInitialized:
+        case ARTRealtimeChannelDetaching:
+        case ARTRealtimeChannelDetached: {
+            ARTErrorInfo *error = [ARTErrorInfo createWithCode:40000 message:@"unable to sync to channel; not attached"];
+            [self.logger logWithError:error];
+            if (callback) callback(error);
+            return;
+        }
+        default:
+            break;
+    }
+
+    [self.logger verbose:__FILE__ line:__LINE__ message:@"R:%p C:%p (%@) requesting a sync operation", _realtime, self, self.name];
+
+    ARTProtocolMessage * msg = [[ARTProtocolMessage alloc] init];
+    msg.action = ARTProtocolMessageSync;
+    msg.channel = self.name;
+
+    if (self.presenceMap.syncMsgSerial) {
+        msg.channelSerial = self.presenceMap.syncChannelSerial;
+        msg.msgSerial = [NSNumber numberWithLongLong:self.presenceMap.syncMsgSerial];
+    }
+
+    [self.realtime send:msg sentCallback:^(ARTErrorInfo *error) {
+        if (error) {
+            [self.logger debug:__FILE__ line:__LINE__ message:@"R:%p C:%p (%@) SYNC request failed with %@", self->_realtime, self, self.name, error];
+            callback(error);
+        }
+        else {
+            [self.logger debug:__FILE__ line:__LINE__ message:@"R:%p C:%p (%@) SYNC requested with success", self->_realtime, self, self.name];
+            callback(nil);
+        }
+    } ackCallback:nil];
+} ART_TRY_OR_MOVE_TO_FAILED_END
+}
+
 - (void)requestContinueSync {
 ART_TRY_OR_MOVE_TO_FAILED_START(_realtime) {
     [self.logger debug:__FILE__ line:__LINE__ message:@"R:%p C:%p (%@) requesting to continue sync operation after reconnect using msgSerial %lld and channelSerial %@", _realtime, self, self.name, self.presenceMap.syncMsgSerial, self.presenceMap.syncChannelSerial];
@@ -174,9 +227,9 @@ - (void)requestContinueSync {
     msg.channelSerial = self.presenceMap.syncChannelSerial;
     msg.channel = self.name;
 
-    [self.realtime send:msg sentCallback:nil ackCallback:^(ARTStatus *status) {
-        [self.logger debug:__FILE__ line:__LINE__ message:@"R:%p C:%p (%@) continue sync, status is %@", self->_realtime, self, self.name, status];
-    }];
+    [self.realtime send:msg sentCallback:^(ARTErrorInfo *error) {
+        [self.logger debug:__FILE__ line:__LINE__ message:@"R:%p C:%p (%@) continue sync, error is %@", self->_realtime, self, self.name, error];
+    } ackCallback:nil];
 } ART_TRY_OR_MOVE_TO_FAILED_END
 }
 
@@ -770,11 +823,11 @@ - (void)onPresence:(ARTProtocolMessage *)message {
                 [self.logger error:@"R:%p C:%p (%@) %@", _realtime, self, self.name, errorInfo.message];
             }
         }
-        
+
         if (!presence.timestamp) {
             presence.timestamp = message.timestamp;
         }
-        
+
         if (!presence.id) {
             presence.id = [NSString stringWithFormat:@"%@:%d", message.id, i];
         }

Source/ARTRest.m

@@ -270,7 +270,7 @@ - (void)executeRequest:(NSURLRequest *)request completion:(void (^)(NSHTTPURLRes
     [self.logger debug:__FILE__ line:__LINE__ message:@"RS:%p executing request %@", self, request];
     [self.httpExecutor executeRequest:request completion:^(NSHTTPURLResponse *response, NSData *data, NSError *error) {
         // Error messages in plaintext and HTML format (only if the URL request is different than `options.authUrl` and we don't have an error already)
-        if (error == nil && data != nil && ![request.URL.host isEqualToString:[self.options.authUrl host]]) {
+        if (error == nil && data != nil && data.length != 0 && ![request.URL.host isEqualToString:[self.options.authUrl host]]) {
             NSString *contentType = [response.allHeaderFields objectForKey:@"Content-Type"];
 
             BOOL validContentType = NO;