Ghost/ghost/admin/app/serializers/setting.js
jbenezech b9dd9f066d
🐛 Fixed settings overriden when updated from multiple tabs (#15536)
closes: https://github.com/TryGhost/Ghost/issues/15470

- When multiple browser tabs are open, each manipulate a different copy of ember data model, changes to the model in one tab are not reflected in the model of the other tab.
- When updating some settings, all current settings were sent to the API.
- As a result, when updating two different categories of settings (navigation/code inspection) in different tabs, the second update was overriding the first one.
- From a user perspective, this is not a natural behaviour. Only settings visible on-screen when clicking save should be modified.

Co-authored-by: Kevin Ansfield <kevin@lookingsideways.co.uk>
2022-10-12 14:03:54 +01:00

68 lines
2.4 KiB
JavaScript

import ApplicationSerializer from 'ghost-admin/serializers/application';
import {pluralize} from 'ember-inflector';
export default class Setting extends ApplicationSerializer {
serializeIntoHash(hash, type, record, options) {
// Settings API does not want ids
options = options || {};
options.includeId = false;
let root = pluralize(type.modelName);
let data = Object.keys(record.record.changedAttributes()).length > 0 ?
this.serialize(record, options) : [];
let payload = [];
delete data.id;
delete data._meta;
Object.keys(data).forEach((k) => {
payload.push({key: k, value: data[k]});
});
hash[root] = payload;
}
serializeAttribute(snapshot, json, key, attributes) {
// Only serialize attributes that have changed and
// send a partial update to the API to avoid conflicts
// with different screens using the same model
// See https://github.com/TryGhost/Ghost/issues/15470
if (
!snapshot.record.get('isNew') &&
!snapshot.record.changedAttributes()[key]
) {
return;
}
super.serializeAttribute(snapshot, json, key, attributes);
}
normalizeArrayResponse(store, primaryModelClass, _payload, id, requestType) {
let payload = {settings: [this._extractObjectFromArrayPayload(_payload)]};
return super.normalizeArrayResponse(store, primaryModelClass, payload, id, requestType);
}
normalizeSingleResponse(store, primaryModelClass, _payload, id, requestType) {
let payload = {setting: this._extractObjectFromArrayPayload(_payload)};
return super.normalizeSingleResponse(store, primaryModelClass, payload, id, requestType);
}
_extractObjectFromArrayPayload(_payload) {
let payload = {id: '0'};
_payload.settings.forEach((setting) => {
payload[setting.key] = setting.value;
});
// HACK: Ember Data doesn't expose `meta` properties consistently
// - https://github.com/emberjs/data/issues/2905
//
// We need the `meta` data returned when saving so we extract it and dump
// it onto the model as an attribute then delete it again when serializing.
if (_payload.meta) {
payload._meta = _payload.meta;
}
return payload;
}
}