mirror of
https://github.com/overleaf/overleaf.git
synced 2024-11-21 20:47:08 -05:00
4bd0708029
I know this is premature optimisation however we do make a lot of requests to the clsi for each compile and this will save mongo a lot of calls
229 lines
7.3 KiB
CoffeeScript
229 lines
7.3 KiB
CoffeeScript
sinon = require('sinon')
|
|
chai = require('chai')
|
|
should = chai.should()
|
|
assert = require("chai").assert
|
|
expect = chai.expect
|
|
modulePath = "../../../../app/js/Features/Compile/CompileController.js"
|
|
SandboxedModule = require('sandboxed-module')
|
|
MockRequest = require "../helpers/MockRequest"
|
|
MockResponse = require "../helpers/MockResponse"
|
|
|
|
describe "CompileController", ->
|
|
beforeEach ->
|
|
@CompileManager =
|
|
compile: sinon.stub()
|
|
@ClsiManager = {}
|
|
@UserGetter =
|
|
getUser:sinon.stub()
|
|
@CompileController = SandboxedModule.require modulePath, requires:
|
|
"settings-sharelatex": @settings =
|
|
apis:
|
|
clsi:
|
|
url: "clsi.example.com"
|
|
clsi_priority:
|
|
url: "clsi.example.com"
|
|
"request": @request = sinon.stub()
|
|
"../../models/Project": Project: @Project = {}
|
|
"logger-sharelatex": @logger = { log: sinon.stub(), error: sinon.stub() }
|
|
"../../infrastructure/Metrics": @Metrics = { inc: sinon.stub() }
|
|
"./CompileManager":@CompileManager
|
|
"../User/UserGetter":@UserGetter
|
|
"./ClsiManager": @ClsiManager
|
|
"../Authentication/AuthenticationController": @AuthenticationController = {}
|
|
@project_id = "project-id"
|
|
@user =
|
|
features:
|
|
compileGroup: "premium"
|
|
compileTimeout: 100
|
|
@next = sinon.stub()
|
|
@req = new MockRequest()
|
|
@res = new MockResponse()
|
|
|
|
describe "compile", ->
|
|
|
|
describe "when not an auto compile", ->
|
|
beforeEach ->
|
|
@req.params =
|
|
Project_id: @project_id
|
|
@req.session = {}
|
|
@AuthenticationController.getLoggedInUserId = sinon.stub().callsArgWith(1, null, @user_id = "mock-user-id")
|
|
@CompileManager.compile = sinon.stub().callsArgWith(3, null, @status = "success", @outputFiles = ["mock-output-files"])
|
|
@UserGetter.getUser.callsArgWith(2, null, @user)
|
|
@CompileController.compile @req, @res, @next
|
|
|
|
it "should look up the user id", ->
|
|
@AuthenticationController.getLoggedInUserId
|
|
.calledWith(@req)
|
|
.should.equal true
|
|
|
|
it "should do the compile without the auto compile flag", ->
|
|
@CompileManager.compile
|
|
.calledWith(@project_id, @user_id, { isAutoCompile: false, settingsOverride:{timeout:@user.features.compileTimeout, compiler:@user.features.compileGroup} })
|
|
.should.equal true
|
|
|
|
it "should set the content-type of the response to application/json", ->
|
|
@res.contentType
|
|
.calledWith("application/json")
|
|
.should.equal true
|
|
|
|
it "should send a successful response reporting the status and files", ->
|
|
@res.statusCode.should.equal 200
|
|
@res.body.should.equal JSON.stringify({
|
|
status: @status
|
|
outputFiles: @outputFiles
|
|
})
|
|
|
|
it "should get the compile timeout from the users features",->
|
|
@UserGetter.getUser.args[0][0].should.equal @user_id
|
|
assert.deepEqual @UserGetter.getUser.args[0][1], {"features.compileGroup":1, "features.compileTimeout":1}
|
|
|
|
it "should put the compile group on the req", ->
|
|
@req.session.compileGroup.should.equal @user.features.compileGroup
|
|
|
|
it "should set the timeout", ->
|
|
assert @res.timout > 1000 * 60 * 3
|
|
|
|
describe "when an auto compile", ->
|
|
beforeEach ->
|
|
@req.params =
|
|
Project_id: @project_id
|
|
@req.query =
|
|
auto_compile: "true"
|
|
@AuthenticationController.getLoggedInUserId = sinon.stub().callsArgWith(1, null, @user_id = "mock-user-id")
|
|
@CompileManager.compile = sinon.stub().callsArgWith(3, null, @status = "success", @outputFiles = ["mock-output-files"])
|
|
@UserGetter.getUser.callsArgWith(2, null, @user)
|
|
@CompileController.compile @req, @res, @next
|
|
|
|
it "should do the compile with the auto compile flag", ->
|
|
@CompileManager.compile.calledWith(@project_id, @user_id, { isAutoCompile: true, settingsOverride:{timeout:@user.features.compileTimeout, compiler:@user.features.compileGroup} }).should.equal true
|
|
|
|
describe "downloadPdf", ->
|
|
beforeEach ->
|
|
@req.params =
|
|
Project_id: @project_id
|
|
@project =
|
|
getSafeProjectName: () => @safe_name = "safe-name"
|
|
|
|
@Project.findById = sinon.stub().callsArgWith(2, null, @project)
|
|
|
|
describe "when downloading for embedding", ->
|
|
beforeEach ->
|
|
@project.useClsi2 = true
|
|
@CompileController.proxyToClsi = sinon.stub()
|
|
@CompileController.downloadPdf(@req, @res, @next)
|
|
|
|
it "should look up the project", ->
|
|
@Project.findById
|
|
.calledWith(@project_id, {name: 1})
|
|
.should.equal true
|
|
|
|
it "should set the content-type of the response to application/pdf", ->
|
|
@res.contentType
|
|
.calledWith("application/pdf")
|
|
.should.equal true
|
|
|
|
it "should set the content-disposition header with the project name", ->
|
|
@res.header
|
|
.calledWith("Content-Disposition", "filename=#{@safe_name}.pdf")
|
|
.should.equal true
|
|
|
|
it "should increment the pdf-downloads metric", ->
|
|
@Metrics.inc
|
|
.calledWith("pdf-downloads")
|
|
.should.equal true
|
|
|
|
it "should proxy the PDF from the CLSI", ->
|
|
@CompileController.proxyToClsi
|
|
.calledWith("/project/#{@project_id}/output/output.pdf", @req, @res, @next)
|
|
.should.equal true
|
|
|
|
describe "proxyToClsi", ->
|
|
beforeEach ->
|
|
@request.returns(@proxy = {
|
|
pipe: sinon.stub()
|
|
on: sinon.stub()
|
|
})
|
|
@upstream =
|
|
statusCode: 204
|
|
headers: { "mock": "header" }
|
|
@req.method = "mock-method"
|
|
|
|
|
|
describe "user with standard priority", ->
|
|
|
|
beforeEach ->
|
|
@UserGetter.getUser.callsArgWith(2, null, @user)
|
|
@CompileController.proxyToClsi(@url = "/test", @req, @res, @next)
|
|
|
|
|
|
it "should open a request to the CLSI", ->
|
|
@request
|
|
.calledWith(
|
|
method: @req.method
|
|
url: "#{@settings.apis.clsi.url}#{@url}",
|
|
timeout: 60 * 1000
|
|
)
|
|
.should.equal true
|
|
|
|
it "should pass the request on to the client", ->
|
|
@proxy.pipe
|
|
.calledWith(@res)
|
|
.should.equal true
|
|
|
|
it "should bind an error handle to the request proxy", ->
|
|
@proxy.on.calledWith("error").should.equal true
|
|
|
|
describe "user with priority compile", ->
|
|
|
|
beforeEach ->
|
|
@req.session.compileGroup = "priority"
|
|
@UserGetter.getUser.callsArgWith(2, null, @user)
|
|
@CompileController.proxyToClsi(@url = "/test", @req, @res, @next)
|
|
|
|
it "should proxy to the priorty url if the user has the feature", ()->
|
|
@request
|
|
.calledWith(
|
|
method: @req.method
|
|
url: "#{@settings.apis.clsi_priority.url}#{@url}",
|
|
timeout: 60 * 1000
|
|
)
|
|
.should.equal true
|
|
|
|
|
|
describe "deleteAuxFiles", ->
|
|
beforeEach ->
|
|
@ClsiManager.deleteAuxFiles = sinon.stub().callsArg(1)
|
|
@req.params =
|
|
Project_id: @project_id
|
|
@res.send = sinon.stub()
|
|
@CompileController.deleteAuxFiles @req, @res, @next
|
|
|
|
it "should proxy to the CLSI", ->
|
|
@ClsiManager.deleteAuxFiles
|
|
.calledWith(@project_id)
|
|
.should.equal true
|
|
|
|
it "should return a 200", ->
|
|
@res.send
|
|
.calledWith(200)
|
|
.should.equal true
|
|
|
|
describe "compileAndDownloadPdf", ->
|
|
beforeEach ->
|
|
@req =
|
|
params:
|
|
project_id:@project_id
|
|
@CompileManager.compile.callsArgWith(3)
|
|
@CompileController.proxyToClsi = sinon.stub()
|
|
@res =
|
|
send:=>
|
|
|
|
it "should call compile in the compile manager", (done)->
|
|
@CompileController.compileAndDownloadPdf @req, @res
|
|
@CompileManager.compile.calledWith(@project_id).should.equal true
|
|
done()
|
|
|
|
it "should proxy the res to the clsi with correct url", (done)->
|
|
@CompileController.compileAndDownloadPdf @req, @res
|
|
@CompileController.proxyToClsi.calledWith("/project/#{@project_id}/output/output.pdf", @req, @res).should.equal true
|
|
done()
|