support custom API host and port configuration. fixes #389

Author: stephenplusplus

lib/common/util.js

@@ -380,6 +380,14 @@ function makeAuthorizedRequest(config) {
 
   var authorize = gsa(config);
 
+  if (config.customApi) {
+    // Using a custom API override. Do not use `google-service-account` for
+    // authentication. (ex: connecting to a local Datastore server)
+    authorize = function(reqOpts, callback) {
+      callback(null, reqOpts);
+    };
+  }
+
   function makeRequest(reqOpts, callback) {
     var tokenRefreshAttempts = 0;
     reqOpts.headers = reqOpts.headers || {};

lib/datastore/dataset.js

@@ -78,6 +78,10 @@ var SCOPES = [
  *     `credentials` object.
  * @param {object=} options.credentials - Credentials object, used in place of
  *     a `keyFilename`.
+ * @param {string=} options.host - Override the default API endpoint used to
+ *     reach the Datastore. This is useful for connecting to your local
+ *     Datastore server.
+ * @param {number=} options.port - Useful with `options.host` to set the port.
  * @param {string} options.namespace - Namespace to isolate transactions to.
  *
  * @example
@@ -93,12 +97,22 @@ function Dataset(options) {
 
   options = options || {};
 
+  if (options.host && options.host.indexOf('http') !== 0) {
+    throw new Error('A protocol must be included when specifying a host.');
+  }
+
   this.makeAuthorizedRequest_ = util.makeAuthorizedRequest({
+    customApi: typeof options.host !== 'undefined',
     credentials: options.credentials,
     keyFile: options.keyFilename,
     scopes: SCOPES
   });
 
+  this.api = {
+    host: options.host || 'https://www.googleapis.com',
+    port: util.is(options.port, 'number') ? options.port : 443
+  };
+
   this.namespace = options.namespace;
   this.projectId = options.projectId;
 }

lib/datastore/request.js

@@ -20,8 +20,8 @@
 
 'use strict';
 
-var https = require('https');
 var streamEvents = require('stream-events');
+var request = require('request');
 var through = require('through2');
 
 /**
@@ -42,12 +42,6 @@ var pb = require('./pb.js');
  */
 var util = require('../common/util.js');
 
-/**
- * @const {string} Host to send with API requests.
- * @private
- */
-var GOOGLE_APIS_HOST = 'www.googleapis.com';
-
 /**
  * @const {string} Non-transaction mode key.
  * @private
@@ -595,8 +589,13 @@ DatastoreRequest.prototype.makeReq_ = function(method, body, callback) {
 
   var reqOpts = {
     method: 'POST',
-    host: GOOGLE_APIS_HOST,
-    path: '/datastore/v1beta2/datasets/' + this.projectId + '/' + method,
+    uri: util.format('{host}:{port}/{path}/{projectId}/{method}', {
+      host: this.api.host,
+      port: this.api.port,
+      path: 'datastore/v1beta2/datasets',
+      projectId: this.projectId,
+      method: method
+    }),
     headers: {
       'Content-Type': 'application/x-protobuf'
     }
@@ -609,7 +608,14 @@ DatastoreRequest.prototype.makeReq_ = function(method, body, callback) {
         return;
       }
 
-      var remoteStream = https.request(authorizedReqOpts, function(resp) {
+      authorizedReqOpts.headers = authorizedReqOpts.headers || {};
+      authorizedReqOpts.headers['Content-Length'] = pbRequest.length;
+
+      var apiRequest = request(authorizedReqOpts);
+
+      apiRequest.on('error', callback);
+
+      apiRequest.on('response', function(resp) {
         var buffer = new Buffer('');
         resp.on('data', function(chunk) {
           buffer = Buffer.concat([buffer, chunk]);
@@ -624,9 +630,8 @@ DatastoreRequest.prototype.makeReq_ = function(method, body, callback) {
           });
         });
       });
-      remoteStream.on('error', callback);
-      remoteStream.write(pbRequest);
-      remoteStream.end();
+
+      apiRequest.end(pbRequest);
     }
   });
 };

lib/datastore/transaction.js

@@ -61,6 +61,7 @@ var extend = require('extend');
  */
 function Transaction(dataset, projectId) {
   this.id = null;
+  this.api = dataset.api;
   this.makeAuthorizedRequest_ = dataset.makeAuthorizedRequest_;
   this.projectId = projectId;
 

test/common/util.js

@@ -299,8 +299,25 @@ describe('common/util', function() {
       util.makeAuthorizedRequest(config);
     });
 
+    it('should not authenticate requests with a custom API', function(done) {
+      var makeRequest = util.makeAuthorizedRequest({ customApi: true });
+
+      var gsaCalled = false;
+      gsa_Override = function() {
+        gsaCalled = true;
+      };
+
+      makeRequest({}, {
+        onAuthorized: function(err) {
+          assert.ifError(err);
+          assert.strictEqual(gsaCalled, false);
+          done();
+        }
+      });
+    });
+
     it('should return gsa.getCredentials function', function() {
-      var getCredentials = util.makeAuthorizedRequest().getCredentials;
+      var getCredentials = util.makeAuthorizedRequest({}).getCredentials;
       assert.equal(typeof getCredentials, 'function');
     });
 
@@ -313,7 +330,7 @@ describe('common/util', function() {
           };
         };
 
-        var makeRequest = util.makeAuthorizedRequest();
+        var makeRequest = util.makeAuthorizedRequest({});
         makeRequest({});
       });
 
@@ -326,7 +343,7 @@ describe('common/util', function() {
           };
         };
 
-        var makeRequest = util.makeAuthorizedRequest();
+        var makeRequest = util.makeAuthorizedRequest({});
         makeRequest({ headers: { 'User-Agent': 'test' } });
       });
 
@@ -339,7 +356,7 @@ describe('common/util', function() {
           };
         };
 
-        var makeRequest = util.makeAuthorizedRequest();
+        var makeRequest = util.makeAuthorizedRequest({});
         makeRequest({}, function(err) {
           assert.equal(err, error);
           done();
@@ -392,7 +409,7 @@ describe('common/util', function() {
           };
         };
 
-        var makeRequest = util.makeAuthorizedRequest();
+        var makeRequest = util.makeAuthorizedRequest({});
         makeRequest({}, function (err) {
           assert.equal(attempts, expectedAttempts);
           assert.equal(err, error);
@@ -407,7 +424,7 @@ describe('common/util', function() {
           };
         };
 
-        var makeRequest = util.makeAuthorizedRequest();
+        var makeRequest = util.makeAuthorizedRequest({});
         makeRequest({}, { onAuthorized: done });
       });
 
@@ -420,7 +437,7 @@ describe('common/util', function() {
           };
         };
 
-        var makeRequest = util.makeAuthorizedRequest();
+        var makeRequest = util.makeAuthorizedRequest({});
         makeRequest({}, {
           onAuthorized: function(err) {
             assert.equal(err, error);
@@ -443,7 +460,7 @@ describe('common/util', function() {
           done();
         };
 
-        var makeRequest = util.makeAuthorizedRequest();
+        var makeRequest = util.makeAuthorizedRequest({});
         makeRequest({}, assert.ifError);
       });
     });

test/datastore/dataset.js

@@ -23,6 +23,20 @@ var Dataset = require('../../lib/datastore/dataset');
 var util = require('../../lib/common/util.js');
 
 describe('Dataset', function() {
+  describe('instantiation', function() {
+    it('should set default API connection details', function() {
+      var ds = new Dataset();
+      assert.equal(ds.api.host, 'https://www.googleapis.com');
+      assert.equal(ds.api.port, 443);
+    });
+
+    it('should set API connection details', function() {
+      var ds = new Dataset({ host: 'http://localhost', port: 8080 });
+      assert.equal(ds.api.host, 'http://localhost');
+      assert.equal(ds.api.port, 8080);
+    });
+  });
+
   describe('key', function() {
     it('should return key scoped by default namespace', function() {
       var ds = new Dataset({ projectId: 'test', namespace: 'my-ns' });