-
Notifications
You must be signed in to change notification settings - Fork 420
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix crashes due to mismatching responses sent to the channel when eve…
…nt observer factories fail. (#395) * Fix crashes due to mismatching responses sent to the channel when event observer factories fail. * Tweak `newFailedFuture`. * PR fixes. * Minor comment improvements. * PR fixes.
- Loading branch information
Showing
8 changed files
with
195 additions
and
8 deletions.
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
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
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
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,152 @@ | ||
| /* | ||
| * 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 | ||
| import NIO | ||
| import NIOHTTP1 | ||
| import NIOHTTP2 | ||
| @testable import SwiftGRPCNIO | ||
| import XCTest | ||
|
|
||
| private let expectedError = GRPCStatus(code: .internalError, message: "expected error") | ||
|
|
||
| // Motivation for two different providers: Throwing immediately causes the event observer future (in the | ||
| // client-streaming and bidi-streaming cases) to throw immediately, _before_ the corresponding handler has even added | ||
| // to the channel. We want to test that case as well as the one where we throw only _after_ the handler has been added | ||
| // to the channel. | ||
| private class ImmediateThrowingEchoProviderNIO: Echo_EchoProvider_NIO { | ||
| func get(request: Echo_EchoRequest, context: StatusOnlyCallContext) -> EventLoopFuture<Echo_EchoResponse> { | ||
| return context.eventLoop.newFailedFuture(error: expectedError) | ||
| } | ||
|
|
||
| func expand(request: Echo_EchoRequest, context: StreamingResponseCallContext<Echo_EchoResponse>) -> EventLoopFuture<GRPCStatus> { | ||
| return context.eventLoop.newFailedFuture(error: expectedError) | ||
| } | ||
|
|
||
| func collect(context: UnaryResponseCallContext<Echo_EchoResponse>) -> EventLoopFuture<(StreamEvent<Echo_EchoRequest>) -> Void> { | ||
| return context.eventLoop.newFailedFuture(error: expectedError) | ||
| } | ||
|
|
||
| func update(context: StreamingResponseCallContext<Echo_EchoResponse>) -> EventLoopFuture<(StreamEvent<Echo_EchoRequest>) -> Void> { | ||
| return context.eventLoop.newFailedFuture(error: expectedError) | ||
| } | ||
| } | ||
|
|
||
| private extension EventLoop { | ||
| func newFailedFuture<T>(error: Error, delay: TimeInterval) -> EventLoopFuture<T> { | ||
| return self.scheduleTask(in: .nanoseconds(TimeAmount.Value(delay * 1000 * 1000 * 1000))) { () }.futureResult | ||
| .thenThrowing { _ -> T in throw error } | ||
| } | ||
| } | ||
|
|
||
| /// See `ImmediateThrowingEchoProviderNIO`. | ||
| private class DelayedThrowingEchoProviderNIO: Echo_EchoProvider_NIO { | ||
| func get(request: Echo_EchoRequest, context: StatusOnlyCallContext) -> EventLoopFuture<Echo_EchoResponse> { | ||
| return context.eventLoop.newFailedFuture(error: expectedError, delay: 0.01) | ||
| } | ||
|
|
||
| func expand(request: Echo_EchoRequest, context: StreamingResponseCallContext<Echo_EchoResponse>) -> EventLoopFuture<GRPCStatus> { | ||
| return context.eventLoop.newFailedFuture(error: expectedError, delay: 0.01) | ||
| } | ||
|
|
||
| func collect(context: UnaryResponseCallContext<Echo_EchoResponse>) -> EventLoopFuture<(StreamEvent<Echo_EchoRequest>) -> Void> { | ||
| return context.eventLoop.newFailedFuture(error: expectedError, delay: 0.01) | ||
| } | ||
|
|
||
| func update(context: StreamingResponseCallContext<Echo_EchoResponse>) -> EventLoopFuture<(StreamEvent<Echo_EchoRequest>) -> Void> { | ||
| return context.eventLoop.newFailedFuture(error: expectedError, delay: 0.01) | ||
| } | ||
| } | ||
|
|
||
| /// Ensures that fulfilling the status promise (where possible) with an error yields the same result as failing the future. | ||
| private class ErrorReturningEchoProviderNIO: ImmediateThrowingEchoProviderNIO { | ||
| // There's no status promise to fulfill for unary calls (only the response promise), so that case is omitted. | ||
|
|
||
| override func expand(request: Echo_EchoRequest, context: StreamingResponseCallContext<Echo_EchoResponse>) -> EventLoopFuture<GRPCStatus> { | ||
| return context.eventLoop.newSucceededFuture(result: expectedError) | ||
| } | ||
|
|
||
| override func collect(context: UnaryResponseCallContext<Echo_EchoResponse>) -> EventLoopFuture<(StreamEvent<Echo_EchoRequest>) -> Void> { | ||
| return context.eventLoop.newSucceededFuture(result: { _ in | ||
| context.responseStatus = expectedError | ||
| context.responsePromise.succeed(result: Echo_EchoResponse()) | ||
| }) | ||
| } | ||
|
|
||
| override func update(context: StreamingResponseCallContext<Echo_EchoResponse>) -> EventLoopFuture<(StreamEvent<Echo_EchoRequest>) -> Void> { | ||
| return context.eventLoop.newSucceededFuture(result: { _ in | ||
| context.statusPromise.succeed(result: expectedError) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| class ServerThrowingTests: NIOBasicEchoTestCase { | ||
| override func makeEchoProvider() -> Echo_EchoProvider_NIO { return ImmediateThrowingEchoProviderNIO() } | ||
|
|
||
| static var allTests: [(String, (ServerThrowingTests) -> () throws -> Void)] { | ||
| return [ | ||
| ("testUnary", testUnary), | ||
| ("testClientStreaming", testClientStreaming), | ||
| ("testServerStreaming", testServerStreaming), | ||
| ("testBidirectionalStreaming", testBidirectionalStreaming), | ||
| ] | ||
| } | ||
| } | ||
|
|
||
| class ServerDelayedThrowingTests: ServerThrowingTests { | ||
| override func makeEchoProvider() -> Echo_EchoProvider_NIO { return DelayedThrowingEchoProviderNIO() } | ||
| } | ||
|
|
||
| class ClientThrowingWhenServerReturningErrorTests: ServerThrowingTests { | ||
| override func makeEchoProvider() -> Echo_EchoProvider_NIO { return ErrorReturningEchoProviderNIO() } | ||
| } | ||
|
|
||
| extension ServerThrowingTests { | ||
| func testUnary() throws { | ||
| let call = client.get(Echo_EchoRequest(text: "foo")) | ||
| XCTAssertEqual(expectedError, try call.status.wait()) | ||
| XCTAssertThrowsError(try call.response.wait()) { | ||
| XCTAssertEqual(expectedError, $0 as? GRPCStatus) | ||
| } | ||
| } | ||
|
|
||
| func testClientStreaming() { | ||
| let call = client.collect() | ||
| XCTAssertNoThrow(try call.sendEnd().wait()) | ||
| XCTAssertEqual(expectedError, try call.status.wait()) | ||
|
|
||
| if type(of: makeEchoProvider()) != ErrorReturningEchoProviderNIO.self { | ||
| // With `ErrorReturningEchoProviderNIO` we actually _return_ a response, which means that the `response` future | ||
| // will _not_ fail, so in that case this test doesn't apply. | ||
| XCTAssertThrowsError(try call.response.wait()) { | ||
| XCTAssertEqual(expectedError, $0 as? GRPCStatus) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func testServerStreaming() { | ||
| let call = client.expand(Echo_EchoRequest(text: "foo")) { XCTFail("no message expected, got \($0)") } | ||
| // Nothing to throw here, but the `status` should be the expected error. | ||
| XCTAssertEqual(expectedError, try call.status.wait()) | ||
| } | ||
|
|
||
| func testBidirectionalStreaming() { | ||
| let call = client.update() { XCTFail("no message expected, got \($0)") } | ||
| XCTAssertNoThrow(try call.sendEnd().wait()) | ||
| // Nothing to throw here, but the `status` should be the expected error. | ||
| XCTAssertEqual(expectedError, try call.status.wait()) | ||
| } | ||
| } |