Skip to content

Commit

Permalink
New configuration parameter for HTTP2 maxFrameSize. (#1253)
Browse files Browse the repository at this point in the history
Motivation:

In gRPC calls that process large payloads, the default settings of the
HTTP2 maxFrameSize (16384) within swift-nio-http2 results in significant
performance impact (for large payloads this performance impact has been
demonstrated to result in timeouts where RPCs fail to complete within
their assigned deadline).

Allowing programmatic configuration of the HTTP2 maxFrameSize when the
server is built allows the parameter to be optimised for the expected
payload sizes.

Modifications:

Added new gRPC configuration parameter for the HTTP2 parameter
maxFrameSize (which can be configured in the Server.Builder using the
new method `withHTTPMaxFrameSize()`).

Result:

The Server.Builder can be used to configure the HTTP2 maxFrameSize
parameter as:

Server.insecure(group: serverGroup).withHTTPMaxFrameSize(1024 * 1024)...
  • Loading branch information
gcjenkinson authored Sep 8, 2021
1 parent 906d48a commit b12b52f
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Sources/GRPC/GRPCServerPipelineConfigurator.swift
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@ final class GRPCServerPipelineConfigurator: ChannelInboundHandler, RemovableChan
parameter: .maxHeaderListSize,
value: HPACKDecoder.defaultMaxHeaderListSize
),
HTTP2Setting(
parameter: .maxFrameSize,
value: self.configuration.httpMaxFrameSize
),
]
)
}
Expand Down
14 changes: 14 additions & 0 deletions Sources/GRPC/Server.swift
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,14 @@ extension Server {
}
}

/// The HTTP/2 max frame size. Defaults to 16384. Value is clamped between 2^14 and 2^24-1
/// octets inclusive (the minimum and maximum allowable values - HTTP/2 RFC 7540 4.2).
public var httpMaxFrameSize: Int = 16384 {
didSet(httpMaxFrameSize) {
self.httpMaxFrameSize = httpMaxFrameSize.clamped(to: 16384 ... 16_777_215)
}
}

/// The root server logger. Accepted connections will branch from this logger and RPCs on
/// each connection will use a logger branched from the connections logger. This logger is made
/// available to service providers via `context`. Defaults to a no-op logger.
Expand Down Expand Up @@ -447,3 +455,9 @@ private extension ServerBootstrapProtocol {
}
}
}

extension Comparable {
fileprivate func clamped(to range: ClosedRange<Self>) -> Self {
return min(max(self, range.lowerBound), range.upperBound)
}
}
8 changes: 8 additions & 0 deletions Sources/GRPC/ServerBuilder.swift
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,14 @@ extension Server.Builder {
}
}

extension Server.Builder {
@discardableResult
public func withHTTPMaxFrameSize(_ httpMaxFrameSize: Int) -> Self {
self.configuration.httpMaxFrameSize = httpMaxFrameSize
return self
}
}

extension Server.Builder {
/// Sets the root server logger. Accepted connections will branch from this logger and RPCs on
/// each connection will use a logger branched from the connections logger. This logger is made
Expand Down

0 comments on commit b12b52f

Please sign in to comment.