Add nullability annotations to sentry module.

CHANGELOG.md

@@ -30,6 +30,7 @@ Breaking Changes:
 * Bump: sentry-native to 0.4.9 (#1431)
 * Fix: Set Span status for OkHttp integration (#1447)
 * Fix: Set user on transaction in Spring & Spring Boot integrations (#1443)
+* Ref: nullability annotations to Sentry module (#1439)
 
 # 4.4.0-alpha.2
 

buildSrc/src/main/java/Config.kt

@@ -102,6 +102,7 @@ object Config {
         val mockitoInline = "org.mockito:mockito-inline:3.8.0"
         val awaitility = "org.awaitility:awaitility-kotlin:4.0.3"
         val mockWebserver = "com.squareup.okhttp3:mockwebserver:4.9.0"
+        val jsonUnit = "net.javacrumbs.json-unit:json-unit:2.11.1"
     }
 
     object QualityPlugins {
@@ -146,6 +147,7 @@ object Config {
         val nopenChecker = "com.jakewharton.nopen:nopen-checker:$nopenVersion"
         val errorprone = "com.google.errorprone:error_prone_core:2.5.1"
         val errorProneJavac8 = "com.google.errorprone:javac:9+181-r4173-1"
+        val errorProneNullAway = "com.uber.nullaway:nullaway:0.9.1"
     }
 
     object NativePlugins {

sentry-android-core/src/main/java/io/sentry/android/core/AndroidLogger.java

@@ -3,6 +3,7 @@
 import android.util.Log;
 import io.sentry.ILogger;
 import io.sentry.SentryLevel;
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 final class AndroidLogger implements ILogger {
@@ -11,18 +12,28 @@ final class AndroidLogger implements ILogger {
 
   @SuppressWarnings("AnnotateFormatMethod")
   @Override
-  public void log(SentryLevel level, String message, Object... args) {
+  public void log(
+      final @NotNull SentryLevel level,
+      final @NotNull String message,
+      final @Nullable Object... args) {
     Log.println(toLogcatLevel(level), tag, String.format(message, args));
   }
 
   @SuppressWarnings("AnnotateFormatMethod")
   @Override
-  public void log(SentryLevel level, Throwable throwable, String message, Object... args) {
+  public void log(
+      final @NotNull SentryLevel level,
+      final @Nullable Throwable throwable,
+      final @NotNull String message,
+      final @Nullable Object... args) {
     log(level, String.format(message, args), throwable);
   }
 
   @Override
-  public void log(SentryLevel level, String message, Throwable throwable) {
+  public void log(
+      final @NotNull SentryLevel level,
+      final @NotNull String message,
+      final @Nullable Throwable throwable) {
 
     switch (level) {
       case INFO:
@@ -49,7 +60,7 @@ public boolean isEnabled(@Nullable SentryLevel level) {
     return true;
   }
 
-  private int toLogcatLevel(SentryLevel sentryLevel) {
+  private int toLogcatLevel(final @NotNull SentryLevel sentryLevel) {
     switch (sentryLevel) {
       case INFO:
         return Log.INFO;

sentry-android-core/src/test/java/io/sentry/android/core/AndroidOptionsInitializerTest.kt

@@ -141,7 +141,9 @@ class AndroidOptionsInitializerTest {
 
         AndroidOptionsInitializer.init(sentryOptions, mockContext)
 
-        assertTrue(sentryOptions.distinctId.isNotEmpty())
+        assertNotNull(sentryOptions.distinctId) {
+            assertTrue(it.isNotEmpty())
+        }
 
         val installation = File(context.filesDir, Installation.INSTALLATION)
         installation.deleteOnExit()

sentry-android-core/src/test/java/io/sentry/android/core/DefaultAndroidEventProcessorTest.kt

@@ -105,8 +105,12 @@ class DefaultAndroidEventProcessorTest {
 
         assertNotNull(sut.process(SentryEvent(), null)) {
             assertNotNull(it.contexts.app)
-            assertEquals("test", it.debugMeta.images[0].uuid)
             assertNotNull(it.dist)
+            assertNotNull(it.debugMeta) { debugMeta ->
+                assertNotNull(debugMeta.images) { images ->
+                    assertEquals("test", images[0].uuid)
+                }
+            }
         }
     }
 
@@ -128,7 +132,11 @@ class DefaultAndroidEventProcessorTest {
         }
 
         assertNotNull(sut.process(event, null)) {
-            assertEquals("test", it.debugMeta.images[0].uuid)
+            assertNotNull(it.debugMeta) { debugMeta ->
+                assertNotNull(debugMeta.images) { images ->
+                    assertEquals("test", images[0].uuid)
+                }
+            }
         }
     }
 
@@ -147,8 +155,12 @@ class DefaultAndroidEventProcessorTest {
         }
 
         assertNotNull(sut.process(event, null)) {
-            assertEquals("abc", it.debugMeta.images.first().uuid)
-            assertEquals("test", it.debugMeta.images.last().uuid)
+            assertNotNull(it.debugMeta) { debugMeta ->
+                assertNotNull(debugMeta.images) { images ->
+                    assertEquals("abc", images.first().uuid)
+                    assertEquals("test", images.last().uuid)
+                }
+            }
         }
     }
 
@@ -164,7 +176,9 @@ class DefaultAndroidEventProcessorTest {
         }
 
         assertNotNull(sut.process(event, null)) {
-            assertTrue(it.threads.first().isCurrent)
+            assertNotNull(it.threads) { threads ->
+                assertTrue(threads.first().isCurrent == true)
+            }
         }
     }
 
@@ -179,7 +193,9 @@ class DefaultAndroidEventProcessorTest {
         }
 
         assertNotNull(sut.process(event, null)) {
-            assertFalse(it.threads.first().isCurrent)
+            assertNotNull(it.threads) { threads ->
+                assertFalse(threads.first().isCurrent == true)
+            }
         }
     }
 

sentry-android-core/src/test/java/io/sentry/android/core/SentryInitProviderTest.kt

@@ -6,7 +6,6 @@ import androidx.test.ext.junit.runners.AndroidJUnit4
 import com.nhaarman.mockitokotlin2.mock
 import io.sentry.ILogger
 import io.sentry.Sentry
-import io.sentry.exception.InvalidDsnException
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertFailsWith
@@ -93,7 +92,7 @@ class SentryInitProviderTest {
 
         metaData.putString(ManifestMetadataReader.DSN, "invalid dsn")
 
-        assertFailsWith<InvalidDsnException> { sentryInitProvider.attachInfo(mockContext, providerInfo) }
+        assertFailsWith<IllegalArgumentException> { sentryInitProvider.attachInfo(mockContext, providerInfo) }
     }
 
     @Test

sentry-android-timber/src/test/java/io/sentry/android/timber/SentryTimberTreeTest.kt

@@ -12,6 +12,7 @@ import io.sentry.getExc
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
+import kotlin.test.assertNotNull
 import kotlin.test.assertNull
 import kotlin.test.assertTrue
 import timber.log.Timber
@@ -165,7 +166,9 @@ class SentryTimberTreeTest {
         val sut = fixture.getSut()
         sut.e("message")
         verify(fixture.hub).captureEvent(check {
-            assertEquals("message", it.message.formatted)
+            assertNotNull(it.message) { message ->
+                assertEquals("message", message.formatted)
+            }
         })
     }
 

sentry-apache-http-client-5/src/main/java/io/sentry/transport/apache/ApacheHttpClientTransport.java

@@ -25,6 +25,7 @@
 import org.apache.hc.core5.io.CloseMode;
 import org.apache.hc.core5.util.TimeValue;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * {@link ITransport} implementation that executes request asynchronously in a non-blocking manner
@@ -62,7 +63,8 @@ public ApacheHttpClientTransport(
 
   @Override
   @SuppressWarnings("FutureReturnValueIgnored")
-  public void send(SentryEnvelope envelope, Object hint) throws IOException {
+  public void send(final @NotNull SentryEnvelope envelope, final @Nullable Object hint)
+      throws IOException {
     if (isSchedulingAllowed()) {
       final SentryEnvelope filteredEnvelope = rateLimiter.filter(envelope, hint);
 

sentry-apache-http-client-5/src/main/java/io/sentry/transport/apache/ApacheHttpClientTransportFactory.java

@@ -32,7 +32,7 @@ public ApacheHttpClientTransportFactory(final @NotNull TimeValue connectionTimeT
   }
 
   @Override
-  public ITransport create(
+  public @NotNull ITransport create(
       final @NotNull SentryOptions options, final @NotNull RequestDetails requestDetails) {
     Objects.requireNonNull(options, "options is required");
     Objects.requireNonNull(requestDetails, "requestDetails is required");

sentry-jul/src/test/kotlin/io/sentry/jul/SentryHandlerTest.kt

@@ -81,9 +81,11 @@ class SentryHandlerTest {
 
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
-                assertEquals("testing message conversion 1, 2", event.message.formatted)
-                assertEquals("testing message conversion {0}, {1}", event.message.message)
-                assertEquals(listOf("1", "2"), event.message.params)
+                assertNotNull(event.message) { message ->
+                    assertEquals("testing message conversion 1, 2", message.formatted)
+                    assertEquals("testing message conversion {0}, {1}", message.message)
+                    assertEquals(listOf("1", "2"), message.params)
+                }
                 assertEquals("jul.SentryHandlerTest", event.logger)
             }, anyOrNull())
         }
@@ -96,9 +98,11 @@ class SentryHandlerTest {
 
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
-                assertEquals("testing message conversion 1, 2", event.message.formatted)
-                assertEquals("testing message conversion {0}, {1}", event.message.message)
-                assertEquals(listOf("1", "2"), event.message.params)
+                assertNotNull(event.message) { message ->
+                    assertEquals("testing message conversion 1, 2", message.formatted)
+                    assertEquals("testing message conversion {0}, {1}", message.message)
+                    assertEquals(listOf("1", "2"), message.params)
+                }
                 assertEquals("jul.SentryHandlerTest", event.logger)
             }, anyOrNull())
         }
@@ -206,16 +210,18 @@ class SentryHandlerTest {
 
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
-                assertEquals(2, event.breadcrumbs.size)
-                val breadcrumb = event.breadcrumbs[0]
-                val breadcrumbTime = Instant.ofEpochMilli(event.timestamp.time)
-                    .atZone(ZoneId.of("UTC"))
-                    .toLocalDateTime()
-                assertTrue { breadcrumbTime.plusSeconds(1).isAfter(utcTime) }
-                assertTrue { breadcrumbTime.minusSeconds(1).isBefore(utcTime) }
-                assertEquals("this should be a breadcrumb #1", breadcrumb.message)
-                assertEquals("jul.SentryHandlerTest", breadcrumb.category)
-                assertEquals(SentryLevel.DEBUG, breadcrumb.level)
+                assertNotNull(event.breadcrumbs) { breadcrumbs ->
+                    assertEquals(2, breadcrumbs.size)
+                    val breadcrumb = breadcrumbs[0]
+                    val breadcrumbTime = Instant.ofEpochMilli(event.timestamp.time)
+                        .atZone(ZoneId.of("UTC"))
+                        .toLocalDateTime()
+                    assertTrue { breadcrumbTime.plusSeconds(1).isAfter(utcTime) }
+                    assertTrue { breadcrumbTime.minusSeconds(1).isBefore(utcTime) }
+                    assertEquals("this should be a breadcrumb #1", breadcrumb.message)
+                    assertEquals("jul.SentryHandlerTest", breadcrumb.category)
+                    assertEquals(SentryLevel.DEBUG, breadcrumb.level)
+                }
             }, anyOrNull())
         }
     }
@@ -230,8 +236,10 @@ class SentryHandlerTest {
 
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
-                assertEquals(1, event.breadcrumbs.size)
-                assertEquals("this should be a breadcrumb", event.breadcrumbs[0].message)
+                assertNotNull(event.breadcrumbs) { breadcrumbs ->
+                    assertEquals(1, breadcrumbs.size)
+                    assertEquals("this should be a breadcrumb", breadcrumbs[0].message)
+                }
             }, anyOrNull())
         }
     }
@@ -247,9 +255,11 @@ class SentryHandlerTest {
 
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
-                assertEquals(2, event.breadcrumbs.size)
-                assertEquals("this should be a breadcrumb", event.breadcrumbs[0].message)
-                assertEquals("this should not be sent as the event but be a breadcrumb", event.breadcrumbs[1].message)
+                assertNotNull(event.breadcrumbs) { breadcrumbs ->
+                    assertEquals(2, breadcrumbs.size)
+                    assertEquals("this should be a breadcrumb", breadcrumbs[0].message)
+                    assertEquals("this should not be sent as the event but be a breadcrumb", breadcrumbs[1].message)
+                }
             }, anyOrNull())
         }
     }

sentry-log4j2/src/test/kotlin/io/sentry/log4j2/SentryAppenderTest.kt

@@ -104,9 +104,11 @@ class SentryAppenderTest {
 
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
-                assertEquals("testing message conversion 1, 2", event.message.formatted)
-                assertEquals("testing message conversion {}, {}", event.message.message)
-                assertEquals(listOf("1", "2"), event.message.params)
+                assertNotNull(event.message) { message ->
+                    assertEquals("testing message conversion 1, 2", message.formatted)
+                    assertEquals("testing message conversion {}, {}", message.message)
+                    assertEquals(listOf("1", "2"), message.params)
+                }
                 assertEquals("io.sentry.log4j2.SentryAppenderTest", event.logger)
             }, anyOrNull())
         }
@@ -303,16 +305,18 @@ class SentryAppenderTest {
 
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
-                assertEquals(2, event.breadcrumbs.size)
-                val breadcrumb = event.breadcrumbs[0]
-                val breadcrumbTime = Instant.ofEpochMilli(event.timestamp.time)
-                    .atZone(fixture.utcTimeZone)
-                    .toLocalDateTime()
-                assertTrue { breadcrumbTime.plusSeconds(1).isAfter(utcTime) }
-                assertTrue { breadcrumbTime.minusSeconds(1).isBefore(utcTime) }
-                assertEquals("this should be a breadcrumb #1", breadcrumb.message)
-                assertEquals("io.sentry.log4j2.SentryAppenderTest", breadcrumb.category)
-                assertEquals(SentryLevel.DEBUG, breadcrumb.level)
+                assertNotNull(event.breadcrumbs) { breadcrumbs ->
+                    assertEquals(2, breadcrumbs.size)
+                    val breadcrumb = breadcrumbs[0]
+                    val breadcrumbTime = Instant.ofEpochMilli(event.timestamp.time)
+                        .atZone(fixture.utcTimeZone)
+                        .toLocalDateTime()
+                    assertTrue { breadcrumbTime.plusSeconds(1).isAfter(utcTime) }
+                    assertTrue { breadcrumbTime.minusSeconds(1).isBefore(utcTime) }
+                    assertEquals("this should be a breadcrumb #1", breadcrumb.message)
+                    assertEquals("io.sentry.log4j2.SentryAppenderTest", breadcrumb.category)
+                    assertEquals(SentryLevel.DEBUG, breadcrumb.level)
+                }
             }, anyOrNull())
         }
     }
@@ -327,8 +331,10 @@ class SentryAppenderTest {
 
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
-                assertEquals(1, event.breadcrumbs.size)
-                assertEquals("this should be a breadcrumb", event.breadcrumbs[0].message)
+                assertNotNull(event.breadcrumbs) { breadcrumbs ->
+                    assertEquals(1, breadcrumbs.size)
+                    assertEquals("this should be a breadcrumb", breadcrumbs[0].message)
+                }
             }, anyOrNull())
         }
     }
@@ -344,9 +350,11 @@ class SentryAppenderTest {
 
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
-                assertEquals(2, event.breadcrumbs.size)
-                assertEquals("this should be a breadcrumb", event.breadcrumbs[0].message)
-                assertEquals("this should not be sent as the event but be a breadcrumb", event.breadcrumbs[1].message)
+                assertNotNull(event.breadcrumbs) { breadcrumbs ->
+                    assertEquals(2, breadcrumbs.size)
+                    assertEquals("this should be a breadcrumb", breadcrumbs[0].message)
+                    assertEquals("this should not be sent as the event but be a breadcrumb", breadcrumbs[1].message)
+                }
             }, anyOrNull())
         }
     }