impl: refactor HttpJsonErrorParser to return google.rpc.Status and rename method to parseStatus

Author: westarle

gax-java/gax-httpjson/src/main/java/com/google/api/gax/httpjson/HttpJsonErrorParser.java

@@ -80,48 +80,44 @@ class HttpJsonErrorParser {
       JsonFormat.parser().ignoringUnknownFields().usingTypeRegistry(STANDARD_ERROR_TYPES);
 
   /**
-   * Parses the given JSON error payload into {@link ErrorDetails}.
+   * Parses the given JSON error payload into {@link Status}.
    *
    * @param errorJson The JSON string representing a Google Cloud error response.
-   * @return An {@link ErrorDetails} object containing the parsed error information. Returns an
-   *     empty {@link ErrorDetails} if the input is null, empty, or invalid.
+   * @return A {@link Status} message containing the parsed error information. Returns {@link
+   *     Status#getDefaultInstance()} if the input is null, empty, or invalid.
    */
-  static ErrorDetails parseErrorDetails(String errorJson) {
+  static Status parseStatus(String errorJson) {
     if (errorJson == null || errorJson.isEmpty()) {
-      return ErrorDetails.builder().build();
+      return Status.getDefaultInstance();
     }
 
     JsonElement jsonElement;
     try {
       jsonElement = JsonParser.parseString(errorJson);
     } catch (JsonSyntaxException e) {
-      return ErrorDetails.builder().build();
+      return Status.getDefaultInstance();
     }
 
     if (!jsonElement.isJsonObject()) {
-      return ErrorDetails.builder().build();
+      return Status.getDefaultInstance();
     }
     JsonObject root = jsonElement.getAsJsonObject();
     if (!root.has("error")) {
-      return ErrorDetails.builder().build();
+      return Status.getDefaultInstance();
     }
 
     JsonElement errorElement = root.get("error");
     if (!errorElement.isJsonObject()) {
-      return ErrorDetails.builder().build();
+      return Status.getDefaultInstance();
     }
 
     Status.Builder statusBuilder = Status.newBuilder();
     try {
       JSON_PARSER.merge(errorElement.toString(), statusBuilder);
     } catch (InvalidProtocolBufferException e) {
-      // Return empty details on parsing failure
-      return ErrorDetails.builder().build();
+      return Status.getDefaultInstance();
     }
 
-    Status status = statusBuilder.build();
-    ErrorDetails.Builder errorDetailsBuilder = ErrorDetails.builder();
-    errorDetailsBuilder.setRawErrorMessages(status.getDetailsList());
-    return errorDetailsBuilder.build();
+    return statusBuilder.build();
   }
 }

gax-java/gax-httpjson/src/test/java/com/google/api/gax/httpjson/HttpJsonErrorParserTest.java

@@ -39,10 +39,13 @@
 class HttpJsonErrorParserTest {
 
   @Test
-  void parseErrorDetails_success() {
+  void parseStatus_success() {
     String payload =
         "{\n"
             + "  \"error\": {\n"
+            + "    \"code\": 401,\n"
+            + "    \"message\": \"Request is missing required authentication credential.\",\n"
+            + "    \"status\": \"UNAUTHENTICATED\",\n"
             + "    \"details\": [\n"
             + "      {\n"
             + "        \"@type\": \"type.googleapis.com/google.rpc.ErrorInfo\",\n"
@@ -56,8 +59,14 @@ void parseErrorDetails_success() {
             + "  }\n"
             + "}";
 
-    ErrorDetails errorDetails = HttpJsonErrorParser.parseErrorDetails(payload);
-    assertThat(errorDetails).isNotNull();
+    com.google.rpc.Status status = HttpJsonErrorParser.parseStatus(payload);
+    assertThat(status).isNotNull();
+    assertThat(status.getCode()).isEqualTo(401);
+    assertThat(status.getMessage())
+        .isEqualTo("Request is missing required authentication credential.");
+
+    ErrorDetails errorDetails =
+        ErrorDetails.builder().setRawErrorMessages(status.getDetailsList()).build();
     ErrorInfo errorInfo = errorDetails.getErrorInfo();
     assertThat(errorInfo).isNotNull();
     assertThat(errorInfo.getReason()).isEqualTo("SERVICE_DISABLED");
@@ -66,7 +75,7 @@ void parseErrorDetails_success() {
   }
 
   @Test
-  void parseErrorDetails_noErrorInfo() {
+  void parseStatus_noErrorInfo() {
     String payload =
         "{\n"
             + "  \"error\": {\n"
@@ -78,43 +87,50 @@ void parseErrorDetails_noErrorInfo() {
             + "  }\n"
             + "}";
 
-    ErrorDetails errorDetails = HttpJsonErrorParser.parseErrorDetails(payload);
-    assertThat(errorDetails).isNotNull();
+    com.google.rpc.Status status = HttpJsonErrorParser.parseStatus(payload);
+    assertThat(status).isNotNull();
+    ErrorDetails errorDetails =
+        ErrorDetails.builder().setRawErrorMessages(status.getDetailsList()).build();
     assertThat(errorDetails.getRetryInfo()).isNotNull();
   }
 
   @Test
-  void parseErrorDetails_emptyPayload() {
-    assertThat(HttpJsonErrorParser.parseErrorDetails("").getErrorInfo()).isNull();
-    assertThat(HttpJsonErrorParser.parseErrorDetails(null).getErrorInfo()).isNull();
+  void parseStatus_emptyPayload() {
+    assertThat(HttpJsonErrorParser.parseStatus("")).isEqualTo(com.google.rpc.Status.getDefaultInstance());
+    assertThat(HttpJsonErrorParser.parseStatus(null)).isEqualTo(com.google.rpc.Status.getDefaultInstance());
   }
 
   @Test
-  void parseErrorDetails_invalidJson() {
-    assertThat(HttpJsonErrorParser.parseErrorDetails("{invalid").getErrorInfo()).isNull();
+  void parseStatus_invalidJson() {
+    assertThat(HttpJsonErrorParser.parseStatus("{invalid"))
+        .isEqualTo(com.google.rpc.Status.getDefaultInstance());
   }
 
   @Test
-  void parseErrorDetails_noErrorObject() {
+  void parseStatus_noErrorObject() {
     String payload = "{\"foo\": \"bar\"}";
-    assertThat(HttpJsonErrorParser.parseErrorDetails(payload).getErrorInfo()).isNull();
+    assertThat(HttpJsonErrorParser.parseStatus(payload))
+        .isEqualTo(com.google.rpc.Status.getDefaultInstance());
   }
 
   @Test
-  void parseErrorDetails_noDetails() {
+  void parseStatus_noDetails() {
     String payload = "{\"error\": {}}";
-    assertThat(HttpJsonErrorParser.parseErrorDetails(payload).getErrorInfo()).isNull();
+    assertThat(HttpJsonErrorParser.parseStatus(payload))
+        .isEqualTo(com.google.rpc.Status.getDefaultInstance());
   }
 
   @Test
-  void parseErrorDetails_garbageInError() {
+  void parseStatus_garbageInError() {
     String payload = "{\"error\": \"not-an-object\"}";
-    assertThat(HttpJsonErrorParser.parseErrorDetails(payload).getErrorInfo()).isNull();
+    assertThat(HttpJsonErrorParser.parseStatus(payload))
+        .isEqualTo(com.google.rpc.Status.getDefaultInstance());
   }
 
   @Test
-  void parseErrorDetails_arrayInError() {
+  void parseStatus_arrayInError() {
     String payload = "{\"error\": []}";
-    assertThat(HttpJsonErrorParser.parseErrorDetails(payload).getErrorInfo()).isNull();
+    assertThat(HttpJsonErrorParser.parseStatus(payload))
+        .isEqualTo(com.google.rpc.Status.getDefaultInstance());
   }
 }