refactor: stackdriver tsconfig - use gts (#28)

refactor: stackdriver tsconfig - use gts

Author: eduardoemery

packages/opencensus-exporter-stackdriver/package.json

@@ -39,6 +39,7 @@
   },
   "devDependencies": {
     "@types/mocha": "^2.2.48",
+    "@types/nock": "^9.1.3",
     "@types/node": "^9.4.7",
     "gts": "^0.5.1",
     "mocha": "^5.0.4",

packages/opencensus-exporter-stackdriver/src/stackdriver.ts

@@ -21,6 +21,20 @@ import {google} from 'googleapis';
 google.options({headers: {'x-opencensus-outgoing-request': 0x1}});
 const cloudTrace = google.cloudtrace('v1');
 
+type TranslatedTrace = {
+  projectId: string,
+  traceId: string,
+  spans: TranslatedSpan[]
+};
+
+type TranslatedSpan = {
+  name: string,
+  kind: string,
+  spanId: string,
+  startTime: Date,
+  endTime: Date
+};
+
 type ExporterBuffer = typeof classes.ExporterBuffer;
 
 /**
@@ -79,15 +93,15 @@ export class StackdriverTraceExporter implements types.Exporter {
           for (const root of rootSpans) {
             this.failBuffer.push(root.spanContext);
           }
-          return `${err}`;
+          return err;
         });
   }
 
   /**
    * Translates root span data to Stackdriver's trace format.
    * @param root
    */
-  private translateTrace(root: types.RootSpan) {
+  private translateTrace(root: types.RootSpan): TranslatedTrace {
     const spanList = root.spans.map(span => this.translateSpan(span));
     spanList.push(this.translateSpan(root));
 
@@ -98,7 +112,7 @@ export class StackdriverTraceExporter implements types.Exporter {
    * Translates span data to Stackdriver's span format.
    * @param span
    */
-  private translateSpan(span: types.Span) {
+  private translateSpan(span: types.Span): TranslatedSpan {
     return {
       name: span.name,
       kind: 'SPAN_KIND_UNSPECIFIED',
@@ -114,11 +128,11 @@ export class StackdriverTraceExporter implements types.Exporter {
    */
   private sendTrace(traces: TracesWithCredentials) {
     return new Promise((resolve, reject) => {
-      cloudTrace.projects.patchTraces(traces, err => {
+      cloudTrace.projects.patchTraces(traces, (err: Error) => {
         if (err) {
-          const errorMsg = `sendTrace error: ${err.message}`;
-          this.logger.error(errorMsg);
-          reject(errorMsg);
+          err.message = `sendTrace error: ${err.message}`;
+          this.logger.error(err.message);
+          reject(err);
         } else {
           const successMsg = 'sendTrace sucessfully';
           this.logger.debug(successMsg);
@@ -133,7 +147,7 @@ export class StackdriverTraceExporter implements types.Exporter {
    * authenticates the client and calls a method to send the traces data.
    * @param stackdriverTraces
    */
-  private authorize(stackdriverTraces) {
+  private authorize(stackdriverTraces: TranslatedTrace[]) {
     return auth.getApplicationDefault()
         .then((client) => {
           let authClient = client.credential as JWT;

packages/opencensus-exporter-stackdriver/test/test-stackdriver.ts

@@ -120,8 +120,8 @@ describe('Stackdriver Exporter', function() {
             span.end();
             rootSpan.end();
 
-            return exporter.publish([rootSpan]).then((result: string) => {
-              assert.ok(result.indexOf('authorize error') >= 0);
+            return exporter.publish([rootSpan]).then((result) => {
+              assert.ok(result.message.indexOf('authorize error') >= 0);
               assert.strictEqual(
                   exporter.failBuffer[0].traceId, rootSpan.spanContext.traceId);
             });
@@ -150,8 +150,8 @@ describe('Stackdriver Exporter', function() {
             span.end();
             rootSpan.end();
 
-            return failExporter.publish([rootSpan]).then((result: string) => {
-              assert.ok(result.indexOf('sendTrace error: ') >= 0);
+            return failExporter.publish([rootSpan]).then((result) => {
+              assert.ok(result.message.indexOf('sendTrace error: ') >= 0);
 
               assert.strictEqual(
                   failExporter.failBuffer[0].traceId,
@@ -172,7 +172,7 @@ describe('Stackdriver Exporter', function() {
             span.end();
             rootSpan.end();
 
-            return exporter.publish([rootSpan]).then((result: string) => {
+            return exporter.publish([rootSpan]).then((result) => {
               assert.ok(result.indexOf('sendTrace sucessfully') >= 0);
             });
           });
@@ -194,8 +194,8 @@ describe('Stackdriver Exporter', function() {
             span.end();
             rootSpan.end();
 
-            return exporter.publish([rootSpan]).then((result: string) => {
-              assert.ok(result.indexOf('Simulated Network Error') >= 0);
+            return exporter.publish([rootSpan]).then((result) => {
+              assert.ok(result.message.indexOf('Simulated Network Error') >= 0);
             });
           });
     });

packages/opencensus-exporter-stackdriver/tsconfig.json

@@ -1,4 +1,5 @@
 {
+  "extends": "./node_modules/gts/tsconfig-google.json",
   "compilerOptions": {
     "rootDir": ".",
     "outDir": "build",