-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(effects): make resubscription handler overridable (#2295)
Closes #2294 BREAKING CHANGE: `resubscribeOnError` renamed to `useEffectsErrorHandler` in `createEffect` metadata BEFORE: ```ts class MyEffects { effect$ = createEffect(() => stream$, { resubscribeOnError: true, // default }); } ``` AFTER: ```ts class MyEffects { effect$ = createEffect(() => stream$, { useEffectsErrorHandler: true, // default }); } ```
- Loading branch information
1 parent
900bf75
commit 3a9ad63
Showing
17 changed files
with
290 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| import { ErrorHandler, Provider } from '@angular/core'; | ||
| import { TestBed } from '@angular/core/testing'; | ||
| import { Action, Store } from '@ngrx/store'; | ||
| import { Observable, of } from 'rxjs'; | ||
| import { catchError } from 'rxjs/operators'; | ||
| import { createEffect, EFFECTS_ERROR_HANDLER, EffectsModule } from '..'; | ||
|
|
||
| describe('Effects Error Handler', () => { | ||
| let subscriptionCount: number; | ||
| let globalErrorHandler: jasmine.Spy; | ||
| let storeNext: jasmine.Spy; | ||
|
|
||
| function makeEffectTestBed(...providers: Provider[]) { | ||
| subscriptionCount = 0; | ||
|
|
||
| TestBed.configureTestingModule({ | ||
| imports: [EffectsModule.forRoot([ErrorEffect])], | ||
| providers: [ | ||
| { | ||
| provide: Store, | ||
| useValue: { | ||
| next: jasmine.createSpy('storeNext'), | ||
| dispatch: jasmine.createSpy('dispatch'), | ||
| }, | ||
| }, | ||
| { | ||
| provide: ErrorHandler, | ||
| useValue: { | ||
| handleError: jasmine.createSpy('globalErrorHandler'), | ||
| }, | ||
| }, | ||
| ...providers, | ||
| ], | ||
| }); | ||
|
|
||
| globalErrorHandler = TestBed.get(ErrorHandler).handleError; | ||
| const store = TestBed.get(Store); | ||
| storeNext = store.next; | ||
| } | ||
|
|
||
| it('should retry and notify error handler when effect error handler is not provided', () => { | ||
| makeEffectTestBed(); | ||
|
|
||
| // two subscriptions expected: | ||
| // 1. Initial subscription to the effect (this will error) | ||
| // 2. Resubscription to the effect after error (this will not error) | ||
| expect(subscriptionCount).toBe(2); | ||
| expect(globalErrorHandler).toHaveBeenCalledWith(new Error('effectError')); | ||
| }); | ||
|
|
||
| it('should use custom error behavior when EFFECTS_ERROR_HANDLER is provided', () => { | ||
| const effectsErrorHandlerSpy = jasmine | ||
| .createSpy() | ||
| .and.callFake((effect$: Observable<any>, errorHandler: ErrorHandler) => { | ||
| return effect$.pipe( | ||
| catchError(err => { | ||
| errorHandler.handleError( | ||
| new Error('inside custom handler: ' + err.message) | ||
| ); | ||
| return of({ type: 'custom action' }); | ||
| }) | ||
| ); | ||
| }); | ||
|
|
||
| makeEffectTestBed({ | ||
| provide: EFFECTS_ERROR_HANDLER, | ||
| useValue: effectsErrorHandlerSpy, | ||
| }); | ||
|
|
||
| expect(effectsErrorHandlerSpy).toHaveBeenCalledWith( | ||
| jasmine.any(Observable), | ||
| TestBed.get(ErrorHandler) | ||
| ); | ||
| expect(globalErrorHandler).toHaveBeenCalledWith( | ||
| new Error('inside custom handler: effectError') | ||
| ); | ||
| expect(subscriptionCount).toBe(1); | ||
| expect(storeNext).toHaveBeenCalledWith({ type: 'custom action' }); | ||
| }); | ||
|
|
||
| class ErrorEffect { | ||
| effect$ = createEffect(errorFirstSubscriber, { | ||
| useEffectsErrorHandler: true, | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * This observable factory returns an observable that will never emit, but the first subscriber will get an immediate | ||
| * error. All subsequent subscribers will just get an observable that does not emit. | ||
| */ | ||
| function errorFirstSubscriber(): Observable<Action> { | ||
| return new Observable(observer => { | ||
| subscriptionCount++; | ||
|
|
||
| if (subscriptionCount === 1) { | ||
| observer.error(new Error('effectError')); | ||
| } | ||
| }); | ||
| } | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.