Overleaf/services/web/test/unit/src/Subscription/UserFeaturesUpdater.test.mjs

import { vi, expect } from 'vitest'
import sinon from 'sinon'
const modulePath =
  '../../../../app/src/Features/Subscription/UserFeaturesUpdater'

describe('UserFeaturesUpdater', function () {
  beforeEach(async function (ctx) {
    ctx.features = {
      collaborators: 6,
      dropbox: true,
      github: true,
      gitBridge: true,
      versioning: true,
      compileTimeout: 180,
      compileGroup: 'priority',
      references: true,
      templates: true,
      trackChanges: true,
      referencesSearch: true,
      zotero: true,
      mendeley: true,
      symbolPalette: true,
    }
    ctx.User = {
      findByIdAndUpdate: sinon.stub().returns({
        exec: sinon.stub().resolves({ features: ctx.features }),
      }),
    }

    vi.doMock('../../../../app/src/models/User', () => ({
      User: ctx.User,
    }))

    vi.doMock('@overleaf/settings', () => ({
      default: (ctx.Settings = {}),
    }))

    ctx.UserFeaturesUpdater = (await import(modulePath)).default
  })

  describe('updateFeatures', function () {
    it('should send the users features', async function (ctx) {
      const userId = '5208dd34438842e2db000005'
      const update = {
        versioning: true,
        collaborators: 10,
      }

      const { features } =
        await ctx.UserFeaturesUpdater.promises.updateFeatures(userId, update)

      const updateArgs = ctx.User.findByIdAndUpdate.lastCall.args
      expect(updateArgs[0]).to.deep.equal(userId)
      expect(Object.keys(updateArgs[1]).length).to.equal(3)
      expect(updateArgs[1]['features.versioning']).to.equal(update.versioning)
      expect(updateArgs[1]['features.collaborators']).to.equal(
        update.collaborators
      )
      expect(updateArgs[1].featuresUpdatedAt instanceof Date).to.be.true
      features.should.deep.equal(update)
      expect(updateArgs[1].featuresEpoch).to.be.undefined
    })

    it('should set the featuresEpoch when present', async function (ctx) {
      const userId = '5208dd34438842e2db000005'
      const update = {
        versioning: true,
      }
      ctx.Settings.featuresEpoch = 'epoch-1'
      const { features } =
        await ctx.UserFeaturesUpdater.promises.updateFeatures(userId, update)

      const updateArgs = ctx.User.findByIdAndUpdate.lastCall.args
      expect(updateArgs[0]).to.deep.equal(userId)
      expect(Object.keys(updateArgs[1]).length).to.equal(3)
      expect(updateArgs[1]['features.versioning']).to.equal(update.versioning)
      expect(updateArgs[1].featuresUpdatedAt instanceof Date).to.be.true
      features.should.deep.equal(update)
      expect(updateArgs[1].featuresEpoch).to.equal('epoch-1')
    })
  })

  describe('overrideFeatures', function () {
    it('should send the users features', async function (ctx) {
      const userId = '5208dd34438842e2db000005'
      const update = Object.assign({}, { mendeley: !ctx.features.mendeley })
      const featuresChanged =
        await ctx.UserFeaturesUpdater.promises.overrideFeatures(userId, update)

      const updateArgs = ctx.User.findByIdAndUpdate.lastCall.args
      expect(updateArgs[0]).to.equal(userId)
      expect(Object.keys(updateArgs[1]).length).to.equal(2)
      expect(updateArgs[1].features).to.deep.equal(update)
      expect(updateArgs[1].featuresUpdatedAt instanceof Date).to.be.true
      featuresChanged.should.equal(true)
    })
  })
})