Public Router service MVP #14805

scalvert · 2017-01-09T21:08:03Z

This PR represents the MVP of the public router service described in this RFC. It incorporates work done by @locks in this PR.

It includes a minimal API:

currentRouteName
currentURL
location
rootURL
transitionTo

Status: Work in progress

Reviewers: @locks @rwjblue @ef4

Changes:

Added ember-routing-router-service feature flag
Added new router service and minimal API as described above
Added deprecation warning for use of private router service when feature enabled
Tests in progress

How to test drive this PR:

yarn start
Open up 2 tabs pointing to http://localhost:4200/tests/index.html, one with Enable Opt Features checked, ensure tests pass

TODO:
Write tests for

RFC Implementation Phases

MVP for public router service with minimal API
Extended API, building on the work in phase 1
Implementation of urlFor, ensuring correct performance profile
Implementation of RouteInfo and associated API

chadhietala · 2017-01-09T21:23:44Z

packages/ember-routing/lib/services/router.js

+  urlFor() {
+    let router = get(this, 'router');
+
+    return router.generate(...arguments);


Doesn't this still take the slow path with the QPs?

Good question. Will verify.

Removing until we verify the implementation details.

krisselden

Any API that doesn't meet the RFC here https://github.com/emberjs/rfcs/blob/master/text/0095-router-service.md#query-parameter-semantics shouldn't be included until it does.

homu · 2017-01-09T22:34:13Z

☔ The latest upstream changes (presumably #14806) made this pull request unmergeable. Please resolve the merge conflicts.

scalvert · 2017-01-10T19:10:55Z

Added tests for currentRouteName.

scalvert · 2017-01-10T21:58:59Z

@krisselden I've stripped the urlFor implementation out of this review. We can work out how to proceed in a subsequent review.

rwjblue · 2017-01-11T17:46:58Z

packages/ember-application/lib/system/application.js

@@ -34,6 +34,8 @@ import ApplicationInstance from './application-instance';
 import { privatize as P } from 'container';
 import Engine from './engine';
 import { setupApplicationRegistry } from 'ember-glimmer';
+import RouterService from 'ember-routing/services/router';
+import isEnabled from 'ember-metal/features';


import { isFeatureEnabled } from 'ember-metal';

rwjblue · 2017-01-11T17:48:40Z

packages/ember-application/lib/system/application.js

@@ -34,6 +34,8 @@ import ApplicationInstance from './application-instance';
 import { privatize as P } from 'container';
 import Engine from './engine';
 import { setupApplicationRegistry } from 'ember-glimmer';
+import RouterService from 'ember-routing/services/router';


import { RouterService } from 'ember-routing';

rwjblue · 2017-01-11T17:49:51Z

packages/ember-routing/lib/services/router.js

+@submodule ember-routing
+*/
+
+import Service from 'ember-runtime/system/service';


Imports should be from the entry points (e.g. from 'ember-runtime'; instead of from 'ember-runtime/somethign';)

rwjblue · 2017-01-11T17:53:17Z

packages/ember-routing/lib/services/router.js

+      containing a mapping of query parameters
+    @return {Transition} the transition object associated with this
+      attempted transition
+    @public


We should add @category ember-routing-router-service so that the YUIDoc will be able to remove these until the feature is enabled

rwjblue · 2017-01-11T17:55:10Z

packages/ember-routing/lib/services/router.js

+    @public
+  */
+  transitionTo() {
+    let router = get(this, 'router');


Since this is injected we should be able to swap this to just this.router here.

rwjblue · 2017-01-11T17:56:49Z

packages/ember/tests/routing/router_service_test.js

+  get
+} from 'ember-metal';
+import { jQuery } from 'ember-views';
+import { inject } from 'ember-runtime';


Group with the ember-runtime import above...

rwjblue · 2017-01-11T17:57:47Z

packages/ember/tests/routing/router_service_test.js

+import { inject } from 'ember-runtime';
+import { ApplicationTestCase, moduleFor } from 'internal-test-helpers';
+
+import isEnabled from 'ember-metal/features';


import { isFeatureEnabled } from 'ember-metal';

rwjblue · 2017-01-11T17:58:13Z

packages/ember/tests/routing/router_service_test.js

+      this.registerRoute('parent', Route.extend({
+        router: inject.service(),
+        init() {
+          routerService = get(this, 'router');


we should call _super before this here

Done for all inits.

rwjblue · 2017-01-11T18:02:01Z

packages/ember/tests/routing/router_service_test.js

+      return this.visit('/child').then(() => {
+        assert.equal(routerService.get('currentRouteName'), 'parent.child');
+
+        return this.visit('/sister').then(() => {


return this.visit('/child').then(() => { return this.visit('/sister'); }).then(() => { assert.equal(routerService.get('currentRouteName'), 'parent.sister'); return this.visit('/brother'); }).then(() => { assert.equal(routerService.get('currentRouteName'), 'parent.brother'); });

rwjblue · 2017-01-11T18:03:03Z

packages/ember-routing/lib/services/router.js

+  currentRouteName: readOnly('router.currentRouteName'),
+  currentURL: readOnly('router.location.path'),
+  location: readOnly('router.location'),
+  rootUrL: readOnly('router.rootURL'),


Correct the casing here (I think it should be rootURL)

locks · 2017-01-12T15:26:47Z

packages/ember-routing/lib/services/router.js

+import { get } from 'ember-metal';
+import RouterDSL from '../system/dsl';
+
+/*


The docstrings don't seem to match out usual style, see Router for example.

I'll update.

krisselden · 2017-01-13T01:14:17Z

I'd love @ef4 review to see if there is any concern about the timing of when these properties update as compared to the RFC, I know that the RFC was a chance to improve the router not just give it a prettier API.

rwjblue

This is looking really good! I'm glad you got to the bottom of that currentURL async issue we chatted about. 👏

I think the only real thing missing here at this point are some tests for .transitionTo, .rootURL, and .location properties.

rwjblue · 2017-01-13T04:07:13Z

packages/ember-routing/lib/services/router.js

+  Service,
+  readOnly
+} from 'ember-runtime';
+import { get, descriptor } from 'ember-metal';


Descriptor seems unused

I'll remove it. Thanks!

rwjblue · 2017-01-13T14:16:19Z

packages/ember-routing/lib/system/router.js

@@ -629,6 +633,7 @@ const EmberRouter = EmberObject.extend(Evented, {

    let doUpdateURL = function() {
      location.setURL(lastURL);
+      set(emberRouter, 'currentURL', lastURL);


I think we should actually do this in the router.updateURL and router.replaceURL methods directly above the run.once(doUpdateURL) bit...

I can do that. My thought was I wanted to keep both set calls in the same place, but these methods are so closely related that it's find either way.

Ah, so it turns out that setting this after a scheduled call is what's fixing this issue. So, it looks like I have to leave it where it is.

rwjblue · 2017-01-13T14:17:43Z

packages/ember-routing/lib/system/router.js


  set(router, 'currentPath', path);
  set(router, 'currentRouteName', currentRouteName);
+  set(router, 'currentURL', currentURL);


I would think this change is not needed since we are setting router.currentURL above in the changes to _setupRouter.

I thought this too, initially. It turns out that there's a different codepath whether you're visiting vs. transitioning, and we need this update to occur in both places. I think this surfaces part of @krisselden's concerns, where we want to take advantage, while we have the engine out on the floor, to refactor this to make it cleaner and more consistent.

rwjblue · 2017-01-13T14:23:30Z

packages/ember-routing/lib/services/router.js

+   access to the router.
+
+   @public
+   @class RouterService


Should add the @category ember-routing-router-service flag here too (so that while the feature is pending it isn't listed in emberjs.com/api).

scalvert · 2017-01-13T16:52:05Z

@rwjblue thanks for the additional comments. I'm adding tests for the outstanding properties/method now - mainly taking it slow so I make sure I cover high value test cases.

scalvert · 2017-01-13T16:56:31Z

@krisselden I appreciate you wanting to make sure we're focussing on the right things with this PR, in terms of the opportunity to improve the router in general. This intent of this particular PR is to get a useful public API for the router in the hands of devs sooner rather than later. This will help provide immediate value, but does not preclude us circling back and refactoring parts of the internals later. In fact, that's our direct intention. We wanted to try to restrict these changes to simple, surface level changes before we get into the more meaty implementation, specifically the refactoring to use RouteInfo. Does this make sense to you?

I'll update the PR's description above to indicate the 4 phases, as discussed by @rwjblue and I.

workmanw · 2017-01-13T17:17:13Z

This is super exciting. Thank you for taking this on and helping driving it home.

One additional thing I'd really like to see fall into one of the later phases is some mechanism for components to subscribe to willTransition and didTransition. We use that kind of thing so often in our app to prevent transitioning when data is dirty. I know the RFC talks about providing new hooks to do that and that might mean willTransition and didTransition have to wait until that part is flushed out. I just don't want to see these guys forgotten about.

rwjblue · 2017-01-14T14:52:05Z

packages/ember/tests/routing/router_service_test.js

+      return this.visit('/').then(() => {
+        let location = routerService.get('location');
+        assert.ok(location);
+        assert.ok(location instanceof Ember.NoneLocation);


This should be imported from ember-routing/locations/none (using global Ember within Ember or the test suite isn't allowed). This is currently causing the linting tests to fail...

Oh weird. I didn't see that failure. Will fix right now!

rwjblue · 2017-01-14T14:53:48Z

packages/ember/tests/routing/router_service_test.js

+        routerService: inject.service('router'),
+        init() {
+          this._super();
+          set(this.router, 'rootURL', '/test');


I have a slight preference to use something other than /test here (since when tests are running we are already in /tests path). It definitely doesn't matter for this test as written, but it would just make this a tad bit easier for my brain to parse 😝

Will change to /brainparse immediately! :)

rwjblue · 2017-01-19T22:49:12Z

packages/ember/tests/routing/router_service_test/currenturl_lifecycle_test.js

+
+      return this.visit('/').then(() => {
+        this.assertText('/');
+      });


Can you add an update and reset phase to this (kinda like the INUR stuff for the glimmer tests)?

I'm thinking something like:

.then(() => routerService.transitionTo('child')) .then(() => this.assertText('/child')) .then(() => routerService.transitionTo('/')) .then(() => this.assertText('/'))

rwjblue · 2017-01-19T22:49:41Z

packages/ember/tests/routing/router_service_test/currenturl_lifecycle_test.js

+        })
+        .then(() => {
+          this.assertText('/child');
+        });


Can you add the update and reset steps (similar to comment for test above)?

Router Service RFC

nickiaconis · 2017-06-29T06:42:39Z

@workmanw The RFC introduces the routeWillChange and routeDidChange events in place of the willTransition and didTransition hooks/events, but I agree. I too would like to ensure they're on the roadmap.

janmisek · 2018-05-11T09:12:50Z

What about rest of features covered by RFC (RouteInfo, transition events ...) ? is there any subsequent issue to track it ?

locks · 2018-05-14T10:43:13Z

@janmisek There is not.

janmisek · 2018-05-15T08:06:43Z

And are these features still planned for implementation ?

ef4 · 2018-05-16T22:12:33Z

Yes, the RFC is merged which means anyone can PR the features. I started on several of them but had to back off to clear some other blockers first.

chadhietala reviewed Jan 9, 2017

View reviewed changes

krisselden requested changes Jan 9, 2017

View reviewed changes

locks requested review from rwjblue and ef4 January 9, 2017 22:59

locks mentioned this pull request Jan 9, 2017

[WIP] Router service #13868

Closed

scalvert force-pushed the router-service branch from d88ba0f to eb763a9 Compare January 10, 2017 22:25

rwjblue reviewed Jan 11, 2017

View reviewed changes

locks requested changes Jan 12, 2017

View reviewed changes

scalvert mentioned this pull request Jan 13, 2017

trying to get location during route's hook gives you the previous location #10906

Closed

krisselden approved these changes Jan 13, 2017

View reviewed changes

rwjblue reviewed Jan 13, 2017

View reviewed changes

locks approved these changes Jan 13, 2017

View reviewed changes

rwjblue reviewed Jan 14, 2017

View reviewed changes

rwjblue reviewed Jan 19, 2017

View reviewed changes

[FEATURE ember-routing-router-service] - Implementing phase 1 of public

7daa911

Router Service RFC

scalvert force-pushed the router-service branch from b38c1d5 to 7daa911 Compare January 20, 2017 00:02

scalvert changed the title ~~[WIP] - Public Router service MVP~~ Public Router service MVP Jan 20, 2017

rwjblue approved these changes Jan 20, 2017

View reviewed changes

rwjblue merged commit 9cbf9f3 into emberjs:master Jan 20, 2017

MartinMalinda mentioned this pull request Apr 19, 2017

Handle /release requests ember-learn/ember-api-docs#209

Merged

4 tasks

Public Router service MVP #14805

Public Router service MVP #14805

Conversation

scalvert commented Jan 9, 2017 • edited Loading

RFC Implementation Phases

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krisselden left a comment

Choose a reason for hiding this comment

homu commented Jan 9, 2017

scalvert commented Jan 10, 2017

scalvert commented Jan 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krisselden commented Jan 13, 2017

rwjblue left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

scalvert commented Jan 13, 2017

scalvert commented Jan 13, 2017

workmanw commented Jan 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nickiaconis commented Jun 29, 2017 • edited Loading

janmisek commented May 11, 2018

locks commented May 14, 2018

janmisek commented May 15, 2018

ef4 commented May 16, 2018

scalvert commented Jan 9, 2017 •

edited

Loading

nickiaconis commented Jun 29, 2017 •

edited

Loading