chore: 🤖 add error handling support to API
This commit is contained in:
2 files changed
+126
No files matched your search
@@ -1,6 +1,7 @@
|
||||
import RESTAdapter from '@ember-data/adapter/rest';
|
||||
import config from 'ember-get-config';
|
||||
import { get } from '@ember/object';
|
||||
import { InvalidError } from '@ember-data/adapter/error';
|
||||
|
||||
export default class ApplicationAdapter extends RESTAdapter {
|
||||
// =attributes
|
||||
@@ -37,4 +38,88 @@ export default class ApplicationAdapter extends RESTAdapter {
|
||||
const method = type === 'PUT' ? 'PATCH' : type;
|
||||
return super.ajax(url, method, options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Our API represents invalid requests via the 400 error. But Ember Data
|
||||
* expects 422 by default. We change it here.
|
||||
*
|
||||
* @override
|
||||
* @method isInvalid
|
||||
* @param {Number} status
|
||||
* @param {Object} headers
|
||||
* @param {Object} payload
|
||||
* @return {Boolean}
|
||||
*/
|
||||
isInvalid(status /*, headers, payload*/) {
|
||||
return status === 400;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ember Data blatantly assumes errors always present under an `errors` key
|
||||
* in the payload, even _before normalizing errors_. Bizarre. Instead,
|
||||
* we pass the payload through an adapter-level transformation step if the
|
||||
* request was invalid. Then we can rely on the serializer's `extractErrors`
|
||||
* to handle the rest.
|
||||
*
|
||||
* @override
|
||||
* @method handleResponse
|
||||
* @param {Number} status
|
||||
* @param {Object} headers
|
||||
* @param {Object} payload
|
||||
* @param {Object} requestData - the original request information
|
||||
* @return {Object | AdapterError} response
|
||||
*/
|
||||
handleResponse(status, headers, payload, requestData) {
|
||||
if (this.isInvalid(status, headers, payload)) {
|
||||
const detailedMessage = this.generatedDetailedMessage(...arguments);
|
||||
const transformedPayload = this.transformValidationErrors(payload);
|
||||
return new InvalidError(transformedPayload.errors, detailedMessage);
|
||||
}
|
||||
return super.handleResponse(status, headers, payload, requestData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalizes the errors found in a payload from our API into JSON API
|
||||
* error format.
|
||||
*
|
||||
* @param {object} payload
|
||||
* @return {object}
|
||||
*/
|
||||
transformValidationErrors(payload) {
|
||||
const fieldErrors = get(payload, 'details.fields') || [];
|
||||
// Normalize the primary error message into "base", which is an error
|
||||
// that applies to the whole model instance
|
||||
const baseError = {
|
||||
status: payload.source,
|
||||
code: payload.code,
|
||||
detail: payload.message,
|
||||
source: { pointer: '/data' },
|
||||
};
|
||||
// Normalize field-specific errors, if any.
|
||||
const errors = fieldErrors.map((error) => ({
|
||||
detail: error.message,
|
||||
source: { pointer: `/data/attributes/${error.name}` },
|
||||
}));
|
||||
// Return a list of JSON API errors rooted under the `errors` key.
|
||||
return {
|
||||
errors: [baseError, ...errors],
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns `payload.message`, which our API provides as a top-level
|
||||
* description of the error that occurred.
|
||||
*
|
||||
* @override
|
||||
* @method generatedDetailedMessage
|
||||
* @private
|
||||
* @param {Number} status
|
||||
* @param {Object} headers
|
||||
* @param {Object} payload
|
||||
* @param {Object} requestData
|
||||
* @return {String} detailed error message
|
||||
*/
|
||||
generatedDetailedMessage(status, headers, payload /*, requestData*/) {
|
||||
return payload.message;
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user