Add tests to verify the behavior of canceling client and server calls.

Also changes a few method signatures where passing a `CallResult` does not make sense.

Author: MrMage

Sources/Examples/Echo/Generated/echo.grpc.swift

@@ -212,7 +212,7 @@ internal protocol Echo_EchoExpandSession: ServerSessionServerStreaming {
 
   /// Close the connection and send the status. Non-blocking.
   /// You MUST call this method once you are done processing the request.
-  func close(withStatus status: ServerStatus, completion: ((CallResult) -> Void)?) throws
+  func close(withStatus status: ServerStatus, completion: (() -> Void)?) throws
 }
 
 fileprivate final class Echo_EchoExpandSessionBase: ServerSessionServerStreamingBase<Echo_EchoRequest, Echo_EchoResponse>, Echo_EchoExpandSession {}
@@ -227,11 +227,11 @@ internal protocol Echo_EchoCollectSession: ServerSessionClientStreaming {
 
   /// You MUST call one of these two methods once you are done processing the request.
   /// Close the connection and send a single result. Non-blocking.
-  func sendAndClose(response: Echo_EchoResponse, status: ServerStatus, completion: ((CallResult) -> Void)?) throws
+  func sendAndClose(response: Echo_EchoResponse, status: ServerStatus, completion: (() -> Void)?) throws
   /// Close the connection and send an error. Non-blocking.
   /// Use this method if you encountered an error that makes it impossible to send a response.
   /// Accordingly, it does not make sense to call this method with a status of `.ok`.
-  func sendErrorAndClose(status: ServerStatus, completion: ((CallResult) -> Void)?) throws
+  func sendErrorAndClose(status: ServerStatus, completion: (() -> Void)?) throws
 }
 
 fileprivate final class Echo_EchoCollectSessionBase: ServerSessionClientStreamingBase<Echo_EchoRequest, Echo_EchoResponse>, Echo_EchoCollectSession {}
@@ -251,7 +251,7 @@ internal protocol Echo_EchoUpdateSession: ServerSessionBidirectionalStreaming {
 
   /// Close the connection and send the status. Non-blocking.
   /// You MUST call this method once you are done processing the request.
-  func close(withStatus status: ServerStatus, completion: ((CallResult) -> Void)?) throws
+  func close(withStatus status: ServerStatus, completion: (() -> Void)?) throws
 }
 
 fileprivate final class Echo_EchoUpdateSessionBase: ServerSessionBidirectionalStreamingBase<Echo_EchoRequest, Echo_EchoResponse>, Echo_EchoUpdateSession {}

Sources/SwiftGRPC/Core/Call.swift

@@ -99,6 +99,8 @@ public class Call {
   /// - Parameter metadata: metadata to send with the call
   /// - Parameter message: data containing the message to send (.unary and .serverStreaming only)
   /// - Parameter completion: a block to call with call results
+  ///     The argument to `completion` will always have `.success = true`
+  ///     because operations containing `.receiveCloseOnClient` always succeed.
   /// - Throws: `CallError` if fails to call.
   public func start(_ style: CallStyle,
                     metadata: Metadata,

Sources/SwiftGRPC/Core/Handler.swift

@@ -121,31 +121,33 @@ public class Handler {
     })
   }
 
-  /// Sends the response to a request
+  /// Sends the response to a request.
+  /// The completion handler does not take an argument because operations containing `.receiveCloseOnServer` always succeed.
   public func sendResponse(message: Data, status: ServerStatus,
-                           completion: ((CallResult) -> Void)? = nil) throws {
+                           completion: (() -> Void)? = nil) throws {
     let messageBuffer = ByteBuffer(data: message)
     try call.perform(OperationGroup(
       call: call,
       operations: [
         .sendMessage(messageBuffer),
         .receiveCloseOnServer,
         .sendStatusFromServer(status.code, status.message, status.trailingMetadata)
-    ]) { operationGroup in
-      completion?(CallResult(operationGroup))
+    ]) { _ in
+      completion?()
       self.shutdown()
     })
   }
 
-  /// Send final status to the client
-  public func sendStatus(_ status: ServerStatus, completion: ((CallResult) -> Void)? = nil) throws {
+  /// Send final status to the client.
+  /// The completion handler does not take an argument because operations containing `.receiveCloseOnServer` always succeed.
+  public func sendStatus(_ status: ServerStatus, completion: (() -> Void)? = nil) throws {
     try call.perform(OperationGroup(
       call: call,
       operations: [
         .receiveCloseOnServer,
         .sendStatusFromServer(status.code, status.message, status.trailingMetadata)
-    ]) { operationGroup in
-      completion?(CallResult(operationGroup))
+    ]) { _ in
+      completion?()
       self.shutdown()
     })
   }

Sources/SwiftGRPC/Runtime/ClientCallUnary.swift

@@ -47,9 +47,8 @@ open class ClientCallUnaryBase<InputType: Message, OutputType: Message>: ClientC
                     completion: @escaping ((OutputType?, CallResult) -> Void)) throws -> Self {
     let requestData = try request.serializedData()
     try call.start(.unary, metadata: metadata, message: requestData) { callResult in
-      if let responseData = callResult.resultData,
-        let response = try? OutputType(serializedData: responseData) {
-        completion(response, callResult)
+      if let responseData = callResult.resultData {
+        completion(try? OutputType(serializedData: responseData), callResult)
       } else {
         completion(nil, callResult)
       }

Sources/SwiftGRPC/Runtime/ServerSession.swift

@@ -39,6 +39,8 @@ public protocol ServerSession: class {
   var requestMetadata: Metadata { get }
 
   var initialMetadata: Metadata { get set }
+  
+  func cancel()
 }
 
 open class ServerSessionBase: ServerSession {
@@ -52,6 +54,10 @@ open class ServerSessionBase: ServerSession {
   public init(handler: Handler) {
     self.handler = handler
   }
+  
+  public func cancel() {
+    call.cancel()
+  }
 }
 
 open class ServerSessionTestStub: ServerSession {
@@ -60,4 +66,6 @@ open class ServerSessionTestStub: ServerSession {
   open var initialMetadata = Metadata()
 
   public init() {}
+  
+  open func cancel() {}
 }

Sources/SwiftGRPC/Runtime/ServerSessionBidirectionalStreaming.swift

@@ -86,9 +86,9 @@ open class ServerSessionBidirectionalStreamingTestStub<InputType: Message, Outpu
     outputs.append(message)
   }
 
-  open func close(withStatus status: ServerStatus, completion: ((CallResult) -> Void)?) throws {
+  open func close(withStatus status: ServerStatus, completion: (() -> Void)?) throws {
     self.status = status
-    completion?(.fakeOK)
+    completion?()
   }
 
   open func waitForSendOperationsToFinish() {}

Sources/SwiftGRPC/Runtime/ServerSessionClientStreaming.swift

@@ -32,11 +32,11 @@ open class ServerSessionClientStreamingBase<InputType: Message, OutputType: Mess
   }
 
   public func sendAndClose(response: OutputType, status: ServerStatus = .ok,
-                           completion: ((CallResult) -> Void)? = nil) throws {
+                           completion: (() -> Void)? = nil) throws {
     try handler.sendResponse(message: response.serializedData(), status: status, completion: completion)
   }
 
-  public func sendErrorAndClose(status: ServerStatus, completion: ((CallResult) -> Void)? = nil) throws {
+  public func sendErrorAndClose(status: ServerStatus, completion: (() -> Void)? = nil) throws {
     try handler.sendStatus(status, completion: completion)
   }
 
@@ -84,15 +84,15 @@ open class ServerSessionClientStreamingTestStub<InputType: Message, OutputType:
     completion(.result(try self.receive()))
   }
 
-  open func sendAndClose(response: OutputType, status: ServerStatus, completion: ((CallResult) -> Void)?) throws {
+  open func sendAndClose(response: OutputType, status: ServerStatus, completion: (() -> Void)?) throws {
     self.output = response
     self.status = status
-    completion?(.fakeOK)
+    completion?()
   }
 
-  open func sendErrorAndClose(status: ServerStatus, completion: ((CallResult) -> Void)? = nil) throws {
+  open func sendErrorAndClose(status: ServerStatus, completion: (() -> Void)? = nil) throws {
     self.status = status
-    completion?(.fakeOK)
+    completion?()
   }
 
   open func close() throws {}

Sources/SwiftGRPC/Runtime/ServerSessionServerStreaming.swift

@@ -76,9 +76,9 @@ open class ServerSessionServerStreamingTestStub<OutputType: Message>: ServerSess
     outputs.append(message)
   }
 
-  open func close(withStatus status: ServerStatus, completion: ((CallResult) -> Void)?) throws {
+  open func close(withStatus status: ServerStatus, completion: (() -> Void)?) throws {
     self.status = status
-    completion?(.fakeOK)
+    completion?()
   }
 
   open func waitForSendOperationsToFinish() {}

Sources/SwiftGRPC/Runtime/StreamSending.swift

@@ -48,7 +48,7 @@ extension StreamSending {
 }
 
 extension StreamSending where Self: ServerSessionBase {
-  public func close(withStatus status: ServerStatus = .ok, completion: ((CallResult) -> Void)? = nil) throws {
+  public func close(withStatus status: ServerStatus = .ok, completion: (() -> Void)? = nil) throws {
     try handler.sendStatus(status, completion: completion)
   }
 }

Sources/protoc-gen-swiftgrpc/Generator-Server.swift

@@ -145,11 +145,11 @@ extension Generator {
   private func printServerMethodSendAndClose(sentType: String) {
     println("/// You MUST call one of these two methods once you are done processing the request.")
     println("/// Close the connection and send a single result. Non-blocking.")
-    println("func sendAndClose(response: \(sentType), status: ServerStatus, completion: ((CallResult) -> Void)?) throws")
+    println("func sendAndClose(response: \(sentType), status: ServerStatus, completion: (() -> Void)?) throws")
     println("/// Close the connection and send an error. Non-blocking.")
     println("/// Use this method if you encountered an error that makes it impossible to send a response.")
     println("/// Accordingly, it does not make sense to call this method with a status of `.ok`.")
-    println("func sendErrorAndClose(status: ServerStatus, completion: ((CallResult) -> Void)?) throws")
+    println("func sendErrorAndClose(status: ServerStatus, completion: (() -> Void)?) throws")
   }
 
   private func printServerMethodClientStreaming() {
@@ -171,7 +171,7 @@ extension Generator {
   private func printServerMethodClose() {
     println("/// Close the connection and send the status. Non-blocking.")
     println("/// You MUST call this method once you are done processing the request.")
-    println("func close(withStatus status: ServerStatus, completion: ((CallResult) -> Void)?) throws")
+    println("func close(withStatus status: ServerStatus, completion: (() -> Void)?) throws")
   }
 
   private func printServerMethodServerStreaming() {

Tests/LinuxMain.swift

@@ -18,10 +18,12 @@ import XCTest
 
 XCTMain([
   testCase(gRPCTests.allTests),
+  testCase(ClientCancellingTests.allTests),
   testCase(ClientTestExample.allTests),
   testCase(ClientTimeoutTests.allTests),
   testCase(ConnectionFailureTests.allTests),
   testCase(EchoTests.allTests),
+  testCase(ServerCancellingTests.allTests),
   testCase(ServerTestExample.allTests),
   testCase(ServerThrowingTests.allTests),
   testCase(ServerTimeoutTests.allTests)

Tests/SwiftGRPCTests/ClientCancellingTests.swift

@@ -0,0 +1,119 @@
+/*
+ * Copyright 2018, gRPC Authors All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import Dispatch
+import Foundation
+@testable import SwiftGRPC
+import XCTest
+
+class ClientCancellingTests: BasicEchoTestCase {
+  static var allTests: [(String, (ClientCancellingTests) -> () throws -> Void)] {
+    return [
+      ("testUnary", testUnary),
+      ("testClientStreaming", testClientStreaming),
+      ("testServerStreaming", testServerStreaming),
+      ("testBidirectionalStreaming", testBidirectionalStreaming),
+    ]
+  }
+  
+  static let lotsOfStrings = (0..<1000).map { String(describing: $0) }
+}
+
+extension ClientCancellingTests {
+  func testUnary() {
+    let completionHandlerExpectation = expectation(description: "final completion handler called")
+    let call = try! client.get(Echo_EchoRequest(text: "foo bar baz")) { response, callResult in
+      XCTAssertNil(response)
+      XCTAssertEqual(.cancelled, callResult.statusCode)
+      completionHandlerExpectation.fulfill()
+    }
+    
+    call.cancel()
+    
+    waitForExpectations(timeout: defaultTimeout)
+  }
+  
+  func testClientStreaming() {
+    let completionHandlerExpectation = expectation(description: "final completion handler called")
+    let call = try! client.collect { callResult in
+      XCTAssertEqual(.cancelled, callResult.statusCode)
+      completionHandlerExpectation.fulfill()
+    }
+    
+    call.cancel()
+    
+    let sendExpectation = expectation(description: "send completion handler 1 called")
+    try! call.send(Echo_EchoRequest(text: "foo")) { [sendExpectation] in XCTAssertEqual(.unknown, $0 as! CallError); sendExpectation.fulfill() }
+    call.waitForSendOperationsToFinish()
+    
+    do {
+      let result = try call.closeAndReceive()
+      XCTFail("should have thrown, received \(result) instead")
+    } catch let receiveError {
+      XCTAssertEqual(.unknown, (receiveError as! RPCError).callResult!.statusCode)
+    }
+    
+    waitForExpectations(timeout: defaultTimeout)
+  }
+  
+  func testServerStreaming() {
+    let completionHandlerExpectation = expectation(description: "completion handler called")
+    let call = try! client.expand(Echo_EchoRequest(text: "foo bar baz")) { callResult in
+      XCTAssertEqual(.cancelled, callResult.statusCode)
+      completionHandlerExpectation.fulfill()
+    }
+    
+    XCTAssertEqual("Swift echo expand (0): foo", try! call.receive()!.text)
+    
+    call.cancel()
+    
+    do {
+      let result = try call.receive()
+      XCTFail("should have thrown, received \(String(describing: result)) instead")
+    } catch let receiveError {
+      XCTAssertEqual(.unknown, (receiveError as! RPCError).callResult!.statusCode)
+    }
+    
+    waitForExpectations(timeout: defaultTimeout)
+  }
+  
+  func testBidirectionalStreaming() {
+    let finalCompletionHandlerExpectation = expectation(description: "final completion handler called")
+    let call = try! client.update { callResult in
+      XCTAssertEqual(.cancelled, callResult.statusCode)
+      finalCompletionHandlerExpectation.fulfill()
+    }
+    
+    var sendExpectation = expectation(description: "send completion handler 1 called")
+    try! call.send(Echo_EchoRequest(text: "foo")) { [sendExpectation] in XCTAssertNil($0); sendExpectation.fulfill() }
+    XCTAssertEqual("Swift echo update (0): foo", try! call.receive()!.text)
+    
+    call.cancel()
+    
+    sendExpectation = expectation(description: "send completion handler 2 called")
+    try! call.send(Echo_EchoRequest(text: "bar")) { [sendExpectation] in XCTAssertEqual(.unknown, $0 as! CallError); sendExpectation.fulfill() }
+    do {
+      let result = try call.receive()
+      XCTFail("should have thrown, received \(String(describing: result)) instead")
+    } catch let receiveError {
+      XCTAssertEqual(.unknown, (receiveError as! RPCError).callResult!.statusCode)
+    }
+    
+    let closeCompletionHandlerExpectation = expectation(description: "close completion handler called")
+    try! call.closeSend { closeCompletionHandlerExpectation.fulfill() }
+    
+    waitForExpectations(timeout: defaultTimeout)
+  }
+}

Tests/SwiftGRPCTests/ClientTimeoutTests.swift

@@ -47,8 +47,8 @@ extension ClientTimeoutTests {
     call.waitForSendOperationsToFinish()
 
     do {
-      _ = try call.closeAndReceive()
-      XCTFail("should have thrown")
+      let result = try call.closeAndReceive()
+      XCTFail("should have thrown, received \(result) instead")
     } catch let receiveError {
       XCTAssertEqual(.unknown, (receiveError as! RPCError).callResult!.statusCode)
     }
@@ -70,8 +70,8 @@ extension ClientTimeoutTests {
     Thread.sleep(forTimeInterval: 0.2)
 
     do {
-      _ = try call.closeAndReceive()
-      XCTFail("should have thrown")
+      let result = try call.closeAndReceive()
+      XCTFail("should have thrown, received \(result) instead")
     } catch let receiveError {
       XCTAssertEqual(.unknown, (receiveError as! RPCError).callResult!.statusCode)
     }