Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(router-store): Handle navigation error, cancel/error action contain real previous state #1294

Merged
merged 2 commits into from
Aug 27, 2018
Merged

fix(router-store): Handle navigation error, cancel/error action contain real previous state #1294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8070323
fix(router-store): Handle navigation error, cancel/error action conta…
dummdidumm Aug 25, 2018
7894950
fix(router-store): Code cleanup, testing error handler
dummdidumm Aug 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 147 additions & 14 deletions modules/router-store/spec/integration.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import { Component, Provider, Injectable } from '@angular/core';
import { Component, Provider, Injectable, ErrorHandler } from '@angular/core';
import { TestBed } from '@angular/core/testing';
import { NavigationEnd, Router, RouterStateSnapshot } from '@angular/router';
import {
NavigationEnd,
Router,
RouterStateSnapshot,
NavigationCancel,
NavigationError,
} from '@angular/router';
import { RouterTestingModule } from '@angular/router/testing';
import { Store, StoreModule, ScannedActionsSubject } from '@ngrx/store';
import { filter, first, mapTo, take } from 'rxjs/operators';
Expand All @@ -19,6 +25,7 @@ import {
ROUTER_REQUEST,
ROUTER_NAVIGATED,
NavigationActionTiming,
RouterReducerState,
} from '../src/router_store_module';

describe('integration spec', () => {
Expand Down Expand Up @@ -119,7 +126,7 @@ describe('integration spec', () => {
});
});

it('should support rolling back if navigation gets canceled', (done: any) => {
it('should support rolling back if navigation gets canceled (navigation initialized through router)', (done: any) => {
const reducer = (state: string = '', action: RouterAction<any>): any => {
if (action.type === ROUTER_NAVIGATION) {
return {
Expand Down Expand Up @@ -176,9 +183,9 @@ describe('integration spec', () => {
{
type: 'store',
state: {
url: '/next',
url: '/',
lastAction: ROUTER_CANCEL,
storeState: { url: '/next', lastAction: ROUTER_NAVIGATION },
storeState: { url: '/', lastAction: ROUTER_NAVIGATION },
},
},
{ type: 'action', action: ROUTER_CANCEL },
Expand All @@ -189,7 +196,67 @@ describe('integration spec', () => {
});
});

it('should support rolling back if navigation errors', (done: any) => {
it('should support rolling back if navigation gets canceled (navigation initialized through store)', (done: any) => {
const CHANGE_ROUTE = 'CHANGE_ROUTE';
const reducer = (
state: RouterReducerState,
action: any
): RouterReducerState => {
if (action.type === CHANGE_ROUTE) {
return {
state: { url: '/next', root: <any>{} },
navigationId: 123,
};
} else {
const nextState = routerReducer(state, action);
if (nextState && nextState.state) {
nextState.state.root = <any>{};
}
return nextState;
}
};

createTestModule({
reducers: { reducer },
canActivate: () => false,
config: { stateKey: 'reducer' },
});

const router: Router = TestBed.get(Router);
const store: Store<any> = TestBed.get(Store);
const log = logOfRouterAndActionsAndStore();

router
.navigateByUrl('/')
.then(() => {
log.splice(0);
store.dispatch({ type: CHANGE_ROUTE });
return waitForNavigation(router, NavigationCancel);
})
.then(() => {
expect(log).toEqual([
{ type: 'router', event: 'NavigationStart', url: '/next' },
{
type: 'store',
state: { state: { url: '/next', root: {} }, navigationId: 123 },
},
{ type: 'action', action: CHANGE_ROUTE },
{ type: 'router', event: 'RoutesRecognized', url: '/next' },
{ type: 'router', event: 'GuardsCheckStart', url: '/next' },
{ type: 'router', event: 'GuardsCheckEnd', url: '/next' },
{
type: 'store',
state: { state: { url: '/', root: {} }, navigationId: 2 },
},
{ type: 'action', action: ROUTER_CANCEL },
{ type: 'router', event: 'NavigationCancel', url: '/next' },
]);

done();
});
});

it('should support rolling back if navigation errors (navigation initialized through router)', (done: any) => {
const reducer = (state: string = '', action: RouterAction<any>): any => {
if (action.type === ROUTER_NAVIGATION) {
return {
Expand Down Expand Up @@ -246,9 +313,9 @@ describe('integration spec', () => {
{
type: 'store',
state: {
url: '/next',
url: '/',
lastAction: ROUTER_ERROR,
storeState: { url: '/next', lastAction: ROUTER_NAVIGATION },
storeState: { url: '/', lastAction: ROUTER_NAVIGATION },
},
},
{ type: 'action', action: ROUTER_ERROR },
Expand All @@ -259,6 +326,75 @@ describe('integration spec', () => {
});
});

it('should support rolling back if navigation errors and hand error to error handler (navigation initialized through store)', (done: any) => {
const CHANGE_ROUTE = 'CHANGE_ROUTE';
const reducer = (
state: RouterReducerState,
action: any
): RouterReducerState => {
if (action.type === CHANGE_ROUTE) {
return {
state: { url: '/next', root: <any>{} },
navigationId: 123,
};
} else {
const nextState = routerReducer(state, action);
if (nextState && nextState.state) {
nextState.state.root = <any>{};
}
return nextState;
}
};

const routerError = new Error('BOOM!');
class SilentErrorHandler implements ErrorHandler {
handleError(error: any) {
expect(error).toBe(routerError);
}
}

createTestModule({
reducers: { reducer },
canActivate: () => {
throw routerError;
},
providers: [{ provide: ErrorHandler, useClass: SilentErrorHandler }],
config: { stateKey: 'reducer' },
});

const router: Router = TestBed.get(Router);
const store: Store<any> = TestBed.get(Store);
const log = logOfRouterAndActionsAndStore();

router
.navigateByUrl('/')
.then(() => {
log.splice(0);
store.dispatch({ type: CHANGE_ROUTE });
return waitForNavigation(router, NavigationError);
})
.then(() => {
expect(log).toEqual([
{ type: 'router', event: 'NavigationStart', url: '/next' },
{
type: 'store',
state: { state: { url: '/next', root: {} }, navigationId: 123 },
},
{ type: 'action', action: CHANGE_ROUTE },
{ type: 'router', event: 'RoutesRecognized', url: '/next' },
{ type: 'router', event: 'GuardsCheckStart', url: '/next' },
{
type: 'store',
state: { state: { url: '/', root: {} }, navigationId: 2 },
},
{ type: 'action', action: ROUTER_ERROR },
{ type: 'router', event: 'NavigationError', url: '/next' },
]);

done();
});
});

it('should call navigateByUrl when resetting state of the routerReducer', (done: any) => {
const reducer = (state: any, action: RouterAction<any>) => {
const r = routerReducer(state, action);
Expand Down Expand Up @@ -385,7 +521,7 @@ describe('integration spec', () => {
{ type: 'store', state: null }, // ROUTER_REQEST event in the store
{ type: 'action', action: ROUTER_REQUEST },
{ type: 'router', event: 'NavigationStart', url: '/load' },
{ type: 'store', state: null },
{ type: 'store', state: { url: '', navigationId: 1 } },
{ type: 'action', action: ROUTER_CANCEL },
{ type: 'router', event: 'NavigationCancel', url: '/load' },
]);
Expand Down Expand Up @@ -744,12 +880,9 @@ function createTestModule(
TestBed.createComponent(AppCmp);
}

function waitForNavigation(router: Router) {
function waitForNavigation(router: Router, event: any = NavigationEnd) {
return router.events
.pipe(
filter((e): e is NavigationEnd => e instanceof NavigationEnd),
first()
)
.pipe(filter(e => e instanceof event), first())
.toPromise();
}

Expand Down
Loading