feat(router): add route config validation
This commit is contained in:
parent
7e12208ca6
commit
ca23b4c55f
|
@ -12,3 +12,24 @@ export interface Route {
|
||||||
redirectTo?: string;
|
redirectTo?: string;
|
||||||
children?: Route[];
|
children?: Route[];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function validateConfig(config: RouterConfig): void {
|
||||||
|
config.forEach(validateNode);
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateNode(route: Route): void {
|
||||||
|
if (!!route.redirectTo && !!route.children) {
|
||||||
|
throw new Error(
|
||||||
|
`Invalid configuration of route '${route.path}': redirectTo and children cannot be used together`);
|
||||||
|
}
|
||||||
|
if (!!route.redirectTo && !!route.component) {
|
||||||
|
throw new Error(
|
||||||
|
`Invalid configuration of route '${route.path}': redirectTo and component cannot be used together`);
|
||||||
|
}
|
||||||
|
if (route.path === undefined) {
|
||||||
|
throw new Error(`Invalid route configuration: routes must have path specified`);
|
||||||
|
}
|
||||||
|
if (route.path.startsWith('/')) {
|
||||||
|
throw new Error(`Invalid route configuration of route '/a': path cannot start with a slash`);
|
||||||
|
}
|
||||||
|
}
|
|
@ -15,7 +15,7 @@ import {Subscription} from 'rxjs/Subscription';
|
||||||
import {of } from 'rxjs/observable/of';
|
import {of } from 'rxjs/observable/of';
|
||||||
|
|
||||||
import {applyRedirects} from './apply_redirects';
|
import {applyRedirects} from './apply_redirects';
|
||||||
import {RouterConfig} from './config';
|
import {RouterConfig, validateConfig} from './config';
|
||||||
import {createRouterState} from './create_router_state';
|
import {createRouterState} from './create_router_state';
|
||||||
import {createUrlTree} from './create_url_tree';
|
import {createUrlTree} from './create_url_tree';
|
||||||
import {RouterOutlet} from './directives/router_outlet';
|
import {RouterOutlet} from './directives/router_outlet';
|
||||||
|
@ -99,6 +99,7 @@ export class Router {
|
||||||
private locationSubscription: Subscription;
|
private locationSubscription: Subscription;
|
||||||
private routerEvents: Subject<Event>;
|
private routerEvents: Subject<Event>;
|
||||||
private navigationId: number = 0;
|
private navigationId: number = 0;
|
||||||
|
private config: RouterConfig;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @internal
|
* @internal
|
||||||
|
@ -106,7 +107,8 @@ export class Router {
|
||||||
constructor(
|
constructor(
|
||||||
private rootComponentType: Type, private resolver: ComponentResolver,
|
private rootComponentType: Type, private resolver: ComponentResolver,
|
||||||
private urlSerializer: UrlSerializer, private outletMap: RouterOutletMap,
|
private urlSerializer: UrlSerializer, private outletMap: RouterOutletMap,
|
||||||
private location: Location, private injector: Injector, private config: RouterConfig) {
|
private location: Location, private injector: Injector, config: RouterConfig) {
|
||||||
|
this.resetConfig(config);
|
||||||
this.routerEvents = new Subject<Event>();
|
this.routerEvents = new Subject<Event>();
|
||||||
this.currentUrlTree = createEmptyUrlTree();
|
this.currentUrlTree = createEmptyUrlTree();
|
||||||
this.currentRouterState = createEmptyState(this.currentUrlTree, this.rootComponentType);
|
this.currentRouterState = createEmptyState(this.currentUrlTree, this.rootComponentType);
|
||||||
|
@ -149,7 +151,10 @@ export class Router {
|
||||||
* ]);
|
* ]);
|
||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
resetConfig(config: RouterConfig): void { this.config = config; }
|
resetConfig(config: RouterConfig): void {
|
||||||
|
validateConfig(config);
|
||||||
|
this.config = config;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @internal
|
* @internal
|
||||||
|
|
|
@ -0,0 +1,50 @@
|
||||||
|
import {validateConfig} from '../src/config';
|
||||||
|
|
||||||
|
describe('config', () => {
|
||||||
|
describe("validateConfig", () => {
|
||||||
|
it("should not throw when no errors", () => {
|
||||||
|
validateConfig([
|
||||||
|
{ path: '', redirectTo: 'b' },
|
||||||
|
{ path: 'b', component: ComponentA }
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should throw when redirectTo and children are used together", () => {
|
||||||
|
expect(() => {
|
||||||
|
validateConfig([
|
||||||
|
{ path: 'a', redirectTo: 'b', children: [
|
||||||
|
{path: 'b', component: ComponentA}
|
||||||
|
] }
|
||||||
|
]);
|
||||||
|
}).toThrowError(`Invalid configuration of route 'a': redirectTo and children cannot be used together`);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should throw when component and redirectTo are used together", () => {
|
||||||
|
expect(() => {
|
||||||
|
validateConfig([
|
||||||
|
{ path: 'a', component: ComponentA, redirectTo: 'b' }
|
||||||
|
]);
|
||||||
|
}).toThrowError(`Invalid configuration of route 'a': redirectTo and component cannot be used together`);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should throw when path is missing", () => {
|
||||||
|
expect(() => {
|
||||||
|
validateConfig([
|
||||||
|
{ component: '', redirectTo: 'b' }
|
||||||
|
]);
|
||||||
|
}).toThrowError(`Invalid route configuration: routes must have path specified`);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should throw when path starts with a slash", () => {
|
||||||
|
expect(() => {
|
||||||
|
validateConfig([
|
||||||
|
{ path: '/a', componenta: '', redirectTo: 'b' }
|
||||||
|
]);
|
||||||
|
}).toThrowError(`Invalid route configuration of route '/a': path cannot start with a slash`);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
class ComponentA {}
|
||||||
|
class ComponentB {}
|
||||||
|
class ComponentC {}
|
|
@ -43,6 +43,7 @@
|
||||||
"test/recognize.spec.ts",
|
"test/recognize.spec.ts",
|
||||||
"test/create_router_state.spec.ts",
|
"test/create_router_state.spec.ts",
|
||||||
"test/create_url_tree.spec.ts",
|
"test/create_url_tree.spec.ts",
|
||||||
|
"test/config.spec.ts",
|
||||||
"test/router.spec.ts",
|
"test/router.spec.ts",
|
||||||
"typings/index.d.ts"
|
"typings/index.d.ts"
|
||||||
]
|
]
|
||||||
|
|
Loading…
Reference in New Issue