overleaf/services/filestore/test/unit/setup.js

import { beforeEach, afterEach, chai, vi } from 'vitest'
import sinon from 'sinon'
import mongodb from 'mongodb'
import sinonChai from 'sinon-chai'
import chaiAsPromised from 'chai-as-promised'

// Workaround: vitest's built-in chai plugins register spy-related properties
// (e.g. callCount) as getter-only via addChainableMethod. sinon-chai then tries
// to overwrite them via addMethod (plain property assignment), which fails.
// Pre-delete the conflicting getter-only properties so the assignment succeeds.
const sinonChaiMethodProps = [
  'callCount',
  'calledBefore',
  'calledAfter',
  'calledImmediatelyBefore',
  'calledImmediatelyAfter',
  'calledOn',
  'calledWith',
  'calledOnceWith',
  'calledWithExactly',
  'calledOnceWithExactly',
  'calledWithMatch',
  'returned',
  'thrown',
]
for (const name of sinonChaiMethodProps) {
  if (Object.getOwnPropertyDescriptor(chai.Assertion.prototype, name)?.get) {
    delete chai.Assertion.prototype[name]
  }
}
chai.use(sinonChai)

chai.use(chaiAsPromised)

// ensure every ObjectId has the id string as a property for correct comparisons
mongodb.ObjectId.cacheHexString = true

const sandbox = sinon.createSandbox()
const stubs = {
  logger: {
    debug: sandbox.stub(),
    log: sandbox.stub(),
    info: sandbox.stub(),
    warn: sandbox.stub(),
    err: sandbox.stub(),
    error: sandbox.stub(),
    fatal: sandbox.stub(),
  },
}

beforeEach(ctx => {
  ctx.logger = stubs.logger
  vi.doMock('@overleaf/logger', () => ({
    default: ctx.logger,
  }))
})

afterEach(() => {
  sandbox.reset()
  vi.restoreAllMocks()
  vi.resetModules()
})