overleaf/services/web/test/unit/coffee/Compile/CompileManagerTests.coffee

271 lines
9.7 KiB
CoffeeScript
Raw Normal View History

2014-02-12 05:23:40 -05:00
sinon = require('sinon')
chai = require('chai')
should = chai.should()
expect = chai.expect
modulePath = "../../../../app/js/Features/Compile/CompileManager.js"
assert = require("chai").assert
SandboxedModule = require('sandboxed-module')
describe "CompileManager", ->
beforeEach ->
@rateLimitGetStub = sinon.stub()
rateLimitGetStub = @rateLimitGetStub
@ratelimiter =
addCount: sinon.stub()
2014-02-12 05:23:40 -05:00
@CompileManager = SandboxedModule.require modulePath, requires:
"settings-sharelatex": @settings =
redis: web: {host: "localhost", port: 42}
"../../infrastructure/RedisWrapper":
client: () => @rclient = { auth: () -> }
2014-02-12 05:23:40 -05:00
"../Project/ProjectRootDocManager": @ProjectRootDocManager = {}
'../Project/ProjectGetter': @ProjectGetter = {}
"../User/UserGetter": @UserGetter = {}
2014-02-12 05:23:40 -05:00
"./ClsiManager": @ClsiManager = {}
"../../infrastructure/RateLimiter": @ratelimiter
"metrics-sharelatex": @Metrics =
2014-02-12 05:23:40 -05:00
Timer: class Timer
done: sinon.stub()
inc: sinon.stub()
"logger-sharelatex": @logger = { log: sinon.stub(), warn: sinon.stub() }
2014-02-12 05:23:40 -05:00
@project_id = "mock-project-id-123"
@user_id = "mock-user-id-123"
@callback = sinon.stub()
@limits = {
timeout: 42
}
2014-02-12 05:23:40 -05:00
2014-02-12 05:23:40 -05:00
describe "compile", ->
beforeEach ->
@CompileManager._checkIfRecentlyCompiled = sinon.stub().callsArgWith(2, null, false)
@CompileManager._ensureRootDocumentIsSet = sinon.stub().callsArgWith(1, null)
@CompileManager.getProjectCompileLimits = sinon.stub().callsArgWith(1, null, @limits)
2016-05-31 11:54:28 -04:00
@ClsiManager.sendRequest = sinon.stub().callsArgWith(3, null, @status = "mock-status", @outputFiles = "mock output files", @output = "mock output")
2014-02-12 05:23:40 -05:00
describe "succesfully", ->
beforeEach ->
2017-10-09 11:31:01 -04:00
@CompileManager._checkIfAutoCompileLimitHasBeenHit = (isAutoCompile, compileGroup, cb)-> cb(null, true)
2014-02-12 05:23:40 -05:00
@CompileManager.compile @project_id, @user_id, {}, @callback
it "should check the project has not been recently compiled", ->
@CompileManager._checkIfRecentlyCompiled
.calledWith(@project_id, @user_id)
.should.equal true
it "should ensure that the root document is set", ->
@CompileManager._ensureRootDocumentIsSet
.calledWith(@project_id)
.should.equal true
it "should get the project compile limits", ->
@CompileManager.getProjectCompileLimits
2014-02-12 05:23:40 -05:00
.calledWith(@project_id)
.should.equal true
it "should run the compile with the compile limits", ->
@ClsiManager.sendRequest
.calledWith(@project_id, @user_id, {
timeout: @limits.timeout
})
.should.equal true
it "should call the callback with the output", ->
2014-02-12 05:23:40 -05:00
@callback
.calledWith(null, @status, @outputFiles, @output)
2014-02-12 05:23:40 -05:00
.should.equal true
it "should time the compile", ->
@Metrics.Timer::done.called.should.equal true
it "should log out the compile", ->
@logger.log
.calledWith(project_id: @project_id, user_id: @user_id, "compiling project")
.should.equal true
describe "when the project has been recently compiled", ->
it "should return", (done)->
2017-10-09 11:31:01 -04:00
@CompileManager._checkIfAutoCompileLimitHasBeenHit = (isAutoCompile, compileGroup, cb)-> cb(null, true)
2014-02-12 05:23:40 -05:00
@CompileManager._checkIfRecentlyCompiled = sinon.stub().callsArgWith(2, null, true)
@CompileManager.compile @project_id, @user_id, {}, (err, status)->
status.should.equal "too-recently-compiled"
done()
2014-02-12 05:23:40 -05:00
describe "should check the rate limit", ->
it "should return", (done)->
2017-10-09 11:31:01 -04:00
@CompileManager._checkIfAutoCompileLimitHasBeenHit = sinon.stub().callsArgWith(2, null, false)
@CompileManager.compile @project_id, @user_id, {}, (err, status)->
status.should.equal "autocompile-backoff"
2014-02-12 05:23:40 -05:00
done()
describe "getProjectCompileLimits", ->
beforeEach ->
@features = {
compileTimeout: @timeout = 42
compileGroup: @group = "priority"
}
@ProjectGetter.getProject = sinon.stub().callsArgWith(2, null, @project = { owner_ref: @owner_id = "owner-id-123" })
@UserGetter.getUser = sinon.stub().callsArgWith(2, null, @user = { features: @features })
@CompileManager.getProjectCompileLimits @project_id, @callback
it "should look up the owner of the project", ->
@ProjectGetter.getProject
.calledWith(@project_id, { owner_ref: 1 })
.should.equal true
it "should look up the owner's features", ->
@UserGetter.getUser
.calledWith(@project.owner_ref, { features: 1 })
.should.equal true
it "should return the limits", ->
@callback
.calledWith(null, {
timeout: @timeout
compileGroup: @group
})
.should.equal true
describe "deleteAuxFiles", ->
2014-02-12 05:23:40 -05:00
beforeEach ->
@CompileManager.getProjectCompileLimits = sinon.stub().callsArgWith 1, null, @limits = { compileGroup: "mock-compile-group" }
2016-05-31 11:54:28 -04:00
@ClsiManager.deleteAuxFiles = sinon.stub().callsArg(3)
@CompileManager.deleteAuxFiles @project_id, @user_id, @callback
it "should look up the compile group to use", ->
@CompileManager.getProjectCompileLimits
2014-02-12 05:23:40 -05:00
.calledWith(@project_id)
.should.equal true
it "should delete the aux files", ->
@ClsiManager.deleteAuxFiles
2016-05-31 11:54:28 -04:00
.calledWith(@project_id, @user_id, @limits)
2014-02-12 05:23:40 -05:00
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true
2014-02-12 05:23:40 -05:00
describe "_checkIfRecentlyCompiled", ->
describe "when the key exists in redis", ->
beforeEach ->
@rclient.set = sinon.stub().callsArgWith(5, null, null)
@CompileManager._checkIfRecentlyCompiled(@project_id, @user_id, @callback)
it "should try to set the key", ->
@rclient.set
.calledWith("compile:#{@project_id}:#{@user_id}", true, "EX", @CompileManager.COMPILE_DELAY, "NX")
.should.equal true
it "should call the callback with true", ->
@callback.calledWith(null, true).should.equal true
describe "when the key does not exist in redis", ->
beforeEach ->
@rclient.set = sinon.stub().callsArgWith(5, null, "OK")
@CompileManager._checkIfRecentlyCompiled(@project_id, @user_id, @callback)
it "should try to set the key", ->
@rclient.set
.calledWith("compile:#{@project_id}:#{@user_id}", true, "EX", @CompileManager.COMPILE_DELAY, "NX")
.should.equal true
it "should call the callback with false", ->
@callback.calledWith(null, false).should.equal true
describe "_ensureRootDocumentIsSet", ->
beforeEach ->
@project = {}
@ProjectGetter.getProject = sinon.stub().callsArgWith(2, null, @project)
2014-02-12 05:23:40 -05:00
@ProjectRootDocManager.setRootDocAutomatically = sinon.stub().callsArgWith(1, null)
describe "when the root doc is set", ->
beforeEach ->
@project.rootDoc_id = "root-doc-id"
@CompileManager._ensureRootDocumentIsSet(@project_id, @callback)
it "should find the project with only the rootDoc_id fiel", ->
@ProjectGetter.getProject
.calledWith(@project_id, rootDoc_id: 1)
2014-02-12 05:23:40 -05:00
.should.equal true
it "should not try to update the project rootDoc_id", ->
@ProjectRootDocManager.setRootDocAutomatically
.called.should.equal false
it "should call the callback", ->
@callback.called.should.equal true
describe "when the root doc is not set", ->
beforeEach ->
@CompileManager._ensureRootDocumentIsSet(@project_id, @callback)
it "should find the project with only the rootDoc_id fiel", ->
@ProjectGetter.getProject
.calledWith(@project_id, rootDoc_id: 1)
2014-02-12 05:23:40 -05:00
.should.equal true
it "should update the project rootDoc_id", ->
@ProjectRootDocManager.setRootDocAutomatically
.calledWith(@project_id)
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true
describe "when the project does not exist", ->
beforeEach ->
@ProjectGetter.getProject = sinon.stub().callsArgWith(2, null, null)
2014-02-12 05:23:40 -05:00
@CompileManager._ensureRootDocumentIsSet(@project_id, @callback)
it "should call the callback with an error", ->
@callback.calledWith(new Error("project not found")).should.equal true
describe "_checkIfAutoCompileLimitHasBeenHit", ->
it "should be able to compile if it is not an autocompile", (done)->
2017-10-09 11:31:01 -04:00
@ratelimiter.addCount.callsArgWith(2, null, true)
@CompileManager._checkIfAutoCompileLimitHasBeenHit false, "everyone", (err, canCompile)=>
2014-02-12 05:23:40 -05:00
canCompile.should.equal true
done()
it "should be able to compile if rate limit has remianing", (done)->
@ratelimiter.addCount.callsArgWith(1, null, true)
2017-10-09 11:31:01 -04:00
@CompileManager._checkIfAutoCompileLimitHasBeenHit true, "everyone", (err, canCompile)=>
args = @ratelimiter.addCount.args[0][0]
args.throttle.should.equal 25
args.subjectName.should.equal "everyone"
args.timeInterval.should.equal 20
args.endpointName.should.equal "auto_compile"
2014-02-12 05:23:40 -05:00
canCompile.should.equal true
done()
it "should be not able to compile if rate limit has no remianing", (done)->
@ratelimiter.addCount.callsArgWith(1, null, false)
2017-10-09 11:31:01 -04:00
@CompileManager._checkIfAutoCompileLimitHasBeenHit true, "everyone", (err, canCompile)=>
2014-02-12 05:23:40 -05:00
canCompile.should.equal false
done()
it "should return false if there is an error in the rate limit", (done)->
@ratelimiter.addCount.callsArgWith(1, "error")
2017-10-09 11:31:01 -04:00
@CompileManager._checkIfAutoCompileLimitHasBeenHit true, "everyone", (err, canCompile)=>
2014-02-12 05:23:40 -05:00
canCompile.should.equal false
done()
2015-09-11 09:21:05 -04:00
describe "wordCount", ->
beforeEach ->
@CompileManager.getProjectCompileLimits = sinon.stub().callsArgWith 1, null, @limits = { compileGroup: "mock-compile-group" }
2016-05-31 11:54:28 -04:00
@ClsiManager.wordCount = sinon.stub().callsArg(4)
@CompileManager.wordCount @project_id, @user_id, false, @callback
2015-09-11 09:21:05 -04:00
it "should look up the compile group to use", ->
@CompileManager.getProjectCompileLimits
.calledWith(@project_id)
.should.equal true
it "should call wordCount for project", ->
@ClsiManager.wordCount
2016-05-31 11:54:28 -04:00
.calledWith(@project_id, @user_id, false, @limits)
2015-09-11 09:21:05 -04:00
.should.equal true
it "should call the callback", ->
@callback.called.should.equal true