raven_config_spec.js 6.65 KB
Newer Older
1
import Raven from 'raven-js';
2
import RavenConfig from '~/raven/raven_config';
3

4
describe('RavenConfig', () => {
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
  describe('IGNORE_ERRORS', () => {
    it('should be an array of strings', () => {
      const areStrings = RavenConfig.IGNORE_ERRORS.every(error => typeof error === 'string');

      expect(areStrings).toBe(true);
    });
  });

  describe('IGNORE_URLS', () => {
    it('should be an array of regexps', () => {
      const areRegExps = RavenConfig.IGNORE_URLS.every(url => url instanceof RegExp);

      expect(areRegExps).toBe(true);
    });
  });

  describe('SAMPLE_RATE', () => {
    it('should be a finite number', () => {
      expect(typeof RavenConfig.SAMPLE_RATE).toEqual('number');
    });
  });

27
  describe('init', () => {
28 29 30
    const options = {
      currentUserId: 1,
    };
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
31

32 33 34 35 36
    beforeEach(() => {
      spyOn(RavenConfig, 'configure');
      spyOn(RavenConfig, 'bindRavenErrors');
      spyOn(RavenConfig, 'setUser');

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
37 38
      RavenConfig.init(options);
    });
39

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
40 41 42
    it('should set the options property', () => {
      expect(RavenConfig.options).toEqual(options);
    });
43

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
44 45 46
    it('should call the configure method', () => {
      expect(RavenConfig.configure).toHaveBeenCalled();
    });
47

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
48 49 50
    it('should call the error bindings method', () => {
      expect(RavenConfig.bindRavenErrors).toHaveBeenCalled();
    });
51

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
52 53
    it('should call setUser', () => {
      expect(RavenConfig.setUser).toHaveBeenCalled();
54 55 56
    });

    it('should not call setUser if there is no current user ID', () => {
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
57 58
      RavenConfig.setUser.calls.reset();

59 60 61
      options.currentUserId = undefined;

      RavenConfig.init(options);
62 63 64 65 66 67

      expect(RavenConfig.setUser).not.toHaveBeenCalled();
    });
  });

  describe('configure', () => {
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
68
    let raven;
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
69
    let ravenConfig;
70 71
    const options = {
      sentryDsn: '//sentryDsn',
72 73
      whitelistUrls: ['//gitlabUrl', 'webpack-internal://'],
      environment: 'test',
74 75 76 77 78
      release: 'revision',
      tags: {
        revision: 'revision',
      },
    };
79

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
80
    beforeEach(() => {
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
81
      ravenConfig = jasmine.createSpyObj('ravenConfig', ['shouldSendSample']);
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
82
      raven = jasmine.createSpyObj('raven', ['install']);
83

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
84
      spyOn(Raven, 'config').and.returnValue(raven);
85

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
86 87 88 89 90
      ravenConfig.options = options;
      ravenConfig.IGNORE_ERRORS = 'ignore_errors';
      ravenConfig.IGNORE_URLS = 'ignore_urls';

      RavenConfig.configure.call(ravenConfig);
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
91
    });
92

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
93 94
    it('should call Raven.config', () => {
      expect(Raven.config).toHaveBeenCalledWith(options.sentryDsn, {
95 96
        release: options.release,
        tags: options.tags,
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
97
        whitelistUrls: options.whitelistUrls,
98
        environment: 'test',
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
99 100 101
        ignoreErrors: ravenConfig.IGNORE_ERRORS,
        ignoreUrls: ravenConfig.IGNORE_URLS,
        shouldSendCallback: jasmine.any(Function),
102
      });
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
103
    });
104

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
105 106 107 108
    it('should call Raven.install', () => {
      expect(raven.install).toHaveBeenCalled();
    });

109 110
    it('should set environment from options', () => {
      ravenConfig.options.environment = 'development';
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
111

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
112
      RavenConfig.configure.call(ravenConfig);
113

Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
114
      expect(Raven.config).toHaveBeenCalledWith(options.sentryDsn, {
115 116
        release: options.release,
        tags: options.tags,
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
117 118
        whitelistUrls: options.whitelistUrls,
        environment: 'development',
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
119 120 121
        ignoreErrors: ravenConfig.IGNORE_ERRORS,
        ignoreUrls: ravenConfig.IGNORE_URLS,
        shouldSendCallback: jasmine.any(Function),
122 123 124 125 126
      });
    });
  });

  describe('setUser', () => {
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
127 128 129 130 131 132 133 134 135
    let ravenConfig;

    beforeEach(() => {
      ravenConfig = { options: { currentUserId: 1 } };
      spyOn(Raven, 'setUserContext');

      RavenConfig.setUser.call(ravenConfig);
    });

Mike Greiling's avatar
Mike Greiling committed
136
    it('should call .setUserContext', function() {
Luke "Jared" Bennett's avatar
Luke "Jared" Bennett committed
137 138 139
      expect(Raven.setUserContext).toHaveBeenCalledWith({
        id: ravenConfig.options.currentUserId,
      });
140 141 142 143
    });
  });

  describe('handleRavenErrors', () => {
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
    let event;
    let req;
    let config;
    let err;

    beforeEach(() => {
      event = {};
      req = { status: 'status', responseText: 'responseText', statusText: 'statusText' };
      config = { type: 'type', url: 'url', data: 'data' };
      err = {};

      spyOn(Raven, 'captureMessage');

      RavenConfig.handleRavenErrors(event, req, config, err);
    });

    it('should call Raven.captureMessage', () => {
      expect(Raven.captureMessage).toHaveBeenCalledWith(err, {
        extra: {
          type: config.type,
          url: config.url,
          data: config.data,
          status: req.status,
167
          response: req.responseText,
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
          error: err,
          event,
        },
      });
    });

    describe('if no err is provided', () => {
      beforeEach(() => {
        Raven.captureMessage.calls.reset();

        RavenConfig.handleRavenErrors(event, req, config);
      });

      it('should use req.statusText as the error value', () => {
        expect(Raven.captureMessage).toHaveBeenCalledWith(req.statusText, {
          extra: {
            type: config.type,
            url: config.url,
            data: config.data,
            status: req.status,
188
            response: req.responseText,
189 190 191 192 193 194
            error: req.statusText,
            event,
          },
        });
      });
    });
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218

    describe('if no req.responseText is provided', () => {
      beforeEach(() => {
        req.responseText = undefined;

        Raven.captureMessage.calls.reset();

        RavenConfig.handleRavenErrors(event, req, config, err);
      });

      it('should use `Unknown response text` as the response', () => {
        expect(Raven.captureMessage).toHaveBeenCalledWith(err, {
          extra: {
            type: config.type,
            url: config.url,
            data: config.data,
            status: req.status,
            response: 'Unknown response text',
            error: err,
            event,
          },
        });
      });
    });
219
  });
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253

  describe('shouldSendSample', () => {
    let randomNumber;

    beforeEach(() => {
      RavenConfig.SAMPLE_RATE = 50;

      spyOn(Math, 'random').and.callFake(() => randomNumber);
    });

    it('should call Math.random', () => {
      RavenConfig.shouldSendSample();

      expect(Math.random).toHaveBeenCalled();
    });

    it('should return true if the sample rate is greater than the random number * 100', () => {
      randomNumber = 0.1;

      expect(RavenConfig.shouldSendSample()).toBe(true);
    });

    it('should return false if the sample rate is less than the random number * 100', () => {
      randomNumber = 0.9;

      expect(RavenConfig.shouldSendSample()).toBe(false);
    });

    it('should return true if the sample rate is equal to the random number * 100', () => {
      randomNumber = 0.5;

      expect(RavenConfig.shouldSendSample()).toBe(true);
    });
  });
254
});