Include gRPC error details in Java stack traces

java/checkstyle.xml

@@ -9,31 +9,25 @@
     <property name="fileExtensions" value="java, properties, xml"/>
 
     <!-- Excludes all 'module-info.java' files              -->
-    <!-- See https://checkstyle.org/config_filefilters.html -->
+    <!-- See https://checkstyle.org/filefilters/ -->
     <module name="BeforeExecutionExclusionFileFilter">
         <property name="fileNamePattern" value="module\-info\.java$"/>
     </module>
 
-    <!-- Only public (API, SPI) classes must have Javadoc -->
-<!--    <module name="SuppressionSingleFilter">-->
-<!--        <property name="checks" value=".*Javadoc.*"/>-->
-<!--        <property name="files" value="src/main/java/org/hyperledger/fabric/client/impl"/>-->
-<!--    </module>-->
-
     <!-- Checks that a package-info.java file exists for each package.     -->
-    <!-- See https://checkstyle.org/config_javadoc.html#JavadocPackage -->
+    <!-- See https://checkstyle.org/checks/javadoc/javadocpackage.html -->
     <module name="JavadocPackage"/>
 
     <!-- Checks whether files end with a new line.                        -->
-    <!-- See https://checkstyle.org/config_misc.html#NewlineAtEndOfFile -->
+    <!-- See https://checkstyle.org/checks/misc/newlineatendoffile.html -->
     <module name="NewlineAtEndOfFile"/>
 
     <!-- Checks that property files contain the same keys.         -->
-    <!-- See https://checkstyle.org/config_misc.html#Translation -->
+    <!-- See https://checkstyle.org/checks/misc/translation.html -->
     <module name="Translation"/>
 
     <!-- Checks for Size Violations.                    -->
-    <!-- See https://checkstyle.org/config_sizes.html -->
+    <!-- See https://checkstyle.org/checks/sizes/ -->
     <module name="FileLength"/>
     <module name="LineLength">
         <property name="fileExtensions" value="java"/>
@@ -42,11 +36,11 @@
     </module>
 
     <!-- Checks for whitespace                               -->
-    <!-- See https://checkstyle.org/config_whitespace.html -->
+    <!-- See https://checkstyle.org/checks/whitespace/ -->
     <module name="FileTabCharacter"/>
 
     <!-- Miscellaneous other checks.                   -->
-    <!-- See https://checkstyle.org/config_misc.html -->
+    <!-- See https://checkstyle.org/checks/misc/ -->
     <module name="RegexpSingleline">
         <property name="format" value="\s+$"/>
         <property name="minimum" value="0"/>
@@ -55,7 +49,7 @@
     </module>
 
     <!-- Checks for Headers                                -->
-    <!-- See https://checkstyle.org/config_header.html   -->
+    <!-- See https://checkstyle.org/checks/header/   -->
     <module name="RegexpHeader">
         <property name="headerFile" value="java-copyright-header.txt"/>
         <property name="fileExtensions" value="java"/>
@@ -77,7 +71,7 @@
         </module>
 
         <!-- Checks for Javadoc comments.                     -->
-        <!-- See https://checkstyle.org/config_javadoc.html -->
+        <!-- See https://checkstyle.org/checks/javadoc/ -->
         <module name="InvalidJavadocPosition"/>
         <module name="JavadocContentLocation"/>
         <module name="JavadocMethod"/>
@@ -95,7 +89,7 @@
         <module name="NonEmptyAtclauseDescription"/>
 
         <!-- Checks for Naming Conventions.                  -->
-        <!-- See https://checkstyle.org/config_naming.html -->
+        <!-- See https://checkstyle.org/checks/naming/ -->
         <module name="ConstantName"/>
         <module name="LocalFinalVariableName"/>
         <module name="LocalVariableName"/>
@@ -107,7 +101,7 @@
         <module name="TypeName"/>
 
         <!-- Checks for imports                              -->
-        <!-- See https://checkstyle.org/config_import.html -->
+        <!-- See https://checkstyle.org/checks/imports/ -->
         <module name="AvoidStarImport"/>
         <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
         <module name="RedundantImport"/>
@@ -116,12 +110,12 @@
         </module>
 
         <!-- Checks for Size Violations.                    -->
-        <!-- See https://checkstyle.org/config_sizes.html -->
+        <!-- See https://checkstyle.org/checks/sizes/ -->
         <module name="MethodLength"/>
         <module name="ParameterNumber"/>
 
         <!-- Checks for whitespace                               -->
-        <!-- See https://checkstyle.org/config_whitespace.html -->
+        <!-- See https://checkstyle.org/checks/whitespace/ -->
         <module name="EmptyLineSeparator">
             <property name="allowNoEmptyLineBetweenFields" value="true"/>
             <property name="allowMultipleEmptyLines" value="false"/>
@@ -139,20 +133,20 @@
         <module name="WhitespaceAround"/>
 
         <!-- Modifier Checks                                    -->
-        <!-- See https://checkstyle.org/config_modifiers.html -->
+        <!-- See https://checkstyle.org/checks/modifier/ -->
         <module name="ModifierOrder"/>
         <module name="RedundantModifier"/>
 
         <!-- Checks for blocks. You know, those {}'s         -->
-        <!-- See https://checkstyle.org/config_blocks.html -->
+        <!-- See https://checkstyle.org/checks/blocks/ -->
         <module name="AvoidNestedBlocks"/>
         <module name="EmptyBlock"/>
         <module name="LeftCurly"/>
         <module name="NeedBraces"/>
         <module name="RightCurly"/>
 
         <!-- Checks for common coding problems               -->
-        <!-- See https://checkstyle.org/config_coding.html -->
+        <!-- See https://checkstyle.org/checks/coding/ -->
         <module name="EmptyStatement"/>
         <module name="EqualsHashCode"/>
         <module name="IllegalInstantiation"/>
@@ -171,21 +165,21 @@
         <module name="UnusedLocalVariable"/>
 
         <!-- Checks for class design                         -->
-        <!-- See https://checkstyle.org/config_design.html -->
+        <!-- See https://checkstyle.org/checks/design/ -->
         <module name="DesignForExtension"/>
         <module name="FinalClass"/>
         <module name="HideUtilityClassConstructor"/>
         <module name="InterfaceIsType"/>
         <module name="VisibilityModifier"/>
 
         <!-- Checks for metrics                            -->
-        <!-- See https://checkstyle.org/config_metrics.html -->
+        <!-- See https://checkstyle.org/checks/metrics/ -->
         <module name="CyclomaticComplexity">
             <property name="max" value="10"/>
         </module>
 
         <!-- Miscellaneous other checks.                   -->
-        <!-- See https://checkstyle.org/config_misc.html -->
+        <!-- See https://checkstyle.org/checks/misc/ -->
         <module name="ArrayTypeStyle"/>
         <module name="FinalParameters"/>
         <module name="Indentation"/>

java/pom.xml

@@ -361,7 +361,7 @@
                             <dependency>
                                 <groupId>com.puppycrawl.tools</groupId>
                                 <artifactId>checkstyle</artifactId>
-                                <version>10.12.2</version>
+                                <version>10.12.3</version>
                             </dependency>
                         </dependencies>
                     </plugin>

java/src/main/java/org/hyperledger/fabric/client/GatewayException.java

@@ -6,11 +6,14 @@
 
 package org.hyperledger.fabric.client;
 
-import java.util.List;
-
 import io.grpc.StatusRuntimeException;
 import org.hyperledger.fabric.protos.gateway.ErrorDetail;
 
+import java.io.CharArrayWriter;
+import java.io.PrintStream;
+import java.io.PrintWriter;
+import java.util.List;
+
 /**
  * Thrown if an error is encountered while invoking gRPC services on a gateway peer. Since the gateway delegates much
  * of the processing to other nodes (endorsing peers and orderers), then the error could have originated from one or
@@ -45,4 +48,49 @@ public io.grpc.Status getStatus() {
     public List<ErrorDetail> getDetails() {
         return grpcStatus.getDetails();
     }
+
+    /**
+     * {@inheritDoc}
+     * This implementation appends any gRPC error details to the stack trace.
+     */
+    @Override
+    public void printStackTrace() {
+        printStackTrace(System.err);
+    }
+
+    /**
+     * {@inheritDoc}
+     * This implementation appends any gRPC error details to the stack trace.
+     */
+    @Override
+    public void printStackTrace(final PrintStream out) {
+        printStackTrace(new PrintWriter(out));
+    }
+
+    /**
+     * {@inheritDoc}
+     * This implementation appends any gRPC error details to the stack trace.
+     */
+    @Override
+    public void printStackTrace(final PrintWriter out) {
+        CharArrayWriter message = new CharArrayWriter();
+
+        try (PrintWriter printer = new PrintWriter(message)) {
+            super.printStackTrace(printer);
+            printer.flush();
+        }
+
+        List<ErrorDetail> details = getDetails();
+        if (!details.isEmpty()) {
+            message.append("Error details:\n");
+            for (ErrorDetail detail : details) {
+                message.append("    address: ").append(detail.getAddress())
+                        .append("; mspId: ").append(detail.getMspId())
+                        .append("; message: ").append(detail.getMessage())
+                        .append('\n');
+            }
+        }
+
+        out.print(message);
+    }
 }

java/src/main/java/org/hyperledger/fabric/client/GrpcStatus.java

@@ -31,7 +31,6 @@ public List<ErrorDetail> getDetails() {
         return StatusProto.fromStatusAndTrailers(status, trailers)
                 .getDetailsList()
                 .stream()
-                .filter(any -> any.is(ErrorDetail.class))
                 .map(any -> {
                     try {
                         return any.unpack(ErrorDetail.class);

java/src/test/java/org/hyperledger/fabric/client/GatewayExceptionTest.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright IBM Corp. All Rights Reserved.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.hyperledger.fabric.client;
+
+import com.google.protobuf.Any;
+import com.google.rpc.Code;
+import io.grpc.StatusRuntimeException;
+import io.grpc.protobuf.StatusProto;
+import org.hyperledger.fabric.protos.gateway.ErrorDetail;
+import org.junit.jupiter.api.Test;
+
+import java.io.CharArrayWriter;
+import java.io.PrintWriter;
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public final class GatewayExceptionTest {
+    @Test
+    void error_details_are_printed() {
+        List<ErrorDetail> details = Arrays.asList(
+                ErrorDetail.newBuilder().setAddress("ADDRESS1").setMspId("MSPID1").setMessage("MESSAGE1").build(),
+                ErrorDetail.newBuilder().setAddress("ADDRESS2").setMspId("MSPID2").setMessage("MESSAGE2").build()
+        );
+        GatewayException e = new GatewayException(newStatusRuntimeException(Code.ABORTED, "STATUS_MESSAGE", details));
+
+        CharArrayWriter actual = new CharArrayWriter();
+        try (PrintWriter out = new PrintWriter(actual)) {
+            e.printStackTrace(out);
+            out.flush();
+        }
+
+        List<String> expected = details.stream()
+                .flatMap(detail -> Stream.of(detail.getAddress(), detail.getMspId(), detail.getMessage()))
+                .collect(Collectors.toList());
+        assertThat(actual.toString()).contains(expected);
+    }
+
+    private StatusRuntimeException newStatusRuntimeException(Code code, String message, List<ErrorDetail> details) {
+        List<Any> anyDetails = details.stream()
+                .map(Any::pack)
+                .collect(Collectors.toList());
+        com.google.rpc.Status status = com.google.rpc.Status.newBuilder()
+                .setCode(code.getNumber())
+                .setMessage(message)
+                .addAllDetails(anyDetails)
+                .build();
+        return StatusProto.toStatusRuntimeException(status);
+    }
+}