@strapi/database 4.5.4 → 4.6.0-beta.0

package/lib/entity-manager/__tests__/relations-orderer.test.js

@@ -0,0 +1,85 @@
+'use strict';
+
+const relationsOrderer = require('../relations-orderer');
+
+describe('relations orderer', () => {
+  test('connect at the end', () => {
+    const orderer = relationsOrderer(
+      [
+        { id: 2, order: 4 },
+        { id: 3, order: 10 },
+      ],
+      'id',
+      'order'
+    );
+
+    orderer.connect([{ id: 4, position: { end: true } }, { id: 5 }]);
+
+    expect(orderer.get()).toMatchObject([
+      { id: 2, order: 4 },
+      { id: 3, order: 10 },
+      { id: 4, order: 10.5 },
+      { id: 5, order: 10.5 },
+    ]);
+  });
+
+  test('connect at the start', () => {
+    const orderer = relationsOrderer(
+      [
+        { id: 2, order: 4 },
+        { id: 3, order: 10 },
+      ],
+      'id',
+      'order'
+    );
+
+    orderer.connect([{ id: 4, position: { start: true } }]);
+
+    expect(orderer.get()).toMatchObject([
+      { id: 4, order: 0.5 },
+      { id: 2, order: 4 },
+      { id: 3, order: 10 },
+    ]);
+  });
+
+  test('connect multiple relations', () => {
+    const orderer = relationsOrderer(
+      [
+        { id: 2, order: 4 },
+        { id: 3, order: 10 },
+      ],
+      'id',
+      'order'
+    );
+
+    orderer.connect([
+      { id: 4, position: { before: 2 } },
+      { id: 4, position: { before: 3 } },
+      { id: 5, position: { before: 4 } },
+    ]);
+
+    expect(orderer.get()).toMatchObject([
+      { id: 2, order: 4 },
+      { id: 5, order: 9.5 },
+      { id: 4, order: 9.5 },
+      { id: 3, order: 10 },
+    ]);
+  });
+
+  test('connect with no initial relations', () => {
+    const orderer = relationsOrderer([], 'id', 'order');
+
+    orderer.connect([
+      { id: 1, position: { start: true } },
+      { id: 2, position: { start: true } },
+      { id: 3, position: { after: 1 } },
+      { id: 1, position: { after: 2 } },
+    ]);
+
+    expect(orderer.get()).toMatchObject([
+      { id: 2, order: 0.5 },
+      { id: 1, order: 0.5 },
+      { id: 3, order: 0.5 },
+    ]);
+  });
+});

package/lib/entity-manager/index.js

@@ -3,6 +3,7 @@
 const {
   isUndefined,
   castArray,
+  compact,
   isNil,
   has,
   isString,
@@ -18,6 +19,7 @@ const {
   isNumber,
   map,
   difference,
+  uniqBy,
 } = require('lodash/fp');
 const types = require('../types');
 const { createField } = require('../fields');
@@ -37,6 +39,7 @@ const {
   deleteRelations,
   cleanOrderColumns,
 } = require('./regular-relations');
+const relationsOrderer = require('./relations-orderer');
 
 const toId = (value) => value.id || value;
 const toIds = (value) => castArray(value || []).map(toId);
@@ -75,7 +78,10 @@ const toAssocs = (data) => {
   }
 
   return {
-    connect: toIdArray(data?.connect),
+    connect: toIdArray(data?.connect).map((elm) => ({
+      id: elm.id,
+      position: elm.position ? elm.position : { end: true },
+    })),
     disconnect: toIdArray(data?.disconnect),
   };
 };
@@ -561,7 +567,7 @@ const createEntityManager = (db) => {
           }
 
           // prepare new relations to insert
-          const insert = relsToAdd.map((data) => {
+          const insert = uniqBy('id', relsToAdd).map((data) => {
             return {
               [joinColumn.name]: id,
               [inverseJoinColumn.name]: data.id,
@@ -571,11 +577,23 @@ const createEntityManager = (db) => {
           });
 
           // add order value
-          if (hasOrderColumn(attribute)) {
-            insert.forEach((rel, idx) => {
-              rel[orderColumnName] = idx + 1;
+          if (cleanRelationData.set && hasOrderColumn(attribute)) {
+            insert.forEach((data, idx) => {
+              data[orderColumnName] = idx + 1;
+            });
+          } else if (cleanRelationData.connect && hasOrderColumn(attribute)) {
+            // use position attributes to calculate order
+            const orderMap = relationsOrderer([], inverseJoinColumn.name, joinTable.orderColumnName)
+              .connect(relsToAdd)
+              .get()
+              // set the order based on the order of the ids
+              .reduce((acc, rel, idx) => ({ ...acc, [rel.id]: idx }), {});
+
+            insert.forEach((row) => {
+              row[orderColumnName] = orderMap[row[inverseJoinColumn.name]];
             });
           }
+
           // add inv_order value
           if (hasInverseOrderColumn(attribute)) {
             const maxResults = await db
@@ -815,27 +833,53 @@ const createEntityManager = (db) => {
               }
 
               // prepare relations to insert
-              const insert = cleanRelationData.connect.map((relToAdd) => ({
+              const insert = uniqBy('id', cleanRelationData.connect).map((relToAdd) => ({
                 [joinColumn.name]: id,
                 [inverseJoinColumn.name]: relToAdd.id,
                 ...(joinTable.on || {}),
                 ...(relToAdd.__pivot || {}),
               }));
 
-              // add order value
               if (hasOrderColumn(attribute)) {
-                const orderMax = (
-                  await this.createQueryBuilder(joinTable.name)
-                    .max(orderColumnName)
-                    .where({ [joinColumn.name]: id })
-                    .where(joinTable.on || {})
-                    .first()
-                    .transacting(trx)
-                    .execute()
-                ).max;
+                // Get all adjacent relations and the one with the highest order
+                const adjacentRelations = await this.createQueryBuilder(joinTable.name)
+                  .where({
+                    $or: [
+                      {
+                        [joinColumn.name]: id,
+                        [inverseJoinColumn.name]: {
+                          $in: compact(
+                            cleanRelationData.connect.map(
+                              (r) => r.position?.after || r.position?.before
+                            )
+                          ),
+                        },
+                      },
+                      {
+                        [joinColumn.name]: id,
+                        [orderColumnName]: this.createQueryBuilder(joinTable.name)
+                          .max(orderColumnName)
+                          .where({ [joinColumn.name]: id })
+                          .where(joinTable.on || {})
+                          .transacting(trx)
+                          .getKnexQuery(),
+                      },
+                    ],
+                  })
+                  .where(joinTable.on || {})
+                  .transacting(trx)
+                  .execute();
 
-                insert.forEach((row, idx) => {
-                  row[orderColumnName] = orderMax + idx + 1;
+                const orderMap = relationsOrderer(
+                  adjacentRelations,
+                  inverseJoinColumn.name,
+                  joinTable.orderColumnName
+                )
+                  .connect(cleanRelationData.connect)
+                  .getOrderMap();
+
+                insert.forEach((row) => {
+                  row[orderColumnName] = orderMap[row[inverseJoinColumn.name]];
                 });
               }
 
@@ -901,7 +945,7 @@ const createEntityManager = (db) => {
                 continue;
               }
 
-              const insert = cleanRelationData.set.map((relToAdd) => ({
+              const insert = uniqBy('id', cleanRelationData.set).map((relToAdd) => ({
                 [joinColumn.name]: id,
                 [inverseJoinColumn.name]: relToAdd.id,
                 ...(joinTable.on || {}),

package/lib/entity-manager/regular-relations.js

@@ -198,42 +198,60 @@ const cleanOrderColumns = async ({ id, attribute, db, inverseRelIds, transaction
     return;
   }
 
+  // Handle databases that don't support window function ROW_NUMBER
+  if (!strapi.db.dialect.supportsWindowFunctions()) {
+    await cleanOrderColumnsForOldDatabases({ id, attribute, db, inverseRelIds, transaction: trx });
+    return;
+  }
+
+  const { joinTable } = attribute;
+  const { joinColumn, inverseJoinColumn, orderColumnName, inverseOrderColumnName } = joinTable;
+  const update = [];
+  const updateBinding = [];
+  const select = ['??'];
+  const selectBinding = ['id'];
+  const where = [];
+  const whereBinding = [];
+
+  if (hasOrderColumn(attribute) && id) {
+    update.push('?? = b.src_order');
+    updateBinding.push(orderColumnName);
+    select.push('ROW_NUMBER() OVER (PARTITION BY ?? ORDER BY ??) AS src_order');
+    selectBinding.push(joinColumn.name, orderColumnName);
+    where.push('?? = ?');
+    whereBinding.push(joinColumn.name, id);
+  }
+
+  if (hasInverseOrderColumn(attribute) && !isEmpty(inverseRelIds)) {
+    update.push('?? = b.inv_order');
+    updateBinding.push(inverseOrderColumnName);
+    select.push('ROW_NUMBER() OVER (PARTITION BY ?? ORDER BY ??) AS inv_order');
+    selectBinding.push(inverseJoinColumn.name, inverseOrderColumnName);
+    where.push(`?? IN (${inverseRelIds.map(() => '?').join(', ')})`);
+    whereBinding.push(inverseJoinColumn.name, ...inverseRelIds);
+  }
+
+  // raw query as knex doesn't allow updating from a subquery
+  // https://github.com/knex/knex/issues/2504
   switch (strapi.db.dialect.client) {
     case 'mysql':
-      await cleanOrderColumnsForInnoDB({ id, attribute, db, inverseRelIds, transaction: trx });
+      await db.connection
+        .raw(
+          `UPDATE
+            ?? as a,
+            (
+              SELECT ${select.join(', ')}
+              FROM ??
+              WHERE ${where.join(' OR ')}
+            ) AS b
+          SET ${update.join(', ')}
+          WHERE b.id = a.id`,
+          [joinTable.name, ...selectBinding, joinTable.name, ...whereBinding, ...updateBinding]
+        )
+        .transacting(trx);
       break;
     default: {
-      const { joinTable } = attribute;
-      const { joinColumn, inverseJoinColumn, orderColumnName, inverseOrderColumnName } = joinTable;
-      const update = [];
-      const updateBinding = [];
-      const select = ['??'];
-      const selectBinding = ['id'];
-      const where = [];
-      const whereBinding = [];
-
-      if (hasOrderColumn(attribute) && id) {
-        update.push('?? = b.src_order');
-        updateBinding.push(orderColumnName);
-        select.push('ROW_NUMBER() OVER (PARTITION BY ?? ORDER BY ??) AS src_order');
-        selectBinding.push(joinColumn.name, orderColumnName);
-        where.push('?? = ?');
-        whereBinding.push(joinColumn.name, id);
-      }
-
-      if (hasInverseOrderColumn(attribute) && !isEmpty(inverseRelIds)) {
-        update.push('?? = b.inv_order');
-        updateBinding.push(inverseOrderColumnName);
-        select.push('ROW_NUMBER() OVER (PARTITION BY ?? ORDER BY ??) AS inv_order');
-        selectBinding.push(inverseJoinColumn.name, inverseOrderColumnName);
-        where.push(`?? IN (${inverseRelIds.map(() => '?').join(', ')})`);
-        whereBinding.push(inverseJoinColumn.name, ...inverseRelIds);
-      }
-
       const joinTableName = addSchema(joinTable.name);
-
-      // raw query as knex doesn't allow updating from a subquery
-      // https://github.com/knex/knex/issues/2504
       await db.connection
         .raw(
           `UPDATE ?? as a
@@ -247,29 +265,24 @@ const cleanOrderColumns = async ({ id, attribute, db, inverseRelIds, transaction
           [joinTableName, ...updateBinding, ...selectBinding, joinTableName, ...whereBinding]
         )
         .transacting(trx);
-
-      /*
-        `UPDATE :joinTable: as a
-          SET :orderColumn: = b.src_order, :inverseOrderColumn: = b.inv_order
-          FROM (
-            SELECT
-              id,
-              ROW_NUMBER() OVER ( PARTITION BY :joinColumn: ORDER BY :orderColumn:) AS src_order,
-              ROW_NUMBER() OVER ( PARTITION BY :inverseJoinColumn: ORDER BY :inverseOrderColumn:) AS inv_order
-            FROM :joinTable:
-            WHERE :joinColumn: = :id OR :inverseJoinColumn: IN (:inverseRelIds)
-          ) AS b
-          WHERE b.id = a.id`,
-      */
     }
+    /*
+      `UPDATE :joinTable: as a
+        SET :orderColumn: = b.src_order, :inverseOrderColumn: = b.inv_order
+        FROM (
+          SELECT
+            id,
+            ROW_NUMBER() OVER ( PARTITION BY :joinColumn: ORDER BY :orderColumn:) AS src_order,
+            ROW_NUMBER() OVER ( PARTITION BY :inverseJoinColumn: ORDER BY :inverseOrderColumn:) AS inv_order
+          FROM :joinTable:
+          WHERE :joinColumn: = :id OR :inverseJoinColumn: IN (:inverseRelIds)
+        ) AS b
+        WHERE b.id = a.id`,
+    */
   }
 };
 
-/*
- * Ensure that orders are following a 1, 2, 3 sequence, without gap.
- * The use of a temporary table instead of a window function makes the query compatible with MySQL 5 and prevents some deadlocks to happen in innoDB databases
- */
-const cleanOrderColumnsForInnoDB = async ({
+const cleanOrderColumnsForOldDatabases = async ({
   id,
   attribute,
   db,
@@ -306,9 +319,6 @@ const cleanOrderColumnsForInnoDB = async ({
           }
         )
         .transacting(trx);
-
-      // raw query as knex doesn't allow updating from a subquery
-      // https://github.com/knex/knex/issues/2504
       await db.connection
         .raw(
           `UPDATE ?? as a, (SELECT * FROM ??) AS b

package/lib/entity-manager/relations-orderer.js

@@ -0,0 +1,126 @@
+'use strict';
+
+const _ = require('lodash/fp');
+
+/**
+ * Responsible for calculating the relations order when connecting them.
+ *
+ * The connect method takes an array of relations with positional attributes:
+ * - before: the id of the relation to connect before
+ * - after: the id of the relation to connect after
+ * - end: it should be at the end
+ * - start: it should be at the start
+ *
+ * Example:
+ *  - Having a connect array like:
+ *      [ { id: 4, before: 2 }, { id: 4, before: 3}, {id: 5, before: 4} ]
+ * - With the initial relations:
+ *      [ { id: 2, order: 4 }, { id: 3, order: 10 } ]
+ * - Step by step, going through the connect array, the array of relations would be:
+ *      [ { id: 4, order: 3.5 }, { id: 2, order: 4 }, { id: 3, order: 10 } ]
+ *      [ { id: 2, order: 4 }, { id: 4, order: 3.5 }, { id: 3, order: 10 } ]
+ *      [ { id: 2, order: 4 }, { id: 5, order: 3.5 },  { id: 4, order: 3.5 }, { id: 3, order: 10 } ]
+ * - The final step would be to recalculate fractional order values.
+ *      [ { id: 2, order: 4 }, { id: 5, order: 3.33 },  { id: 4, order: 3.66 }, { id: 3, order: 10 } ]
+ *
+ * Constraints:
+ * - Expects you will never connect a relation before / after one that does not exist
+ * - Expect initArr to have all relations referenced in the positional attributes
+ *
+ * @param {Array<*>} initArr - array of relations to initialize the class with
+ * @param {string} idColumn - the column name of the id
+ * @param {string} orderColumn - the column name of the order
+ * @return {*}
+ */
+const relationsOrderer = (initArr, idColumn, orderColumn) => {
+  const arr = _.castArray(initArr || []).map((r) => ({
+    init: true,
+    id: r[idColumn],
+    order: r[orderColumn],
+  }));
+
+  const maxOrder = _.maxBy('order', arr)?.order || 0;
+
+  // TODO: Improve performance by using a map
+  const findRelation = (id) => {
+    const idx = arr.findIndex((r) => r.id === id);
+    return { idx, relation: arr[idx] };
+  };
+
+  const removeRelation = (r) => {
+    const { idx } = findRelation(r.id);
+    if (idx >= 0) {
+      arr.splice(idx, 1);
+    }
+  };
+
+  const insertRelation = (r) => {
+    let idx;
+
+    if (r.position?.before) {
+      const { idx: _idx, relation } = findRelation(r.position.before);
+      if (relation.init) r.order = relation.order - 0.5;
+      else r.order = relation.order;
+      idx = _idx;
+    } else if (r.position?.after) {
+      const { idx: _idx, relation } = findRelation(r.position.after);
+      if (relation.init) r.order = relation.order + 0.5;
+      else r.order = relation.order;
+      idx = _idx + 1;
+    } else if (r.position?.start) {
+      r.order = 0.5;
+      idx = 0;
+    } else {
+      r.order = maxOrder + 0.5;
+      idx = arr.length;
+    }
+
+    // Insert the relation in the array
+    arr.splice(idx, 0, r);
+  };
+
+  return {
+    disconnect(relations) {
+      _.castArray(relations).forEach((relation) => {
+        removeRelation(relation);
+      });
+      return this;
+    },
+    connect(relations) {
+      _.castArray(relations).forEach((relation) => {
+        this.disconnect(relation);
+
+        try {
+          insertRelation(relation);
+        } catch (err) {
+          strapi.log.error(err);
+          throw new Error(
+            `Could not connect ${relation.id}, position ${JSON.stringify(
+              relation.position
+            )} is invalid`
+          );
+        }
+      });
+      return this;
+    },
+    get() {
+      return arr;
+    },
+    /**
+     * Get a map between the relation id and its order
+     */
+    getOrderMap() {
+      return _(arr)
+        .groupBy('order')
+        .reduce((acc, relations) => {
+          if (relations[0]?.init) return acc;
+          relations.forEach((relation, idx) => {
+            acc[relation.id] = Math.floor(relation.order) + (idx + 1) / (relations.length + 1);
+          });
+          return acc;
+        }, {});
+    },
+  };
+};
+
+module.exports = relationsOrderer;

package/lib/metadata/index.js

@@ -136,7 +136,7 @@ const createCompoLinkModelMeta = (baseModelMeta) => {
         type: 'string',
       },
       order: {
-        type: 'integer',
+        type: 'float',
         column: {
           unsigned: true,
           defaultTo: null,

package/lib/metadata/relations.js

@@ -231,7 +231,7 @@ const createMorphToMany = (attributeName, attribute, meta, metadata) => {
         type: 'string',
       },
       order: {
-        type: 'integer',
+        type: 'float',
         column: {
           unsigned: true,
         },
@@ -485,7 +485,7 @@ const createJoinTable = (metadata, { attributeName, attribute, meta }) => {
   // order
   if (isAnyToMany(attribute)) {
     metadataSchema.attributes[orderColumnName] = {
-      type: 'integer',
+      type: 'float',
       column: {
         unsigned: true,
         defaultTo: null,
@@ -502,7 +502,7 @@ const createJoinTable = (metadata, { attributeName, attribute, meta }) => {
   // inv order
   if (isBidirectional(attribute) && isManyToAny(attribute)) {
     metadataSchema.attributes[inverseOrderColumnName] = {
-      type: 'integer',
+      type: 'float',
       column: {
         unsigned: true,
         defaultTo: null,

package/lib/query/helpers/where.js

@@ -53,7 +53,7 @@ const castValue = (value, attribute) => {
     return value;
   }
 
-  if (types.isScalar(attribute.type)) {
+  if (types.isScalar(attribute.type) && !isKnexQuery(value)) {
     const field = createField(attribute);
 
     return value === null ? null : field.toDB(value);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/database",
-  "version": "4.5.4",
+  "version": "4.6.0-beta.0",
   "description": "Strapi's database layer",
   "homepage": "https://strapi.io",
   "bugs": {
@@ -43,5 +43,5 @@
     "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "8716ecc920130db5341b0904cf868c6e6b581a5d"
+  "gitHead": "c0c3365ad801d088a6ab6c4eb95a014078429747"
 }