Ghost/ghost/admin/app/routes/application.js
Kevin Ansfield 5b2194d5e8 Added Sentry error tracking for unhandled exceptions and API errors
refs https://github.com/TryGhost/Team/issues/723

- if the `/site/` API returns a `sentry_dsn` then we configure Sentry for error reporting as soon as we've loaded the initial unauthenticated data
- once we're authenticated and we have the full Ghost version available, override the Sentry event processor to use the full release
- updated `notifications.showAlert()` which is our fallback for API errors that shows the red banner at the top - these are the errors we're most interested in getting visibility for and reducing
2021-05-26 17:01:32 +01:00

191 lines
5.8 KiB
JavaScript

import AuthConfiguration from 'ember-simple-auth/configuration';
import RSVP from 'rsvp';
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 {InitSentryForEmber} from '@sentry/ember';
import {configureScope} from '@sentry/browser';
import {
isAjaxError,
isNotFoundError,
isUnauthorizedError
} from 'ember-ajax/errors';
import {isArray as isEmberArray} from '@ember/array';
import {
isMaintenanceError,
isVersionMismatchError
} from 'ghost-admin/services/ajax';
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'};
export default Route.extend(ShortcutsRoute, {
ajax: service(),
config: service(),
feature: service(),
ghostPaths: service(),
notifications: service(),
router: service(),
session: service(),
settings: service(),
ui: service(),
whatsNew: service(),
shortcuts,
routeAfterAuthentication: 'home',
init() {
this._super(...arguments);
this.router.on('routeDidChange', () => {
this.notifications.displayDelayed();
});
},
beforeModel() {
return this.config.fetchUnauthenticated()
.then(() => {
// 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.get('sentry_dsn')) {
InitSentryForEmber({
dsn: this.config.get('sentry_dsn'),
environment: this.config.get('sentry_env'),
release: `ghost@${this.config.get('version')}`
});
}
});
},
afterModel(model, transition) {
this._super(...arguments);
if (this.get('session.isAuthenticated')) {
this.session.appLoadTransition = transition;
this.session.loadServerNotifications();
// return the feature/settings load promises so that we block until
// they are loaded to enable synchronous access everywhere
return RSVP.all([
this.config.fetchAuthenticated(),
this.feature.fetch(),
this.settings.fetch()
]).then((results) => {
this._appLoaded = true;
// update Sentry with the full Ghost version which we only get after authentication
if (this.config.get('sentry_dsn')) {
configureScope((scope) => {
scope.addEventProcessor((event) => {
return new Promise((resolve) => {
resolve({
...event,
release: `ghost@${this.config.get('version')}`
});
});
});
});
}
// kick off background update of "whats new"
// - we don't want to block the router for this
// - we need the user details to know what the user has seen
this.whatsNew.fetchLatest.perform();
return results;
});
}
this._appLoaded = true;
},
actions: {
closeMenus() {
this.ui.closeMenus();
},
didTransition() {
this.session.appLoadTransition = null;
this.send('closeMenus');
},
authorizationFailed() {
windowProxy.replaceLocation(AuthConfiguration.rootURL);
},
// noop default for unhandled save (used from shortcuts)
save: K,
error(error, transition) {
// unauthoirized 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 = [];
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);
}
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;
}
}
});