Merge pull request #2350 from bugsnag/PLAT-15132/notify-http-errors

Report HTTP errors

Author: lemnik

bugsnag-android-core/api/bugsnag-android-core.api

@@ -702,6 +702,8 @@ public abstract interface class com/bugsnag/android/Plugin {
 }
 
 public final class com/bugsnag/android/Request : com/bugsnag/android/AbstractHttpEntity, com/bugsnag/android/JsonStream$Streamable {
+	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
+	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
 	public fun addQueryParameter (Ljava/lang/String;Ljava/lang/String;)V
 	public fun getHttpMethod ()Ljava/lang/String;
 	public fun getHttpVersion ()Ljava/lang/String;
@@ -716,6 +718,7 @@ public final class com/bugsnag/android/Request : com/bugsnag/android/AbstractHtt
 }
 
 public final class com/bugsnag/android/Response : com/bugsnag/android/AbstractHttpEntity, com/bugsnag/android/JsonStream$Streamable {
+	public fun <init> (I)V
 	public fun getStatusCode ()I
 	public fun setStatusCode (I)V
 	public fun toStream (Lcom/bugsnag/android/JsonStream;)V

bugsnag-android-core/src/androidTest/java/com/bugsnag/android/RequestTest.kt

@@ -8,14 +8,11 @@ class RequestTest {
     private val testBodyString = "this is a body string with some content"
     private val customBodyLength = 5000L
 
-    private val logger = NoopLogger
-
     @Test
     fun urlQueryIsExtracted() {
         val request = Request(
-            logger,
-            "GET",
             "1.1",
+            "GET",
             "http://localhost/test?t1=arg1&test2=argument+2"
         )
 
@@ -27,14 +24,14 @@ class RequestTest {
 
     @Test
     fun setBody() {
-        val request = Request(logger, "GET", "1.1", "http://localhost/")
+        val request = Request("1.1", "GET", "http://localhost/")
         request.body = testBodyString
         assertEquals(testBodyString, request.body)
     }
 
     @Test
     fun setBodyWithUserLength() {
-        val request = Request(logger, "GET", "1.1", "http://localhost/")
+        val request = Request("1.1", "GET", "http://localhost/")
         request.bodyLength = customBodyLength
         request.body = testBodyString
 
@@ -44,15 +41,15 @@ class RequestTest {
 
     @Test
     fun setNullBody() {
-        val request = Request(logger, "GET", "1.1", "http://localhost/")
+        val request = Request("1.1", "GET", "http://localhost/")
         request.body = testBodyString
         request.body = null
         assertNull(request.body)
     }
 
     @Test
     fun setHttpMethod() {
-        val request = Request(logger, "GET", "1.1", "http://localhost/")
+        val request = Request("1.1", "GET", "http://localhost/")
         assertEquals("GET", request.httpMethod)
 
         request.httpMethod = "POST"
@@ -61,7 +58,7 @@ class RequestTest {
 
     @Test
     fun setHttpVersion() {
-        val request = Request(logger, "1.1", "1.1", "http://localhost/")
+        val request = Request("1.1", "1.1", "http://localhost/")
         assertEquals("1.1", request.httpVersion)
 
         request.httpVersion = "1.0"
@@ -70,7 +67,7 @@ class RequestTest {
 
     @Test
     fun setUrl() {
-        val request = Request(logger, "GET", "1.1", "http://localhost/")
+        val request = Request("1.1", "GET", "http://localhost/")
         assertEquals("http://localhost/", request.url)
 
         request.url = "https://google.com"
@@ -79,7 +76,7 @@ class RequestTest {
 
     @Test
     fun setUrlWithQuery() {
-        val request = Request(logger, "GET", "1.1", "http://localhost/")
+        val request = Request("1.1", "GET", "http://localhost/")
         request.url = "http://foo.com?a=1&b=2"
         assertEquals("http://foo.com", request.url)
         assertEquals("1", request.getQueryParameter("a"))
@@ -89,7 +86,7 @@ class RequestTest {
 
     @Test
     fun queryParameters() {
-        val request = Request(logger, "GET", "1.1", "http://localhost/")
+        val request = Request("1.1", "GET", "http://localhost/")
         request.addQueryParameter("foo", "bar")
         request.addQueryParameter("another", "param")
 
@@ -104,7 +101,7 @@ class RequestTest {
 
     @Test
     fun headers() {
-        val request = Request(logger, "GET", "1.1", "http://localhost/")
+        val request = Request("1.1", "GET", "http://localhost/")
         request.addHeader("X-Test", "value")
         request.addHeader("Another-Header", "another-value")
 
@@ -119,7 +116,7 @@ class RequestTest {
 
     @Test
     fun setBodyLength() {
-        val request = Request(logger, "GET", "1.1", "http://localhost/")
+        val request = Request("1.1", "GET", "http://localhost/")
         request.bodyLength = 1234
         assertEquals(1234, request.bodyLength)
 

bugsnag-android-core/src/main/java/com/bugsnag/android/Request.java

@@ -18,40 +18,56 @@
  */
 @SuppressWarnings("ConstantValue")
 public final class Request extends AbstractHttpEntity implements JsonStream.Streamable {
-    private final Logger logger;
     private final Map<String, String> params = new LinkedHashMap<>();
 
-    @NonNull
+    @Nullable
     private String httpMethod;
 
-    @NonNull
+    @Nullable
     private String httpVersion;
 
-    @NonNull
-    @SuppressWarnings("NotNullFieldNotInitialized")
+    @Nullable
     private String url;
 
-    Request(Logger logger,
-            @NonNull String httpMethod,
-            @NonNull String httpVersion,
-            @NonNull String url) {
+    /**
+     * Constructs a new Request with the specified HTTP version, method, and URL.
+     * If the URL contains query parameters, they will be extracted and stored separately.
+     *
+     * @param httpVersion the HTTP version (e.g. "HTTP/1.1"), or null
+     * @param httpMethod  the HTTP method (e.g. "GET", "POST"), or null
+     * @param url         the request URL, optionally including query parameters, or null
+     */
+    public Request(
+            @Nullable String httpVersion,
+            @Nullable String httpMethod,
+            @Nullable String url) {
 
-        this.logger = logger;
         this.httpMethod = httpMethod;
         this.httpVersion = httpVersion;
         setUrl(url);
     }
 
-    private void logNull(String property) {
-        logger.e("Invalid null value supplied to request." + property + ", ignoring");
+    /**
+     * Constructs a new Request with the specified HTTP method and URL.
+     * The HTTP version will be set to null.
+     * If the URL contains query parameters, they will be extracted and stored separately.
+     *
+     * @param httpMethod the HTTP method (e.g. "GET", "POST"), or null
+     * @param url        the request URL, optionally including query parameters, or null
+     */
+    public Request(
+            @Nullable String httpMethod,
+            @Nullable String url) {
+
+        this(null, httpMethod, url);
     }
 
     /**
      * Return the HTTP method for this request (e.g. "GET").
      *
      * @return the HTTP method
      */
-    @NonNull
+    @Nullable
     public String getHttpMethod() {
         return httpMethod;
     }
@@ -61,20 +77,16 @@ public String getHttpMethod() {
      *
      * @param httpMethod the HTTP method name
      */
-    public void setHttpMethod(@NonNull String httpMethod) {
-        if (httpMethod != null) {
-            this.httpMethod = httpMethod;
-        } else {
-            logNull("httpMethod");
-        }
+    public void setHttpMethod(@Nullable String httpMethod) {
+        this.httpMethod = httpMethod;
     }
 
     /**
      * Return the HTTP version for this request (e.g. "HTTP/1.1").
      *
      * @return the HTTP version
      */
-    @NonNull
+    @Nullable
     public String getHttpVersion() {
         return httpVersion;
     }
@@ -84,20 +96,16 @@ public String getHttpVersion() {
      *
      * @param httpVersion the HTTP version
      */
-    public void setHttpVersion(@NonNull String httpVersion) {
-        if (httpVersion != null) {
-            this.httpVersion = httpVersion;
-        } else {
-            logNull("httpVersion");
-        }
+    public void setHttpVersion(@Nullable String httpVersion) {
+        this.httpVersion = httpVersion;
     }
 
     /**
      * Return the URL for this request, excluding query parameters.
      *
      * @return the request URL
      */
-    @NonNull
+    @Nullable
     public String getUrl() {
         return url;
     }
@@ -108,7 +116,7 @@ public String getUrl() {
      *
      * @param url the request URL, optionally including query parameters
      */
-    public void setUrl(@NonNull String url) {
+    public void setUrl(@Nullable String url) {
         if (url != null) {
             int querySeparatorIndex = url.indexOf('?');
 

bugsnag-android-core/src/main/java/com/bugsnag/android/Response.java

@@ -12,7 +12,12 @@
 public final class Response extends AbstractHttpEntity implements JsonStream.Streamable {
     private int statusCode;
 
-    Response(@IntRange(from = 0) int statusCode) {
+    /**
+     * Constructs a new Response with the specified HTTP status code.
+     *
+     * @param statusCode the HTTP status code
+     */
+    public Response(@IntRange(from = 0) int statusCode) {
         this.statusCode = statusCode;
     }
 

bugsnag-plugin-android-okhttp/detekt-baseline.xml

@@ -12,6 +12,8 @@
     <ID>MagicNumber:BugsnagOkHttpPlugin.kt$399</ID>
     <ID>MagicNumber:BugsnagOkHttpPlugin.kt$400</ID>
     <ID>MagicNumber:BugsnagOkHttpPlugin.kt$599</ID>
+    <ID>NestedBlockDepth:BugsnagOkHttpInterceptor.kt$OkHttpInstrumentedResponse$private fun extractResponseBody(): String?</ID>
+    <ID>ReturnCount:BugsnagOkHttpInterceptor.kt$OkHttpInstrumentedResponse$private fun extractResponseBody(): String?</ID>
     <ID>TooManyFunctions:DelegateEventListener.kt$DelegateEventListener : EventListener</ID>
   </CurrentIssues>
 </SmellBaseline>

bugsnag-plugin-android-okhttp/src/main/java/com/bugsnag/android/okhttp/BugsnagOkHttp.kt

@@ -19,6 +19,7 @@ import kotlin.math.max
  * [addInterceptor](okhttp3.OkHttpClient.Builder.addInterceptor) to configure it with your
  * `OkHttpClient`.
  */
+@Suppress("SENSELESS_COMPARISON")
 class BugsnagOkHttp : HttpInstrumentationBuilder<Request, Response> {
     private val errorCodes = BitSet()
     private var maxRequestBodyCapture = DEFAULT_BODY_CAPTURE_SIZE
@@ -85,7 +86,6 @@ class BugsnagOkHttp : HttpInstrumentationBuilder<Request, Response> {
     }
 
     override fun addRequestCallback(callback: HttpRequestCallback<Request>): BugsnagOkHttp {
-        @Suppress("SENSELESS_COMPARISON")
         if (callback != null) {
             requestCallbacks.add(callback)
         }
@@ -94,7 +94,6 @@ class BugsnagOkHttp : HttpInstrumentationBuilder<Request, Response> {
     }
 
     override fun addResponseCallback(callback: HttpResponseCallback<Request, Response>): BugsnagOkHttp {
-        @Suppress("SENSELESS_COMPARISON")
         if (callback != null) {
             responseCallbacks.add(callback)
         }
@@ -148,6 +147,6 @@ class BugsnagOkHttp : HttpInstrumentationBuilder<Request, Response> {
     }
 
     internal companion object {
-        private const val DEFAULT_BODY_CAPTURE_SIZE = 4096L
+        private const val DEFAULT_BODY_CAPTURE_SIZE: Long = 0L
     }
 }