Fix memory leak caused by throwableToSpan (#2227)

getsentry · Aug 30, 2022 · 88fade9 · 88fade9
1 parent d425298
commit 88fade9
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Fixes
+
+- Fix memory leak caused by throwableToSpan ([#2227](https://github.com/getsentry/sentry-java/pull/2227))
+
 ## 6.4.0
 
 ### Fixes

diff --git a/sentry/src/main/java/io/sentry/Hub.java b/sentry/src/main/java/io/sentry/Hub.java
@@ -12,6 +12,7 @@
 import io.sentry.util.Objects;
 import io.sentry.util.Pair;
 import java.io.Closeable;
+import java.lang.ref.WeakReference;
 import java.util.Collections;
 import java.util.Date;
 import java.util.List;
@@ -27,7 +28,7 @@ public final class Hub implements IHub {
   private volatile boolean isEnabled;
   private final @NotNull Stack stack;
   private final @NotNull TracesSampler tracesSampler;
-  private final @NotNull Map<Throwable, Pair<ISpan, String>> throwableToSpan =
+  private final @NotNull Map<Throwable, Pair<WeakReference<ISpan>, String>> throwableToSpan =
       Collections.synchronizedMap(new WeakHashMap<>());
 
   public Hub(final @NotNull SentryOptions options) {
@@ -237,12 +238,15 @@ public boolean isEnabled() {
 
   private void assignTraceContext(final @NotNull SentryEvent event) {
     if (options.isTracingEnabled() && event.getThrowable() != null) {
-      final Pair<ISpan, String> pair =
+      final Pair<WeakReference<ISpan>, String> pair =
           throwableToSpan.get(ExceptionUtils.findRootCause(event.getThrowable()));
       if (pair != null) {
-        final ISpan span = pair.getFirst();
-        if (event.getContexts().getTrace() == null && span != null) {
-          event.getContexts().setTrace(span.getSpanContext());
+        final WeakReference<ISpan> spanWeakRef = pair.getFirst();
+        if (event.getContexts().getTrace() == null && spanWeakRef != null) {
+          final ISpan span = spanWeakRef.get();
+          if (span != null) {
+            event.getContexts().setTrace(span.getSpanContext());
+          }
         }
         final String transactionName = pair.getSecond();
         if (event.getTransaction() == null && transactionName != null) {
@@ -775,19 +779,22 @@ public void setSpanContext(
     final Throwable rootCause = ExceptionUtils.findRootCause(throwable);
     // the most inner span should be assigned to a throwable
     if (!throwableToSpan.containsKey(rootCause)) {
-      throwableToSpan.put(rootCause, new Pair<>(span, transactionName));
+      throwableToSpan.put(rootCause, new Pair<>(new WeakReference<>(span), transactionName));
     }
   }
 
   @Nullable
   SpanContext getSpanContext(final @NotNull Throwable throwable) {
     Objects.requireNonNull(throwable, "throwable is required");
     final Throwable rootCause = ExceptionUtils.findRootCause(throwable);
-    final Pair<ISpan, String> pair = this.throwableToSpan.get(rootCause);
+    final Pair<WeakReference<ISpan>, String> pair = this.throwableToSpan.get(rootCause);
     if (pair != null) {
-      final ISpan span = pair.getFirst();
-      if (span != null) {
-        return span.getSpanContext();
+      final WeakReference<ISpan> spanWeakRef = pair.getFirst();
+      if (spanWeakRef != null) {
+        final ISpan span = spanWeakRef.get();
+        if (span != null) {
+          return span.getSpanContext();
+        }
       }
     }
     return null;