Overleaf/services/web/test/unit/src/Subscription/FeaturesHelperTests.js

const SandboxedModule = require('sandboxed-module')
const { expect } = require('chai')

const MODULE_PATH = '../../../../app/src/Features/Subscription/FeaturesHelper'

describe('FeaturesHelper', function () {
  beforeEach(function () {
    this.FeaturesHelper = SandboxedModule.require(MODULE_PATH)
  })

  describe('mergeFeatures', function () {
    it('should prefer priority over standard for compileGroup', function () {
      expect(
        this.FeaturesHelper.mergeFeatures(
          { compileGroup: 'priority' },
          { compileGroup: 'standard' }
        )
      ).to.deep.equal({ compileGroup: 'priority' })
      expect(
        this.FeaturesHelper.mergeFeatures(
          { compileGroup: 'standard' },
          { compileGroup: 'priority' }
        )
      ).to.deep.equal({ compileGroup: 'priority' })
      expect(
        this.FeaturesHelper.mergeFeatures(
          { compileGroup: 'priority' },
          { compileGroup: 'priority' }
        )
      ).to.deep.equal({ compileGroup: 'priority' })
      expect(
        this.FeaturesHelper.mergeFeatures(
          { compileGroup: 'standard' },
          { compileGroup: 'standard' }
        )
      ).to.deep.equal({ compileGroup: 'standard' })
    })

    it('should prefer -1 over any other for collaborators', function () {
      expect(
        this.FeaturesHelper.mergeFeatures(
          { collaborators: -1 },
          { collaborators: 10 }
        )
      ).to.deep.equal({ collaborators: -1 })
      expect(
        this.FeaturesHelper.mergeFeatures(
          { collaborators: 10 },
          { collaborators: -1 }
        )
      ).to.deep.equal({ collaborators: -1 })
      expect(
        this.FeaturesHelper.mergeFeatures(
          { collaborators: 4 },
          { collaborators: 10 }
        )
      ).to.deep.equal({ collaborators: 10 })
    })

    it('should prefer the higher of compileTimeout', function () {
      expect(
        this.FeaturesHelper.mergeFeatures(
          { compileTimeout: 20 },
          { compileTimeout: 10 }
        )
      ).to.deep.equal({ compileTimeout: 20 })
      expect(
        this.FeaturesHelper.mergeFeatures(
          { compileTimeout: 10 },
          { compileTimeout: 20 }
        )
      ).to.deep.equal({ compileTimeout: 20 })
    })

    it('should prefer the true over false for other keys', function () {
      expect(
        this.FeaturesHelper.mergeFeatures({ github: true }, { github: false })
      ).to.deep.equal({ github: true })
      expect(
        this.FeaturesHelper.mergeFeatures({ github: false }, { github: true })
      ).to.deep.equal({ github: true })
      expect(
        this.FeaturesHelper.mergeFeatures({ github: true }, { github: true })
      ).to.deep.equal({ github: true })
      expect(
        this.FeaturesHelper.mergeFeatures({ github: false }, { github: false })
      ).to.deep.equal({ github: false })
    })
  })

  describe('computeFeatureSet', function () {
    it('should handle only one featureSet', function () {
      expect(
        this.FeaturesHelper.computeFeatureSet([
          { github: true, feat1: true, feat2: false },
        ])
      ).to.deep.equal({ github: true, feat1: true, feat2: false })
    })
    it('should handle an empty array of featureSets', function () {
      expect(this.FeaturesHelper.computeFeatureSet([])).to.deep.equal({})
    })

    it('should handle 3+ featureSets', function () {
      const featureSets = [
        { github: true, feat1: false, feat2: false },
        { github: false, feat1: true, feat2: false, feat3: false },
        { github: false, feat1: false, feat2: true, feat4: true },
      ]
      expect(this.FeaturesHelper.computeFeatureSet(featureSets)).to.deep.equal({
        github: true,
        feat1: true,
        feat2: true,
        feat3: false,
        feat4: true,
      })
    })
  })

  describe('isFeatureSetBetter', function () {
    it('simple comparisons', function () {
      const result1 = this.FeaturesHelper.isFeatureSetBetter(
        { dropbox: true },
        { dropbox: false }
      )
      expect(result1).to.be.true

      const result2 = this.FeaturesHelper.isFeatureSetBetter(
        { dropbox: false },
        { dropbox: true }
      )
      expect(result2).to.be.false
    })

    it('compound comparisons with same features', function () {
      const result1 = this.FeaturesHelper.isFeatureSetBetter(
        { collaborators: 9, dropbox: true },
        { collaborators: 10, dropbox: true }
      )
      expect(result1).to.be.false

      const result2 = this.FeaturesHelper.isFeatureSetBetter(
        { collaborators: -1, dropbox: true },
        { collaborators: 10, dropbox: true }
      )
      expect(result2).to.be.true

      const result3 = this.FeaturesHelper.isFeatureSetBetter(
        { collaborators: -1, compileTimeout: 60, dropbox: true },
        { collaborators: 10, compileTimeout: 60, dropbox: true }
      )
      expect(result3).to.be.true
    })
  })
})