feat(spanner): support for type UUID

Author: alkatrivedi

src/codec.ts

@@ -21,6 +21,7 @@ import * as is from 'is';
 import {common as p} from 'protobufjs';
 import {google as spannerClient} from '../protos/protos';
 import {GoogleError} from 'google-gax';
+import * as uuid from 'uuid';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type Value = any;
@@ -142,20 +143,6 @@ export class SpannerDate extends Date {
   }
 }
 
-/**
- * @typedef UUID
- * @see Spanner.uuid
- */
-export class UUID {
-  value: string;
-  constructor(value: string) {
-    this.value = value;
-  }
-  valueOf(): string {
-    return String(this.value);
-  }
-}
-
 /**
  * Using an abstract class to simplify checking for wrapped numbers.
  *
@@ -543,10 +530,6 @@ function decode(
         enumObject: columnMetadata as object,
       });
       break;
-    case spannerClient.spanner.v1.TypeCode.UUID:
-    case 'UUID':
-      decoded = new UUID(decoded);
-      break;
     case spannerClient.spanner.v1.TypeCode.FLOAT32:
     case 'FLOAT32':
       decoded = new Float32(decoded);
@@ -683,10 +666,6 @@ function encodeValue(value: Value): Value {
     return value.value;
   }
 
-  if (value instanceof UUID) {
-    return value.value;
-  }
-
   if (value instanceof Struct) {
     return Array.from(value).map(field => encodeValue(field.value));
   }
@@ -760,6 +739,7 @@ interface FieldType extends Type {
 /**
  * @typedef {object} ParamType
  * @property {string} type The param type. Must be one of the following:
+ *     - uuid
  *     - float32
  *     - float64
  *     - int64
@@ -797,10 +777,6 @@ function getType(value: Value): Type {
   const isSpecialNumber =
     is.infinite(value) || (is.number(value) && isNaN(value));
 
-  if (value instanceof UUID) {
-    return {type: 'uuid'};
-  }
-
   if (value instanceof Float32) {
     return {type: 'float32'};
   }
@@ -841,6 +817,10 @@ function getType(value: Value): Type {
     return {type: 'bool'};
   }
 
+  if (uuid.validate(value)) {
+    return {type: 'unspecified'};
+  }
+
   if (is.string(value)) {
     return {type: 'string'};
   }
@@ -996,7 +976,6 @@ export const codec = {
   convertProtoTimestampToDate,
   createTypeObject,
   SpannerDate,
-  UUID,
   Float32,
   Float,
   Int,

src/index.ts

@@ -26,7 +26,6 @@ import * as streamEvents from 'stream-events';
 import * as through from 'through2';
 import {
   codec,
-  UUID,
   Float32,
   Float,
   Int,
@@ -1705,23 +1704,6 @@ class Spanner extends GrpcService {
     return new PreciseDate(value as number);
   }
 
-  /**
-   * Helper function to get a Cloud Spanner UUID object.
-   *
-   * @param {string} value The uuid as a string.
-   * @returns {UUID}
-   *
-   * @example
-   * ```
-   * const {Spanner} = require('@google-cloud/spanner');
-   * const value = uuidv4();
-   * const uuid = Spanner.uuid(value);
-   * ```
-   */
-  static uuid(value): UUID {
-    return new codec.UUID(value);
-  }
-
   /**
    * Helper function to get a Cloud Spanner Float32 object.
    *
@@ -1909,7 +1891,6 @@ class Spanner extends GrpcService {
 promisifyAll(Spanner, {
   exclude: [
     'date',
-    'uuid',
     'float32',
     'float',
     'instance',
@@ -2089,5 +2070,5 @@ import * as protos from '../protos/protos';
 import IInstanceConfig = instanceAdmin.spanner.admin.instance.v1.IInstanceConfig;
 export {v1, protos};
 export default {Spanner};
-export {UUID, Float32, Float, Int, Struct, Numeric, PGNumeric, SpannerDate};
+export {Float32, Float, Int, Struct, Numeric, PGNumeric, SpannerDate};
 export {ObservabilityOptions};

src/transaction.ts

@@ -1521,7 +1521,17 @@ export class Snapshot extends EventEmitter {
     if (!is.empty(typeMap)) {
       Object.keys(typeMap).forEach(param => {
         const type = typeMap[param];
-        paramTypes[param] = codec.createTypeObject(type);
+        const typeObject = codec.createTypeObject(type);
+        if (type.child) {
+          if (
+            typeObject.code === 'ARRAY' &&
+            typeObject.arrayElementType?.code !== 'TYPE_CODE_UNSPECIFIED'
+          ) {
+            paramTypes[param] = codec.createTypeObject(type);
+          }
+        } else if (typeObject.code !== 'TYPE_CODE_UNSPECIFIED') {
+          paramTypes[param] = codec.createTypeObject(type);
+        }
       });
     }