mirror of
https://github.com/overleaf/overleaf.git
synced 2024-09-23 02:55:13 -04:00
4d70bd664f
These changes were previously merged, not deployed, and reverted. This reverts the revert. This reverts commit a6b8c6c658b33b6eee78b8b99e43308f32211ae2, reversing changes made to 93c98921372eed4244d22fce800716cb27eca299.
473 lines
13 KiB
JavaScript
473 lines
13 KiB
JavaScript
const sinon = require('sinon')
|
|
const { expect } = require('chai')
|
|
const Settings = require('settings-sharelatex')
|
|
const docUpdaterRedis = require('@overleaf/redis-wrapper').createClient(
|
|
Settings.redis.documentupdater
|
|
)
|
|
const Keys = Settings.redis.documentupdater.key_schema
|
|
|
|
const MockTrackChangesApi = require('./helpers/MockTrackChangesApi')
|
|
const MockProjectHistoryApi = require('./helpers/MockProjectHistoryApi')
|
|
const MockWebApi = require('./helpers/MockWebApi')
|
|
const DocUpdaterClient = require('./helpers/DocUpdaterClient')
|
|
const DocUpdaterApp = require('./helpers/DocUpdaterApp')
|
|
|
|
describe('Setting a document', function () {
|
|
before(function (done) {
|
|
this.lines = ['one', 'two', 'three']
|
|
this.version = 42
|
|
this.update = {
|
|
doc: this.doc_id,
|
|
op: [
|
|
{
|
|
i: 'one and a half\n',
|
|
p: 4
|
|
}
|
|
],
|
|
v: this.version
|
|
}
|
|
this.result = ['one', 'one and a half', 'two', 'three']
|
|
this.newLines = ['these', 'are', 'the', 'new', 'lines']
|
|
this.source = 'dropbox'
|
|
this.user_id = 'user-id-123'
|
|
|
|
sinon.spy(MockTrackChangesApi, 'flushDoc')
|
|
sinon.spy(MockProjectHistoryApi, 'flushProject')
|
|
sinon.spy(MockWebApi, 'setDocument')
|
|
DocUpdaterApp.ensureRunning(done)
|
|
})
|
|
|
|
after(function () {
|
|
MockTrackChangesApi.flushDoc.restore()
|
|
MockProjectHistoryApi.flushProject.restore()
|
|
MockWebApi.setDocument.restore()
|
|
})
|
|
|
|
describe('when the updated doc exists in the doc updater', function () {
|
|
before(function (done) {
|
|
this.project_id = DocUpdaterClient.randomId()
|
|
this.doc_id = DocUpdaterClient.randomId()
|
|
MockWebApi.insertDoc(this.project_id, this.doc_id, {
|
|
lines: this.lines,
|
|
version: this.version
|
|
})
|
|
DocUpdaterClient.preloadDoc(this.project_id, this.doc_id, (error) => {
|
|
if (error) {
|
|
throw error
|
|
}
|
|
DocUpdaterClient.sendUpdate(
|
|
this.project_id,
|
|
this.doc_id,
|
|
this.update,
|
|
(error) => {
|
|
if (error) {
|
|
throw error
|
|
}
|
|
setTimeout(() => {
|
|
DocUpdaterClient.setDocLines(
|
|
this.project_id,
|
|
this.doc_id,
|
|
this.newLines,
|
|
this.source,
|
|
this.user_id,
|
|
false,
|
|
(error, res, body) => {
|
|
if (error) {
|
|
return done(error)
|
|
}
|
|
this.statusCode = res.statusCode
|
|
done()
|
|
}
|
|
)
|
|
}, 200)
|
|
}
|
|
)
|
|
})
|
|
})
|
|
|
|
after(function () {
|
|
MockTrackChangesApi.flushDoc.resetHistory()
|
|
MockProjectHistoryApi.flushProject.resetHistory()
|
|
MockWebApi.setDocument.resetHistory()
|
|
})
|
|
|
|
it('should return a 204 status code', function () {
|
|
this.statusCode.should.equal(204)
|
|
})
|
|
|
|
it('should send the updated doc lines and version to the web api', function () {
|
|
MockWebApi.setDocument
|
|
.calledWith(this.project_id, this.doc_id, this.newLines)
|
|
.should.equal(true)
|
|
})
|
|
|
|
it('should update the lines in the doc updater', function (done) {
|
|
DocUpdaterClient.getDoc(
|
|
this.project_id,
|
|
this.doc_id,
|
|
(error, res, doc) => {
|
|
if (error) {
|
|
return done(error)
|
|
}
|
|
doc.lines.should.deep.equal(this.newLines)
|
|
done()
|
|
}
|
|
)
|
|
})
|
|
|
|
it('should bump the version in the doc updater', function (done) {
|
|
DocUpdaterClient.getDoc(
|
|
this.project_id,
|
|
this.doc_id,
|
|
(error, res, doc) => {
|
|
if (error) {
|
|
return done(error)
|
|
}
|
|
doc.version.should.equal(this.version + 2)
|
|
done()
|
|
}
|
|
)
|
|
})
|
|
|
|
it('should leave the document in redis', function (done) {
|
|
docUpdaterRedis.get(
|
|
Keys.docLines({ doc_id: this.doc_id }),
|
|
(error, lines) => {
|
|
if (error) {
|
|
throw error
|
|
}
|
|
expect(JSON.parse(lines)).to.deep.equal(this.newLines)
|
|
done()
|
|
}
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('when the updated doc does not exist in the doc updater', function () {
|
|
before(function (done) {
|
|
this.project_id = DocUpdaterClient.randomId()
|
|
this.doc_id = DocUpdaterClient.randomId()
|
|
MockWebApi.insertDoc(this.project_id, this.doc_id, {
|
|
lines: this.lines,
|
|
version: this.version
|
|
})
|
|
DocUpdaterClient.setDocLines(
|
|
this.project_id,
|
|
this.doc_id,
|
|
this.newLines,
|
|
this.source,
|
|
this.user_id,
|
|
false,
|
|
(error, res, body) => {
|
|
if (error) {
|
|
return done(error)
|
|
}
|
|
this.statusCode = res.statusCode
|
|
setTimeout(done, 200)
|
|
}
|
|
)
|
|
})
|
|
|
|
after(function () {
|
|
MockTrackChangesApi.flushDoc.resetHistory()
|
|
MockProjectHistoryApi.flushProject.resetHistory()
|
|
MockWebApi.setDocument.resetHistory()
|
|
})
|
|
|
|
it('should return a 204 status code', function () {
|
|
this.statusCode.should.equal(204)
|
|
})
|
|
|
|
it('should send the updated doc lines to the web api', function () {
|
|
MockWebApi.setDocument
|
|
.calledWith(this.project_id, this.doc_id, this.newLines)
|
|
.should.equal(true)
|
|
})
|
|
|
|
it('should flush track changes', function () {
|
|
MockTrackChangesApi.flushDoc.calledWith(this.doc_id).should.equal(true)
|
|
})
|
|
|
|
it('should flush project history', function () {
|
|
MockProjectHistoryApi.flushProject
|
|
.calledWith(this.project_id)
|
|
.should.equal(true)
|
|
})
|
|
|
|
it('should remove the document from redis', function (done) {
|
|
docUpdaterRedis.get(
|
|
Keys.docLines({ doc_id: this.doc_id }),
|
|
(error, lines) => {
|
|
if (error) {
|
|
throw error
|
|
}
|
|
expect(lines).to.not.exist
|
|
done()
|
|
}
|
|
)
|
|
})
|
|
})
|
|
|
|
const DOC_TOO_LARGE_TEST_CASES = [
|
|
{
|
|
desc: 'when the updated doc is too large for the body parser',
|
|
size: Settings.maxJsonRequestSize,
|
|
expectedStatusCode: 413
|
|
},
|
|
{
|
|
desc: 'when the updated doc is larger than the HTTP controller limit',
|
|
size: Settings.max_doc_length,
|
|
expectedStatusCode: 406
|
|
}
|
|
]
|
|
|
|
DOC_TOO_LARGE_TEST_CASES.forEach((testCase) => {
|
|
describe(testCase.desc, function () {
|
|
before(function (done) {
|
|
this.project_id = DocUpdaterClient.randomId()
|
|
this.doc_id = DocUpdaterClient.randomId()
|
|
MockWebApi.insertDoc(this.project_id, this.doc_id, {
|
|
lines: this.lines,
|
|
version: this.version
|
|
})
|
|
this.newLines = []
|
|
while (JSON.stringify(this.newLines).length <= testCase.size) {
|
|
this.newLines.push('(a long line of text)'.repeat(10000))
|
|
}
|
|
DocUpdaterClient.setDocLines(
|
|
this.project_id,
|
|
this.doc_id,
|
|
this.newLines,
|
|
this.source,
|
|
this.user_id,
|
|
false,
|
|
(error, res, body) => {
|
|
if (error) {
|
|
return done(error)
|
|
}
|
|
this.statusCode = res.statusCode
|
|
setTimeout(done, 200)
|
|
}
|
|
)
|
|
})
|
|
|
|
after(function () {
|
|
MockTrackChangesApi.flushDoc.resetHistory()
|
|
MockProjectHistoryApi.flushProject.resetHistory()
|
|
MockWebApi.setDocument.resetHistory()
|
|
})
|
|
|
|
it(`should return a ${testCase.expectedStatusCode} status code`, function () {
|
|
this.statusCode.should.equal(testCase.expectedStatusCode)
|
|
})
|
|
|
|
it('should not send the updated doc lines to the web api', function () {
|
|
MockWebApi.setDocument.called.should.equal(false)
|
|
})
|
|
|
|
it('should not flush track changes', function () {
|
|
MockTrackChangesApi.flushDoc.called.should.equal(false)
|
|
})
|
|
|
|
it('should not flush project history', function () {
|
|
MockProjectHistoryApi.flushProject.called.should.equal(false)
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('when the updated doc is large but under the bodyParser and HTTPController size limit', function () {
|
|
before(function (done) {
|
|
this.project_id = DocUpdaterClient.randomId()
|
|
this.doc_id = DocUpdaterClient.randomId()
|
|
MockWebApi.insertDoc(this.project_id, this.doc_id, {
|
|
lines: this.lines,
|
|
version: this.version
|
|
})
|
|
|
|
this.newLines = []
|
|
while (JSON.stringify(this.newLines).length < 2 * 1024 * 1024) {
|
|
// limit in HTTPController
|
|
this.newLines.push('(a long line of text)'.repeat(10000))
|
|
}
|
|
this.newLines.pop() // remove the line which took it over the limit
|
|
DocUpdaterClient.setDocLines(
|
|
this.project_id,
|
|
this.doc_id,
|
|
this.newLines,
|
|
this.source,
|
|
this.user_id,
|
|
false,
|
|
(error, res, body) => {
|
|
if (error) {
|
|
return done(error)
|
|
}
|
|
this.statusCode = res.statusCode
|
|
setTimeout(done, 200)
|
|
}
|
|
)
|
|
})
|
|
|
|
after(function () {
|
|
MockTrackChangesApi.flushDoc.resetHistory()
|
|
MockProjectHistoryApi.flushProject.resetHistory()
|
|
MockWebApi.setDocument.resetHistory()
|
|
})
|
|
|
|
it('should return a 204 status code', function () {
|
|
this.statusCode.should.equal(204)
|
|
})
|
|
|
|
it('should send the updated doc lines to the web api', function () {
|
|
MockWebApi.setDocument
|
|
.calledWith(this.project_id, this.doc_id, this.newLines)
|
|
.should.equal(true)
|
|
})
|
|
})
|
|
|
|
describe('with track changes', function () {
|
|
before(function () {
|
|
this.lines = ['one', 'one and a half', 'two', 'three']
|
|
this.id_seed = '587357bd35e64f6157'
|
|
this.update = {
|
|
doc: this.doc_id,
|
|
op: [
|
|
{
|
|
d: 'one and a half\n',
|
|
p: 4
|
|
}
|
|
],
|
|
meta: {
|
|
tc: this.id_seed,
|
|
user_id: this.user_id
|
|
},
|
|
v: this.version
|
|
}
|
|
})
|
|
|
|
describe('with the undo flag', function () {
|
|
before(function (done) {
|
|
this.project_id = DocUpdaterClient.randomId()
|
|
this.doc_id = DocUpdaterClient.randomId()
|
|
MockWebApi.insertDoc(this.project_id, this.doc_id, {
|
|
lines: this.lines,
|
|
version: this.version
|
|
})
|
|
DocUpdaterClient.preloadDoc(this.project_id, this.doc_id, (error) => {
|
|
if (error) {
|
|
throw error
|
|
}
|
|
DocUpdaterClient.sendUpdate(
|
|
this.project_id,
|
|
this.doc_id,
|
|
this.update,
|
|
(error) => {
|
|
if (error) {
|
|
throw error
|
|
}
|
|
// Go back to old lines, with undo flag
|
|
DocUpdaterClient.setDocLines(
|
|
this.project_id,
|
|
this.doc_id,
|
|
this.lines,
|
|
this.source,
|
|
this.user_id,
|
|
true,
|
|
(error, res, body) => {
|
|
if (error) {
|
|
return done(error)
|
|
}
|
|
this.statusCode = res.statusCode
|
|
setTimeout(done, 200)
|
|
}
|
|
)
|
|
}
|
|
)
|
|
})
|
|
})
|
|
|
|
after(function () {
|
|
MockTrackChangesApi.flushDoc.resetHistory()
|
|
MockProjectHistoryApi.flushProject.resetHistory()
|
|
MockWebApi.setDocument.resetHistory()
|
|
})
|
|
|
|
it('should undo the tracked changes', function (done) {
|
|
DocUpdaterClient.getDoc(
|
|
this.project_id,
|
|
this.doc_id,
|
|
(error, res, data) => {
|
|
if (error) {
|
|
throw error
|
|
}
|
|
const { ranges } = data
|
|
expect(ranges.changes).to.be.undefined
|
|
done()
|
|
}
|
|
)
|
|
})
|
|
})
|
|
|
|
describe('without the undo flag', function () {
|
|
before(function (done) {
|
|
this.project_id = DocUpdaterClient.randomId()
|
|
this.doc_id = DocUpdaterClient.randomId()
|
|
MockWebApi.insertDoc(this.project_id, this.doc_id, {
|
|
lines: this.lines,
|
|
version: this.version
|
|
})
|
|
DocUpdaterClient.preloadDoc(this.project_id, this.doc_id, (error) => {
|
|
if (error) {
|
|
throw error
|
|
}
|
|
DocUpdaterClient.sendUpdate(
|
|
this.project_id,
|
|
this.doc_id,
|
|
this.update,
|
|
(error) => {
|
|
if (error) {
|
|
throw error
|
|
}
|
|
// Go back to old lines, without undo flag
|
|
DocUpdaterClient.setDocLines(
|
|
this.project_id,
|
|
this.doc_id,
|
|
this.lines,
|
|
this.source,
|
|
this.user_id,
|
|
false,
|
|
(error, res, body) => {
|
|
if (error) {
|
|
return done(error)
|
|
}
|
|
this.statusCode = res.statusCode
|
|
setTimeout(done, 200)
|
|
}
|
|
)
|
|
}
|
|
)
|
|
})
|
|
})
|
|
|
|
after(function () {
|
|
MockTrackChangesApi.flushDoc.resetHistory()
|
|
MockProjectHistoryApi.flushProject.resetHistory()
|
|
MockWebApi.setDocument.resetHistory()
|
|
})
|
|
|
|
it('should not undo the tracked changes', function (done) {
|
|
DocUpdaterClient.getDoc(
|
|
this.project_id,
|
|
this.doc_id,
|
|
(error, res, data) => {
|
|
if (error) {
|
|
throw error
|
|
}
|
|
const { ranges } = data
|
|
expect(ranges.changes.length).to.equal(1)
|
|
done()
|
|
}
|
|
)
|
|
})
|
|
})
|
|
})
|
|
})
|