mongoose-smart-delete/tests/distinct.test.js

A Mongoose plugin for implementing soft delete functionality, allowing documents to be marked as deleted without being removed from the database.

const mongoose        = require('mongoose')
const createModel     = require('./setup/createModel')
const modes           = require('./setup/modes')
const mongooseVersion = parseInt(mongoose.version.split('.')[0])

modes.forEach((mode) => {
  describe(`SoftDelete - distinct (mode: ${mode})`, () => {
    let Model

    beforeAll(async () => {
      Model = createModel({
        name: String
      }, {mode: mode})
    })

    beforeEach(async () => {
      await Model.create({name: 'A'})
      await Model.create({name: 'B'})
      await Model.create({name: 'C'})
      await Model.deleteOne({name: 'A'})
    })

    afterEach(async () => {
      await Model.deleteMany({}, {softDelete: false, withDeleted: true})
    })

    it('Should exclude soft deleted documents by default', async () => {
      expect(await Model.distinct('name')).toEqual(['B', 'C'])
    })

    // Skip this test for mongoose < 8, because distinct() does support options as a third argument
    if (mongooseVersion >= 8) {
      it('Should include soft deleted documents when using the withDeleted option', async () => {
        expect(await Model.distinct('name', {}, {withDeleted: true})).toEqual(['A', 'B', 'C'])
      })
    }

    it('Should include soft deleted documents when chaining withDeleted(true)', async () => {
      expect(await Model.distinct('name').withDeleted(true)).toEqual(['A', 'B', 'C'])
    })
  })
})