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

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

const createModel = require('./setup/createModel')
const modes       = require('./setup/modes')

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

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

    beforeEach(async () => {
      Document1 = await Model.create({})
      Document2 = await Model.create({})
    })

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

    it('Should exclude soft deleted documents by default', async () => {
      await Document1.deleteOne()
      const documents = await Model.find({})
      expect(documents.length).toBe(1)
      expect(documents[0]._id).toEqual(Document2._id)
    })

    it('Should include soft deleted documents when using the withDeleted option', async () => {
      await Document1.deleteOne()
      const documents = await Model.find({}, null, {withDeleted: true})
      expect(documents.length).toBe(2)
    })

    it('Should include soft deleted documents when chaining withDeleted(true)', async () => {
      await Document1.deleteOne()
      const documents = await Model.find({}).withDeleted(true)
      expect(documents.length).toBe(2)
    })
  })
})