move feature flag buffer to span context; add e2e test

Author: adinauer

sentry-opentelemetry/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/OtelSpanWrapper.java

@@ -77,8 +77,6 @@ public final class OtelSpanWrapper implements IOtelSpanWrapper {
 
   private @NotNull Deque<ISentryLifecycleToken> tokensToCleanup = new ArrayDeque<>(1);
 
-  private final @NotNull IFeatureFlagBuffer featureFlags = SpanFeatureFlagBuffer.create();
-
   public OtelSpanWrapper(
       final @NotNull ReadWriteSpan span,
       final @NotNull IScopes scopes,
@@ -511,7 +509,7 @@ public Map<String, MeasurementValue> getMeasurements() {
 
   @Override
   public void addFeatureFlag(final @Nullable String flag, final @Nullable Boolean result) {
-    featureFlags.add(flag, result);
+    context.addFeatureFlag(flag, result);
   }
 
   @Override

sentry-samples/sentry-samples-spring-boot-jakarta/src/main/java/io/sentry/samples/spring/boot/jakarta/PersonController.java

@@ -23,6 +23,7 @@ public PersonController(PersonService personService) {
 
   @GetMapping("{id}")
   Person person(@PathVariable Long id) {
+    Sentry.addFeatureFlag("transaction-feature-flag", true);
     ISpan currentSpan = Sentry.getSpan();
     ISpan sentrySpan = currentSpan.startChild("spanCreatedThroughSentryApi");
     try {

sentry-samples/sentry-samples-spring-boot-jakarta/src/test/kotlin/io/sentry/systemtest/PersonSystemTest.kt

@@ -1,5 +1,6 @@
 package io.sentry.systemtest
 
+import io.sentry.protocol.FeatureFlag
 import io.sentry.systemtest.util.TestHelper
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -31,7 +32,8 @@ class PersonSystemTest {
     }
 
     testHelper.ensureTransactionReceived { transaction, envelopeHeader ->
-      testHelper.doesTransactionHaveOp(transaction, "http.server")
+      testHelper.doesTransactionHave(transaction, op = "http.server", featureFlag = FeatureFlag("flag.evaluation.transaction-feature-flag", true))
+        && testHelper.doesTransactionHaveSpanWith(transaction, op = "spanCreatedThroughSentryApi", featureFlag = FeatureFlag("flag.evaluation.my-feature-flag", true))
     }
 
     Thread.sleep(10000)

sentry-samples/sentry-samples-spring-boot/src/test/kotlin/io/sentry/systemtest/PersonSystemTest.kt

@@ -1,5 +1,6 @@
 package io.sentry.systemtest
 
+import io.sentry.protocol.FeatureFlag
 import io.sentry.systemtest.util.TestHelper
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -26,7 +27,7 @@ class PersonSystemTest {
     }
 
     testHelper.ensureTransactionReceived { transaction, envelopeHeader ->
-      testHelper.doesTransactionHaveOp(transaction, "http.server")
+        testHelper.doesTransactionHave(transaction, op = "http.server", featureFlag = FeatureFlag("flag.evaluation.my-feature-flag", true))
     }
 
     Thread.sleep(10000)

sentry-system-test-support/src/main/kotlin/io/sentry/systemtest/util/TestHelper.kt

@@ -8,6 +8,7 @@ import io.sentry.SentryEvent
 import io.sentry.SentryItemType
 import io.sentry.SentryLogEvents
 import io.sentry.SentryOptions
+import io.sentry.protocol.FeatureFlag
 import io.sentry.protocol.SentrySpan
 import io.sentry.protocol.SentryTransaction
 import io.sentry.systemtest.graphql.GraphqlTestClient
@@ -154,7 +155,7 @@ class TestHelper(backendUrl: String) {
   }
 
   fun ensureErrorReceived(callback: ((SentryEvent) -> Boolean)) {
-    ensureEnvelopeReceived { envelopeString ->
+    ensureEnvelopeReceived(retryCount = 3) { envelopeString ->
       val deserializeEnvelope = jsonSerializer.deserializeEnvelope(envelopeString.byteInputStream())
       if (deserializeEnvelope == null) {
         return@ensureEnvelopeReceived false
@@ -275,6 +276,52 @@ class TestHelper(backendUrl: String) {
     return true
   }
 
+  fun doesTransactionHave(transaction: SentryTransaction, op: String, featureFlag: FeatureFlag? = null): Boolean {
+    val matches = transaction.contexts.trace?.operation == op
+    if (!matches) {
+      println("Unable to find transaction with op $op:")
+      logObject(transaction)
+      return false
+    }
+
+    val foundFlag = transaction.contexts.trace?.data?.get(featureFlag?.flag)
+    if (featureFlag != null && foundFlag == null) {
+      println("Unable to find span with feature flag ${featureFlag?.flag}:")
+      logObject(transaction)
+      return false
+    }
+    if (featureFlag != null && foundFlag != featureFlag.result) {
+      println("Feature flag ${featureFlag?.flag} has unexpected result ${foundFlag}:")
+      logObject(transaction)
+      return false
+    }
+
+    return true
+  }
+
+  fun doesTransactionHaveSpanWith(transaction: SentryTransaction, op: String, featureFlag: FeatureFlag? = null): Boolean {
+    val foundSpan = transaction.spans.firstOrNull { span -> span.op == op }
+    if (foundSpan == null) {
+      println("Unable to find span with op $op:")
+      logObject(transaction)
+      return false
+    }
+
+    val foundFlag = foundSpan.data?.get(featureFlag?.flag)
+    if (featureFlag != null && foundFlag == null) {
+      println("Unable to find span with feature flag ${featureFlag?.flag}:")
+      logObject(transaction)
+      return false
+    }
+    if (featureFlag != null && foundFlag != featureFlag.result) {
+      println("Feature flag ${featureFlag?.flag} has unexpected result ${foundFlag}:")
+      logObject(transaction)
+      return false
+    }
+
+    return true
+  }
+
   fun doesEventHaveExceptionMessage(event: SentryEvent, expectedMessage: String): Boolean {
     val exceptions = event.exceptions
     if (exceptions == null) {

sentry/src/main/java/io/sentry/Span.java

@@ -51,8 +51,6 @@ public final class Span implements ISpan {
 
   private final @NotNull Contexts contexts = new Contexts();
 
-  private final @NotNull IFeatureFlagBuffer featureFlags = SpanFeatureFlagBuffer.create();
-
   Span(
       final @NotNull SentryTracer transaction,
       final @NotNull IScopes scopes,
@@ -465,11 +463,6 @@ private List<Span> getDirectChildren() {
 
   @Override
   public void addFeatureFlag(final @Nullable String flag, final @Nullable Boolean result) {
-    featureFlags.add(flag, result);
-  }
-
-  @ApiStatus.Internal
-  public @NotNull IFeatureFlagBuffer getFeatureFlagBuffer() {
-    return featureFlags;
+    context.addFeatureFlag(flag, result);
   }
 }

sentry/src/main/java/io/sentry/SpanContext.java

@@ -1,6 +1,9 @@
 package io.sentry;
 
 import com.jakewharton.nopen.annotation.Open;
+
+import io.sentry.featureflags.IFeatureFlagBuffer;
+import io.sentry.featureflags.SpanFeatureFlagBuffer;
 import io.sentry.protocol.SentryId;
 import io.sentry.util.CollectionUtils;
 import io.sentry.util.Objects;
@@ -55,6 +58,8 @@ public class SpanContext implements JsonUnknown, JsonSerializable {
 
   protected @Nullable Baggage baggage;
 
+  protected @NotNull IFeatureFlagBuffer featureFlags = SpanFeatureFlagBuffer.create();
+
   /**
    * Set the profiler id associated with this transaction. If set to a non-empty id, this value will
    * be sent to sentry instead of {@link SentryOptions#getContinuousProfiler}
@@ -320,6 +325,16 @@ public void setProfilerId(@NotNull SentryId profilerId) {
     this.profilerId = profilerId;
   }
 
+  @ApiStatus.Internal
+  public void addFeatureFlag(final @Nullable String flag, final @Nullable Boolean result) {
+    featureFlags.add(flag, result);
+  }
+
+  @ApiStatus.Internal
+  public @NotNull IFeatureFlagBuffer getFeatureFlagBuffer() {
+    return featureFlags;
+  }
+
   // region JsonSerializable
 
   public static final class JsonKeys {

sentry/src/main/java/io/sentry/protocol/SentrySpan.java

@@ -74,7 +74,7 @@ public SentrySpan(final @NotNull Span span, final @Nullable Map<String, Object>
     // we lose precision here, from potential nanosecond precision down to 10 microsecond precision
     this.startTimestamp = DateUtils.nanosToSeconds(span.getStartDate().nanoTimestamp());
     this.data = data;
-    final @NotNull IFeatureFlagBuffer featureFlagBuffer = span.getFeatureFlagBuffer();
+    final @NotNull IFeatureFlagBuffer featureFlagBuffer = span.getSpanContext().getFeatureFlagBuffer();
     final @Nullable FeatureFlags featureFlags = featureFlagBuffer.getFeatureFlags();
     if (featureFlags != null && data != null) {
       for (FeatureFlag featureFlag : featureFlags.getValues()) {

sentry/src/main/java/io/sentry/protocol/SentryTransaction.java

@@ -15,6 +15,7 @@
 import io.sentry.SpanContext;
 import io.sentry.SpanStatus;
 import io.sentry.TracesSamplingDecision;
+import io.sentry.featureflags.IFeatureFlagBuffer;
 import io.sentry.util.Objects;
 import io.sentry.vendor.gson.stream.JsonToken;
 import java.io.IOException;
@@ -99,6 +100,14 @@ public SentryTransaction(final @NotNull SentryTracer sentryTracer) {
       }
     }
 
+    final @NotNull IFeatureFlagBuffer featureFlagBuffer = tracerContext.getFeatureFlagBuffer();
+    final @Nullable FeatureFlags featureFlags = featureFlagBuffer.getFeatureFlags();
+    if (featureFlags != null) {
+      for (FeatureFlag featureFlag : featureFlags.getValues()) {
+        tracerContextToSend.setData("flag.evaluation." + featureFlag.getFlag(), featureFlag.getResult());
+      }
+    }
+
     contexts.setTrace(tracerContextToSend);
 
     this.transactionInfo = new TransactionInfo(sentryTracer.getTransactionNameSource().apiName());