fix(core): Suppress the new Error Prone and javac 21 findings in the sentry module

Author: markushi

sentry/src/main/java/io/sentry/Baggage.java

@@ -257,6 +257,10 @@ public String getThirdPartyHeader() {
     return thirdPartyHeader;
   }
 
+  // TODO Fix for JDK21: ConcurrentHashMap.keySet() compiled against JDK 8+ returns KeySetView,
+  // which crashes on Android
+  // < 24.
+  @SuppressWarnings("JdkObsolete")
   public @NotNull String toHeaderString(@Nullable String thirdPartyBaggageHeaderString) {
     final StringBuilder sb = new StringBuilder();
     String separator = "";
@@ -325,10 +329,14 @@ public String getThirdPartyHeader() {
     return sb.toString();
   }
 
+  // TODO Fix for JDK21: The Charset overload requires Java 10.
+  @SuppressWarnings("JdkObsolete")
   private String encode(final @NotNull String value) throws UnsupportedEncodingException {
     return URLEncoder.encode(value, CHARSET).replaceAll("\\+", "%20");
   }
 
+  // TODO Fix for JDK21: The Charset overload requires Java 10.
+  @SuppressWarnings("JdkObsolete")
   private static String decode(final @NotNull String value) throws UnsupportedEncodingException {
     return URLDecoder.decode(value, CHARSET);
   }

sentry/src/main/java/io/sentry/Breadcrumb.java

@@ -630,6 +630,8 @@ public void setType(@Nullable String type) {
     this.type = type;
   }
 
+  // TODO Fix for JDK21: EMPTY_DATA is a sentinel, so identity comparison is intended.
+  @SuppressWarnings("ReferenceEquality")
   private @NotNull Map<String, @NotNull Object> getOrCreateData() {
     Map<String, @NotNull Object> currentData = data;
     if (currentData == EMPTY_DATA) {
@@ -691,6 +693,8 @@ public void setData(@Nullable String key, @Nullable Object value) {
    *
    * @param key the key
    */
+  // TODO Fix for JDK21: EMPTY_DATA is a sentinel, so identity comparison is intended.
+  @SuppressWarnings("ReferenceEquality")
   public void removeData(@Nullable String key) {
     if (key == null) {
       return;

sentry/src/main/java/io/sentry/DiagnosticLogger.java

@@ -29,6 +29,8 @@ public DiagnosticLogger(final @NotNull SentryOptions options, final @Nullable IL
    * @param level The SentryLevel to test against.
    * @return True if a log message would be recorded for the level. Otherwise false.
    */
+  // TODO Fix for JDK21: SentryLevel is declared in ascending severity order.
+  @SuppressWarnings("EnumOrdinal")
   @Override
   public boolean isEnabled(final @Nullable SentryLevel level) {
     final SentryLevel diagLevel = options.getDiagnosticLevel();

sentry/src/main/java/io/sentry/MonitorContexts.java

@@ -43,6 +43,10 @@ public void setTrace(final @NotNull SpanContext traceContext) {
 
   // region json
 
+  // TODO Fix for JDK21: ConcurrentHashMap.keySet() compiled against JDK 8+ returns KeySetView,
+  // which crashes on Android
+  // < 24.
+  @SuppressWarnings("JdkObsolete")
   @Override
   public void serialize(final @NotNull ObjectWriter writer, final @NotNull ILogger logger)
       throws IOException {

sentry/src/main/java/io/sentry/ReplayRecording.java

@@ -102,7 +102,8 @@ public void setUnknown(@Nullable Map<String, Object> unknown) {
 
   public static final class Deserializer implements JsonDeserializer<ReplayRecording> {
 
-    @SuppressWarnings("unchecked")
+    // TODO Fix for JDK21: The rrweb protocol encodes these enums by ordinal.
+    @SuppressWarnings({"unchecked", "EnumOrdinal"})
     @Override
     public @NotNull ReplayRecording deserialize(
         @NotNull ObjectReader reader, @NotNull ILogger logger) throws Exception {

sentry/src/main/java/io/sentry/SentryOptions.java

@@ -58,6 +58,9 @@
 import org.jetbrains.annotations.TestOnly;
 
 /** Sentry SDK options */
+// TODO Fix for JDK21: Constructors call overridable methods; making them final would break the
+// public API.
+@SuppressWarnings("this-escape")
 @Open
 public class SentryOptions implements RateLimiterConfig {
 

sentry/src/main/java/io/sentry/SentryThreadFactory.java

@@ -78,6 +78,8 @@ List<SentryThread> getCurrentThreads(
    *     crashed. This is the case for e.g. watchdog threads which are not the one erroring.
    * @return a list of SentryThread or null if none
    */
+  // TODO Fix for JDK21: Identifies the current thread by identity.
+  @SuppressWarnings("ReferenceEquality")
   @TestOnly
   @Nullable
   List<SentryThread> getCurrentThreads(

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

@@ -16,6 +16,9 @@
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.TestOnly;
 
+// TODO Fix for JDK21: Constructors call overridable methods; making them final would break the
+// public API.
+@SuppressWarnings("this-escape")
 @Open
 public class SpanContext implements JsonUnknown, JsonSerializable {
   public static final String TYPE = "trace";

sentry/src/main/java/io/sentry/SynchronizedCollection.java

@@ -50,9 +50,14 @@ class SynchronizedCollection<E> implements Collection<E>, Serializable {
   private static final long serialVersionUID = 2412805092710877986L;
 
   /** The collection to decorate */
+  // TODO Fix for JDK21: Serializable only if the decorated collection is, as in Apache Commons
+  // Collections.
+  @SuppressWarnings("serial")
   private final Collection<E> collection;
 
   /** The object to lock on, needed for List/SortedSet views */
+  // TODO Fix for JDK21: Not Serializable either; the SDK never serializes these collections.
+  @SuppressWarnings("serial")
   final AutoClosableReentrantLock lock;
 
   /**

sentry/src/main/java/io/sentry/UncaughtExceptionHandlerIntegration.java

@@ -47,6 +47,8 @@ public UncaughtExceptionHandlerIntegration() {
     this.threadAdapter = threadAdapter;
   }
 
+  // TODO Fix for JDK21: Both integrations must share the same global scope instance.
+  @SuppressWarnings("ReferenceEquality")
   @Override
   public final void register(final @NotNull IScopes scopes, final @NotNull SentryOptions options) {
     if (registered) {