fix(startup): dont start if NODE_ENV=test

Author: gergelyke

lib/index.js

@@ -6,19 +6,30 @@ var debug = require('debug')('risingstack/trace')
 
 var ConfigReader = require('./utils/configReader')
 
+var traceNoop = {
+  report: function () {},
+  reportError: function () {},
+  getTransactionId: function () {}
+}
+
 function Trace () {
+  if (process.env.NODE_ENV === 'test') {
+    return traceNoop
+  }
+
   this.configReader = ConfigReader.create()
+
   try {
     this.config = this.configReader.getConfig()
   } catch (ex) {
     console.error(format('%s trace: error: %s', new Date(), ex.message))
-    return
+    return traceNoop
   }
 
   // warn the user if the newrelic agent is present as well
   if (require.cache.__NR_cache) {
     console.error('Make sure to require Trace before New Relic, otherwise Trace won\'t start')
-    return
+    return traceNoop
   }
 
   this.agent = Agent.create({

lib/index.spec.js

@@ -1,10 +1,29 @@
 var expect = require('chai').expect
+var freshy = require('freshy')
 
 var Agent = require('./agent')
 var Instrumentation = require('./instrumentations')
 var ConfigReader = require('./utils/configReader')
 
 describe('The trace module', function () {
+  beforeEach(function () {
+    freshy.unload('./')
+  })
+
+  it('doesn\'t start in NODE_ENV=test', function () {
+    this.sandbox.stub(process, 'env', {
+      NODE_ENV: 'test'
+    })
+
+    var configReaderStub = this.sandbox.stub(ConfigReader, 'create')
+
+    var trace = require('./')
+    expect(trace.report).to.be.a('function')
+    expect(trace.reportError).to.be.a('function')
+    expect(trace.getTransactionId).to.be.a('function')
+    expect(configReaderStub).to.have.not.been.called
+  })
+
   it('initializes', function () {
     var fakeAgent = {
       name: 'agent'

package.json

@@ -27,10 +27,10 @@
   "scripts": {
     "preinstall": "npm install node-gyp-install && node-gyp-install",
     "lint": "eslint lib example e2e",
-    "test": "NODE_ENV=test npm run test-unit && npm run test-e2e",
-    "test-unit": "NODE_ENV=test mocha $(find ./lib -name \"*.spec.js\" -not -path \"./node_modules/*\")",
-    "test-cls": "NODE_ENV=test mocha $(find ./lib -name \"*.spec.e2e.js\" -not -path \"./node_modules/*\")",
-    "test-e2e": "NODE_ENV=test node ./e2e | tap-spec",
+    "test": "npm run test-unit && npm run test-e2e",
+    "test-unit": "mocha $(find ./lib -name \"*.spec.js\" -not -path \"./node_modules/*\")",
+    "test-cls": "mocha $(find ./lib -name \"*.spec.e2e.js\" -not -path \"./node_modules/*\")",
+    "test-e2e": "node ./e2e | tap-spec",
     "cover": "istanbul cover _mocha $(find ./lib -name \"*.spec.js\" -not -path \"./node_modules/*\"); open coverage/lcov-report/index.html",
     "changelog": "conventional-changelog -p angular -o CHANGELOG.md -r 500",
     "semantic-release": "semantic-release pre && npm publish && semantic-release post"
@@ -70,6 +70,7 @@
     "eslint-config-standard": "5.1.0",
     "eslint-plugin-standard": "1.3.2",
     "express": "4.13.4",
+    "fresh": "0.3.0",
     "freshy": "1.0.2",
     "ioredis": "1.15.1",
     "istanbul": "0.4.2",