Treat all transport errors as recoverable

This is a cherry-pick of 46ee0b0, to resolve #1823 on the fix/socketrocket-fix branch which one of our customers is using. TODO bring in test changes
ably · Nov 6, 2023 · 79e741b · 79e741b
1 parent c1aed2b
commit 79e741b
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 19 deletions.
diff --git a/Source/ARTRealtime.m b/Source/ARTRealtime.m
@@ -1519,16 +1519,8 @@ - (void)realtimeTransportFailed:(id<ARTRealtimeTransport>)transport withError:(A
         }
     }
 
-    switch (transportError.type) {
-        case ARTRealtimeTransportErrorTypeBadResponse:
-        case ARTRealtimeTransportErrorTypeOther:
-            [self transition:ARTRealtimeFailed withErrorInfo:[ARTErrorInfo createFromNSError:transportError.error]];
-            break;
-        default: {
-            ARTErrorInfo *error = [ARTErrorInfo createFromNSError:transportError.error];
-            [self transitionToDisconnectedOrSuspendedWithError:error];
-        }
-    }
+    ARTErrorInfo *error = [ARTErrorInfo createFromNSError:transportError.error];
+    [self transitionToDisconnectedOrSuspendedWithError:error];
 }
 
 - (void)realtimeTransportNeverConnected:(id<ARTRealtimeTransport>)transport {
@@ -1537,7 +1529,7 @@ - (void)realtimeTransportNeverConnected:(id<ARTRealtimeTransport>)transport {
         return;
     }
 
-    [self transition:ARTRealtimeFailed withErrorInfo:[ARTErrorInfo createWithCode:ARTClientCodeErrorTransport message:@"Transport never connected"]];
+    [self transitionToDisconnectedOrSuspendedWithError:[ARTErrorInfo createWithCode:ARTClientCodeErrorTransport message:@"Transport never connected"]];
 }
 
 - (void)realtimeTransportRefused:(id<ARTRealtimeTransport>)transport withError:(ARTRealtimeTransportError *)error {
@@ -1547,13 +1539,13 @@ - (void)realtimeTransportRefused:(id<ARTRealtimeTransport>)transport withError:(
     }
 
     if (error && error.type == ARTRealtimeTransportErrorTypeRefused) {
-        [self transition:ARTRealtimeFailed withErrorInfo:[ARTErrorInfo createWithCode:ARTClientCodeErrorTransport message:[NSString stringWithFormat:@"Connection refused using %@", error.url]]];
+        [self transitionToDisconnectedOrSuspendedWithErrorInfo:[ARTErrorInfo createWithCode:ARTClientCodeErrorTransport message:[NSString stringWithFormat:@"Connection refused using %@", error.url]]];
     }
     else if (error) {
-        [self transition:ARTRealtimeFailed withErrorInfo:[ARTErrorInfo createFromNSError:error.error]];
+        [self transitionToDisconnectedOrSuspendedWithErrorInfo:[ARTErrorInfo createFromNSError:error.error]];
     }
     else {
-        [self transition:ARTRealtimeFailed];
+        [self transitionToDisconnectedOrSuspendedWithError:nil];
     }
 }
 
@@ -1563,7 +1555,7 @@ - (void)realtimeTransportTooBig:(id<ARTRealtimeTransport>)transport {
         return;
     }
 
-    [self transition:ARTRealtimeFailed withErrorInfo:[ARTErrorInfo createWithCode:ARTClientCodeErrorTransport message:@"Transport too big"]];
+    [self transitionToDisconnectedOrSuspendedWithError:[ARTErrorInfo createWithCode:ARTClientCodeErrorTransport message:@"Transport too big"]];
 }
 
 - (void)realtimeTransportSetMsgSerial:(id<ARTRealtimeTransport>)transport msgSerial:(int64_t)msgSerial {

diff --git a/Spec/Test Utilities/TestUtilities.swift b/Spec/Test Utilities/TestUtilities.swift
@@ -744,6 +744,7 @@ enum FakeNetworkResponse {
     case requestTimeout(timeout: TimeInterval)
     case hostInternalError(code: Int)
     case host400BadRequest
+    case arbitraryError
 
     var error: NSError {
         switch self {
@@ -757,6 +758,8 @@ enum FakeNetworkResponse {
             return NSError(domain: AblyTestsErrorDomain, code: code, userInfo: [NSLocalizedDescriptionKey: "internal error", NSLocalizedFailureReasonErrorKey: AblyTestsErrorDomain + ".FakeNetworkResponse"])
         case .host400BadRequest:
             return NSError(domain: AblyTestsErrorDomain, code: 400, userInfo: [NSLocalizedDescriptionKey: "bad request", NSLocalizedFailureReasonErrorKey: AblyTestsErrorDomain + ".FakeNetworkResponse"])
+        case .arbitraryError:
+            return NSError(domain: AblyTestsErrorDomain, code: 1, userInfo: [NSLocalizedDescriptionKey: "error from FakeNetworkResponse.arbitraryError"])
         }
     }
 
@@ -772,6 +775,8 @@ enum FakeNetworkResponse {
             return ARTRealtimeTransportError(error: error, badResponseCode: code, url: url)
         case .host400BadRequest:
             return ARTRealtimeTransportError(error: error, badResponseCode: 400, url: url)
+        case .arbitraryError:
+            return ARTRealtimeTransportError(error: error, type: .other, url: url)
         }
     }
 }
@@ -857,6 +862,8 @@ class MockHTTP: ARTHttp {
             requestCallback?(HTTPURLResponse(url: URL(string: "http://cocoa.test.suite")!, statusCode: code, httpVersion: nil, headerFields: nil), nil, nil)
         case .host400BadRequest:
             requestCallback?(HTTPURLResponse(url: URL(string: "http://cocoa.test.suite")!, statusCode: 400, httpVersion: nil, headerFields: nil), nil, nil)
+        case .arbitraryError:
+            requestCallback?(nil, nil, NSError(domain: AblyTestsErrorDomain, code: 1, userInfo: [NSLocalizedDescriptionKey: "error from FakeNetworkResponse.arbitraryError"]))
         }
     }
 
@@ -1232,7 +1239,8 @@ class TestProxyTransport: ARTWebSocketTransport {
             case .noInternet,
                  .hostUnreachable,
                  .hostInternalError,
-                 .host400BadRequest:
+                 .host400BadRequest,
+                 .arbitraryError:
                 performFakeConnectionError(0.1, error: networkResponse.transportError(for: url))
             case .requestTimeout(let timeout):
                 performFakeConnectionError(0.1 + timeout, error: networkResponse.transportError(for: url))
@@ -1613,9 +1621,11 @@ extension ARTWebSocketTransport {
     }
 
     func simulateIncomingError() {
-        let error = NSError(domain: ARTAblyErrorDomain, code: 0, userInfo: [NSLocalizedDescriptionKey:"Fail test"])
-        let webSocketDelegate = self as ARTWebSocketDelegate
-        webSocketDelegate.webSocket(self.websocket!, didFailWithError: error)
+        // Simulate receiving an ERROR ProtocolMessage, which should put a client into the FAILED state (per RTN15i)
+        let protocolMessage = ARTProtocolMessage()
+        protocolMessage.action = .error
+        protocolMessage.error = ARTErrorInfo.create(withCode: 50000 /* arbitrarily chosen */, message: "Fail test")
+        receive(protocolMessage)
     }
 }