common: pull out common changes

googleapis · Sep 9, 2016 · a3eccbd · a3eccbd
1 parent c2b3648
commit a3eccbd
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 100 deletions.
diff --git a/packages/common/src/grpc-service.js b/packages/common/src/grpc-service.js
@@ -36,12 +36,6 @@ var through = require('through2');
  */
 var Service = require('./service.js');
 
-/**
- * @type {module:common/util}
- * @private
- */
-var util = require('./util.js');
-
 /**
  * @const {object} - A map of protobuf codes to HTTP status codes.
  * @private
@@ -176,7 +170,6 @@ function GrpcService(config, options) {
   }
 
   this.maxRetries = options.maxRetries;
-  this.userAgent = util.getUserAgentFromPackageJson(config.packageJson);
 
   var apiVersion = config.apiVersion;
   var service = this.service = config.service;
@@ -739,8 +732,7 @@ GrpcService.prototype.getService_ = function(protoOpts) {
   if (!service) {
     service = new proto[protoOpts.service](
       proto.baseUrl || this.baseUrl,
-      this.grpcCredentials,
-      { 'grpc.primary_user_agent': this.userAgent }
+      this.grpcCredentials
     );
 
     this.activeServiceMap_.set(protoOpts.service, service);

diff --git a/packages/common/src/service.js b/packages/common/src/service.js
@@ -57,7 +57,6 @@ function Service(config, options) {
   this.getCredentials = this.makeAuthenticatedRequest.getCredentials;
   this.globalInterceptors = arrify(options.interceptors_);
   this.interceptors = [];
-  this.packageJson = config.packageJson;
   this.projectId = options.projectId;
   this.projectIdRequired = config.projectIdRequired !== false;
 }
@@ -115,10 +114,6 @@ Service.prototype.request = function(reqOpts, callback) {
 
   delete reqOpts.interceptors_;
 
-  reqOpts.headers = extend({}, reqOpts.headers, {
-    'User-Agent': util.getUserAgentFromPackageJson(this.packageJson)
-  });
-
   return this.makeAuthenticatedRequest(reqOpts, callback);
 };
 

diff --git a/packages/common/src/util.js b/packages/common/src/util.js
@@ -38,6 +38,12 @@ var streamEvents = require('stream-events');
 var through = require('through2');
 var uniq = require('array-uniq');
 
+/** @const {object} @google-cloud/common's package.json file. */
+var PKG = require('../package.json');
+
+/** @const {string} User agent. */
+var USER_AGENT = PKG.name + '/' + PKG.version;
+
 var util = module.exports;
 
 var errorMessage = format([
@@ -460,6 +466,11 @@ util.makeRequest = makeRequest;
  */
 function decorateRequest(reqOpts, config) {
   config = config || {};
+  reqOpts.headers = reqOpts.headers || {};
+
+  var headers = reqOpts.headers;
+  var userAgent = headers['User-Agent'] || headers['user-agent'];
+  headers['User-Agent'] = userAgent || config.userAgent || USER_AGENT;
 
   if (is.object(reqOpts.qs)) {
     delete reqOpts.qs.autoPaginate;
@@ -614,19 +625,3 @@ function isCustomType(unknown, module) {
 }
 
 util.isCustomType = isCustomType;
-
-/**
- * Create a properly-formatted User-Agent string from a package.json file.
- *
- * @param {object} packageJson - A module's package.json file.
- * @return {string} userAgent - The formatted User-Agent string.
- */
-function getUserAgentFromPackageJson(packageJson) {
-  var hyphenatedPackageName = packageJson.name
-    .replace('@google-cloud', 'gcloud-node') // For legacy purposes.
-    .replace('/', '-'); // For UA spec-compliance purposes.
-
-  return hyphenatedPackageName + '/' + packageJson.version;
-}
-
-util.getUserAgentFromPackageJson = getUserAgentFromPackageJson;
diff --git a/packages/common/test/grpc-service.js b/packages/common/test/grpc-service.js
@@ -28,7 +28,6 @@ var sinon = require('sinon').sandbox.create();
 var through = require('through2');
 
 var util = require('../src/util.js');
-var fakeUtil = extend({}, util);
 
 function FakeService() {
   this.calledWith_ = arguments;
@@ -93,10 +92,6 @@ describe('GrpcService', function() {
     proto: {},
     service: 'Service',
     apiVersion: 'v1',
-    packageJson: {
-      name: '@google-cloud/service',
-      version: '0.2.0'
-    },
     grpcMetadata: {
       property: 'value'
     }
@@ -120,8 +115,7 @@ describe('GrpcService', function() {
       'google-proto-files': fakeGoogleProtoFiles,
       'retry-request': fakeRetryRequest,
       grpc: fakeGrpc,
-      './service.js': FakeService,
-      './util.js': fakeUtil
+      './service.js': FakeService
     });
     GrpcServiceCached = extend(true, {}, GrpcService);
   });
@@ -249,12 +243,6 @@ describe('GrpcService', function() {
       assert.strictEqual(calledWith[1], OPTIONS);
     });
 
-    it('should set insecure credentials if using customEndpoint', function() {
-      var config = extend({}, CONFIG, { customEndpoint: true });
-      var grpcService = new GrpcService(config, OPTIONS);
-      assert.strictEqual(grpcService.grpcCredentials.name, 'createInsecure');
-    });
-
     it('should default grpcMetadata to empty metadata', function() {
       var fakeGrpcMetadata = {};
 
@@ -289,20 +277,6 @@ describe('GrpcService', function() {
       assert.strictEqual(grpcService.maxRetries, OPTIONS.maxRetries);
     });
 
-    it('should set the correct user-agent', function() {
-      var userAgent = 'user-agent/0.0.0';
-
-      var getUserAgentFn = fakeUtil.getUserAgentFromPackageJson;
-      fakeUtil.getUserAgentFromPackageJson = function(packageJson) {
-        fakeUtil.getUserAgentFromPackageJson = getUserAgentFn;
-        assert.strictEqual(packageJson, CONFIG.packageJson);
-        return userAgent;
-      };
-
-      var grpcService = new GrpcService(CONFIG, OPTIONS);
-      assert.strictEqual(grpcService.userAgent, userAgent);
-    });
-
     it('should get the root directory for the proto files', function(done) {
       googleProtoFilesOverride = function(path) {
         assert.strictEqual(path, '..');
@@ -313,6 +287,12 @@ describe('GrpcService', function() {
       new GrpcService(CONFIG, OPTIONS);
     });
 
+    it('should set insecure credentials if using customEndpoint', function() {
+      var config = extend({}, CONFIG, { customEndpoint: true });
+      var grpcService = new GrpcService(config, OPTIONS);
+      assert.strictEqual(grpcService.grpcCredentials.name, 'createInsecure');
+    });
+
     it('should localize the service', function() {
       assert.strictEqual(grpcService.service, CONFIG.service);
     });
@@ -1518,13 +1498,9 @@ describe('GrpcService', function() {
 
       grpcService.protos = {
         Service: {
-          Service: function(baseUrl, grpcCredentials, userAgent) {
+          Service: function(baseUrl, grpcCredentials) {
             assert.strictEqual(baseUrl, grpcService.baseUrl);
             assert.strictEqual(grpcCredentials, grpcService.grpcCredentials);
-            assert.deepEqual(userAgent, {
-              'grpc.primary_user_agent': grpcService.userAgent
-            });
-
             return fakeService;
           }
         }

diff --git a/packages/common/test/service.js b/packages/common/test/service.js
@@ -39,11 +39,7 @@ describe('Service', function() {
   var CONFIG = {
     scopes: [],
     baseUrl: 'base-url',
-    projectIdRequired: false,
-    packageJson: {
-      name: '@google-cloud/service',
-      version: '0.2.0'
-    }
+    projectIdRequired: false
   };
 
   var OPTIONS = {
@@ -133,10 +129,6 @@ describe('Service', function() {
       assert.deepEqual(service.interceptors, []);
     });
 
-    it('should localize package.json', function() {
-      assert.strictEqual(service.packageJson, CONFIG.packageJson);
-    });
-
     it('should localize the projectId', function() {
       assert.strictEqual(service.projectId, OPTIONS.projectId);
     });
@@ -220,24 +212,6 @@ describe('Service', function() {
       service.request(reqOpts, assert.ifError);
     });
 
-    it('should add the User Agent', function(done) {
-      var userAgent = 'user-agent/0.0.0';
-
-      var getUserAgentFn = util.getUserAgentFromPackageJson;
-      util.getUserAgentFromPackageJson = function(packageJson) {
-        util.getUserAgentFromPackageJson = getUserAgentFn;
-        assert.strictEqual(packageJson, service.packageJson);
-        return userAgent;
-      };
-
-      service.makeAuthenticatedRequest = function(reqOpts) {
-        assert.strictEqual(reqOpts.headers['User-Agent'], userAgent);
-        done();
-      };
-
-      service.request(reqOpts, assert.ifError);
-    });
-
     describe('projectIdRequired', function() {
       describe('false', function() {
         it('should include the projectId', function(done) {

diff --git a/packages/common/test/util.js b/packages/common/test/util.js
@@ -1153,6 +1153,60 @@ describe('common/util', function() {
   });
 
   describe('decorateRequest', function() {
+    it('should keep user agent', function() {
+      var USER_AGENT = 'test/v1';
+
+      var reqOpts = {
+        a: 'b',
+        c: 'd',
+        headers: {
+          'User-Agent': USER_AGENT
+        }
+      };
+
+      var expectedReqOpts = extend({}, reqOpts, {
+        headers: {
+          'User-Agent': USER_AGENT
+        }
+      });
+
+      var decoratedReqOpts = util.decorateRequest(reqOpts);
+      assert.deepEqual(decoratedReqOpts, expectedReqOpts);
+    });
+
+    it('should add the user agent', function() {
+      var USER_AGENT = 'test/v2';
+
+      var reqOpts = { a: 'b', c: 'd' };
+
+      var expectedReqOpts = extend({}, reqOpts, {
+        headers: {
+          'User-Agent': USER_AGENT
+        }
+      });
+
+      var decoratedReqOpts = util.decorateRequest(reqOpts, {
+        userAgent: USER_AGENT
+      });
+      assert.deepEqual(decoratedReqOpts, expectedReqOpts);
+    });
+
+    it('should add the default user agent', function() {
+      var PKG = require('../package.json');
+      var USER_AGENT = PKG.name + '/' + PKG.version;
+
+      var reqOpts = { a: 'b', c: 'd' };
+
+      var expectedReqOpts = extend({}, reqOpts, {
+        headers: {
+          'User-Agent': USER_AGENT
+        }
+      });
+
+      var decoratedReqOpts = util.decorateRequest(reqOpts);
+      assert.deepEqual(decoratedReqOpts, expectedReqOpts);
+    });
+
     it('should delete qs.autoPaginate', function() {
       var decoratedReqOpts = util.decorateRequest({
         qs: {
@@ -1363,15 +1417,4 @@ describe('common/util', function() {
       });
     });
   });
-
-  describe('getUserAgentFromPackageJson', function() {
-    it('should format a User Agent string from a package.json', function() {
-      var userAgent = util.getUserAgentFromPackageJson({
-        name: '@google-cloud/storage',
-        version: '0.1.0'
-      });
-
-      assert.strictEqual(userAgent, 'gcloud-node-storage/0.1.0');
-    });
-  });
 });