feat: add a new specific exception about json data has unknown field (#…

…1792) * feat: add a new specific exception about json data has unknown field * . * . * .
googleapis · Sep 22, 2022 · 18f93c1 · 18f93c1
1 parent 3eb1475
commit 18f93c1
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/...-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1/Exceptions.java b/...-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1/Exceptions.java
@@ -342,6 +342,23 @@ protected InflightBytesLimitExceededException(String writerId, long currentLimit
           currentLimit);
     }
   }
+  /**
+   * Input Json data has unknown field to the schema of the JsonStreamWriter. User can either turn
+   * on IgnoreUnknownFields option on the JsonStreamWriter, or if they don't want the error to be
+   * ignored, they should recreate the JsonStreamWriter with the updated table schema.
+   */
+  public static final class JsonDataHasUnknownFieldException extends IllegalArgumentException {
+    private final String jsonFieldName;
+
+    protected JsonDataHasUnknownFieldException(String jsonFieldName) {
+      super(String.format("JSONObject has fields unknown to BigQuery: %s.", jsonFieldName));
+      this.jsonFieldName = jsonFieldName;
+    }
+
+    public String getFieldName() {
+      return jsonFieldName;
+    }
+  }
 
   private Exceptions() {}
 }
diff --git a/...igquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1/JsonToProtoMessage.java b/...igquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1/JsonToProtoMessage.java
@@ -201,8 +201,7 @@ private static DynamicMessage convertJsonToProtoMessageImpl(
       String currentScope = jsonScope + "." + jsonName;
       FieldDescriptor field = protoSchema.findFieldByName(jsonLowercaseName);
       if (field == null && !ignoreUnknownFields) {
-        throw new IllegalArgumentException(
-            String.format("JSONObject has fields unknown to BigQuery: %s.", currentScope));
+        throw new Exceptions.JsonDataHasUnknownFieldException(currentScope);
       } else if (field == null) {
         continue;
       }

diff --git a/...erystorage/src/test/java/com/google/cloud/bigquery/storage/v1/JsonToProtoMessageTest.java b/...erystorage/src/test/java/com/google/cloud/bigquery/storage/v1/JsonToProtoMessageTest.java
@@ -1122,8 +1122,9 @@ public void testAllowUnknownFieldsError() throws Exception {
       DynamicMessage protoMsg =
           JsonToProtoMessage.convertJsonToProtoMessage(RepeatedInt64.getDescriptor(), json);
       Assert.fail("Should fail");
-    } catch (IllegalArgumentException e) {
+    } catch (Exceptions.JsonDataHasUnknownFieldException e) {
       assertEquals("JSONObject has fields unknown to BigQuery: root.string.", e.getMessage());
+      assertEquals("root.string", e.getFieldName());
     }
   }