overleaf/services/web/test/unit/src/Compile/CompileManagerTests.js

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

const MODULE_PATH = '../../../../app/src/Features/Compile/CompileManager.js'

describe('CompileManager', function () {
  beforeEach(function () {
    this.rateLimiter = {
      consume: sinon.stub().resolves(),
    }
    this.RateLimiter = {
      RateLimiter: sinon.stub().returns(this.rateLimiter),
    }
    this.timer = {
      done: sinon.stub(),
    }
    this.Metrics = {
      Timer: sinon.stub().returns(this.timer),
      inc: sinon.stub(),
    }
    this.CompileManager = SandboxedModule.require(MODULE_PATH, {
      requires: {
        '@overleaf/settings': (this.settings = {
          apis: { clsi: { defaultBackendClass: 'e2' } },
          redis: { web: { host: 'localhost', port: 42 } },
          rateLimit: { autoCompile: {} },
        }),
        '../../infrastructure/RedisWrapper': {
          client: () => (this.rclient = { auth() {} }),
        },
        '../Project/ProjectRootDocManager': (this.ProjectRootDocManager = {}),
        '../Project/ProjectGetter': (this.ProjectGetter = {}),
        '../User/UserGetter': (this.UserGetter = {}),
        './ClsiManager': (this.ClsiManager = {}),
        '../../infrastructure/RateLimiter': this.RateLimiter,
        '@overleaf/metrics': this.Metrics,
        '../SplitTests/SplitTestHandler': {
          getAssignmentForMongoUser: (this.getAssignmentForMongoUser = sinon
            .stub()
            .yields(null, {
              variant: 'default',
            })),
        },
      },
    })
    this.project_id = 'mock-project-id-123'
    this.user_id = 'mock-user-id-123'
    this.callback = sinon.stub()
    this.limits = {
      timeout: 42,
      compileGroup: 'standard',
    }
  })

  describe('compile', function () {
    beforeEach(function () {
      this.CompileManager._checkIfRecentlyCompiled = sinon
        .stub()
        .callsArgWith(2, null, false)
      this.ProjectRootDocManager.ensureRootDocumentIsSet = sinon
        .stub()
        .callsArgWith(1, null)
      this.CompileManager.getProjectCompileLimits = sinon
        .stub()
        .callsArgWith(1, null, this.limits)
      this.ClsiManager.sendRequest = sinon
        .stub()
        .callsArgWith(
          3,
          null,
          (this.status = 'mock-status'),
          (this.outputFiles = 'mock output files'),
          (this.output = 'mock output')
        )
    })

    describe('succesfully', function () {
      beforeEach(function () {
        this.CompileManager._checkIfAutoCompileLimitHasBeenHit = (
          isAutoCompile,
          compileGroup,
          cb
        ) => cb(null, true)
        this.CompileManager.compile(
          this.project_id,
          this.user_id,
          {},
          this.callback
        )
      })

      it('should check the project has not been recently compiled', function () {
        this.CompileManager._checkIfRecentlyCompiled
          .calledWith(this.project_id, this.user_id)
          .should.equal(true)
      })

      it('should ensure that the root document is set', function () {
        this.ProjectRootDocManager.ensureRootDocumentIsSet
          .calledWith(this.project_id)
          .should.equal(true)
      })

      it('should get the project compile limits', function () {
        this.CompileManager.getProjectCompileLimits
          .calledWith(this.project_id)
          .should.equal(true)
      })

      it('should run the compile with the compile limits', function () {
        this.ClsiManager.sendRequest
          .calledWith(this.project_id, this.user_id, {
            timeout: this.limits.timeout,
            compileGroup: 'standard',
          })
          .should.equal(true)
      })

      it('should call the callback with the output', function () {
        this.callback
          .calledWith(null, this.status, this.outputFiles, this.output)
          .should.equal(true)
      })

      it('should time the compile', function () {
        this.timer.done.called.should.equal(true)
      })
    })

    describe('when the project has been recently compiled', function () {
      it('should return', function (done) {
        this.CompileManager._checkIfAutoCompileLimitHasBeenHit = (
          isAutoCompile,
          compileGroup,
          cb
        ) => cb(null, true)
        this.CompileManager._checkIfRecentlyCompiled = sinon
          .stub()
          .callsArgWith(2, null, true)
        this.CompileManager.compile(
          this.project_id,
          this.user_id,
          {},
          (err, status) => {
            if (err) {
              return done(err)
            }
            status.should.equal('too-recently-compiled')
            done()
          }
        )
      })
    })

    describe('should check the rate limit', function () {
      it('should return', function (done) {
        this.CompileManager._checkIfAutoCompileLimitHasBeenHit = sinon
          .stub()
          .callsArgWith(2, null, false)
        this.CompileManager.compile(
          this.project_id,
          this.user_id,
          {},
          (err, status) => {
            if (err) {
              return done(err)
            }
            status.should.equal('autocompile-backoff')
            done()
          }
        )
      })
    })
  })

  describe('getProjectCompileLimits', function () {
    beforeEach(function () {
      this.features = {
        compileTimeout: (this.timeout = 42),
        compileGroup: (this.group = 'priority'),
      }
      this.ProjectGetter.getProject = sinon
        .stub()
        .callsArgWith(
          2,
          null,
          (this.project = { owner_ref: (this.owner_id = 'owner-id-123') })
        )
      this.UserGetter.getUser = sinon
        .stub()
        .callsArgWith(
          2,
          null,
          (this.user = { features: this.features, analyticsId: 'abc' })
        )
      this.CompileManager.getProjectCompileLimits(
        this.project_id,
        this.callback
      )
    })

    it('should look up the owner of the project', function () {
      this.ProjectGetter.getProject
        .calledWith(this.project_id, { owner_ref: 1 })
        .should.equal(true)
    })

    it("should look up the owner's features", function () {
      this.UserGetter.getUser
        .calledWith(this.project.owner_ref, {
          _id: 1,
          alphaProgram: 1,
          analyticsId: 1,
          betaProgram: 1,
          features: 1,
          splitTests: 1,
          signUpDate: 1,
        })
        .should.equal(true)
    })

    it('should return the limits', function () {
      this.callback
        .calledWith(null, {
          timeout: this.timeout,
          compileGroup: this.group,
          compileBackendClass: 'e2',
          ownerAnalyticsId: 'abc',
          showFasterCompilesFeedbackUI: false,
        })
        .should.equal(true)
    })
  })

  describe('getProjectCompileLimits with reduced compile timeout', function () {
    beforeEach(function () {
      this.getAssignmentForMongoUser.callsFake((user, test, cb) => {
        if (test === 'compile-backend-class-n2d') {
          cb(null, { variant: 'n2d' })
        }
        if (test === 'compile-timeout-20s') {
          cb(null, { variant: '20s' })
        }
      })
      this.features = {
        compileTimeout: (this.timeout = 60),
        compileGroup: (this.group = 'standard'),
      }
      this.ProjectGetter.getProject = sinon
        .stub()
        .callsArgWith(
          2,
          null,
          (this.project = { owner_ref: (this.owner_id = 'owner-id-123') })
        )
      this.UserGetter.getUser = sinon
        .stub()
        .callsArgWith(
          2,
          null,
          (this.user = { features: this.features, analyticsId: 'abc' })
        )
      this.CompileManager.getProjectCompileLimits(
        this.project_id,
        this.callback
      )
    })

    describe('user is in the n2d group and compile-timeout-20s split test variant', function () {
      describe('user has a timeout of more than 60s', function () {
        beforeEach(function () {
          this.features.compileTimeout = 120
        })
        it('should keep the users compile timeout', function () {
          this.CompileManager.getProjectCompileLimits(
            this.project_id,
            this.callback
          )
          this.callback
            .calledWith(null, sinon.match({ timeout: 120 }))
            .should.equal(true)
        })
      })
      describe('user registered before the cut off date', function () {
        beforeEach(function () {
          this.features.compileTimeout = 60
          const signUpDate = new Date(
            this.CompileManager.NEW_COMPILE_TIMEOUT_ENFORCED_CUTOFF
          )
          signUpDate.setDate(signUpDate.getDate() - 1)
          this.user.signUpDate = signUpDate
        })
        it('should keep the users compile timeout', function () {
          this.CompileManager.getProjectCompileLimits(
            this.project_id,
            this.callback
          )
          this.callback
            .calledWith(null, sinon.match({ timeout: 60 }))
            .should.equal(true)
        })
      })
      describe('user registered after the cut off date', function () {
        beforeEach(function () {
          this.timeout = 60
          const signUpDate = new Date(
            this.CompileManager.NEW_COMPILE_TIMEOUT_ENFORCED_CUTOFF
          )
          signUpDate.setDate(signUpDate.getDate() + 1)
          this.user.signUpDate = signUpDate
        })
        it('should reduce compile timeout to 20s', function () {
          this.CompileManager.getProjectCompileLimits(
            this.project_id,
            this.callback
          )
          this.callback
            .calledWith(null, sinon.match({ timeout: 20 }))
            .should.equal(true)
        })
      })
    })
  })

  describe('compileBackendClass', function () {
    beforeEach(function () {
      this.features = {
        compileTimeout: 42,
        compileGroup: 'standard',
      }
      this.ProjectGetter.getProject = sinon
        .stub()
        .yields(null, { owner_ref: 'owner-id-123' })
      this.UserGetter.getUser = sinon
        .stub()
        .yields(null, { features: this.features, analyticsId: 'abc' })
    })

    describe('with standard compile', function () {
      beforeEach(function () {
        this.features.compileGroup = 'standard'
      })

      describe('default', function () {
        beforeEach(function () {
          this.getAssignmentForMongoUser.yields(null, {
            variant: 'default',
          })
        })
        it('should return the e2 class and disable the ui', function (done) {
          this.CompileManager.getProjectCompileLimits(
            this.project_id,
            (err, { compileBackendClass, showFasterCompilesFeedbackUI }) => {
              if (err) return done(err)
              expect(compileBackendClass).to.equal('e2')
              expect(showFasterCompilesFeedbackUI).to.equal(false)
              done()
            }
          )
        })
      })

      describe('n2d variant', function () {
        beforeEach(function () {
          this.getAssignmentForMongoUser.yields(null, {
            variant: 'n2d',
          })
        })
        it('should return the n2d class and disable the ui', function (done) {
          this.CompileManager.getProjectCompileLimits(
            this.project_id,
            (err, { compileBackendClass, showFasterCompilesFeedbackUI }) => {
              if (err) return done(err)
              expect(compileBackendClass).to.equal('n2d')
              expect(showFasterCompilesFeedbackUI).to.equal(false)
              done()
            }
          )
        })
      })
    })

    describe('with priority compile', function () {
      beforeEach(function () {
        this.features.compileGroup = 'priority'
      })
      describe('split test not active', function () {
        beforeEach(function () {
          this.getAssignmentForMongoUser.yields(null, {
            analytics: { segmentation: {} },
            variant: 'default',
          })
        })

        it('should return the default class and disable ui', function (done) {
          this.CompileManager.getProjectCompileLimits(
            this.project_id,
            (err, { compileBackendClass, showFasterCompilesFeedbackUI }) => {
              if (err) return done(err)
              expect(compileBackendClass).to.equal('e2')
              expect(showFasterCompilesFeedbackUI).to.equal(false)
              done()
            }
          )
        })
      })

      describe('split test active', function () {
        describe('default variant', function () {
          beforeEach(function () {
            this.getAssignmentForMongoUser.yields(null, {
              analytics: { segmentation: { splitTest: 'foo' } },
              variant: 'default',
            })
          })
          it('should return the default class and enable ui', function (done) {
            this.CompileManager.getProjectCompileLimits(
              this.project_id,
              (err, { compileBackendClass, showFasterCompilesFeedbackUI }) => {
                if (err) return done(err)
                expect(compileBackendClass).to.equal('e2')
                expect(showFasterCompilesFeedbackUI).to.equal(true)
                done()
              }
            )
          })
        })

        describe('c2d variant', function () {
          beforeEach(function () {
            this.getAssignmentForMongoUser.yields(null, {
              analytics: { segmentation: { splitTest: 'foo' } },
              variant: 'c2d',
            })
          })
          it('should return the c2d class and enable ui', function (done) {
            this.CompileManager.getProjectCompileLimits(
              this.project_id,
              (err, { compileBackendClass, showFasterCompilesFeedbackUI }) => {
                if (err) return done(err)
                expect(compileBackendClass).to.equal('c2d')
                expect(showFasterCompilesFeedbackUI).to.equal(true)
                done()
              }
            )
          })
        })
      })
    })
  })

  describe('deleteAuxFiles', function () {
    beforeEach(function () {
      this.CompileManager.getProjectCompileLimits = sinon
        .stub()
        .callsArgWith(
          1,
          null,
          (this.limits = { compileGroup: 'mock-compile-group' })
        )
      this.ClsiManager.deleteAuxFiles = sinon.stub().callsArg(3)
      this.CompileManager.deleteAuxFiles(
        this.project_id,
        this.user_id,
        this.callback
      )
    })

    it('should look up the compile group to use', function () {
      this.CompileManager.getProjectCompileLimits
        .calledWith(this.project_id)
        .should.equal(true)
    })

    it('should delete the aux files', function () {
      this.ClsiManager.deleteAuxFiles
        .calledWith(this.project_id, this.user_id, this.limits)
        .should.equal(true)
    })

    it('should call the callback', function () {
      this.callback.called.should.equal(true)
    })
  })

  describe('_checkIfRecentlyCompiled', function () {
    describe('when the key exists in redis', function () {
      beforeEach(function () {
        this.rclient.set = sinon.stub().callsArgWith(5, null, null)
        this.CompileManager._checkIfRecentlyCompiled(
          this.project_id,
          this.user_id,
          this.callback
        )
      })

      it('should try to set the key', function () {
        this.rclient.set
          .calledWith(
            `compile:${this.project_id}:${this.user_id}`,
            true,
            'EX',
            this.CompileManager.COMPILE_DELAY,
            'NX'
          )
          .should.equal(true)
      })

      it('should call the callback with true', function () {
        this.callback.calledWith(null, true).should.equal(true)
      })
    })

    describe('when the key does not exist in redis', function () {
      beforeEach(function () {
        this.rclient.set = sinon.stub().callsArgWith(5, null, 'OK')
        this.CompileManager._checkIfRecentlyCompiled(
          this.project_id,
          this.user_id,
          this.callback
        )
      })

      it('should try to set the key', function () {
        this.rclient.set
          .calledWith(
            `compile:${this.project_id}:${this.user_id}`,
            true,
            'EX',
            this.CompileManager.COMPILE_DELAY,
            'NX'
          )
          .should.equal(true)
      })

      it('should call the callback with false', function () {
        this.callback.calledWith(null, false).should.equal(true)
      })
    })
  })

  describe('_checkIfAutoCompileLimitHasBeenHit', function () {
    it('should be able to compile if it is not an autocompile', function (done) {
      this.CompileManager._checkIfAutoCompileLimitHasBeenHit(
        false,
        'everyone',
        (err, canCompile) => {
          if (err) {
            return done(err)
          }
          canCompile.should.equal(true)
          done()
        }
      )
    })

    it('should be able to compile if rate limit has remaining', function (done) {
      this.CompileManager._checkIfAutoCompileLimitHasBeenHit(
        true,
        'everyone',
        (err, canCompile) => {
          if (err) {
            return done(err)
          }
          expect(this.rateLimiter.consume).to.have.been.calledWith('global')
          canCompile.should.equal(true)
          done()
        }
      )
    })

    it('should be not able to compile if rate limit has no remianing', function (done) {
      this.rateLimiter.consume.rejects({ remainingPoints: 0 })
      this.CompileManager._checkIfAutoCompileLimitHasBeenHit(
        true,
        'everyone',
        (err, canCompile) => {
          if (err) {
            return done(err)
          }
          canCompile.should.equal(false)
          done()
        }
      )
    })

    it('should return false if there is an error in the rate limit', function (done) {
      this.rateLimiter.consume.rejects(new Error('BOOM!'))
      this.CompileManager._checkIfAutoCompileLimitHasBeenHit(
        true,
        'everyone',
        (err, canCompile) => {
          if (err) {
            return done(err)
          }
          canCompile.should.equal(false)
          done()
        }
      )
    })
  })

  describe('wordCount', function () {
    beforeEach(function () {
      this.CompileManager.getProjectCompileLimits = sinon
        .stub()
        .callsArgWith(
          1,
          null,
          (this.limits = { compileGroup: 'mock-compile-group' })
        )
      this.ClsiManager.wordCount = sinon.stub().callsArg(4)
      this.CompileManager.wordCount(
        this.project_id,
        this.user_id,
        false,
        this.callback
      )
    })

    it('should look up the compile group to use', function () {
      this.CompileManager.getProjectCompileLimits
        .calledWith(this.project_id)
        .should.equal(true)
    })

    it('should call wordCount for project', function () {
      this.ClsiManager.wordCount
        .calledWith(this.project_id, this.user_id, false, this.limits)
        .should.equal(true)
    })

    it('should call the callback', function () {
      this.callback.called.should.equal(true)
    })
  })
})