fix(test): Suppress logs when NODE_ENV=test

[spencerwilson-optimizely]

Summary

• Ensure console isn't logged to during unit tests
• Refactor createInstance tests.
• Delete superfluous indent in lib/optimizely > constructor tests. When viewing the diff in GitHub, try the 'Hide whitespace changes' option to make this diff clearer.
• Simplify npm test definition. The bug here before was a lack of 'single quotes' around the glob pattern, which prevent glob expansion by bash (the interpreter of npm run-scripts).
• Add *.swp (vim temporary files) to gitignore

The status quo is noise like this. Now,

$ npm test

> @optimizely/optimizely-sdk@2.1.1 test /Users/swilson/code/javascript-sdk/packages/optimizely-sdk
> NODE_ENV=test mocha --reporter dot './lib/**/*.tests.js'



  ․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․
  ․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․sandbox.stub(obj, 'meth', val) is deprecated and will be removed from the public API in a future version of sinon.
 Use sandbox.stub(obj, 'meth').callsFake(fn) instead in order to stub a function.
 Use sandbox.stub(obj, 'meth').value(fn) instead in order to stub a non-function value.
sinon.stub(obj, 'meth', fn) is deprecated and will be removed from the public API in a future version of sinon.
 Use stub(obj, 'meth').callsFake(fn).
 Codemod available at https://github.com/hurrymaplelad/sinon-codemod
․sandbox.stub(obj, 'meth', val) is deprecated and will be removed from the public API in a future version of sinon.
 Use sandbox.stub(obj, 'meth').callsFake(fn) instead in order to stub a function.
 Use sandbox.stub(obj, 'meth').value(fn) instead in order to stub a non-function value.
sinon.stub(obj, 'meth', fn) is deprecated and will be removed from the public API in a future version of sinon.
 Use stub(obj, 'meth').callsFake(fn).
 Codemod available at https://github.com/hurrymaplelad/sinon-codemod
․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․
  ․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․․

  372 passing (616ms)

With the noise removed, deprecation warnings from Sinon are now clearly visible. Hooray!

Initially I wanted to avoid putting the NODE_ENV stuff inside the logger module, instead trying to stub logger.createInstance in the appropriate places in the tests. Down this path, I discovered that one issue was that, though the logger in most (all?) tests is properly stubbed, the optlyInstance is often constructed before the createdLogger.log method is stubbed (example), which yields the symptom of lots of log messages like

[OPTIMIZELY] - INFO Tue Jul 03 2018 22:52:25 GMT+0000 (Coordinated Universal Time) OPTIMIZELY: Datafile is valid.

making it through before the stub. (See how many of these are in the example build link above.)

I tried moving the optlyInstance construction after createdLogger.log was stubbed, but that caused all of the many assertions like this one to start to fail. This was kind of a bummer and I'm not sure how much value asserting exact text of log messages adds, so at this point I pivoted to the NODE_ENV approach.

Test plan

In the master branch, there are 371 tests. In this branch, 372. That's from the createInstance refactor, which net created 1 new test:

  optimizelyFactory
    APIs
      createInstance
        ✓ should create an instance of optimizely
        config fails validation
          ✓ catches internal errors
          a logger was supplied
            ✓ an error message is submitted to the supplied logger
          a logger was not supplied
            ✓ an error message is submitted to a simple logger

[coveralls]

Coverage decreased (-0.03%) to 97.078% when pulling 8d0957c on sw/supress-test-logs into 6a3c9a5 on master.

[spencerwilson-optimizely]

This is ready for review, please.

[tylerbrandt]

nit: I would make the message something like "submits an error message to the supplied logger" so it reads better in combination with the context.

[tylerbrandt]

nit: Could we not just configure the test to set the logLevel to enums.LOG_LEVEL.ERROR + 1 (or some other really high value)? Then you wouldn't have to mess with the env in the logger test.

[mikeproeng37]

Obsolete