Add reactive-streams Notifier implementation with optional Reactor support (#263)

* Add reactive-streams Notifier implementation with optional Project Reactor support.

* Rollbar java reactivestreams implementation: Replace Thread.sleep in ReactorAsyncHttpClient with Project Reactor built-in block method.

Author: diegov

.palantir/revapi.yml

@@ -0,0 +1,15 @@
+acceptedBreaks:
+  "1.7.6":
+    com.rollbar:rollbar-java:
+    - code: "java.field.removed"
+      old: "field com.rollbar.notifier.config.ConfigBuilder.defaultErrorLevel"
+      justification: "Removing protected fields, deriving from ConfigBuilder should\
+        \ be done by other SDK classes only"
+    - code: "java.field.removed"
+      old: "field com.rollbar.notifier.config.ConfigBuilder.defaultMessageLevel"
+      justification: "Removing protected fields, deriving from ConfigBuilder should\
+        \ be done by other SDK classes only"
+    - code: "java.field.removed"
+      old: "field com.rollbar.notifier.config.ConfigBuilder.defaultThrowableLevel"
+      justification: "Removing protected fields, deriving from ConfigBuilder should\
+        \ be done by other SDK classes only"

README.md

@@ -26,6 +26,7 @@ For actual usage, the easiest way to get started is by looking at the examples:
 - [rollbar-logback](https://github.com/rollbar/rollbar-java/tree/master/examples/rollbar-logback)
 - [rollbar-spring-webmvc](https://github.com/rollbar/rollbar-java/tree/master/examples/rollbar-spring-webmvc)
 - [rollbar-spring-boot-webmvc](https://github.com/rollbar/rollbar-java/tree/master/examples/rollbar-spring-boot-webmvc)
+- [rollbar-reactive-streams-reactor](https://github.com/rollbar/rollbar-java/tree/master/examples/rollbar-reactive-streams-reactor)
 
 ## Release History & Changelog
 

build.gradle

@@ -35,7 +35,11 @@ subprojects { project ->
             !project.parent.name.equals("examples") &&
             !project.name.contains('examples')) {
         apply plugin: 'java-library'
-        apply from: "$rootDir/gradle/release.gradle"
+
+        // reactive-streams support will be published along with Spring Webflux 
+        if (!project.name.startsWith('rollbar-reactive-streams')) {
+            apply from: "$rootDir/gradle/release.gradle"
+        }
 
         apply from: "$rootDir/gradle/quality.gradle"
 
@@ -57,7 +61,7 @@ subprojects { project ->
         dependencies {
             testImplementation group: 'junit', name: 'junit', version: '4.12'
             testImplementation group: 'org.hamcrest', name: 'hamcrest-all', version: '1.3'
-            testImplementation group: 'org.mockito', name: 'mockito-core', version: '2.28.2'
+            testImplementation group: 'org.mockito', name: 'mockito-core', version: '3.8.0'
         }
 
         compileJava {

examples/rollbar-reactive-streams-reactor/build.gradle

@@ -0,0 +1,21 @@
+apply plugin: 'application'
+
+jar {
+    archivesBaseName = "rollbar-reactive-streams-reactor-example"
+    archiveVersion =  '0.1.0'
+}
+
+application {
+    mainClassName = "com.rollbar.reactivestreams.reactor.example.Application"
+}
+
+dependencies {
+    implementation project(":rollbar-reactive-streams-reactor")
+
+    implementation platform('io.projectreactor:reactor-bom:2020.0.6')
+    implementation 'io.projectreactor:reactor-core'
+    implementation 'io.projectreactor:reactor-tools'
+    implementation 'io.projectreactor.netty:reactor-netty-http'
+
+    implementation 'org.slf4j:slf4j-log4j12:1.7.25'
+}

examples/rollbar-reactive-streams-reactor/src/main/java/com/rollbar/reactivestreams/reactor/example/Application.java

@@ -0,0 +1,57 @@
+package com.rollbar.reactivestreams.reactor.example;
+
+import com.rollbar.reactivestreams.notifier.ReactorRollbar;
+import com.rollbar.reactivestreams.notifier.config.Config;
+import com.rollbar.reactivestreams.notifier.config.ConfigBuilder;
+import com.rollbar.reactivestreams.notifier.sender.http.ReactorAsyncHttpClient;
+import reactor.core.publisher.Hooks;
+import reactor.core.publisher.Mono;
+import reactor.netty.DisposableChannel;
+import reactor.netty.DisposableServer;
+import reactor.netty.http.client.HttpClient;
+import reactor.netty.http.client.HttpClientResponse;
+import reactor.netty.tcp.TcpServer;
+
+/**
+ * Application example using rollbar-reactive-streams-reactor.
+ */
+public class Application {
+  /**
+   * Main method for the rollbar-reactive-streams-reactor example application.
+   *
+   * @param args command line arguments (unused).
+   */
+  public static void main(String[] args) throws Exception {
+    Config config = ConfigBuilder
+        .withAccessToken(System.getenv("ROLLBAR_ACCESSTOKEN"))
+        .httpClient(new ReactorAsyncHttpClient.Builder().build())
+        .environment("development")
+        .build();
+
+    ReactorRollbar rollbar = new ReactorRollbar(config);
+
+    // We'll create a misbehaving HTTP server that immediately disconnects clients
+    DisposableServer badServer = TcpServer.create().port(0)
+        .doOnConnection(DisposableChannel::disposeNow)
+        .bindNow();
+
+    String url = "http://localhost:" + badServer.port();
+
+    // Rollbar.logMonoError will log the error and return the original Mono
+    Mono<HttpClientResponse> request = HttpClient.create()
+        .get()
+        .uri(url)
+        .response()
+        .onErrorResume(rollbar::logMonoError);
+
+    // The Mono still contains the original error, and we're free to handle it however we see fit.
+    // For this example, we'll replace the error it with an empty Mono to let the application
+    // exit successfully, and block until it completes.
+    request.onErrorResume(r -> Mono.empty()).block();
+
+    rollbar.close(true);
+
+    badServer.dispose();
+  }
+
+}

examples/rollbar-reactive-streams-reactor/src/main/resources/log4j.properties

@@ -0,0 +1,14 @@
+# Root logger option
+log4j.rootLogger=INFO, stdout
+
+# Rollbar logger
+log4j.logger.com.rollbar.notifier=DEBUG, stdout
+log4j.additivity.com.rollbar.notifier=false
+log4j.logger.com.rollbar.reactivestreams.notifier=DEBUG, stdout
+log4j.additivity.com.rollbar.reactivestreams.notifier=false
+
+# Direct log messages to stdout
+log4j.appender.stdout=org.apache.log4j.ConsoleAppender
+log4j.appender.stdout.Target=System.out
+log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
+log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

gradle/quality.gradle

@@ -31,13 +31,13 @@ spotbugsMain {
     }
 }
 spotbugsTest {
-    ignoreFailures = true
+    enabled = false
 }
 
 afterEvaluate {
     if (project.tasks.findByPath("spotbugsIntegTest") != null) {
         spotbugsIntegTest {
-            ignoreFailures = true
+            enabled = false
         }
     }
 }

rollbar-api/src/main/java/com/rollbar/api/annotations/Unstable.java

@@ -0,0 +1,18 @@
+package com.rollbar.api.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * <p>
+ * Classes and methods annotated with {@link Unstable} will likely change in ways that will break
+ * backwards compatibility, both at source and binary level.
+ * </p>
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface Unstable {
+  String reason = "This class or method is not part of the SDK's public API, and will likely "
+      + "change in ways that will break backwards compatibility, both at source and binary level.";
+}

rollbar-java/build.gradle

@@ -11,6 +11,10 @@ buildscript {
 
 apply plugin: "nebula.integtest"
 
+configurations {
+    integTestArtifacts
+}
+
 dependencies {
   api project(':rollbar-api')
 
@@ -76,3 +80,13 @@ test {
   // running tests. 
   systemProperty 'ROLLBAR_IMPLEMENTATION_VERSION', VERSION_NAME
 }
+
+// The 'java-test-fixtures' plugin is not getting along with 'nebula.integtest', so we'll use this instead
+task integTestJar(type: Jar, dependsOn: project.tasks.integTestClasses) {
+    archiveClassifier.set('integtest')
+    from sourceSets.integTest.output
+}
+
+artifacts {
+    integTestArtifacts integTestJar
+}