fix: Require MockWebSocket to be initialized with a graphql subscriptions protocol

Author: calvincestari

Sources/ApolloTestSupport/MockWebSocket.swift

@@ -8,8 +8,10 @@ public class MockWebSocket: WebSocketClient {
   public var delegate: WebSocketClientDelegate? = nil
   public var isConnected: Bool = false
 
-  public required init(request: URLRequest) {
+  public required init(request: URLRequest, protocol: WebSocket.WSProtocol) {
     self.request = request
+
+    self.request.setValue(`protocol`.description, forHTTPHeaderField: WebSocket.Constants.headerWSProtocolName)
   }
 
   open func reportDidConnect() {

Tests/ApolloTests/WebSocket/GraphqlTransportWsProtocolTests.swift

@@ -16,6 +16,10 @@ class GraphqlTransportWsProtocolTests: WSProtocolTestsBase {
     return request
   }
 
+  private func buildWebSocket() {
+    buildWebSocket(protocol: .graphql_transport_ws)
+  }
+
   // MARK: Initializer Tests
 
   func test__designatedInitializer__shouldSetRequestProtocolHeader() {

Tests/ApolloTests/WebSocket/GraphqlWsProtocolTests.swift

@@ -16,6 +16,10 @@ class GraphqlWsProtocolTests: WSProtocolTestsBase {
     return request
   }
 
+  private func buildWebSocket() {
+    buildWebSocket(protocol: .graphql_ws)
+  }
+
   // MARK: Initializer Tests
 
   func test__designatedInitializer__shouldSetRequestProtocolHeader() {

Tests/ApolloTests/WebSocket/WSProtocolTestsBase.swift

@@ -40,9 +40,9 @@ class WSProtocolTestsBase: XCTestCase {
     fatalError("Subclasses must override this property!")
   }
 
-  func buildWebSocket() {
+  func buildWebSocket(protocol: WebSocket.WSProtocol) {
     mockWebSocketDelegate = MockWebSocketDelegate()
-    mockWebSocket = MockWebSocket(request: urlRequest)
+    mockWebSocket = MockWebSocket(request: urlRequest, protocol: `protocol`)
     websocketTransport = WebSocketTransport(websocket: mockWebSocket, store: store)
   }
 

Tests/ApolloTests/WebSocket/WebSocketTests.swift

@@ -28,7 +28,10 @@ class WebSocketTests: XCTestCase {
     super.setUp()
 
     let store = ApolloStore()
-    let websocket = MockWebSocket(request:URLRequest(url: TestURL.mockServer.url))
+    let websocket = MockWebSocket(
+      request:URLRequest(url: TestURL.mockServer.url),
+      protocol: .graphql_ws
+    )
     networkTransport = WebSocketTransport(websocket: websocket, store: store)
     client = ApolloClient(networkTransport: networkTransport!, store: store)
   }
@@ -133,7 +136,10 @@ class WebSocketTests: XCTestCase {
     let expectation = self.expectation(description: "Single Subscription with Custom Operation Message Id Creator")
 
     let store = ApolloStore()
-    let websocket = MockWebSocket(request:URLRequest(url: TestURL.mockServer.url))
+    let websocket = MockWebSocket(
+      request:URLRequest(url: TestURL.mockServer.url),
+      protocol: .graphql_ws
+    )
     networkTransport = WebSocketTransport(websocket: websocket, store: store, operationMessageIdCreator: CustomOperationMessageIdCreator())
     client = ApolloClient(networkTransport: networkTransport!, store: store)
 

Tests/ApolloTests/WebSocket/WebSocketTransportTests.swift

@@ -17,8 +17,10 @@ class WebSocketTransportTests: XCTestCase {
     var request = URLRequest(url: TestURL.mockServer.url)
     request.addValue("OldToken", forHTTPHeaderField: "Authorization")
 
-    self.webSocketTransport = WebSocketTransport(websocket: MockWebSocket(request: request),
-                                                 store: ApolloStore())
+    self.webSocketTransport = WebSocketTransport(
+      websocket: MockWebSocket(request: request, protocol: .graphql_ws),
+      store: ApolloStore()
+    )
 
     self.webSocketTransport.updateHeaderValues(["Authorization": "UpdatedToken"])
 
@@ -28,9 +30,11 @@ class WebSocketTransportTests: XCTestCase {
   func testUpdateConnectingPayload() {
     let request = URLRequest(url: TestURL.mockServer.url)
 
-    self.webSocketTransport = WebSocketTransport(websocket: MockWebSocket(request: request),
-                                                 store: ApolloStore(),
-                                                 connectingPayload: ["Authorization": "OldToken"])
+    self.webSocketTransport = WebSocketTransport(
+      websocket: MockWebSocket(request: request, protocol: .graphql_ws),
+      store: ApolloStore(),
+      connectingPayload: ["Authorization": "OldToken"]
+    )
 
     let mockWebSocketDelegate = MockWebSocketDelegate()
 
@@ -59,9 +63,11 @@ class WebSocketTransportTests: XCTestCase {
   func testCloseConnectionAndInit() {
     let request = URLRequest(url: TestURL.mockServer.url)
 
-    self.webSocketTransport = WebSocketTransport(websocket: MockWebSocket(request: request),
-                                                 store: ApolloStore(),
-                                                 connectingPayload: ["Authorization": "OldToken"])
+    self.webSocketTransport = WebSocketTransport(
+      websocket: MockWebSocket(request: request, protocol: .graphql_ws),
+      store: ApolloStore(),
+      connectingPayload: ["Authorization": "OldToken"]
+    )
     self.webSocketTransport.closeConnection()
     self.webSocketTransport.updateConnectingPayload(["Authorization": "UpdatedToken"])
     self.webSocketTransport.initServer()