Skip to content

Fix case-sensitive HTTP headers in W3C traces #5347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
puffnfresh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix case-sensitive HTTP headers in W3C traces #5347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ...mon/src/main/scala/org/lfdecentralizedtrust/splice/admin/api/TraceContextDirectives.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ package org.lfdecentralizedtrust.splice.admin.api
import org.apache.pekko.http.scaladsl.server
import org.apache.pekko.http.scaladsl.server.{Directive, Directive1, RequestContext, RouteResult}
import org.lfdecentralizedtrust.splice.admin.api.client.TraceContextPropagation.*
import com.digitalasset.canton.tracing.HeaderName
import com.digitalasset.canton.tracing.TraceContext
import com.digitalasset.canton.tracing.W3CTraceContext

Expand All @@ -21,7 +22,7 @@ object TraceContextDirectives {
def withTraceContext: Directive1[TraceContext] = {
Directive { inner => ctx =>
val headersMap =
ctx.request.headers.map(h => h.name -> h.value).toMap
ctx.request.headers.map(h => HeaderName(h.name) -> h.value).toMap

W3CTraceContext
.fromHeaders(headersMap)
Expand Down
6 changes: 3 additions & 3 deletions ...main/scala/org/lfdecentralizedtrust/splice/admin/api/client/TraceContextPropagation.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package org.lfdecentralizedtrust.splice.admin.api.client

import org.apache.pekko.http.scaladsl.model.HttpHeader
import org.apache.pekko.http.scaladsl.model.headers.RawHeader
import com.digitalasset.canton.tracing.TraceContext
import com.digitalasset.canton.tracing.{HeaderName, TraceContext}

object TraceContextPropagation {
implicit class TraceContextExtension(tc: TraceContext) {
Expand All @@ -16,9 +16,9 @@ object TraceContextPropagation {
.map { w3Ctx =>
val headersMap = w3Ctx.asHeaders
val w3CtxHeaders = headersMap.map { case (name, value) =>
RawHeader(name, value)
RawHeader(name.value, value)
}
headers.filterNot(h => headersMap.contains(h.name)) ++ w3CtxHeaders.toSeq
headers.filterNot(h => headersMap.contains(HeaderName(h.name))) ++ w3CtxHeaders.toSeq
}
.getOrElse(headers)
}
Expand Down
4 changes: 2 additions & 2 deletions apps/common/src/main/scala/org/lfdecentralizedtrust/splice/http/HttpClient.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import com.daml.metrics.api.MetricQualification.Latency
import com.daml.metrics.api.{MetricHandle, MetricInfo, MetricName, MetricsContext}
import com.digitalasset.canton.config.{ApiLoggingConfig, NonNegativeDuration}
import com.digitalasset.canton.logging.{NamedLoggerFactory, TracedLogger}
import com.digitalasset.canton.tracing.{TraceContext, W3CTraceContext}
import com.digitalasset.canton.tracing.{HeaderName, TraceContext, W3CTraceContext}
import org.apache.pekko.actor.ActorSystem
import org.apache.pekko.http.scaladsl.{ClientTransport, ConnectionContext, Http}
import org.apache.pekko.http.scaladsl.model.{
Expand Down Expand Up @@ -281,7 +281,7 @@ object HttpClient {

private def traceContextFromHeaders(headers: immutable.Seq[HttpHeader]) = {
W3CTraceContext
.fromHeaders(headers.map(h => h.name() -> h.value()).toMap)
.fromHeaders(headers.map(h => HeaderName(h.name()) -> h.value()).toMap)
.map(_.toTraceContext)
.getOrElse(TraceContext.empty)
}
Expand Down
2 changes: 1 addition & 1 deletion ...test/scala/com/digitalasset/canton/integration/tests/jsonapi/HttpServiceUserFixture.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ trait HttpServiceUserFixture extends PekkoBeforeAndAfterAll { this: Suite with C
}

protected def extractHeaders(w3cContext: W3CTraceContext): Seq[HttpHeader] =
w3cContext.asHeaders.toSeq.map(h => HttpHeader.parse(h._1, h._2)).collect {
w3cContext.asHeaders.toSeq.map(h => HttpHeader.parse(h._1.value, h._2)).collect {
case ParsingResult.Ok(header, _) =>
header
}
Expand Down
6 changes: 4 additions & 2 deletions ...edger/ledger-json-api/src/main/scala/com/digitalasset/canton/http/json/v2/Endpoints.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import com.digitalasset.canton.ledger.error.{JsonApiErrors, LedgerApiErrors}
import com.digitalasset.canton.logging.audit.ApiRequestLogger
import com.digitalasset.canton.logging.{LoggingContextWithTrace, NamedLogging}
import com.digitalasset.canton.networking.grpc.CallMetadata
import com.digitalasset.canton.tracing.{TraceContext, W3CTraceContext}
import com.digitalasset.canton.tracing.{HeaderName, TraceContext, W3CTraceContext}
import com.digitalasset.daml.lf.data.Ref
import com.digitalasset.daml.lf.engine.Error.Preprocessing
import com.digitalasset.daml.lf.language.Ast.TVar
Expand Down Expand Up @@ -465,7 +465,9 @@ object Endpoints {
)
)
.map { case (headersList: Seq[Header], addr) =>
val z = W3CTraceContext.fromHeaders(headersList.map(h => (h.name, h.value)).toMap)
val z = W3CTraceContext.fromHeaders(
headersList.map(h => (HeaderName(h.name), h.value)).toMap
)
Comment on lines -468 to +470
Copy link
Copy Markdown
Contributor

@stephencompall-DA stephencompall-DA May 6, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only the changes in TraceContextPropagation directly affect [only] Splice endpoints; this is effectively a noop to satisfy scalac here. If you want ledger JSON API (participant) endpoints to be affected, this must be ported to digital-asset/canton repo, whose maintainers may have alternative suggestions.

(z.map(_.toTraceContext), addr)
} { case (tc1, addr) =>
(
Expand Down
6 changes: 3 additions & 3 deletions ...ledger/ledger-json-api/src/main/scala/com/digitalasset/canton/http/json/v2/V2Routes.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import com.digitalasset.canton.logging.audit.{ApiRequestLogger, ResponseKind, Tr
import com.digitalasset.canton.logging.{NamedLoggerFactory, NamedLogging}
import com.digitalasset.canton.networking.grpc.CallMetadata
import com.digitalasset.canton.platform.PackagePreferenceBackend
import com.digitalasset.canton.tracing.{TraceContext, W3CTraceContext}
import com.digitalasset.canton.tracing.{HeaderName, TraceContext, W3CTraceContext}
import org.apache.pekko.http.scaladsl.model.{AttributeKeys, HttpRequest, MediaType, MediaTypes}
import org.apache.pekko.http.scaladsl.server.RequestContext
import org.apache.pekko.stream.Materializer
Expand Down Expand Up @@ -193,7 +193,7 @@ class RequestInterceptors(

def loggingInterceptor() =
RequestInterceptor.transformServerRequest { request =>
val incomingHeaders = request.headers.map(h => (h.name, h.value)).toMap
val incomingHeaders = request.headers.map(h => (HeaderName(h.name), h.value)).toMap
val extractedW3cTrace = W3CTraceContext.fromHeaders(incomingHeaders)
val requestParameters =
s"[${request.queryParameters.toSeq.map { case (k, v) => s"$k=$v" }.mkString(", ")}]"
Expand Down Expand Up @@ -289,7 +289,7 @@ class RequestInterceptors(

def apply[B](request: ServerRequest, result: RequestResult[B]): Future[RequestResult[B]] = {
val addr = RequestInterceptorsUtil.extractAddress(request)
val incomingHeaders = request.headers.map(h => (h.name, h.value)).toMap
val incomingHeaders = request.headers.map(h => (HeaderName(h.name), h.value)).toMap
val extractedW3cTrace = W3CTraceContext.fromHeaders(incomingHeaders)
val callMetadata = CallMetadata(
apiEndpoint = request.showShort,
Expand Down
21 changes: 21 additions & 0 deletions ...munity/util-observability/src/main/scala/com/digitalasset/canton/tracing/HeaderName.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Copyright (c) 2026 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

package com.digitalasset.canton.tracing

import java.util.Locale

/** HTTP header name with case-insensitive equality (RFC 7230 §3.2). The
* apply factory normalizes to lowercase, so equality and hashing on the
* underlying String are case-insensitive by construction. Use as the key
* type for any map of HTTP headers to avoid lookup misses caused by
* upstream case variation.
*/
final class HeaderName private (val value: String) extends AnyVal {
Copy link
Copy Markdown
Contributor

@stephencompall-DA stephencompall-DA May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered whether using sttp Header in more places would be a nice alternative to this but it's at the wrong abstraction layer, so this makes sense to me. 👍

override def toString: String = value
}

object HeaderName {
def apply(name: String): HeaderName =
new HeaderName(name.toLowerCase(Locale.ROOT))
}
32 changes: 17 additions & 15 deletions ...y/util-observability/src/main/scala/com/digitalasset/canton/tracing/W3CTraceContext.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ final case class W3CTraceContext(parent: String, state: Option[String] = None)
/** HTTP headers of this trace context. Marked transient as the headers do not need to be
* serialized when using java serialization.
*/
@transient lazy val asHeaders: Map[String, String] =
Map(TRACEPARENT_HEADER_NAME -> parent) ++ state.map(TRACESTATE_HEADER_NAME -> _).toList
@transient lazy val asHeaders: Map[HeaderName, String] =
Map(TraceparentHeader -> parent) ++ state.map(TracestateHeader -> _).toList

override def toString: String = {
val sb = new mutable.StringBuilder()
Expand All @@ -41,27 +41,27 @@ final case class W3CTraceContext(parent: String, state: Option[String] = None)
object W3CTraceContext {
// https://www.w3.org/TR/trace-context/
private val propagator = W3CTraceContextPropagator.getInstance()
private val TRACEPARENT_HEADER_NAME =
"traceparent" // same as W3CTraceContextPropagator.TRACE_PARENT
private val TRACESTATE_HEADER_NAME = "tracestate" // same as W3CTraceContextPropagator.TRACE_STATE
// values match W3CTraceContextPropagator.TRACE_PARENT / TRACE_STATE
private val TraceparentHeader = HeaderName("traceparent")
private val TracestateHeader = HeaderName("tracestate")

@SuppressWarnings(Array("org.wartremover.warts.Var"))
def fromOpenTelemetryContext(context: OpenTelemetryContext): Option[W3CTraceContext] = {
var builder = new W3CTraceContextBuilder
val setter: TextMapSetter[W3CTraceContextBuilder] = (carrier, key, value) =>
builder = key match {
case TRACEPARENT_HEADER_NAME => carrier.copy(parent = Some(value))
case TRACESTATE_HEADER_NAME => carrier.copy(state = Some(value))
builder = HeaderName(key) match {
case TraceparentHeader => carrier.copy(parent = Some(value))
case TracestateHeader => carrier.copy(state = Some(value))
case _ => carrier
}
propagator.inject(context, builder, setter)
builder.build
}

def fromHeaders(headers: Map[String, String]): Option[W3CTraceContext] =
def fromHeaders(headers: Map[HeaderName, String]): Option[W3CTraceContext] =
W3CTraceContextBuilder(
headers.get(TRACEPARENT_HEADER_NAME),
headers.get(TRACESTATE_HEADER_NAME),
headers.get(TraceparentHeader),
headers.get(TracestateHeader),
).build

private final case class W3CTraceContextBuilder(
Expand Down Expand Up @@ -96,10 +96,12 @@ object W3CTraceContext {
* returned but the current span will be invalid and [[TraceContext.traceId]] will return None.
*/
@SuppressWarnings(Array("org.wartremover.warts.Null"))
def toTraceContext(parent: Option[String], state: Option[String]): TraceContext = extract {
case `TRACEPARENT_HEADER_NAME` => parent.orNull
case `TRACESTATE_HEADER_NAME` => state.orNull
case _ => null
def toTraceContext(parent: Option[String], state: Option[String]): TraceContext = extract { key =>
HeaderName(key) match {
case TraceparentHeader => parent.orNull
case TracestateHeader => state.orNull
case _ => null
}
}

private def extract(getter: String => String): TraceContext =
Expand Down