Repository: ngokevin/redux-raven-middleware
Branch: master
Commit: ddd508cb7f12
Files: 8
Total size: 13.8 KB

Directory structure:
gitextract_l0m2_va_/

├── .gitignore
├── LICENSE
├── README.md
├── index.es6
├── index.js
├── package.json
├── test.es6
└── test.js

================================================
FILE CONTENTS
================================================

================================================
FILE: .gitignore
================================================
*.sw[pon]
node_modules/


================================================
FILE: LICENSE
================================================
The MIT License (MIT)

Copyright (c) 2015 Kevin Ngo

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.



================================================
FILE: README.md
================================================
# redux-raven-middleware

> Also check out [Raven for Redux](https://github.com/captbaritone/raven-for-redux).

Redux middleware for sending error reports to Sentry through raven-js.

Will automatically send an error report upon encountering a Javascript error
on dispatching any action. redux-raven-middleware will pass in the error as
well as extra information such as the action that caused the error and the
entire Redux application state.

## RavenMiddleware(sentryDSN, sentryConfig, middlewareOptions)

Creates a Raven Middleware.

- `sentryDSN` -- string representing your Sentry instance.
- `sentryConfig` -- object that will be passed into Raven.config.
- `middlewareOptions` -- object to customize the middleware:
  - `actionTransformer` -- transform the action before sending to Sentry
  - `stateTransformer` -- transform the state before sending to Sentry
  - `logger` -- log function to use instead of `console.error`

```js
import {applyMiddleware, createStore} from 'redux';
import RavenMiddleware from 'redux-raven-middleware';


const createStoreWithMiddleware = applyMiddleware(
  RavenMiddleware('my-sentry-dsn')
)(createStore);
```


================================================
FILE: index.es6
================================================
import Raven from 'raven-js';

const identity = stuff => stuff;

export default function createMiddleware(dsn, cfg={}, options={}) {
  /*
    Function that generates a crash reporter for Sentry.

    dsn - private Sentry DSN.
    cfg - object to configure Raven.
    options - customize extra data sent to sentry
      actionTransformer - tranform the action object to send; default to identity function
      stateTransformer - transform the state object to send; default to identity function
      logger - the logger to use for logging; default to console.error
  */
  if (!Raven.isSetup()) {
    if (!dsn) {
      // Skip this middleware if there is no DSN.
      console.error('[redux-raven-middleware] Sentry DSN required.');
      return store => next => action => {
        return next(action);
      };
    }
    Raven.config(dsn, cfg).install();
  }

  return store => next => action => {
    const {
      actionTransformer = identity,
      stateTransformer = identity,
      logger = console.error.bind(console, '[redux-raven-middleware] Reporting error to Sentry:')
    } = options;
    try {
      Raven.captureBreadcrumb({
        category: 'redux',
        message: action.type
      });

      return next(action);
    } catch (err) {
      logger(err);

      // Send the report.
      Raven.captureException(err, {
        extra: {
          action: actionTransformer(action),
          state: stateTransformer(store.getState()),
        }
      });
    }
  }
}


================================================
FILE: index.js
================================================
'use strict';

Object.defineProperty(exports, '__esModule', {
  value: true
});
exports['default'] = createMiddleware;

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }

var _ravenJs = require('raven-js');

var _ravenJs2 = _interopRequireDefault(_ravenJs);

var identity = function identity(stuff) {
  return stuff;
};

function createMiddleware(dsn) {
  var cfg = arguments.length <= 1 || arguments[1] === undefined ? {} : arguments[1];
  var options = arguments.length <= 2 || arguments[2] === undefined ? {} : arguments[2];

  /*
    Function that generates a crash reporter for Sentry.
     dsn - private Sentry DSN.
    cfg - object to configure Raven.
    options - customize extra data sent to sentry
      actionTransformer - tranform the action object to send; default to identity function
      stateTransformer - transform the state object to send; default to identity function
      logger - the logger to use for logging; default to console.error
  */
  if (!_ravenJs2['default'].isSetup()) {
    if (!dsn) {
      // Skip this middleware if there is no DSN.
      console.error('[redux-raven-middleware] Sentry DSN required.');
      return function (store) {
        return function (next) {
          return function (action) {
            next(action);
          };
        };
      };
    }
    _ravenJs2['default'].config(dsn, cfg).install();
  }

  return function (store) {
    return function (next) {
      return function (action) {
        var _options$actionTransformer = options.actionTransformer;
        var actionTransformer = _options$actionTransformer === undefined ? identity : _options$actionTransformer;
        var _options$stateTransformer = options.stateTransformer;
        var stateTransformer = _options$stateTransformer === undefined ? identity : _options$stateTransformer;
        var _options$logger = options.logger;
        var logger = _options$logger === undefined ? console.error.bind(console, '[redux-raven-middleware] Reporting error to Sentry:') : _options$logger;

        try {
          _ravenJs2['default'].captureBreadcrumb({
            category: 'redux',
            message: action.type
          });

          return next(action);
        } catch (err) {
          logger(err);

          // Send the report.
          _ravenJs2['default'].captureException(err, {
            extra: {
              action: actionTransformer(action),
              state: stateTransformer(store.getState())
            }
          });
        }
      };
    };
  };
}

module.exports = exports['default'];


================================================
FILE: package.json
================================================
{
  "name": "redux-raven-middleware",
  "version": "1.2.1",
  "description": "Redux middleware for sending error reports to Sentry through raven-js.",
  "main": "./index.js",
  "dependencies": {
    "raven-js": "^3.1.1"
  },
  "devDependencies": {
    "babel": "^5.4.7",
    "babel-runtime": "^5.8.20",
    "mocha": "^2.2.5",
    "sinon": "^1.16.1"
  },
  "scripts": {
    "build:lib": "babel --stage 0 index.es6 -o index.js",
    "pretest": "babel --stage 0 test.es6 -o test.js && npm run build:lib",
    "test": "mocha test.js",
    "prepublish": "npm run build:lib"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/ngokevin/redux-raven-middleware"
  },
  "keywords": [
    "react",
    "redux",
    "raven",
    "raven-js",
    "sentry",
    "middleware",
    "crash",
    "error",
    "report"
  ],
  "author": "Kevin Ngo <me@ngokevin.com>",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/ngokevin/redux-raven-middleware/issues"
  },
  "homepage": "https://github.com/ngokevin/redux-raven-middleware"
}


================================================
FILE: test.es6
================================================
import assert from 'assert';
import sinon from 'sinon';


const stubStore = {
  getState: () => ({test: 'test'})
};

const mockNextHandler = action => {
  if (action.error) {
    throw new Error('Test Error');
  }
};


describe('createRavenMiddleware', () => {
  const createRavenMiddleware = require('./index');
  const Raven = require('raven-js');
  const ravenSpy = sinon.spy(Raven, 'captureException');

  beforeEach(() => {
    sinon.stub(Raven, 'config', () => {
      return {install: () => {}}
    });
  });
  afterEach(() => {
    Raven.config.restore();
    ravenSpy.reset();
  });

  it('returns middleware', () => {
    assert.equal(createRavenMiddleware.constructor, Function);
  });

  it('middleware returns nextHandler', () => {
    const nextHandler = createRavenMiddleware('abc')(stubStore);
    assert.equal(nextHandler.constructor, Function);
  });

  it('nextHandler returns actionHandler', () => {
    const actionHandler = createRavenMiddleware('abc')(stubStore)();
    assert.equal(actionHandler.constructor, Function);
    assert.equal(actionHandler.length, 1);
  });

  it('configures Raven', done => {
    Raven.config.restore();
    sinon.stub(Raven, 'config', (dsn, cfg) => {
      assert.equal(dsn, 'abc');
      assert.deepEqual(cfg, {tags: {test: 'test'}});
      done();

      return {install: () => {}};
    });
    createRavenMiddleware('abc', {tags: {test: 'test'}})
  });

  it('reports error', () => {
    createRavenMiddleware('abc')(stubStore)(mockNextHandler)({error: true});

    assert.equal(ravenSpy.args[0][0].constructor, Error);
    assert.equal(ravenSpy.args[0][0].message, 'Test Error');
    assert.deepEqual(ravenSpy.args[0][1].extra.action, {error: true});
    assert.deepEqual(ravenSpy.args[0][1].extra.state, {test: 'test'});
  });

  it('reports error with transformed state and action', () => {
    const actionTransformer = action => action.error
    const stateTransformer = state => state.test
    const cfg = {}
    const opts = { actionTransformer, stateTransformer }
    createRavenMiddleware('abc', cfg, opts)(stubStore)(mockNextHandler)({error: true});

    assert.equal(ravenSpy.args[0][0].constructor, Error);
    assert.equal(ravenSpy.args[0][0].message, 'Test Error');
    assert.equal(ravenSpy.args[0][1].extra.action, true);
    assert.equal(ravenSpy.args[0][1].extra.state, 'test');
  });

  it('logs via custom logger', () => {
    const logger = sinon.spy()
    const cfg = {}
    const opts = { logger }
    createRavenMiddleware('abc', cfg, opts)(stubStore)(mockNextHandler)({error: true});

    assert.equal(ravenSpy.args[0][0].constructor, Error);
    assert.equal(ravenSpy.args[0][0].message, 'Test Error');
    assert.deepEqual(ravenSpy.args[0][1].extra.action, {error: true});
    assert.deepEqual(ravenSpy.args[0][1].extra.state, {test: 'test'});
    assert(logger.calledOnce, 'logs one message')
    assert.equal(logger.args[0][0], ravenSpy.args[0][0])
  });
});


================================================
FILE: test.js
================================================
'use strict';

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }

var _assert = require('assert');

var _assert2 = _interopRequireDefault(_assert);

var _sinon = require('sinon');

var _sinon2 = _interopRequireDefault(_sinon);

var stubStore = {
  getState: function getState() {
    return { test: 'test' };
  }
};

var mockNextHandler = function mockNextHandler(action) {
  if (action.error) {
    throw new Error('Test Error');
  }
};

describe('createRavenMiddleware', function () {
  var createRavenMiddleware = require('./index');
  var Raven = require('raven-js');
  var ravenSpy = _sinon2['default'].spy(Raven, 'captureException');

  beforeEach(function () {
    _sinon2['default'].stub(Raven, 'config', function () {
      return { install: function install() {} };
    });
  });
  afterEach(function () {
    Raven.config.restore();
    ravenSpy.reset();
  });

  it('returns middleware', function () {
    _assert2['default'].equal(createRavenMiddleware.constructor, Function);
  });

  it('middleware returns nextHandler', function () {
    var nextHandler = createRavenMiddleware('abc')(stubStore);
    _assert2['default'].equal(nextHandler.constructor, Function);
  });

  it('nextHandler returns actionHandler', function () {
    var actionHandler = createRavenMiddleware('abc')(stubStore)();
    _assert2['default'].equal(actionHandler.constructor, Function);
    _assert2['default'].equal(actionHandler.length, 1);
  });

  it('configures Raven', function (done) {
    Raven.config.restore();
    _sinon2['default'].stub(Raven, 'config', function (dsn, cfg) {
      _assert2['default'].equal(dsn, 'abc');
      _assert2['default'].deepEqual(cfg, { tags: { test: 'test' } });
      done();

      return { install: function install() {} };
    });
    createRavenMiddleware('abc', { tags: { test: 'test' } });
  });

  it('reports error', function () {
    createRavenMiddleware('abc')(stubStore)(mockNextHandler)({ error: true });

    _assert2['default'].equal(ravenSpy.args[0][0].constructor, Error);
    _assert2['default'].equal(ravenSpy.args[0][0].message, 'Test Error');
    _assert2['default'].deepEqual(ravenSpy.args[0][1].extra.action, { error: true });
    _assert2['default'].deepEqual(ravenSpy.args[0][1].extra.state, { test: 'test' });
  });

  it('reports error with transformed state and action', function () {
    var actionTransformer = function actionTransformer(action) {
      return action.error;
    };
    var stateTransformer = function stateTransformer(state) {
      return state.test;
    };
    var cfg = {};
    var opts = { actionTransformer: actionTransformer, stateTransformer: stateTransformer };
    createRavenMiddleware('abc', cfg, opts)(stubStore)(mockNextHandler)({ error: true });

    _assert2['default'].equal(ravenSpy.args[0][0].constructor, Error);
    _assert2['default'].equal(ravenSpy.args[0][0].message, 'Test Error');
    _assert2['default'].equal(ravenSpy.args[0][1].extra.action, true);
    _assert2['default'].equal(ravenSpy.args[0][1].extra.state, 'test');
  });

  it('logs via custom logger', function () {
    var logger = _sinon2['default'].spy();
    var cfg = {};
    var opts = { logger: logger };
    createRavenMiddleware('abc', cfg, opts)(stubStore)(mockNextHandler)({ error: true });

    _assert2['default'].equal(ravenSpy.args[0][0].constructor, Error);
    _assert2['default'].equal(ravenSpy.args[0][0].message, 'Test Error');
    _assert2['default'].deepEqual(ravenSpy.args[0][1].extra.action, { error: true });
    _assert2['default'].deepEqual(ravenSpy.args[0][1].extra.state, { test: 'test' });
    (0, _assert2['default'])(logger.calledOnce, 'logs one message');
    _assert2['default'].equal(logger.args[0][0], ravenSpy.args[0][0]);
  });
});