Ghost/ghost/admin/app/routes/application.js
Kevin Ansfield 459a2c553e Added full-page refresh when new post route is in a bad state
ref https://linear.app/tryghost/issue/ONC-323

When the store gets into a bad state for new posts that causes saves to fail we can detect that by looking at the `model.isNew` property. Currently our best approach to fix this state is to restart the app.

- added a `didTransition()` hook to our `lexical-edit.new` route
  - detects the bad state, logs the error, and triggers a browser refresh
  - logs with a `recreatedPostIsGood` property that will let us know if we could instead just try recreating the post and avoiding a full refresh (so far we have no reproduction case so we need to learn what we can)
- added `sinon-chai` dependency for better assertions on spies/stubs
- added `sentry-testkit` dependency so we can test our Sentry integration calls
  - we can't use sinon for these calls because of the way Sentry's es6 imports work
- extracted our full Sentry config object generation to a util function so it can be re-used in unit tests
  - updated our integrations list to disable the default `dedupe` integration because it can cause very unexpected/difficult to debug test failures when you're asserting using `sentry-testkit`
2024-09-23 22:38:34 +01:00

211 lines
6.1 KiB
JavaScript

import * as Sentry from '@sentry/ember';
import AdminXSettings from '../components/admin-x/settings';
import AuthConfiguration from 'ember-simple-auth/configuration';
import React from 'react';
import ReactDOM from 'react-dom';
import Route from '@ember/routing/route';
import ShortcutsRoute from 'ghost-admin/mixins/shortcuts-route';
import ctrlOrCmd from 'ghost-admin/utils/ctrl-or-cmd';
import windowProxy from 'ghost-admin/utils/window-proxy';
import {getSentryConfig} from '../utils/sentry';
import {importComponent} from '../components/admin-x/admin-x-component';
import {inject} from 'ghost-admin/decorators/inject';
import {
isAjaxError,
isNotFoundError,
isUnauthorizedError
} from 'ember-ajax/errors';
import {isArray as isEmberArray} from '@ember/array';
import {
isMaintenanceError,
isVersionMismatchError
} from 'ghost-admin/services/ajax';
import {later} from '@ember/runloop';
import {inject as service} from '@ember/service';
function K() {
return this;
}
let shortcuts = {};
shortcuts.esc = {action: 'closeMenus', scope: 'default'};
shortcuts[`${ctrlOrCmd}+s`] = {action: 'save', scope: 'all'};
// make globals available for any pulled in UMD components
// - avoids external components needing to bundle React and running into multiple version errors
window.React = React;
window.ReactDOM = ReactDOM;
export default Route.extend(ShortcutsRoute, {
ajax: service(),
configManager: service(),
feature: service(),
ghostPaths: service(),
notifications: service(),
router: service(),
session: service(),
settings: service(),
ui: service(),
whatsNew: service(),
billing: service(),
shortcuts,
routeAfterAuthentication: 'home',
init() {
this._super(...arguments);
this.router.on('routeDidChange', () => {
this.notifications.displayDelayed();
});
this.ui.initBodyDragHandlers();
},
config: inject(),
async beforeModel() {
await this.session.setup();
return this.prepareApp();
},
async afterModel(model, transition) {
this._super(...arguments);
if (this.get('session.isAuthenticated')) {
this.session.appLoadTransition = transition;
}
this._appLoaded = true;
},
actions: {
closeMenus() {
this.ui.closeMenus();
},
didTransition() {
this.session.appLoadTransition = null;
this.send('closeMenus');
// Need a tiny delay here to allow the router to update to the current route
later(() => {
Sentry.setTag('route', this.router.currentRouteName);
}, 2);
},
authorizationFailed() {
windowProxy.replaceLocation(AuthConfiguration.rootURL);
},
// noop default for unhandled save (used from shortcuts)
save: K,
error(error, transition) {
// unauthorized errors are already handled in the ajax service
if (isUnauthorizedError(error)) {
return false;
}
if (isNotFoundError(error)) {
if (transition) {
transition.abort();
let routeInfo = transition?.to;
let router = this.router;
let params = [];
if (routeInfo) {
for (let key of Object.keys(routeInfo.params)) {
params.push(routeInfo.params[key]);
}
let url = router.urlFor(routeInfo.name, ...params)
.replace(/^#\//, '')
.replace(/^\//, '')
.replace(/^ghost\//, '');
return this.replaceWith('error404', url);
}
}
// when there's no transition we fall through to our generic error handler
// for network errors that will hit the isAjaxError branch below
}
if (isVersionMismatchError(error)) {
if (transition) {
transition.abort();
}
this.upgradeStatus.requireUpgrade();
if (this._appLoaded) {
return false;
}
}
if (isMaintenanceError(error)) {
if (transition) {
transition.abort();
}
this.upgradeStatus.maintenanceAlert();
if (this._appLoaded) {
return false;
}
}
if (isAjaxError(error) || error && error.payload && isEmberArray(error.payload.errors)) {
this.notifications.showAPIError(error);
// don't show the 500 page if we weren't navigating
if (!transition) {
return false;
}
}
// fallback to 500 error page
return true;
}
},
willDestroy() {
this.ui.cleanupBodyDragHandlers();
},
async prepareApp() {
await this.configManager.fetchUnauthenticated();
// init Sentry here rather than app.js so that we can use API-supplied
// sentry_dsn and sentry_env rather than building it into release assets
if (this.config.sentry_dsn) {
const sentryConfig = getSentryConfig(this.config.sentry_dsn, this.config.sentry_env, this.config.version);
Sentry.init(sentryConfig);
}
if (this.session.isAuthenticated) {
try {
await this.session.populateUser();
} catch (e) {
await this.session.invalidate();
}
await this.session.postAuthPreparation();
}
if (this.config.hostSettings?.forceUpgrade) {
// enforce opening the BMA in a force upgrade state
this.billing.openBillingWindow(this.router.currentURL, '/pro');
}
// Preload settings to avoid a delay when opening
setTimeout(() => {
importComponent(AdminXSettings.packageName);
}, 1000);
}
});