raven.client.js

var raven = require('../')
  , fs = require('fs')
  , nock = require('nock');

var dsn = 'https://public:private@app.getsentry.com/269';

function wait(scope, done) {
    setTimeout(function() {
        scope.done(); done();
    }, 10);
}

describe('raven.version', function(){
    it('should be valid', function(){
        raven.version.should.match(/^\d+\.\d+\.\d+(-\w+)?$/);
    });
});

describe('raven.Client', function(){
    var client;
    before(function(){
        client = new raven.Client(dsn);
    });

    it('should parse the DSN with options', function(){
        var expected = {
            protocol: 'https',
            public_key: 'public',
            private_key: 'private',
            host: 'app.getsentry.com',
            path: '',
            project_id: 269
        };
        var client = new raven.Client(dsn, {name: 'YAY!', site:'Googlez'});
        client.dsn.should.eql(expected);
        client.name.should.equal('YAY!');
        client.site.should.equal('Googlez');
    });

    it('should pull SENTRY_DSN from environment', function(){
        var expected = {
            protocol: 'https',
            public_key: 'abc',
            private_key: '123',
            host: 'app.getsentry.com',
            path: '',
            project_id: 1
        };
        process.env.SENTRY_DSN='https://abc:123@app.getsentry.com/1';
        var client = new raven.Client();
        client.dsn.should.eql(expected);
        delete process.env.SENTRY_DSN; // gotta clean up so it doesn't leak into other tests
    });

    it('should pull SENTRY_DSN from environment when passing options', function(){
        var expected = {
            protocol: 'https',
            public_key: 'abc',
            private_key: '123',
            host: 'app.getsentry.com',
            path: '',
            project_id: 1
        };
        process.env.SENTRY_DSN='https://abc:123@app.getsentry.com/1';
        var client = new raven.Client({name: 'YAY!'});
        client.dsn.should.eql(expected);
        client.name.should.equal('YAY!');
        delete process.env.SENTRY_DSN; // gotta clean up so it doesn't leak into other tests
    });

    it('should pull SENTRY_NAME from environment', function(){
        process.env.SENTRY_NAME='new_name';
        var client = new raven.Client(dsn);
        client.name.should.eql('new_name');
        delete process.env.SENTRY_NAME;
    });

    it('should pull SENTRY_SITE from environment', function(){
        process.env.SENTRY_SITE='Googlez';
        var client = new raven.Client(dsn);
        client.site.should.eql('Googlez');
        delete process.env.SENTRY_SITE;
    });

    describe('#getIdent()', function(){
        it('should match', function(){
            var result = {
                id: 'c988bf5cb7db4653825c92f6864e7206',
                checksum: 'b8a6fbd29cc9113a149ad62cf7e0ddd5'
            };
            client.getIdent(result).should.equal('c988bf5cb7db4653825c92f6864e7206$b8a6fbd29cc9113a149ad62cf7e0ddd5');
        });
    });

    describe('#captureMessage()', function(){
        it('should send a plain text message to Sentry server', function(done){
            var scope = nock('https://app.getsentry.com')
                .filteringRequestBody(/.*/, '*')
                .post('/api/store/', '*')
                .reply(200, 'OK');

            client.captureMessage('Hey!');
            wait(scope, done);
        });
    });

    describe('#captureError()', function(){
        it('should send an Error to Sentry server', function(done){
            var scope = nock('https://app.getsentry.com')
                .filteringRequestBody(/.*/, '*')
                .post('/api/store/', '*')
                .reply(200, 'OK');

            client.captureError(new Error('wtf?'));
            wait(scope, done);
        });
    });

    describe('#patchGlobal()', function(){
        it('should add itself to the uncaughtException event list', function(){
            var before = process._events.uncaughtException;
            client.patchGlobal();
            process._events.uncaughtException.length.should.equal(before.length+1);
            process._events.uncaughtException = before; // patch it back to what it was
        });

        /* Why can't I do this?!?!
        it('should send an uncaughtException to Sentry server', function(done){
            var scope = nock('https://app.getsentry.com')
                .filteringRequestBody(/.*\/, '*')
                .post('/api/store/', '*')
                .reply(200, 'OK');
            var before = process._events.uncaughtException;
            process.removeAllListeners('uncaughtException');
            console.log(process._events);
            client.patchGlobal();
            console.log(process._events);
            ''(); // should be caught and sent to Sentry
            before.forEach(function(cb) {
                // restore old callbacks
                process.on('uncaughtException', cb);
            });
            done();
        });
        */
    });
});