Document minorVersion_ as an internal property (#239)

ofrobots · web-flow · commit 75974f56d518 · 2017-02-11T07:22:11.000-08:00
diff --git a/src/agent/config.js b/src/agent/config.js
@@ -61,7 +61,14 @@ module.exports = {
      * @property {?string} the service version
      * @default
      */
-    version: null
+    version: null,
+
+    /**
+     * @property {?string} a unique deployment identifier. This is used
+     * internally only.
+     * @private
+     */
+    minorVersion_: null
   },
 
   /**
diff --git a/src/agent/debuglet.js b/src/agent/debuglet.js
@@ -149,7 +149,7 @@ Debuglet.prototype.normalizeConfig_ = function(config) {
       // AppEngine Flex doesn't have this environment variable. We provide a
       // fake value as a work-around, but only on Flex (GAE_SERVICE will be
       // defined on Flex).
-      minorVersion:
+      minorVersion_:
           process.env.GAE_MINOR_VERSION ||
               (process.env.GAE_SERVICE ? 'fake-minor-version' : undefined)
     }
@@ -281,9 +281,9 @@ Debuglet.createDebuggee =
       desc += ' version:' + serviceContext.version;
     }
 
-    if (_.isString(serviceContext.minorVersion)) {
+    if (_.isString(serviceContext.minorVersion_)) {
       //          v--- intentional lowercase
-      labels.minorversion = serviceContext.minorVersion;
+      labels.minorversion = serviceContext.minorVersion_;
     }
   }
 
diff --git a/test/test-debuglet.js b/test/test-debuglet.js
@@ -252,7 +252,7 @@ describe('Debuglet', function() {
            var debuglet = new Debuglet(debug, defaultConfig);
            assert.ok(debuglet.config_);
            assert.ok(debuglet.config_.serviceContext);
-           assert.strictEqual(debuglet.config_.serviceContext.minorVersion,
+           assert.strictEqual(debuglet.config_.serviceContext.minorVersion_,
                               'some minor version');
          });
 
@@ -263,7 +263,7 @@ describe('Debuglet', function() {
            var debuglet = new Debuglet(debug, defaultConfig);
            assert.ok(debuglet.config_);
            assert.ok(debuglet.config_.serviceContext);
-           assert.ok(_.isString(debuglet.config_.serviceContext.minorVersion));
+           assert.ok(_.isString(debuglet.config_.serviceContext.minorVersion_));
          });
 
       it('should not have minorVersion unless enviroment provides it',

Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ Debuglet.prototype.normalizeConfig_ = function(config) {`
`149`	`149`	`// AppEngine Flex doesn't have this environment variable. We provide a`
`150`	`150`	`// fake value as a work-around, but only on Flex (GAE_SERVICE will be`
`151`	`151`	`// defined on Flex).`
`152`		`- minorVersion:`
	`152`	`+ minorVersion_:`
`153`	`153`	`process.env.GAE_MINOR_VERSION \|\|`
`154`	`154`	`(process.env.GAE_SERVICE ? 'fake-minor-version' : undefined)`
`155`	`155`	`}`
`@@ -281,9 +281,9 @@ Debuglet.createDebuggee =`
`281`	`281`	`desc += ' version:' + serviceContext.version;`
`282`	`282`	`}`
`283`	`283`
`284`		`- if (_.isString(serviceContext.minorVersion)) {`
	`284`	`+ if (_.isString(serviceContext.minorVersion_)) {`
`285`	`285`	`// v--- intentional lowercase`
`286`		`- labels.minorversion = serviceContext.minorVersion;`
	`286`	`+ labels.minorversion = serviceContext.minorVersion_;`
`287`	`287`	`}`
`288`	`288`	`}`
`289`	`289`