Fix findOne with PK as one of the params

Signed-off-by: Pierre Noël <pierre.noel@strapi.io>
This commit is contained in:
Pierre Noël 2020-03-05 17:24:46 +01:00
parent 37d6a3464d
commit c0d9dd26d1
4 changed files with 104 additions and 239 deletions

View File

@ -4,11 +4,7 @@
*/
const _ = require('lodash');
const {
convertRestQueryParams,
buildQuery,
models: modelUtils,
} = require('strapi-utils');
const { convertRestQueryParams, buildQuery, models: modelUtils } = require('strapi-utils');
module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
/* Utils */
@ -50,14 +46,6 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
* Find one entry based on params
*/
async function findOne(params, populate, { transacting } = {}) {
const primaryKey = params[model.primaryKey] || params.id;
if (primaryKey) {
params = {
[model.primaryKey]: primaryKey,
};
}
const entry = await model.where(params).fetch({
withRelated: populate,
transacting,
@ -99,10 +87,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
const entry = await model.forge(data).save(null, { transacting: trx });
await createComponents(entry, values, { transacting: trx });
return model.updateRelations(
{ id: entry.id, values: relations },
{ transacting: trx }
);
return model.updateRelations({ id: entry.id, values: relations }, { transacting: trx });
};
return wrapTransaction(runCreate, { transacting });
@ -133,10 +118,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
await updateComponents(updatedEntry, values, { transacting: trx });
if (Object.keys(relations).length > 0) {
return model.updateRelations(
{ id: entry.id, values: relations },
{ transacting: trx }
);
return model.updateRelations({ id: entry.id, values: relations }, { transacting: trx });
}
return this.findOne(params, null, { transacting: trx });
@ -145,8 +127,8 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
return wrapTransaction(runUpdate, { transacting });
}
async function deleteOne(params, { transacting } = {}) {
const entry = await model.where(params).fetch({ transacting });
async function deleteOne(id, { transacting } = {}) {
const entry = await model.where({ id }).fetch({ transacting });
if (!entry) {
const err = new Error('entry.notFound');
@ -173,13 +155,11 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
}
});
await model.updateRelations({ ...params, values }, { transacting });
await model.updateRelations({ [model.primaryKey]: id, values }, { transacting });
const runDelete = async trx => {
await deleteComponents(entry, { transacting: trx });
await model
.where({ id: entry.id })
.destroy({ transacting: trx, require: false });
await model.where({ id: entry.id }).destroy({ transacting: trx, require: false });
return entry.toJSON();
};
@ -187,13 +167,9 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
}
async function deleteMany(params, { transacting } = {}) {
const primaryKey = params[model.primaryKey] || params.id;
if (primaryKey) return deleteOne(params, { transacting });
const entries = await find(params, null, { transacting });
return await Promise.all(
entries.map(entry => deleteOne({ id: entry.id }, { transacting }))
entries.map(entry => deleteOne(entry[model.primaryKey], { transacting }))
);
}
@ -237,12 +213,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
const joinModel = model.componentsJoinModel;
const { foreignKey } = joinModel;
const createComponentAndLink = async ({
componentModel,
value,
key,
order,
}) => {
const createComponentAndLink = async ({ componentModel, value, key, order }) => {
return strapi
.query(componentModel.uid)
.create(value, { transacting })
@ -343,12 +314,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
const joinModel = model.componentsJoinModel;
const { foreignKey } = joinModel;
const updateOrCreateComponentAndLink = async ({
componentModel,
key,
value,
order,
}) => {
const updateOrCreateComponentAndLink = async ({ componentModel, key, value, order }) => {
// check if value has an id then update else create
if (_.has(value, componentModel.primaryKey)) {
return strapi
@ -481,11 +447,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
return;
}
async function deleteDynamicZoneOldComponents(
entry,
values,
{ key, joinModel, transacting }
) {
async function deleteDynamicZoneOldComponents(entry, values, { key, joinModel, transacting }) {
const idsToKeep = values.reduce((acc, value) => {
const component = value.__component;
const componentModel = strapi.components[component];
@ -506,8 +468,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
.fetchAll({ transacting })
.map(el => {
const componentKey = Object.keys(strapi.components).find(
key =>
strapi.components[key].collectionName === el.get('component_type')
key => strapi.components[key].collectionName === el.get('component_type')
);
return {
@ -518,9 +479,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
// verify the provided ids are realted to this entity.
idsToKeep.forEach(({ id, component }) => {
if (
!allIds.find(el => el.id === id && el.component.uid === component.uid)
) {
if (!allIds.find(el => el.id === id && el.component.uid === component.uid)) {
const err = new Error(
`Some of the provided components in ${key} are not related to the entity`
);
@ -530,11 +489,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
});
const idsToDelete = allIds.reduce((acc, { id, component }) => {
if (
!idsToKeep.find(
el => el.id === id && el.component.uid === component.uid
)
) {
if (!idsToKeep.find(el => el.id === id && el.component.uid === component.uid)) {
acc.push({
id,
component,
@ -550,10 +505,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
qb.where(qb => {
idsToDelete.forEach(({ id, component }) => {
qb.orWhere(qb => {
qb.where('component_id', id).andWhere(
'component_type',
component.collectionName
);
qb.where('component_id', id).andWhere('component_type', component.collectionName);
});
});
});
@ -573,9 +525,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
componentValue,
{ key, joinModel, componentModel, transacting }
) {
const componentArr = Array.isArray(componentValue)
? componentValue
: [componentValue];
const componentArr = Array.isArray(componentValue) ? componentValue : [componentValue];
const idsToKeep = componentArr
.filter(el => _.has(el, componentModel.primaryKey))
@ -603,17 +553,12 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
const idsToDelete = _.difference(allIds, idsToKeep);
if (idsToDelete.length > 0) {
await joinModel
.query(qb =>
qb.whereIn('component_id', idsToDelete).andWhere('field', key)
)
.query(qb => qb.whereIn('component_id', idsToDelete).andWhere('field', key))
.destroy({ transacting, require: false });
await strapi
.query(componentModel.uid)
.delete(
{ [`${componentModel.primaryKey}_in`]: idsToDelete },
{ transacting }
);
.delete({ [`${componentModel.primaryKey}_in`]: idsToDelete }, { transacting });
}
}
@ -643,10 +588,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
await strapi
.query(componentModel.uid)
.delete(
{ [`${componentModel.primaryKey}_in`]: ids },
{ transacting }
);
.delete({ [`${componentModel.primaryKey}_in`]: ids }, { transacting });
await joinModel
.where({
@ -674,9 +616,7 @@ module.exports = function createQueryBuilder({ model, modelKey, strapi }) {
const { uid, collectionName } = strapi.components[compo];
const model = strapi.query(uid);
const toDelete = componentJoins.filter(
el => el.componentType === collectionName
);
const toDelete = componentJoins.filter(el => el.componentType === collectionName);
if (toDelete.length > 0) {
await model.delete(
@ -725,33 +665,18 @@ const buildSearchQuery = (qb, model, params) => {
const associations = model.associations.map(x => x.alias);
const searchText = Object.keys(model._attributes)
.filter(
attribute =>
attribute !== model.primaryKey && !associations.includes(attribute)
)
.filter(attribute =>
['string', 'text'].includes(model._attributes[attribute].type)
);
.filter(attribute => attribute !== model.primaryKey && !associations.includes(attribute))
.filter(attribute => ['string', 'text'].includes(model._attributes[attribute].type));
const searchInt = Object.keys(model._attributes)
.filter(
attribute =>
attribute !== model.primaryKey && !associations.includes(attribute)
)
.filter(attribute => attribute !== model.primaryKey && !associations.includes(attribute))
.filter(attribute =>
['integer', 'decimal', 'float'].includes(
model._attributes[attribute].type
)
['integer', 'decimal', 'float'].includes(model._attributes[attribute].type)
);
const searchBool = Object.keys(model._attributes)
.filter(
attribute =>
attribute !== model.primaryKey && !associations.includes(attribute)
)
.filter(attribute =>
['boolean'].includes(model._attributes[attribute].type)
);
.filter(attribute => attribute !== model.primaryKey && !associations.includes(attribute))
.filter(attribute => ['boolean'].includes(model._attributes[attribute].type));
if (!_.isNaN(_.toNumber(query))) {
searchInt.forEach(attribute => {
@ -768,10 +693,7 @@ const buildSearchQuery = (qb, model, params) => {
// Search in columns with text using index.
switch (model.client) {
case 'mysql':
qb.orWhereRaw(
`MATCH(${searchText.join(',')}) AGAINST(? IN BOOLEAN MODE)`,
`*${query}*`
);
qb.orWhereRaw(`MATCH(${searchText.join(',')}) AGAINST(? IN BOOLEAN MODE)`, `*${query}*`);
break;
case 'pg': {
const searchQuery = searchText.map(attribute =>
@ -803,13 +725,8 @@ function validateRepeatableInput(value, { key, min, max, required }) {
}
});
if (
(required === true || (required !== true && value.length > 0)) &&
(min && value.length < min)
) {
const err = new Error(
`Component ${key} must contain at least ${min} items`
);
if ((required === true || (required !== true && value.length > 0)) && min && value.length < min) {
const err = new Error(`Component ${key} must contain at least ${min} items`);
err.status = 400;
throw err;
}
@ -835,10 +752,7 @@ function validateNonRepeatableInput(value, { key, required }) {
}
}
function validateDynamiczoneInput(
value,
{ key, min, max, components, required }
) {
function validateDynamiczoneInput(value, { key, min, max, components, required }) {
if (!Array.isArray(value)) {
const err = new Error(`Dynamiczone ${key} is invalid. Expected an array`);
err.status = 400;
@ -869,20 +783,13 @@ function validateDynamiczoneInput(
}
});
if (
(required === true || (required !== true && value.length > 0)) &&
(min && value.length < min)
) {
const err = new Error(
`Dynamiczone ${key} must contain at least ${min} items`
);
if ((required === true || (required !== true && value.length > 0)) && min && value.length < min) {
const err = new Error(`Dynamiczone ${key} must contain at least ${min} items`);
err.status = 400;
throw err;
}
if (max && value.length > max) {
const err = new Error(
`Dynamiczone ${key} must contain at most ${max} items`
);
const err = new Error(`Dynamiczone ${key} must contain at most ${max} items`);
err.status = 400;
throw err;
}

View File

@ -4,17 +4,12 @@
*/
const _ = require('lodash');
const {
convertRestQueryParams,
buildQuery,
models: modelUtils,
} = require('strapi-utils');
const { convertRestQueryParams, buildQuery, models: modelUtils } = require('strapi-utils');
const { findComponentByGlobalId } = require('./utils/helpers');
const hasPK = (obj, model) => _.has(obj, model.primaryKey) || _.has(obj, 'id');
const getPK = (obj, model) =>
_.has(obj, model.primaryKey) ? obj[model.primaryKey] : obj.id;
const getPK = (obj, model) => (_.has(obj, model.primaryKey) ? obj[model.primaryKey] : obj.id);
module.exports = ({ model, modelKey, strapi }) => {
const assocKeys = model.associations.map(ast => ast.alias);
@ -77,9 +72,7 @@ module.exports = ({ model, modelKey, strapi }) => {
validateNonRepeatableInput(componentValue, { key, ...attr });
if (componentValue === null) continue;
const componentEntry = await strapi
.query(component)
.create(componentValue);
const componentEntry = await strapi.query(component).create(componentValue);
entry[key] = [
{
kind: componentModel.globalId,
@ -174,9 +167,7 @@ module.exports = ({ model, modelKey, strapi }) => {
});
const components = await Promise.all(
componentValue.map(value =>
updateOrCreateComponent({ componentUID, value })
)
componentValue.map(value => updateOrCreateComponent({ componentUID, value }))
);
const componentsArr = components.map(component => ({
kind: componentModel.globalId,
@ -222,14 +213,12 @@ module.exports = ({ model, modelKey, strapi }) => {
const dynamiczones = await Promise.all(
dynamiczoneValues.map(value => {
const componentUID = value.__component;
return updateOrCreateComponent({ componentUID, value }).then(
entity => {
return {
componentUID,
entity,
};
}
);
return updateOrCreateComponent({ componentUID, value }).then(entity => {
return {
componentUID,
entity,
};
});
})
);
@ -273,9 +262,7 @@ module.exports = ({ model, modelKey, strapi }) => {
// verify the provided ids are realted to this entity.
idsToKeep.forEach(({ id, componentUID }) => {
if (
!allIds.find(el => el.id === id && el.componentUID === componentUID)
) {
if (!allIds.find(el => el.id === id && el.componentUID === componentUID)) {
const err = new Error(
`Some of the provided components in ${key} are not related to the entity`
);
@ -285,9 +272,7 @@ module.exports = ({ model, modelKey, strapi }) => {
});
const idsToDelete = allIds.reduce((acc, { id, componentUID }) => {
if (
!idsToKeep.find(el => el.id === id && el.componentUID === componentUID)
) {
if (!idsToKeep.find(el => el.id === id && el.componentUID === componentUID)) {
acc.push({
id,
componentUID,
@ -317,14 +302,8 @@ module.exports = ({ model, modelKey, strapi }) => {
}
}
async function deleteOldComponents(
entry,
componentValue,
{ key, componentModel }
) {
const componentArr = Array.isArray(componentValue)
? componentValue
: [componentValue];
async function deleteOldComponents(entry, componentValue, { key, componentModel }) {
const componentArr = Array.isArray(componentValue) ? componentValue : [componentValue];
const idsToKeep = componentArr
.filter(val => hasPK(val, componentModel))
@ -352,9 +331,7 @@ module.exports = ({ model, modelKey, strapi }) => {
}, []);
if (idsToDelete.length > 0) {
await strapi
.query(componentModel.uid)
.delete({ [`${model.primaryKey}_in`]: idsToDelete });
await strapi.query(componentModel.uid).delete({ [`${model.primaryKey}_in`]: idsToDelete });
}
}
@ -415,23 +392,11 @@ module.exports = ({ model, modelKey, strapi }) => {
model,
filters,
populate: populateOpt,
}).then(results =>
results.map(result => (result ? result.toObject() : null))
);
}).then(results => results.map(result => (result ? result.toObject() : null)));
}
async function findOne(params, populate) {
const primaryKey = getPK(params, model);
if (primaryKey) {
params = {
[model.primaryKey]: primaryKey,
};
}
const entry = await model
.findOne(params)
.populate(populate || defaultPopulate);
const entry = await model.findOne(params).populate(populate || defaultPopulate);
return entry ? entry.toObject() : null;
}
@ -463,14 +428,6 @@ module.exports = ({ model, modelKey, strapi }) => {
}
async function update(params, values) {
const primaryKey = getPK(params, model);
if (primaryKey) {
params = {
[model.primaryKey]: primaryKey,
};
}
const entry = await model.findOne(params);
if (!entry) {
@ -498,12 +455,12 @@ module.exports = ({ model, modelKey, strapi }) => {
if (primaryKey) return deleteOne(params);
const entries = await find(params);
return await Promise.all(entries.map(entry => deleteOne({ id: entry.id })));
return Promise.all(entries.map(entry => deleteOne(entry[model.primaryKey])));
}
async function deleteOne(params) {
async function deleteOne(id) {
const entry = await model
.findOneAndRemove({ [model.primaryKey]: getPK(params, model) })
.findOneAndRemove({ [model.primaryKey]: id })
.populate(defaultPopulate);
if (!entry) {
@ -521,21 +478,17 @@ module.exports = ({ model, modelKey, strapi }) => {
}
const search =
_.endsWith(association.nature, 'One') ||
association.nature === 'oneToMany'
_.endsWith(association.nature, 'One') || association.nature === 'oneToMany'
? { [association.via]: entry._id }
: { [association.via]: { $in: [entry._id] } };
const update =
_.endsWith(association.nature, 'One') ||
association.nature === 'oneToMany'
_.endsWith(association.nature, 'One') || association.nature === 'oneToMany'
? { [association.via]: null }
: { $pull: { [association.via]: entry._id } };
// Retrieve model.
const model = association.plugin
? strapi.plugins[association.plugin].models[
association.model || association.collection
]
? strapi.plugins[association.plugin].models[association.model || association.collection]
: strapi.models[association.model || association.collection];
return model.updateMany(search, update);
@ -557,9 +510,7 @@ module.exports = ({ model, modelKey, strapi }) => {
.skip(filters.start)
.limit(filters.limit)
.populate(populate || defaultPopulate)
.then(results =>
results.map(result => (result ? result.toObject() : null))
);
.then(results => results.map(result => (result ? result.toObject() : null)));
}
function countSearch(params) {
@ -623,13 +574,8 @@ function validateRepeatableInput(value, { key, min, max, required }) {
}
});
if (
(required === true || (required !== true && value.length > 0)) &&
(min && value.length < min)
) {
const err = new Error(
`Component ${key} must contain at least ${min} items`
);
if ((required === true || (required !== true && value.length > 0)) && min && value.length < min) {
const err = new Error(`Component ${key} must contain at least ${min} items`);
err.status = 400;
throw err;
}
@ -655,10 +601,7 @@ function validateNonRepeatableInput(value, { key, required }) {
}
}
function validateDynamiczoneInput(
value,
{ key, min, max, components, required }
) {
function validateDynamiczoneInput(value, { key, min, max, components, required }) {
if (!Array.isArray(value)) {
const err = new Error(`Dynamiczone ${key} is invalid. Expected an array`);
err.status = 400;
@ -689,20 +632,13 @@ function validateDynamiczoneInput(
}
});
if (
(required === true || (required !== true && value.length > 0)) &&
(min && value.length < min)
) {
const err = new Error(
`Dynamiczone ${key} must contain at least ${min} items`
);
if ((required === true || (required !== true && value.length > 0)) && min && value.length < min) {
const err = new Error(`Dynamiczone ${key} must contain at least ${min} items`);
err.status = 400;
throw err;
}
if (max && value.length > max) {
const err = new Error(
`Dynamiczone ${key} must contain at most ${max} items`
);
const err = new Error(`Dynamiczone ${key} must contain at most ${max} items`);
err.status = 400;
throw err;
}

View File

@ -1,5 +1,7 @@
'use strict';
const { replaceIdByPrimaryKey } = require('../utils/primary-key');
module.exports = function createQuery(opts) {
return new Query(opts);
};
@ -35,43 +37,49 @@ class Query {
}
if (typeof mapping[this.orm] !== 'function') {
throw new Error(
`Custom queries must be functions received ${typeof mapping[this.orm]}`
);
throw new Error(`Custom queries must be functions received ${typeof mapping[this.orm]}`);
}
return mapping[this.model.orm].call(this, { model: this.model });
}
find(...args) {
return this.connectorQuery.find(...args);
find(params = {}, ...args) {
const newParams = replaceIdByPrimaryKey(params, this.model);
return this.connectorQuery.find(newParams, ...args);
}
findOne(...args) {
return this.connectorQuery.findOne(...args);
findOne(params = {}, ...args) {
const newParams = replaceIdByPrimaryKey(params, this.model);
return this.connectorQuery.findOne(newParams, ...args);
}
create(...args) {
return this.connectorQuery.create(...args);
create(params = {}, ...args) {
const newParams = replaceIdByPrimaryKey(params, this.model);
return this.connectorQuery.create(newParams, ...args);
}
update(...args) {
return this.connectorQuery.update(...args);
update(params = {}, ...args) {
const newParams = replaceIdByPrimaryKey(params, this.model);
return this.connectorQuery.update(newParams, ...args);
}
delete(...args) {
return this.connectorQuery.delete(...args);
delete(params = {}, ...args) {
const newParams = replaceIdByPrimaryKey(params, this.model);
return this.connectorQuery.delete(newParams, ...args);
}
count(...args) {
return this.connectorQuery.count(...args);
count(params = {}, ...args) {
const newParams = replaceIdByPrimaryKey(params, this.model);
return this.connectorQuery.count(newParams, ...args);
}
search(...args) {
return this.connectorQuery.search(...args);
search(params = {}, ...args) {
const newParams = replaceIdByPrimaryKey(params, this.model);
return this.connectorQuery.search(newParams, ...args);
}
countSearch(...args) {
return this.connectorQuery.countSearch(...args);
countSearch(params = {}, ...args) {
const newParams = replaceIdByPrimaryKey(params, this.model);
return this.connectorQuery.countSearch(newParams, ...args);
}
}

View File

@ -0,0 +1,14 @@
'use strict';
const _ = require('lodash');
module.exports = {
replaceIdByPrimaryKey: (params, model) => {
const newParams = { ...params };
if (_.has(params, 'id')) {
delete newParams.id;
newParams[model.primaryKey] = params[model.primaryKey] || params.id;
}
return newParams;
},
};