Set SpanContext on SentryTransaction to avoid potential NPE.

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 * Enchancement: Support SENTRY_TRACES_SAMPLE_RATE conf. via env variables (#1171)
 * Enhancement: Pass request to CustomSamplingContext in Spring integration (#1172)
+* Ref: Set SpanContext on SentryTransaction to avoid potential NPE (#1173)
 
 # 4.0.0-alpha.3
 

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

@@ -28,7 +28,9 @@ public final class SentryTransaction extends SentryBaseEvent implements ITransac
    * A hub this transaction is attached to. Marked as transient to be ignored during JSON
    * serialization.
    */
-  private @NotNull final transient IHub hub;
+  private final transient @NotNull IHub hub;
+
+  private final transient @NotNull SpanContext context;
 
   /** The {@code type} property is required in JSON payload sent to Sentry. */
   @SuppressWarnings("UnusedVariable")
@@ -47,17 +49,16 @@ public final class SentryTransaction extends SentryBaseEvent implements ITransac
    * Creates transaction with name and contexts.
    *
    * @param name - transaction name
-   * @param contexts - transaction contexts
+   * @param context - transaction contexts
    * @param hub - the hub
    */
   @TestOnly
   public SentryTransaction(
-      final @NotNull String name, final @NotNull SpanContext contexts, final @NotNull IHub hub) {
-    Objects.requireNonNull(contexts, "contexts are required");
+      final @NotNull String name, final @NotNull SpanContext context, final @NotNull IHub hub) {
     this.transaction = Objects.requireNonNull(name, "name is required");
     this.startTimestamp = DateUtils.getCurrentDateTime();
     this.hub = Objects.requireNonNull(hub, "hub is required");
-    this.getContexts().setTrace(contexts);
+    this.context = Objects.requireNonNull(context, "contexts is required");
   }
 
   /**
@@ -137,17 +138,17 @@ public void setName(final @NotNull String name) {
 
   @NotNull
   SpanId getSpanId() {
-    return getContexts().getTrace().getSpanId();
+    return this.context.getSpanId();
   }
 
   @NotNull
   SentryId getTraceId() {
-    return getContexts().getTrace().getTraceId();
+    return this.context.getTraceId();
   }
 
   @Override
   public @Nullable Boolean isSampled() {
-    return getContexts().getTrace().getSampled();
+    return this.context.getSampled();
   }
 
   @Override
@@ -156,6 +157,7 @@ public void finish() {
     if (this.throwable != null) {
       hub.setSpanContext(this.throwable, this.getSpanContext());
     }
+    this.getContexts().setTrace(this.context);
     this.hub.captureTransaction(this, null);
   }
 
@@ -166,7 +168,7 @@ public void finish() {
    */
   @Override
   public void setOperation(@Nullable String op) {
-    this.getContexts().getTrace().setOperation(op);
+    this.context.setOperation(op);
   }
 
   /**
@@ -176,17 +178,17 @@ public void setOperation(@Nullable String op) {
    */
   @Override
   public void setDescription(@Nullable String description) {
-    this.getContexts().getTrace().setDescription(description);
+    this.context.setDescription(description);
   }
 
   @Override
   public @Nullable String getDescription() {
-    return this.getContexts().getTrace().getDescription();
+    return this.context.getDescription();
   }
 
   @Override
   public @NotNull SpanContext getSpanContext() {
-    return this.getContexts().getTrace();
+    return this.context;
   }
 
   /**
@@ -196,7 +198,7 @@ public void setDescription(@Nullable String description) {
    */
   @Override
   public void setStatus(@Nullable SpanStatus spanStatus) {
-    this.getContexts().getTrace().setStatus(spanStatus);
+    this.context.setStatus(spanStatus);
   }
 
   /**
@@ -239,4 +241,9 @@ Date getTimestamp() {
     }
     return null;
   }
+
+  @NotNull
+  SpanContext getContext() {
+    return context;
+  }
 }

sentry/src/test/java/io/sentry/GsonSerializerTest.kt

@@ -440,6 +440,7 @@ class GsonSerializerTest {
         trace.status = SpanStatus.OK
         trace.setTag("myTag", "myValue")
         val transaction = SentryTransaction("transaction-name", trace, mock())
+        transaction.finish()
 
         val stringWriter = StringWriter()
         fixture.serializer.serialize(transaction, stringWriter)

sentry/src/test/java/io/sentry/HubTest.kt

@@ -1045,7 +1045,7 @@ class HubTest {
 
         val transaction = hub.startTransaction(contexts)
         assertTrue(transaction is SentryTransaction)
-        assertEquals(contexts, transaction.contexts.trace)
+        assertEquals(contexts, transaction.context)
     }
 
     @Test

sentry/src/test/java/io/sentry/SentryClientTest.kt

@@ -770,6 +770,7 @@ class SentryClientTest {
         val scope = createScope()
         val transaction = SentryTransaction("name")
         scope.setTransaction(transaction)
+        transaction.finish()
         sut.captureEvent(event, scope)
         assertNotNull(event.contexts.trace)
         assertEquals(transaction.contexts.trace, event.contexts.trace)

sentry/src/test/java/io/sentry/SentryTransactionTest.kt

@@ -133,20 +133,23 @@ class SentryTransactionTest {
     fun `setting op sets op on TraceContext`() {
         val transaction = SentryTransaction("name")
         transaction.setOperation("op")
+        transaction.finish()
         assertEquals("op", transaction.contexts.trace!!.operation)
     }
 
     @Test
     fun `setting description sets description on TraceContext`() {
         val transaction = SentryTransaction("name")
-        transaction.setDescription("desc")
+        transaction.description = "desc"
+        transaction.finish()
         assertEquals("desc", transaction.contexts.trace!!.description)
     }
 
     @Test
     fun `setting status sets status on TraceContext`() {
         val transaction = SentryTransaction("name")
         transaction.setStatus(SpanStatus.ALREADY_EXISTS)
+        transaction.finish()
         assertEquals(SpanStatus.ALREADY_EXISTS, transaction.contexts.trace!!.status)
     }