io.gatling.http.util.package.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gatling-http Show documentation
gatling-http
The newest version!
/*
 * Copyright 2011-2024 GatlingCorp (https://gatling.io)
 *
 * 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 io.gatling.http

import java.{ lang => jl }
import java.time.{ Instant, ZoneId }
import java.time.format.DateTimeFormatter

import scala.jdk.CollectionConverters._
import scala.util.control.NonFatal

import io.gatling.commons.util.StringHelper.Eol
import io.gatling.commons.util.Throwables._
import io.gatling.http.client.Request
import io.gatling.http.response.{ HttpResult, Response }
import io.gatling.http.util.HttpHelper.isText

import com.typesafe.scalalogging.LazyLogging
import io.netty.handler.codec.http.HttpHeaders

package object util extends LazyLogging {

  private val bufferFormat = DateTimeFormatter.ofPattern("HH:mm:ss.SSS").withZone(ZoneId.systemDefault())

  private val BodyMaxPrintableLength = 500_000

  implicit class HttpStringBuilder(val buff: jl.StringBuilder) extends AnyVal {
    def appendHttpHeaders(headers: HttpHeaders): jl.StringBuilder = {
      headers.asScala.foreach { entry =>
        buff.append('\t').append(entry.getKey).append(": ").append(entry.getValue).append(Eol)
      }
      buff
    }

    def appendRequest(request: Request): jl.StringBuilder = {
      buff.append(request.getMethod).append(" ").append(request.getUri.toUrl).append(Eol)

      if (!request.getHeaders.isEmpty) {
        buff.append("headers:").append(Eol)
        buff.appendHttpHeaders(request.getHeaders)
      }

      if (!request.getCookies.isEmpty) {
        buff.append("cookies:").append(Eol)
        for (cookie <- request.getCookies.asScala) {
          buff.append('\t').append(cookie).append(Eol)
        }
      }

      Option(request.getBody).foreach { requestBody =>
        buff.append("body:").append(requestBody.print(BodyMaxPrintableLength)).append(Eol)
      }

      if (request.getProxyServer != null) {
        buff.append("proxy:").append(Eol).append('\t').append(request.getProxyServer).append(Eol)
      }

      if (request.getRealm != null) {
        buff.append("realm:").append(Eol).append('\t').append(request.getRealm).append(Eol)
      }

      buff
    }

    def appendWithEol(s: String): jl.StringBuilder =
      buff.append(s).append(Eol)

    def appendResponse(result: HttpResult): jl.StringBuilder =
      result match {
        case response: Response =>
          buff.append("version:").append(Eol).append('\t').append(if (response.isHttp2) "HTTP/2" else "HTTP/1.1").append(Eol)

          buff.append("status:").append(Eol).append('\t').append(response.status).append(Eol)

          if (!response.headers.isEmpty) {
            buff
              .append("headers:")
              .append(Eol)
              .appendHttpHeaders(response.headers)
              .append(Eol)
          }

          if (response.body.length > 0) {
            buff.append("body:").append(Eol)
            if (isText(response.headers)) {
              try {
                val bodyString = response.body.string
                if (bodyString.length > BodyMaxPrintableLength) {
                  buff.append(response.body.string, 0, BodyMaxPrintableLength).append("...")
                } else {
                  buff.append(response.body.string)
                }

              } catch {
                case NonFatal(t) =>
                  val message = "Could not decode response body"
                  logger.trace(message, t)
                  buff.append(s"$message: ${t.rootMessage}")
              }
            } else {
              buff.append("<<>>")
            }
            buff.append(Eol)
          } else {
            buff
          }
        case _ => buff
      }

    def appendWebsocketInboundMessages(messageBuffer: Seq[(Long, String)]): jl.StringBuilder = {
      messageBuffer.zipWithIndex
        .foreach { case ((timestamp, message), index) =>
          val time = bufferFormat.format(Instant.ofEpochMilli(timestamp))
          buff.append(s"$time [$index] -> $message").append(Eol)
        }

      buff
    }
  }
}