Bug fixes (#3)

* bug fixes for handling tag values of float-type

* minor improvement in the code comments

* adding tslint

* adding caller's span context option to startSpan

Author: ashishagg

Makefile

@@ -12,11 +12,15 @@ check-node-version:
 	@$(MIN_NODE_VER_FOUND) || echo Build requires minimum Node $(MIN_NODE_VER).x
 
 .PHONY: build
-build: check-node-version npm_install idl_codegen
+build: check-node-version npm_install idl_codegen tslint
 	rm -rf ./dist/
 	tsc -p tsconfig.json
 	cp package.json dist/
 
+.PHONY: tslnt
+tslint:
+	$(shell ./node_modules/tslint/bin/tslint -t msbuild -c tslint.json 'src/**/*.ts')
+
 .PHONY: idl_codegen
 idl_codegen:
 	rm -rf src/proto_idl_codegen
@@ -33,5 +37,5 @@ npm_install:
 example: build
 	mkdir -p logs
 	rm -rf logs/spans
-	node dist/examples/index.js
+	node examples/index.js
 	cat logs/spans

README.md

@@ -8,7 +8,7 @@ This is Haystack's client library for Nodejs that implements [OpenTracing API 1.
 
 ## How to use the library?
 
-Check our detailed [example](src/examples/) on how to initialize tracer, start a span and send it to one of the dispatchers.
+Check our detailed [example](examples/index.js) on how to initialize tracer, start a span and send it to one of the dispatchers.
 
 
 ## How to build this library?

src/examples/index.js examples/index.jssrc/examples/index.js renamed to examples/index.js

@@ -15,16 +15,17 @@
  */
 
 
-/// first do `npm install haystack-client`
-const initTracer = require('../index').initTracer;
-const opentracing = require('opentracing');
-import MyLogger from "./logger";
+"use strict";
 
+/// first do `npm install haystack-client` and replace '../dist/index' with 'haystack-client'
+const initTracer = require('../dist/index').initTracer;
+const opentracing = require('opentracing');
+const MyLogger = require('./logger');
 
 /// setup a logger. if you skip providing logger to config, the library will not spit any errors, warning or info
 /// you can provide the logger object already configured in your service, provided it has 4 methods defined:
 // debug(msg), info(msg), error(msg), warn(msg)
-const logger = new MyLogger();
+const logger = new MyLogger.default();
 
 
 /// setup the config object required for initializing Tracer
@@ -42,7 +43,7 @@ const config = {
         // or
 
         // type: 'haystack_agent',
-        // agentHost: 'haystack-agent',
+        // agentHost: '192.168.99.100',
         // agentPort: '35000'
     },
     logger: logger
@@ -53,26 +54,34 @@ const tracer = initTracer(config);
 
 /// now create a span, for e.g. at the time of incoming REST call.
 /// Make sure to add SPAN_KIND tag. Possible values are 'server' or 'client'.
+/// Important: if you are receiving TraceId, SpanId, ParentSpanId in the http headers or message payload of your incoming REST call,
+/// then set it in the callerSpanContext
+
 const serverSpan = tracer
-    .startSpan('dummy-operation')
+    .startSpan('dummy-operation', {
+        callerSpanContext: {
+            _traceId: '1848fadd-fa16-4b3e-8ad1-6d73339bbee7',
+            _spanId: '7a7cc5bf-796e-4527-9b42-13ae5766c6fd',
+            _parentSpanId: 'e96de653-ad6e-4ad5-b437-e81fd9d2d61d'
+        }
+    })
     .setTag(opentracing.Tags.SPAN_KIND, 'server')
     .setTag(opentracing.Tags.HTTP_METHOD, 'GET');
 
+/// Or if you are the root service, skip callerSpanContext and use the following
+
+// const serverSpan = tracer
+//     .startSpan('dummy-operation')
+//     .setTag(opentracing.Tags.SPAN_KIND, 'server')
+//     .setTag(opentracing.Tags.HTTP_METHOD, 'GET');
 
 
-/// Important:
-//  if you are receiving TraceId, SpanId, ParentSpanId in the http headers or message payload of your incoming REST call,
-/// then update the IDs in the span context, else tracer will use the unique TraceId and SpanId.
-/*
-  serverSpan.context().setTraceId(<TRACE ID> );
-  serverSpan.context().setSpanId(<SPAN ID>);
-  serverSpan.context().setParentSpanId(<PARENT SPAN ID>);
-*/
 
 
 /// now say service is calling downstream service, then you start another span - a client span
 /// since this span is a child of the main serverSpan, so pass it along as `childOf` attribute.
 /// library will setup the traceId, spanId and parentSpanId by itself.
+/// You dont need to set the callerSpanContext if you are setting childOf
 const clientChildSpan = tracer.startSpan('downstream-service-call', {
     childOf: serverSpan,
     tags: {
@@ -82,9 +91,11 @@ const clientChildSpan = tracer.startSpan('downstream-service-call', {
 
 
 /// add more tags or logs to your spans
-clientChildSpan.setTag(opentracing.Tags.ERROR, false);
-serverSpan.setTag(opentracing.Tags.ERROR, false);
+clientChildSpan.setTag(opentracing.Tags.ERROR, true);
+clientChildSpan.setTag(opentracing.Tags.HTTP_STATUS_CODE, 503);
 
+serverSpan.setTag(opentracing.Tags.ERROR, true);
+serverSpan.setTag('my-custom-tag', 10.5);
 
 /// finish the downstream call span. This will publish the span to either file or haystack-agent
 clientChildSpan.finish();
@@ -93,4 +104,6 @@ clientChildSpan.finish();
 serverSpan.finish();
 
 /// close the tracer at the time of service shutdown
-tracer.close();
+setTimeout(() => {
+    tracer.close();
+}, 3000);

src/examples/logger.js examples/logger.jssrc/examples/logger.js renamed to examples/logger.js

@@ -14,22 +14,24 @@
  *       limitations under the License.
  */
 
-export default class MyLogger {
-    constructor() {}
+"use strict";
 
-    debug(message) {
-        console.log(message);
+const MyLogger = (function () {
+    function MyLogger() {
     }
-
-    info(message) {
+    MyLogger.prototype.debug = function (message) {
         console.log(message);
-    }
-
-    warn(message) {
+    };
+    MyLogger.prototype.info = function (message) {
         console.log(message);
-    }
-
-    error(message) {
+    };
+    MyLogger.prototype.warn = function (message) {
         console.log(message);
-    }
-}
+    };
+    MyLogger.prototype.error = function (message) {
+        console.log(message);
+    };
+    return MyLogger;
+}());
+
+exports.default = MyLogger;

package.json

@@ -13,6 +13,9 @@
     "type": "git",
     "url": "git://github.com/ExpediaDotCom/haystack-client-node.git"
   },
+  "scripts": {
+    "lint": "tslint -t msbuild -c tslint.json 'src/**/*.ts'"
+  },
   "contributors": [
     "Haystack <haystack@expedia.com>"
   ],
@@ -25,6 +28,7 @@
   "devDependencies": {
     "@types/node": "^10.3.4",
     "typescript": "2.9.2",
-    "grpc-tools": "1.6.6"
+    "grpc-tools": "1.6.6",
+    "tslint": "^5.0.0"
   }
 }

src/configuration.ts

@@ -14,16 +14,16 @@
  *       limitations under the License.
  */
 
-import FileDispatcher from "./dispatchers/file";
-import RemoteDispatcher from "./dispatchers/remote";
-import {Dispatcher} from "./dispatchers/dispatcher";
-import InMemoryDispatcher from "./dispatchers/in_memory";
-import NoopDispatcher from "./dispatchers/noop";
+import FileDispatcher from './dispatchers/file';
+import RemoteDispatcher from './dispatchers/remote';
+import {Dispatcher} from './dispatchers/dispatcher';
+import InMemoryDispatcher from './dispatchers/in_memory';
+import NoopDispatcher from './dispatchers/noop';
 
 export default class Configuration {
     static _getDispatcher(config): Dispatcher {
 
-        let dispatcher = config.dispatcher;
+        const dispatcher = config.dispatcher;
         if (dispatcher) {
             switch (dispatcher.type) {
                 case 'file':

src/dispatchers/composite_dispatchers.ts

@@ -14,10 +14,10 @@
  *       limitations under the License.
  */
 
-import Span from "../span";
+import Span from '../span';
 
 export interface Dispatcher {
-    name(): string
-    dispatch(span: Span): void
-    close(callback: () => void): void
-}
+    name(): string;
+    dispatch(span: Span): void;
+    close(callback: () => void): void;
+}

src/dispatchers/dispatcher.ts

@@ -14,34 +14,33 @@
  *       limitations under the License.
  */
 
-import * as fs from "fs";
-import Span from "../span";
-import {Dispatcher} from "./dispatcher";
+import * as fs from 'fs';
+import Span from '../span';
+import {Dispatcher} from './dispatcher';
 
 export default class FileDispatcher implements Dispatcher {
     _spanFileStream: fs.WriteStream;
 
     constructor(_filePath: string) {
-        if(!_filePath) {
+        if (!_filePath) {
             throw new Error(`Fail to create file dispatcher without valid 'filePath' in the config`);
         }
-        this._spanFileStream = fs.createWriteStream(_filePath, { 'flags': 'a' });
+        this._spanFileStream = fs.createWriteStream(_filePath, { flags: 'a' });
     }
 
-    name() {
-        return "FileDispatcher";
+    name(): string {
+        return 'FileDispatcher';
     }
 
-    dispatch(span: Span) {
+    dispatch(span: Span): void {
         this._spanFileStream.write(span.toString());
-        this._spanFileStream.write("\n");
+        this._spanFileStream.write('\n');
     }
 
-    close(callback: () => void) {
-        this._spanFileStream.end("\n");
+    close(callback: () => void): void {
+        this._spanFileStream.end('\n');
         if (callback) {
             callback();
         }
     }
 }
-

src/dispatchers/file.ts

@@ -14,25 +14,25 @@
  *       limitations under the License.
  */
 
-import Span from "../span";
-import {Dispatcher} from "./dispatcher";
+import Span from '../span';
+import {Dispatcher} from './dispatcher';
 
 export default class InMemoryDispatcher implements Dispatcher {
-    _spans: Array<Span>;
+    _spans: Span[];
 
     constructor() {
         this._spans = [];
     }
 
-    name() {
-        return "InMemoryDispatcher";
+    name(): string {
+        return 'InMemoryDispatcher';
     }
 
-    dispatch(span: Span) {
+    dispatch(span: Span): void {
         this._spans.push(span);
     }
 
-    close(callback: () => void) {
+    close(callback: () => void): void {
         if (callback) {
             callback();
         }