fix query param types bug (#44)

Author: callmehiphop

src/codec.js

@@ -274,3 +274,76 @@ var TYPES = [
 ];
 
 codec.TYPES = TYPES;
+
+/**
+ * Encodes a ExecuteSqlRequest object into the correct format.
+ *
+ * @private
+ *
+ * @param {object} query The query object.
+ * @param {object} [query.params] A map of parameter name to values.
+ * @param {object} [query.types] A map of parameter types.
+ * @returns {object}
+ */
+function encodeQuery(query) {
+  if (query.params) {
+    let fields = {};
+
+    if (!query.types) {
+      query.types = {};
+    }
+
+    for (let prop in query.params) {
+      let field = query.params[prop];
+
+      if (!query.types[prop]) {
+        query.types[prop] = codec.getType(field);
+      }
+
+      fields[prop] = codec.encode(field);
+    }
+
+    query.params = {fields};
+  }
+
+  if (query.types) {
+    let formattedTypes = {};
+
+    for (let prop in query.types) {
+      let type = query.types[prop];
+      let childType;
+      let child;
+
+      // if a type is an ARRAY, then we'll accept an object specifying
+      // the type and the child type
+      if (is.object(type)) {
+        childType = type.child;
+        child = codec.TYPES.indexOf(childType);
+        type = type.type;
+      }
+
+      let code = codec.TYPES.indexOf(type);
+
+      if (code === -1) {
+        code = 0; // unspecified
+      }
+
+      formattedTypes[prop] = {code};
+
+      if (child === -1) {
+        child = 0; // unspecified
+      }
+
+      if (is.number(child)) {
+        formattedTypes[prop].arrayElementType = {code: child};
+      }
+    }
+
+    delete query.types;
+    query.paramTypes = formattedTypes;
+  }
+
+  return query;
+}
+
+codec.encodeQuery = encodeQuery;

src/database.js

@@ -610,6 +610,8 @@ Database.prototype.getTransaction = function(options, callback) {
  * @param {string|object} query A SQL query or query object. See an
  *     [ExecuteSqlRequest](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest)
  *     object.
+ * @param {object} [query.params] A map of parameter name to values.
+ * @param {object} [query.types] A map of parameter types.
  * @param {DatabaseRunRequest} [options] [Transaction options](https://cloud.google.com/spanner/docs/timestamp-bounds).
  * @param {RunCallback} [callback] Callback function.
  * @returns {Promise<RunResponse>}
@@ -737,6 +739,7 @@ Database.prototype.run = function(query, options, callback) {
  *     [ExecuteSqlRequest](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest)
  *     object.
  * @param {object} [query.params] A map of parameter name to values.
+ * @param {object} [query.types] A map of parameter types.
  * @param {DatabaseRunRequest} [options] [Transaction options](https://cloud.google.com/spanner/docs/timestamp-bounds).
  * @returns {ReadableStream} A readable stream that emits rows.
  *
@@ -837,67 +840,7 @@ Database.prototype.runStream = function(query, options) {
     };
   }
 
-  var reqOpts = extend({}, query, {
-    session: this.formattedName_,
-  });
-
-  var fields = {};
-  var prop;
-
-  if (reqOpts.params) {
-    reqOpts.types = reqOpts.types || {};
-
-    for (prop in reqOpts.params) {
-      var field = reqOpts.params[prop];
-
-      if (!reqOpts.types[prop]) {
-        reqOpts.types[prop] = codec.getType(field);
-      }
-
-      fields[prop] = codec.encode(field);
-    }
-
-    reqOpts.params = {
-      fields: fields,
-    };
-  }
-
-  if (reqOpts.types) {
-    var types = {};
-
-    for (prop in reqOpts.types) {
-      var type = reqOpts.types[prop];
-      var childType;
-      var child;
-
-      // if a type is an ARRAY, then we'll accept an object specifying
-      // the type and the child type
-      if (is.object(type)) {
-        childType = type.child;
-        child = codec.TYPES.indexOf(childType);
-        type = type.type;
-      }
-
-      var code = codec.TYPES.indexOf(type);
-
-      if (code === -1) {
-        throw new Error('Unknown param type: ' + type);
-      }
-
-      types[prop] = {code: code};
-
-      if (child === -1) {
-        throw new Error('Unknown param type: ' + childType);
-      }
-
-      if (is.number(child)) {
-        types[prop].arrayElementType = {code: child};
-      }
-    }
-
-    reqOpts.paramTypes = types;
-    delete reqOpts.types;
-  }
+  var reqOpts = codec.encodeQuery(query);
 
   if (options) {
     reqOpts.transaction = {
@@ -911,7 +854,7 @@ Database.prototype.runStream = function(query, options) {
     return self.pool_.requestStream({
       client: 'SpannerClient',
       method: 'executeStreamingSql',
-      reqOpts: extend(reqOpts, {resumeToken: resumeToken}),
+      reqOpts: extend(reqOpts, {resumeToken}),
     });
   }
 

src/transaction.js

@@ -536,6 +536,8 @@ Transaction.prototype.rollback = function(callback) {
  * @param {string|object} query A SQL query or
  *     [`ExecuteSqlRequest`](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest)
  *     object.
+ * @param {object} [query.params] A map of parameter name to values.
+ * @param {object} [query.types] A map of parameter types.
  * @param {RunCallback} [callback] Callback function.
  * @returns {Promise<RunResponse>}
  *
@@ -585,6 +587,30 @@ Transaction.prototype.rollback = function(callback) {
  *
  *   transaction.run(query, function(err, rows) {});
  * });
+ *
+ * //-
+ * // If you need to enforce a specific param type, a types map can be provided.
+ * // This is typically useful if your param value can be null.
+ * //-
+ * database.runTransaction(function(err, transaction) {
+ *   if (err) {
+ *     // Error handling omitted.
+ *   }
+ *
+ *   const query = {
+ *     sql: 'SELECT * FROM Singers WHERE name = @name AND id = @id',
+ *     params: {
+ *       id: spanner.int(8),
+ *       name: null
+ *     },
+ *     types: {
+ *       id: 'int64',
+ *       name: 'string'
+ *     }
+ *   };
+ *
+ *   transaction.run(query, function(err, rows) {});
+ * });
  */
 Transaction.prototype.run = function(query, callback) {
   var rows = [];
@@ -612,6 +638,8 @@ Transaction.prototype.run = function(query, callback) {
  * @param {string|object} query - A SQL query or
  *     [`ExecuteSqlRequest`](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest)
  *     object.
+ * @param {object} [query.params] A map of parameter name to values.
+ * @param {object} [query.types] A map of parameter types.
  * @returns {ReadableStream}
  *
  * @example
@@ -691,65 +719,10 @@ Transaction.prototype.runStream = function(query) {
   var reqOpts = extend(
     {
       transaction: {},
-      session: this.formattedName_,
     },
-    query
+    codec.encodeQuery(query)
   );
 
-  var fields = {};
-  var prop;
-
-  if (reqOpts.params) {
-    reqOpts.types = reqOpts.types || {};
-
-    for (prop in reqOpts.params) {
-      var field = reqOpts.params[prop];
-
-      if (!reqOpts.types[prop]) {
-        reqOpts.types[prop] = codec.getType(field);
-      }
-
-      fields[prop] = codec.encode(field);
-    }
-
-    reqOpts.params = {
-      fields: fields,
-    };
-  }
-
-  if (reqOpts.types) {
-    var types = {};
-
-    for (prop in reqOpts.types) {
-      var type = reqOpts.types[prop];
-      var child;
-
-      if (is.object(type)) {
-        child = codec.TYPES.indexOf(type.child);
-        type = type.type;
-      }
-
-      var code = codec.TYPES.indexOf(type);
-
-      if (code === -1) {
-        code = 0; // unspecified
-      }
-
-      types[prop] = {code: code};
-
-      if (child === -1) {
-        child = 0; // unspecified
-      }
-
-      if (is.number(child)) {
-        types[prop].arrayElementType = {code: child};
-      }
-    }
-
-    reqOpts.paramTypes = types;
-    delete reqOpts.types;
-  }
-
   if (this.id) {
     reqOpts.transaction.id = this.id;
   } else {