ts-patch-mongoose/tests/plugin-omit-all.test.ts

Patch history & events for mongoose models

import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest'

import mongoose, { model, Types } from 'mongoose'
import em from '../src/em'
import { patchHistoryPlugin } from '../src/index'
import { HistoryModel } from '../src/model'
import { isMongooseLessThan7 } from '../src/version'
import server from './mongo/server'
import { type User, UserSchema } from './schemas/User'

vi.mock('../src/em', () => ({ default: { emit: vi.fn() } }))

describe('plugin - omit all', () => {
  const instance = server('plugin-omit-all')

  UserSchema.plugin(patchHistoryPlugin, {
    omit: ['__v', 'name', 'role', 'createdAt', 'updatedAt'],
  })

  const UserModel = model<User>('User', UserSchema)

  beforeAll(async () => {
    await instance.create()
  })

  afterAll(async () => {
    await instance.destroy()
  })

  beforeEach(async () => {
    await mongoose.connection.collection('users').deleteMany({})
    await mongoose.connection.collection('history').deleteMany({})
  })

  afterEach(async () => {
    vi.resetAllMocks()
  })

  it('should createHistory', async () => {
    const user = await UserModel.create({ name: 'John', role: 'user' })
    expect(user.name).toBe('John')

    user.name = 'Alice'
    await user.save()

    user.name = 'Bob'
    await user.save()

    await UserModel.deleteMany({ role: 'user' }).exec()

    const history = await HistoryModel.find({})
    expect(history).toHaveLength(2)

    const [first, second] = history

    expect(first.op).toBe('create')
    expect(first.modelName).toBe('User')
    expect(first.collectionName).toBe('users')
    expect(first.collectionId).toEqual(user._id)
    expect(first.version).toBe(0)
    expect(first.patch).toHaveLength(0)

    expect(first.doc).not.toHaveProperty('name')
    expect(first.doc).not.toHaveProperty('role')
    expect(first.doc).not.toHaveProperty('createdAt')
    expect(first.doc).not.toHaveProperty('updatedAt')
    expect(first.doc).toHaveProperty('_id', user._id)

    expect(second.op).toBe('deleteMany')
    expect(second.modelName).toBe('User')
    expect(second.collectionName).toBe('users')
    expect(second.collectionId).toEqual(user._id)
    expect(second.version).toBe(0)
    expect(second.patch).toHaveLength(0)

    expect(second.doc).not.toHaveProperty('name')
    expect(second.doc).not.toHaveProperty('role')
    expect(second.doc).not.toHaveProperty('createdAt')
    expect(second.doc).not.toHaveProperty('updatedAt')
    expect(second.doc).toHaveProperty('_id', user._id)

    expect(em.emit).toHaveBeenCalledTimes(0)
  })

  it('should omit update of role', async () => {
    const user = await UserModel.create({ name: 'John', role: 'user' })
    expect(user.name).toBe('John')

    user.role = 'manager'
    await user.save()

    const history = await HistoryModel.find({})
    expect(history).toHaveLength(1)

    const [first] = history

    expect(first.op).toBe('create')
    expect(first.modelName).toBe('User')
    expect(first.collectionName).toBe('users')
    expect(first.collectionId).toEqual(user._id)
    expect(first.version).toBe(0)
    expect(first.patch).toHaveLength(0)

    expect(first.doc).not.toHaveProperty('name')
    expect(first.doc).not.toHaveProperty('role')
    expect(first.doc).not.toHaveProperty('createdAt')
    expect(first.doc).not.toHaveProperty('updatedAt')
    expect(first.doc).toHaveProperty('_id', user._id)

    expect(em.emit).toHaveBeenCalledTimes(0)
  })

  it('should updateOne', async () => {
    const user = await UserModel.create({ name: 'John', role: 'user' })
    expect(user.name).toBe('John')

    await UserModel.updateOne({ _id: user._id }, { name: 'Alice' }).exec()

    const history = await HistoryModel.find({})
    expect(history).toHaveLength(1)

    const [first] = history

    expect(first.op).toBe('create')
    expect(first.modelName).toBe('User')
    expect(first.collectionName).toBe('users')
    expect(first.collectionId).toEqual(user._id)
    expect(first.version).toBe(0)
    expect(first.patch).toHaveLength(0)

    expect(first.doc).not.toHaveProperty('name')
    expect(first.doc).not.toHaveProperty('role')
    expect(first.doc).not.toHaveProperty('createdAt')
    expect(first.doc).not.toHaveProperty('updatedAt')
    expect(first.doc).toHaveProperty('_id', user._id)

    expect(em.emit).toHaveBeenCalledTimes(0)
  })

  it('should findOneAndUpdate', async () => {
    const user = await UserModel.create({ name: 'John', role: 'user' })
    expect(user.name).toBe('John')

    await UserModel.findOneAndUpdate({ _id: user._id }, { name: 'Alice' }).exec()

    const history = await HistoryModel.find({})
    expect(history).toHaveLength(1)

    const [first] = history

    expect(first.op).toBe('create')
    expect(first.modelName).toBe('User')
    expect(first.collectionName).toBe('users')
    expect(first.collectionId).toEqual(user._id)
    expect(first.version).toBe(0)
    expect(first.patch).toHaveLength(0)

    expect(first.doc).not.toHaveProperty('name')
    expect(first.doc).not.toHaveProperty('role')
    expect(first.doc).not.toHaveProperty('createdAt')
    expect(first.doc).not.toHaveProperty('updatedAt')
    expect(first.doc).toHaveProperty('_id', user._id)

    expect(em.emit).toHaveBeenCalledTimes(0)
  })

  it('should update deprecated', async () => {
    const user = await UserModel.create({ name: 'John', role: 'user' })
    expect(user.name).toBe('John')

    if (isMongooseLessThan7) {
      // @ts-expect-error not available in Mongoose 6 and below
      await UserModel.update({ _id: user._id }, { $set: { name: 'Alice' } }).exec()
    } else {
      await UserModel.findOneAndUpdate({ _id: user._id }, { $set: { name: 'Alice' } }).exec()
    }

    const history = await HistoryModel.find({})
    expect(history).toHaveLength(1)

    const [first] = history

    expect(first.op).toBe('create')
    expect(first.modelName).toBe('User')
    expect(first.collectionName).toBe('users')
    expect(first.collectionId).toEqual(user._id)
    expect(first.version).toBe(0)
    expect(first.patch).toHaveLength(0)

    expect(first.doc).not.toHaveProperty('name')
    expect(first.doc).not.toHaveProperty('role')
    expect(first.doc).not.toHaveProperty('createdAt')
    expect(first.doc).not.toHaveProperty('updatedAt')
    expect(first.doc).toHaveProperty('_id', user._id)

    expect(em.emit).toHaveBeenCalledTimes(0)
  })

  it('should updated deprecated with multi flag', async () => {
    const john = await UserModel.create({ name: 'John', role: 'user' })
    expect(john.name).toBe('John')
    const alice = await UserModel.create({ name: 'Alice', role: 'user' })
    expect(alice.name).toBe('Alice')

    if (isMongooseLessThan7) {
      // @ts-expect-error not available in Mongoose 6 and below
      await UserModel.update({ role: 'user' }, { $set: { name: 'Bob' } }, { multi: true }).exec()
    } else {
      await UserModel.updateMany({ role: 'user' }, { $set: { name: 'Bob' } }).exec()
    }

    const history = await HistoryModel.find({})
    expect(history).toHaveLength(2)

    const [first, second] = history

    expect(first.op).toBe('create')
    expect(first.modelName).toBe('User')
    expect(first.collectionName).toBe('users')
    expect(first.collectionId).toEqual(john._id)
    expect(first.version).toBe(0)
    expect(first.patch).toHaveLength(0)

    expect(first.doc).not.toHaveProperty('name')
    expect(first.doc).not.toHaveProperty('role')
    expect(first.doc).not.toHaveProperty('createdAt')
    expect(first.doc).not.toHaveProperty('updatedAt')
    expect(first.doc).toHaveProperty('_id', john._id)

    expect(second.op).toBe('create')
    expect(second.modelName).toBe('User')
    expect(second.collectionName).toBe('users')
    expect(second.collectionId).toEqual(alice._id)
    expect(second.version).toBe(0)
    expect(second.patch).toHaveLength(0)

    expect(second.doc).not.toHaveProperty('name')
    expect(second.doc).not.toHaveProperty('role')
    expect(second.doc).not.toHaveProperty('createdAt')
    expect(second.doc).not.toHaveProperty('updatedAt')
    expect(second.doc).toHaveProperty('_id', alice._id)

    expect(em.emit).toHaveBeenCalledTimes(0)
  })

  it('should create many', async () => {
    await UserModel.create({ name: 'John', role: 'user' })
    await UserModel.create({ name: 'Alice', role: 'user' })

    const history = await HistoryModel.find({})
    expect(history).toHaveLength(2)

    const [first, second] = history

    expect(first.op).toBe('create')
    expect(first.modelName).toBe('User')
    expect(first.collectionName).toBe('users')
    expect(first.collectionId).toBeInstanceOf(Types.ObjectId)
    expect(first.version).toBe(0)
    expect(first.patch).toHaveLength(0)

    expect(first.doc).not.toHaveProperty('name')
    expect(first.doc).not.toHaveProperty('role')
    expect(first.doc).not.toHaveProperty('createdAt')
    expect(first.doc).not.toHaveProperty('updatedAt')
    expect(first.doc).toHaveProperty('_id')

    expect(second.op).toBe('create')
    expect(second.modelName).toBe('User')
    expect(second.collectionName).toBe('users')
    expect(second.collectionId).toBeInstanceOf(Types.ObjectId)
    expect(second.version).toBe(0)
    expect(second.patch).toHaveLength(0)

    expect(second.doc).not.toHaveProperty('name')
    expect(second.doc).not.toHaveProperty('role')
    expect(second.doc).not.toHaveProperty('createdAt')
    expect(second.doc).not.toHaveProperty('updatedAt')
    expect(second.doc).toHaveProperty('_id')

    expect(em.emit).toHaveBeenCalledTimes(0)
  })

  it('should findOneAndUpdate upsert', async () => {
    await UserModel.findOneAndUpdate({ name: 'John', role: 'user' }, { name: 'Bob', role: 'user' }, { upsert: true, runValidators: true }).exec()
    const documents = await UserModel.find({})
    expect(documents).toHaveLength(1)

    const history = await HistoryModel.find({})
    expect(history).toHaveLength(1)

    const [first] = history

    expect(first.op).toBe('findOneAndUpdate')
    expect(first.modelName).toBe('User')
    expect(first.collectionName).toBe('users')
    expect(first.collectionId).toBeInstanceOf(Types.ObjectId)
    expect(first.version).toBe(0)
    expect(first.patch).toHaveLength(0)

    expect(first.doc).not.toHaveProperty('name')
    expect(first.doc).not.toHaveProperty('role')
    expect(first.doc).toHaveProperty('_id')

    expect(em.emit).toHaveBeenCalledTimes(0)
  })

  it('should update many', async () => {
    const john = await UserModel.create({ name: 'John', role: 'user' })
    expect(john.name).toBe('John')
    const alice = await UserModel.create({ name: 'Alice', role: 'user' })
    expect(alice.name).toBe('Alice')

    await UserModel.updateMany({ role: 'user' }, { $set: { name: 'Bob' } }).exec()

    const history = await HistoryModel.find({})
    expect(history).toHaveLength(2)

    const [first, second] = history

    expect(first.op).toBe('create')
    expect(first.modelName).toBe('User')
    expect(first.collectionName).toBe('users')
    expect(first.collectionId).toEqual(john._id)
    expect(first.version).toBe(0)
    expect(first.patch).toHaveLength(0)

    expect(first.doc).not.toHaveProperty('name')
    expect(first.doc).not.toHaveProperty('role')
    expect(first.doc).not.toHaveProperty('createdAt')
    expect(first.doc).not.toHaveProperty('updatedAt')
    expect(first.doc).toHaveProperty('_id', john._id)

    expect(second.op).toBe('create')
    expect(second.modelName).toBe('User')
    expect(second.collectionName).toBe('users')
    expect(second.collectionId).toEqual(alice._id)
    expect(second.version).toBe(0)
    expect(second.patch).toHaveLength(0)

    expect(second.doc).not.toHaveProperty('name')
    expect(second.doc).not.toHaveProperty('role')
    expect(second.doc).not.toHaveProperty('createdAt')
    expect(second.doc).not.toHaveProperty('updatedAt')
    expect(second.doc).toHaveProperty('_id', alice._id)

    expect(em.emit).toHaveBeenCalledTimes(0)
  })
})