Sequelize/packages/core/test/integration/model/findAll/groupedLimit.test.js

'use strict';

const groupBy = require('lodash/groupBy');
const invokeMap = require('lodash/invokeMap');
const property = require('lodash/property');

const chai = require('chai');
const sinon = require('sinon');

const expect = chai.expect;
const Support = require('../../support');

const { DataTypes, Sequelize } = require('@sequelize/core');

const current = Support.sequelize;

if (current.dialect.supports['UNION ALL']) {
  describe(Support.getTestDialectTeaser('Model'), () => {
    describe('findAll', () => {
      describe('groupedLimit', () => {
        before(function () {
          this.clock = sinon.useFakeTimers();
        });

        afterEach(function () {
          this.clock.reset();
        });

        after(function () {
          this.clock.restore();
        });

        beforeEach(async function () {
          this.User = this.sequelize.define('user', {
            age: DataTypes.INTEGER,
          });
          this.Project = this.sequelize.define('project', {
            title: DataTypes.STRING,
          });
          this.Task = this.sequelize.define('task');

          this.ProjectUserParanoid = this.sequelize.define(
            'project_user_paranoid',
            {},
            {
              timestamps: true,
              paranoid: true,
              createdAt: false,
              updatedAt: false,
            },
          );

          this.User.Projects = this.User.belongsToMany(this.Project, {
            through: 'project_user',
            inverse: { as: 'members' },
          });

          this.User.ParanoidProjects = this.User.belongsToMany(this.Project, {
            as: 'paranoidProjects',
            through: this.ProjectUserParanoid,
            inverse: { as: 'paranoidMembers' },
          });

          this.User.Tasks = this.User.hasMany(this.Task);

          await this.sequelize.sync({ force: true });

          await Promise.all([
            this.User.bulkCreate([
              { age: -5 },
              { age: 45 },
              { age: 7 },
              { age: -9 },
              { age: 8 },
              { age: 15 },
              { age: -9 },
            ]),
            this.Project.bulkCreate([{}, {}]),
            this.Task.bulkCreate([{}, {}]),
          ]);

          const [users, projects, tasks] = await Promise.all([
            this.User.findAll(),
            this.Project.findAll(),
            this.Task.findAll(),
          ]);
          this.projects = projects;

          await Promise.all([
            projects[0].setMembers(users.slice(0, 4)),
            projects[1].setMembers(users.slice(2)),
            projects[0].setParanoidMembers(users.slice(0, 4)),
            projects[1].setParanoidMembers(users.slice(2)),
            users[2].setTasks(tasks),
          ]);
        });

        describe('on: belongsToMany', () => {
          it('maps attributes from a grouped limit to models', async function () {
            const users = await this.User.findAll({
              groupedLimit: {
                limit: 3,
                on: this.User.Projects,
                values: this.projects.map(item => item.get('id')),
              },
            });

            expect(users).to.have.length(5);
            for (const u of users.filter(u => u.get('id') !== 3)) {
              expect(u.get('project_user')).to.have.length(1);
            }

            for (const u of users.filter(u => u.get('id') === 3)) {
              expect(u.get('project_user')).to.have.length(2);
            }
          });

          it('maps attributes from a grouped limit to models with include', async function () {
            const users = await this.User.findAll({
              groupedLimit: {
                limit: 3,
                on: this.User.Projects,
                values: this.projects.map(item => item.get('id')),
              },
              order: ['id'],
              include: [this.User.Tasks],
            });

            /*
             project1 - 1, 2, 3
             project2 - 3, 4, 5
             */
            expect(users).to.have.length(5);
            expect(users.map(u => u.get('id'))).to.deep.equal([1, 2, 3, 4, 5]);

            expect(users[2].get('tasks')).to.have.length(2);
            for (const u of users.filter(u => u.get('id') !== 3)) {
              expect(u.get('project_user')).to.have.length(1);
            }

            for (const u of users.filter(u => u.get('id') === 3)) {
              expect(u.get('project_user')).to.have.length(2);
            }
          });

          it('works with computed orders', async function () {
            const users = await this.User.findAll({
              attributes: ['id'],
              groupedLimit: {
                limit: 3,
                on: this.User.Projects,
                values: this.projects.map(item => item.get('id')),
              },
              order: [
                Sequelize.fn('ABS', Sequelize.col('age')),
                // Two users have the same abs(age), so we need to make sure that the order is deterministic
                ['id', 'DESC'],
              ],
              include: [this.User.Tasks],
            });

            /*
              project1 - 1, 3, 4
              project2 - 3, 5, 7
             */
            expect(users).to.have.length(5);
            expect(users.map(u => u.get('id'))).to.deep.equal([1, 3, 5, 7, 4]);
          });

          it('works with paranoid junction models', async function () {
            const users0 = await this.User.findAll({
              attributes: ['id'],
              groupedLimit: {
                limit: 3,
                on: this.User.ParanoidProjects,
                values: this.projects.map(item => item.get('id')),
              },
              order: [Sequelize.fn('ABS', Sequelize.col('age')), ['id', 'DESC']],
              include: [this.User.Tasks],
            });

            /*
              project1 - 1, 3, 4
              project2 - 3, 5, 7
             */
            expect(users0).to.have.length(5);
            expect(users0.map(u => u.get('id'))).to.deep.equal([1, 3, 5, 7, 4]);

            await Promise.all([
              this.projects[0].setParanoidMembers(users0.slice(0, 2)),
              this.projects[1].setParanoidMembers(users0.slice(4)),
            ]);

            const users = await this.User.findAll({
              attributes: ['id'],
              groupedLimit: {
                limit: 3,
                on: this.User.ParanoidProjects,
                values: this.projects.map(item => item.get('id')),
              },
              order: [Sequelize.fn('ABS', Sequelize.col('age')), ['id', 'DESC']],
              include: [this.User.Tasks],
            });

            /*
              project1 - 1, 3
              project2 - 4
             */
            expect(users).to.have.length(3);
            expect(users.map(u => u.get('id'))).to.deep.equal([1, 3, 4]);
          });
        });

        describe('on: hasMany', () => {
          beforeEach(async function () {
            this.User = this.sequelize.define('user');
            this.Task = this.sequelize.define('task');
            this.User.Tasks = this.User.hasMany(this.Task);

            await this.sequelize.sync({ force: true });

            await Promise.all([
              this.User.bulkCreate([{}, {}, {}]),
              this.Task.bulkCreate([
                { id: 1 },
                { id: 2 },
                { id: 3 },
                { id: 4 },
                { id: 5 },
                { id: 6 },
              ]),
            ]);

            const [users, tasks] = await Promise.all([this.User.findAll(), this.Task.findAll()]);
            this.users = users;

            await Promise.all([
              users[0].setTasks(tasks[0]),
              users[1].setTasks(tasks.slice(1, 4)),
              users[2].setTasks(tasks.slice(4)),
            ]);
          });

          it('Applies limit and order correctly', async function () {
            const tasks = await this.Task.findAll({
              order: [['id', 'DESC']],
              groupedLimit: {
                limit: 3,
                on: this.User.Tasks,
                values: this.users.map(item => item.get('id')),
              },
            });

            const byUser = groupBy(tasks, property('userId'));
            expect(Object.keys(byUser)).to.have.length(3);

            expect(byUser[1]).to.have.length(1);
            expect(byUser[2]).to.have.length(3);
            expect(invokeMap(byUser[2], 'get', 'id')).to.deep.equal([4, 3, 2]);
            expect(byUser[3]).to.have.length(2);
          });
        });
      });
    });
  });
}