add http request + test utilities

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   lint:
     docker:
-      - image: mhart/alpine-node
+      - image: node:alpine
     working_directory: ~/dd-trace-js
     steps:
       - checkout
@@ -17,7 +17,7 @@ jobs:
           command: npm run lint
   build-node-base: &node-base
     docker:
-      - image: mhart/alpine-node
+      - image: node:alpine
     working_directory: ~/dd-trace-js
     steps:
       - checkout
@@ -33,34 +33,27 @@ jobs:
       - run:
           name: Benchmark
           command: npm run bench
-  build-node-0.10:
-    <<: *node-base
-    docker:
-      - image: mhart/alpine-node:0.10
-  build-node-0.12:
-    <<: *node-base
-    docker:
-      - image: mhart/alpine-node:0.12
   build-node-4:
     <<: *node-base
     docker:
-      - image: mhart/alpine-node:4
+      - image: node:4-alpine
   build-node-6:
     <<: *node-base
     docker:
-      - image: mhart/alpine-node:6
+      - image: node:6-alpine
   build-node-8:
     <<: *node-base
     docker:
-      - image: mhart/alpine-node:8
+      - image: node:8-alpine
+  build-node-latest:
+    <<: *node-base
 
 workflows:
   version: 2
   build:
     jobs:
       - lint
-      - build-node-0.10
-      - build-node-0.12
       - build-node-4
       - build-node-6
       - build-node-8
+      - build-node-latest

.eslintignore

@@ -0,0 +1 @@
+coverage

.eslintrc.json

@@ -11,7 +11,9 @@
   },
   "rules": {
     "max-len": [2, 120, 2],
+    "no-var": 2,
     "no-console": 2,
+    "prefer-const": 2,
     "object-curly-spacing": [2, "always"]
   }
 }

.nvmrc

@@ -1 +1 @@
-0.10
+4

README.md

@@ -39,11 +39,6 @@ To run the linter, use:
 $ npm run lint
 ```
 
-**Note:** ESLint only supports Node >= 4, so make sure you are using
-a compatible Node version before running this command. We also
-recommend using a plugin on your editor instead of constantly running
-this command.
-
 ### Continuous Integration
 
 We rely on CircleCI 2.0 for our tests. If you want to test how the CI behaves
@@ -54,11 +49,10 @@ After installing the `circleci` CLI, simply run one of the following:
 
 ```sh
 $ circleci build --job lint
-$ circleci build --job build-node-0.10
-$ circleci build --job build-node-0.12
 $ circleci build --job build-node-4
 $ circleci build --job build-node-6
 $ circleci build --job build-node-8
+$ circleci build --job build-node-latest
 ```
 
 ### Benchmarks

benchmark/index.js

@@ -1,16 +1,16 @@
 'use strict'
 
-var Benchmark = require('benchmark')
-var DatadogTracer = require('../src/opentracing/tracer')
+const Benchmark = require('benchmark')
+const DatadogTracer = require('../src/opentracing/tracer')
 
-var suite = new Benchmark.Suite()
-var tracer = new DatadogTracer()
+const suite = new Benchmark.Suite()
+const tracer = new DatadogTracer()
 
 suite
-  .add('DatadogTracer#startSpan', function () {
+  .add('DatadogTracer#startSpan', () => {
     tracer.startSpan()
   })
-  .on('cycle', function (event) {
+  .on('cycle', event => {
     console.log(String(event.target)) // eslint-disable-line no-console
   })
   .run({ 'async': true })

index.js

@@ -1,7 +1,8 @@
 'use strict'
 
-var DatadogTracer = require('./src/opentracing/tracer')
+const platform = require('./src/platform')
+const node = require('./src/platform/node')
 
-module.exports = {
-  Tracer: DatadogTracer
-}
+platform.use(node)
+
+module.exports = {}

package.json

@@ -7,7 +7,7 @@
     "bench": "node benchmark",
     "lint": "eslint .",
     "tdd": "mocha --watch",
-    "test": "mocha"
+    "test": "nyc mocha"
   },
   "repository": {
     "type": "git",
@@ -25,19 +25,27 @@
     "url": "https://github.com/DataDog/dd-trace-js/issues"
   },
   "homepage": "https://github.com/DataDog/dd-trace-js#readme",
+  "engines": {
+    "node": ">=4"
+  },
   "dependencies": {
-    "inherits": "^2.0.3",
-    "opentracing": "^0.14.1"
+    "opentracing": "^0.14.1",
+    "safe-buffer": "^5.1.1"
   },
   "devDependencies": {
     "benchmark": "^2.1.4",
-    "chai": "^3.4.1",
+    "chai": "^4.1.2",
     "eslint": "^4.15.0",
     "eslint-config-standard": "^11.0.0-beta.0",
     "eslint-plugin-import": "^2.8.0",
     "eslint-plugin-node": "^5.2.1",
     "eslint-plugin-promise": "^3.6.0",
     "eslint-plugin-standard": "^3.0.1",
-    "mocha": "^2.4.5"
+    "mocha": "^5.0.0",
+    "nock": "^9.1.6",
+    "nyc": "^11.4.1",
+    "proxyquire": "^1.8.0",
+    "sinon": "^4.2.1",
+    "sinon-chai": "^2.14.0"
   }
 }

src/opentracing/tracer.js

@@ -1,12 +1,7 @@
 'use strict'
 
-var inherits = require('inherits')
-var Tracer = require('opentracing').Tracer
+const Tracer = require('opentracing').Tracer
 
-inherits(DatadogTracer, Tracer)
-
-function DatadogTracer () {
-  Tracer.call(this)
-}
+class DatadogTracer extends Tracer {}
 
 module.exports = DatadogTracer

src/platform/index.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = {
+  use (impl) {
+    Object.assign(this, impl)
+  }
+}

src/platform/node/index.js

@@ -0,0 +1,40 @@
+'use strict'
+
+const http = require('http')
+
+module.exports = {
+  request (options, callback) {
+    options = Object.assign({
+      headers: {},
+      timeout: 2000
+    }, options)
+
+    options.headers['Content-Length'] = byteLength(options.data)
+
+    return new Promise((resolve, reject) => {
+      const req = http.request(options, res => {
+        res.on('data', chunk => {})
+        res.on('end', () => {
+          if (res.statusCode >= 200 && res.statusCode <= 299) {
+            resolve()
+          } else {
+            const error = new Error(http.STATUS_CODES[res.statusCode])
+            error.status = res.statusCode
+
+            reject(error)
+          }
+        })
+      })
+
+      req.setTimeout(options.timeout, req.abort)
+      req.on('error', reject)
+
+      req.write(options.data)
+      req.end()
+    })
+  }
+}
+
+function byteLength (data) {
+  return data ? data.length : 0
+}

test/.eslintrc.json

@@ -0,0 +1,17 @@
+{
+  "extends": [
+    "../.eslintrc.json"
+  ],
+  "env": {
+    "mocha": true
+  },
+  "globals": {
+    "expect": true,
+    "sinon": true,
+    "proxyquire": true,
+    "nock": true
+  },
+  "rules": {
+    "no-unused-expressions": 0
+  }
+}

test/mocha.opts

@@ -1 +1,2 @@
+--require test/setup.js
 test/**/*.spec.js

test/opentracing/api.spec.js

@@ -1,8 +1,6 @@
 'use strict'
 
-var apiCompatibilityChecks = require('opentracing/lib/test/api_compatibility').default
-var DatadogTracer = require('../../src/opentracing/tracer')
+const apiCompatibilityChecks = require('opentracing/lib/test/api_compatibility').default
+const DatadogTracer = require('../../src/opentracing/tracer')
 
-apiCompatibilityChecks(function () {
-  return new DatadogTracer({ service: 'test' })
-})
+apiCompatibilityChecks(() => new DatadogTracer({ service: 'test' }))

test/platform/node/index.spec.js

@@ -0,0 +1,90 @@
+'use strict'
+
+const Buffer = require('safe-buffer').Buffer
+
+describe('Node Platform', () => {
+  let platform
+
+  beforeEach(() => {
+    platform = require('../../../src/platform/node')
+  })
+
+  describe('request', () => {
+    it('should send an http request with a buffer', () => {
+      nock('http://test:123', {
+        reqheaders: {
+          'content-type': 'application/octet-stream',
+          'content-length': '13'
+        }
+      })
+        .put('/path', { foo: 'bar' })
+        .reply(200)
+
+      return platform.request({
+        protocol: 'http:',
+        hostname: 'test',
+        port: 123,
+        path: '/path',
+        method: 'PUT',
+        headers: {
+          'Content-Type': 'application/octet-stream'
+        },
+        data: Buffer.from(JSON.stringify({ foo: 'bar' }))
+      })
+    })
+
+    it('should handle an http error', done => {
+      nock('http://localhost:80')
+        .put('/path')
+        .reply(400)
+
+      platform
+        .request({
+          path: '/path',
+          method: 'PUT'
+        })
+        .catch(err => {
+          expect(err).to.be.instanceof(Error)
+          expect(err.status).to.equal(400)
+          done()
+        })
+    })
+
+    it('should timeout after 5 seconds by default', done => {
+      nock('http://localhost:80')
+        .put('/path')
+        .socketDelay(5001)
+        .reply(200)
+
+      platform
+        .request({
+          path: '/path',
+          method: 'PUT'
+        })
+        .catch(err => {
+          expect(err).to.be.instanceof(Error)
+          expect(err.code).to.equal('ECONNRESET')
+          done()
+        })
+    })
+
+    it('should have a configurable timeout', done => {
+      nock('http://localhost:80')
+        .put('/path')
+        .socketDelay(2001)
+        .reply(200)
+
+      platform
+        .request({
+          path: '/path',
+          method: 'PUT',
+          timeout: 2000
+        })
+        .catch(err => {
+          expect(err).to.be.instanceof(Error)
+          expect(err.code).to.equal('ECONNRESET')
+          done()
+        })
+    })
+  })
+})

test/setup.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const sinon = require('sinon')
+const chai = require('chai')
+const sinonChai = require('sinon-chai')
+const proxyquire = require('proxyquire')
+const nock = require('nock')
+
+chai.use(sinonChai)
+nock.disableNetConnect()
+
+global.sinon = sinon
+global.expect = chai.expect
+global.proxyquire = proxyquire.noCallThru()
+global.nock = nock