move UA formatting to util

Author: stephenplusplus

packages/common/src/grpc-service.js

@@ -36,6 +36,12 @@ 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
@@ -170,11 +176,7 @@ function GrpcService(config, options) {
   }
 
   this.maxRetries = options.maxRetries;
-
-  var hyphenatedPackageName = config.packageJson.name
-    .replace('@google-cloud', 'gcloud-node') // For legacy purposes.
-    .replace('/', '-'); // For UA spec-compliance purposes.
-  this.userAgent = hyphenatedPackageName + '/' + config.packageJson.version;
+  this.userAgent = util.getUserAgentFromPackageJson(config.packageJson);
 
   var apiVersion = config.apiVersion;
   var service = this.service = config.service;

packages/common/src/service.js

@@ -116,10 +116,7 @@ Service.prototype.request = function(reqOpts, callback) {
   delete reqOpts.interceptors_;
 
   reqOpts.headers = extend({}, reqOpts.headers, {
-    'User-Agent': [
-      this.packageJson.name.replace('@google-cloud', 'gcloud-node'),
-      this.packageJson.version
-    ].join('/')
+    'User-Agent': util.getUserAgentFromPackageJson(this.packageJson)
   });
 
   return this.makeAuthenticatedRequest(reqOpts, callback);

packages/common/src/util.js

@@ -614,3 +614,19 @@ 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;

packages/common/test/grpc-service.js

@@ -28,6 +28,7 @@ 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;
@@ -43,6 +44,7 @@ function fakeRetryRequest() {
   return (retryRequestOverride || retryRequest).apply(null, arguments);
 }
 
+
 var GrpcMetadataOverride;
 var grpcLoadOverride;
 var fakeGrpc = {
@@ -119,7 +121,8 @@ describe('GrpcService', function() {
       'google-proto-files': fakeGoogleProtoFiles,
       'retry-request': fakeRetryRequest,
       grpc: fakeGrpc,
-      './service.js': FakeService
+      './service.js': FakeService,
+      './util.js': fakeUtil
     });
     GrpcServiceCached = extend(true, {}, GrpcService);
   });
@@ -288,7 +291,17 @@ describe('GrpcService', function() {
     });
 
     it('should set the correct user-agent', function() {
-      assert.strictEqual(grpcService.userAgent, 'gcloud-node-service/0.2.0');
+      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) {

packages/common/test/service.js

@@ -221,11 +221,17 @@ describe('Service', function() {
     });
 
     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'], [
-          CONFIG.packageJson.name.replace('@google-cloud', 'gcloud-node'),
-          CONFIG.packageJson.version
-        ].join('/'));
+        assert.strictEqual(reqOpts.headers['User-Agent'], userAgent);
         done();
       };
 

packages/common/test/util.js

@@ -1363,4 +1363,15 @@ 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');
+    });
+  });
 });

packages/translate/src/index.js

@@ -384,10 +384,7 @@ Translate.prototype.request = function(reqOpts, callback) {
       key: this.key
     },
     headers: {
-      'User-Agent': [
-        PKG.name.replace('@google-cloud', 'gcloud-node'),
-        PKG.version
-      ].join('/')
+      'User-Agent': common.util.getUserAgentFromPackageJson(PKG)
     }
   });
 

packages/translate/test/index.js

@@ -21,8 +21,6 @@ var extend = require('extend');
 var proxyquire = require('proxyquire');
 var util = require('@google-cloud/common').util;
 
-var PKG = require('../package.json');
-
 var makeRequestOverride;
 var fakeUtil = extend({}, util, {
   makeRequest: function() {
@@ -386,6 +384,15 @@ describe('Translate', function() {
 
   describe('request', function() {
     it('should make the correct request', function(done) {
+      var userAgent = 'user-agent/0.0.0';
+
+      var getUserAgentFn = fakeUtil.getUserAgentFromPackageJson;
+      fakeUtil.getUserAgentFromPackageJson = function(packageJson) {
+        fakeUtil.getUserAgentFromPackageJson = getUserAgentFn;
+        assert.deepEqual(packageJson, require('../package.json'));
+        return userAgent;
+      };
+
       var reqOpts = {
         uri: '/test',
         a: 'b',
@@ -401,7 +408,7 @@ describe('Translate', function() {
           key: translate.key
         },
         headers: {
-          'User-Agent': 'gcloud-node/translate/' + PKG.version
+          'User-Agent': userAgent
         }
       });
       var BASE_URL = 'https://www.googleapis.com/language/translate/v2';