mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-11-29 07:09:48 +03:00
3864584f74
no issue - upgrade `ember-ajax` to 3.0.0 - `ember-ajax` [now passes the payload through directly](https://github.com/ember-cli/ember-ajax/releases/tag/v3.0.0) rather than trying to normalize it so all our error handling needed to be updated
249 lines
8.5 KiB
JavaScript
249 lines
8.5 KiB
JavaScript
import AjaxService from 'ember-ajax/services/ajax';
|
|
import config from 'ghost-admin/config/environment';
|
|
import {AjaxError, isAjaxError} from 'ember-ajax/errors';
|
|
import {computed} from '@ember/object';
|
|
import {get} from '@ember/object';
|
|
import {isArray as isEmberArray} from '@ember/array';
|
|
import {isNone} from '@ember/utils';
|
|
import {inject as service} from '@ember/service';
|
|
|
|
const JSONContentType = 'application/json';
|
|
|
|
function isJSONContentType(header) {
|
|
if (!header || isNone(header)) {
|
|
return false;
|
|
}
|
|
return header.indexOf(JSONContentType) === 0;
|
|
}
|
|
|
|
/* Version mismatch error */
|
|
|
|
export function VersionMismatchError(payload) {
|
|
AjaxError.call(this, payload, 'API server is running a newer version of Ghost, please upgrade.');
|
|
}
|
|
|
|
VersionMismatchError.prototype = Object.create(AjaxError.prototype);
|
|
|
|
export function isVersionMismatchError(errorOrStatus, payload) {
|
|
if (isAjaxError(errorOrStatus)) {
|
|
return errorOrStatus instanceof VersionMismatchError;
|
|
} else {
|
|
return get(payload || {}, 'errors.firstObject.errorType') === 'VersionMismatchError';
|
|
}
|
|
}
|
|
|
|
/* Request entity too large error */
|
|
|
|
export function ServerUnreachableError(payload) {
|
|
AjaxError.call(this, payload, 'Server was unreachable');
|
|
}
|
|
|
|
ServerUnreachableError.prototype = Object.create(AjaxError.prototype);
|
|
|
|
export function isServerUnreachableError(error) {
|
|
if (isAjaxError(error)) {
|
|
return error instanceof ServerUnreachableError;
|
|
} else {
|
|
return error === 0 || error === '0';
|
|
}
|
|
}
|
|
|
|
export function RequestEntityTooLargeError(payload) {
|
|
AjaxError.call(this, payload, 'Request is larger than the maximum file size the server allows');
|
|
}
|
|
|
|
RequestEntityTooLargeError.prototype = Object.create(AjaxError.prototype);
|
|
|
|
export function isRequestEntityTooLargeError(errorOrStatus) {
|
|
if (isAjaxError(errorOrStatus)) {
|
|
return errorOrStatus instanceof RequestEntityTooLargeError;
|
|
} else {
|
|
return errorOrStatus === 413;
|
|
}
|
|
}
|
|
|
|
/* Unsupported media type error */
|
|
|
|
export function UnsupportedMediaTypeError(payload) {
|
|
AjaxError.call(this, payload, 'Request contains an unknown or unsupported file type.');
|
|
}
|
|
|
|
UnsupportedMediaTypeError.prototype = Object.create(AjaxError.prototype);
|
|
|
|
export function isUnsupportedMediaTypeError(errorOrStatus) {
|
|
if (isAjaxError(errorOrStatus)) {
|
|
return errorOrStatus instanceof UnsupportedMediaTypeError;
|
|
} else {
|
|
return errorOrStatus === 415;
|
|
}
|
|
}
|
|
|
|
/* Maintenance error */
|
|
|
|
export function MaintenanceError(payload) {
|
|
AjaxError.call(this, payload, 'Ghost is currently undergoing maintenance, please wait a moment then retry.');
|
|
}
|
|
|
|
MaintenanceError.prototype = Object.create(AjaxError.prototype);
|
|
|
|
export function isMaintenanceError(errorOrStatus) {
|
|
if (isAjaxError(errorOrStatus)) {
|
|
return errorOrStatus instanceof MaintenanceError;
|
|
} else {
|
|
return errorOrStatus === 503;
|
|
}
|
|
}
|
|
|
|
/* Theme validation error */
|
|
|
|
export function ThemeValidationError(payload) {
|
|
AjaxError.call(this, payload, 'Theme is not compatible or contains errors.');
|
|
}
|
|
|
|
ThemeValidationError.prototype = Object.create(AjaxError.prototype);
|
|
|
|
export function isThemeValidationError(errorOrStatus, payload) {
|
|
if (isAjaxError(errorOrStatus)) {
|
|
return errorOrStatus instanceof ThemeValidationError;
|
|
} else {
|
|
return get(payload || {}, 'errors.firstObject.errorType') === 'ThemeValidationError';
|
|
}
|
|
}
|
|
|
|
/* end: custom error types */
|
|
|
|
let ajaxService = AjaxService.extend({
|
|
session: service(),
|
|
|
|
headers: computed('session.isAuthenticated', function () {
|
|
let session = this.get('session');
|
|
let headers = {};
|
|
|
|
headers['X-Ghost-Version'] = config.APP.version;
|
|
headers['App-Pragma'] = 'no-cache';
|
|
|
|
if (session.get('isAuthenticated')) {
|
|
session.authorize('authorizer:oauth2', (headerName, headerValue) => {
|
|
headers[headerName] = headerValue;
|
|
});
|
|
}
|
|
|
|
return headers;
|
|
}).volatile(),
|
|
|
|
// ember-ajax recognises `application/vnd.api+json` as a JSON-API request
|
|
// and formats appropriately, we want to handle `application/json` the same
|
|
_makeRequest(hash) {
|
|
let isAuthenticated = this.get('session.isAuthenticated');
|
|
let isGhostRequest = hash.url.indexOf('/ghost/api/') !== -1;
|
|
let isTokenRequest = isGhostRequest && hash.url.match(/authentication\/(?:token|ghost)/);
|
|
let tokenExpiry = this.get('session.authenticated.expires_at');
|
|
let isTokenExpired = tokenExpiry < (new Date()).getTime();
|
|
|
|
if (isJSONContentType(hash.contentType) && hash.type !== 'GET') {
|
|
if (typeof hash.data === 'object') {
|
|
hash.data = JSON.stringify(hash.data);
|
|
}
|
|
}
|
|
|
|
// we can get into a situation where the app is left open without a
|
|
// network connection and the token subsequently expires, this will
|
|
// result in the next network request returning a 401 and killing the
|
|
// session. This is an attempt to detect that and restore the session
|
|
// using the stored refresh token before continuing with the request
|
|
//
|
|
// TODO:
|
|
// - this might be quite blunt, if we have a lot of requests at once
|
|
// we probably want to queue the requests until the restore completes
|
|
// BUG:
|
|
// - the original caller gets a rejected promise with `undefined` instead
|
|
// of the AjaxError object when session restore fails. This isn't a
|
|
// huge deal because the session will be invalidated and app reloaded
|
|
// but it would be nice to be consistent
|
|
if (isAuthenticated && isGhostRequest && !isTokenRequest && isTokenExpired) {
|
|
return this.get('session').restore().then(() => {
|
|
return this._makeRequest(hash);
|
|
});
|
|
}
|
|
|
|
return this._super(...arguments);
|
|
},
|
|
|
|
handleResponse(status, headers, payload) {
|
|
if (this.isVersionMismatchError(status, headers, payload)) {
|
|
return new VersionMismatchError(payload);
|
|
} else if (this.isServerUnreachableError(status, headers, payload)) {
|
|
return new ServerUnreachableError(payload);
|
|
} else if (this.isRequestEntityTooLargeError(status, headers, payload)) {
|
|
return new RequestEntityTooLargeError(payload);
|
|
} else if (this.isUnsupportedMediaTypeError(status, headers, payload)) {
|
|
return new UnsupportedMediaTypeError(payload);
|
|
} else if (this.isMaintenanceError(status, headers, payload)) {
|
|
return new MaintenanceError(payload);
|
|
} else if (this.isThemeValidationError(status, headers, payload)) {
|
|
return new ThemeValidationError(payload);
|
|
}
|
|
|
|
// TODO: we may want to check that we are hitting our own API before
|
|
// logging the user out due to a 401 response
|
|
if (this.isUnauthorizedError(status, headers, payload) && this.get('session.isAuthenticated')) {
|
|
this.get('session').invalidate();
|
|
}
|
|
|
|
return this._super(...arguments);
|
|
},
|
|
|
|
normalizeErrorResponse(status, headers, payload) {
|
|
if (payload && typeof payload === 'object') {
|
|
let errors = payload.error || payload.errors || payload.message || undefined;
|
|
|
|
if (errors) {
|
|
if (!isEmberArray(errors)) {
|
|
errors = [errors];
|
|
}
|
|
|
|
payload.errors = errors.map(function(error) {
|
|
if (typeof error === 'string') {
|
|
return {message: error};
|
|
} else {
|
|
return error;
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
return this._super(status, headers, payload);
|
|
},
|
|
|
|
isVersionMismatchError(status, headers, payload) {
|
|
return isVersionMismatchError(status, payload);
|
|
},
|
|
|
|
isServerUnreachableError(status) {
|
|
return isServerUnreachableError(status);
|
|
},
|
|
|
|
isRequestEntityTooLargeError(status) {
|
|
return isRequestEntityTooLargeError(status);
|
|
},
|
|
|
|
isUnsupportedMediaTypeError(status) {
|
|
return isUnsupportedMediaTypeError(status);
|
|
},
|
|
|
|
isMaintenanceError(status, headers, payload) {
|
|
return isMaintenanceError(status, payload);
|
|
},
|
|
|
|
isThemeValidationError(status, headers, payload) {
|
|
return isThemeValidationError(status, payload);
|
|
}
|
|
});
|
|
|
|
// we need to reopen so that internal methods use the correct contentType
|
|
ajaxService.reopen({
|
|
contentType: 'application/json; charset=UTF-8'
|
|
});
|
|
|
|
export default ajaxService;
|