refactor: ts conversion of trace-labels and constants (googleapis#558)

PR-URL: googleapis#558
BenCrux · Sep 19, 2017 · 7a614c5 · 7a614c5
1 parent ce34e55
commit 7a614c5
Show file tree

Hide file tree

Showing 24 changed files with 157 additions and 146 deletions.
diff --git a/index.ts b/index.ts
@@ -33,11 +33,12 @@ if (require('semver').satisfies(process.version, '<8') ||
   require('continuation-local-storage');
 }
 
+import { Constants } from './src/constants';
+
 var path = require('path');
 var cls = require('./src/cls'/*.js*/);
 var common = require('@google-cloud/common');
 var extend = require('extend');
-var constants = require('./src/constants'/*.js*/);
 var traceUtil = require('./src/util'/*.js*/);
 var TraceAgent = require('./src/trace-api'/*.js*/);
 var pluginLoader = require('./src/trace-plugin-loader'/*.js*/);
@@ -85,8 +86,8 @@ function initConfig(projectConfig) {
     projectConfig, envConfig);
 
   // Enforce the upper limit for the label value size.
-  if (config.maximumLabelValueSize > constants.TRACE_SERVICE_LABEL_VALUE_LIMIT) {
-    config.maximumLabelValueSize = constants.TRACE_SERVICE_LABEL_VALUE_LIMIT;
+  if (config.maximumLabelValueSize > Constants.TRACE_SERVICE_LABEL_VALUE_LIMIT) {
+    config.maximumLabelValueSize = Constants.TRACE_SERVICE_LABEL_VALUE_LIMIT;
   }
   // Clamp the logger level.
   if (config.logLevel < 0) {

diff --git a/src/constants.ts b/src/constants.ts
@@ -16,25 +16,23 @@
 
 'use strict';
 
-module.exports = {
+export namespace Constants {
   /** @const {string} header that carries trace context across Google infrastructure. */
-  TRACE_CONTEXT_HEADER_NAME: 'x-cloud-trace-context',
+  export const TRACE_CONTEXT_HEADER_NAME = 'x-cloud-trace-context';
 
   /** @const {string} header that is used to identify outgoing http made by the agent. */
-  TRACE_AGENT_REQUEST_HEADER: 'x-cloud-trace-agent-request',
+  export const TRACE_AGENT_REQUEST_HEADER = 'x-cloud-trace-agent-request';
 
   /** @const {number} bitmask to determine whether trace is enabled in trace options. */
-  TRACE_OPTIONS_TRACE_ENABLED: 1 << 0,
+  export const TRACE_OPTIONS_TRACE_ENABLED = 1 << 0;
 
   /** See: cloud.google.com/trace/api/reference/rest/v1/projects.traces for limits. */
   /** Maximum size of a span name in bytes. */
-  TRACE_SERVICE_SPAN_NAME_LIMIT: 127,
+  export const TRACE_SERVICE_SPAN_NAME_LIMIT = 127;
 
   /** Maximum size of a label key in bytes. */
-  TRACE_SERVICE_LABEL_KEY_LIMIT: 127,
+  export const TRACE_SERVICE_LABEL_KEY_LIMIT = 127;
 
   /** Maximum size of a label value in bytes. */
-  TRACE_SERVICE_LABEL_VALUE_LIMIT: 16 * 1024 - 1,
+  export const TRACE_SERVICE_LABEL_VALUE_LIMIT = 16 * 1024 - 1;
 };
-
-export default {};
diff --git a/src/span-data.ts b/src/span-data.ts
@@ -43,9 +43,10 @@ declare global {
   }
 }
 
-var constants = require('./constants'/*.js*/);
+import { Constants } from './constants';
+import { TraceLabels } from './trace-labels';
+
 var TraceSpan = require('./trace-span'/*.js*/);
-var TraceLabels = require('./trace-labels'/*.js*/);
 var traceUtil = require('./util'/*.js*/);
 var util = require('util');
 var TraceWriter = require('./trace-writer'/*.js*/);
@@ -64,7 +65,7 @@ var uid = 1;
  */
 function SpanData(trace, name, parentSpanId, isRoot, skipFrames) {
   var spanId = uid++;
-  var spanName = traceUtil.truncate(name, constants.TRACE_SERVICE_SPAN_NAME_LIMIT);
+  var spanName = traceUtil.truncate(name, Constants.TRACE_SERVICE_SPAN_NAME_LIMIT);
   this.span = new TraceSpan(spanName, spanId, parentSpanId);
   this.trace = trace;
   this.isRoot = isRoot;
@@ -110,7 +111,7 @@ function SpanData(trace, name, parentSpanId, isRoot, skipFrames) {
     // config.maxLabelValueSize.
     this.span.setLabel(TraceLabels.STACK_TRACE_DETAILS_KEY,
       traceUtil.truncate(JSON.stringify({stack_frame: stackFrames}),
-        constants.TRACE_SERVICE_LABEL_VALUE_LIMIT));
+        Constants.TRACE_SERVICE_LABEL_VALUE_LIMIT));
 
     Error.stackTraceLimit = origLimit;
     Error.prepareStackTrace = origPrepare;
@@ -122,7 +123,7 @@ SpanData.prototype.getTraceContext = function() {
 };
 
 SpanData.prototype.addLabel = function(key, value) {
-  var k = traceUtil.truncate(key, constants.TRACE_SERVICE_LABEL_KEY_LIMIT);
+  var k = traceUtil.truncate(key, Constants.TRACE_SERVICE_LABEL_KEY_LIMIT);
   var string_val = typeof value === 'string' ? value : util.inspect(value);
   var v = traceUtil.truncate(string_val, TraceWriter.get().config().maximumLabelValueSize);
   this.span.setLabel(k, v);

diff --git a/src/trace-api.ts b/src/trace-api.ts
@@ -15,10 +15,12 @@
  */
 
 'use strict';
+
+import { Constants } from './constants';
+import { TraceLabels } from './trace-labels';
+
 var cls = require('./cls'/*.js*/);
-var constants = require('./constants'/*.js*/);
 var is = require('is');
-var TraceLabels = require('./trace-labels'/*.js*/);
 var util = require('./util'/*.js*/);
 var Trace = require('./trace'/*.js*/);
 var SpanData = require('./span-data'/*.js*/);
@@ -161,7 +163,7 @@ TraceAgent.prototype.runInRootSpan = function(options, fn) {
     // policy disallows it.
     var locallyAllowed = that.policy_.shouldTrace(Date.now(), options.url || '');
     var remotelyAllowed = isNaN(incomingTraceContext.options) ||
-      (incomingTraceContext.options & constants.TRACE_OPTIONS_TRACE_ENABLED);
+      (incomingTraceContext.options & Constants.TRACE_OPTIONS_TRACE_ENABLED);
     if (!locallyAllowed || !remotelyAllowed) {
       cls.setRootContext(nullSpan);
       return fn(null);
@@ -298,7 +300,7 @@ TraceAgent.prototype.wrapEmitter = function(emitter) {
   this.namespace_.bindEmitter(emitter);
 };
 
-TraceAgent.prototype.constants = constants;
+TraceAgent.prototype.constants = Constants;
 
 TraceAgent.prototype.labels = TraceLabels;
 

diff --git a/src/trace-labels.ts b/src/trace-labels.ts
@@ -94,11 +94,3 @@ export namespace TraceLabels {
    */
   export const AGENT_DATA = '/agent';
 };
-
-
-/**
- * Export TraceLabels.
- */
-module.exports = TraceLabels;
-
-export default {};
diff --git a/src/trace-writer.ts b/src/trace-writer.ts
@@ -16,17 +16,18 @@
 
 'use strict';
 
+import { Constants } from './constants';
+import { TraceLabels } from './trace-labels';
+
 var common = require('@google-cloud/common');
 var gcpMetadata = require('gcp-metadata');
 var util = require('util');
-var traceLabels = require('./trace-labels'/*.js*/);
 var pjson = require('../../package.json');
-var constants = require('./constants'/*.js*/);
 
 var onUncaughtExceptionValues = ['ignore', 'flush', 'flushAndExit'];
 
 var headers = {};
-headers[constants.TRACE_AGENT_REQUEST_HEADER] = 1;
+headers[Constants.TRACE_AGENT_REQUEST_HEADER] = 1;
 
 /* @const {Array<string>} list of scopes needed to operate with the trace API */
 var SCOPES = ['https://www.googleapis.com/auth/trace.append'];
@@ -114,25 +115,25 @@ TraceWriter.prototype.initialize = function(cb) {
   that.getHostname(function(hostname) {
     that.getInstanceId(function(instanceId) {
       var labels = {};
-      labels[traceLabels.AGENT_DATA] = 'node ' + pjson.name + ' v' + pjson.version;
-      labels[traceLabels.GCE_HOSTNAME] = hostname;
+      labels[TraceLabels.AGENT_DATA] = 'node ' + pjson.name + ' v' + pjson.version;
+      labels[TraceLabels.GCE_HOSTNAME] = hostname;
       if (instanceId) {
-        labels[traceLabels.GCE_INSTANCE_ID] = instanceId;
+        labels[TraceLabels.GCE_INSTANCE_ID] = instanceId;
       }
       var moduleName = that.config_.serviceContext.service || hostname;
-      labels[traceLabels.GAE_MODULE_NAME] = moduleName;
+      labels[TraceLabels.GAE_MODULE_NAME] = moduleName;
 
       var moduleVersion = that.config_.serviceContext.version;
       if (moduleVersion) {
-        labels[traceLabels.GAE_MODULE_VERSION] = moduleVersion;
+        labels[TraceLabels.GAE_MODULE_VERSION] = moduleVersion;
         var minorVersion = that.config_.serviceContext.minorVersion;
         if (minorVersion) {
           var versionLabel = '';
           if (moduleName !== 'default') {
             versionLabel = moduleName + ':';
           }
           versionLabel += moduleVersion + '.' + minorVersion;
-          labels[traceLabels.GAE_VERSION] = versionLabel;
+          labels[TraceLabels.GAE_VERSION] = versionLabel;
         }
       }
       Object.freeze(labels);

diff --git a/test/plugins/test-trace-connect.ts b/test/plugins/test-trace-connect.ts
@@ -15,10 +15,11 @@
  */
 'use strict';
 
-var traceLabels = require('../../src/trace-labels'/*.js*/);
+import { Constants } from '../../src/constants';
+import { TraceLabels } from '../../src/trace-labels';
+
 var http = require('http');
 var assert = require('assert');
-var constants = require('../../src/constants'/*.js*/);
 var common = require('./common'/*.js*/);
 
 var server;
@@ -104,10 +105,10 @@ describe('test-trace-connect', function() {
     server = app.listen(common.serverPort, function() {
       http.get({port: common.serverPort}, function(res) {
         var labels = common.getMatchingSpan(connectPredicate).labels;
-        assert.equal(labels[traceLabels.HTTP_RESPONSE_CODE_LABEL_KEY], '200');
-        assert.equal(labels[traceLabels.HTTP_METHOD_LABEL_KEY], 'GET');
-        assert.equal(labels[traceLabels.HTTP_URL_LABEL_KEY], 'http://localhost:9042/');
-        assert(labels[traceLabels.HTTP_SOURCE_IP]);
+        assert.equal(labels[TraceLabels.HTTP_RESPONSE_CODE_LABEL_KEY], '200');
+        assert.equal(labels[TraceLabels.HTTP_METHOD_LABEL_KEY], 'GET');
+        assert.equal(labels[TraceLabels.HTTP_URL_LABEL_KEY], 'http://localhost:9042/');
+        assert(labels[TraceLabels.HTTP_SOURCE_IP]);
         done();
       });
     });
@@ -121,7 +122,7 @@ describe('test-trace-connect', function() {
     server = app.listen(common.serverPort, function() {
       http.get({port: common.serverPort}, function(res) {
         var labels = common.getMatchingSpan(connectPredicate).labels;
-        var stackTrace = JSON.parse(labels[traceLabels.STACK_TRACE_DETAILS_KEY]);
+        var stackTrace = JSON.parse(labels[TraceLabels.STACK_TRACE_DETAILS_KEY]);
         // Ensure that our middleware is on top of the stack
         assert.equal(stackTrace.stack_frame[0].method_name, 'middleware');
         done();
@@ -151,7 +152,7 @@ describe('test-trace-connect', function() {
     server = app.listen(common.serverPort, function() {
       http.get({port: common.serverPort}, function(res) {
         var labels = common.getMatchingSpan(connectPredicate).labels;
-        assert.equal(labels[traceLabels.HTTP_RESPONSE_CODE_LABEL_KEY], '500');
+        assert.equal(labels[TraceLabels.HTTP_RESPONSE_CODE_LABEL_KEY], '500');
         done();
       });
     });
@@ -164,16 +165,16 @@ describe('test-trace-connect', function() {
     });
     server = app.listen(common.serverPort, function() {
       var headers = {};
-      headers[constants.TRACE_CONTEXT_HEADER_NAME] = '123456/1;o=1';
+      headers[Constants.TRACE_CONTEXT_HEADER_NAME] = '123456/1;o=1';
       http.get({
         port: common.serverPort
       }, function(res) {
-        assert(!res.headers[constants.TRACE_CONTEXT_HEADER_NAME]);
+        assert(!res.headers[Constants.TRACE_CONTEXT_HEADER_NAME]);
         http.get({
           port: common.serverPort,
           headers: headers
         }, function(res) {
-          assert(res.headers[constants.TRACE_CONTEXT_HEADER_NAME].indexOf(';o=1') !== -1);
+          assert(res.headers[Constants.TRACE_CONTEXT_HEADER_NAME].indexOf(';o=1') !== -1);
           done();
         });
       });

diff --git a/test/plugins/test-trace-express.ts b/test/plugins/test-trace-express.ts
@@ -15,10 +15,11 @@
  */
 'use strict';
 
-var traceLabels = require('../../src/trace-labels'/*.js*/);
+import { Constants } from '../../src/constants';
+import { TraceLabels } from '../../src/trace-labels';
+
 var http = require('http');
 var assert = require('assert');
-var constants = require('../../src/constants'/*.js*/);
 var common = require('./common'/*.js*/);
 
 var server;
@@ -159,10 +160,10 @@ describe('test-trace-express', function() {
     server = app.listen(common.serverPort, function() {
       http.get({port: common.serverPort}, function(res) {
         var labels = common.getMatchingSpan(expressPredicate).labels;
-        assert.equal(labels[traceLabels.HTTP_RESPONSE_CODE_LABEL_KEY], '200');
-        assert.equal(labels[traceLabels.HTTP_METHOD_LABEL_KEY], 'GET');
-        assert.equal(labels[traceLabels.HTTP_URL_LABEL_KEY], 'http://localhost/');
-        assert(labels[traceLabels.HTTP_SOURCE_IP]);
+        assert.equal(labels[TraceLabels.HTTP_RESPONSE_CODE_LABEL_KEY], '200');
+        assert.equal(labels[TraceLabels.HTTP_METHOD_LABEL_KEY], 'GET');
+        assert.equal(labels[TraceLabels.HTTP_URL_LABEL_KEY], 'http://localhost/');
+        assert(labels[TraceLabels.HTTP_SOURCE_IP]);
         done();
       });
     });
@@ -176,7 +177,7 @@ describe('test-trace-express', function() {
     server = app.listen(common.serverPort, function() {
       http.get({port: common.serverPort}, function(res) {
         var labels = common.getMatchingSpan(expressPredicate).labels;
-        var stackTrace = JSON.parse(labels[traceLabels.STACK_TRACE_DETAILS_KEY]);
+        var stackTrace = JSON.parse(labels[TraceLabels.STACK_TRACE_DETAILS_KEY]);
         // Ensure that our middleware is on top of the stack
         assert.equal(stackTrace.stack_frame[0].method_name, 'middleware');
         done();
@@ -206,7 +207,7 @@ describe('test-trace-express', function() {
     server = app.listen(common.serverPort, function() {
       http.get({port: common.serverPort}, function(res) {
         var labels = common.getMatchingSpan(expressPredicate).labels;
-        assert.equal(labels[traceLabels.HTTP_RESPONSE_CODE_LABEL_KEY], '500');
+        assert.equal(labels[TraceLabels.HTTP_RESPONSE_CODE_LABEL_KEY], '500');
         done();
       });
     });
@@ -220,7 +221,7 @@ describe('test-trace-express', function() {
     server = app.listen(common.serverPort, function() {
       http.get({port: common.serverPort}, function(res) {
         var labels = common.getMatchingSpan(expressPredicate).labels;
-        assert.equal(labels[traceLabels.HTTP_RESPONSE_CODE_LABEL_KEY], '500');
+        assert.equal(labels[TraceLabels.HTTP_RESPONSE_CODE_LABEL_KEY], '500');
         done();
       });
     });
@@ -233,14 +234,14 @@ describe('test-trace-express', function() {
     });
     server = app.listen(common.serverPort, function() {
       var headers = {};
-      headers[constants.TRACE_CONTEXT_HEADER_NAME] = '123456/1;o=1';
+      headers[Constants.TRACE_CONTEXT_HEADER_NAME] = '123456/1;o=1';
       http.get({port: common.serverPort}, function(res) {
-        assert(!res.headers[constants.TRACE_CONTEXT_HEADER_NAME]);
+        assert(!res.headers[Constants.TRACE_CONTEXT_HEADER_NAME]);
         http.get({
           port: common.serverPort,
           headers: headers
         }, function(res) {
-          assert(res.headers[constants.TRACE_CONTEXT_HEADER_NAME].indexOf(';o=1') !== -1);
+          assert(res.headers[Constants.TRACE_CONTEXT_HEADER_NAME].indexOf(';o=1') !== -1);
           done();
         });
       });

diff --git a/test/plugins/test-trace-grpc.ts b/test/plugins/test-trace-grpc.ts
@@ -15,12 +15,13 @@
  */
 'use strict';
 
+import { Constants } from '../../src/constants';
+import { TraceLabels } from '../../src/trace-labels';
+
 var assert = require('assert');
 var cls = require('../../src/cls'/*.js*/);
 var util = require('../../src/util'/*.js*/);
-var constants = require('../../src/constants'/*.js*/);
 var shimmer = require('shimmer');
-var traceLabels = require('../../src/trace-labels'/*.js*/);
 var TracingPolicy = require('../../src/tracing-policy'/*.js*/);
 var common = require('./common'/*.js*/);
 
@@ -46,7 +47,7 @@ var checkMetadata;
 
 function checkServerMetadata(metadata) {
   if (checkMetadata) {
-    var traceContext = metadata.getMap()[constants.TRACE_CONTEXT_HEADER_NAME];
+    var traceContext = metadata.getMap()[Constants.TRACE_CONTEXT_HEADER_NAME];
     assert.ok(/[a-f0-9]{32}\/[0-9]+;o=1/.test(traceContext));
     var parsedContext = util.parseContextFromHeader(traceContext);
     var root = cls.getNamespace().get('root');
@@ -550,7 +551,7 @@ Object.keys(versions).forEach(function(version) {
           function getMethodName(predicate) {
             var trace = common.getMatchingSpan(predicate);
             var labels = trace.labels;
-            var stack = JSON.parse(labels[traceLabels.STACK_TRACE_DETAILS_KEY]);
+            var stack = JSON.parse(labels[TraceLabels.STACK_TRACE_DETAILS_KEY]);
             return stack.stack_frame[0].method_name;
           }
           assert.notStrictEqual(-1, getMethodName(grpcClientPredicate)