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.

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

Deprecate Application Controller Router Properties #421

Merged
merged 4 commits into from
Feb 5, 2019
Merged
Changes from all commits
Commits
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
83 changes: 83 additions & 0 deletions text/0421-deprecate-application-controller-props.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
- Start Date: 2018-19-12
- RFC PR: https://github.com/emberjs/rfcs/pull/421
- Ember Issue: (leave this empty)

# Deprecate Application Controller Router Properties

## Summary

This RFC proposes the deprecation of `ApplicationController#currentPath` and `ApplicationController#currentRouteName`.

## Motivation

These APIs are no longer needed as the `RouterService` now has `RouterService#currentPath` and `RouterService#currentRouteName`.
These fields are only ever present on the application controller which is a weird special casing that we would like to remove.
Additionally, it's likely that there are very few if any consumers of this API as it is not documented.

## Transition Path

If you are reliant on `ApplicationController#currentPath` and `ApplicationController#currentRouteName` you can get the same functionality from the `RouterService` to migrate, inject the `RouterService` and read the `currentRouteName` or `currentPath` off of it.

Before:

```js
// app/controllers/application.js
import Controller from '@ember/controller';
import fetch from 'fetch';

export default Controller.extend({
store: service('store'),

actions: {
sendPayload() {
fetch('/endpoint', {
method: 'POST',
body: JSON.stringify({
route: this.currentRouteName
})
});
}
}
})
```

After:

```js
// app/controllers/application.js
import Controller from '@ember/controller';
import fetch from 'fetch';

export default Controller.extend({
store: service('store'),
router: service('router'),

actions: {
sendPayload() {
fetch('/endpoint', {
method: 'POST',
body: JSON.stringify({
route: this.router.currentRouteName
})
});
}
}
})
```

## How We Teach This

There is likely very few consumers of this functionality and migration path is covered by existing documentation.

## Drawbacks

This may introduce churn that we are not aware of.

## Alternatives

No real alternative other than keep setting the properties.

## Unresolved questions

Optional, but suggested for first drafts. What parts of the design are still
TBD?