Ghost/ghost/admin/app/services/navigation.js
Kevin Ansfield c646e78fff Made session.user a synchronous property rather than a promise
no issue

Having `session.user` return a promise made dealing with it in components difficult because you always had to remember it returned a promise rather than a model and had to handle the async behaviour. It also meant that you couldn't use any current user properties directly inside getters which made refactors to Glimmer/Octane idioms harder to reason about.

`session.user` was a cached computed property so it really made no sense for it to be a promise - it was loaded on first access and then always returned instantly but with a fulfilled promise rather than the  underlying model.

Refactoring to a synchronous property that is loaded as part of the authentication flows (we load the current user to check that we're logged in - we may as well make use of that!) means one less thing to be aware of/remember and provides a nicer migration process to Glimmer components. As part of the refactor, the auth flows and pre-load of required data across other services was also simplified to make it easier to find and follow.

- refactored app setup and `session.user`
  - added `session.populateUser()` that fetches a user model from the current user endpoint and sets it on `session.user`
  - removed knowledge of app setup from the `cookie` authenticator and moved it into = `session.postAuthPreparation()`, this means we have the same post-authentication setup no matter which authenticator is used so we have more consistent behaviour in tests which don't use the `cookie` authenticator
  - switched `session` service to native class syntax to get the expected `super()` behaviour
  - updated `handleAuthentication()` so it populate's `session.user` and performs post-auth setup before transitioning (handles sign-in after app load)
  - updated `application` route to remove duplicated knowledge of app preload behaviour that now lives in `session.postAuthPreparation()` (handles already-authed app load)
  - removed out-of-date attempt at pre-loading data from setup controller as that's now handled automatically via `session.handleAuthentication`
- updated app code to not treat `session.user` as a promise
  - predominant usage was router `beforeModel` hooks that transitioned users without valid permissions, this sets us up for an easier removal of the `current-user-settings` mixin in the future
2021-07-08 14:54:31 +01:00

60 lines
1.9 KiB
JavaScript

import Service from '@ember/service';
import {action} from '@ember/object';
import {observes} from '@ember-decorators/object';
import {inject as service} from '@ember/service';
import {set} from '@ember/object';
import {tracked} from '@glimmer/tracking';
const DEFAULT_SETTINGS = {
expanded: {
posts: true
}
};
export default class NavigationService extends Service {
@service session;
@tracked settings;
constructor() {
super(...arguments);
this.settings = Object.assign({}, DEFAULT_SETTINGS);
this.updateSettings();
}
// eslint-disable-next-line ghost/ember/no-observers
@observes('session.{isAuthenticated,user}', 'session.user.accessibility')
async updateSettings() {
// avoid fetching user before authenticated otherwise the 403 can fire
// during authentication and cause errors during setup/signin
if (!this.session.isAuthenticated || !this.session.user) {
return;
}
let userSettings = JSON.parse(this.session.user.accessibility || '{}') || {};
this.settings = userSettings.navigation || Object.assign({}, DEFAULT_SETTINGS);
}
@action
async toggleExpansion(key) {
if (!this.settings.expanded) {
this.settings.expanded = {};
}
// set is still needed here because we're not tracking deep keys
// and Ember picks up that our templates are dependent on them and
// complains. TODO: can we avoid set?
set(this.settings.expanded, key, !this.settings.expanded[key]);
return await this._saveNavigationSettings();
}
async _saveNavigationSettings() {
let user = this.session.user;
let userSettings = JSON.parse(user.get('accessibility')) || {};
userSettings.navigation = this.settings;
user.set('accessibility', JSON.stringify(userSettings));
return user.save();
}
}