angular/router - Speaker Deck

Slide 1

Slide 1 text

angular/router The New Angular Router

Slide 2

Slide 2 text

Hi, I’m Nikas Front end dev @ Wix.com/app-market @nikaspran github/nikaspran nikas.praninskas.com

Slide 3

Slide 3 text

The next 45 minutes of your life Prior art What is the New Angular Router? Migration Current state of affairs

Slide 4

Slide 4 text

Disclaimer: everything is Work In Progress

Slide 5

Slide 5 text

Prior art

Slide 6

Slide 6 text

What ARE frogs Routers?

Slide 7

Slide 7 text

Deep linking is awesome share information know at a glance contextualize bookmark The ability to

Slide 8

Slide 8 text

Don’t break the back button The back button is free and obvious It is very easy to be annoying if you break navigation

Slide 9

Slide 9 text

Structure for your app Forces you to modularize Makes apps easy to understand

Slide 10

Slide 10 text

ngRoute The default Angular 1 routing solution

Slide 11

Slide 11 text

ngRoute - very simple .config(function($routeProvider){ $routeProvider .when('/user/:id', { templateUrl: 'user.html', controller: 'UserCtrl', resolve: {...} }) .when('/user/:id/edit', { templateUrl: 'userEdit.html', controller: 'UserEditCtrl' }); }); One view per app One URL, one view

Slide 12

Slide 12 text

Good things come to those who wait .when('/user/:id', { ..., resolve: { user: function($q) { var data = $q.defer(); //get user data from API return data.promise; } } }) Inject into controller from configuration Waits until promises resolve

Slide 13

Slide 13 text

Simple, but too simple Difficult to do things like modals sidebars deep routes parallel views complex apps

Slide 14

Slide 14 text

UI Router The de facto Angular 1 routing solution

Slide 15

Slide 15 text

UI Router - much more powerful

State based routing .config(function($stateProvider){ $stateProvider .state('layout', { abstract: true, templateUrl: 'layout.html' }) .state('layout.user', { views: { sidebar: { templateUrl: 'sidebar.html', controller: 'SidebarCtrl', resolve: {...} }, content: {...} } }) });

Slide 16

Slide 16 text

States are intuitive States describe architecture Not everything has to have a URL Easy to link to parts of your application

Slide 17

Slide 17 text

Lots of utility

Slide 18

Slide 18 text

$state.is() $state.go() $state.href() $state.includes() Lots of utility …

Slide 19

Slide 19 text

Customizability is very important and UI Router does a pretty good job: christopherthielen/ui-router-extras onEnter, onExit, $stateChange*, ...

Slide 20

Slide 20 text

…up to a point Do something complex enough and you start fighting the router

Slide 21

Slide 21 text

Something complex enough

Slide 22

Slide 22 text

Same URL, different background state

Slide 23

Slide 23 text

Multiple paths that preserve history 1. Open App Market 2. Click App icon Use direct link to App (eg. via social) wix.com/app-market/:appName/overview

Slide 24

Slide 24 text

we spent way too much time fighting our tools at the time, we did a fork still not obvious how to do it all

Slide 25

Slide 25 text

Angular 2 is coming Can we do better with a clean slate?

Slide 26

Slide 26 text

Introducing The New Angular Router

Slide 27

Slide 27 text

Introducing The New Angular Router

Slide 28

Slide 28 text

Introducing Component Router

Slide 29

Slide 29 text

Goals

Slide 30

Slide 30 text

Be customizable… Let people do complex interesting surprising amazing things

Slide 31

Slide 31 text

…but have great defaults Make it obvious intuitive quick easy to learn and use

Slide 32

Slide 32 text

Multiple views /foo/bar foo bar foo bar parallel nested OR

Slide 33

Slide 33 text

State-like reverse routing Automatically deep link to components

Slide 34

Slide 34 text

State-like reverse routing Link to multiple components at once sidebar content mainPage

Slide 35

Slide 35 text

Thought experiment: The router is one of the most important parts of an application

Slide 36

Slide 36 text

So… If it is designed for Angular 2

Slide 37

Slide 37 text

If it is designed for Angular 2 but also works with Angular 1

Slide 38

Slide 38 text

If it is designed for Angular 2 but also works with Angular 1 We have a migration plan! ng1 ng2

Slide 39

Slide 39 text

Proposed migration scenario ng1 ng1 ng1 ng1 ng1 ng1 Angular 1 app

Slide 40

Slide 40 text

Proposed migration scenario ng1 ng1 ng1 ng2 ng1 ng1

Slide 41

Slide 41 text

Proposed migration scenario ng1 ng2 ng1 ng2 ng2 ng1

Slide 42

Slide 42 text

Proposed migration scenario ng2 ng2 ng2 ng2 ng2 ng2 Angular 2 app

Slide 43

Slide 43 text

まよたねぃみむょじをりぉねぼりぉけばやわゎおらゆろりぉけばやわゎおらゆじゃでりぐきなゕゟたょをこでぷおじぁだどぬすっらびぅぬだざまよたねぃみむょじをりぉねぼびぃぅやこそぶやあゝぼゆぺみひじえわぶすぞぷゑっぞほだ Show me the code already まよたねぃみむょじをりぉねぼろりぉけばやわゎおらゆほぞぁろりぉけばやわゎおびぃぅやこそぶやあゝぼゆぺみひじえわぶすぞぷゑっぞほだまよたねぃみむょじをろりぉけばやわゎおらゆほびぃぅやこそぶやあゝぼゆぺみひじえわぶすぞぷゑっまよたねぃみむょじをりぉねぼろりぉけばやわゎおらゆほぞぁろりぉけばやわゎびぃぅやこそぶやあゝぼゆぺみぶすぞぷゑっぞほだりぉけばやわゎおらゆほぞぁろりぉけばやわゎおぉけばやわゎおらゆほろりぉけばやわゎおらゆけばやわゎおらゆほぞぁろりぉけばやわゎおらゆをこでぷおじぁだどうえをこでぷおじぁだどうえぬすっらびぅぬだざぬすっらびぅぬだざぬすっらびぅぬだざぶすぞぷゑっぞほだゝぼゆぺみあゝぼゆぺみあゝぼゆぺみあゝぼゆぺみぬすっらびぅぬすっらびぅぬだざぬすっらびぅぬだざぬすっらびぅぬだざぬすっらびぅぬあゝぼゆぺみゝぼゆぺみまよたねびぃぅやこそぶまよたねぃみ

Slide 44

Slide 44 text

Angular 2.x import {ListComponent} from './list'; import {EditComponent} from './edit'; @Component({...}) @View({template: '...'}) @RouteConfig([ {path: '/', component: ListComponent}, {path: '/edit/:id', component: EditComponent} ]) class AppComponent() { ... }

Slide 45

Slide 45 text

Angular 1.x $componentMapper .setCtrlNameMapping(comp => comp + 'Ctrl'); $componentMapper .setTemplateMapping(comp => comp + '.html'); AppController.$routeConfig([ {path: '/', component: 'list'}, {path: '/edit/:id', component: 'edit'} ]); function AppController() { ... }

Slide 46

Slide 46 text

Static configuration {path: '/', component: 'list'}, {path: '/edit/:id', component: 'edit'} {path: '/', component: ListComponent}, {path: '/edit/:id', component: EditComponent} ng2 ng1 === easy to port

Slide 47

Slide 47 text

Component Router Components Outlets Instructions Pipeline

Slide 48

Slide 48 text

Component Router Components Outlets Instructions Pipeline

Slide 49

Slide 49 text

So what’s a component anyway? Template Controller Router

Slide 50

Slide 50 text

Template - ng2 @View({template: '...'}) @View({templateUrl: '...'})

Slide 51

Slide 51 text

Template - ng1 $componentMapper .setTemplateMapping(function (compName) { return templatePath; }); ./components/my-comp/my-comp.html myComp Uses component convention by default: Customize as you want:

Slide 52

Slide 52 text

“Controller” - ng2 class MyComp() {...}

Slide 53

Slide 53 text

Controller - ng1 $componentMapper .setCtrlNameMapping(function (compName) { return controllerName; }); Adds “Controller” by default: Customize as you want: MyCompController myComp

Slide 54

Slide 54 text

Router Each component can have a child router Child routers manage their sub-URLs

Slide 55

Slide 55 text

You can release it as an artifact They can mount and use it SO,if you build an amazing component with deep linking

Slide 56

Slide 56 text

Router - ng2 @RouteConfig([ {path: '/', redirectTo: '/main'}, {path: '/main', component: MainComp}, {path: '/other', components: {}, as: 'other'} ])

Slide 57

Slide 57 text

Router - ng1 function MainController($router) { $router.config([...]); } function MainController() {...}; MainController.$routeConfig([...]);

Slide 58

Slide 58 text

Component Router Components Outlets Instructions Pipeline

Slide 59

Slide 59 text

Outlet - think ui-view

{path: '/', components: { default: 'posts', left: 'users' }}

Slide 60

Slide 60 text

Component Router Components Outlets Instructions Pipeline

Slide 61

Slide 61 text

Instruction Holds all the context for a transition: Outlets, path, parameters, ...

Slide 62

Slide 62 text

Component Router Components Outlets Instructions Pipeline

Slide 63

Slide 63 text

Pipeline - it’s middleware Takes Instruction Transforms it ..with side effects $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep

Slide 64

Slide 64 text

E.g.: pipeline in Angular 1.x $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep Pipeline

Slide 65

Slide 65 text

Let’s ask the router to go somewhere $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep router.navigate('users/123')

Slide 66

Slide 66 text

Router generates the instruction $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep router.navigate('users/123') recognize(): instruction matchedUrl component router children: Instruction[]

Slide 67

Slide 67 text

Once more unto the pipeline! $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep matchedUrl component router children: Instruction[]

Slide 68

Slide 68 text

$setupRoutersStep $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep matchedUrl component router children: Instruction[] Add child instruction routers

Slide 69

Slide 69 text

$initLocalsStep $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep matchedUrl component router children: Instruction[] locals Add locals: $router, $routeParams

Slide 70

Slide 70 text

$runCanDeactivateHookStep $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep matchedUrl component router children: Instruction[] locals Visit old outlets; run canDeactivate()

Slide 71

Slide 71 text

$runCanActivateHookStep $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep matchedUrl component router children: Instruction[] locals Visit new outlets; run canActivate()

Slide 72

Slide 72 text

$loadTemplatesStep $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep matchedUrl component router children: Instruction[] locals template Load templates, add to instruction

Slide 73

Slide 73 text

$activateStep $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep matchedUrl component router children: Instruction[] locals template Recursively activate outlets (ctrl, tmpl, ...)

Slide 74

Slide 74 text

Final step… Update $location: http://someHost/base/users/123 … and done!

Slide 75

Slide 75 text

Pipeline - it’s customizable $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep Up to you

Slide 76

Slide 76 text

E.g.: let’s add resolve $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep resolveStep

Slide 77

Slide 77 text

Create our step factory .factory('resolveStep', function ($q, $injector) { return function resolve(instruction) { }; })

Slide 78

Slide 78 text

Recurse over instructions .factory('resolveStep', function ($q, $injector) { return function resolve(instruction) { var promises = []; return instruction.router.traverseInstruction( instruction, queueResolves ).then(function () { return $q.all(promises); }); }; })

Slide 79

Slide 79 text

Get config from instruction .factory('resolveStep', function ($q, $injector) { return function resolve(instruction) { var promises = []; function queueResolves(instruction) { var cfg = getResolveConfigFrom(instruction); } return instruction.router.traverseInstruction( instruction, queueResolves ).then(function () { return $q.all(promises); }); }; })

Slide 80

Slide 80 text

Queue the resolution .factory('resolveStep', function ($q, $injector) { return function resolve(instruction) { var promises = []; function queueResolves(instruction) { var cfg = getResolveConfigFrom(instruction); var resolve = $q.when($injector.invoke(cfg.value)); promises.push(resolve.then(function (resolved) { })); } return instruction.router.traverseInstruction( instruction, queueResolves ).then(function () { return $q.all(promises); }); }; })

Slide 81

Slide 81 text

Add it to locals .factory('resolveStep', function ($q, $injector) { return function resolve(instruction) { var promises = []; function queueResolves(instruction) { var cfg = getResolveConfigFrom(instruction); var resolve = $q.when($injector.invoke(cfg.value)); promises.push(resolve.then(function (resolved) { instruction.locals[cfg.key] = resolved; })); } return instruction.router.traverseInstruction( instruction, queueResolves ).then(function () { return $q.all(promises); }); }; })

Slide 82

Slide 82 text

Insert it into the pipeline .config(function ($pipelineProvider) { var steps = $pipelineProvider.steps; var atPosition = steps.indexOf('$runCanDeactivateHookStep) + 1; //insert resolveStep after $runCanDeactivateHookStep steps.splice(atPosition, 0, 'resolveStep'); $pipelineProvider.config(steps); })

Slide 83

Slide 83 text

End result $setupRoutersStep $initLocalsStep $runCanDeactivateHookStep $runCanActivateHookStep $loadTemplatesStep $activateStep resolveStep Part of the pipeline Called on every transition

Slide 84

Slide 84 text

> implications Standardized extension Make it suit your app Publish and prosper

Slide 85

Slide 85 text

Component Router Components Outlets Instructions Pipeline Other “stuff”

Slide 86

Slide 86 text

Sticky components This is how it currently works Under consideration and desirable

Slide 87

Slide 87 text

Dynamic loading Add new routes @ runtime: function SomeController($router) { $router.config([...]); }

Slide 88

Slide 88 text

Recursive components Not sure how practical, but why not

Slide 89

Slide 89 text

Migration

Slide 90

Slide 90 text

ng1 + ngComponentRouter ng2 ng 1.5 + new router Some things we know

Slide 91

Slide 91 text

And some we don’t ng1 + X ng1 + ngComponentRouter ng2 ng 1.5 + new router ?

Slide 92

Slide 92 text

ngRoute is too simple to worry about

Slide 93

Slide 93 text

Migration strategies from UI Router are a TODO item But one can dream…

Slide 94

Slide 94 text

Multi-components are sort of like states $router.config([{ as: 'category', path: '/:category', components: { sidebar: 'Sidebar', content: 'Category' } }]); $stateProvider .state('category', { url: '/:category', views: { sidebar: { templateUrl: '...', controller: '...' }, content: { templateUrl: '...', controller: '...' } } }); ui-router compRouter

Slide 95

Slide 95 text

Directives are sort of similar ~== ui-router compRouter

Slide 96

Slide 96 text

What about what’s missing? Well…

Slide 97

Slide 97 text

Pipeline! e.g. we saw how to add resolve we can fake $stateChangeEvents someone write an adapter? :)

Slide 98

Slide 98 text

How can we prepare? Use similar conventions Component-like architecture Component-like file structure

Slide 99

Slide 99 text

Write unit tests UI Router configuration is testable Write now, then verify migration later http://nikas.praninskas.com/test-ui-router Component Router should be even easier

Slide 100

Slide 100 text

Current $state of affairs //TODO: draw something totally awesome like robots and lasers and stuff and maybe a cat

Slide 101

Slide 101 text

Documentation!

Slide 102

Slide 102 text

Read the source, Luke: github.com/angular/router

Slide 103

Slide 103 text

github.com/angular/angular …no wait, now it’s:

Slide 104

Slide 104 text

but only temporarily…

Slide 105

Slide 105 text

Codebase is a bit of a mess: 1.x has not worked for over a month everything in ng2 repo until build is stable still working out core issues (i.e. reverse routing)

Slide 106

Slide 106 text

When? Originally slated for 1.4

Slide 107

Slide 107 text

…but probably not anymore: :(

Slide 108

Slide 108 text

June-July? (my somewhat educated guess)

Slide 109

Slide 109 text

In place of a summary Designed from the ground up; New ideas for the future; Lessons learned from the past; Not yet ready.

Slide 110

Slide 110 text

Thank you! nikas.praninskas.com github/nikaspran @nikaspran