feat(ErrorHandler): use the angular ErrorHandler for reporting errors

Fixes ngrx#626 BREAKING CHANGE: Errors are now reported to the @angular/core ErrorHandler. Errors are no longer reported to the console.
jbedard · Dec 23, 2017 · 2c88d9e · 2c88d9e
1 parent 95dd2dc
commit 2c88d9e
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 96 deletions.
diff --git a/modules/effects/spec/effect_sources.spec.ts b/modules/effects/spec/effect_sources.spec.ts
@@ -9,27 +9,19 @@ import { _throw } from 'rxjs/observable/throw';
 import { never } from 'rxjs/observable/never';
 import { empty } from 'rxjs/observable/empty';
 import { TestBed } from '@angular/core/testing';
-import { ErrorReporter } from '../src/error_reporter';
-import { CONSOLE } from '../src/tokens';
+import { ErrorHandler } from '@angular/core';
 import { Effect, EffectSources } from '../';
 
 describe('EffectSources', () => {
-  let mockErrorReporter: ErrorReporter;
+  let mockErrorReporter: ErrorHandler;
   let effectSources: EffectSources;
 
   beforeEach(() => {
     TestBed.configureTestingModule({
-      providers: [
-        EffectSources,
-        ErrorReporter,
-        {
-          provide: CONSOLE,
-          useValue: console,
-        },
-      ],
+      providers: [EffectSources],
     });
 
-    mockErrorReporter = TestBed.get(ErrorReporter);
+    mockErrorReporter = TestBed.get(ErrorHandler);
     effectSources = TestBed.get(EffectSources);
 
     spyOn(mockErrorReporter, 'handleError');
@@ -118,7 +110,7 @@ describe('EffectSources', () => {
     });
 
     function toActions(source: any): Observable<any> {
-      source['errorReporter'] = mockErrorReporter;
+      source['errorHandler'] = mockErrorReporter;
       return effectSources.toActions.call(source);
     }
   });

diff --git a/modules/effects/src/effect_notification.ts b/modules/effects/src/effect_notification.ts
@@ -1,11 +1,7 @@
 import { Observable } from 'rxjs/Observable';
 import { Notification } from 'rxjs/Notification';
 import { Action } from '@ngrx/store';
-import {
-  ErrorReporter,
-  EffectError,
-  InvalidActionError,
-} from './error_reporter';
+import { ErrorHandler } from '@angular/core';
 
 export interface EffectNotification {
   effect: Observable<any> | (() => Observable<any>);
@@ -17,33 +13,21 @@ export interface EffectNotification {
 
 export function verifyOutput(
   output: EffectNotification,
-  reporter: ErrorReporter
+  reporter: ErrorHandler
 ) {
   reportErrorThrown(output, reporter);
   reportInvalidActions(output, reporter);
 }
 
-function reportErrorThrown(
-  output: EffectNotification,
-  reporter: ErrorReporter
-) {
+function reportErrorThrown(output: EffectNotification, reporter: ErrorHandler) {
   if (output.notification.kind === 'E') {
-    const errorReason = new Error(
-      `Effect ${getEffectName(output)} threw an error`
-    ) as EffectError;
-
-    errorReason.Source = output.sourceInstance;
-    errorReason.Effect = output.effect;
-    errorReason.Error = output.notification.error;
-    errorReason.Notification = output.notification;
-
-    reporter.handleError(errorReason);
+    reporter.handleError(output.notification.error);
   }
 }
 
 function reportInvalidActions(
   output: EffectNotification,
-  reporter: ErrorReporter
+  reporter: ErrorHandler
 ) {
   if (output.notification.kind === 'N') {
     const action = output.notification.value;
@@ -52,14 +36,9 @@ function reportInvalidActions(
     if (isInvalidAction) {
       const errorReason = new Error(
         `Effect ${getEffectName(output)} dispatched an invalid action`
-      ) as InvalidActionError;
-
-      errorReason.Source = output.sourceInstance;
-      errorReason.Effect = output.effect;
-      errorReason.Dispatched = action;
-      errorReason.Notification = output.notification;
+      );
 
-      reporter.handleError(errorReason);
+      reporter.handleError(Object.assign(errorReason, { action }));
     }
   }
 }

diff --git a/modules/effects/src/effect_sources.ts b/modules/effects/src/effect_sources.ts
@@ -8,16 +8,15 @@ import { concat } from 'rxjs/observable/concat';
 import { Observable } from 'rxjs/Observable';
 import { Subject } from 'rxjs/Subject';
 import { Notification } from 'rxjs/Notification';
-import { Injectable } from '@angular/core';
+import { ErrorHandler, Injectable } from '@angular/core';
 import { Action } from '@ngrx/store';
 import { EffectNotification, verifyOutput } from './effect_notification';
 import { getSourceForInstance } from './effects_metadata';
 import { resolveEffectSource } from './effects_resolver';
-import { ErrorReporter } from './error_reporter';
 
 @Injectable()
 export class EffectSources extends Subject<any> {
-  constructor(private errorReporter: ErrorReporter) {
+  constructor(private errorHandler: ErrorHandler) {
     super();
   }
 
@@ -37,7 +36,7 @@ export class EffectSources extends Subject<any> {
             map.call(
               exhaustMap.call(source$, resolveEffectSource),
               (output: EffectNotification) => {
-                verifyOutput(output, this.errorReporter);
+                verifyOutput(output, this.errorHandler);
 
                 return output.notification;
               }

diff --git a/modules/effects/src/effects_module.ts b/modules/effects/src/effects_module.ts
@@ -1,11 +1,10 @@
 import { NgModule, ModuleWithProviders, Type } from '@angular/core';
 import { EffectSources } from './effect_sources';
 import { Actions } from './actions';
-import { ROOT_EFFECTS, FEATURE_EFFECTS, CONSOLE } from './tokens';
+import { ROOT_EFFECTS, FEATURE_EFFECTS } from './tokens';
 import { EffectsFeatureModule } from './effects_feature_module';
 import { EffectsRootModule } from './effects_root_module';
 import { EffectsRunner } from './effects_runner';
-import { ErrorReporter } from './error_reporter';
 
 @NgModule({})
 export class EffectsModule {
@@ -30,18 +29,13 @@ export class EffectsModule {
       providers: [
         EffectsRunner,
         EffectSources,
-        ErrorReporter,
         Actions,
         rootEffects,
         {
           provide: ROOT_EFFECTS,
           deps: rootEffects,
           useFactory: createSourceInstances,
         },
-        {
-          provide: CONSOLE,
-          useFactory: getConsole,
-        },
       ],
     };
   }
@@ -50,7 +44,3 @@ export class EffectsModule {
 export function createSourceInstances(...instances: any[]) {
   return instances;
 }
-
-export function getConsole() {
-  return console;
-}
diff --git a/modules/effects/src/error_reporter.ts b/modules/effects/src/error_reporter.ts
diff --git a/modules/effects/src/tokens.ts b/modules/effects/src/tokens.ts
@@ -9,4 +9,3 @@ export const ROOT_EFFECTS = new InjectionToken<Type<any>[]>(
 export const FEATURE_EFFECTS = new InjectionToken<any[][]>(
   'ngrx/effects: Feature Effects'
 );
-export const CONSOLE = new InjectionToken<Console>('Browser Console');