@strapi/core 0.0.0-next.bec3f8cddf61be32ee5516609a1d4d6032933972 → 0.0.0-next.becb1565a20b0d3fbd0e2d79455c09c2f9f46808

package/dist/services/document-service/components.js

@@ -1,284 +1,379 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const _ = require("lodash");
-const fp = require("lodash/fp");
-const strapiUtils = require("@strapi/utils");
-const _interopDefault = (e) => e && e.__esModule ? e : { default: e };
-const ___default = /* @__PURE__ */ _interopDefault(_);
-const omitComponentData = fp.curry(
-  (schema, data) => {
+'use strict';
+
+var _ = require('lodash');
+var fp = require('lodash/fp');
+var strapiUtils = require('@strapi/utils');
+var transformContentTypesToModels = require('../../utils/transform-content-types-to-models.js');
+
+const omitComponentData = fp.curry((schema, data)=>{
     const { attributes } = schema;
-    const componentAttributes = Object.keys(attributes).filter(
-      (attributeName) => strapiUtils.contentTypes.isComponentAttribute(attributes[attributeName])
-    );
+    const componentAttributes = Object.keys(attributes).filter((attributeName)=>strapiUtils.contentTypes.isComponentAttribute(attributes[attributeName]));
     return fp.omit(componentAttributes, data);
-  }
-);
-const createComponents = async (uid, data) => {
-  const { attributes = {} } = strapi.getModel(uid);
-  const componentBody = {};
-  const attributeNames = Object.keys(attributes);
-  for (const attributeName of attributeNames) {
-    const attribute = attributes[attributeName];
-    if (!fp.has(attributeName, data) || !strapiUtils.contentTypes.isComponentAttribute(attribute)) {
-      continue;
-    }
-    if (attribute.type === "component") {
-      const { component: componentUID, repeatable = false } = attribute;
-      const componentValue = data[attributeName];
-      if (componentValue === null) {
-        continue;
-      }
-      if (repeatable === true) {
-        if (!Array.isArray(componentValue)) {
-          throw new Error("Expected an array to create repeatable component");
+});
+// NOTE: we could generalize the logic to allow CRUD of relation directly in the DB layer
+const createComponents = async (uid, data)=>{
+    const { attributes = {} } = strapi.getModel(uid);
+    const componentBody = {};
+    const attributeNames = Object.keys(attributes);
+    for (const attributeName of attributeNames){
+        const attribute = attributes[attributeName];
+        if (!fp.has(attributeName, data) || !strapiUtils.contentTypes.isComponentAttribute(attribute)) {
+            continue;
         }
-        const components = await strapiUtils.async.map(
-          componentValue,
-          (value) => createComponent(componentUID, value)
-        );
-        componentBody[attributeName] = components.map(({ id }) => {
-          return {
-            id,
-            __pivot: {
-              field: attributeName,
-              component_type: componentUID
+        if (attribute.type === 'component') {
+            const { component: componentUID, repeatable = false } = attribute;
+            const componentValue = data[attributeName];
+            if (componentValue === null) {
+                continue;
             }
-          };
-        });
-      } else {
-        const component = await createComponent(
-          componentUID,
-          componentValue
-        );
-        componentBody[attributeName] = {
-          id: component.id,
-          __pivot: {
-            field: attributeName,
-            component_type: componentUID
-          }
-        };
-      }
-      continue;
-    }
-    if (attribute.type === "dynamiczone") {
-      const dynamiczoneValues = data[attributeName];
-      if (!Array.isArray(dynamiczoneValues)) {
-        throw new Error("Expected an array to create repeatable component");
-      }
-      const createDynamicZoneComponents = async (value) => {
-        const { id } = await createComponent(value.__component, value);
-        return {
-          id,
-          __component: value.__component,
-          __pivot: {
-            field: attributeName
-          }
-        };
-      };
-      componentBody[attributeName] = await strapiUtils.async.map(
-        dynamiczoneValues,
-        createDynamicZoneComponents
-      );
-      continue;
+            if (repeatable === true) {
+                if (!Array.isArray(componentValue)) {
+                    throw new Error('Expected an array to create repeatable component');
+                }
+                const components = await strapiUtils.async.map(componentValue, (value)=>createComponent(componentUID, value));
+                componentBody[attributeName] = components.map(({ id })=>{
+                    return {
+                        id,
+                        __pivot: {
+                            field: attributeName,
+                            component_type: componentUID
+                        }
+                    };
+                });
+            } else {
+                const component = await createComponent(componentUID, componentValue);
+                componentBody[attributeName] = {
+                    id: component.id,
+                    __pivot: {
+                        field: attributeName,
+                        component_type: componentUID
+                    }
+                };
+            }
+            continue;
+        }
+        if (attribute.type === 'dynamiczone') {
+            const dynamiczoneValues = data[attributeName];
+            if (!Array.isArray(dynamiczoneValues)) {
+                throw new Error('Expected an array to create repeatable component');
+            }
+            const createDynamicZoneComponents = async (value)=>{
+                const { id } = await createComponent(value.__component, value);
+                return {
+                    id,
+                    __component: value.__component,
+                    __pivot: {
+                        field: attributeName
+                    }
+                };
+            };
+            // MySQL/MariaDB can cause deadlocks here if concurrency higher than 1
+            componentBody[attributeName] = await strapiUtils.async.map(dynamiczoneValues, createDynamicZoneComponents);
+            continue;
+        }
     }
-  }
-  return componentBody;
-};
-const getComponents = async (uid, entity) => {
-  const componentAttributes = strapiUtils.contentTypes.getComponentAttributes(strapi.getModel(uid));
-  if (___default.default.isEmpty(componentAttributes)) {
-    return {};
-  }
-  return strapi.db.query(uid).load(entity, componentAttributes);
+    return componentBody;
 };
-const updateComponents = async (uid, entityToUpdate, data) => {
-  const { attributes = {} } = strapi.getModel(uid);
-  const componentBody = {};
-  for (const attributeName of Object.keys(attributes)) {
-    const attribute = attributes[attributeName];
-    if (!fp.has(attributeName, data)) {
-      continue;
+const getComponents = async (uid, entity)=>{
+    const componentAttributes = strapiUtils.contentTypes.getComponentAttributes(strapi.getModel(uid));
+    if (_.isEmpty(componentAttributes)) {
+        return {};
     }
-    if (attribute.type === "component") {
-      const { component: componentUID, repeatable = false } = attribute;
-      const componentValue = data[attributeName];
-      await deleteOldComponents(uid, componentUID, entityToUpdate, attributeName, componentValue);
-      if (repeatable === true) {
-        if (!Array.isArray(componentValue)) {
-          throw new Error("Expected an array to create repeatable component");
+    return strapi.db.query(uid).load(entity, componentAttributes);
+};
+/*
+  delete old components
+  create or update
+*/ const updateComponents = async (uid, entityToUpdate, data)=>{
+    const { attributes = {} } = strapi.getModel(uid);
+    const componentBody = {};
+    for (const attributeName of Object.keys(attributes)){
+        const attribute = attributes[attributeName];
+        if (!fp.has(attributeName, data)) {
+            continue;
         }
-        const components = await strapiUtils.async.map(
-          componentValue,
-          (value) => updateOrCreateComponent(componentUID, value)
-        );
-        componentBody[attributeName] = components.filter(___default.default.negate(___default.default.isNil)).map(({ id }) => {
-          return {
-            id,
-            __pivot: {
-              field: attributeName,
-              component_type: componentUID
+        if (attribute.type === 'component') {
+            const { component: componentUID, repeatable = false } = attribute;
+            const componentValue = data[attributeName];
+            await deleteOldComponents(uid, componentUID, entityToUpdate, attributeName, componentValue);
+            if (repeatable === true) {
+                if (!Array.isArray(componentValue)) {
+                    throw new Error('Expected an array to create repeatable component');
+                }
+                // MySQL/MariaDB can cause deadlocks here if concurrency higher than 1
+                const components = await strapiUtils.async.map(componentValue, (value)=>updateOrCreateComponent(componentUID, value));
+                componentBody[attributeName] = components.filter(_.negate(_.isNil)).map(({ id })=>{
+                    return {
+                        id,
+                        __pivot: {
+                            field: attributeName,
+                            component_type: componentUID
+                        }
+                    };
+                });
+            } else {
+                const component = await updateOrCreateComponent(componentUID, componentValue);
+                componentBody[attributeName] = component && {
+                    id: component.id,
+                    __pivot: {
+                        field: attributeName,
+                        component_type: componentUID
+                    }
+                };
             }
-          };
-        });
-      } else {
-        const component = await updateOrCreateComponent(componentUID, componentValue);
-        componentBody[attributeName] = component && {
-          id: component.id,
-          __pivot: {
-            field: attributeName,
-            component_type: componentUID
-          }
-        };
-      }
-    } else if (attribute.type === "dynamiczone") {
-      const dynamiczoneValues = data[attributeName];
-      await deleteOldDZComponents(uid, entityToUpdate, attributeName, dynamiczoneValues);
-      if (!Array.isArray(dynamiczoneValues)) {
-        throw new Error("Expected an array to create repeatable component");
-      }
-      componentBody[attributeName] = await strapiUtils.async.map(dynamiczoneValues, async (value) => {
-        const { id } = await updateOrCreateComponent(value.__component, value);
-        return {
-          id,
-          __component: value.__component,
-          __pivot: {
-            field: attributeName
-          }
-        };
-      });
+        } else if (attribute.type === 'dynamiczone') {
+            const dynamiczoneValues = data[attributeName];
+            await deleteOldDZComponents(uid, entityToUpdate, attributeName, dynamiczoneValues);
+            if (!Array.isArray(dynamiczoneValues)) {
+                throw new Error('Expected an array to create repeatable component');
+            }
+            // MySQL/MariaDB can cause deadlocks here if concurrency higher than 1
+            componentBody[attributeName] = await strapiUtils.async.map(dynamiczoneValues, async (value)=>{
+                const { id } = await updateOrCreateComponent(value.__component, value);
+                return {
+                    id,
+                    __component: value.__component,
+                    __pivot: {
+                        field: attributeName
+                    }
+                };
+            });
+        }
     }
-  }
-  return componentBody;
+    return componentBody;
 };
-const pickStringifiedId = ({
-  id
-}) => {
-  if (typeof id === "string") {
-    return id;
-  }
-  return `${id}`;
+const pickStringifiedId = ({ id })=>{
+    if (typeof id === 'string') {
+        return id;
+    }
+    return `${id}`;
 };
-const deleteOldComponents = async (uid, componentUID, entityToUpdate, attributeName, componentValue) => {
-  const previousValue = await strapi.db.query(uid).load(entityToUpdate, attributeName);
-  const idsToKeep = ___default.default.castArray(componentValue).filter(fp.has("id")).map(pickStringifiedId);
-  const allIds = ___default.default.castArray(previousValue).filter(fp.has("id")).map(pickStringifiedId);
-  idsToKeep.forEach((id) => {
-    if (!allIds.includes(id)) {
-      throw new strapiUtils.errors.ApplicationError(
-        `Some of the provided components in ${attributeName} are not related to the entity`
-      );
+const deleteOldComponents = async (uid, componentUID, entityToUpdate, attributeName, componentValue)=>{
+    const previousValue = await strapi.db.query(uid).load(entityToUpdate, attributeName);
+    const idsToKeep = _.castArray(componentValue).filter(fp.has('id')).map(pickStringifiedId);
+    const allIds = _.castArray(previousValue).filter(fp.has('id')).map(pickStringifiedId);
+    idsToKeep.forEach((id)=>{
+        if (!allIds.includes(id)) {
+            throw new strapiUtils.errors.ApplicationError(`Some of the provided components in ${attributeName} are not related to the entity`);
+        }
+    });
+    const idsToDelete = _.difference(allIds, idsToKeep);
+    if (idsToDelete.length > 0) {
+        for (const idToDelete of idsToDelete){
+            await deleteComponent(componentUID, {
+                id: idToDelete
+            });
+        }
     }
-  });
-  const idsToDelete = ___default.default.difference(allIds, idsToKeep);
-  if (idsToDelete.length > 0) {
-    for (const idToDelete of idsToDelete) {
-      await deleteComponent(componentUID, { id: idToDelete });
+};
+const deleteOldDZComponents = async (uid, entityToUpdate, attributeName, dynamiczoneValues)=>{
+    const previousValue = await strapi.db.query(uid).load(entityToUpdate, attributeName);
+    const idsToKeep = _.castArray(dynamiczoneValues).filter(fp.has('id')).map((v)=>({
+            id: pickStringifiedId(v),
+            __component: v.__component
+        }));
+    const allIds = _.castArray(previousValue).filter(fp.has('id')).map((v)=>({
+            id: pickStringifiedId(v),
+            __component: v.__component
+        }));
+    idsToKeep.forEach(({ id, __component })=>{
+        if (!allIds.find((el)=>el.id === id && el.__component === __component)) {
+            const err = new Error(`Some of the provided components in ${attributeName} are not related to the entity`);
+            Object.assign(err, {
+                status: 400
+            });
+            throw err;
+        }
+    });
+    const idsToDelete = allIds.reduce((acc, { id, __component })=>{
+        if (!idsToKeep.find((el)=>el.id === id && el.__component === __component)) {
+            acc.push({
+                id,
+                __component
+            });
+        }
+        return acc;
+    }, []);
+    if (idsToDelete.length > 0) {
+        for (const idToDelete of idsToDelete){
+            const { id, __component } = idToDelete;
+            await deleteComponent(__component, {
+                id
+            });
+        }
     }
-  }
 };
-const deleteOldDZComponents = async (uid, entityToUpdate, attributeName, dynamiczoneValues) => {
-  const previousValue = await strapi.db.query(uid).load(entityToUpdate, attributeName);
-  const idsToKeep = ___default.default.castArray(dynamiczoneValues).filter(fp.has("id")).map((v) => ({
-    id: pickStringifiedId(v),
-    __component: v.__component
-  }));
-  const allIds = ___default.default.castArray(previousValue).filter(fp.has("id")).map((v) => ({
-    id: pickStringifiedId(v),
-    __component: v.__component
-  }));
-  idsToKeep.forEach(({ id, __component }) => {
-    if (!allIds.find((el) => el.id === id && el.__component === __component)) {
-      const err = new Error(
-        `Some of the provided components in ${attributeName} are not related to the entity`
-      );
-      Object.assign(err, { status: 400 });
-      throw err;
+const deleteComponents = async (uid, entityToDelete, { loadComponents = true } = {})=>{
+    const { attributes = {} } = strapi.getModel(uid);
+    const attributeNames = Object.keys(attributes);
+    for (const attributeName of attributeNames){
+        const attribute = attributes[attributeName];
+        if (attribute.type === 'component' || attribute.type === 'dynamiczone') {
+            let value;
+            if (loadComponents) {
+                value = await strapi.db.query(uid).load(entityToDelete, attributeName);
+            } else {
+                value = entityToDelete[attributeName];
+            }
+            if (!value) {
+                continue;
+            }
+            if (attribute.type === 'component') {
+                const { component: componentUID } = attribute;
+                await strapiUtils.async.map(_.castArray(value), (subValue)=>deleteComponent(componentUID, subValue));
+            } else {
+                await strapiUtils.async.map(_.castArray(value), (subValue)=>deleteComponent(subValue.__component, subValue));
+            }
+            continue;
+        }
     }
-  });
-  const idsToDelete = allIds.reduce((acc, { id, __component }) => {
-    if (!idsToKeep.find((el) => el.id === id && el.__component === __component)) {
-      acc.push({ id, __component });
+};
+/** *************************
+    Component queries
+************************** */ // components can have nested compos so this must be recursive
+const createComponent = async (uid, data)=>{
+    const schema = strapi.getModel(uid);
+    const componentData = await createComponents(uid, data);
+    const transform = fp.pipe(// Make sure we don't save the component with a pre-defined ID
+    fp.omit('id'), assignComponentData(schema, componentData));
+    return strapi.db.query(uid).create({
+        data: transform(data)
+    });
+};
+// components can have nested compos so this must be recursive
+const updateComponent = async (uid, componentToUpdate, data)=>{
+    const schema = strapi.getModel(uid);
+    const componentData = await updateComponents(uid, componentToUpdate, data);
+    return strapi.db.query(uid).update({
+        where: {
+            id: componentToUpdate.id
+        },
+        data: assignComponentData(schema, componentData, data)
+    });
+};
+const updateOrCreateComponent = (componentUID, value)=>{
+    if (value === null) {
+        return null;
     }
-    return acc;
-  }, []);
-  if (idsToDelete.length > 0) {
-    for (const idToDelete of idsToDelete) {
-      const { id, __component } = idToDelete;
-      await deleteComponent(__component, { id });
+    // update
+    if ('id' in value && typeof value.id !== 'undefined') {
+        // TODO: verify the compo is associated with the entity
+        return updateComponent(componentUID, {
+            id: value.id
+        }, value);
     }
-  }
+    // create
+    return createComponent(componentUID, value);
 };
-const deleteComponents = async (uid, entityToDelete, { loadComponents = true } = {}) => {
-  const { attributes = {} } = strapi.getModel(uid);
-  const attributeNames = Object.keys(attributes);
-  for (const attributeName of attributeNames) {
-    const attribute = attributes[attributeName];
-    if (attribute.type === "component" || attribute.type === "dynamiczone") {
-      let value;
-      if (loadComponents) {
-        value = await strapi.db.query(uid).load(entityToDelete, attributeName);
-      } else {
-        value = entityToDelete[attributeName];
-      }
-      if (!value) {
-        continue;
-      }
-      if (attribute.type === "component") {
-        const { component: componentUID } = attribute;
-        await strapiUtils.async.map(
-          ___default.default.castArray(value),
-          (subValue) => deleteComponent(componentUID, subValue)
-        );
-      } else {
-        await strapiUtils.async.map(
-          ___default.default.castArray(value),
-          (subValue) => deleteComponent(subValue.__component, subValue)
-        );
-      }
-      continue;
-    }
-  }
+const deleteComponent = async (uid, componentToDelete)=>{
+    await deleteComponents(uid, componentToDelete);
+    await strapi.db.query(uid).delete({
+        where: {
+            id: componentToDelete.id
+        }
+    });
 };
-const createComponent = async (uid, data) => {
-  const schema = strapi.getModel(uid);
-  const componentData = await createComponents(uid, data);
-  const transform = fp.pipe(
-    // Make sure we don't save the component with a pre-defined ID
-    fp.omit("id"),
-    assignComponentData(schema, componentData)
-  );
-  return strapi.db.query(uid).create({ data: transform(data) });
+const assignComponentData = fp.curry((schema, componentData, data)=>{
+    return fp.pipe(omitComponentData(schema), fp.assign(componentData))(data);
+});
+/** *************************
+    Component relation handling for document operations
+************************** */ /**
+ * Find the parent entry of a component instance.
+ *
+ * Given a component model, a specific component instance id, and the list of
+ * possible parent content types (those that can embed this component),
+ * this function checks each parent's *_cmps join table to see if the component
+ * instance is linked to a parent entity.
+ *
+ * - Returns the parent uid, parent table name, and parent id if found.
+ * - Returns null if no parent relationship exists.
+ */ const findComponentParent = async (componentSchema, componentId, parentSchemasForComponent, opts)=>{
+    if (!componentSchema?.uid) return null;
+    const schemaBuilder = strapi.db.getSchemaConnection(opts?.trx);
+    const withTrx = (qb)=>opts?.trx ? qb.transacting(opts.trx) : qb;
+    for (const parent of parentSchemasForComponent){
+        if (!parent.collectionName) continue;
+        // Use the exact same functions that create the tables
+        const identifiers = strapi.db.metadata.identifiers;
+        const joinTableName = transformContentTypesToModels.getComponentJoinTableName(parent.collectionName, identifiers);
+        try {
+            const tableExists = await schemaBuilder.hasTable(joinTableName);
+            if (!tableExists) continue;
+            // Use the exact same functions that create the columns
+            const entityIdColumn = transformContentTypesToModels.getComponentJoinColumnEntityName(identifiers);
+            const componentIdColumn = transformContentTypesToModels.getComponentJoinColumnInverseName(identifiers);
+            const componentTypeColumn = transformContentTypesToModels.getComponentTypeColumn(identifiers);
+            const parentRow = await withTrx(strapi.db.getConnection(joinTableName)).where({
+                [componentIdColumn]: componentId,
+                [componentTypeColumn]: componentSchema.uid
+            }).first(entityIdColumn);
+            if (parentRow) {
+                return {
+                    uid: parent.uid,
+                    table: parent.collectionName,
+                    parentId: parentRow[entityIdColumn]
+                };
+            }
+        } catch  {
+            continue;
+        }
+    }
+    return null;
 };
-const updateComponent = async (uid, componentToUpdate, data) => {
-  const schema = strapi.getModel(uid);
-  const componentData = await updateComponents(uid, componentToUpdate, data);
-  return strapi.db.query(uid).update({
-    where: {
-      id: componentToUpdate.id
-    },
-    data: assignComponentData(schema, componentData, data)
-  });
+/**
+ * Finds content types that contain the given component and have draft & publish enabled.
+ */ const getParentSchemasForComponent = (componentSchema)=>{
+    return Object.values(strapi.contentTypes).filter((contentType)=>{
+        if (!contentType.options?.draftAndPublish) return false;
+        return Object.values(contentType.attributes).some((attr)=>{
+            return attr.type === 'component' && attr.component === componentSchema.uid || attr.type === 'dynamiczone' && attr.components?.includes(componentSchema.uid);
+        });
+    });
 };
-const updateOrCreateComponent = (componentUID, value) => {
-  if (value === null) {
-    return null;
-  }
-  if ("id" in value && typeof value.id !== "undefined") {
-    return updateComponent(componentUID, { id: value.id }, value);
-  }
-  return createComponent(componentUID, value);
+/**
+ * Determines if a component relation should be propagated to a new document version
+ * when a document with draft and publish is updated.
+ */ const shouldPropagateComponentRelationToNewVersion = async (componentRelation, componentSchema, parentSchemasForComponent, trx)=>{
+    // Get the component ID column name using the actual component model name
+    const componentIdColumn = strapi.db.metadata.identifiers.getJoinColumnAttributeIdName(_.snakeCase(componentSchema.modelName));
+    const componentId = componentRelation[componentIdColumn];
+    const parent = await findComponentParent(componentSchema, componentId, parentSchemasForComponent, {
+        trx
+    });
+    // Keep relation if component has no parent entry
+    if (!parent?.uid) {
+        return true;
+    }
+    const parentContentType = strapi.contentTypes[parent.uid];
+    // Keep relation if parent doesn't have draft & publish enabled
+    if (!parentContentType?.options?.draftAndPublish) {
+        return true;
+    }
+    // Discard relation if parent has draft & publish enabled
+    return false;
 };
-const deleteComponent = async (uid, componentToDelete) => {
-  await deleteComponents(uid, componentToDelete);
-  await strapi.db.query(uid).delete({ where: { id: componentToDelete.id } });
+/**
+ * Creates a filter function for component relations that can be passed to the generic
+ * unidirectional relations utility
+ */ const createComponentRelationFilter = ()=>{
+    return async (relation, model, trx)=>{
+        // Only apply component-specific filtering for components
+        if (model.modelType !== 'component') {
+            return true;
+        }
+        const componentSchema = model;
+        const parentSchemas = getParentSchemasForComponent(componentSchema);
+        // Exit if no draft & publish parent types exist
+        if (parentSchemas.length === 0) {
+            return true;
+        }
+        return shouldPropagateComponentRelationToNewVersion(relation, componentSchema, parentSchemas, trx);
+    };
 };
-const assignComponentData = fp.curry(
-  (schema, componentData, data) => {
-    return fp.pipe(omitComponentData(schema), fp.assign(componentData))(data);
-  }
-);
+
 exports.assignComponentData = assignComponentData;
+exports.createComponentRelationFilter = createComponentRelationFilter;
 exports.createComponents = createComponents;
 exports.deleteComponent = deleteComponent;
 exports.deleteComponents = deleteComponents;