-
Notifications
You must be signed in to change notification settings - Fork 789
/
ResponseLogger.scala
142 lines (128 loc) · 5.2 KB
/
ResponseLogger.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
/*
* Copyright 2014 http4s.org
*
* 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.
*/
package org.http4s
package server
package middleware
import cats.arrow.FunctionK
import cats.data.Kleisli
import cats.data.OptionT
import cats.effect.kernel.Async
import cats.effect.kernel.MonadCancelThrow
import cats.effect.kernel.Outcome
import cats.effect.syntax.all._
import cats.syntax.all._
import cats.~>
import fs2.Chunk
import fs2.Pipe
import fs2.Stream
import org.typelevel.ci.CIString
/** Simple middleware for logging responses as they are processed
*/
object ResponseLogger {
private[this] val logger = Platform.loggerFactory.getLogger
def apply[G[_], F[_], A](
logHeaders: Boolean,
logBody: Boolean,
fk: F ~> G,
redactHeadersWhen: CIString => Boolean = Headers.SensitiveHeaders.contains,
logAction: Option[String => F[Unit]] = None,
)(
http: Kleisli[G, A, Response[F]]
)(implicit G: MonadCancelThrow[G], F: Async[F]): Kleisli[G, A, Response[F]] =
impl[G, F, A](logHeaders, Left(logBody), fk, redactHeadersWhen, logAction)(http)
private[server] def impl[G[_], F[_], A](
logHeaders: Boolean,
logBodyText: Either[Boolean, Stream[F, Byte] => Option[F[String]]],
fk: F ~> G,
redactHeadersWhen: CIString => Boolean,
logAction: Option[String => F[Unit]],
)(
http: Kleisli[G, A, Response[F]]
)(implicit G: MonadCancelThrow[G], F: Async[F]): Kleisli[G, A, Response[F]] = {
val fallback: String => F[Unit] = s => logger.info(s).to[F]
val log = logAction.fold(fallback)(identity)
def logMessage(resp: Response[F]): F[Unit] =
logBodyText match {
case Left(bool) =>
Logger.logMessage[F, Response[F]](resp)(logHeaders, bool, redactHeadersWhen)(log(_))
case Right(f) =>
org.http4s.internal.Logger
.logMessageWithBodyText(resp)(logHeaders, f, redactHeadersWhen)(log(_))
}
val logBody: Boolean = logBodyText match {
case Left(bool) => bool
case Right(_) => true
}
def logResponse(response: Response[F]): F[Response[F]] =
if (!logBody)
logMessage(response)
.as(response)
else
F.ref(Vector.empty[Chunk[Byte]]).map { vec =>
val newBody = Stream.eval(vec.get).flatMap(v => Stream.emits(v)).unchunks
// Cannot Be Done Asynchronously - Otherwise All Chunks May Not Be Appended Previous to Finalization
val logPipe: Pipe[F, Byte, Byte] =
_.observe(_.chunks.flatMap(c => Stream.exec(vec.update(_ :+ c))))
.onFinalizeWeak(logMessage(response.withBodyStream(newBody)))
response.pipeBodyThrough(logPipe)
}
Kleisli[G, A, Response[F]] { req =>
http(req)
.flatMap((response: Response[F]) => fk(logResponse(response)))
.guaranteeCase {
case Outcome.Errored(t) => fk(log(s"service raised an error: ${t.getClass}"))
case Outcome.Canceled() => fk(log(s"service canceled response for request"))
case Outcome.Succeeded(_) => G.unit
}
}
}
def httpApp[F[_]: Async, A](
logHeaders: Boolean,
logBody: Boolean,
redactHeadersWhen: CIString => Boolean = Headers.SensitiveHeaders.contains,
logAction: Option[String => F[Unit]] = None,
)(httpApp: Kleisli[F, A, Response[F]]): Kleisli[F, A, Response[F]] =
apply(logHeaders, logBody, FunctionK.id[F], redactHeadersWhen, logAction)(httpApp)
def httpAppLogBodyText[F[_]: Async, A](
logHeaders: Boolean,
logBody: Stream[F, Byte] => Option[F[String]],
redactHeadersWhen: CIString => Boolean = Headers.SensitiveHeaders.contains,
logAction: Option[String => F[Unit]] = None,
)(httpApp: Kleisli[F, A, Response[F]]): Kleisli[F, A, Response[F]] =
impl[F, F, A](logHeaders, Right(logBody), FunctionK.id[F], redactHeadersWhen, logAction)(
httpApp
)
def httpRoutes[F[_]: Async, A](
logHeaders: Boolean,
logBody: Boolean,
redactHeadersWhen: CIString => Boolean = Headers.SensitiveHeaders.contains,
logAction: Option[String => F[Unit]] = None,
)(httpRoutes: Kleisli[OptionT[F, *], A, Response[F]]): Kleisli[OptionT[F, *], A, Response[F]] =
apply(logHeaders, logBody, OptionT.liftK[F], redactHeadersWhen, logAction)(httpRoutes)
def httpRoutesLogBodyText[F[_]: Async, A](
logHeaders: Boolean,
logBody: Stream[F, Byte] => Option[F[String]],
redactHeadersWhen: CIString => Boolean = Headers.SensitiveHeaders.contains,
logAction: Option[String => F[Unit]] = None,
)(httpRoutes: Kleisli[OptionT[F, *], A, Response[F]]): Kleisli[OptionT[F, *], A, Response[F]] =
impl[OptionT[F, *], F, A](
logHeaders,
Right(logBody),
OptionT.liftK[F],
redactHeadersWhen,
logAction,
)(httpRoutes)
}