forked from http4s/http4s
/
BlazeClientBuilder.scala
277 lines (243 loc) · 11 KB
/
BlazeClientBuilder.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
package org.http4s
package client
package blaze
import cats.implicits._
import cats.effect._
import java.nio.channels.AsynchronousChannelGroup
import javax.net.ssl.SSLContext
import org.http4s.blaze.channel.ChannelOptions
import org.http4s.blaze.util.TickWheelExecutor
import org.http4s.blazecore.{BlazeBackendBuilder, tickWheelResource}
import org.http4s.headers.{AgentProduct, `User-Agent`}
import org.http4s.internal.BackendBuilder
import org.log4s.getLogger
import scala.concurrent.ExecutionContext
import scala.concurrent.duration._
/**
* @param sslContext Some custom `SSLContext`, or `None` if the
* default SSL context is to be lazily instantiated.
*/
sealed abstract class BlazeClientBuilder[F[_]] private (
val responseHeaderTimeout: Duration,
val idleTimeout: Duration,
val requestTimeout: Duration,
val connectTimeout: Duration,
val userAgent: Option[`User-Agent`],
val maxTotalConnections: Int,
val maxWaitQueueLimit: Int,
val maxConnectionsPerRequestKey: RequestKey => Int,
val sslContext: Option[SSLContext],
val checkEndpointIdentification: Boolean,
val maxResponseLineSize: Int,
val maxHeaderLength: Int,
val maxChunkSize: Int,
val chunkBufferMaxSize: Int,
val parserMode: ParserMode,
val bufferSize: Int,
val executionContext: ExecutionContext,
val scheduler: Resource[F, TickWheelExecutor],
val asynchronousChannelGroup: Option[AsynchronousChannelGroup],
val channelOptions: ChannelOptions
)(implicit protected val F: ConcurrentEffect[F])
extends BlazeBackendBuilder[Client[F]]
with BackendBuilder[F, Client[F]] {
type Self = BlazeClientBuilder[F]
final protected val logger = getLogger(this.getClass)
private def copy(
responseHeaderTimeout: Duration = responseHeaderTimeout,
idleTimeout: Duration = idleTimeout,
requestTimeout: Duration = requestTimeout,
connectTimeout: Duration = connectTimeout,
userAgent: Option[`User-Agent`] = userAgent,
maxTotalConnections: Int = maxTotalConnections,
maxWaitQueueLimit: Int = maxWaitQueueLimit,
maxConnectionsPerRequestKey: RequestKey => Int = maxConnectionsPerRequestKey,
sslContext: Option[SSLContext] = sslContext,
checkEndpointIdentification: Boolean = checkEndpointIdentification,
maxResponseLineSize: Int = maxResponseLineSize,
maxHeaderLength: Int = maxHeaderLength,
maxChunkSize: Int = maxChunkSize,
chunkBufferMaxSize: Int = chunkBufferMaxSize,
parserMode: ParserMode = parserMode,
bufferSize: Int = bufferSize,
executionContext: ExecutionContext = executionContext,
scheduler: Resource[F, TickWheelExecutor] = scheduler,
asynchronousChannelGroup: Option[AsynchronousChannelGroup] = asynchronousChannelGroup,
channelOptions: ChannelOptions = channelOptions
): BlazeClientBuilder[F] =
new BlazeClientBuilder[F](
responseHeaderTimeout = responseHeaderTimeout,
idleTimeout = idleTimeout,
requestTimeout = requestTimeout,
connectTimeout = connectTimeout,
userAgent = userAgent,
maxTotalConnections = maxTotalConnections,
maxWaitQueueLimit = maxWaitQueueLimit,
maxConnectionsPerRequestKey = maxConnectionsPerRequestKey,
sslContext = sslContext,
checkEndpointIdentification = checkEndpointIdentification,
maxResponseLineSize = maxResponseLineSize,
maxHeaderLength = maxHeaderLength,
maxChunkSize = maxChunkSize,
chunkBufferMaxSize = chunkBufferMaxSize,
parserMode = parserMode,
bufferSize = bufferSize,
executionContext = executionContext,
scheduler = scheduler,
asynchronousChannelGroup = asynchronousChannelGroup,
channelOptions = channelOptions
) {}
def withResponseHeaderTimeout(responseHeaderTimeout: Duration): BlazeClientBuilder[F] =
copy(responseHeaderTimeout = responseHeaderTimeout)
def withMaxHeaderLength(maxHeaderLength: Int): BlazeClientBuilder[F] =
copy(maxHeaderLength = maxHeaderLength)
def withIdleTimeout(idleTimeout: Duration): BlazeClientBuilder[F] =
copy(idleTimeout = idleTimeout)
def withRequestTimeout(requestTimeout: Duration): BlazeClientBuilder[F] =
copy(requestTimeout = requestTimeout)
def withConnectTimeout(connectTimeout: Duration): BlazeClientBuilder[F] =
copy(connectTimeout = connectTimeout)
def withUserAgentOption(userAgent: Option[`User-Agent`]): BlazeClientBuilder[F] =
copy(userAgent = userAgent)
def withUserAgent(userAgent: `User-Agent`): BlazeClientBuilder[F] =
withUserAgentOption(Some(userAgent))
def withoutUserAgent: BlazeClientBuilder[F] =
withUserAgentOption(None)
def withMaxTotalConnections(maxTotalConnections: Int): BlazeClientBuilder[F] =
copy(maxTotalConnections = maxTotalConnections)
def withMaxWaitQueueLimit(maxWaitQueueLimit: Int): BlazeClientBuilder[F] =
copy(maxWaitQueueLimit = maxWaitQueueLimit)
def withMaxConnectionsPerRequestKey(
maxConnectionsPerRequestKey: RequestKey => Int): BlazeClientBuilder[F] =
copy(maxConnectionsPerRequestKey = maxConnectionsPerRequestKey)
/** Use the provided `SSLContext` when making secure calls */
def withSslContext(sslContext: SSLContext): BlazeClientBuilder[F] =
copy(sslContext = Some(sslContext))
/** Use an `SSLContext` obtained by `SSLContext.getDefault()` when making secure calls.
*
* The creation of the context is lazy, as `SSLContext.getDefault()` throws on some
* platforms. The context creation is deferred until the first secure client call.
*/
def withDefaultSslContext: BlazeClientBuilder[F] =
copy(sslContext = None)
@deprecated("Use `withSslContext` or `withDefaultSslContext`", "0.20.2")
def withSslContextOption(sslContext: Option[SSLContext]): BlazeClientBuilder[F] =
copy(sslContext = sslContext)
@deprecated("Use `withDefaultSslContext`", "0.20.2")
def withoutSslContext: BlazeClientBuilder[F] =
withDefaultSslContext
def withCheckEndpointAuthentication(checkEndpointIdentification: Boolean): BlazeClientBuilder[F] =
copy(checkEndpointIdentification = checkEndpointIdentification)
def withMaxResponseLineSize(maxResponseLineSize: Int): BlazeClientBuilder[F] =
copy(maxResponseLineSize = maxResponseLineSize)
def withMaxChunkSize(maxChunkSize: Int): BlazeClientBuilder[F] =
copy(maxChunkSize = maxChunkSize)
def withChunkBufferMaxSize(chunkBufferMaxSize: Int): BlazeClientBuilder[F] =
copy(chunkBufferMaxSize = chunkBufferMaxSize)
def withParserMode(parserMode: ParserMode): BlazeClientBuilder[F] =
copy(parserMode = parserMode)
def withBufferSize(bufferSize: Int): BlazeClientBuilder[F] =
copy(bufferSize = bufferSize)
def withExecutionContext(executionContext: ExecutionContext): BlazeClientBuilder[F] =
copy(executionContext = executionContext)
def withScheduler(scheduler: TickWheelExecutor): BlazeClientBuilder[F] =
copy(scheduler = scheduler.pure[Resource[F, ?]])
def withAsynchronousChannelGroupOption(
asynchronousChannelGroup: Option[AsynchronousChannelGroup]): BlazeClientBuilder[F] =
copy(asynchronousChannelGroup = asynchronousChannelGroup)
def withAsynchronousChannelGroup(
asynchronousChannelGroup: AsynchronousChannelGroup): BlazeClientBuilder[F] =
withAsynchronousChannelGroupOption(Some(asynchronousChannelGroup))
def withoutAsynchronousChannelGroup: BlazeClientBuilder[F] =
withAsynchronousChannelGroupOption(None)
def withChannelOptions(channelOptions: ChannelOptions): BlazeClientBuilder[F] =
copy(channelOptions = channelOptions)
def resource: Resource[F, Client[F]] =
scheduler.flatMap { scheduler =>
verifyAllTimeoutsAccuracy(scheduler)
connectionManager(scheduler).map { manager =>
BlazeClient.makeClient(
manager = manager,
responseHeaderTimeout = responseHeaderTimeout,
idleTimeout = idleTimeout,
requestTimeout = requestTimeout,
scheduler = scheduler,
ec = executionContext
)
}
}
private def verifyAllTimeoutsAccuracy(scheduler: TickWheelExecutor): Unit = {
verifyTimeoutAccuracy(scheduler.tick, responseHeaderTimeout, "responseHeaderTimeout")
verifyTimeoutAccuracy(scheduler.tick, idleTimeout, "idleTimeout")
verifyTimeoutAccuracy(scheduler.tick, requestTimeout, "requestTimeout")
verifyTimeoutAccuracy(scheduler.tick, connectTimeout, "connectTimeout")
}
private def verifyTimeoutAccuracy(
tick: Duration,
timeout: Duration,
timeoutName: String): Unit = {
val warningThreshold = 0.1 // 10%
val inaccuracy = tick / timeout
if (inaccuracy > warningThreshold) {
logger.warn(
s"With current configuration $timeoutName ($timeout) may be up to ${inaccuracy * 100}% longer than configured. " +
s"If timeout accuracy is important, consider using a scheduler with a shorter tick (currently $tick).")
}
}
private def connectionManager(scheduler: TickWheelExecutor)(
implicit F: ConcurrentEffect[F]): Resource[F, ConnectionManager[F, BlazeConnection[F]]] = {
val http1: ConnectionBuilder[F, BlazeConnection[F]] = new Http1Support(
sslContextOption = sslContext,
bufferSize = bufferSize,
asynchronousChannelGroup = asynchronousChannelGroup,
executionContext = executionContext,
scheduler = scheduler,
checkEndpointIdentification = checkEndpointIdentification,
maxResponseLineSize = maxResponseLineSize,
maxHeaderLength = maxHeaderLength,
maxChunkSize = maxChunkSize,
chunkBufferMaxSize = chunkBufferMaxSize,
parserMode = parserMode,
userAgent = userAgent,
channelOptions = channelOptions,
connectTimeout = connectTimeout
).makeClient
Resource.make(
ConnectionManager.pool(
builder = http1,
maxTotal = maxTotalConnections,
maxWaitQueueLimit = maxWaitQueueLimit,
maxConnectionsPerRequestKey = maxConnectionsPerRequestKey,
responseHeaderTimeout = responseHeaderTimeout,
requestTimeout = requestTimeout,
executionContext = executionContext
))(_.shutdown)
}
}
object BlazeClientBuilder {
def apply[F[_]: ConcurrentEffect](
executionContext: ExecutionContext,
sslContext: Option[SSLContext] = None): BlazeClientBuilder[F] =
new BlazeClientBuilder[F](
responseHeaderTimeout = 10.seconds,
idleTimeout = 1.minute,
requestTimeout = 1.minute,
connectTimeout = 10.seconds,
userAgent = Some(`User-Agent`(AgentProduct("http4s-blaze", Some(BuildInfo.version)))),
maxTotalConnections = 10,
maxWaitQueueLimit = 256,
maxConnectionsPerRequestKey = Function.const(256),
sslContext = sslContext,
checkEndpointIdentification = true,
maxResponseLineSize = 4096,
maxHeaderLength = 40960,
maxChunkSize = Int.MaxValue,
chunkBufferMaxSize = 1024 * 1024,
parserMode = ParserMode.Strict,
bufferSize = 8192,
executionContext = executionContext,
scheduler = tickWheelResource,
asynchronousChannelGroup = None,
channelOptions = ChannelOptions(Vector.empty)
) {}
}