Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-06 22:40:14 -05:00
Code Issues Activity

Improved import_label creation logic

Browse source 
no issue

- When an import was done and there were no "global labels" present Ghost created generic `import-[data]` label which later helped to find a specific batch of imported data
- It did not make sense to create such generic label when user provided their own unique label
- The rules that work now are:
1. When there is no global provided Ghost generates on and removes it in case there are no imported records
2. When there is a unique new global label provided no new label is generated, but the label stays even if there are no imported records
This commit is contained in:
Nazar Gargol 2020-08-27 17:27:15 +12:00
parent f30d3cd2c2
commit 262d33b73c
2 changed files with 58 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

112
core/server/api/canary/members.js
View file

@ -154,30 +154,58 @@ function serializeMemberLabels(labels) {
}
const findOrCreateLabels = async (labels, options) => {
const api = require('./index');
const existingLabels = [];
const createdLabels = [];
return await Promise.all(labels.map((label) => {
return models.Label.findOne({name: label.name}).then((existingLabel) => {
if (existingLabel) {
return existingLabel;
for (const label of labels) {
const existingLabel = await models.Label.findOne({name: label.name});
if (existingLabel) {
existingLabels.push(existingLabel.toJSON());
} else {
try {
const createdLabel = await models.Label.add(label, options);
createdLabels.push(createdLabel.toJSON());
} catch (error) {
if (error.code && error.message.toLowerCase().indexOf('unique') !== -1) {
// ignore if label already exists
} else {
throw error;
}
}
}
}
return api.labels.add.query({
data: {
labels: [label]
},
options: {
context: options.context
}
}).catch((error) => {
if (error.errorType === 'ValidationError') {
return;
}
return {existingLabels, createdLabels};
};
throw error;
});
});
}));
const handleImportSetLabels = async (labels, options) => {
const importSetLabels = serializeMemberLabels(labels);
let importLabel;
const {existingLabels, createdLabels} = await findOrCreateLabels(importSetLabels, options);
// NOTE: an import label allows for imports to be "undone" via bulk delete
if (createdLabels.length) {
importLabel = createdLabels[0] && createdLabels[0];
} else {
const siteTimezone = settingsCache.get('timezone');
const name = `Import ${moment().tz(siteTimezone).format('YYYY-MM-DD HH:mm')}`;
const result = await findOrCreateLabels([{name}], options);
const generatedLabel = result.createdLabels.length
? result.createdLabels[0]
: result.existingLabels[0];
importLabel = generatedLabel;
importLabel.generated = true;
createdLabels.push(generatedLabel);
}
return {
importSetLabels: [...existingLabels, ...createdLabels],
importLabel
};
};
const getUniqueMemberLabels = (members) => {
@ -528,21 +556,7 @@ module.exports = {
};
let duplicateStripeCustomerIdCount = 0;
// NOTE: custom labels have to be created in advance otherwise there are conflicts
// when processing member creation in parallel later on in import process
const importSetLabels = serializeMemberLabels(frame.data.labels);
await findOrCreateLabels(importSetLabels, frame.options);
// NOTE: adding an import label allows for imports to be "undone" via bulk delete
let importLabel;
if (frame.data.members.length) {
const siteTimezone = settingsCache.get('timezone');
const name = `Import ${moment().tz(siteTimezone).format('YYYY-MM-DD HH:mm')}`;
const result = await findOrCreateLabels([{name}], frame.options);
importLabel = result[0] && result[0].toJSON();
importSetLabels.push(importLabel);
}
let {importSetLabels, importLabel} = await handleImportSetLabels(frame.data.labels, frame.options);
// NOTE: member-specific labels have to be pre-created as they cause conflicts when processed
// in parallel
@ -634,7 +648,7 @@ module.exports = {
invalid.errors = outputErrors;
if (imported.count === 0 && importLabel) {
if (imported.count === 0 && importLabel && importLabel.generated) {
await models.Label.destroy(Object.assign({}, {id: importLabel.id}, frame.options));
importLabel = null;
}
@ -681,29 +695,17 @@ module.exports = {
const createdBy = contextUser(frame.options);
// NOTE: custom labels have to be created in advance otherwise there are conflicts
// when processing member creation in parallel later on in import process
const importSetLabels = serializeMemberLabels(frame.data.labels);
// NOTE: adding an import label allows for imports to be "undone" via bulk delete
let importLabel;
if (frame.data.members.length) {
const siteTimezone = settingsCache.get('timezone');
const name = `Import ${moment().tz(siteTimezone).format('YYYY-MM-DD HH:mm')}`;
const result = await findOrCreateLabels([{name}], frame.options);
importLabel = result[0] && result[0].toJSON();
importSetLabels.push(importLabel);
}
const importSetLabelModels = await findOrCreateLabels(importSetLabels, frame.options);
let {importSetLabels, importLabel} = await handleImportSetLabels(frame.data.labels, frame.options);
// NOTE: member-specific labels have to be pre-created as they cause conflicts when processed
// in parallel
const memberLabels = serializeMemberLabels(getUniqueMemberLabels(frame.data.members));
const memberLabelModels = await findOrCreateLabels(memberLabels, frame.options);
const memberLabelsResult = await findOrCreateLabels(memberLabels, frame.options);
const allLabelModels = [...importSetLabelModels, ...memberLabelModels].filter(model => model !== undefined);
const allLabelModels = [
...importSetLabels,
...memberLabelsResult.existingLabels,
...memberLabelsResult.createdLabels].filter(model => model !== undefined);
return Promise.resolve().then(async () => {
const {sanitized, invalidCount, validationErrors} = await sanitizeInput(frame.data.members);
@ -746,7 +748,7 @@ module.exports = {
invalid.errors = outputErrors;
if (imported.count === 0 && importLabel) {
if (imported.count === 0 && importLabel && importLabel.generated) {
await models.Label.destroy(Object.assign({}, {id: importLabel.id}, frame.options));
importLabel = null;
}

2
core/server/services/members/importer/index.js
View file

@ -216,7 +216,7 @@ function serializeMemberLabels(labels) {
function getMemberData({members, allLabelModels, importSetLabels, createdBy}) {
const labelIdLookup = allLabelModels.reduce(function (labelIdLookupAcc, labelModel) {
return Object.assign(labelIdLookupAcc, {
[labelModel.get('name')]: labelModel.id
[labelModel.name]: labelModel.id
});
}, {});