Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move server connection management tests to swift-testing #14

Merged
merged 1 commit into from
Oct 15, 2024
Merged

Move server connection management tests to swift-testing #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions Sources/GRPCNIOTransportCore/Server/Connection/ServerConnectionManagementHandler.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
* limitations under the License.
*/

internal import GRPCCore
internal import NIOCore
internal import NIOHTTP2
internal import NIOTLS
private import GRPCCore
package import NIOCore
package import NIOHTTP2
private import NIOTLS

/// A `ChannelHandler` which manages the lifecycle of a gRPC connection over HTTP/2.
///
Expand All @@ -39,11 +39,11 @@ internal import NIOTLS
/// Some of the behaviours are described in:
/// - [gRFC A8](https://github.com/grpc/proposal/blob/master/A8-client-side-keepalive.md), and
/// - [gRFC A9](https://github.com/grpc/proposal/blob/master/A9-server-side-conn-mgt.md).
final class ServerConnectionManagementHandler: ChannelDuplexHandler {
typealias InboundIn = HTTP2Frame
typealias InboundOut = HTTP2Frame
typealias OutboundIn = HTTP2Frame
typealias OutboundOut = HTTP2Frame
package final class ServerConnectionManagementHandler: ChannelDuplexHandler {
package typealias InboundIn = HTTP2Frame
package typealias InboundOut = HTTP2Frame
package typealias OutboundIn = HTTP2Frame
package typealias OutboundOut = HTTP2Frame

/// The `EventLoop` of the `Channel` this handler exists in.
private let eventLoop: any EventLoop
Expand Down Expand Up @@ -98,7 +98,7 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
/// While NIO's `EmbeddedEventLoop` provides control over its view of time (and therefore any
/// events scheduled on it) it doesn't offer a way to get the current time. This is usually done
/// via `NIODeadline`.
enum Clock {
package enum Clock {
case nio
case manual(Manual)

Expand All @@ -111,14 +111,14 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
}
}

final class Manual {
package final class Manual {
private(set) var time: NIODeadline

init() {
package init() {
self.time = .uptimeNanoseconds(0)
}

func advance(by amount: TimeAmount) {
package func advance(by amount: TimeAmount) {
self.time = self.time + amount
}
}
Expand Down Expand Up @@ -147,23 +147,23 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
}

/// A synchronous view over this handler.
var syncView: SyncView {
package var syncView: SyncView {
return SyncView(self)
}

/// A synchronous view over this handler.
///
/// Methods on this view *must* be called from the same `EventLoop` as the `Channel` in which
/// this handler exists.
struct SyncView {
package struct SyncView {
private let handler: ServerConnectionManagementHandler

fileprivate init(_ handler: ServerConnectionManagementHandler) {
self.handler = handler
}

/// Notify the handler that the connection has received a flush event.
func connectionWillFlush() {
package func connectionWillFlush() {
// The handler can't rely on `flush(context:)` due to its expected position in the pipeline.
// It's expected to be placed after the HTTP/2 handler (i.e. closer to the application) as
// it needs to receive HTTP/2 frames. However, flushes from stream channels aren't sent down
Expand All @@ -178,13 +178,13 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
}

/// Notify the handler that a HEADERS frame was written in the last write loop.
func wroteHeadersFrame() {
package func wroteHeadersFrame() {
self.handler.eventLoop.assertInEventLoop()
self.handler.frameStats.wroteHeaders()
}

/// Notify the handler that a DATA frame was written in the last write loop.
func wroteDataFrame() {
package func wroteDataFrame() {
self.handler.eventLoop.assertInEventLoop()
self.handler.frameStats.wroteData()
}
Expand All @@ -208,7 +208,7 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
/// keep-alive pings. Pings more frequent than this interval count as 'strikes' and the
/// connection is closed if there are too many strikes.
/// - clock: A clock providing the current time.
init(
package init(
eventLoop: any EventLoop,
maxIdleTime: TimeAmount?,
maxAge: TimeAmount?,
Expand Down Expand Up @@ -248,16 +248,16 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
self.requireALPN = requireALPN
}

func handlerAdded(context: ChannelHandlerContext) {
package func handlerAdded(context: ChannelHandlerContext) {
assert(context.eventLoop === self.eventLoop)
self.context = context
}

func handlerRemoved(context: ChannelHandlerContext) {
package func handlerRemoved(context: ChannelHandlerContext) {
self.context = nil
}

func channelActive(context: ChannelHandlerContext) {
package func channelActive(context: ChannelHandlerContext) {
let view = LoopBoundView(handler: self, context: context)

self.maxAgeTimer?.schedule(on: context.eventLoop) {
Expand All @@ -275,7 +275,7 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
context.fireChannelActive()
}

func channelInactive(context: ChannelHandlerContext) {
package func channelInactive(context: ChannelHandlerContext) {
self.maxIdleTimer?.cancel()
self.maxAgeTimer?.cancel()
self.maxGraceTimer?.cancel()
Expand All @@ -284,7 +284,7 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
context.fireChannelInactive()
}

func userInboundEventTriggered(context: ChannelHandlerContext, event: Any) {
package func userInboundEventTriggered(context: ChannelHandlerContext, event: Any) {
switch event {
case let event as NIOHTTP2StreamCreatedEvent:
self._streamCreated(event.streamID, channel: context.channel)
Expand Down Expand Up @@ -314,7 +314,7 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
context.fireUserInboundEventTriggered(event)
}

func channelRead(context: ChannelHandlerContext, data: NIOAny) {
package func channelRead(context: ChannelHandlerContext, data: NIOAny) {
self.inReadLoop = true

// Any read data indicates that the connection is alive so cancel the keep-alive timers.
Expand All @@ -337,7 +337,7 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
context.fireChannelRead(data)
}

func channelReadComplete(context: ChannelHandlerContext) {
package func channelReadComplete(context: ChannelHandlerContext) {
while self.flushPending {
self.flushPending = false
context.flush()
Expand All @@ -354,7 +354,7 @@ final class ServerConnectionManagementHandler: ChannelDuplexHandler {
context.fireChannelReadComplete()
}

func flush(context: ChannelHandlerContext) {
package func flush(context: ChannelHandlerContext) {
self.maybeFlush(context: context)
}
}
Expand Down Expand Up @@ -383,7 +383,7 @@ extension ServerConnectionManagementHandler {
}

extension ServerConnectionManagementHandler {
struct HTTP2StreamDelegate: @unchecked Sendable, NIOHTTP2StreamDelegate {
package struct HTTP2StreamDelegate: @unchecked Sendable, NIOHTTP2StreamDelegate {
// @unchecked is okay: the only methods do the appropriate event-loop dance.

private let handler: ServerConnectionManagementHandler
Expand All @@ -392,7 +392,7 @@ extension ServerConnectionManagementHandler {
self.handler = handler
}

func streamCreated(_ id: HTTP2StreamID, channel: any Channel) {
package func streamCreated(_ id: HTTP2StreamID, channel: any Channel) {
if self.handler.eventLoop.inEventLoop {
self.handler._streamCreated(id, channel: channel)
} else {
Expand All @@ -402,7 +402,7 @@ extension ServerConnectionManagementHandler {
}
}

func streamClosed(_ id: HTTP2StreamID, channel: any Channel) {
package func streamClosed(_ id: HTTP2StreamID, channel: any Channel) {
if self.handler.eventLoop.inEventLoop {
self.handler._streamClosed(id, channel: channel)
} else {
Expand All @@ -413,7 +413,7 @@ extension ServerConnectionManagementHandler {
}
}

var http2StreamDelegate: HTTP2StreamDelegate {
package var http2StreamDelegate: HTTP2StreamDelegate {
return HTTP2StreamDelegate(self)
}

Expand Down
Loading
Loading