Sequelize/packages/core/test/integration/hooks/destroy.test.js

'use strict';

const chai = require('chai');

const expect = chai.expect;
const Support = require('../support');
const { DataTypes } = require('@sequelize/core');
const sinon = require('sinon');

describe(Support.getTestDialectTeaser('Hooks'), () => {
  beforeEach(async function () {
    this.User = this.sequelize.define('User', {
      username: {
        type: DataTypes.STRING,
        allowNull: false,
      },
      mood: {
        type: DataTypes.ENUM(['happy', 'sad', 'neutral']),
      },
    });
    await this.sequelize.sync({ force: true });
  });

  describe('#destroy', () => {
    describe('on success', () => {
      it('should run hooks', async function () {
        const beforeHook = sinon.spy();
        const afterHook = sinon.spy();

        this.User.beforeDestroy(beforeHook);
        this.User.afterDestroy(afterHook);

        const user = await this.User.create({ username: 'Toni', mood: 'happy' });
        await user.destroy();
        expect(beforeHook).to.have.been.calledOnce;
        expect(afterHook).to.have.been.calledOnce;
      });
    });

    describe('on error', () => {
      it('should return an error from before', async function () {
        const beforeHook = sinon.spy();
        const afterHook = sinon.spy();

        this.User.beforeDestroy(() => {
          beforeHook();
          throw new Error('Whoops!');
        });
        this.User.afterDestroy(afterHook);

        const user = await this.User.create({ username: 'Toni', mood: 'happy' });
        await expect(user.destroy()).to.be.rejected;
        expect(beforeHook).to.have.been.calledOnce;
        expect(afterHook).not.to.have.been.called;
      });

      it('should return an error from after', async function () {
        const beforeHook = sinon.spy();
        const afterHook = sinon.spy();

        this.User.beforeDestroy(beforeHook);
        this.User.afterDestroy(() => {
          afterHook();
          throw new Error('Whoops!');
        });

        const user = await this.User.create({ username: 'Toni', mood: 'happy' });
        await expect(user.destroy()).to.be.rejected;
        expect(beforeHook).to.have.been.calledOnce;
        expect(afterHook).to.have.been.calledOnce;
      });
    });

    describe('with paranoid mode enabled', () => {
      beforeEach(function () {
        this.ParanoidUser = this.sequelize.define(
          'ParanoidUser',
          {
            username: DataTypes.STRING,
            updatedBy: DataTypes.INTEGER,
            virtualField: {
              type: DataTypes.VIRTUAL(DataTypes.INTEGER, ['updatedBy']),
              get() {
                return this.updatedBy - 1;
              },
            },
          },
          {
            paranoid: true,
            hooks: {
              beforeDestroy: instance => {
                instance.updatedBy = 1;
              },
            },
          },
        );
      });

      it('sets other changed values when soft deleting and a beforeDestroy hooks kicks in', async function () {
        await this.ParanoidUser.sync({ force: true });
        const user0 = await this.ParanoidUser.create({ username: 'user1' });
        await user0.destroy();
        const user = await this.ParanoidUser.findOne({ paranoid: false });
        expect(user.updatedBy).to.equal(1);
      });

      it('should not throw error when a beforeDestroy hook changes a virtual column', async function () {
        this.ParanoidUser.beforeDestroy(instance => {
          instance.virtualField = 2;
        });

        await this.ParanoidUser.sync({ force: true });
        const user0 = await this.ParanoidUser.create({ username: 'user1' });
        await user0.destroy();
        const user = await this.ParanoidUser.findOne({ paranoid: false });
        expect(user.virtualField).to.equal(0);
      });
    });
  });
});