Deprecate mixins

[marcoow]

This PR deprecates the mixins and introduces a new API that is exposed completely via the session service.

We discussed a few options for replacing the current mixins with a new mechanism in #2185 (thanks to everyone who chimed in!) but focussed mostly on concepts that would replace the mixins directly. Since we have dropped support for older versions of Ember though and now have new capabilities that we can leverage that were not available when ESA's current mixin mechanism was first introduced, I realized we could build a completely new API.

Historically, transitioning between routes was only really possible from route classes (or controllers) since there was no routing service. For that reason, we had to establish a connection between the session and its change state on one side and the routes on the other side. With the routing service that is no longer necessary though as we can transition between routes from the session directly using the service. That means we can just drop the ApplicationRouteMixin that implemented the above described connection between the routing layer and the session and handle all of that in the session itself. We still maintain customizability of course since any app can simply extend the session service and override the respective methods, similar to how you would do the same thing in the application route currently.

The AuthenticatedRouteMixin's and UnauthenticatedRouteMixin's main responsibilities were adding custom logic into the route classes' beforeModel methods that would check for the session to be authenticated or not and transition elsewhere etc. A mixin is a nice way to share that code and automatically put it in the right place. While exposing that API via the session service now will require a bit more code, it still doesn't put significant additional cognitive load on the developer and it's easy to extract the code into a base class if one wanted to do that:

export default ProtectedRoute extends Route {
  @service session;

  beforeModel(transition) {
    this.session.requireAuthentication(transition, 'login');
  }
}

The opposite of this would be this.session.prohibitAuthentication('index') for disallowing a route to be visited when the session is authenticated already.

The OAuth2ImplicitGrantCallbackRouteMixin and DataAdapterMixin mixins are deprecated without 1:1 replacements. They provide very little value anyway and would usually only be used once per application. Thus, adding guidance in the docs for achieving the respective behavior should be sufficient.

TODO

• update README and guides
• deprecate DataAdapterMixin
• deprecate OAuth2ImplicitGrantCallbackRouteMixin
• update the API docs template to show the deprecation status of mixins

closes #2185

[jelhan]

Thanks a lot for putting all that work into Ember Simple Auth! To small comments on the API design. Hope it's helpful.

[patsy-issa]

One minor clarification, loving the new api <3

[patsy-issa]

One minor fix needed for the readme and this looks good to go.

[patsy-issa]

hmm any ideas on why the specs are failing?

[marcoow]

@patsy-issa I think we're running into this: ember-cli/babel-plugin-ember-modules-api-polyfill#64 (it's also broken on master)

[rwjblue]

@marcoow - ember-cli-babel@7.20.1 was just released, and should fix the underlying issue referenced in ember-cli/babel-plugin-ember-modules-api-polyfill#64.

https://github.com/babel/ember-cli-babel/releases/tag/v7.20.1

[marcoow]

Thanks @rwjblue ❤️

[marcoow]

Unfortunately we're running into ember-cli/babel-plugin-ember-modules-api-polyfill#110 now…

[marcoow]

@patsy-issa CI is green now

[patsy-issa]

[pjcarly]

Great to see this merged. Thanks for the amazing work!

Any idea when we can expect a release?

[sdebarros]

@pjcarly we released a beta version including this today. 🎉