-
Notifications
You must be signed in to change notification settings - Fork 6
/
ServerMiddleware.scala
327 lines (278 loc) · 13.9 KB
/
ServerMiddleware.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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
package io.chrisdavenport.natchezhttp4sotel
import cats._
import cats.syntax.all._
import cats.effect.kernel._
import cats.effect.syntax.all._
import org.http4s._
import org.typelevel.ci.CIString
import natchez._
import scala.collection.mutable.ListBuffer
import org.http4s.headers._
import org.http4s.client._
import io.chrisdavenport.fiberlocal._
import cats.data.OptionT
import java.net.URI
import cats.arrow.FunctionK
object ServerMiddleware {
def default[F[_]: MonadCancelThrow: GenFiberLocal](ep: EntryPoint[F]): ServerMiddlewareBuilder[F] =
new ServerMiddlewareBuilder[F](ep, Defaults.isKernelHeader, Defaults.reqHeaders, Defaults.respHeaders, Defaults.routeClassifier, Defaults.serverSpanName, Defaults.additionalRequestTags, Defaults.additionalResponseTags, Defaults.includeUrl)
object Defaults {
val isKernelHeader: CIString => Boolean = name => !ExcludedHeaders.contains(name)
val reqHeaders: Set[CIString] = OTHttpTags.Headers.defaultHeadersIncluded
val respHeaders: Set[CIString] = OTHttpTags.Headers.defaultHeadersIncluded
def routeClassifier[F[_]]: Request[F] => Option[String] = {(_: Request[F]) => None}
def serverSpanName[F[_]]: Request[F] => String = {(req: Request[F]) => s"Http Server - ${req.method}"}
def additionalRequestTags[F[_]]: Request[F] => Seq[(String, TraceValue)] = {(_: Request[F]) => Seq()}
def additionalResponseTags[F[_]]: Response[F] => Seq[(String, TraceValue)] = {(_: Response[F]) => Seq()}
def includeUrl[F[_]]: Request[F] => Boolean = {(_: Request[F]) => true}
}
final class ServerMiddlewareBuilder[F[_]: MonadCancelThrow: GenFiberLocal] private[ServerMiddleware] (
ep: EntryPoint[F],
isKernelHeader: CIString => Boolean,
reqHeaders: Set[CIString],
respHeaders: Set[CIString],
routeClassifier: Request[F] => Option[String],
serverSpanName: Request[F] => String,
additionalRequestTags: Request[F] => Seq[(String, TraceValue)],
additionalResponseTags: Response[F] => Seq[(String, TraceValue)],
includeUrl: Request[F] => Boolean,
){ self =>
private def copy(
ep: EntryPoint[F] = self.ep,
isKernelHeader: CIString => Boolean = self.isKernelHeader,
reqHeaders: Set[CIString] = self.reqHeaders,
respHeaders: Set[CIString] = self.respHeaders,
routeClassifier: Request[F] => Option[String] = self.routeClassifier,
serverSpanName: Request[F] => String = self.serverSpanName,
additionalRequestTags: Request[F] => Seq[(String, TraceValue)] = self.additionalRequestTags,
additionalResponseTags: Response[F] => Seq[(String, TraceValue)] = self.additionalResponseTags,
includeUrl: Request[F] => Boolean = self.includeUrl,
): ServerMiddlewareBuilder[F] =
new ServerMiddlewareBuilder[F](ep, isKernelHeader, reqHeaders, respHeaders, routeClassifier, serverSpanName, additionalRequestTags, additionalResponseTags, includeUrl)
def withIsKernelHeader(isKernelHeader: CIString => Boolean) = copy(isKernelHeader = isKernelHeader)
def withRequestHeaders(reqHeaders: Set[CIString]) = copy(reqHeaders = reqHeaders)
def withResponseHeaders(respHeaders: Set[CIString]) = copy(respHeaders = respHeaders)
def withRouteClassifier(routeClassifier: Request[F] => Option[String]) = copy(routeClassifier = routeClassifier)
def withServerSpanName(serverSpanName: Request[F] => String) = copy(serverSpanName = serverSpanName)
def withAdditionalRequestTags(additionalRequestTags: Request[F] => Seq[(String, TraceValue)]) = copy(additionalRequestTags = additionalRequestTags)
def withAdditionalResponseTags(additionalResponseTags: Response[F] => Seq[(String, TraceValue)]) = copy(additionalResponseTags = additionalResponseTags)
def withIncludeUrl(includeUrl: Request[F] => Boolean) = copy(includeUrl = includeUrl)
def buildHttpApp(f: Trace[F] => HttpApp[F]): HttpApp[F] =
MakeSureYouKnowWhatYouAreDoing.buildTracedF(FunctionK.id)(f.andThen(_.pure[F]))
def buildHttpRoutes(f: Trace[F] => HttpRoutes[F]): HttpRoutes[F] =
MakeSureYouKnowWhatYouAreDoing.buildTracedF(OptionT.liftK)(f.andThen(OptionT.pure[F](_)))
final class MakeSureYouKnowWhatYouAreDoing{
def buildTracedF[G[_]: MonadCancelThrow](fk: F ~> G)(f: Trace[F] => G[Http[G, F]]): Http[G, F] = {
cats.data.Kleisli{(req: Request[F]) =>
val kernelHeaders = req.headers.headers
.collect {
case header if isKernelHeader(header.name) => header.name -> header.value
}
.toMap
val kernel = Kernel(kernelHeaders)
MonadCancelThrow[G].uncancelable(poll =>
ep.continueOrElseRoot(serverSpanName(req), kernel).mapK(fk).use{span =>
val init = request(req, reqHeaders, routeClassifier, includeUrl) ++ additionalRequestTags(req)
fk(span.put(init:_*)) >>
fk(GenFiberLocal[F].local(span)).map(fromFiberLocal(_))
.flatMap( trace =>
poll(f(trace).flatMap(_.run(req))).guaranteeCase{
case Outcome.Succeeded(fa) =>
fk(span.put("exit.case" -> "succeeded")) >>
fa.flatMap{resp =>
val out = response(resp, respHeaders) ++ additionalResponseTags(resp)
fk(span.put(out:_*))
}
case Outcome.Errored(e) =>
fk(span.put("exit.case" -> "errored")) >>
fk(span.put(OTHttpTags.Errors.error(e):_*))
case Outcome.Canceled() =>
fk(span.put(
"exit.case" -> "canceled",
"canceled" -> true,
"error" -> true // A cancelled http is an error for the server. The connection got cut for some reason.
))
}
)
}
)
}
}
}
def MakeSureYouKnowWhatYouAreDoing = new MakeSureYouKnowWhatYouAreDoing
}
// Recommended to get best tracing
@deprecated("0.2.1", "Direct Method is Deprecated, use default with the builder instead.")
def httpApp[F[_]: MonadCancelThrow: GenFiberLocal](
ep: EntryPoint[F],
isKernelHeader: CIString => Boolean = name => !ExcludedHeaders.contains(name),
reqHeaders: Set[CIString] = OTHttpTags.Headers.defaultHeadersIncluded,
respHeaders: Set[CIString] = OTHttpTags.Headers.defaultHeadersIncluded,
routeClassifier: Request[F] => Option[String] = {(_: Request[F]) => None},
serverSpanName: Request[F] => String = {(req: Request[F]) => s"Http Server - ${req.method}"},
additionalRequestTags: Request[F] => Seq[(String, TraceValue)] = {(_: Request[F]) => Seq()},
additionalResponseTags: Response[F] => Seq[(String, TraceValue)] = {(_: Response[F]) => Seq()},
)(f: Trace[F] => HttpApp[F]): HttpApp[F] =
default(ep)
.withIsKernelHeader(isKernelHeader)
.withRequestHeaders(reqHeaders)
.withResponseHeaders(respHeaders)
.withRouteClassifier(routeClassifier)
.withServerSpanName(serverSpanName)
.withAdditionalRequestTags(additionalRequestTags)
.withAdditionalResponseTags(additionalResponseTags)
.buildHttpApp(f)
@deprecated("0.2.1", "Direct Method is Deprecated, use default with the builder instead.")
def httpRoutes[F[_]: MonadCancelThrow: GenFiberLocal](
ep: EntryPoint[F],
isKernelHeader: CIString => Boolean = name => !ExcludedHeaders.contains(name),
reqHeaders: Set[CIString] = OTHttpTags.Headers.defaultHeadersIncluded,
respHeaders: Set[CIString] = OTHttpTags.Headers.defaultHeadersIncluded,
routeClassifier: Request[F] => Option[String] = {(_: Request[F]) => None},
serverSpanName: Request[F] => String = {(req: Request[F]) => s"Http Server - ${req.method}"},
additionalRequestTags: Request[F] => Seq[(String, TraceValue)] = {(_: Request[F]) => Seq()},
additionalResponseTags: Response[F] => Seq[(String, TraceValue)] = {(_: Response[F]) => Seq()},
)(f: Trace[F] => HttpRoutes[F]): HttpRoutes[F] =
default(ep)
.withIsKernelHeader(isKernelHeader)
.withRequestHeaders(reqHeaders)
.withResponseHeaders(respHeaders)
.withRouteClassifier(routeClassifier)
.withServerSpanName(serverSpanName)
.withAdditionalRequestTags(additionalRequestTags)
.withAdditionalResponseTags(additionalResponseTags)
.buildHttpRoutes(f)
object MakeSureYouKnowWhatYouAreDoing {
// This effect to generate routes will run on every request.
// This is often undesired and can generate a lot of wasted state if used
// incorrectly. Should never be used to instantiate global state across request,
// the effect is scoped to a single request in. But as we see for the fiberlocal
// with this can be pretty useful when its what you need.
@deprecated("0.2.1", "Direct Method is Deprecated, use default with the builder instead.")
def tracedF[F[_]: MonadCancelThrow: GenFiberLocal, G[_]: MonadCancelThrow](
ep: EntryPoint[F],
fk: F ~> G,
isKernelHeader: CIString => Boolean = name => !ExcludedHeaders.contains(name),
reqHeaders: Set[CIString] = OTHttpTags.Headers.defaultHeadersIncluded,
respHeaders: Set[CIString] = OTHttpTags.Headers.defaultHeadersIncluded,
routeClassifier: Request[F] => Option[String] = {(_: Request[F]) => None},
serverSpanName: Request[F] => String = {(req: Request[F]) => s"Http Server - ${req.method}"},
additionalRequestTags: Request[F] => Seq[(String, TraceValue)] = {(_: Request[F]) => Seq()},
additionalResponseTags: Response[F] => Seq[(String, TraceValue)] = {(_: Response[F]) => Seq()},
)(
f: Trace[F] => G[Http[G, F]]
): Http[G, F] =
default(ep)
.withIsKernelHeader(isKernelHeader)
.withRequestHeaders(reqHeaders)
.withResponseHeaders(respHeaders)
.withRouteClassifier(routeClassifier)
.withServerSpanName(serverSpanName)
.withAdditionalRequestTags(additionalRequestTags)
.withAdditionalResponseTags(additionalResponseTags)
.MakeSureYouKnowWhatYouAreDoing
.buildTracedF(fk)(f)
}
private[natchezhttp4sotel] def request[F[_]](req: Request[F], headers: Set[CIString], routeClassifier: Request[F] => Option[String]): List[(String, TraceValue)] = {
request(req, headers, routeClassifier, Function.const[Boolean, Request[F]](true))
}
def request[F[_]](request: Request[F], headers: Set[CIString], routeClassifier: Request[F] => Option[String], includeUrl: Request[F] => Boolean): List[(String, TraceValue)] = {
val builder = new ListBuffer[(String, TraceValue)]()
builder += OTHttpTags.Common.kind("server")
builder += OTHttpTags.Common.method(request.method)
if (includeUrl(request)) {
builder += OTHttpTags.Common.url(request.uri)
builder += OTHttpTags.Common.target(request.uri)
}
val host = request.headers.get[Host].getOrElse{
val key = RequestKey.fromRequest(request)
Host(key.authority.host.value, key.authority.port)
}
builder += OTHttpTags.Common.host(host)
request.uri.scheme.foreach( s =>
builder += OTHttpTags.Common.scheme(s)
)
request.headers.get[`User-Agent`].foreach( ua =>
builder += OTHttpTags.Common.userAgent(ua)
)
request.contentLength.foreach(l =>
builder += OTHttpTags.Common.requestContentLength(l)
)
routeClassifier(request).foreach(s =>
builder += OTHttpTags.Server.route(s)
)
builder += OTHttpTags.Common.flavor(request.httpVersion)
request.remote.foreach{sa =>
builder +=
OTHttpTags.Common.peerIp(sa.host)
builder +=
OTHttpTags.Common.peerPort(sa.port)
}
// Special Server
request.from.foreach(ip =>
builder += OTHttpTags.Server.clientIp(ip)
)
builder ++=
OTHttpTags.Headers.request(request.headers, headers)
builder.toList
}
def response[F[_]](response: Response[F], headers: Set[CIString]): List[(String, TraceValue)] = {
val builder = new ListBuffer[(String, TraceValue)]()
builder += OTHttpTags.Common.status(response.status)
response.contentLength.foreach(l =>
builder += OTHttpTags.Common.responseContentLength(l)
)
builder ++=
OTHttpTags.Headers.response(response.headers, headers)
builder.toList
}
private def fromFiberLocal[F[_]: MonadCancelThrow](local: FiberLocal[F, Span[F]]): natchez.Trace[F] = {
new Trace[F] {
override def put(fields: (String, TraceValue)*): F[Unit] =
local.get.flatMap(_.put(fields: _*))
override def attachError(err: Throwable, fields: (String, TraceValue)*): F[Unit] =
local.get.flatMap(_.attachError(err, fields: _*))
override def log(fields: (String, TraceValue)*): F[Unit] =
local.get.flatMap(_.log(fields: _*))
override def log(event: String): F[Unit] =
local.get.flatMap(_.log(event))
override def kernel: F[Kernel] =
local.get.flatMap(_.kernel)
override def spanR(name: String, options: Span.Options): Resource[F, F ~> F] =
for {
parent <- Resource.eval(local.get)
child <- parent.span(name, options)
} yield new (F ~> F) {
def apply[A](fa: F[A]): F[A] =
local.get.flatMap { old =>
local
.set(child)
.bracket(_ => fa.onError{ case e => child.attachError(e)})(_ => local.set(old))
}
}
override def span[A](name: String, options: Span.Options)(k: F[A]): F[A] =
spanR(name, options).use(_(k))
override def traceId: F[Option[String]] =
local.get.flatMap(_.traceId)
override def traceUri: F[Option[URI]] =
local.get.flatMap(_.traceUri)
}
}
val ExcludedHeaders: Set[CIString] = {
import org.http4s.headers._
import org.typelevel.ci._
val payload = Set(
`Content-Length`.name,
ci"Content-Type",
`Content-Range`.name,
ci"Trailer",
`Transfer-Encoding`.name,
)
val security = Set(
Authorization.name,
Cookie.name,
`Set-Cookie`.name,
)
payload ++ security
}
}