|
|
@@ -4,28 +4,71 @@ const modulePath = '../../../../app/src/Features/Compile/ClsiManager.js'
|
|
|
const SandboxedModule = require('sandboxed-module')
|
|
|
const tk = require('timekeeper')
|
|
|
|
|
|
+const FILESTORE_URL = 'http://filestore.example.com'
|
|
|
+const CLSI_URL = 'http://clsi.example.com'
|
|
|
+
|
|
|
describe('ClsiManager', function () {
|
|
|
beforeEach(function () {
|
|
|
this.jar = { cookie: 'stuff' }
|
|
|
+ this.user_id = 'user-id'
|
|
|
+ this.project = {
|
|
|
+ _id: 'project-id',
|
|
|
+ compiler: 'latex',
|
|
|
+ rootDoc_id: 'mock-doc-id-1',
|
|
|
+ imageName: 'mock-image-name',
|
|
|
+ }
|
|
|
+ this.docs = {
|
|
|
+ '/main.tex': {
|
|
|
+ name: 'main.tex',
|
|
|
+ _id: 'mock-doc-id-1',
|
|
|
+ lines: ['Hello', 'world'],
|
|
|
+ },
|
|
|
+ '/chapters/chapter1.tex': {
|
|
|
+ name: 'chapter1.tex',
|
|
|
+ _id: 'mock-doc-id-2',
|
|
|
+ lines: ['Chapter 1'],
|
|
|
+ },
|
|
|
+ }
|
|
|
+ this.files = {
|
|
|
+ '/images/image.png': {
|
|
|
+ name: 'image.png',
|
|
|
+ _id: 'mock-file-id-1',
|
|
|
+ created: new Date(),
|
|
|
+ },
|
|
|
+ }
|
|
|
+ this.rawOutputFiles = {}
|
|
|
+ this.response = { statusCode: 200 }
|
|
|
+ this.responseBody = {
|
|
|
+ compile: { status: 'success' },
|
|
|
+ }
|
|
|
+
|
|
|
+ this.request = sinon.stub().yields(null, this.response, this.responseBody)
|
|
|
this.ClsiCookieManager = {
|
|
|
clearServerId: sinon.stub().yields(),
|
|
|
getCookieJar: sinon.stub().yields(null, this.jar),
|
|
|
setServerId: sinon.stub().yields(null),
|
|
|
- _getServerId: sinon.stub(),
|
|
|
}
|
|
|
this.ClsiStateManager = {
|
|
|
computeHash: sinon.stub().returns('01234567890abcdef'),
|
|
|
}
|
|
|
this.ClsiFormatChecker = {
|
|
|
- checkRecoursesForProblems: sinon.stub().callsArgWith(1),
|
|
|
+ checkRecoursesForProblems: sinon.stub().yields(),
|
|
|
}
|
|
|
this.Project = {}
|
|
|
- this.ProjectEntityHandler = {}
|
|
|
- this.ProjectGetter = {}
|
|
|
+ this.ProjectEntityHandler = {
|
|
|
+ getAllDocs: sinon.stub().yields(null, this.docs),
|
|
|
+ getAllFiles: sinon.stub().yields(null, this.files),
|
|
|
+ getAllDocPathsFromProject: sinon.stub(),
|
|
|
+ }
|
|
|
+ this.ProjectGetter = {
|
|
|
+ findById: sinon.stub().yields(null, this.project),
|
|
|
+ getProject: sinon.stub().yields(null, this.project),
|
|
|
+ }
|
|
|
this.DocumentUpdaterHandler = {
|
|
|
- getProjectDocsIfMatch: sinon.stub().callsArgWith(2, null, null),
|
|
|
+ clearProjectState: sinon.stub().yields(),
|
|
|
+ flushProjectToMongo: sinon.stub().yields(),
|
|
|
+ getProjectDocsIfMatch: sinon.stub().yields(),
|
|
|
}
|
|
|
- this.request = sinon.stub()
|
|
|
this.Metrics = {
|
|
|
Timer: class Metrics {
|
|
|
constructor() {
|
|
|
@@ -35,16 +78,20 @@ describe('ClsiManager', function () {
|
|
|
inc: sinon.stub(),
|
|
|
count: sinon.stub(),
|
|
|
}
|
|
|
+ this.SplitTestHandler = {
|
|
|
+ getAssignment: sinon.stub().yields(null, { variant: 'default' }),
|
|
|
+ }
|
|
|
+
|
|
|
this.ClsiManager = SandboxedModule.require(modulePath, {
|
|
|
requires: {
|
|
|
'@overleaf/settings': (this.settings = {
|
|
|
apis: {
|
|
|
filestore: {
|
|
|
- url: 'filestore.example.com',
|
|
|
+ url: FILESTORE_URL,
|
|
|
secret: 'secret',
|
|
|
},
|
|
|
clsi: {
|
|
|
- url: 'http://clsi.example.com',
|
|
|
+ url: CLSI_URL,
|
|
|
defaultBackendClass: 'e2',
|
|
|
},
|
|
|
clsi_priority: {
|
|
|
@@ -65,15 +112,9 @@ describe('ClsiManager', function () {
|
|
|
request: this.request,
|
|
|
'./ClsiFormatChecker': this.ClsiFormatChecker,
|
|
|
'@overleaf/metrics': this.Metrics,
|
|
|
- '../SplitTests/SplitTestHandler': {
|
|
|
- getAssignment: (this.getAssignment = sinon.stub().yields(null, {
|
|
|
- variant: 'default',
|
|
|
- })),
|
|
|
- },
|
|
|
+ '../SplitTests/SplitTestHandler': this.SplitTestHandler,
|
|
|
},
|
|
|
})
|
|
|
- this.project_id = 'project-id'
|
|
|
- this.user_id = 'user-id'
|
|
|
this.callback = sinon.stub()
|
|
|
tk.freeze(Date.now())
|
|
|
})
|
|
|
@@ -84,72 +125,17 @@ describe('ClsiManager', function () {
|
|
|
|
|
|
describe('sendRequest', function () {
|
|
|
beforeEach(function () {
|
|
|
- this.ClsiManager._buildRequest = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(2, null, (this.request = 'mock-request'))
|
|
|
- this.ClsiCookieManager._getServerId.callsArgWith(2, null, 'clsi3')
|
|
|
+ this.ClsiCookieManager.getCookieJar.yields(null, this.jar, 'clsi3')
|
|
|
})
|
|
|
|
|
|
describe('with a successful compile', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager._postToClsi = sinon.stub().yields(null, {
|
|
|
- compile: {
|
|
|
- status: (this.status = 'success'),
|
|
|
- outputFiles: [
|
|
|
- {
|
|
|
- url: `${this.settings.apis.clsi.url}/project/${this.project_id}/user/${this.user_id}/build/1234/output/output.pdf`,
|
|
|
- path: 'output.pdf',
|
|
|
- type: 'pdf',
|
|
|
- build: 1234,
|
|
|
- },
|
|
|
- {
|
|
|
- url: `${this.settings.apis.clsi.url}/project/${this.project_id}/user/${this.user_id}/build/1234/output/output.log`,
|
|
|
- path: 'output.log',
|
|
|
- type: 'log',
|
|
|
- build: 1234,
|
|
|
- },
|
|
|
- ],
|
|
|
- },
|
|
|
- })
|
|
|
- this.ClsiManager.sendRequest(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- { compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
- this.callback
|
|
|
- )
|
|
|
- })
|
|
|
-
|
|
|
- it('should build the request', function () {
|
|
|
- this.ClsiManager._buildRequest
|
|
|
- .calledWith(this.project_id)
|
|
|
- .should.equal(true)
|
|
|
- })
|
|
|
-
|
|
|
- it('should send the request to the CLSI', function () {
|
|
|
- this.ClsiManager._postToClsi
|
|
|
- .calledWith(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- this.request,
|
|
|
- 'e2',
|
|
|
- 'standard'
|
|
|
- )
|
|
|
- .should.equal(true)
|
|
|
- })
|
|
|
-
|
|
|
- it('should call the callback with the status and output files', function () {
|
|
|
- const outputFiles = [
|
|
|
+ beforeEach(function (done) {
|
|
|
+ this.outputFiles = [
|
|
|
{
|
|
|
url: `/project/${this.project_id}/user/${this.user_id}/build/1234/output/output.pdf`,
|
|
|
path: 'output.pdf',
|
|
|
type: 'pdf',
|
|
|
build: 1234,
|
|
|
- ranges: [],
|
|
|
- createdAt: new Date(),
|
|
|
- // gets dropped by JSON.stringify
|
|
|
- contentId: undefined,
|
|
|
- size: undefined,
|
|
|
- startXRefTable: undefined,
|
|
|
},
|
|
|
{
|
|
|
url: `/project/${this.project_id}/user/${this.user_id}/build/1234/output/output.log`,
|
|
|
@@ -158,1159 +144,855 @@ describe('ClsiManager', function () {
|
|
|
build: 1234,
|
|
|
},
|
|
|
]
|
|
|
- this.callback
|
|
|
- .calledWith(null, this.status, outputFiles)
|
|
|
- .should.equal(true)
|
|
|
+ this.responseBody.compile.outputFiles = this.outputFiles.map(
|
|
|
+ outputFile => ({ ...outputFile, url: CLSI_URL + outputFile.url })
|
|
|
+ )
|
|
|
+ this.timeout = 100
|
|
|
+ this.ClsiManager.sendRequest(
|
|
|
+ this.project._id,
|
|
|
+ this.user_id,
|
|
|
+ {
|
|
|
+ compileBackendClass: 'e2',
|
|
|
+ compileGroup: 'standard',
|
|
|
+ timeout: this.timeout,
|
|
|
+ },
|
|
|
+ (err, status, outputFiles) => {
|
|
|
+ if (err) {
|
|
|
+ return done(err)
|
|
|
+ }
|
|
|
+ this.result = { status, outputFiles }
|
|
|
+ done()
|
|
|
+ }
|
|
|
+ )
|
|
|
})
|
|
|
- })
|
|
|
|
|
|
- describe('with ranges on the pdf and stats/timings details', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager._postToClsi = sinon.stub().yields(
|
|
|
- null,
|
|
|
- {
|
|
|
+ it('should send the request to the CLSI', function () {
|
|
|
+ this.request.should.have.been.calledWith({
|
|
|
+ url: `${CLSI_URL}/project/${this.project._id}/user/${this.user_id}/compile?compileBackendClass=e2&compileGroup=standard`,
|
|
|
+ method: 'POST',
|
|
|
+ json: {
|
|
|
compile: {
|
|
|
- status: 'success',
|
|
|
- stats: { fooStat: 1 },
|
|
|
- timings: { barTiming: 2 },
|
|
|
- outputFiles: [
|
|
|
- {
|
|
|
- url: `${this.settings.apis.clsi.url}/project/${this.project_id}/user/${this.user_id}/build/1234/output/output.pdf`,
|
|
|
- path: 'output.pdf',
|
|
|
- type: 'pdf',
|
|
|
- build: 1234,
|
|
|
- contentId: '123-321',
|
|
|
- ranges: [{ start: 1, end: 42, hash: 'foo' }],
|
|
|
- startXRefTable: 42,
|
|
|
- size: 42,
|
|
|
- },
|
|
|
- {
|
|
|
- url: `${this.settings.apis.clsi.url}/project/${this.project_id}/user/${this.user_id}/build/1234/output/output.log`,
|
|
|
- path: 'output.log',
|
|
|
- type: 'log',
|
|
|
- build: 1234,
|
|
|
- },
|
|
|
- ],
|
|
|
+ options: sinon.match({
|
|
|
+ compiler: this.project.compiler,
|
|
|
+ imageName: this.project.imageName,
|
|
|
+ timeout: this.timeout,
|
|
|
+ draft: false,
|
|
|
+ check: undefined,
|
|
|
+ syncType: undefined, // "full"
|
|
|
+ syncState: undefined,
|
|
|
+ compileGroup: 'standard',
|
|
|
+ enablePdfCaching: false,
|
|
|
+ pdfCachingMinChunkSize: undefined,
|
|
|
+ flags: undefined,
|
|
|
+ metricsMethod: 'standard',
|
|
|
+ stopOnFirstError: false,
|
|
|
+ }),
|
|
|
+ rootResourcePath: 'main.tex',
|
|
|
+ resources: _makeResources(this.project, this.docs, this.files),
|
|
|
},
|
|
|
},
|
|
|
- 'clsi-server-id-43'
|
|
|
+ jar: this.jar,
|
|
|
+ })
|
|
|
+ })
|
|
|
+
|
|
|
+ it('should get the project with the required fields', function () {
|
|
|
+ this.ProjectGetter.getProject.should.have.been.calledWith(
|
|
|
+ this.project._id,
|
|
|
+ {
|
|
|
+ compiler: 1,
|
|
|
+ rootDoc_id: 1,
|
|
|
+ imageName: 1,
|
|
|
+ rootFolder: 1,
|
|
|
+ }
|
|
|
)
|
|
|
- this.ClsiCookieManager._getServerId.yields(null, 'clsi-server-id-42')
|
|
|
- this.ClsiManager.sendRequest(
|
|
|
- this.project_id,
|
|
|
+ })
|
|
|
+
|
|
|
+ it('should flush the project to the database', function () {
|
|
|
+ this.DocumentUpdaterHandler.flushProjectToMongo.should.have.been.calledWith(
|
|
|
+ this.project._id
|
|
|
+ )
|
|
|
+ })
|
|
|
+
|
|
|
+ it('should get all the docs', function () {
|
|
|
+ this.ProjectEntityHandler.getAllDocs.should.have.been.calledWith(
|
|
|
+ this.project._id
|
|
|
+ )
|
|
|
+ })
|
|
|
+
|
|
|
+ it('should get all the files', function () {
|
|
|
+ this.ProjectEntityHandler.getAllFiles.should.have.been.calledWith(
|
|
|
+ this.project._id
|
|
|
+ )
|
|
|
+ })
|
|
|
+
|
|
|
+ it('should call the callback with the status and output files', function () {
|
|
|
+ expect(this.result.status).to.equal('success')
|
|
|
+ expect(this.result.outputFiles.map(f => f.path)).to.have.members(
|
|
|
+ this.outputFiles.map(f => f.path)
|
|
|
+ )
|
|
|
+ })
|
|
|
+
|
|
|
+ it('should process a request with a cookie jar', function () {
|
|
|
+ expect(this.request).to.have.been.calledWith(
|
|
|
+ sinon.match(opts => opts.jar === this.jar && opts.qs == null)
|
|
|
+ )
|
|
|
+ })
|
|
|
+
|
|
|
+ it('should persist the cookie from the response', function () {
|
|
|
+ expect(this.ClsiCookieManager.setServerId).to.have.been.calledWith(
|
|
|
+ this.project._id,
|
|
|
this.user_id,
|
|
|
- { compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
- this.callback
|
|
|
+ 'standard',
|
|
|
+ 'e2',
|
|
|
+ this.response
|
|
|
)
|
|
|
})
|
|
|
+ })
|
|
|
|
|
|
- it('should emit the caching details and stats/timings', function () {
|
|
|
- const outputFiles = [
|
|
|
+ describe('with ranges on the pdf and stats/timings details', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ this.ranges = [{ start: 1, end: 42, hash: 'foo' }]
|
|
|
+ this.startXRefTable = 123
|
|
|
+ this.size = 456
|
|
|
+ this.contentId = '123-321'
|
|
|
+ this.outputFiles = [
|
|
|
{
|
|
|
- url: `/project/${this.project_id}/user/${this.user_id}/build/1234/output/output.pdf`,
|
|
|
+ url: `/project/${this.project._id}/user/${this.user_id}/build/1234/output/output.pdf`,
|
|
|
path: 'output.pdf',
|
|
|
type: 'pdf',
|
|
|
build: 1234,
|
|
|
- contentId: '123-321',
|
|
|
- ranges: [{ start: 1, end: 42, hash: 'foo' }],
|
|
|
- startXRefTable: 42,
|
|
|
- size: 42,
|
|
|
- createdAt: new Date(),
|
|
|
+ contentId: this.contentId,
|
|
|
+ ranges: this.ranges,
|
|
|
+ startXRefTable: this.startXRefTable,
|
|
|
+ size: this.size,
|
|
|
},
|
|
|
{
|
|
|
- url: `/project/${this.project_id}/user/${this.user_id}/build/1234/output/output.log`,
|
|
|
+ url: `/project/${this.project._id}/user/${this.user_id}/build/1234/output/output.log`,
|
|
|
path: 'output.log',
|
|
|
type: 'log',
|
|
|
build: 1234,
|
|
|
},
|
|
|
]
|
|
|
- const validationError = undefined
|
|
|
- expect(this.callback).to.have.been.calledWith(
|
|
|
+ this.stats = { fooStat: 1 }
|
|
|
+ this.timings = { barTiming: 2 }
|
|
|
+ this.serverId = 'clsi-server-id-42'
|
|
|
+ this.responseBody.compile.outputFiles = this.outputFiles.map(
|
|
|
+ outputFile => ({ ...outputFile, url: CLSI_URL + outputFile.url })
|
|
|
+ )
|
|
|
+ this.responseBody.compile.stats = this.stats
|
|
|
+ this.responseBody.compile.timings = this.timings
|
|
|
+ this.ClsiCookieManager.getCookieJar.yields(
|
|
|
null,
|
|
|
- 'success',
|
|
|
- outputFiles,
|
|
|
- 'clsi-server-id-43',
|
|
|
- validationError,
|
|
|
- { fooStat: 1 },
|
|
|
- { barTiming: 2 }
|
|
|
+ this.jar,
|
|
|
+ this.serverId
|
|
|
)
|
|
|
- })
|
|
|
- })
|
|
|
-
|
|
|
- describe('with a failed compile', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager._postToClsi = sinon.stub().yields(null, {
|
|
|
- compile: {
|
|
|
- status: (this.status = 'failure'),
|
|
|
- },
|
|
|
- })
|
|
|
this.ClsiManager.sendRequest(
|
|
|
- this.project_id,
|
|
|
+ this.project._id,
|
|
|
this.user_id,
|
|
|
- {},
|
|
|
- this.callback
|
|
|
+ { compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
+ (
|
|
|
+ err,
|
|
|
+ status,
|
|
|
+ outputFiles,
|
|
|
+ serverId,
|
|
|
+ validationError,
|
|
|
+ stats,
|
|
|
+ timings
|
|
|
+ ) => {
|
|
|
+ if (err) {
|
|
|
+ return done(err)
|
|
|
+ }
|
|
|
+ this.result = {
|
|
|
+ status,
|
|
|
+ outputFiles,
|
|
|
+ serverId,
|
|
|
+ validationError,
|
|
|
+ stats,
|
|
|
+ timings,
|
|
|
+ }
|
|
|
+ done()
|
|
|
+ }
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should call the callback with a failure status', function () {
|
|
|
- this.callback.calledWith(null, this.status).should.equal(true)
|
|
|
+ it('should emit the caching details and stats/timings', function () {
|
|
|
+ expect(this.result.status).to.equal('success')
|
|
|
+ expect(this.result.serverId).to.equal(this.serverId)
|
|
|
+ expect(this.result.validationError).to.be.undefined
|
|
|
+ expect(this.result.stats).to.equal(this.stats)
|
|
|
+ expect(this.result.timings).to.equal(this.timings)
|
|
|
+ const outputPdf = this.result.outputFiles.find(
|
|
|
+ f => f.path === 'output.pdf'
|
|
|
+ )
|
|
|
+ expect(outputPdf.ranges).to.equal(this.ranges)
|
|
|
+ expect(outputPdf.startXRefTable).to.equal(this.startXRefTable)
|
|
|
+ expect(outputPdf.contentId).to.equal(this.contentId)
|
|
|
+ expect(outputPdf.size).to.equal(this.size)
|
|
|
})
|
|
|
})
|
|
|
|
|
|
- describe('with a sync conflict', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager.sendRequestOnce = sinon.stub()
|
|
|
- this.ClsiManager.sendRequestOnce
|
|
|
- .withArgs(this.project_id, this.user_id, { syncType: 'full' })
|
|
|
- .callsArgWith(3, null, (this.status = 'success'))
|
|
|
- this.ClsiManager.sendRequestOnce
|
|
|
- .withArgs(this.project_id, this.user_id, {})
|
|
|
- .callsArgWith(3, null, 'conflict')
|
|
|
+ describe('with the incremental compile option', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ const doc = this.docs['/main.tex']
|
|
|
+ this.DocumentUpdaterHandler.getProjectDocsIfMatch.yields(null, [
|
|
|
+ { _id: doc._id, lines: doc.lines, v: 123 },
|
|
|
+ ])
|
|
|
+ this.ProjectEntityHandler.getAllDocPathsFromProject.returns({
|
|
|
+ 'mock-doc-id-1': 'main.tex',
|
|
|
+ })
|
|
|
this.ClsiManager.sendRequest(
|
|
|
- this.project_id,
|
|
|
+ this.project._id,
|
|
|
this.user_id,
|
|
|
- {},
|
|
|
- this.callback
|
|
|
+ {
|
|
|
+ timeout: 100,
|
|
|
+ incrementalCompilesEnabled: true,
|
|
|
+ compileBackendClass: 'e2',
|
|
|
+ compileGroup: 'priority',
|
|
|
+ enablePdfCaching: true,
|
|
|
+ pdfCachingMinChunkSize: 1337,
|
|
|
+ },
|
|
|
+ (err, status, outputFiles) => {
|
|
|
+ if (err) {
|
|
|
+ return done(err)
|
|
|
+ }
|
|
|
+ this.result = { status, outputFiles }
|
|
|
+ done()
|
|
|
+ }
|
|
|
+ )
|
|
|
+ })
|
|
|
+
|
|
|
+ it('should get the project with the required fields', function () {
|
|
|
+ this.ProjectGetter.getProject.should.have.been.calledWith(
|
|
|
+ this.project._id,
|
|
|
+ {
|
|
|
+ compiler: 1,
|
|
|
+ rootDoc_id: 1,
|
|
|
+ imageName: 1,
|
|
|
+ rootFolder: 1,
|
|
|
+ }
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should call the sendRequestOnce method twice', function () {
|
|
|
- this.ClsiManager.sendRequestOnce.calledTwice.should.equal(true)
|
|
|
+ it('should not explicitly flush the project to the database', function () {
|
|
|
+ this.DocumentUpdaterHandler.flushProjectToMongo.should.not.have.been.calledWith(
|
|
|
+ this.project._id
|
|
|
+ )
|
|
|
})
|
|
|
|
|
|
- it('should call the sendRequestOnce method with syncType:full', function () {
|
|
|
- this.ClsiManager.sendRequestOnce
|
|
|
- .calledWith(this.project_id, this.user_id, { syncType: 'full' })
|
|
|
- .should.equal(true)
|
|
|
+ it('should get only the live docs from the docupdater with a background flush in docupdater', function () {
|
|
|
+ this.DocumentUpdaterHandler.getProjectDocsIfMatch.should.have.been.calledWith(
|
|
|
+ this.project._id
|
|
|
+ )
|
|
|
})
|
|
|
|
|
|
- it('should call the sendRequestOnce method without syncType:full', function () {
|
|
|
- this.ClsiManager.sendRequestOnce
|
|
|
- .calledWith(this.project_id, this.user_id, {})
|
|
|
- .should.equal(true)
|
|
|
+ it('should not get any of the files', function () {
|
|
|
+ this.ProjectEntityHandler.getAllFiles.should.not.have.been.called
|
|
|
})
|
|
|
|
|
|
- it('should call the callback with a success status', function () {
|
|
|
- this.callback.calledWith(null, this.status).should.equal(true)
|
|
|
+ it('should build up the CLSI request', function () {
|
|
|
+ this.request.should.have.been.calledWith({
|
|
|
+ url: `${CLSI_URL}/project/${this.project._id}/user/${this.user_id}/compile?compileBackendClass=e2&compileGroup=priority`,
|
|
|
+ method: 'POST',
|
|
|
+ json: {
|
|
|
+ compile: {
|
|
|
+ options: {
|
|
|
+ compiler: this.project.compiler,
|
|
|
+ timeout: 100,
|
|
|
+ imageName: this.project.imageName,
|
|
|
+ draft: false,
|
|
|
+ check: undefined,
|
|
|
+ syncType: 'incremental',
|
|
|
+ syncState: '01234567890abcdef',
|
|
|
+ compileGroup: 'priority',
|
|
|
+ enablePdfCaching: true,
|
|
|
+ pdfCachingMinChunkSize: 1337,
|
|
|
+ flags: undefined,
|
|
|
+ metricsMethod: 'priority',
|
|
|
+ stopOnFirstError: false,
|
|
|
+ },
|
|
|
+ rootResourcePath: 'main.tex',
|
|
|
+ resources: [
|
|
|
+ {
|
|
|
+ path: 'main.tex',
|
|
|
+ content: this.docs['/main.tex'].lines.join('\n'),
|
|
|
+ },
|
|
|
+ ],
|
|
|
+ },
|
|
|
+ },
|
|
|
+ jar: this.jar,
|
|
|
+ })
|
|
|
})
|
|
|
})
|
|
|
|
|
|
- describe('with an unavailable response', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager.sendRequestOnce = sinon.stub()
|
|
|
- this.ClsiManager.sendRequestOnce
|
|
|
- .withArgs(this.project_id, this.user_id, {
|
|
|
- syncType: 'full',
|
|
|
- forceNewClsiServer: true,
|
|
|
- })
|
|
|
- .callsArgWith(3, null, (this.status = 'success'))
|
|
|
- this.ClsiManager.sendRequestOnce
|
|
|
- .withArgs(this.project_id, this.user_id, {})
|
|
|
- .callsArgWith(3, null, 'unavailable')
|
|
|
+ describe('when the root doc is set and not in the docupdater', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ const doc = this.docs['/main.tex']
|
|
|
+ this.DocumentUpdaterHandler.getProjectDocsIfMatch.yields(null, [
|
|
|
+ { _id: doc._id, lines: doc.lines, v: 123 },
|
|
|
+ ])
|
|
|
+ this.ProjectEntityHandler.getAllDocPathsFromProject.returns({
|
|
|
+ 'mock-doc-id-1': 'main.tex',
|
|
|
+ 'mock-doc-id-2': '/chapters/chapter1.tex',
|
|
|
+ })
|
|
|
this.ClsiManager.sendRequest(
|
|
|
- this.project_id,
|
|
|
+ this.project._id,
|
|
|
this.user_id,
|
|
|
- {},
|
|
|
- this.callback
|
|
|
+ {
|
|
|
+ timeout: 100,
|
|
|
+ incrementalCompilesEnabled: true,
|
|
|
+ rootDoc_id: 'mock-doc-id-2',
|
|
|
+ },
|
|
|
+ done
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should call the sendRequestOnce method twice', function () {
|
|
|
- this.ClsiManager.sendRequestOnce.calledTwice.should.equal(true)
|
|
|
- })
|
|
|
-
|
|
|
- it('should call the sendRequestOnce method with forceNewClsiServer:true', function () {
|
|
|
- this.ClsiManager.sendRequestOnce
|
|
|
- .calledWith(this.project_id, this.user_id, {
|
|
|
- forceNewClsiServer: true,
|
|
|
- syncType: 'full',
|
|
|
- })
|
|
|
- .should.equal(true)
|
|
|
+ it('should still change the root path', function () {
|
|
|
+ this.request.should.have.been.calledWith(
|
|
|
+ sinon.match(
|
|
|
+ opts =>
|
|
|
+ opts.json.compile.rootResourcePath === 'chapters/chapter1.tex'
|
|
|
+ )
|
|
|
+ )
|
|
|
})
|
|
|
+ })
|
|
|
|
|
|
- it('should call the sendRequestOnce method without forceNewClsiServer:true', function () {
|
|
|
- this.ClsiManager.sendRequestOnce
|
|
|
- .calledWith(this.project_id, this.user_id, {})
|
|
|
- .should.equal(true)
|
|
|
+ describe('when root doc override is valid', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ this.ClsiManager.sendRequest(
|
|
|
+ this.project._id,
|
|
|
+ this.user_id,
|
|
|
+ { rootDoc_id: 'mock-doc-id-2' },
|
|
|
+ done
|
|
|
+ )
|
|
|
})
|
|
|
|
|
|
- it('should call the callback with a success status', function () {
|
|
|
- this.callback.calledWith(null, this.status).should.equal(true)
|
|
|
+ it('should change root path', function () {
|
|
|
+ this.request.should.have.been.calledWith(
|
|
|
+ sinon.match(
|
|
|
+ opts =>
|
|
|
+ opts.json.compile.rootResourcePath === 'chapters/chapter1.tex'
|
|
|
+ )
|
|
|
+ )
|
|
|
})
|
|
|
})
|
|
|
|
|
|
- describe('when the resources fail the precompile check', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiFormatChecker.checkRecoursesForProblems = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(1, new Error('failed'))
|
|
|
- this.ClsiManager._postToClsi = sinon.stub().yields(null, {
|
|
|
- compile: {
|
|
|
- status: (this.status = 'failure'),
|
|
|
- },
|
|
|
- })
|
|
|
+ describe('when root doc override is invalid', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
this.ClsiManager.sendRequest(
|
|
|
- this.project_id,
|
|
|
+ this.project._id,
|
|
|
this.user_id,
|
|
|
- {},
|
|
|
- this.callback
|
|
|
+ { rootDoc_id: 'invalid-id' },
|
|
|
+ done
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should call the callback only once', function () {
|
|
|
- this.callback.calledOnce.should.equal(true)
|
|
|
- })
|
|
|
-
|
|
|
- it('should call the callback with an error', function () {
|
|
|
- this.callback.should.have.been.calledWith(sinon.match.instanceOf(Error))
|
|
|
+ it('should fallback to default root doc', function () {
|
|
|
+ this.request.should.have.been.calledWith(
|
|
|
+ sinon.match(opts => opts.json.compile.rootResourcePath === 'main.tex')
|
|
|
+ )
|
|
|
})
|
|
|
})
|
|
|
- })
|
|
|
|
|
|
- describe('sendExternalRequest', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.submission_id = 'submission-id'
|
|
|
- this.clsi_request = 'mock-request'
|
|
|
- this.ClsiCookieManager._getServerId.callsArgWith(2, null, 'clsi3')
|
|
|
- })
|
|
|
+ describe('when the project has an invalid compiler', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ this.project.compiler = 'context'
|
|
|
+ this.ClsiManager.sendRequest(this.project._id, this.user_id, {}, done)
|
|
|
+ })
|
|
|
|
|
|
- describe('with a successful compile', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager._postToClsi = sinon.stub().yields(null, {
|
|
|
- compile: {
|
|
|
- status: (this.status = 'success'),
|
|
|
- outputFiles: [
|
|
|
- {
|
|
|
- url: `${this.settings.apis.clsi.url}/project/${this.submission_id}/build/1234/output/output.pdf`,
|
|
|
- path: 'output.pdf',
|
|
|
- type: 'pdf',
|
|
|
- build: 1234,
|
|
|
- },
|
|
|
- {
|
|
|
- url: `${this.settings.apis.clsi.url}/project/${this.submission_id}/build/1234/output/output.log`,
|
|
|
- path: 'output.log',
|
|
|
- type: 'log',
|
|
|
- build: 1234,
|
|
|
- },
|
|
|
- ],
|
|
|
- },
|
|
|
- })
|
|
|
- this.ClsiManager.sendExternalRequest(
|
|
|
- this.submission_id,
|
|
|
- this.clsi_request,
|
|
|
- { compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
- this.callback
|
|
|
+ it('should set the compiler to pdflatex', function () {
|
|
|
+ expect(this.request).to.have.been.calledWith(
|
|
|
+ sinon.match(opts => opts.json.compile.options.compiler === 'pdflatex')
|
|
|
)
|
|
|
})
|
|
|
+ })
|
|
|
|
|
|
- it('should send the request to the CLSI', function () {
|
|
|
- this.ClsiManager._postToClsi
|
|
|
- .calledWith(
|
|
|
- this.submission_id,
|
|
|
- null,
|
|
|
- this.clsi_request,
|
|
|
- 'e2',
|
|
|
- 'standard'
|
|
|
- )
|
|
|
- .should.equal(true)
|
|
|
+ describe('when there is no valid root document', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ this.project.rootDoc_id = 'not-valid'
|
|
|
+ this.ClsiManager.sendRequest(this.project._id, this.user_id, {}, done)
|
|
|
})
|
|
|
|
|
|
- it('should call the callback with the status and output files', function () {
|
|
|
- const outputFiles = [
|
|
|
- {
|
|
|
- url: `/project/${this.submission_id}/build/1234/output/output.pdf`,
|
|
|
- path: 'output.pdf',
|
|
|
- type: 'pdf',
|
|
|
- build: 1234,
|
|
|
- ranges: [],
|
|
|
- createdAt: new Date(),
|
|
|
- // gets dropped by JSON.stringify
|
|
|
- contentId: undefined,
|
|
|
- size: undefined,
|
|
|
- startXRefTable: undefined,
|
|
|
- },
|
|
|
- {
|
|
|
- url: `/project/${this.submission_id}/build/1234/output/output.log`,
|
|
|
- path: 'output.log',
|
|
|
- type: 'log',
|
|
|
- build: 1234,
|
|
|
- },
|
|
|
- ]
|
|
|
- this.callback.should.have.been.calledWith(
|
|
|
- null,
|
|
|
- this.status,
|
|
|
- outputFiles
|
|
|
+ it('should set to main.tex', function () {
|
|
|
+ expect(this.request).to.have.been.calledWith(
|
|
|
+ sinon.match(opts => opts.json.compile.rootResourcePath === 'main.tex')
|
|
|
)
|
|
|
})
|
|
|
})
|
|
|
|
|
|
- describe('with a failed compile', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager._postToClsi = sinon.stub().yields(null, {
|
|
|
- compile: {
|
|
|
- status: (this.status = 'failure'),
|
|
|
- },
|
|
|
- })
|
|
|
- this.ClsiManager.sendExternalRequest(
|
|
|
- this.submission_id,
|
|
|
- this.clsi_request,
|
|
|
+ describe('when there is no valid root document and no main.tex document', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ this.project.rootDoc_id = 'not-valid'
|
|
|
+ this.docs = {
|
|
|
+ '/other.tex': {
|
|
|
+ name: 'other.tex',
|
|
|
+ _id: 'mock-doc-id-1',
|
|
|
+ lines: ['Hello', 'world'],
|
|
|
+ },
|
|
|
+ '/chapters/chapter1.tex': {
|
|
|
+ name: 'chapter1.tex',
|
|
|
+ _id: 'mock-doc-id-2',
|
|
|
+ lines: ['Chapter 1'],
|
|
|
+ },
|
|
|
+ }
|
|
|
+ this.ProjectEntityHandler.getAllDocs.yields(null, this.docs)
|
|
|
+ this.ClsiManager.sendRequest(
|
|
|
+ this.project._id,
|
|
|
+ this.user_id,
|
|
|
{},
|
|
|
- this.callback
|
|
|
+ (err, status) => {
|
|
|
+ if (err) {
|
|
|
+ return done(err)
|
|
|
+ }
|
|
|
+ this.result = { status }
|
|
|
+ done()
|
|
|
+ }
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should call the callback with a failure status', function () {
|
|
|
- this.callback.calledWith(null, this.status).should.equal(true)
|
|
|
+ it('should report a validation problem', function () {
|
|
|
+ expect(this.result.status).to.equal('validation-problems')
|
|
|
})
|
|
|
})
|
|
|
|
|
|
- describe('when the resources fail the precompile check', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiFormatChecker.checkRecoursesForProblems = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(1, new Error('failed'))
|
|
|
- this.ClsiManager._postToClsi = sinon.stub().yields(null, {
|
|
|
- compile: {
|
|
|
- status: (this.status = 'failure'),
|
|
|
+ describe('when there is no valid root document and a single document which is not main.tex', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ this.project.rootDoc_id = 'not-valid'
|
|
|
+ this.docs = {
|
|
|
+ '/other.tex': {
|
|
|
+ name: 'other.tex',
|
|
|
+ _id: 'mock-doc-id-1',
|
|
|
+ lines: ['Hello', 'world'],
|
|
|
},
|
|
|
- })
|
|
|
- this.ClsiManager.sendExternalRequest(
|
|
|
- this.submission_id,
|
|
|
- this.clsi_request,
|
|
|
- {},
|
|
|
- this.callback
|
|
|
- )
|
|
|
- })
|
|
|
-
|
|
|
- it('should call the callback only once', function () {
|
|
|
- this.callback.calledOnce.should.equal(true)
|
|
|
+ }
|
|
|
+ this.ProjectEntityHandler.getAllDocs.yields(null, this.docs)
|
|
|
+ this.ClsiManager.sendRequest(this.project._id, this.user_id, {}, done)
|
|
|
})
|
|
|
|
|
|
- it('should call the callback with an error', function () {
|
|
|
- this.callback.should.have.been.calledWith(sinon.match.instanceOf(Error))
|
|
|
+ it('should set io to the only file', function () {
|
|
|
+ expect(this.request).to.have.been.calledWith(
|
|
|
+ sinon.match(
|
|
|
+ opts => opts.json.compile.rootResourcePath === 'other.tex'
|
|
|
+ )
|
|
|
+ )
|
|
|
})
|
|
|
})
|
|
|
- })
|
|
|
|
|
|
- describe('deleteAuxFiles', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager._makeRequestWithClsiServerId = sinon.stub().yields(null)
|
|
|
- this.DocumentUpdaterHandler.clearProjectState = sinon.stub().callsArg(1)
|
|
|
- })
|
|
|
-
|
|
|
- describe('with the standard compileGroup', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager.deleteAuxFiles(
|
|
|
- this.project_id,
|
|
|
+ describe('with the draft option', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ this.ClsiManager.sendRequest(
|
|
|
+ this.project._id,
|
|
|
this.user_id,
|
|
|
- { compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
- 'node-1',
|
|
|
- this.callback
|
|
|
+ { timeout: 100, draft: true },
|
|
|
+ done
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should call the delete method in the standard CLSI', function () {
|
|
|
- this.ClsiManager._makeRequestWithClsiServerId
|
|
|
- .calledWith(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- {
|
|
|
- method: 'DELETE',
|
|
|
- url: `${this.settings.apis.clsi.url}/project/${this.project_id}/user/${this.user_id}?compileBackendClass=e2&compileGroup=standard`,
|
|
|
- },
|
|
|
- 'node-1'
|
|
|
- )
|
|
|
- .should.equal(true)
|
|
|
- })
|
|
|
-
|
|
|
- it('should clear the project state from the docupdater', function () {
|
|
|
- this.DocumentUpdaterHandler.clearProjectState
|
|
|
- .calledWith(this.project_id)
|
|
|
- .should.equal(true)
|
|
|
+ it('should add the draft option into the request', function () {
|
|
|
+ expect(this.request).to.have.been.calledWith(
|
|
|
+ sinon.match(opts => opts.json.compile.options.draft === true)
|
|
|
+ )
|
|
|
})
|
|
|
+ })
|
|
|
|
|
|
- it('should clear the clsi persistance', function () {
|
|
|
- this.ClsiCookieManager.clearServerId
|
|
|
- .calledWith(this.project_id, this.user_id)
|
|
|
- .should.equal(true)
|
|
|
+ describe('with a failed compile', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ this.responseBody.compile.status = 'failure'
|
|
|
+ this.ClsiManager.sendRequest(
|
|
|
+ this.project._id,
|
|
|
+ this.user_id,
|
|
|
+ {},
|
|
|
+ (err, status) => {
|
|
|
+ if (err) {
|
|
|
+ return done(err)
|
|
|
+ }
|
|
|
+ this.result = { status }
|
|
|
+ done()
|
|
|
+ }
|
|
|
+ )
|
|
|
})
|
|
|
|
|
|
- it('should call the callback', function () {
|
|
|
- this.callback.called.should.equal(true)
|
|
|
+ it('should call the callback with a failure status', function () {
|
|
|
+ expect(this.result.status).to.equal('failure')
|
|
|
})
|
|
|
})
|
|
|
- })
|
|
|
-
|
|
|
- describe('_buildRequest', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.project = {
|
|
|
- _id: this.project_id,
|
|
|
- compiler: (this.compiler = 'latex'),
|
|
|
- rootDoc_id: 'mock-doc-id-1',
|
|
|
- imageName: (this.image = 'mock-image-name'),
|
|
|
- }
|
|
|
-
|
|
|
- this.docs = {
|
|
|
- '/main.tex': (this.doc_1 = {
|
|
|
- name: 'main.tex',
|
|
|
- _id: 'mock-doc-id-1',
|
|
|
- lines: ['Hello', 'world'],
|
|
|
- }),
|
|
|
- '/chapters/chapter1.tex': (this.doc_2 = {
|
|
|
- name: 'chapter1.tex',
|
|
|
- _id: 'mock-doc-id-2',
|
|
|
- lines: ['Chapter 1'],
|
|
|
- }),
|
|
|
- }
|
|
|
|
|
|
- this.files = {
|
|
|
- '/images/image.png': (this.file_1 = {
|
|
|
- name: 'image.png',
|
|
|
- _id: 'mock-file-id-1',
|
|
|
- created: new Date(),
|
|
|
- }),
|
|
|
- }
|
|
|
-
|
|
|
- this.Project.findById = sinon.stub().callsArgWith(2, null, this.project)
|
|
|
- this.ProjectEntityHandler.getAllDocs = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(1, null, this.docs)
|
|
|
- this.ProjectEntityHandler.getAllFiles = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(1, null, this.files)
|
|
|
- this.ProjectGetter.getProject = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(2, null, this.project)
|
|
|
- this.DocumentUpdaterHandler.flushProjectToMongo = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(1, null)
|
|
|
- })
|
|
|
-
|
|
|
- describe('with a valid project', function () {
|
|
|
+ describe('with a sync conflict', function () {
|
|
|
beforeEach(function (done) {
|
|
|
- this.ClsiManager._buildRequest(
|
|
|
- this.project_id,
|
|
|
- { timeout: 100, compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
- (err, request) => {
|
|
|
- if (err != null) {
|
|
|
+ this.request
|
|
|
+ .withArgs(
|
|
|
+ sinon.match(opts => opts.json.compile.options.syncType !== 'full')
|
|
|
+ )
|
|
|
+ .yields(null, this.response, {
|
|
|
+ compile: { status: 'conflict' },
|
|
|
+ })
|
|
|
+ this.ClsiManager.sendRequest(
|
|
|
+ this.project._id,
|
|
|
+ this.user_id,
|
|
|
+ {},
|
|
|
+ (err, status) => {
|
|
|
+ if (err) {
|
|
|
return done(err)
|
|
|
}
|
|
|
- this.request = request
|
|
|
+ this.result = { status }
|
|
|
done()
|
|
|
}
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should get the project with the required fields', function () {
|
|
|
- this.ProjectGetter.getProject
|
|
|
- .calledWith(this.project_id, {
|
|
|
- compiler: 1,
|
|
|
- rootDoc_id: 1,
|
|
|
- imageName: 1,
|
|
|
- rootFolder: 1,
|
|
|
- })
|
|
|
- .should.equal(true)
|
|
|
+ it('should send two requests to CLSI', function () {
|
|
|
+ this.request.should.have.been.calledTwice
|
|
|
})
|
|
|
|
|
|
- it('should flush the project to the database', function () {
|
|
|
- this.DocumentUpdaterHandler.flushProjectToMongo
|
|
|
- .calledWith(this.project_id)
|
|
|
- .should.equal(true)
|
|
|
+ it('should call the CLSI first without syncType:full', function () {
|
|
|
+ const compileOptions =
|
|
|
+ this.request.getCall(0).args[0].json.compile.options
|
|
|
+ expect(compileOptions.syncType).to.be.undefined
|
|
|
})
|
|
|
|
|
|
- it('should get all the docs', function () {
|
|
|
- this.ProjectEntityHandler.getAllDocs
|
|
|
- .calledWith(this.project_id)
|
|
|
- .should.equal(true)
|
|
|
+ it('should call the CLSI a second time with syncType:full', function () {
|
|
|
+ const compileOptions =
|
|
|
+ this.request.getCall(1).args[0].json.compile.options
|
|
|
+ expect(compileOptions.syncType).to.equal('full')
|
|
|
})
|
|
|
|
|
|
- it('should get all the files', function () {
|
|
|
- this.ProjectEntityHandler.getAllFiles
|
|
|
- .calledWith(this.project_id)
|
|
|
- .should.equal(true)
|
|
|
- })
|
|
|
-
|
|
|
- it('should build up the CLSI request', function () {
|
|
|
- expect(this.request).to.deep.equal({
|
|
|
- compile: {
|
|
|
- options: {
|
|
|
- compiler: this.compiler,
|
|
|
- timeout: 100,
|
|
|
- imageName: this.image,
|
|
|
- draft: false,
|
|
|
- check: undefined,
|
|
|
- syncType: undefined, // "full"
|
|
|
- syncState: undefined,
|
|
|
- compileGroup: 'standard',
|
|
|
- enablePdfCaching: false,
|
|
|
- pdfCachingMinChunkSize: undefined,
|
|
|
- flags: undefined,
|
|
|
- metricsMethod: 'standard',
|
|
|
- stopOnFirstError: false,
|
|
|
- }, // "01234567890abcdef"
|
|
|
- rootResourcePath: 'main.tex',
|
|
|
- resources: [
|
|
|
- {
|
|
|
- path: 'main.tex',
|
|
|
- content: this.doc_1.lines.join('\n'),
|
|
|
- },
|
|
|
- {
|
|
|
- path: 'chapters/chapter1.tex',
|
|
|
- content: this.doc_2.lines.join('\n'),
|
|
|
- },
|
|
|
- {
|
|
|
- path: 'images/image.png',
|
|
|
- url: `${this.settings.apis.filestore.url}/project/${this.project_id}/file/${this.file_1._id}`,
|
|
|
- modified: this.file_1.created.getTime(),
|
|
|
- },
|
|
|
- ],
|
|
|
- },
|
|
|
- })
|
|
|
+ it('should call the callback with a success status', function () {
|
|
|
+ this.result.status.should.equal('success')
|
|
|
})
|
|
|
})
|
|
|
|
|
|
- describe('with the incremental compile option', function () {
|
|
|
+ describe('with an unavailable response', function () {
|
|
|
beforeEach(function (done) {
|
|
|
- this.project_state_hash = '01234567890abcdef'
|
|
|
- this.ClsiStateManager.computeHash = sinon
|
|
|
- .stub()
|
|
|
- .returns(this.project_state_hash)
|
|
|
- this.DocumentUpdaterHandler.getProjectDocsIfMatch = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(2, null, [
|
|
|
- { _id: this.doc_1._id, lines: this.doc_1.lines, v: 123 },
|
|
|
- ])
|
|
|
- this.ProjectEntityHandler.getAllDocPathsFromProject = sinon
|
|
|
- .stub()
|
|
|
- .returns({ 'mock-doc-id-1': 'main.tex' })
|
|
|
- this.ClsiManager._buildRequest(
|
|
|
- this.project_id,
|
|
|
- {
|
|
|
- timeout: 100,
|
|
|
- incrementalCompilesEnabled: true,
|
|
|
- compileGroup: 'priority',
|
|
|
- enablePdfCaching: true,
|
|
|
- pdfCachingMinChunkSize: 1337,
|
|
|
- },
|
|
|
- (err, request) => {
|
|
|
- if (err != null) {
|
|
|
+ this.request.onCall(0).yields(null, this.response, {
|
|
|
+ compile: { status: 'unavailable' },
|
|
|
+ })
|
|
|
+ this.ClsiManager.sendRequest(
|
|
|
+ this.project._id,
|
|
|
+ this.user_id,
|
|
|
+ {},
|
|
|
+ (err, status) => {
|
|
|
+ if (err) {
|
|
|
return done(err)
|
|
|
}
|
|
|
- this.request = request
|
|
|
+ this.result = { status }
|
|
|
done()
|
|
|
}
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should get the project with the required fields', function () {
|
|
|
- this.ProjectGetter.getProject
|
|
|
- .calledWith(this.project_id, {
|
|
|
- compiler: 1,
|
|
|
- rootDoc_id: 1,
|
|
|
- imageName: 1,
|
|
|
- rootFolder: 1,
|
|
|
- })
|
|
|
- .should.equal(true)
|
|
|
+ it('should send two requests to CLSI', function () {
|
|
|
+ this.request.should.have.been.calledTwice
|
|
|
})
|
|
|
|
|
|
- it('should not explicitly flush the project to the database', function () {
|
|
|
- this.DocumentUpdaterHandler.flushProjectToMongo
|
|
|
- .calledWith(this.project_id)
|
|
|
- .should.equal(false)
|
|
|
+ it('should call the CLSI first without syncType:full', function () {
|
|
|
+ const compileOptions =
|
|
|
+ this.request.getCall(0).args[0].json.compile.options
|
|
|
+ expect(compileOptions.syncType).to.be.undefined
|
|
|
})
|
|
|
|
|
|
- it('should get only the live docs from the docupdater with a background flush in docupdater', function () {
|
|
|
- this.DocumentUpdaterHandler.getProjectDocsIfMatch
|
|
|
- .calledWith(this.project_id)
|
|
|
- .should.equal(true)
|
|
|
+ it('should call the CLSI a second time with syncType:full', function () {
|
|
|
+ const compileOptions =
|
|
|
+ this.request.getCall(1).args[0].json.compile.options
|
|
|
+ expect(compileOptions.syncType).to.equal('full')
|
|
|
})
|
|
|
|
|
|
- it('should not get any of the files', function () {
|
|
|
- this.ProjectEntityHandler.getAllFiles.called.should.equal(false)
|
|
|
+ it('should clear the CLSI server id cookie', function () {
|
|
|
+ expect(this.ClsiCookieManager.clearServerId).to.have.been.calledWith(
|
|
|
+ this.project._id,
|
|
|
+ this.user_id
|
|
|
+ )
|
|
|
})
|
|
|
|
|
|
- it('should build up the CLSI request', function () {
|
|
|
- expect(this.request).to.deep.equal({
|
|
|
- compile: {
|
|
|
- options: {
|
|
|
- compiler: this.compiler,
|
|
|
- timeout: 100,
|
|
|
- imageName: this.image,
|
|
|
- draft: false,
|
|
|
- check: undefined,
|
|
|
- syncType: 'incremental',
|
|
|
- syncState: '01234567890abcdef',
|
|
|
- compileGroup: 'priority',
|
|
|
- enablePdfCaching: true,
|
|
|
- pdfCachingMinChunkSize: 1337,
|
|
|
- flags: undefined,
|
|
|
- metricsMethod: 'priority',
|
|
|
- stopOnFirstError: false,
|
|
|
- },
|
|
|
- rootResourcePath: 'main.tex',
|
|
|
- resources: [
|
|
|
- {
|
|
|
- path: 'main.tex',
|
|
|
- content: this.doc_1.lines.join('\n'),
|
|
|
- },
|
|
|
- ],
|
|
|
- },
|
|
|
- })
|
|
|
+ it('should call the callback with a success status', function () {
|
|
|
+ expect(this.result.status).to.equal('success')
|
|
|
})
|
|
|
+ })
|
|
|
|
|
|
- describe('when the root doc is set and not in the docupdater', function () {
|
|
|
- beforeEach(function (done) {
|
|
|
- this.project_state_hash = '01234567890abcdef'
|
|
|
- this.ClsiStateManager.computeHash = sinon
|
|
|
- .stub()
|
|
|
- .returns(this.project_state_hash)
|
|
|
- this.DocumentUpdaterHandler.getProjectDocsIfMatch = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(2, null, [
|
|
|
- { _id: this.doc_1._id, lines: this.doc_1.lines, v: 123 },
|
|
|
- ])
|
|
|
- this.ProjectEntityHandler.getAllDocPathsFromProject = sinon
|
|
|
- .stub()
|
|
|
- .returns({
|
|
|
- 'mock-doc-id-1': 'main.tex',
|
|
|
- 'mock-doc-id-2': '/chapters/chapter1.tex',
|
|
|
- })
|
|
|
- this.ClsiManager._buildRequest(
|
|
|
- this.project_id,
|
|
|
- {
|
|
|
- timeout: 100,
|
|
|
- incrementalCompilesEnabled: true,
|
|
|
- rootDoc_id: 'mock-doc-id-2',
|
|
|
- },
|
|
|
- (err, request) => {
|
|
|
- if (err != null) {
|
|
|
- return done(err)
|
|
|
- }
|
|
|
- this.request = request
|
|
|
- done()
|
|
|
- }
|
|
|
- )
|
|
|
- })
|
|
|
+ describe('when the resources fail the precompile check', function () {
|
|
|
+ beforeEach(function () {
|
|
|
+ this.ClsiFormatChecker.checkRecoursesForProblems.yields(
|
|
|
+ new Error('failed')
|
|
|
+ )
|
|
|
+ this.ClsiManager.sendRequest(
|
|
|
+ this.project._id,
|
|
|
+ this.user_id,
|
|
|
+ {},
|
|
|
+ this.callback
|
|
|
+ )
|
|
|
+ })
|
|
|
|
|
|
- it('should still change the root path', function () {
|
|
|
- this.request.compile.rootResourcePath.should.equal(
|
|
|
- 'chapters/chapter1.tex'
|
|
|
- )
|
|
|
- })
|
|
|
+ it('should call the callback only once', function () {
|
|
|
+ this.callback.calledOnce.should.equal(true)
|
|
|
+ })
|
|
|
+
|
|
|
+ it('should call the callback with an error', function () {
|
|
|
+ this.callback.should.have.been.calledWith(sinon.match.instanceOf(Error))
|
|
|
})
|
|
|
})
|
|
|
|
|
|
- describe('when root doc override is valid', function () {
|
|
|
+ describe('when a new backend is configured', function () {
|
|
|
beforeEach(function (done) {
|
|
|
- this.ClsiManager._buildRequest(
|
|
|
- this.project_id,
|
|
|
- { rootDoc_id: 'mock-doc-id-2' },
|
|
|
- (err, request) => {
|
|
|
- if (err != null) {
|
|
|
+ this.settings.apis.clsi_new = { url: 'https://compiles.somewhere.test' }
|
|
|
+ this.ClsiManager.sendRequest(
|
|
|
+ this.project._id,
|
|
|
+ this.user_id,
|
|
|
+ { compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
+ err => {
|
|
|
+ if (err) {
|
|
|
return done(err)
|
|
|
}
|
|
|
- this.request = request
|
|
|
- done()
|
|
|
+ // wait for the background task to finish
|
|
|
+ setTimeout(done, 0)
|
|
|
}
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should change root path', function () {
|
|
|
- this.request.compile.rootResourcePath.should.equal(
|
|
|
- 'chapters/chapter1.tex'
|
|
|
+ it('makes a request to the new backend', function () {
|
|
|
+ expect(this.request).to.have.been.calledTwice
|
|
|
+ expect(this.request).to.have.been.calledWith(
|
|
|
+ sinon.match({
|
|
|
+ url: `${CLSI_URL}/project/${this.project._id}/user/${this.user_id}/compile?compileBackendClass=e2&compileGroup=standard`,
|
|
|
+ })
|
|
|
+ )
|
|
|
+ expect(this.request).to.have.been.calledWith(
|
|
|
+ sinon.match({
|
|
|
+ url: `${this.settings.apis.clsi_new.url}/project/${this.project._id}/user/${this.user_id}/compile?compileBackendClass=e2&compileGroup=standard`,
|
|
|
+ })
|
|
|
)
|
|
|
})
|
|
|
})
|
|
|
+ })
|
|
|
|
|
|
- describe('when root doc override is invalid', function () {
|
|
|
+ describe('sendExternalRequest', function () {
|
|
|
+ beforeEach(function () {
|
|
|
+ this.submissionId = 'submission-id'
|
|
|
+ this.clsiRequest = 'mock-request'
|
|
|
+ this.ClsiCookieManager.getCookieJar.yields(null, this.jar, 'clsi3')
|
|
|
+ })
|
|
|
+
|
|
|
+ describe('with a successful compile', function () {
|
|
|
beforeEach(function (done) {
|
|
|
- this.ClsiManager._buildRequest(
|
|
|
- this.project_id,
|
|
|
- { rootDoc_id: 'invalid-id' },
|
|
|
- (err, request) => {
|
|
|
- if (err != null) {
|
|
|
+ this.outputFiles = [
|
|
|
+ {
|
|
|
+ url: `/project/${this.submissionId}/build/1234/output/output.pdf`,
|
|
|
+ path: 'output.pdf',
|
|
|
+ type: 'pdf',
|
|
|
+ build: 1234,
|
|
|
+ },
|
|
|
+ {
|
|
|
+ url: `/project/${this.submissionId}/build/1234/output/output.log`,
|
|
|
+ path: 'output.log',
|
|
|
+ type: 'log',
|
|
|
+ build: 1234,
|
|
|
+ },
|
|
|
+ ]
|
|
|
+ this.responseBody.compile.outputFiles = this.outputFiles.map(
|
|
|
+ outputFile => ({ ...outputFile, url: CLSI_URL + outputFile.url })
|
|
|
+ )
|
|
|
+ this.ClsiManager.sendExternalRequest(
|
|
|
+ this.submissionId,
|
|
|
+ this.clsiRequest,
|
|
|
+ { compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
+ (err, status, outputFiles) => {
|
|
|
+ if (err) {
|
|
|
return done(err)
|
|
|
}
|
|
|
- this.request = request
|
|
|
+ this.result = { status, outputFiles }
|
|
|
done()
|
|
|
}
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should fallback to default root doc', function () {
|
|
|
- this.request.compile.rootResourcePath.should.equal('main.tex')
|
|
|
- })
|
|
|
- })
|
|
|
-
|
|
|
- describe('when the project has an invalid compiler', function () {
|
|
|
- beforeEach(function (done) {
|
|
|
- this.project.compiler = 'context'
|
|
|
- this.ClsiManager._buildRequest(this.project, null, (err, request) => {
|
|
|
- if (err != null) {
|
|
|
- return done(err)
|
|
|
- }
|
|
|
- this.request = request
|
|
|
- done()
|
|
|
+ it('should send the request to the CLSI', function () {
|
|
|
+ this.request.should.have.been.calledWith({
|
|
|
+ url: `${CLSI_URL}/project/${this.submissionId}/compile?compileBackendClass=e2&compileGroup=standard`,
|
|
|
+ method: 'POST',
|
|
|
+ json: this.clsiRequest,
|
|
|
+ jar: this.jar,
|
|
|
})
|
|
|
})
|
|
|
|
|
|
- it('should set the compiler to pdflatex', function () {
|
|
|
- this.request.compile.options.compiler.should.equal('pdflatex')
|
|
|
+ it('should call the callback with the status and output files', function () {
|
|
|
+ expect(this.result.status).to.equal('success')
|
|
|
+ expect(this.result.outputFiles.map(f => f.path)).to.have.members(
|
|
|
+ this.outputFiles.map(f => f.path)
|
|
|
+ )
|
|
|
})
|
|
|
})
|
|
|
|
|
|
- describe('when there is no valid root document', function () {
|
|
|
+ describe('with a failed compile', function () {
|
|
|
beforeEach(function (done) {
|
|
|
- this.project.rootDoc_id = 'not-valid'
|
|
|
- this.ClsiManager._buildRequest(this.project, null, (error, request) => {
|
|
|
- this.error = error
|
|
|
- this.request = request
|
|
|
- done()
|
|
|
- })
|
|
|
- })
|
|
|
-
|
|
|
- it('should set to main.tex', function () {
|
|
|
- this.request.compile.rootResourcePath.should.equal('main.tex')
|
|
|
- })
|
|
|
- })
|
|
|
-
|
|
|
- describe('when there is no valid root document and no main.tex document', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.project.rootDoc_id = 'not-valid'
|
|
|
- this.docs = {
|
|
|
- '/other.tex': (this.doc_1 = {
|
|
|
- name: 'other.tex',
|
|
|
- _id: 'mock-doc-id-1',
|
|
|
- lines: ['Hello', 'world'],
|
|
|
- }),
|
|
|
- '/chapters/chapter1.tex': (this.doc_2 = {
|
|
|
- name: 'chapter1.tex',
|
|
|
- _id: 'mock-doc-id-2',
|
|
|
- lines: ['Chapter 1'],
|
|
|
- }),
|
|
|
- }
|
|
|
- this.ProjectEntityHandler.getAllDocs = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(1, null, this.docs)
|
|
|
- this.ClsiManager._buildRequest(this.project, null, this.callback)
|
|
|
+ this.responseBody.compile.status = 'failure'
|
|
|
+ this.ClsiManager.sendExternalRequest(
|
|
|
+ this.submissionId,
|
|
|
+ this.clsiRequest,
|
|
|
+ {},
|
|
|
+ (err, status) => {
|
|
|
+ if (err) {
|
|
|
+ return done(err)
|
|
|
+ }
|
|
|
+ this.result = { status }
|
|
|
+ done()
|
|
|
+ }
|
|
|
+ )
|
|
|
})
|
|
|
|
|
|
- it('should report an error', function () {
|
|
|
- this.callback.should.have.been.calledWith(sinon.match.instanceOf(Error))
|
|
|
+ it('should call the callback with a failure status', function () {
|
|
|
+ expect(this.result.status).to.equal('failure')
|
|
|
})
|
|
|
})
|
|
|
|
|
|
- describe('when there is no valid root document and a single document which is not main.tex', function () {
|
|
|
+ describe('when the resources fail the precompile check', function () {
|
|
|
beforeEach(function (done) {
|
|
|
- this.project.rootDoc_id = 'not-valid'
|
|
|
- this.docs = {
|
|
|
- '/other.tex': (this.doc_1 = {
|
|
|
- name: 'other.tex',
|
|
|
- _id: 'mock-doc-id-1',
|
|
|
- lines: ['Hello', 'world'],
|
|
|
- }),
|
|
|
- }
|
|
|
- this.ProjectEntityHandler.getAllDocs = sinon
|
|
|
- .stub()
|
|
|
- .callsArgWith(1, null, this.docs)
|
|
|
- this.ClsiManager._buildRequest(this.project, null, (error, request) => {
|
|
|
- this.error = error
|
|
|
- this.request = request
|
|
|
- done()
|
|
|
- })
|
|
|
- })
|
|
|
-
|
|
|
- it('should set io to the only file', function () {
|
|
|
- this.request.compile.rootResourcePath.should.equal('other.tex')
|
|
|
- })
|
|
|
- })
|
|
|
-
|
|
|
- describe('with the draft option', function () {
|
|
|
- it('should add the draft option into the request', function (done) {
|
|
|
- this.ClsiManager._buildRequest(
|
|
|
- this.project_id,
|
|
|
- { timeout: 100, draft: true },
|
|
|
- (err, request) => {
|
|
|
- if (err != null) {
|
|
|
- return done(err)
|
|
|
- }
|
|
|
- request.compile.options.draft.should.equal(true)
|
|
|
+ this.ClsiFormatChecker.checkRecoursesForProblems.yields(
|
|
|
+ new Error('failed')
|
|
|
+ )
|
|
|
+ this.responseBody.compile.status = 'failure'
|
|
|
+ this.ClsiManager.sendExternalRequest(
|
|
|
+ this.submissionId,
|
|
|
+ this.clsiRequest,
|
|
|
+ {},
|
|
|
+ err => {
|
|
|
+ this.err = err
|
|
|
done()
|
|
|
}
|
|
|
)
|
|
|
})
|
|
|
- })
|
|
|
- })
|
|
|
|
|
|
- describe('_postToClsi', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.req = { mock: 'req', compile: {} }
|
|
|
+ it('should call the callback with an error', function () {
|
|
|
+ expect(this.err).to.be.instanceof(Error)
|
|
|
+ })
|
|
|
})
|
|
|
+ })
|
|
|
|
|
|
- describe('successfully', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager._makeRequest = sinon
|
|
|
- .stub()
|
|
|
- .yields(null, { statusCode: 204 }, (this.body = { mock: 'foo' }))
|
|
|
- this.ClsiManager._postToClsi(
|
|
|
- this.project_id,
|
|
|
+ describe('deleteAuxFiles', function () {
|
|
|
+ describe('with the standard compileGroup', function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
+ this.ClsiManager.deleteAuxFiles(
|
|
|
+ this.project._id,
|
|
|
this.user_id,
|
|
|
- this.req,
|
|
|
- 'e2',
|
|
|
- 'standard',
|
|
|
- this.callback
|
|
|
+ { compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
+ 'node-1',
|
|
|
+ done
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should send the request to the CLSI', function () {
|
|
|
- const url = `${this.settings.apis.clsi.url}/project/${this.project_id}/user/${this.user_id}/compile?compileBackendClass=e2&compileGroup=standard`
|
|
|
- this.ClsiManager._makeRequest
|
|
|
- .calledWith(this.project_id, this.user_id, 'standard', 'e2', {
|
|
|
- method: 'POST',
|
|
|
- url,
|
|
|
- json: this.req,
|
|
|
- })
|
|
|
+ it('should call the delete method in the standard CLSI', function () {
|
|
|
+ this.request.should.have.been.calledWith({
|
|
|
+ url: `${CLSI_URL}/project/${this.project._id}/user/${this.user_id}?compileBackendClass=e2&compileGroup=standard`,
|
|
|
+ method: 'DELETE',
|
|
|
+ qs: {
|
|
|
+ compileGroup: 'standard',
|
|
|
+ compileBackendClass: 'e2',
|
|
|
+ clsiserverid: 'node-1',
|
|
|
+ },
|
|
|
+ })
|
|
|
+ })
|
|
|
+
|
|
|
+ it('should clear the project state from the docupdater', function () {
|
|
|
+ this.DocumentUpdaterHandler.clearProjectState
|
|
|
+ .calledWith(this.project._id)
|
|
|
.should.equal(true)
|
|
|
})
|
|
|
|
|
|
- it('should call the callback with the body and no error', function () {
|
|
|
- this.callback.calledWith(null, this.body).should.equal(true)
|
|
|
+ it('should clear the clsi persistance', function () {
|
|
|
+ this.ClsiCookieManager.clearServerId
|
|
|
+ .calledWith(this.project._id, this.user_id)
|
|
|
+ .should.equal(true)
|
|
|
})
|
|
|
- })
|
|
|
|
|
|
- describe('when the CLSI returns an error', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager._makeRequest = sinon
|
|
|
- .stub()
|
|
|
- .yields(null, { statusCode: 500 }, (this.body = { mock: 'foo' }))
|
|
|
- this.ClsiManager._postToClsi(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- this.req,
|
|
|
- 'e2',
|
|
|
- 'standard',
|
|
|
- this.callback
|
|
|
+ it('should not add a cookie jar', function () {
|
|
|
+ expect(this.request).to.have.been.calledWith(
|
|
|
+ sinon.match(opts => opts.jar == null)
|
|
|
)
|
|
|
})
|
|
|
|
|
|
- it('should call the callback with an error', function () {
|
|
|
- this.callback.should.have.been.calledWith(sinon.match.instanceOf(Error))
|
|
|
+ it('should not persist a cookie on response', function () {
|
|
|
+ expect(this.ClsiCookieManager.setServerId).not.to.have.been.called
|
|
|
})
|
|
|
})
|
|
|
})
|
|
|
|
|
|
describe('wordCount', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.ClsiManager._makeRequestWithClsiServerId = sinon
|
|
|
- .stub()
|
|
|
- .yields(null, { statusCode: 200 }, (this.body = { mock: 'foo' }))
|
|
|
- this.ClsiManager._buildRequest = sinon.stub().yields(
|
|
|
- null,
|
|
|
- (this.req = {
|
|
|
- compile: { rootResourcePath: 'rootfile.text', options: {} },
|
|
|
- })
|
|
|
- )
|
|
|
- })
|
|
|
-
|
|
|
describe('with root file', function () {
|
|
|
- beforeEach(function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
this.ClsiManager.wordCount(
|
|
|
- this.project_id,
|
|
|
+ this.project._id,
|
|
|
this.user_id,
|
|
|
false,
|
|
|
{ compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
'node-1',
|
|
|
- this.callback
|
|
|
+ done
|
|
|
)
|
|
|
})
|
|
|
|
|
|
it('should call wordCount with root file', function () {
|
|
|
- this.ClsiManager._makeRequestWithClsiServerId
|
|
|
- .calledWith(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- {
|
|
|
- method: 'GET',
|
|
|
- url: `http://clsi.example.com/project/${this.project_id}/user/${this.user_id}/wordcount?compileBackendClass=e2&compileGroup=standard`,
|
|
|
- qs: {
|
|
|
- file: 'rootfile.text',
|
|
|
- image: undefined,
|
|
|
- },
|
|
|
- json: true,
|
|
|
- },
|
|
|
- 'node-1'
|
|
|
- )
|
|
|
- .should.equal(true)
|
|
|
+ expect(this.request).to.have.been.calledWith({
|
|
|
+ url: `http://clsi.example.com/project/${this.project._id}/user/${this.user_id}/wordcount?compileBackendClass=e2&compileGroup=standard`,
|
|
|
+ method: 'GET',
|
|
|
+ qs: {
|
|
|
+ compileGroup: 'standard',
|
|
|
+ compileBackendClass: 'e2',
|
|
|
+ clsiserverid: 'node-1',
|
|
|
+ file: 'main.tex',
|
|
|
+ image: 'mock-image-name',
|
|
|
+ },
|
|
|
+ json: true,
|
|
|
+ })
|
|
|
})
|
|
|
|
|
|
- it('should call the callback', function () {
|
|
|
- this.callback.called.should.equal(true)
|
|
|
+ it('should not persist a cookie on response', function () {
|
|
|
+ expect(this.ClsiCookieManager.setServerId).not.to.have.been.called
|
|
|
})
|
|
|
})
|
|
|
|
|
|
describe('with param file', function () {
|
|
|
- beforeEach(function () {
|
|
|
+ beforeEach(function (done) {
|
|
|
this.ClsiManager.wordCount(
|
|
|
- this.project_id,
|
|
|
+ this.project._id,
|
|
|
this.user_id,
|
|
|
- 'main.tex',
|
|
|
+ 'other.tex',
|
|
|
{ compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
'node-2',
|
|
|
- this.callback
|
|
|
+ done
|
|
|
)
|
|
|
})
|
|
|
|
|
|
it('should call wordCount with param file', function () {
|
|
|
- this.ClsiManager._makeRequestWithClsiServerId
|
|
|
- .calledWith(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- {
|
|
|
- method: 'GET',
|
|
|
- url: `http://clsi.example.com/project/${this.project_id}/user/${this.user_id}/wordcount?compileBackendClass=e2&compileGroup=standard`,
|
|
|
- qs: { file: 'main.tex', image: undefined },
|
|
|
- json: true,
|
|
|
- },
|
|
|
- 'node-2'
|
|
|
- )
|
|
|
- .should.equal(true)
|
|
|
- })
|
|
|
- })
|
|
|
-
|
|
|
- describe('with image', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.req.compile.options.imageName = this.image =
|
|
|
- 'example.com/mock/image'
|
|
|
- this.ClsiManager.wordCount(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'main.tex',
|
|
|
- { compileBackendClass: 'e2', compileGroup: 'standard' },
|
|
|
- 'node-3',
|
|
|
- this.callback
|
|
|
- )
|
|
|
- })
|
|
|
-
|
|
|
- it('should call wordCount with file and image', function () {
|
|
|
- this.ClsiManager._makeRequestWithClsiServerId
|
|
|
- .calledWith(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- {
|
|
|
- method: 'GET',
|
|
|
- url: `http://clsi.example.com/project/${this.project_id}/user/${this.user_id}/wordcount?compileBackendClass=e2&compileGroup=standard`,
|
|
|
- qs: { file: 'main.tex', image: this.image },
|
|
|
- json: true,
|
|
|
- },
|
|
|
- 'node-3'
|
|
|
- )
|
|
|
- .should.equal(true)
|
|
|
- })
|
|
|
- })
|
|
|
- })
|
|
|
-
|
|
|
- describe('_makeRequest', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.response = { there: 'something' }
|
|
|
- this.request.callsArgWith(1, null, this.response)
|
|
|
- this.opts = {
|
|
|
- method: 'SOMETHIGN',
|
|
|
- url: 'http://a place on the web',
|
|
|
- }
|
|
|
- })
|
|
|
-
|
|
|
- it('should process a request with a cookie jar', function (done) {
|
|
|
- this.ClsiManager._makeRequest(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- this.opts,
|
|
|
- () => {
|
|
|
- const args = this.request.args[0]
|
|
|
- args[0].method.should.equal(this.opts.method)
|
|
|
- args[0].url.should.equal(this.opts.url)
|
|
|
- args[0].jar.should.equal(this.jar)
|
|
|
- done()
|
|
|
- }
|
|
|
- )
|
|
|
- })
|
|
|
-
|
|
|
- it('should set the cookie again on response as it might have changed', function (done) {
|
|
|
- this.ClsiManager._makeRequest(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- this.opts,
|
|
|
- () => {
|
|
|
- this.ClsiCookieManager.setServerId
|
|
|
- .calledWith(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- this.response
|
|
|
- )
|
|
|
- .should.equal(true)
|
|
|
- done()
|
|
|
- }
|
|
|
- )
|
|
|
- })
|
|
|
- })
|
|
|
-
|
|
|
- describe('_makeRequestWithClsiServerId', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.response = { statusCode: 200 }
|
|
|
- this.request.yields(null, this.response)
|
|
|
- this.opts = {
|
|
|
- method: 'GET',
|
|
|
- url: 'http://clsi',
|
|
|
- }
|
|
|
- })
|
|
|
-
|
|
|
- describe('with a regular request', function () {
|
|
|
- it('should process a request with a cookie jar', function (done) {
|
|
|
- this.ClsiManager._makeRequestWithClsiServerId(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- this.opts,
|
|
|
- undefined,
|
|
|
- err => {
|
|
|
- if (err) return done(err)
|
|
|
- const args = this.request.args[0]
|
|
|
- args[0].method.should.equal(this.opts.method)
|
|
|
- args[0].url.should.equal(this.opts.url)
|
|
|
- args[0].jar.should.equal(this.jar)
|
|
|
- expect(args[0].qs).to.not.exist
|
|
|
- done()
|
|
|
- }
|
|
|
- )
|
|
|
- })
|
|
|
-
|
|
|
- it('should persist the cookie from the response', function (done) {
|
|
|
- this.ClsiManager._makeRequestWithClsiServerId(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- this.opts,
|
|
|
- undefined,
|
|
|
- err => {
|
|
|
- if (err) return done(err)
|
|
|
- this.ClsiCookieManager.setServerId
|
|
|
- .calledWith(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- this.response
|
|
|
- )
|
|
|
- .should.equal(true)
|
|
|
- done()
|
|
|
- }
|
|
|
- )
|
|
|
- })
|
|
|
- })
|
|
|
-
|
|
|
- describe('with a persistent request', function () {
|
|
|
- it('should not add a cookie jar', function (done) {
|
|
|
- this.ClsiManager._makeRequestWithClsiServerId(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- this.opts,
|
|
|
- 'node-1',
|
|
|
- err => {
|
|
|
- if (err) return done(err)
|
|
|
- const requestOpts = this.request.args[0][0]
|
|
|
- expect(requestOpts.method).to.equal(this.opts.method)
|
|
|
- expect(requestOpts.url).to.equal(this.opts.url)
|
|
|
- expect(requestOpts.jar).to.not.exist
|
|
|
- expect(requestOpts.qs).to.deep.equal({
|
|
|
- clsiserverid: 'node-1',
|
|
|
- compileGroup: 'standard',
|
|
|
- compileBackendClass: 'e2',
|
|
|
- })
|
|
|
- done()
|
|
|
- }
|
|
|
- )
|
|
|
+ expect(this.request).to.have.been.calledWith({
|
|
|
+ url: `http://clsi.example.com/project/${this.project._id}/user/${this.user_id}/wordcount?compileBackendClass=e2&compileGroup=standard`,
|
|
|
+ method: 'GET',
|
|
|
+ qs: {
|
|
|
+ compileGroup: 'standard',
|
|
|
+ compileBackendClass: 'e2',
|
|
|
+ clsiserverid: 'node-2',
|
|
|
+ file: 'other.tex',
|
|
|
+ image: 'mock-image-name',
|
|
|
+ },
|
|
|
+ json: true,
|
|
|
+ })
|
|
|
})
|
|
|
|
|
|
- it('should not persist a cookie on response', function (done) {
|
|
|
- this.ClsiManager._makeRequestWithClsiServerId(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- this.opts,
|
|
|
- 'node-1',
|
|
|
- err => {
|
|
|
- if (err) return done(err)
|
|
|
- expect(this.ClsiCookieManager.setServerId.called).to.equal(false)
|
|
|
- done()
|
|
|
- }
|
|
|
- )
|
|
|
+ it('should not persist a cookie on response', function () {
|
|
|
+ expect(this.ClsiCookieManager.setServerId).not.to.have.been.called
|
|
|
})
|
|
|
})
|
|
|
})
|
|
|
-
|
|
|
- describe('_makeGoogleCloudRequest', function () {
|
|
|
- beforeEach(function () {
|
|
|
- this.settings.apis.clsi_new = { url: 'https://compiles.somewhere.test' }
|
|
|
- this.response = { there: 'something' }
|
|
|
- this.request.callsArgWith(1, null, this.response)
|
|
|
- this.opts = {
|
|
|
- url: this.ClsiManager._getCompilerUrl(
|
|
|
- 'e2',
|
|
|
- 'standard',
|
|
|
- this.project_id
|
|
|
- ),
|
|
|
- }
|
|
|
- })
|
|
|
-
|
|
|
- it('should change the domain on the url', function (done) {
|
|
|
- this.ClsiManager._makeNewBackendRequest(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- this.opts,
|
|
|
- () => {
|
|
|
- const args = this.request.args[0]
|
|
|
- args[0].url.should.equal(
|
|
|
- `https://compiles.somewhere.test/project/${this.project_id}?compileBackendClass=e2&compileGroup=standard`
|
|
|
- )
|
|
|
- done()
|
|
|
- }
|
|
|
- )
|
|
|
- })
|
|
|
-
|
|
|
- it('should not make a request if there is not clsi_new url', function (done) {
|
|
|
- this.settings.apis.clsi_new = undefined
|
|
|
- this.ClsiManager._makeNewBackendRequest(
|
|
|
- this.project_id,
|
|
|
- this.user_id,
|
|
|
- 'standard',
|
|
|
- 'e2',
|
|
|
- this.opts,
|
|
|
- err => {
|
|
|
- expect(err).to.equal(undefined)
|
|
|
- this.request.callCount.should.equal(0)
|
|
|
- done()
|
|
|
- }
|
|
|
- )
|
|
|
- })
|
|
|
- })
|
|
|
})
|
|
|
+
|
|
|
+function _makeResources(project, docs, files) {
|
|
|
+ const resources = []
|
|
|
+ for (const [path, doc] of Object.entries(docs)) {
|
|
|
+ resources.push({
|
|
|
+ path: path.replace(/^\//, ''),
|
|
|
+ content: doc.lines.join('\n'),
|
|
|
+ })
|
|
|
+ }
|
|
|
+ for (const [path, file] of Object.entries(files)) {
|
|
|
+ resources.push({
|
|
|
+ path: path.replace(/^\//, ''),
|
|
|
+ url: `${FILESTORE_URL}/project/${project._id}/file/${file._id}`,
|
|
|
+ modified: file.created.getTime(),
|
|
|
+ })
|
|
|
+ }
|
|
|
+ return resources
|
|
|
+}
|