SentryApollo4HttpInterceptorTest.kt

package io.sentry.apollo4

import com.apollographql.apollo.ApolloCall
import com.apollographql.apollo.ApolloClient
import com.apollographql.apollo.api.ApolloResponse
import com.apollographql.apollo.api.Operation
import com.apollographql.apollo.api.http.HttpRequest
import com.apollographql.apollo.api.http.HttpResponse
import com.apollographql.apollo.exception.ApolloException
import com.apollographql.apollo.exception.ApolloHttpException
import com.apollographql.apollo.network.http.HttpInterceptor
import com.apollographql.apollo.network.http.HttpInterceptorChain
import io.sentry.BaggageHeader
import io.sentry.Breadcrumb
import io.sentry.IScopes
import io.sentry.ITransaction
import io.sentry.Scope
import io.sentry.ScopeCallback
import io.sentry.SentryOptions
import io.sentry.SentryOptions.DEFAULT_PROPAGATION_TARGETS
import io.sentry.SentryTraceHeader
import io.sentry.SentryTracer
import io.sentry.SpanDataConvention
import io.sentry.SpanDataConvention.HTTP_METHOD_KEY
import io.sentry.SpanStatus
import io.sentry.TraceContext
import io.sentry.TracesSamplingDecision
import io.sentry.TransactionContext
import io.sentry.W3CTraceparentHeader
import io.sentry.apollo4.SentryApollo4HttpInterceptor.BeforeSpanCallback
import io.sentry.apollo4.generated.LaunchDetailsQuery
import io.sentry.mockServerRequestTimeoutMillis
import io.sentry.protocol.SdkVersion
import io.sentry.protocol.SentryTransaction
import io.sentry.util.Apollo4PlatformTestManipulator
import java.util.concurrent.TimeUnit
import kotlin.reflect.KSuspendFunction1
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertNotNull
import kotlin.test.assertNull
import kotlin.test.assertTrue
import kotlinx.coroutines.launch
import kotlinx.coroutines.runBlocking
import okhttp3.mockwebserver.MockResponse
import okhttp3.mockwebserver.MockWebServer
import okhttp3.mockwebserver.SocketPolicy
import org.junit.Before
import org.mockito.kotlin.any
import org.mockito.kotlin.anyOrNull
import org.mockito.kotlin.check
import org.mockito.kotlin.doAnswer
import org.mockito.kotlin.mock
import org.mockito.kotlin.verify
import org.mockito.kotlin.whenever

class SentryApollo4HttpInterceptorTestWithV4Implementation :
  SentryApollo4HttpInterceptorTest(ApolloCall<*>::execute)

class SentryApollo4HttpInterceptorTestWithV3Implementation :
  SentryApollo4HttpInterceptorTest(ApolloCall<*>::executeV3)

abstract class SentryApollo4HttpInterceptorTest(
  private val executeQueryImplementation:
    KSuspendFunction1<ApolloCall<*>, ApolloResponse<out Operation.Data>>
) {
  class Fixture {
    val server = MockWebServer()
    val options =
      SentryOptions().apply {
        dsn = "https://key@sentry.io/proj"
        setTracePropagationTargets(listOf(DEFAULT_PROPAGATION_TARGETS))
        sdkVersion = SdkVersion("test", "1.2.3")
      }
    val scope = Scope(options)
    val scopes =
      mock<IScopes>().also {
        whenever(it.options).thenReturn(options)
        doAnswer { (it.arguments[0] as ScopeCallback).run(scope) }
          .whenever(it)
          .configureScope(any())
      }
    private var httpInterceptor =
      SentryApollo4HttpInterceptor(scopes, captureFailedRequests = false)

    @SuppressWarnings("LongParameterList")
    fun getSut(
      httpStatusCode: Int = 200,
      responseBody: String =
        """{
  "data": {
    "launch": {
      "__typename": "Launch",
      "id": "83",
      "site": "CCAFS SLC 40",
      "mission": {
        "__typename": "Mission",
        "name": "Amos-17",
        "missionPatch": "https://images2.imgbox.com/a0/ab/XUoByiuR_o.png"
      }
    }
  }
}""",
      socketPolicy: SocketPolicy = SocketPolicy.KEEP_OPEN,
      interceptor: HttpInterceptor? = null,
      addThirdPartyBaggageHeader: Boolean = false,
      beforeSpan: BeforeSpanCallback? = null,
    ): ApolloClient {
      server.enqueue(
        MockResponse()
          .setBody(responseBody)
          .setSocketPolicy(socketPolicy)
          .setResponseCode(httpStatusCode)
      )

      if (beforeSpan != null) {
        httpInterceptor =
          SentryApollo4HttpInterceptor(scopes, beforeSpan, captureFailedRequests = false)
      }

      val builder =
        ApolloClient.Builder()
          .serverUrl(server.url("/").toString())
          .addHttpInterceptor(httpInterceptor)

      interceptor?.let { builder.addHttpInterceptor(interceptor) }

      if (addThirdPartyBaggageHeader) {
        builder
          .addHttpHeader("baggage", "thirdPartyBaggage=someValue")
          .addHttpHeader(
            "baggage",
            "secondThirdPartyBaggage=secondValue; property;propertyKey=propertyValue,anotherThirdPartyBaggage=anotherValue",
          )
      }

      return builder.build()
    }
  }

  private val fixture = Fixture()

  @Before
  fun setup() {
    Apollo4PlatformTestManipulator.pretendIsAndroid(false)
  }

  @Test
  fun `creates a span around the successful request`() {
    executeQuery()

    verify(fixture.scopes)
      .captureTransaction(
        check {
          assertTransactionDetails(it, httpStatusCode = 200)
          assertEquals(SpanStatus.OK, it.spans.first().status)
        },
        anyOrNull<TraceContext>(),
        anyOrNull(),
        anyOrNull(),
      )
  }

  @Test
  fun `creates a span around the failed request`() {
    executeQuery(fixture.getSut(httpStatusCode = 403))

    verify(fixture.scopes)
      .captureTransaction(
        check {
          assertTransactionDetails(it, httpStatusCode = 403)
          assertEquals(SpanStatus.PERMISSION_DENIED, it.spans.first().status)
        },
        anyOrNull<TraceContext>(),
        anyOrNull(),
        anyOrNull(),
      )
  }

  @Test
  fun `get http status from ApolloHttpException in failed request`() {
    val failingInterceptor =
      object : HttpInterceptor {
        override suspend fun intercept(
          request: HttpRequest,
          chain: HttpInterceptorChain,
        ): HttpResponse = throw ApolloHttpException(404, mock(), mock(), "")
      }
    executeQuery(fixture.getSut(interceptor = failingInterceptor))

    verify(fixture.scopes)
      .captureTransaction(
        check {
          assertTransactionDetails(it, httpStatusCode = 404, contentLength = null)
          assertEquals("POST", it.spans.first().data?.get(SpanDataConvention.HTTP_METHOD_KEY))
          assertEquals(404, it.spans.first().data?.get(SpanDataConvention.HTTP_STATUS_CODE_KEY))
          assertEquals(SpanStatus.NOT_FOUND, it.spans.first().status)
        },
        anyOrNull<TraceContext>(),
        anyOrNull(),
        anyOrNull(),
      )
  }

  @Test
  fun `creates a span around the request failing with network error`() {
    executeQuery(fixture.getSut(socketPolicy = SocketPolicy.DISCONNECT_DURING_REQUEST_BODY))

    verify(fixture.scopes)
      .captureTransaction(
        check {
          assertTransactionDetails(it, httpStatusCode = null, contentLength = null)
          assertEquals(SpanStatus.INTERNAL_ERROR, it.spans.first().status)
        },
        anyOrNull<TraceContext>(),
        anyOrNull(),
        anyOrNull(),
      )
  }

  @Test
  fun `does not add sentry trace header to the request if host is disallowed`() {
    fixture.options.setTracePropagationTargets(listOf("some-host-that-does-not-exist"))
    executeQuery(isSpanActive = false)

    val recorderRequest =
      fixture.server.takeRequest(mockServerRequestTimeoutMillis, TimeUnit.MILLISECONDS)!!
    assertNull(recorderRequest.headers[SentryTraceHeader.SENTRY_TRACE_HEADER])
    assertNull(recorderRequest.headers[BaggageHeader.BAGGAGE_HEADER])
  }

  @Test
  fun `when there is no active span, does not add sentry trace header to the request`() {
    executeQuery(isSpanActive = false)

    val recorderRequest =
      fixture.server.takeRequest(mockServerRequestTimeoutMillis, TimeUnit.MILLISECONDS)!!
    assertNotNull(recorderRequest.headers[SentryTraceHeader.SENTRY_TRACE_HEADER])
    assertNotNull(recorderRequest.headers[BaggageHeader.BAGGAGE_HEADER])
  }

  @Test
  fun `does not add sentry-trace header when span origin is ignored`() {
    fixture.options.setIgnoredSpanOrigins(listOf("auto.graphql.apollo4"))
    executeQuery(isSpanActive = false)

    val recorderRequest =
      fixture.server.takeRequest(mockServerRequestTimeoutMillis, TimeUnit.MILLISECONDS)!!
    assertNull(recorderRequest.headers[SentryTraceHeader.SENTRY_TRACE_HEADER])
    assertNull(recorderRequest.headers[BaggageHeader.BAGGAGE_HEADER])
  }

  @Test
  fun `when there is an active span, adds sentry trace headers to the request`() {
    executeQuery()
    val recorderRequest =
      fixture.server.takeRequest(mockServerRequestTimeoutMillis, TimeUnit.MILLISECONDS)!!
    assertNotNull(recorderRequest.headers[SentryTraceHeader.SENTRY_TRACE_HEADER])
    assertNotNull(recorderRequest.headers[BaggageHeader.BAGGAGE_HEADER])
  }

  @Test
  fun `when there is an active span, existing baggage headers are merged with sentry baggage into single header`() {
    executeQuery(sut = fixture.getSut(addThirdPartyBaggageHeader = true))
    val recorderRequest =
      fixture.server.takeRequest(mockServerRequestTimeoutMillis, TimeUnit.MILLISECONDS)!!
    assertNotNull(recorderRequest.headers[SentryTraceHeader.SENTRY_TRACE_HEADER])
    assertNotNull(recorderRequest.headers[BaggageHeader.BAGGAGE_HEADER])

    val baggageHeaderValues = recorderRequest.headers.values(BaggageHeader.BAGGAGE_HEADER)
    assertEquals(baggageHeaderValues.size, 1)
    assertTrue(
      baggageHeaderValues[0].startsWith(
        "thirdPartyBaggage=someValue,secondThirdPartyBaggage=secondValue; property;propertyKey=propertyValue,anotherThirdPartyBaggage=anotherValue"
      )
    )
    assertTrue(baggageHeaderValues[0].contains("sentry-public_key=key"))
    assertTrue(baggageHeaderValues[0].contains("sentry-transaction=op"))
    assertTrue(baggageHeaderValues[0].contains("sentry-trace_id"))
  }

  @Test
  fun `customizer modifies span`() {
    executeQuery(
      fixture.getSut(
        beforeSpan = { span, request, response ->
          span.description = "overwritten description"
          span
        }
      )
    )

    verify(fixture.scopes)
      .captureTransaction(
        check {
          assertEquals(1, it.spans.size)
          val httpClientSpan = it.spans.first()
          assertEquals("overwritten description", httpClientSpan.description)
        },
        anyOrNull<TraceContext>(),
        anyOrNull(),
        anyOrNull(),
      )
  }

  @Test
  fun `returning null in beforeSpan callback drops span`() {
    executeQuery(fixture.getSut(beforeSpan = { _, _, _ -> null }))

    verify(fixture.scopes)
      .captureTransaction(
        check { assertEquals(0, it.spans.size) },
        anyOrNull<TraceContext>(),
        anyOrNull(),
        anyOrNull(),
      )
  }

  @Test
  fun `when customizer throws, exception is handled`() {
    executeQuery(fixture.getSut(beforeSpan = { _, _, _ -> throw RuntimeException() }))

    verify(fixture.scopes)
      .captureTransaction(
        check { assertEquals(1, it.spans.size) },
        anyOrNull<TraceContext>(),
        anyOrNull(),
        anyOrNull(),
      )
  }

  @Test
  fun `adds breadcrumb when http calls succeeds`() {
    executeQuery(fixture.getSut())
    verify(fixture.scopes)
      .addBreadcrumb(
        check<Breadcrumb> {
          assertEquals("http", it.type)
          // response_body_size is added but mock webserver returns 0 always
          assertEquals(0L, it.data["response_body_size"])
          assertEquals(193L, it.data["request_body_size"])
        },
        anyOrNull(),
      )
  }

  @Test
  fun `sets SDKVersion Info`() {
    assertNotNull(fixture.scopes.options.sdkVersion)
    assert(fixture.scopes.options.sdkVersion!!.integrationSet.contains("Apollo4"))
  }

  @Test
  fun `attaches to root transaction on Android`() {
    Apollo4PlatformTestManipulator.pretendIsAndroid(true)
    executeQuery(fixture.getSut())
    verify(fixture.scopes).transaction
  }

  @Test
  fun `attaches to child span on non-Android`() {
    Apollo4PlatformTestManipulator.pretendIsAndroid(false)
    executeQuery(fixture.getSut())
    verify(fixture.scopes).span
  }

  @Test
  fun `adds W3C traceparent header when propagateTraceparent is enabled`() {
    fixture.options.isPropagateTraceparent = true
    executeQuery()
    val recorderRequest =
      fixture.server.takeRequest(mockServerRequestTimeoutMillis, TimeUnit.MILLISECONDS)!!
    assertNotNull(recorderRequest.headers[SentryTraceHeader.SENTRY_TRACE_HEADER])
    assertNotNull(recorderRequest.headers[W3CTraceparentHeader.TRACEPARENT_HEADER])
  }

  @Test
  fun `does not add W3C traceparent header when propagateTraceparent is disabled`() {
    fixture.options.isPropagateTraceparent = false
    executeQuery()
    val recorderRequest =
      fixture.server.takeRequest(mockServerRequestTimeoutMillis, TimeUnit.MILLISECONDS)!!
    assertNotNull(recorderRequest.headers[SentryTraceHeader.SENTRY_TRACE_HEADER])
    assertNull(recorderRequest.headers[W3CTraceparentHeader.TRACEPARENT_HEADER])
  }

  private fun assertTransactionDetails(
    it: SentryTransaction,
    httpStatusCode: Int? = 200,
    contentLength: Long? = 0L,
  ) {
    assertEquals(1, it.spans.size)
    val httpClientSpan = it.spans.first()
    assertEquals("http.graphql", httpClientSpan.op)
    assertEquals(
      "Post http://${fixture.server.hostName}:${fixture.server.port}/",
      httpClientSpan.description,
    )
    assertNotNull(httpClientSpan.data) {
      assertEquals("POST", it[HTTP_METHOD_KEY])
      httpStatusCode?.let { code ->
        assertEquals(code, it[SpanDataConvention.HTTP_STATUS_CODE_KEY])
      }
      contentLength?.let { contentLength ->
        assertEquals(contentLength, it[SpanDataConvention.HTTP_RESPONSE_CONTENT_LENGTH_KEY])
      }
    }
  }

  private fun executeQuery(
    sut: ApolloClient = fixture.getSut(),
    isSpanActive: Boolean = true,
    id: String = "83",
  ) = runBlocking {
    var tx: ITransaction? = null
    if (isSpanActive) {
      tx =
        SentryTracer(TransactionContext("op", "desc", TracesSamplingDecision(true)), fixture.scopes)
      whenever(fixture.scopes.transaction).thenReturn(tx)
      whenever(fixture.scopes.span).thenReturn(tx)
    }

    val coroutine = launch {
      try {
        executeQueryImplementation(sut.query(LaunchDetailsQuery(id)))
      } catch (e: ApolloException) {
        return@launch
      }
    }

    coroutine.join()
    tx?.finish()
  }
}