feat: support unrecognized types

Author: olavloite

google-cloud-spanner/src/main/java/com/google/cloud/ByteArrayHelper.java

@@ -26,7 +26,6 @@
 import com.google.api.client.util.ExponentialBackOff;
 import com.google.api.gax.retrying.RetrySettings;
 import com.google.cloud.ByteArray;
-import com.google.cloud.ByteArrayHelper;
 import com.google.cloud.Date;
 import com.google.cloud.Timestamp;
 import com.google.cloud.spanner.Type.StructField;
@@ -39,6 +38,7 @@
 import com.google.common.util.concurrent.Uninterruptibles;
 import com.google.protobuf.ByteString;
 import com.google.protobuf.ListValue;
+import com.google.protobuf.NullValue;
 import com.google.protobuf.Value.KindCase;
 import com.google.spanner.v1.PartialResultSet;
 import com.google.spanner.v1.ResultSetMetadata;
@@ -74,6 +74,8 @@
 /** Implementation of {@link ResultSet}. */
 abstract class AbstractResultSet<R> extends AbstractStructReader implements ResultSet {
   private static final Tracer tracer = Tracing.getTracer();
+  private static final com.google.protobuf.Value NULL_VALUE =
+      com.google.protobuf.Value.newBuilder().setNullValue(NullValue.NULL_VALUE).build();
 
   interface Listener {
     /**
@@ -362,7 +364,7 @@ static class LazyByteArray implements Serializable {
         new AbstractLazyInitializer<ByteArray>() {
           @Override
           protected ByteArray initialize() {
-            return ByteArrayHelper.wrap(DECODER.decode(base64String));
+            return ByteArray.copyFrom(DECODER.decode(base64String));
           }
         };
 
@@ -566,6 +568,8 @@ private static Object decodeValue(Type fieldType, com.google.protobuf.Value prot
           checkType(fieldType, proto, KindCase.LIST_VALUE);
           ListValue structValue = proto.getListValue();
           return decodeStructValue(fieldType, structValue);
+        case UNRECOGNIZED:
+          return proto;
         default:
           throw new AssertionError("Unhandled type code: " + fieldType.getCode());
       }
@@ -675,7 +679,11 @@ protected String getPgJsonbInternal(int columnIndex) {
 
     @Override
     protected ByteArray getBytesInternal(int columnIndex) {
-      return ((LazyByteArray) rowData.get(columnIndex)).getByteArray();
+      return getLazyBytesInternal(columnIndex).getByteArray();
+    }
+
+    LazyByteArray getLazyBytesInternal(int columnIndex) {
+      return (LazyByteArray) rowData.get(columnIndex);
     }
 
     @Override
@@ -712,13 +720,16 @@ protected Value getValueInternal(int columnIndex) {
         case PG_JSONB:
           return Value.pgJsonb(isNull ? null : getPgJsonbInternal(columnIndex));
         case BYTES:
-          return Value.bytes(isNull ? null : getBytesInternal(columnIndex));
+          return Value.lazyBytes(isNull ? null : getLazyBytesInternal(columnIndex));
         case TIMESTAMP:
           return Value.timestamp(isNull ? null : getTimestampInternal(columnIndex));
         case DATE:
           return Value.date(isNull ? null : getDateInternal(columnIndex));
         case STRUCT:
           return Value.struct(isNull ? null : getStructInternal(columnIndex));
+        case UNRECOGNIZED:
+          return Value.untyped(
+              isNull ? NULL_VALUE : (com.google.protobuf.Value) rowData.get(columnIndex));
         case ARRAY:
           final Type elementType = columnType.getArrayElementType();
           switch (elementType.getCode()) {

google-cloud-spanner/src/main/java/com/google/cloud/spanner/AbstractResultSet.java

@@ -170,20 +170,17 @@ public BigDecimal getBigDecimal(String columnName) {
   public String getString(int columnIndex) {
     checkNonNullOfTypes(
         columnIndex,
-        Arrays.asList(Type.string(), Type.pgNumeric(), Type.bytes()),
+        Arrays.asList(Type.string(), Type.pgNumeric()),
         columnIndex,
-        "STRING, NUMERIC, BYTES");
+        "STRING, NUMERIC");
     return getStringInternal(columnIndex);
   }
 
   @Override
   public String getString(String columnName) {
     int columnIndex = getColumnIndex(columnName);
     checkNonNullOfTypes(
-        columnIndex,
-        Arrays.asList(Type.string(), Type.pgNumeric(), Type.bytes()),
-        columnName,
-        "STRING, NUMERIC, BYTES");
+        columnIndex, Arrays.asList(Type.string(), Type.pgNumeric()), columnName, "STRING, NUMERIC");
     return getStringInternal(columnIndex);
   }
 
@@ -254,7 +251,6 @@ public Date getDate(String columnName) {
 
   @Override
   public Value getValue(int columnIndex) {
-    checkNonNull(columnIndex, columnIndex);
     return getValueInternal(columnIndex);
   }
 

google-cloud-spanner/src/main/java/com/google/cloud/spanner/AbstractStructReader.java

@@ -33,6 +33,7 @@
 import java.util.Map.Entry;
 import java.util.Objects;
 import java.util.TreeMap;
+import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 
@@ -71,6 +72,10 @@ public final class Type implements Serializable {
   private static final int AMBIGUOUS_FIELD = -1;
   private static final long serialVersionUID = -3076152125004114582L;
 
+  static Type unrecognized(com.google.spanner.v1.Type proto) {
+    return new Type(proto);
+  }
+
   /** Returns the descriptor for the {@code BOOL type}. */
   public static Type bool() {
     return TYPE_BOOL;
@@ -190,6 +195,7 @@ public static Type struct(StructField... fields) {
     return new Type(Code.STRUCT, null, ImmutableList.copyOf(fields));
   }
 
+  private final com.google.spanner.v1.Type proto;
   private final Code code;
   private final Type arrayElementType;
   private final ImmutableList<StructField> structFields;
@@ -204,13 +210,23 @@ private Type(
       Code code,
       @Nullable Type arrayElementType,
       @Nullable ImmutableList<StructField> structFields) {
+    this.proto = null;
     this.code = code;
     this.arrayElementType = arrayElementType;
     this.structFields = structFields;
   }
 
+  private Type(@Nonnull com.google.spanner.v1.Type proto) {
+    this.proto = proto;
+    this.code = Code.UNRECOGNIZED;
+    this.arrayElementType =
+        proto.hasArrayElementType() ? new Type(proto.getArrayElementType()) : null;
+    this.structFields = null;
+  }
+
   /** Enumerates the categories of types. */
   public enum Code {
+    UNRECOGNIZED(TypeCode.UNRECOGNIZED),
     BOOL(TypeCode.BOOL),
     INT64(TypeCode.INT64),
     NUMERIC(TypeCode.NUMERIC),
@@ -258,8 +274,7 @@ TypeAnnotationCode getTypeAnnotationCode() {
 
     static Code fromProto(TypeCode typeCode, TypeAnnotationCode typeAnnotationCode) {
       Code code = protoToCode.get(new SimpleEntry<>(typeCode, typeAnnotationCode));
-      checkArgument(code != null, "Invalid code: %s<%s>", typeCode, typeAnnotationCode);
-      return code;
+      return code == null ? Code.UNRECOGNIZED : code;
     }
 
     @Override
@@ -325,7 +340,7 @@ public Code getCode() {
    * @throws IllegalStateException if {@code code() != Code.ARRAY}
    */
   public Type getArrayElementType() {
-    Preconditions.checkState(code == Code.ARRAY, "Illegal call for non-ARRAY type");
+    Preconditions.checkState(arrayElementType != null, "Illegal call for non-ARRAY type");
     return arrayElementType;
   }
 
@@ -378,7 +393,7 @@ public int getFieldIndex(String fieldName) {
   }
 
   void toString(StringBuilder b) {
-    if (code == Code.ARRAY) {
+    if (code == Code.ARRAY || (proto != null && proto.hasArrayElementType())) {
       b.append("ARRAY<");
       arrayElementType.toString(b);
       b.append('>');
@@ -393,6 +408,11 @@ void toString(StringBuilder b) {
         f.getType().toString(b);
       }
       b.append('>');
+    } else if (proto != null) {
+      b.append(proto.getCode().name());
+      if (proto.getTypeAnnotation() != TYPE_ANNOTATION_CODE_UNSPECIFIED) {
+        b.append("<").append(proto.getTypeAnnotation().name()).append(">");
+      }
     } else {
       b.append(code.toString());
     }
@@ -414,17 +434,26 @@ public boolean equals(Object o) {
       return false;
     }
     Type that = (Type) o;
+    if (proto != null) {
+      return Objects.equals(proto, that.proto);
+    }
     return code == that.code
         && Objects.equals(arrayElementType, that.arrayElementType)
         && Objects.equals(structFields, that.structFields);
   }
 
   @Override
   public int hashCode() {
+    if (proto != null) {
+      return proto.hashCode();
+    }
     return Objects.hash(code, arrayElementType, structFields);
   }
 
   com.google.spanner.v1.Type toProto() {
+    if (proto != null) {
+      return proto;
+    }
     com.google.spanner.v1.Type.Builder proto = com.google.spanner.v1.Type.newBuilder();
     proto.setCode(code.getTypeCode());
     proto.setTypeAnnotation(code.getTypeAnnotationCode());
@@ -490,8 +519,9 @@ static Type fromProto(com.google.spanner.v1.Type proto) {
           fields.add(StructField.of(name, fromProto(field.getType())));
         }
         return struct(fields);
+      case UNRECOGNIZED:
       default:
-        throw new AssertionError("Unimplemented case: " + type);
+        return unrecognized(proto);
     }
   }
 }