Make ITransport top-level abstraction for sending events to Sentry.

CHANGELOG.md

@@ -1,5 +1,8 @@
 # vNext
 
+* Ref: `ITransport` implementations are now responsible for executing request in asynchronous or synchronous way (#1118)
+* Ref: Add option to set `TransportFactory` instead of `ITransport` on `SentryOptions` (#1124) 
+
 # 4.0.0-alpha.2
 
 * Feat: Add basic support for attachments (#1082)

sentry-log4j2/api/sentry-log4j2.api

@@ -4,7 +4,7 @@ public final class io/sentry/log4j2/BuildConfig {
 }
 
 public final class io/sentry/log4j2/SentryAppender : org/apache/logging/log4j/core/appender/AbstractAppender {
-	public fun <init> (Ljava/lang/String;Lorg/apache/logging/log4j/core/Filter;Ljava/lang/String;Lorg/apache/logging/log4j/Level;Lorg/apache/logging/log4j/Level;Lio/sentry/transport/ITransport;Lio/sentry/IHub;)V
+	public fun <init> (Ljava/lang/String;Lorg/apache/logging/log4j/core/Filter;Ljava/lang/String;Lorg/apache/logging/log4j/Level;Lorg/apache/logging/log4j/Level;Lio/sentry/ITransportFactory;Lio/sentry/IHub;)V
 	public fun append (Lorg/apache/logging/log4j/core/LogEvent;)V
 	public static fun createAppender (Ljava/lang/String;Lorg/apache/logging/log4j/Level;Lorg/apache/logging/log4j/Level;Ljava/lang/String;Lorg/apache/logging/log4j/core/Filter;)Lio/sentry/log4j2/SentryAppender;
 	public fun start ()V

sentry-log4j2/src/main/java/io/sentry/log4j2/SentryAppender.java

@@ -4,13 +4,13 @@
 import io.sentry.DateUtils;
 import io.sentry.HubAdapter;
 import io.sentry.IHub;
+import io.sentry.ITransportFactory;
 import io.sentry.Sentry;
 import io.sentry.SentryEvent;
 import io.sentry.SentryLevel;
 import io.sentry.SentryOptions;
 import io.sentry.protocol.Message;
 import io.sentry.protocol.SdkVersion;
-import io.sentry.transport.ITransport;
 import io.sentry.util.CollectionUtils;
 import java.util.Arrays;
 import java.util.Collections;
@@ -36,7 +36,7 @@
 @Plugin(name = "Sentry", category = "Core", elementType = "appender", printObject = true)
 public final class SentryAppender extends AbstractAppender {
   private final @Nullable String dsn;
-  private final @Nullable ITransport transport;
+  private final @Nullable ITransportFactory transportFactory;
   private @NotNull Level minimumBreadcrumbLevel = Level.INFO;
   private @NotNull Level minimumEventLevel = Level.ERROR;
   private final @NotNull IHub hub;
@@ -47,7 +47,7 @@ public SentryAppender(
       final @Nullable String dsn,
       final @Nullable Level minimumBreadcrumbLevel,
       final @Nullable Level minimumEventLevel,
-      final @Nullable ITransport transport,
+      final @Nullable ITransportFactory transportFactory,
       final @NotNull IHub hub) {
     super(name, filter, null, true, null);
     this.dsn = dsn;
@@ -57,7 +57,7 @@ public SentryAppender(
     if (minimumEventLevel != null) {
       this.minimumEventLevel = minimumEventLevel;
     }
-    this.transport = transport;
+    this.transportFactory = transportFactory;
     this.hub = hub;
   }
 
@@ -103,7 +103,7 @@ public void start() {
               options.setDsn(dsn);
               options.setSentryClientName(BuildConfig.SENTRY_LOG4J2_SDK_NAME);
               options.setSdkVersion(createSdkVersion(options));
-              Optional.ofNullable(transport).ifPresent(options::setTransport);
+              Optional.ofNullable(transportFactory).ifPresent(options::setTransportFactory);
             });
       } catch (IllegalArgumentException e) {
         LOGGER.info("Failed to init Sentry during appender initialization: " + e.getMessage());

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

@@ -1,8 +1,12 @@
 package io.sentry.log4j2
 
+import com.nhaarman.mockitokotlin2.any
+import com.nhaarman.mockitokotlin2.anyOrNull
 import com.nhaarman.mockitokotlin2.mock
 import com.nhaarman.mockitokotlin2.verify
+import com.nhaarman.mockitokotlin2.whenever
 import io.sentry.HubAdapter
+import io.sentry.ITransportFactory
 import io.sentry.Sentry
 import io.sentry.SentryLevel
 import io.sentry.test.checkEvent
@@ -30,13 +34,20 @@ import org.awaitility.kotlin.await
 class SentryAppenderTest {
     private class Fixture() {
         val loggerContext = LogManager.getContext() as LoggerContext
-        lateinit var transport: ITransport
+        var transportFactory = mock<ITransportFactory>()
+        var transport = mock<ITransport>()
 
-        fun getSut(transport: ITransport = mock(), minimumBreadcrumbLevel: Level? = null, minimumEventLevel: Level? = null): ExtendedLogger {
-            this.transport = transport
+        init {
+            whenever(transportFactory.create(any())).thenReturn(transport)
+        }
+
+        fun getSut(transportFactory: ITransportFactory? = null, minimumBreadcrumbLevel: Level? = null, minimumEventLevel: Level? = null): ExtendedLogger {
+            if (transportFactory != null) {
+                this.transportFactory = transportFactory
+            }
             loggerContext.start()
             val config: Configuration = loggerContext.configuration
-            val appender = SentryAppender("sentry", null, "http://key@localhost/proj", minimumBreadcrumbLevel, minimumEventLevel, transport, HubAdapter.getInstance())
+            val appender = SentryAppender("sentry", null, "http://key@localhost/proj", minimumBreadcrumbLevel, minimumEventLevel, this.transportFactory, HubAdapter.getInstance())
             config.addAppender(appender)
 
             val ref = AppenderRef.createAppenderRef("sentry", null, null)
@@ -69,19 +80,18 @@ class SentryAppenderTest {
 
     @Test
     fun `does not initialize Sentry if Sentry is already enabled`() {
-        val transport = mock<ITransport>()
         Sentry.init {
             it.dsn = "http://key@localhost/proj"
             it.environment = "manual-environment"
-            it.setTransport(transport)
+            it.setTransportFactory(fixture.transportFactory)
         }
-        val logger = fixture.getSut(transport = transport)
+        val logger = fixture.getSut()
         logger.error("testing environment field")
 
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertEquals("manual-environment", event.environment)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -96,7 +106,7 @@ class SentryAppenderTest {
                 assertEquals("testing message conversion {}, {}", event.message.message)
                 assertEquals(listOf("1", "2"), event.message.params)
                 assertEquals("io.sentry.log4j2.SentryAppenderTest", event.logger)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -115,7 +125,7 @@ class SentryAppenderTest {
 
                 assertTrue { eventTime.plusSeconds(1).isAfter(utcTime) }
                 assertTrue { eventTime.minusSeconds(1).isBefore(utcTime) }
-            })
+            }, anyOrNull())
         }
     }
 
@@ -127,7 +137,7 @@ class SentryAppenderTest {
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertEquals(SentryLevel.DEBUG, event.level)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -139,7 +149,7 @@ class SentryAppenderTest {
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertEquals(SentryLevel.DEBUG, event.level)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -151,7 +161,7 @@ class SentryAppenderTest {
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertEquals(SentryLevel.INFO, event.level)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -163,7 +173,7 @@ class SentryAppenderTest {
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertEquals(SentryLevel.WARNING, event.level)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -175,7 +185,7 @@ class SentryAppenderTest {
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertEquals(SentryLevel.ERROR, event.level)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -187,7 +197,7 @@ class SentryAppenderTest {
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertEquals(SentryLevel.FATAL, event.level)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -199,7 +209,7 @@ class SentryAppenderTest {
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertNotNull(event.getExtra("thread_name"))
-            })
+            }, anyOrNull())
         }
     }
 
@@ -212,7 +222,7 @@ class SentryAppenderTest {
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertEquals(mapOf("key" to "value"), event.contexts["Context Data"])
-            })
+            }, anyOrNull())
         }
     }
 
@@ -224,7 +234,7 @@ class SentryAppenderTest {
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertFalse(event.contexts.containsKey("MDC"))
-            })
+            }, anyOrNull())
         }
     }
 
@@ -242,7 +252,7 @@ class SentryAppenderTest {
                     "maven:sentry-log4j2" == pkg.name &&
                         BuildConfig.VERSION_NAME == pkg.version
                 })
-            })
+            }, anyOrNull())
         }
     }
 
@@ -267,7 +277,7 @@ class SentryAppenderTest {
                 assertEquals("this should be a breadcrumb #1", breadcrumb.message)
                 assertEquals("io.sentry.log4j2.SentryAppenderTest", breadcrumb.category)
                 assertEquals(SentryLevel.DEBUG, breadcrumb.level)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -283,7 +293,7 @@ class SentryAppenderTest {
             verify(fixture.transport).send(checkEvent { event ->
                 assertEquals(1, event.breadcrumbs.size)
                 assertEquals("this should be a breadcrumb", event.breadcrumbs[0].message)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -301,7 +311,7 @@ class SentryAppenderTest {
                 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)
-            })
+            }, anyOrNull())
         }
     }
 
@@ -313,7 +323,7 @@ class SentryAppenderTest {
         await.untilAsserted {
             verify(fixture.transport).send(checkEvent { event ->
                 assertEquals("release from sentry.properties", event.release)
-            })
+            }, anyOrNull())
         }
     }
 }

sentry-logback/src/main/java/io/sentry/logback/SentryAppender.java

@@ -6,13 +6,13 @@
 import ch.qos.logback.core.UnsynchronizedAppenderBase;
 import io.sentry.Breadcrumb;
 import io.sentry.DateUtils;
+import io.sentry.ITransportFactory;
 import io.sentry.Sentry;
 import io.sentry.SentryEvent;
 import io.sentry.SentryLevel;
 import io.sentry.SentryOptions;
 import io.sentry.protocol.Message;
 import io.sentry.protocol.SdkVersion;
-import io.sentry.transport.ITransport;
 import io.sentry.util.CollectionUtils;
 import java.util.Arrays;
 import java.util.Collections;
@@ -29,7 +29,7 @@
 /** Appender for logback in charge of sending the logged events to a Sentry server. */
 public final class SentryAppender extends UnsynchronizedAppenderBase<ILoggingEvent> {
   private @NotNull SentryOptions options = new SentryOptions();
-  private @Nullable ITransport transport;
+  private @Nullable ITransportFactory transportFactory;
   private @NotNull Level minimumBreadcrumbLevel = Level.INFO;
   private @NotNull Level minimumEventLevel = Level.ERROR;
 
@@ -39,7 +39,7 @@ public void start() {
       options.setEnableExternalConfiguration(true);
       options.setSentryClientName(BuildConfig.SENTRY_LOGBACK_SDK_NAME);
       options.setSdkVersion(createSdkVersion(options));
-      Optional.ofNullable(transport).ifPresent(options::setTransport);
+      Optional.ofNullable(transportFactory).ifPresent(options::setTransportFactory);
       try {
         Sentry.init(options);
       } catch (IllegalArgumentException e) {
@@ -179,7 +179,7 @@ public void setMinimumEventLevel(final @Nullable Level minimumEventLevel) {
   }
 
   @ApiStatus.Internal
-  void setTransport(@Nullable ITransport transport) {
-    this.transport = transport;
+  void setTransportFactory(final @Nullable ITransportFactory transportFactory) {
+    this.transportFactory = transportFactory;
   }
 }