kinesis4cats.smithy4s.client.middleware.ResponseLogger.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kinesis4cats-smithy4s-client_sjs1_2.13 Show documentation
Cats tooling for the Smithy4s Kinesis Client
The newest version!
/*
 * Copyright 2023-2023 etspaceman
 *
 * 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 kinesis4cats.smithy4s.client
package middleware

import cats.effect.{Async, Ref, Resource}
import cats.syntax.all._
import fs2.{Chunk, Pipe, Stream}
import org.http4s.Response
import org.http4s.client.Client
import org.typelevel.log4cats.StructuredLogger

import kinesis4cats.logging.LogContext

/** Mostly copied from the Http4s
  * [[https://github.com/http4s/http4s/blob/series/0.23/client/shared/src/main/scala/org/http4s/client/middleware/ResponseLogger.scala ResponseLogger]].
  * Main difference is that this logs information to the context rather than the
  * message body. Also uses debug/trace instead of info.
  */
object ResponseLogger {

  /** Apply
    * [[kinesis4cats.smithy4s.client.middleware.ResponseLogger ResponseLogger]]
    * middleware to a [[https://http4s.org/v0.23/docs/client.html Client]]
    *
    * @param logger
    *   [[org.typelevel.log4cats.StructuredLogger StructuredLogger]]
    * @param client
    *   [[https://http4s.org/v0.23/docs/client.html Client]]
    * @param F
    *   [[cats.effect.Async Async]]
    * @param encoders
    *   [[kinesis4cats.smithy4s.client.KinesisClient.LogEncoders KinesisClient.LogEncoders]]
    * @return
    *   [[https://http4s.org/v0.23/docs/client.html Client]] that logs its
    *   requests in debug and trace levels
    */
  def apply[F[_]](
      logger: StructuredLogger[F],
      encoders: KinesisClient.LogEncoders[F] = KinesisClient.LogEncoders.show[F]
  )(client: Client[F])(implicit
      F: Async[F]
  ): Client[F] = {
    import encoders._

    def logResponse(response: Response[F]): Resource[F, Response[F]] =
      Resource.suspend {
        val ctx = LogContext().addEncoded("response", response)

        Ref[F].of(Vector.empty[Chunk[Byte]]).map { vec =>
          val dumpChunksToVec: Pipe[F, Byte, Nothing] =
            _.chunks.flatMap(s => Stream.exec(vec.update(_ :+ s)))

          val observeDumpChunks: Pipe[F, Byte, Byte] =
            _.observe(dumpChunksToVec)

          Resource.make(
            // Cannot Be Done Asynchronously - Otherwise All Chunks May Not Be Appended before Finalization
            F.pure(response.withBodyStream(observeDumpChunks(response.body)))
          ) { _ =>
            val newBody = Stream.eval(vec.get).flatMap(Stream.emits).unchunks
            val newResponseBody: Response[F] = response.withBodyStream(newBody)

            for {
              _ <- logger.debug(ctx.context)("Successfully completed request")
              body <- newResponseBody.as[String]
              _ <- logger
                .trace(ctx.addEncoded("responseBody", body).context)(
                  "Logging response body"
                )
                .handleErrorWith(t =>
                  logger.error(ctx.context, t)("Error logging response body")
                )
            } yield ()
          }
        }
      }

    Client(req => client.run(req).flatMap(logResponse))
  }

}