Basic NSURLSessionWebSocketTask functionality #1541
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| #import <Foundation/Foundation.h> | ||
| #import "ARTWebSocket.h" | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0)) | ||
| @interface ARTURLSessionWebSocket : NSObject<ARTWebSocket> | ||
|
|
||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| #import "ARTURLSessionWebSocket.h" | ||
| #import "ARTRealtimeTransport.h" | ||
| #import "ARTLog.h" | ||
|
|
||
| @interface ARTURLSessionWebSocket () <NSURLSessionWebSocketDelegate> | ||
|
|
||
| @property (atomic, assign, readwrite) ARTWebSocketState readyState; | ||
|
|
||
| @end | ||
|
|
||
| @implementation ARTURLSessionWebSocket { | ||
| NSURLSession *_urlSession; | ||
| NSURLSessionWebSocketTask *_webSocketTask; | ||
| ARTLog *_logger; | ||
| } | ||
|
|
||
| #pragma mark - ARTWebSocket | ||
|
|
||
| @synthesize delegate = _delegate; | ||
| @synthesize readyState = _readyState; | ||
| @synthesize delegateDispatchQueue = _delegateDispatchQueue; | ||
|
|
||
| - (instancetype)initWithURLRequest:(NSURLRequest *)request logger:(ARTLog *)logger { | ||
| if (self = [super init]) { | ||
| NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration]; | ||
| _urlSession = [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:nil]; | ||
| _webSocketTask = [_urlSession webSocketTaskWithRequest:request]; | ||
| _readyState = ARTWebSocketStateClosed; | ||
| _logger = logger; | ||
| } | ||
| return self; | ||
| } | ||
|
|
||
| - (dispatch_queue_t)getDelegateDispatchQueue { | ||
| return _delegateDispatchQueue ?: dispatch_get_main_queue(); | ||
| } | ||
|
|
||
| - (void)listenForMessage { | ||
| __weak ARTURLSessionWebSocket *weakSelf = self; | ||
| [_webSocketTask receiveMessageWithCompletionHandler:^(NSURLSessionWebSocketMessage *message, NSError *error) { | ||
| ARTURLSessionWebSocket *strongSelf = weakSelf; | ||
| if (strongSelf) { | ||
| dispatch_async([strongSelf getDelegateDispatchQueue], ^{ | ||
| /* | ||
| * We will ignore `error` object here, relying only on `message` object presence, since: | ||
| * 1) there is additional handler for connectivity issues (`URLSession:task:didCompleteWithError:`) and | ||
| * 2) the `ARTWebSocketTransport` is not very welcoming for error emerging from here, causing some tests to fail. | ||
| */ | ||
| if (error != nil) { | ||
| [strongSelf->_logger debug:__FILE__ line:__LINE__ message:@"Receive message error: %@, task state = %@", error, @(strongSelf->_webSocketTask.state)]; | ||
| } | ||
| if (message != nil) { | ||
| switch (message.type) { | ||
| case NSURLSessionWebSocketMessageTypeData: | ||
| [strongSelf->_delegate webSocket:strongSelf didReceiveMessage:[message data]]; | ||
| break; | ||
| case NSURLSessionWebSocketMessageTypeString: | ||
| [strongSelf->_delegate webSocket:strongSelf didReceiveMessage:[message string]]; | ||
| break; | ||
| } | ||
| } | ||
| if (strongSelf.readyState == ARTWebSocketStateOpened) { | ||
| [strongSelf listenForMessage]; | ||
| } | ||
| }); | ||
| } | ||
| }]; | ||
| } | ||
|
|
||
| - (void)open { | ||
| _readyState = ARTWebSocketStateConnecting; | ||
| [_webSocketTask resume]; | ||
| } | ||
|
|
||
| - (void)send:(id)data { | ||
| NSURLSessionWebSocketMessage *wsMessage = [data isKindOfClass:[NSString class]] ? | ||
| [[NSURLSessionWebSocketMessage alloc] initWithString:data] : | ||
| [[NSURLSessionWebSocketMessage alloc] initWithData:data]; | ||
| __weak ARTURLSessionWebSocket *weakSelf = self; | ||
| [_webSocketTask sendMessage:wsMessage completionHandler:^(NSError *error) { | ||
| ARTURLSessionWebSocket *strongSelf = weakSelf; | ||
| if (strongSelf) { | ||
| dispatch_async([strongSelf getDelegateDispatchQueue], ^{ | ||
| if (error != nil) { | ||
| [strongSelf->_delegate webSocket:strongSelf didFailWithError:error]; | ||
| } | ||
| }); | ||
| } | ||
| }]; | ||
| } | ||
|
|
||
| - (void)closeWithCode:(NSInteger)code reason:(NSString *)reason { | ||
| if (self.readyState != ARTWebSocketStateClosed) { | ||
| self.readyState = ARTWebSocketStateClosing; | ||
| } | ||
| [_webSocketTask cancelWithCloseCode:code reason:[reason dataUsingEncoding:NSUTF8StringEncoding]]; | ||
| } | ||
|
|
||
| - (ARTRealtimeTransportError *)classifyError:(NSError *)error { | ||
| ARTRealtimeTransportErrorType type = ARTRealtimeTransportErrorTypeOther; | ||
|
|
||
| if ([error.domain isEqualToString:(NSString *)kCFErrorDomainCFNetwork]) { | ||
| type = ARTRealtimeTransportErrorTypeHostUnreachable; | ||
| } | ||
| else if ([error.domain isEqualToString:@"NSPOSIXErrorDomain"] && (error.code == 57 || error.code == 50)) { | ||
| type = ARTRealtimeTransportErrorTypeNoInternet; | ||
| } | ||
| else if ([error.domain isEqualToString:@"NSURLErrorDomain"] && (error.code == NSURLErrorNotConnectedToInternet)) { | ||
| type = ARTRealtimeTransportErrorTypeNoInternet; | ||
| } | ||
| else if ([error.domain isEqualToString:@"NSURLErrorDomain"] && (error.code == NSURLErrorTimedOut)) { | ||
| type = ARTRealtimeTransportErrorTypeTimeout; | ||
| } | ||
| else if ([error.domain isEqualToString:@"NSURLErrorDomain"] && (error.code == NSURLErrorBadServerResponse)) { | ||
| type = ARTRealtimeTransportErrorTypeBadResponse; | ||
| } | ||
| return [[ARTRealtimeTransportError alloc] initWithError:error type:type url:_webSocketTask.originalRequest.URL]; | ||
| } | ||
|
|
||
| #pragma mark - NSURLSessionWebSocketDelegate | ||
|
|
||
| - (void)URLSession:(NSURLSession *)session webSocketTask:(NSURLSessionWebSocketTask *)webSocketTask didOpenWithProtocol:(NSString *)protocol { | ||
| self.readyState = ARTWebSocketStateOpened; | ||
| [self listenForMessage]; | ||
| dispatch_async([self getDelegateDispatchQueue], ^{ | ||
| [self->_delegate webSocketDidOpen:self]; | ||
| }); | ||
| } | ||
|
|
||
| - (void)URLSession:(NSURLSession *)session | ||
| webSocketTask:(NSURLSessionWebSocketTask *)webSocketTask | ||
| didCloseWithCode:(NSURLSessionWebSocketCloseCode)closeCode reason:(NSData *)reasonData { | ||
| if (self.readyState == ARTWebSocketStateClosing || self.readyState == ARTWebSocketStateOpened) { | ||
| self.readyState = ARTWebSocketStateClosed; | ||
| } | ||
| dispatch_async([self getDelegateDispatchQueue], ^{ | ||
| NSString *reason = [[NSString alloc] initWithData:reasonData encoding:NSUTF8StringEncoding]; | ||
| [self->_delegate webSocket:self didCloseWithCode:closeCode reason:reason wasClean:YES]; | ||
| }); | ||
| } | ||
|
|
||
| - (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error { | ||
| self.readyState = ARTWebSocketStateClosed; | ||
| if (error != nil) { | ||
| [_logger debug:__FILE__ line:__LINE__ message:@"Session completion error: %@, task state = %@", error, @(_webSocketTask.state)]; | ||
| dispatch_async([self getDelegateDispatchQueue], ^{ | ||
| [self->_delegate webSocket:self didFailWithError:error]; | ||
| }); | ||
| } | ||
| else { | ||
| [_logger debug:__FILE__ line:__LINE__ message:@"Session completion task state = %@", @(_webSocketTask.state)]; | ||
| } | ||
| } | ||
|
|
||
| @end | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given how fundamental this class is to the SDK, I think it's important that we unit test it, to confirm that it conforms to the
ARTWebSocketprotocol and that it respects the contract of theARTWebSocketDelegateprotocol.