This is a big change. @matsko also deserves much of the credit for the implementation.
Previously, `ComponentInstruction`s held all the state for async components.
Now, we introduce several subclasses for `Instruction` to describe each type of navigation.
BREAKING CHANGE:
Redirects now use the Link DSL syntax. Before:
```
@RouteConfig([
  { path: '/foo', redirectTo: '/bar' },
  { path: '/bar', component: BarCmp }
])
```
After:
```
@RouteConfig([
  { path: '/foo', redirectTo: ['Bar'] },
  { path: '/bar', component: BarCmp, name: 'Bar' }
])
```
BREAKING CHANGE:
This also introduces `useAsDefault` in the RouteConfig, which makes cases like lazy-loading
and encapsulating large routes with sub-routes easier.
Previously, you could use `redirectTo` like this to expand a URL like `/tab` to `/tab/posts`:
@RouteConfig([
  { path: '/tab', redirectTo: '/tab/users' }
  { path: '/tab', component: TabsCmp, name: 'Tab' }
])
AppCmp { ... }
Now the recommended way to handle this is case is to use `useAsDefault` like so:
```
@RouteConfig([
  { path: '/tab', component: TabsCmp, name: 'Tab' }
])
AppCmp { ... }
@RouteConfig([
  { path: '/posts', component: PostsCmp, useAsDefault: true, name: 'Posts' },
  { path: '/users', component: UsersCmp, name: 'Users' }
])
TabsCmp { ... }
```
In the above example, you can write just `['/Tab']` and the route `Users` is automatically selected as a child route.
Closes #4170
Closes #4490
Closes #4694
Closes #5200
Closes #5352
		
	
			
		
			
				
	
	
		
			307 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
			
		
		
	
	
			307 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
import {
 | 
						|
  AsyncTestCompleter,
 | 
						|
  beforeEach,
 | 
						|
  ddescribe,
 | 
						|
  describe,
 | 
						|
  expect,
 | 
						|
  iit,
 | 
						|
  inject,
 | 
						|
  it,
 | 
						|
  xdescribe,
 | 
						|
  xit,
 | 
						|
} from 'angular2/testing_internal';
 | 
						|
 | 
						|
import {bootstrap} from 'angular2/bootstrap';
 | 
						|
import {Component, Directive, View} from 'angular2/src/core/metadata';
 | 
						|
import {DOM} from 'angular2/src/platform/dom/dom_adapter';
 | 
						|
import {provide} from 'angular2/core';
 | 
						|
import {DOCUMENT} from 'angular2/src/platform/dom/dom_tokens';
 | 
						|
import {Type} from 'angular2/src/facade/lang';
 | 
						|
 | 
						|
import {
 | 
						|
  ROUTER_PROVIDERS,
 | 
						|
  Router,
 | 
						|
  RouteConfig,
 | 
						|
  APP_BASE_HREF,
 | 
						|
  ROUTER_DIRECTIVES
 | 
						|
} from 'angular2/router';
 | 
						|
 | 
						|
import {ExceptionHandler} from 'angular2/src/facade/exceptions';
 | 
						|
import {LocationStrategy} from 'angular2/src/router/location_strategy';
 | 
						|
import {MockLocationStrategy} from 'angular2/src/mock/mock_location_strategy';
 | 
						|
 | 
						|
class _ArrayLogger {
 | 
						|
  res: any[] = [];
 | 
						|
  log(s: any): void { this.res.push(s); }
 | 
						|
  logError(s: any): void { this.res.push(s); }
 | 
						|
  logGroup(s: any): void { this.res.push(s); }
 | 
						|
  logGroupEnd(){};
 | 
						|
}
 | 
						|
 | 
						|
export function main() {
 | 
						|
  describe('RouteConfig with POJO arguments', () => {
 | 
						|
    var fakeDoc, el, testBindings;
 | 
						|
    beforeEach(() => {
 | 
						|
      fakeDoc = DOM.createHtmlDocument();
 | 
						|
      el = DOM.createElement('app-cmp', fakeDoc);
 | 
						|
      DOM.appendChild(fakeDoc.body, el);
 | 
						|
      var logger = new _ArrayLogger();
 | 
						|
      var exceptionHandler = new ExceptionHandler(logger, true);
 | 
						|
      testBindings = [
 | 
						|
        ROUTER_PROVIDERS,
 | 
						|
        provide(LocationStrategy, {useClass: MockLocationStrategy}),
 | 
						|
        provide(DOCUMENT, {useValue: fakeDoc}),
 | 
						|
        provide(ExceptionHandler, {useValue: exceptionHandler})
 | 
						|
      ];
 | 
						|
    });
 | 
						|
 | 
						|
    it('should bootstrap an app with a hierarchy', inject([AsyncTestCompleter], (async) => {
 | 
						|
         bootstrap(HierarchyAppCmp, testBindings)
 | 
						|
             .then((applicationRef) => {
 | 
						|
               var router = applicationRef.hostComponent.router;
 | 
						|
               router.subscribe((_) => {
 | 
						|
                 expect(el).toHaveText('root { parent { hello } }');
 | 
						|
                 expect(applicationRef.hostComponent.location.path()).toEqual('/parent/child');
 | 
						|
                 async.done();
 | 
						|
               });
 | 
						|
               router.navigateByUrl('/parent/child');
 | 
						|
             });
 | 
						|
       }));
 | 
						|
 | 
						|
 | 
						|
    it('should work in an app with redirects', inject([AsyncTestCompleter], (async) => {
 | 
						|
         bootstrap(RedirectAppCmp, testBindings)
 | 
						|
             .then((applicationRef) => {
 | 
						|
               var router = applicationRef.hostComponent.router;
 | 
						|
               router.subscribe((_) => {
 | 
						|
                 expect(el).toHaveText('root { hello }');
 | 
						|
                 expect(applicationRef.hostComponent.location.path()).toEqual('/after');
 | 
						|
                 async.done();
 | 
						|
               });
 | 
						|
               router.navigateByUrl('/before');
 | 
						|
             });
 | 
						|
       }));
 | 
						|
 | 
						|
 | 
						|
    it('should work in an app with async components', inject([AsyncTestCompleter], (async) => {
 | 
						|
         bootstrap(AsyncAppCmp, testBindings)
 | 
						|
             .then((applicationRef) => {
 | 
						|
               var router = applicationRef.hostComponent.router;
 | 
						|
               router.subscribe((_) => {
 | 
						|
                 expect(el).toHaveText('root { hello }');
 | 
						|
                 expect(applicationRef.hostComponent.location.path()).toEqual('/hello');
 | 
						|
                 async.done();
 | 
						|
               });
 | 
						|
               router.navigateByUrl('/hello');
 | 
						|
             });
 | 
						|
       }));
 | 
						|
 | 
						|
 | 
						|
    it('should work in an app with aux routes', inject([AsyncTestCompleter], (async) => {
 | 
						|
         bootstrap(AuxAppCmp, testBindings)
 | 
						|
             .then((applicationRef) => {
 | 
						|
               var router = applicationRef.hostComponent.router;
 | 
						|
               router.subscribe((_) => {
 | 
						|
                 expect(el).toHaveText('root { hello } aside { hello }');
 | 
						|
                 expect(applicationRef.hostComponent.location.path()).toEqual('/hello(aside)');
 | 
						|
                 async.done();
 | 
						|
               });
 | 
						|
               router.navigateByUrl('/hello(aside)');
 | 
						|
             });
 | 
						|
       }));
 | 
						|
 | 
						|
 | 
						|
    it('should work in an app with async components defined with "loader"',
 | 
						|
       inject([AsyncTestCompleter], (async) => {
 | 
						|
         bootstrap(ConciseAsyncAppCmp, testBindings)
 | 
						|
             .then((applicationRef) => {
 | 
						|
               var router = applicationRef.hostComponent.router;
 | 
						|
               router.subscribe((_) => {
 | 
						|
                 expect(el).toHaveText('root { hello }');
 | 
						|
                 expect(applicationRef.hostComponent.location.path()).toEqual('/hello');
 | 
						|
                 async.done();
 | 
						|
               });
 | 
						|
               router.navigateByUrl('/hello');
 | 
						|
             });
 | 
						|
       }));
 | 
						|
 | 
						|
 | 
						|
    it('should work in an app with a constructor component',
 | 
						|
       inject([AsyncTestCompleter], (async) => {
 | 
						|
         bootstrap(ExplicitConstructorAppCmp, testBindings)
 | 
						|
             .then((applicationRef) => {
 | 
						|
               var router = applicationRef.hostComponent.router;
 | 
						|
               router.subscribe((_) => {
 | 
						|
                 expect(el).toHaveText('root { hello }');
 | 
						|
                 expect(applicationRef.hostComponent.location.path()).toEqual('/hello');
 | 
						|
                 async.done();
 | 
						|
               });
 | 
						|
               router.navigateByUrl('/hello');
 | 
						|
             });
 | 
						|
       }));
 | 
						|
 | 
						|
    it('should throw if a config is missing a target',
 | 
						|
       inject(
 | 
						|
           [AsyncTestCompleter],
 | 
						|
           (async) => {
 | 
						|
               bootstrap(WrongConfigCmp, testBindings)
 | 
						|
                   .catch((e) => {
 | 
						|
                     expect(e.originalException)
 | 
						|
                         .toContainError(
 | 
						|
                             'Route config should contain exactly one "component", "loader", or "redirectTo" property.');
 | 
						|
                     async.done();
 | 
						|
                     return null;
 | 
						|
                   })}));
 | 
						|
 | 
						|
    it('should throw if a config has an invalid component type',
 | 
						|
       inject(
 | 
						|
           [AsyncTestCompleter],
 | 
						|
           (async) => {
 | 
						|
               bootstrap(WrongComponentTypeCmp, testBindings)
 | 
						|
                   .catch((e) => {
 | 
						|
                     expect(e.originalException)
 | 
						|
                         .toContainError(
 | 
						|
                             'Invalid component type "intentionallyWrongComponentType". Valid types are "constructor" and "loader".');
 | 
						|
                     async.done();
 | 
						|
                     return null;
 | 
						|
                   })}));
 | 
						|
 | 
						|
    it('should throw if a config has an invalid alias name',
 | 
						|
       inject(
 | 
						|
           [AsyncTestCompleter],
 | 
						|
           (async) => {
 | 
						|
               bootstrap(BadAliasNameCmp, testBindings)
 | 
						|
                   .catch((e) => {
 | 
						|
                     expect(e.originalException)
 | 
						|
                         .toContainError(
 | 
						|
                             `Route "/child" with name "child" does not begin with an uppercase letter. Route names should be CamelCase like "Child".`);
 | 
						|
                     async.done();
 | 
						|
                     return null;
 | 
						|
                   })}));
 | 
						|
 | 
						|
    it('should throw if a config has an invalid alias name with "as"',
 | 
						|
       inject(
 | 
						|
           [AsyncTestCompleter],
 | 
						|
           (async) => {
 | 
						|
               bootstrap(BadAliasCmp, testBindings)
 | 
						|
                   .catch((e) => {
 | 
						|
                     expect(e.originalException)
 | 
						|
                         .toContainError(
 | 
						|
                             `Route "/child" with name "child" does not begin with an uppercase letter. Route names should be CamelCase like "Child".`);
 | 
						|
                     async.done();
 | 
						|
                     return null;
 | 
						|
                   })}));
 | 
						|
 | 
						|
    it('should throw if a config has multiple alias properties "as" and "name"',
 | 
						|
       inject([AsyncTestCompleter],
 | 
						|
              (async) => {
 | 
						|
                  bootstrap(MultipleAliasCmp, testBindings)
 | 
						|
                      .catch((e) => {
 | 
						|
                        expect(e.originalException)
 | 
						|
                            .toContainError(
 | 
						|
                                `Route config should contain exactly one "as" or "name" property.`);
 | 
						|
                        async.done();
 | 
						|
                        return null;
 | 
						|
                      })}));
 | 
						|
  });
 | 
						|
}
 | 
						|
 | 
						|
 | 
						|
@Component({selector: 'hello-cmp'})
 | 
						|
@View({template: 'hello'})
 | 
						|
class HelloCmp {
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([
 | 
						|
  {path: '/before', redirectTo: ['Hello']},
 | 
						|
  {path: '/after', component: HelloCmp, name: 'Hello'}
 | 
						|
])
 | 
						|
class RedirectAppCmp {
 | 
						|
  constructor(public router: Router, public location: LocationStrategy) {}
 | 
						|
}
 | 
						|
 | 
						|
function HelloLoader(): Promise<any> {
 | 
						|
  return Promise.resolve(HelloCmp);
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([
 | 
						|
  {path: '/hello', component: {type: 'loader', loader: HelloLoader}},
 | 
						|
])
 | 
						|
class AsyncAppCmp {
 | 
						|
  constructor(public router: Router, public location: LocationStrategy) {}
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([
 | 
						|
  {path: '/hello', loader: HelloLoader},
 | 
						|
])
 | 
						|
class ConciseAsyncAppCmp {
 | 
						|
  constructor(public router: Router, public location: LocationStrategy) {}
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> } aside { <router-outlet name="aside"></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([{path: '/hello', component: HelloCmp}, {aux: 'aside', component: HelloCmp}])
 | 
						|
class AuxAppCmp {
 | 
						|
  constructor(public router: Router, public location: LocationStrategy) {}
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([
 | 
						|
  {path: '/hello', component: {type: 'constructor', constructor: HelloCmp}},
 | 
						|
])
 | 
						|
class ExplicitConstructorAppCmp {
 | 
						|
  constructor(public router: Router, public location: LocationStrategy) {}
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'parent-cmp'})
 | 
						|
@View({template: `parent { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([{path: '/child', component: HelloCmp}])
 | 
						|
class ParentCmp {
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([{path: '/parent/...', component: ParentCmp}])
 | 
						|
class HierarchyAppCmp {
 | 
						|
  constructor(public router: Router, public location: LocationStrategy) {}
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([{path: '/hello'}])
 | 
						|
class WrongConfigCmp {
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([{path: '/child', component: HelloCmp, name: 'child'}])
 | 
						|
class BadAliasNameCmp {
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([{path: '/child', component: HelloCmp, as: 'child'}])
 | 
						|
class BadAliasCmp {
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([{path: '/child', component: HelloCmp, as: 'Child', name: 'Child'}])
 | 
						|
class MultipleAliasCmp {
 | 
						|
}
 | 
						|
 | 
						|
@Component({selector: 'app-cmp'})
 | 
						|
@View({template: `root { <router-outlet></router-outlet> }`, directives: ROUTER_DIRECTIVES})
 | 
						|
@RouteConfig([
 | 
						|
  {path: '/hello', component: {type: 'intentionallyWrongComponentType', constructor: HelloCmp}},
 | 
						|
])
 | 
						|
class WrongComponentTypeCmp {
 | 
						|
}
 |