Allow a single direct access point to package.json (#347)

DominicKramer · web-flow · commit b9085453fe8f · 2017-10-25T13:26:54.000-07:00
diff --git a/src/agent/debuglet.ts b/src/agent/debuglet.ts
@@ -43,13 +43,11 @@ import * as scanner from './io/scanner';
 import * as SourceMapper from './io/sourcemapper';
 import * as debugapi from './v8/debugapi';
 
-const pjson = require('../../../package.json');
-
 import * as assert from 'assert';
 
 import * as stackdriver from '../types/stackdriver';
 import {DebugAgentConfig} from './config';
-import {Debug} from '../client/stackdriver/debug';
+import {Debug, PackageInfo} from '../client/stackdriver/debug';
 import {Logger} from '../types/common';
 import {DebugApi} from './v8/debugapi';
 
@@ -161,8 +159,10 @@ export class Debuglet extends EventEmitter {
     this.fetcherActive_ = false;
 
     /** @private {common.logger} */
-    this.logger_ = new common.logger(
-        {level: common.logger.LEVELS[this.config_.logLevel], tag: pjson.name});
+    this.logger_ = new common.logger({
+      level: common.logger.LEVELS[this.config_.logLevel],
+      tag: this.debug_.packageInfo.name
+    });
 
     /** @private {DebugletApi} */
     this.controller_ = new Controller(this.debug_);
@@ -315,7 +315,8 @@ export class Debuglet extends EventEmitter {
         that.debuggee_ = Debuglet.createDebuggee(
             // TODO: Address the case when `id` is `undefined`.
             project, id as string, that.config_.serviceContext, sourceContext,
-            onGCP, that.config_.description, undefined);
+            onGCP, that.debug_.packageInfo, that.config_.description,
+            undefined);
         that.scheduleRegistration_(0 /* immediately */);
         that.emit('started');
       });
@@ -332,21 +333,22 @@ export class Debuglet extends EventEmitter {
       serviceContext:
           {service?: string, version?: string, minorVersion_?: string},
       sourceContext: {[key: string]: string}, onGCP: boolean,
-      description?: string, errorMessage?: string): Debuggee {
+      packageInfo: PackageInfo, description?: string,
+      errorMessage?: string): Debuggee {
     const cwd = process.cwd();
     const mainScript = path.relative(cwd, process.argv[1]);
 
     const version = 'google.com/node-' + (onGCP ? 'gcp' : 'standalone') + '/v' +
-        pjson.version;
+        packageInfo.version;
     let desc = process.title + ' ' + mainScript;
 
     const labels: {[key: string]: string} = {
       'main script': mainScript,
       'process.title': process.title,
       'node version': process.versions.node,
       'V8 version': process.versions.v8,
-      'agent.name': pjson.name,
-      'agent.version': pjson.version,
+      'agent.name': packageInfo.name,
+      'agent.version': packageInfo.version,
       'projectid': projectId
     };
 
@@ -392,7 +394,8 @@ export class Debuglet extends EventEmitter {
       agentVersion: version,
       labels: labels,
       statusMessage: statusMessage,
-      sourceContexts: [sourceContext]
+      sourceContexts: [sourceContext],
+      packageInfo: packageInfo
     };
     return new Debuggee(properties);
   }
diff --git a/src/client/stackdriver/debug.ts b/src/client/stackdriver/debug.ts
@@ -17,8 +17,14 @@
 import {AuthenticationConfig, Common} from '../../types/common';
 export const common: Common = require('@google-cloud/common');
 
+export interface PackageInfo {
+  name: string;
+  version: string;
+}
+
 export class Debug extends common.Service {
   options: AuthenticationConfig;
+  packageInfo: PackageInfo;
 
   /**
    * <p class="notice">
@@ -43,17 +49,17 @@ export class Debug extends common.Service {
    *
    * @param options - [Authentication options](#/docs)
    */
-  constructor(options: AuthenticationConfig) {
+  constructor(options: AuthenticationConfig, packageJson: any) {
     if (new.target !== Debug) {
       options = common.util.normalizeArguments(null, options);
-      return new Debug(options);
+      return new Debug(options, packageJson);
     }
 
     const config = {
       projectIdRequired: false,
       baseUrl: 'https://clouddebugger.googleapis.com/v2',
       scopes: ['https://www.googleapis.com/auth/cloud_debugger'],
-      packageJson: require('../../../../package.json')
+      packageJson: packageJson
     };
 
     // TODO: Update Service to provide types
@@ -67,5 +73,7 @@ export class Debug extends common.Service {
     // https://github.com/GoogleCloudPlatform/google-cloud-node/issues/1891
     // is resolved.
     this.options = options;
+
+    this.packageInfo = {name: packageJson.name, version: packageJson.version};
   }
 }
diff --git a/src/debuggee.ts b/src/debuggee.ts
@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-const pjson = require('../../package.json');
 import * as _ from 'lodash';
 import {StatusMessage} from './client/stackdriver/status-message';
 
@@ -26,7 +25,7 @@ export interface DebuggeeProperties {
   project?: string;
   uniquifier?: string;
   description?: string;
-  agentVersion?: string;
+  agentVersion: string;
   labels?: {
     [key: string]: string,
   };
@@ -95,8 +94,7 @@ export class Debuggee {
     this.project = properties.project;
     this.uniquifier = properties.uniquifier;
     this.description = properties.description;
-    this.agentVersion =
-        properties.agentVersion || (pjson.name + '/client/v' + pjson.version);
+    this.agentVersion = properties.agentVersion;
     if (properties.labels) {
       this.labels = properties.labels;
     }
diff --git a/src/index.ts b/src/index.ts
@@ -18,6 +18,8 @@ import {DebugAgentConfig, StackdriverConfig} from './agent/config';
 import {Debuglet} from './agent/debuglet';
 import {Debug} from './client/stackdriver/debug';
 
+const pjson = require('../../package.json');
+
 // Singleton.
 let debuglet: Debuglet;
 
@@ -44,7 +46,7 @@ export function start(options: DebugAgentConfig|StackdriverConfig): Debuglet|
     throw new Error('Debug Agent has already been started');
   }
 
-  const debug = new Debug(options);
+  const debug = new Debug(options, pjson);
   debuglet = new Debuglet(debug, agentConfig);
   debuglet.start();
 
diff --git a/system-test/test-controller.ts b/system-test/test-controller.ts
@@ -27,9 +27,12 @@ assert.ok(
 import * as stackdriver from '../src/types/stackdriver';
 import {Controller} from '../src/agent/controller';
 import {Debuggee} from '../src/debuggee';
-import {Debug} from '../src/client/stackdriver/debug';
-const debug = new Debug({});
+import {Debug, PackageInfo} from '../src/client/stackdriver/debug';
 
+const packageInfo: PackageInfo = { name: 'SomeName', version: 'SomeVersion' };
+const agentVersion = `${packageInfo.name}/client/${packageInfo.version}`;
+
+const debug = new Debug({}, packageInfo);
 
 describe('Controller', function() {
   this.timeout(60 * 1000);
@@ -40,7 +43,8 @@ describe('Controller', function() {
         new Debuggee({
           project: process.env.GCLOUD_PROJECT,
           uniquifier: 'test-uid-' + Date.now(),
-          description: 'this is a system test'
+          description: 'this is a system test',
+          agentVersion: agentVersion
         });
 
     controller.register(debuggee, function(err, maybeBody) {
@@ -59,7 +63,8 @@ describe('Controller', function() {
         new Debuggee({
           project: process.env.GCLOUD_PROJECT,
           uniquifier: 'test-uid-' + Date.now(),
-          description: 'this is a system test'
+          description: 'this is a system test',
+          agentVersion: agentVersion
         });
     // TODO: Determine if the body parameter should be used.
     controller.register(debuggee, function(err, _body) {
@@ -83,7 +88,8 @@ describe('Controller', function() {
         new Debuggee({
           project: process.env.GCLOUD_PROJECT,
           uniquifier: 'test-uid-' + Date.now(),
-          description: 'this is a system test'
+          description: 'this is a system test',
+          agentVersion: agentVersion
         });
     // TODO: Determine if the body parameter should be used.
     controller.register(debuggee, function(err, _body) {
diff --git a/system-test/test-e2e.ts b/system-test/test-e2e.ts
@@ -52,7 +52,8 @@ describe('@google-cloud/debug end-to-end behavior', function () {
 
   before(function() {
     promisifyAll(Debugger);
-    api = new Debugger(new Debug({}));
+    const packageInfo = { name: 'Some name', vesion: 'Some version' };
+    api = new Debugger(new Debug({}, packageInfo));
   });
 
   beforeEach(function() {
diff --git a/test/debugger.ts b/test/debugger.ts
@@ -23,7 +23,6 @@ import * as stackdriver from '../src/types/stackdriver';
 import {Debug} from '../src/client/stackdriver/debug';
 import {Debuggee} from '../src/debuggee';
 
-const pjson = require('../../package.json');
 export const common: commonTypes.Common = require('@google-cloud/common');
 // TODO: Verify these types are correct.
 const qs: { parse: (qs: any, sep?: string, eq?: string,
@@ -50,7 +49,7 @@ export class Debugger extends common.ServiceObject {
     /** @private {string} */
     this.nextWaitToken_ = null;
 
-    this.clientVersion_ = pjson.name + '/client-for-testing/v' + pjson.version;
+    this.clientVersion_ = debug.packageInfo.name + '/client-for-testing/v' + debug.packageInfo.version;
   }
 
   /**
diff --git a/test/test-controller.ts b/test/test-controller.ts
@@ -33,6 +33,7 @@ const fakeDebug: Debug = {
   request: request
 } as any as Debug;
 
+const agentVersion = `SomeName/client/SomeVersion`;
 const url = 'https://clouddebugger.googleapis.com';
 const api = '/v2/controller';
 
@@ -50,7 +51,8 @@ describe('Controller API', function() {
       const debuggee = new Debuggee({
         project: 'fake-project',
         uniquifier: 'fake-id',
-        description: 'unit test'
+        description: 'unit test',
+        agentVersion: agentVersion
       });
       const controller = new Controller(fakeDebug);
       // TODO: Determine if this type signature is correct.
@@ -73,7 +75,8 @@ describe('Controller API', function() {
          const debuggee = new Debuggee({
            project: 'fake-project',
            uniquifier: 'fake-id',
-           description: 'unit test'
+           description: 'unit test',
+           agentVersion: agentVersion
          });
          const controller = new Controller(fakeDebug);
          controller.register(debuggee, function(err: Error, result: {debuggee: Debuggee}) {
@@ -101,7 +104,8 @@ describe('Controller API', function() {
       const debuggee = new Debuggee({
         project: 'fake-project',
         uniquifier: 'fake-id',
-        description: 'unit test'
+        description: 'unit test',
+        agentVersion: agentVersion
       });
       const controller = new Controller(fakeDebug);
       controller.register(debuggee, function(err/*, result*/) {
diff --git a/test/test-debuggee.ts b/test/test-debuggee.ts
@@ -17,29 +17,31 @@
 import * as assert from 'assert';
 import {Debuggee} from '../src/debuggee';
 
+const agentVersion = `SomeName/client/SomeVersion`;
+
 describe('Debuggee', function() {
 
   it('should create a Debuggee instance on valid input', function() {
     const debuggee = new Debuggee(
-        {project: 'project', uniquifier: 'uid', description: 'unit test'});
+        {project: 'project', uniquifier: 'uid', description: 'unit test', agentVersion: agentVersion});
     assert.ok(debuggee instanceof Debuggee);
   });
 
   it('should create a Debuggee on a call without new', function() {
     const debuggee = new Debuggee(
-        {project: 'project', uniquifier: 'uid', description: 'unit test'});
+        {project: 'project', uniquifier: 'uid', description: 'unit test', agentVersion: agentVersion});
     assert.ok(debuggee instanceof Debuggee);
   });
 
   it('should throw on invalid input', function() {
-    assert.throws(function() { new Debuggee({}); });
-    assert.throws(function() { new Debuggee({project: '5'}); });
-    assert.throws(function() { new Debuggee({project: undefined}); });
-    assert.throws(function() { new Debuggee({project: 'test'}); });
+    assert.throws(function() { new Debuggee({agentVersion: agentVersion}); });
+    assert.throws(function() { new Debuggee({project: '5', agentVersion: agentVersion}); });
+    assert.throws(function() { new Debuggee({project: undefined, agentVersion: agentVersion}); });
+    assert.throws(function() { new Debuggee({project: 'test', agentVersion: agentVersion}); });
     assert.throws(function() {
-      new Debuggee({project: 'test', uniquifier: undefined});
+      new Debuggee({project: 'test', uniquifier: undefined, agentVersion: agentVersion});
       assert.throws(function() {
-        new Debuggee({project: 'test', uniquifier: 'uid'});
+        new Debuggee({project: 'test', uniquifier: 'uid', agentVersion: agentVersion});
       });
     });
   });
diff --git a/test/test-debuglet.ts b/test/test-debuglet.ts
diff --git a/test/test-module.ts b/test/test-module.ts
diff --git a/test/test-options-credentials.ts b/test/test-options-credentials.ts
