order in defaultScope merging rather than overwritten

What are you doing?

Docs say “The limit, offset, order, paranoid, lock and raw fields are overwritten, while where is shallowly merged (meaning that identical keys will be overwritten). The merge strategy for include will be discussed later on.” but when i use order in defaultScope, and i use order in my query, order is merging not overwritten

when using this model

module.exports = (sequelize, DataTypes) => {
  const organizationMember = sequelize.define(
    "organizationMember",
    {
      id: {
        type: DataTypes.UUID,
        primaryKey: true,
        defaultValue: DataTypes.UUIDV4
      },
      organizationId: {
        type: DataTypes.UUID,
        allowNull: false
      },
      accountId: {
        type: DataTypes.UUID,
        allowNull: false
      },
      type: {
        type: DataTypes.STRING,
        allowNull: false
      },
      deletedAt: {
        type: DataTypes.DATE,
        allowNull: true
      }
    },
    {
      defaultScope: {
        order: [["createdAt", "ASC"]],
        where: { deletedAt: null }
      }
    }
  );
  return organizationMember;
};

then i query with

const organizationMember = await OrganizationMember.findAll({
  limit: 10,
  offset: 0,
  order: [["createdAt", "DESC"]],
  where: { organizationId: "97b5d956-c740-4100-ad1a-ea2a1364f9df" }
});

What do you expect to happen?

this sql query

SELECT "id", "organizationId", "accountId", "type", "deletedAt", "createdAt", "updatedAt" FROM "organizationMembers" AS "organizationMember" WHERE "organizationMember"."deletedAt" IS NULL AND "organizationMember"."organizationId" = '97b5d956-c740-4100-ad1a-ea2a1364f9df' ORDER BY "organizationMember"."createdAt" DESC LIMIT 10 OFFSET 0;

What is actually happening?

but i got this query

SELECT "id", "organizationId", "accountId", "type", "deletedAt", "createdAt", "updatedAt" FROM "organizationMembers" AS "organizationMember" WHERE "organizationMember"."deletedAt" IS NULL AND "organizationMember"."organizationId" = '97b5d956-c740-4100-ad1a-ea2a1364f9df' ORDER BY "organizationMember"."createdAt" ASC, "organizationMember"."createdAt" DESC LIMIT 10 OFFSET 0;

Environment

Dialect:

• mysql
• postgres
• sqlite
• mssql
• any

Dialect library version: 7.10.0 Database version: 11.2 Sequelize version: 5.8.5 Node Version: 10.15.3 OS: Fedora 29

Tested with latest release:

• No
• Yes, specify that version: 5.8.5

[toxuin]

We are seeing the same behaviour on MySQL too. This is annoying because there’s no non-hacky way to fix it.

This behaviour does not make any sense: you specify the ordering you need results in, but the resulting SQL contains something completely different.

I believe the scope merging is doing a disservice in case of ordering. Docs are absolutely right: it should replace the existing order, not merge it in.

I was able to “fix” it by means of a dirty patch to sequelize, but I have no idea if it would break other things.

Please let me know if I am on the right path here:

in model.js in _injectScope function, I add a line:

if (options.order) scope.order = options.order;

right after cloning the this._scope.

Sequelize version 5.8.6, MySQL 5.7.24.

[DanielOverdevest]

Fixing this with this PR #15230