https://github.com/angular/angular
Raw File
Tip revision: bb05225dcd973647d41ad83790bd350ad53d3ca2 authored by Dylan Hunn on 01 June 2023, 15:25:22 UTC
release: cut the v16.0.4 release
Tip revision: bb05225
reporting-error-handler.spec.ts
import { ErrorHandler, Injector, VERSION } from '@angular/core';
import { TestBed } from '@angular/core/testing';
import { AppModule } from 'app/app.module';

import { ReportingErrorHandler } from './reporting-error-handler';
import { AnalyticsService } from './analytics.service';

describe('ReportingErrorHandler service', () => {
  let handler: ReportingErrorHandler;
  let superHandler: jasmine.Spy;
  let reportErrorSpy: jasmine.Spy;

  beforeEach(() => {
    superHandler = spyOn(ErrorHandler.prototype, 'handleError');
    reportErrorSpy = jasmine.createSpy('analytics report error');

    const injector = Injector.create({providers: [
      { provide: AnalyticsService, useValue: {reportError: reportErrorSpy} },
      { provide: ErrorHandler, useClass: ReportingErrorHandler, deps: [AnalyticsService] },
    ]});

    handler = injector.get(ErrorHandler) as unknown as ReportingErrorHandler;
  });

  it('should be registered on the AppModule', () => {
    handler = TestBed.configureTestingModule({ imports: [AppModule] }).inject(ErrorHandler) as any;
    expect(handler).toEqual(jasmine.any(ReportingErrorHandler));
  });

  describe('handleError', () => {
    it('should call the super class handleError', () => {
      const error = new Error();
      handler.handleError(error);
      expect(superHandler).toHaveBeenCalledWith(error);
    });

    it('should cope with the super handler throwing an error', () => {
      const error = new Error('initial error');
      superHandler.and.throwError('super handler error');
      handler.handleError(error);

      expect(reportErrorSpy).toHaveBeenCalledTimes(2);

      // Error from super handler is reported first
      expect(reportErrorSpy.calls.argsFor(0)[0]).toEqual(
        jasmine.stringContaining('super handler error\n'));

      // Then error from initial exception
      expect(reportErrorSpy.calls.argsFor(1)[0]).toEqual(
        jasmine.stringContaining(`[v${VERSION.full}] initial error\n`));
    });

    it('should augment an error object with version info', () => {
      const originalMessage = 'this is an error message';
      const error = new Error(originalMessage);

      expect(error.message).toBe(originalMessage);
      // NOTE:
      // Intentionally not checking `error.stack` here, because accessing it causes the property to
      // be computed and may affect the observed behavior of `handleError()`.

      handler.handleError(error);

      expect(error.message).toBe(`[v${VERSION.full}] ${originalMessage}`);
      if (error.stack) {
        const expected = `Error: [v${VERSION.full}] ${originalMessage}`;
        const actual = error.stack.split('\n', 1)[0];
        expect(actual.startsWith(expected))
            .withContext(`Expected '${actual}' to start with '${expected}'.`)
            .toBeTrue();
      }
    });

    it('should send an error object to analytics', () => {
      const error = new Error('this is an error message');
      handler.handleError(error);
      expect(reportErrorSpy).toHaveBeenCalledWith(
          jasmine.stringContaining('this is an error message\n'));
    });

    it('should send a non-error object to analytics', () => {
      const error = {reason: 'this is an error message'};
      handler.handleError(error);
      expect(reportErrorSpy).toHaveBeenCalledWith(JSON.stringify(error));
    });

    it('should send a non-error object with circular references to analytics', () => {
      const error = {
        reason: 'this is an error message',
        get self() { return this; },
        toString() { return `{reason: ${this.reason}}`; },
      };
      handler.handleError(error);
      expect(reportErrorSpy).toHaveBeenCalledWith('{reason: this is an error message}');
    });

    it('should send an error string to analytics (prefixed with version info)', () => {
      const error = 'this is an error message';
      handler.handleError(error);
      expect(reportErrorSpy).toHaveBeenCalledWith(`[v${VERSION.full}] ${error}`);
    });

    it('should send a non-object, non-string error stringified to analytics', () => {
      handler.handleError(404);
      handler.handleError(false);
      handler.handleError(null);
      handler.handleError(undefined);

      expect(reportErrorSpy.calls.allArgs()).toEqual([
        ['404'],
        ['false'],
        ['null'],
        ['undefined'],
      ]);
    });
  });
});
back to top