Merge pull request #184 from MrMage/more-improvements

improved error handling and structure throughout the project

Author: timburks

.gitignore

@@ -2,16 +2,11 @@
 project.xcworkspace
 xcuserdata
 .build
-protoc-gen-swift
-protoc-gen-swiftgrpc
+/protoc-gen-swift
+/protoc-gen-swiftgrpc
 third_party/**
-Plugin/Packages/**
-Plugin/Sources/protoc-gen-swiftgrpc/templates.swift
-Plugin/protoc-*
-Plugin/swiftgrpc.log
-Plugin/echo.*.swift
-Echo
-test.out
-echo.pid
-SwiftGRPC.xcodeproj
+/Echo
+/test.out
+/echo.pid
+/SwiftGRPC.xcodeproj
 Package.resolved

.travis-install.sh

@@ -28,7 +28,7 @@
 cd
 mkdir -p local
 
-if [ $TRAVIS_OS_NAME == "osx" ]; then
+if [ "$TRAVIS_OS_NAME" == "osx" ]; then
   PROTOC_URL=https://github.com/google/protobuf/releases/download/v3.5.1/protoc-3.5.1-osx-x86_64.zip
 else
   # Install swift

.travis.yml

@@ -19,6 +19,12 @@ os:
   - linux
   - osx
 
+cache:
+  apt: true
+  directories:
+    - .build/checkouts
+    - .build/repositories
+
 # Use Ubuntu 14.04
 dist: trusty
 
@@ -29,23 +35,25 @@ sudo: false
 addons:
   apt:
     packages:
-    - clang-3.8 
-    - lldb-3.8 
-    - libicu-dev 
-    - libtool 
-    - libcurl4-openssl-dev 
-    - libbsd-dev 
-    - build-essential 
-    - libssl-dev 
-    - uuid-dev
-    - curl
-    - unzip
+      - clang-3.8 
+      - lldb-3.8 
+      - libicu-dev 
+      - libtool 
+      - libcurl4-openssl-dev 
+      - libbsd-dev 
+      - build-essential 
+      - libssl-dev 
+      - uuid-dev
+      - curl
+      - unzip
 
 install: ./.travis-install.sh
 
 script: 
   - export PATH=$HOME/local/bin:$PATH
   - export LD_LIBRARY_PATH=$HOME/local/lib
+  - swift package -v resolve
+  - make all
   - make test
   - make test-plugin
   - make test-echo

Examples/EchoXcode/Echo/EchoViewController.swift

@@ -44,7 +44,7 @@ class EchoViewController: NSViewController, NSTextFieldDelegate {
       do {
         try callServer(address: addressField.stringValue,
                        host: "example.com")
-      } catch (let error) {
+      } catch {
         print(error)
       }
     }
@@ -54,7 +54,7 @@ class EchoViewController: NSViewController, NSTextFieldDelegate {
     if nowStreaming {
       do {
         try sendClose()
-      } catch (let error) {
+      } catch {
         print(error)
       }
     }
@@ -66,7 +66,7 @@ class EchoViewController: NSViewController, NSTextFieldDelegate {
     if nowStreaming {
       do {
         try sendClose()
-      } catch (let error) {
+      } catch {
         print(error)
       }
     }
@@ -76,7 +76,7 @@ class EchoViewController: NSViewController, NSTextFieldDelegate {
     if nowStreaming {
       do {
         try sendClose()
-      } catch (let error) {
+      } catch {
         print(error)
       }
     }
@@ -151,7 +151,7 @@ class EchoViewController: NSViewController, NSTextFieldDelegate {
           }
           try receiveExpandMessages()
           displayMessageSent(requestMessage.text)
-        } catch (let error) {
+        } catch {
           self.displayMessageReceived("No message received. \(error)")
         }
       }
@@ -169,7 +169,7 @@ class EchoViewController: NSViewController, NSTextFieldDelegate {
           }
         }
         try sendCollectMessage()
-      } catch (let error) {
+      } catch {
         self.displayMessageReceived("No message received. \(error)")
       }
     } else if callSelectButton.selectedSegment == 3 {
@@ -187,7 +187,7 @@ class EchoViewController: NSViewController, NSTextFieldDelegate {
           }
         }
         try sendUpdateMessage()
-      } catch (let error) {
+      } catch {
         self.displayMessageReceived("No message received. \(error)")
       }
     }

Examples/Google/NaturalLanguage/Sources/main.swift

@@ -55,7 +55,7 @@ if let provider = DefaultTokenProvider(scopes: scopes) {
       do {
         let result = try service.annotatetext(request)
         print("\(result)")
-      } catch (let error) {
+      } catch {
         print("ERROR: \(error)")
       }
     }

Examples/SimpleXcode/Simple/Document.swift

@@ -181,8 +181,8 @@ class Document: NSDocument {
               }
             }
           }
-        } catch (let callError) {
-          Swift.print("call error \(callError)")
+        } catch {
+          Swift.print("call error \(error)")
         }
         self.log("------------------------------")
         sleep(1)
@@ -241,8 +241,8 @@ class Document: NSDocument {
                                         trailingMetadata: trailingMetadataToSend)
 
         self.log("------------------------------")
-      } catch (let callError) {
-        Swift.print("call error \(callError)")
+      } catch {
+        Swift.print("call error \(error)")
       }
     }
 

Makefile

@@ -8,6 +8,8 @@ all:
 
 project:
 	swift package generate-xcodeproj
+# Optional: set the generated project's indentation settings.
+	-ruby fix-indentation-settings.rb
 
 test:	all
 	swift test -v $(CFLAGS)

Package.swift

@@ -23,15 +23,15 @@ let package = Package(
     .library(name: "SwiftGRPC", targets: ["SwiftGRPC"]),
   ],
   dependencies: [
-    .package(url: "https://github.com/Zewo/zlib.git", from: "0.4.0"),
+    .package(url: "https://github.com/apple/swift-nio-zlib-support.git", from: "1.0.0"),
     .package(url: "https://github.com/apple/swift-protobuf.git", from: "1.0.2"),
     .package(url: "https://github.com/kylef/Commander.git", from: "0.8.0")
   ],
   targets: [
     .target(name: "SwiftGRPC",
             dependencies: ["CgRPC", "SwiftProtobuf"]),
     .target(name: "CgRPC",
-            dependencies: ["BoringSSL", "zlib"]),
+            dependencies: ["BoringSSL"]),
     .target(name: "RootsEncoder"),
     .target(name: "protoc-gen-swiftgrpc",
             dependencies: [

Sources/Examples/Echo/EchoProvider.swift

@@ -38,32 +38,34 @@ class EchoProvider: Echo_EchoProvider {
       }
     }
     session.waitForSendOperationsToFinish()
+    try session.close(withStatus: .ok, completion: nil)
   }
 
   // collect collects a sequence of messages and returns them concatenated when the caller closes.
   func collect(session: Echo_EchoCollectSession) throws {
     var parts: [String] = []
     while true {
       do {
-        let request = try session.receive()
+        guard let request = try session.receive()
+          else { break }  // End of stream
         parts.append(request.text)
-      } catch ServerError.endOfStream {
+      } catch {
+        print("collect error: \(error)")
         break
-      } catch (let error) {
-        print("\(error)")
       }
     }
     var response = Echo_EchoResponse()
     response.text = "Swift echo collect: " + parts.joined(separator: " ")
-    try session.sendAndClose(response)
+    try session.sendAndClose(response: response, status: .ok, completion: nil)
   }
 
   // update streams back messages as they are received in an input stream.
   func update(session: Echo_EchoUpdateSession) throws {
     var count = 0
     while true {
       do {
-        let request = try session.receive()
+        guard let request = try session.receive()
+          else { break }  // End of stream
         var response = Echo_EchoResponse()
         response.text = "Swift echo update (\(count)): \(request.text)"
         count += 1
@@ -72,14 +74,12 @@ class EchoProvider: Echo_EchoProvider {
             print("update error: \(error)")
           }
         }
-      } catch ServerError.endOfStream {
-        break
-      } catch (let error) {
-        print("\(error)")
+      } catch {
+        print("update error: \(error)")
         break
       }
     }
     session.waitForSendOperationsToFinish()
-    try session.close()
+    try session.close(withStatus: .ok, completion: nil)
   }
 }

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

@@ -33,9 +33,9 @@ fileprivate final class Echo_EchoGetCallBase: ClientCallUnaryBase<Echo_EchoReque
 
 internal protocol Echo_EchoExpandCall: ClientCallServerStreaming {
   /// Call this to wait for a result. Blocking.
-  func receive() throws -> Echo_EchoResponse
+  func receive() throws -> Echo_EchoResponse?
   /// Call this to wait for a result. Nonblocking.
-  func receive(completion: @escaping (Echo_EchoResponse?, ClientError?) -> Void) throws
+  func receive(completion: @escaping (ResultOrRPCError<Echo_EchoResponse?>) -> Void) throws
 }
 
 fileprivate final class Echo_EchoExpandCallBase: ClientCallServerStreamingBase<Echo_EchoRequest, Echo_EchoResponse>, Echo_EchoExpandCall {
@@ -47,13 +47,15 @@ class Echo_EchoExpandCallTestStub: ClientCallServerStreamingTestStub<Echo_EchoRe
 }
 
 internal protocol Echo_EchoCollectCall: ClientCallClientStreaming {
-  /// Call this to send each message in the request stream. Nonblocking.
+  /// Send a message to the stream. Nonblocking.
   func send(_ message: Echo_EchoRequest, completion: @escaping (Error?) -> Void) throws
+  /// Send a message to the stream and wait for the send operation to finish. Blocking.
+  func send(_ message: Echo_EchoRequest) throws
 
   /// Call this to close the connection and wait for a response. Blocking.
   func closeAndReceive() throws -> Echo_EchoResponse
   /// Call this to close the connection and wait for a response. Nonblocking.
-  func closeAndReceive(completion: @escaping (Echo_EchoResponse?, ClientError?) -> Void) throws
+  func closeAndReceive(completion: @escaping (ResultOrRPCError<Echo_EchoResponse>) -> Void) throws
 }
 
 fileprivate final class Echo_EchoCollectCallBase: ClientCallClientStreamingBase<Echo_EchoRequest, Echo_EchoResponse>, Echo_EchoCollectCall {
@@ -68,12 +70,14 @@ class Echo_EchoCollectCallTestStub: ClientCallClientStreamingTestStub<Echo_EchoR
 
 internal protocol Echo_EchoUpdateCall: ClientCallBidirectionalStreaming {
   /// Call this to wait for a result. Blocking.
-  func receive() throws -> Echo_EchoResponse
+  func receive() throws -> Echo_EchoResponse?
   /// Call this to wait for a result. Nonblocking.
-  func receive(completion: @escaping (Echo_EchoResponse?, ClientError?) -> Void) throws
+  func receive(completion: @escaping (ResultOrRPCError<Echo_EchoResponse?>) -> Void) throws
 
-  /// Call this to send each message in the request stream.
+  /// Send a message to the stream. Nonblocking.
   func send(_ message: Echo_EchoRequest, completion: @escaping (Error?) -> Void) throws
+  /// Send a message to the stream and wait for the send operation to finish. Blocking.
+  func send(_ message: Echo_EchoRequest) throws
 
   /// Call this to close the sending connection. Blocking.
   func closeSend() throws
@@ -201,35 +205,53 @@ fileprivate final class Echo_EchoGetSessionBase: ServerSessionUnaryBase<Echo_Ech
 class Echo_EchoGetSessionTestStub: ServerSessionUnaryTestStub, Echo_EchoGetSession {}
 
 internal protocol Echo_EchoExpandSession: ServerSessionServerStreaming {
-  /// Send a message. Nonblocking.
-  func send(_ response: Echo_EchoResponse, completion: ((Error?) -> Void)?) throws
+  /// Send a message to the stream. Nonblocking.
+  func send(_ message: Echo_EchoResponse, completion: @escaping (Error?) -> Void) throws
+  /// Send a message to the stream and wait for the send operation to finish. Blocking.
+  func send(_ message: Echo_EchoResponse) throws
+
+  /// 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: (() -> Void)?) throws
 }
 
 fileprivate final class Echo_EchoExpandSessionBase: ServerSessionServerStreamingBase<Echo_EchoRequest, Echo_EchoResponse>, Echo_EchoExpandSession {}
 
 class Echo_EchoExpandSessionTestStub: ServerSessionServerStreamingTestStub<Echo_EchoResponse>, Echo_EchoExpandSession {}
 
 internal protocol Echo_EchoCollectSession: ServerSessionClientStreaming {
-  /// Receive a message. Blocks until a message is received or the client closes the connection.
-  func receive() throws -> Echo_EchoRequest
-
-  /// Send a response and close the connection.
-  func sendAndClose(_ response: Echo_EchoResponse) throws
+  /// Call this to wait for a result. Blocking.
+  func receive() throws -> Echo_EchoRequest?
+  /// Call this to wait for a result. Nonblocking.
+  func receive(completion: @escaping (ResultOrRPCError<Echo_EchoRequest?>) -> Void) throws
+
+  /// 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: (() -> 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: (() -> Void)?) throws
 }
 
 fileprivate final class Echo_EchoCollectSessionBase: ServerSessionClientStreamingBase<Echo_EchoRequest, Echo_EchoResponse>, Echo_EchoCollectSession {}
 
 class Echo_EchoCollectSessionTestStub: ServerSessionClientStreamingTestStub<Echo_EchoRequest, Echo_EchoResponse>, Echo_EchoCollectSession {}
 
 internal protocol Echo_EchoUpdateSession: ServerSessionBidirectionalStreaming {
-  /// Receive a message. Blocks until a message is received or the client closes the connection.
-  func receive() throws -> Echo_EchoRequest
+  /// Call this to wait for a result. Blocking.
+  func receive() throws -> Echo_EchoRequest?
+  /// Call this to wait for a result. Nonblocking.
+  func receive(completion: @escaping (ResultOrRPCError<Echo_EchoRequest?>) -> Void) throws
 
-  /// Send a message. Nonblocking.
-  func send(_ response: Echo_EchoResponse, completion: ((Error?) -> Void)?) throws
+  /// Send a message to the stream. Nonblocking.
+  func send(_ message: Echo_EchoResponse, completion: @escaping (Error?) -> Void) throws
+  /// Send a message to the stream and wait for the send operation to finish. Blocking.
+  func send(_ message: Echo_EchoResponse) throws
 
-  /// Close a connection. Blocks until the connection is closed.
-  func close() throws
+  /// 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: (() -> Void)?) throws
 }
 
 fileprivate final class Echo_EchoUpdateSessionBase: ServerSessionBidirectionalStreamingBase<Echo_EchoRequest, Echo_EchoResponse>, Echo_EchoUpdateSession {}