StatusRuntimeException without stacktrace - Android compatibility

panchenko · panchenko · commit 82e2bd5ab1b3 · 2024-12-19T23:49:08.000+02:00
diff --git a/api/build.gradle b/api/build.gradle
@@ -54,13 +54,11 @@ dependencies {
             extension = "signature"
         }
     }
-    // TODO: Temporarily disabled until StatusException is fixed.
-    // Context: https://github.com/grpc/grpc-java/pull/11066
-    //signature (libraries.signature.android) {
-    //    artifact {
-    //        extension = "signature"
-    //    }
-    //}
+    signature (libraries.signature.android) {
+        artifact {
+            extension = "signature"
+        }
+    }
 }
 
 tasks.named("javadoc").configure {
diff --git a/api/src/main/java/io/grpc/InternalStatus.java b/api/src/main/java/io/grpc/InternalStatus.java
@@ -42,8 +42,8 @@ private InternalStatus() {}
    * of the stack trace.
    */
   @Internal
-  public static final StatusRuntimeException asRuntimeException(Status status,
-      @Nullable Metadata trailers, boolean fillInStackTrace) {
-    return new StatusRuntimeException(status, trailers, fillInStackTrace);
+  public static StatusRuntimeException asRuntimeException(Status status,
+      @Nullable Metadata trailers) {
+    return new InternalStatusRuntimeException(status, trailers);
   }
 }
diff --git a/api/src/main/java/io/grpc/InternalStatusRuntimeException.java b/api/src/main/java/io/grpc/InternalStatusRuntimeException.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2015 The gRPC Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.grpc;
+
+import javax.annotation.Nullable;
+
+/**
+ * StatusRuntimeException without stack trace, implemented as a subclass, as the
+ * {@code String, Throwable, boolean, boolean} constructor is not available in the supported
+ * version of Android.
+ *
+ * @see StatusRuntimeException
+ */
+class InternalStatusRuntimeException extends StatusRuntimeException {
+  private static final long serialVersionUID = 5225396310618305864L;
+
+  public InternalStatusRuntimeException(Status status, @Nullable Metadata trailers) {
+    super(status, trailers);
+  }
+
+  @Override
+  public synchronized Throwable fillInStackTrace() {
+    return this;
+  }
+}
diff --git a/api/src/main/java/io/grpc/StatusException.java b/api/src/main/java/io/grpc/StatusException.java
@@ -44,12 +44,7 @@ public StatusException(Status status) {
    * @since 1.0.0
    */
   public StatusException(Status status, @Nullable Metadata trailers) {
-    this(status, trailers, /*fillInStackTrace=*/ true);
-  }
-
-  StatusException(Status status, @Nullable Metadata trailers, boolean fillInStackTrace) {
-    super(Status.formatThrowableMessage(status), status.getCause(),
-            /* enableSuppression */ true, /* writableStackTrace */fillInStackTrace);
+    super(Status.formatThrowableMessage(status), status.getCause());
     this.status = status;
     this.trailers = trailers;
   }
diff --git a/api/src/main/java/io/grpc/StatusRuntimeException.java b/api/src/main/java/io/grpc/StatusRuntimeException.java
@@ -45,12 +45,7 @@ public StatusRuntimeException(Status status) {
    * @since 1.0.0
    */
   public StatusRuntimeException(Status status, @Nullable Metadata trailers) {
-    this(status, trailers, /*fillInStackTrace=*/ true);
-  }
-
-  StatusRuntimeException(Status status, @Nullable Metadata trailers, boolean fillInStackTrace) {
-    super(Status.formatThrowableMessage(status), status.getCause(),
-            /* enable suppressions */ true, /* writableStackTrace */ fillInStackTrace);
+    super(Status.formatThrowableMessage(status), status.getCause());
     this.status = status;
     this.trailers = trailers;
   }
diff --git a/api/src/test/java/io/grpc/StatusExceptionTest.java b/api/src/test/java/io/grpc/StatusExceptionTest.java
@@ -28,14 +28,6 @@
 @RunWith(JUnit4.class)
 public class StatusExceptionTest {
 
-  @Test
-  public void internalCtorRemovesStack() {
-    StackTraceElement[] trace =
-        new StatusException(Status.CANCELLED, null, false) {}.getStackTrace();
-
-    assertThat(trace).isEmpty();
-  }
-
   @Test
   public void normalCtorKeepsStack() {
     StackTraceElement[] trace =
diff --git a/api/src/test/java/io/grpc/StatusRuntimeExceptionTest.java b/api/src/test/java/io/grpc/StatusRuntimeExceptionTest.java
@@ -31,7 +31,7 @@ public class StatusRuntimeExceptionTest {
   @Test
   public void internalCtorRemovesStack() {
     StackTraceElement[] trace =
-        new StatusRuntimeException(Status.CANCELLED, null, false) {}.getStackTrace();
+        new InternalStatusRuntimeException(Status.CANCELLED, null) {}.getStackTrace();
 
     assertThat(trace).isEmpty();
   }
diff --git a/core/src/main/java/io/grpc/internal/ServerCallImpl.java b/core/src/main/java/io/grpc/internal/ServerCallImpl.java
@@ -373,10 +373,10 @@ private void closedInternal(Status status) {
         } else {
           call.cancelled = true;
           listener.onCancel();
-          // The status will not have a cause in all failure scenarios but we want to make sure
+          // The status will not have a cause in all failure scenarios, but we want to make sure
           // we always cancel the context with one to keep the context cancelled state consistent.
           cancelCause = InternalStatus.asRuntimeException(
-              Status.CANCELLED.withDescription("RPC cancelled"), null, false);
+              Status.CANCELLED.withDescription("RPC cancelled"), null);
         }
       } finally {
         // Cancel context after delivering RPC closure notification to allow the application to
diff --git a/core/src/main/java/io/grpc/internal/ServerImpl.java b/core/src/main/java/io/grpc/internal/ServerImpl.java
@@ -888,7 +888,7 @@ private void closedInternal(final Status status) {
         Throwable cancelCause = status.getCause();
         if (cancelCause == null) {
           cancelCause = InternalStatus.asRuntimeException(
-              Status.CANCELLED.withDescription("RPC cancelled"), null, false);
+              Status.CANCELLED.withDescription("RPC cancelled"), null);
         }
 
         // The callExecutor might be busy doing user work. To avoid waiting, use an executor that

Original file line number	Diff line number	Diff line change
`@@ -54,13 +54,11 @@ dependencies {`
`54`	`54`	`extension = "signature"`
`55`	`55`	`}`
`56`	`56`	`}`
`57`		`- // TODO: Temporarily disabled until StatusException is fixed.`
`58`		`- // Context: https://github.com/grpc/grpc-java/pull/11066`
`59`		`- //signature (libraries.signature.android) {`
`60`		`- // artifact {`
`61`		`- // extension = "signature"`
`62`		`- // }`
`63`		`- //}`
	`57`	`+ signature (libraries.signature.android) {`
	`58`	`+ artifact {`
	`59`	`+ extension = "signature"`
	`60`	`+ }`
	`61`	`+ }`
`64`	`62`	`}`
`65`	`63`
`66`	`64`	`tasks.named("javadoc").configure {`
Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,8 @@ private InternalStatus() {}`
`42`	`42`	`* of the stack trace.`
`43`	`43`	`*/`
`44`	`44`	`@Internal`
`45`		`- public static final StatusRuntimeException asRuntimeException(Status status,`
`46`		`- @Nullable Metadata trailers, boolean fillInStackTrace) {`
`47`		`- return new StatusRuntimeException(status, trailers, fillInStackTrace);`
	`45`	`+ public static StatusRuntimeException asRuntimeException(Status status,`
	`46`	`+ @Nullable Metadata trailers) {`
	`47`	`+ return new InternalStatusRuntimeException(status, trailers);`
`48`	`48`	`}`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public class StatusRuntimeExceptionTest {`
`31`	`31`	`@Test`
`32`	`32`	`public void internalCtorRemovesStack() {`
`33`	`33`	`StackTraceElement[] trace =`
`34`		`- new StatusRuntimeException(Status.CANCELLED, null, false) {}.getStackTrace();`
	`34`	`+ new InternalStatusRuntimeException(Status.CANCELLED, null) {}.getStackTrace();`
`35`	`35`
`36`	`36`	`assertThat(trace).isEmpty();`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -888,7 +888,7 @@ private void closedInternal(final Status status) {`
`888`	`888`	`Throwable cancelCause = status.getCause();`
`889`	`889`	`if (cancelCause == null) {`
`890`	`890`	`cancelCause = InternalStatus.asRuntimeException(`
`891`		`- Status.CANCELLED.withDescription("RPC cancelled"), null, false);`
	`891`	`+ Status.CANCELLED.withDescription("RPC cancelled"), null);`
`892`	`892`	`}`
`893`	`893`
`894`	`894`	`// The callExecutor might be busy doing user work. To avoid waiting, use an executor that`