Move request logging

Author: adamw

core/src/main/scala/sttp/client4/RequestOptions.scala

@@ -2,12 +2,14 @@ package sttp.client4
 
 import scala.concurrent.duration.Duration
 import sttp.model.HttpVersion
+import sttp.client4.logging.LoggingOptions
 
 case class RequestOptions(
     followRedirects: Boolean,
     readTimeout: Duration, // TODO: Use FiniteDuration while migrating to sttp-4
     maxRedirects: Int,
     redirectToGet: Boolean,
     disableAutoDecompression: Boolean,
-    httpVersion: Option[HttpVersion]
+    httpVersion: Option[HttpVersion],
+    loggingOptions: LoggingOptions
 )

core/src/main/scala/sttp/client4/SttpApi.scala

@@ -10,6 +10,7 @@ import scala.concurrent.duration._
 import sttp.capabilities.Streams
 import sttp.capabilities.Effect
 import sttp.client4.wrappers.FollowRedirectsBackend
+import sttp.client4.logging.LoggingOptions
 
 trait SttpApi extends SttpExtensions with UriInterpolator {
   val DefaultReadTimeout: Duration = 1.minute
@@ -30,7 +31,8 @@ trait SttpApi extends SttpExtensions with UriInterpolator {
         FollowRedirectsBackend.MaxRedirects,
         redirectToGet = false,
         disableAutoDecompression = false,
-        httpVersion = None
+        httpVersion = None,
+        loggingOptions = LoggingOptions()
       ),
       Map()
     )

core/src/main/scala/sttp/client4/logging/Log.scala

@@ -57,15 +57,11 @@ class DefaultLog[F[_]](
 ) extends Log[F] {
 
   def beforeRequestSend(request: GenericRequest[_, _]): F[Unit] =
-    request.loggingOptions match {
-      case Some(options) =>
-        before(
-          request,
-          options.logRequestBody.getOrElse(logRequestBody),
-          options.logRequestHeaders.getOrElse(logRequestHeaders)
-        )
-      case None => before(request, logRequestBody, logRequestHeaders)
-    }
+    before(
+      request,
+      request.loggingOptions.logRequestBody.getOrElse(logRequestBody),
+      request.loggingOptions.logRequestHeaders.getOrElse(logRequestHeaders)
+    )
 
   private def before(request: GenericRequest[_, _], _logRequestBody: Boolean, _logRequestHeaders: Boolean): F[Unit] =
     logger(
@@ -82,19 +78,14 @@ class DefaultLog[F[_]](
       response: Response[_],
       responseBody: Option[String],
       elapsed: Option[Duration]
-  ): F[Unit] = request.loggingOptions match {
-    case Some(options) =>
-      handleResponse(
-        request.showBasic,
-        response,
-        responseBody,
-        options.logResponseBody.getOrElse(responseBody.isDefined),
-        options.logResponseHeaders.getOrElse(logResponseHeaders),
-        elapsed
-      )
-    case None =>
-      handleResponse(request.showBasic, response, responseBody, responseBody.isDefined, logResponseHeaders, elapsed)
-  }
+  ): F[Unit] = handleResponse(
+    request.showBasic,
+    response,
+    responseBody,
+    request.loggingOptions.logResponseBody.getOrElse(responseBody.isDefined),
+    request.loggingOptions.logResponseHeaders.getOrElse(logResponseHeaders),
+    elapsed
+  )
 
   private def handleResponse(
       showBasic: String,

core/src/main/scala/sttp/client4/requestBuilder.scala

@@ -302,8 +302,6 @@ trait PartialRequestBuilder[+PR <: PartialRequestBuilder[PR, R], +R]
     */
   def autoDecompressionDisabled: Boolean = options.disableAutoDecompression
 
-  // TODO: add similar functionality to Response
-
   /** Set the HTTP version with which this request should be sent. Supported only in a few backends. */
   def httpVersion(version: HttpVersion): PR = withOptions(options.copy(httpVersion = Some(version)))
 
@@ -315,30 +313,33 @@ trait PartialRequestBuilder[+PR <: PartialRequestBuilder[PR, R], +R]
     */
   def httpVersion: Option[HttpVersion] = options.httpVersion
 
-  private val loggingOptionsTagKey = "loggingOptions"
-
-  /** Will only have effect when using the `LoggingBackend` */
-  def logSettings(
+  /** Sets per-request logging options. Will only have effect when using the [[sttp.client4.logging.LoggingBackend]]
+    * wrapper.
+    */
+  def loggingOptions(
       logRequestBody: Option[Boolean] = None,
       logResponseBody: Option[Boolean] = None,
       logRequestHeaders: Option[Boolean] = None,
       logResponseHeaders: Option[Boolean] = None
-  ): PR = {
-    val loggingOptions = LoggingOptions(
-      logRequestBody = logRequestBody,
-      logResponseBody = logResponseBody,
-      logRequestHeaders = logRequestHeaders,
-      logResponseHeaders = logResponseHeaders
+  ): PR = withOptions(
+    options.copy(loggingOptions =
+      LoggingOptions(
+        logRequestBody = logRequestBody,
+        logResponseBody = logResponseBody,
+        logRequestHeaders = logRequestHeaders,
+        logResponseHeaders = logResponseHeaders
+      )
     )
-    this.tag(loggingOptionsTagKey, loggingOptions)
-  }
+  )
 
-  def logSettings(
-      loggingOptions: Option[LoggingOptions]
-  ): PR =
-    this.tag(loggingOptionsTagKey, loggingOptions)
+  /** Sets per-request logging options. Will only have effect when using the [[sttp.client4.logging.LoggingBackend]]
+    * wrapper.
+    */
+  def loggingOptions(loggingOptions: LoggingOptions): PR = withOptions(options.copy(loggingOptions = loggingOptions))
 
-  def loggingOptions: Option[LoggingOptions] = tag(loggingOptionsTagKey).asInstanceOf[Option[LoggingOptions]]
+  /** The per-request logging options, which have effect when using the [[sttp.client4.logging.LoggingBackend]] wrapper.
+    */
+  def loggingOptions: LoggingOptions = options.loggingOptions
 
   def show(
       includeBody: Boolean = true,