mirror of
https://github.com/overleaf/overleaf.git
synced 2024-09-16 02:52:31 -04:00
518 lines
18 KiB
CoffeeScript
518 lines
18 KiB
CoffeeScript
sinon = require('sinon')
|
|
chai = require('chai')
|
|
should = chai.should()
|
|
expect = chai.expect
|
|
modulePath = "../../../../app/js/UpdatesManager.js"
|
|
SandboxedModule = require('sandboxed-module')
|
|
|
|
describe "UpdatesManager", ->
|
|
beforeEach ->
|
|
@UpdatesManager = SandboxedModule.require modulePath, requires:
|
|
"./UpdateCompressor": @UpdateCompressor = {}
|
|
"./MongoManager" : @MongoManager = {}
|
|
"./RedisManager" : @RedisManager = {}
|
|
"./LockManager" : @LockManager = {}
|
|
"./WebApiManager": @WebApiManager = {}
|
|
"logger-sharelatex": { log: sinon.stub(), error: sinon.stub() }
|
|
@doc_id = "doc-id-123"
|
|
@project_id = "project-id-123"
|
|
@callback = sinon.stub()
|
|
|
|
describe "compressAndSaveRawUpdates", ->
|
|
describe "when there are no raw ops", ->
|
|
beforeEach ->
|
|
@MongoManager.popLastCompressedUpdate = sinon.stub()
|
|
@MongoManager.insertCompressedUpdates = sinon.stub()
|
|
@UpdatesManager.compressAndSaveRawUpdates @project_id, @doc_id, [], @callback
|
|
|
|
it "should not need to access the database", ->
|
|
@MongoManager.popLastCompressedUpdate.called.should.equal false
|
|
@MongoManager.insertCompressedUpdates.called.should.equal false
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "when there is no compressed history to begin with", ->
|
|
beforeEach ->
|
|
@rawUpdates = [{ v: 12, op: "mock-op-12" }, { v: 13, op: "mock-op-13" }]
|
|
@compressedUpdates = { v: 13, op: "compressed-op-12" }
|
|
|
|
@MongoManager.popLastCompressedUpdate = sinon.stub().callsArgWith(1, null, null)
|
|
@MongoManager.insertCompressedUpdates = sinon.stub().callsArg(3)
|
|
@UpdateCompressor.compressRawUpdates = sinon.stub().returns(@compressedUpdates)
|
|
@UpdatesManager.compressAndSaveRawUpdates @project_id, @doc_id, @rawUpdates, @callback
|
|
|
|
it "should try to pop the last compressed op", ->
|
|
@MongoManager.popLastCompressedUpdate
|
|
.calledWith(@doc_id)
|
|
.should.equal true
|
|
|
|
it "should compress the raw ops", ->
|
|
@UpdateCompressor.compressRawUpdates
|
|
.calledWith(null, @rawUpdates)
|
|
.should.equal true
|
|
|
|
it "should save the compressed ops", ->
|
|
@MongoManager.insertCompressedUpdates
|
|
.calledWith(@project_id, @doc_id, @compressedUpdates)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "when the raw ops need appending to existing history", ->
|
|
beforeEach ->
|
|
@lastCompressedUpdate = { v: 11, op: "compressed-op-11" }
|
|
@compressedUpdates = { v: 13, op: "compressed-op-12" }
|
|
|
|
@MongoManager.popLastCompressedUpdate = sinon.stub().callsArgWith(1, null, @lastCompressedUpdate)
|
|
@MongoManager.insertCompressedUpdates = sinon.stub().callsArg(3)
|
|
@UpdateCompressor.compressRawUpdates = sinon.stub().returns(@compressedUpdates)
|
|
|
|
describe "when the raw ops start where the existing history ends", ->
|
|
beforeEach ->
|
|
@rawUpdates = [{ v: 12, op: "mock-op-12" }, { v: 13, op: "mock-op-13" }]
|
|
@UpdatesManager.compressAndSaveRawUpdates @project_id, @doc_id, @rawUpdates, @callback
|
|
|
|
it "should try to pop the last compressed op", ->
|
|
@MongoManager.popLastCompressedUpdate
|
|
.calledWith(@doc_id)
|
|
.should.equal true
|
|
|
|
it "should compress the last compressed op and the raw ops", ->
|
|
@UpdateCompressor.compressRawUpdates
|
|
.calledWith(@lastCompressedUpdate, @rawUpdates)
|
|
.should.equal true
|
|
|
|
it "should save the compressed ops", ->
|
|
@MongoManager.insertCompressedUpdates
|
|
.calledWith(@project_id, @doc_id, @compressedUpdates)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "when some raw ops are passed that have already been compressed", ->
|
|
beforeEach ->
|
|
@rawUpdates = [{ v: 10, op: "mock-op-10" }, { v: 11, op: "mock-op-11"}, { v: 12, op: "mock-op-12" }, { v: 13, op: "mock-op-13" }]
|
|
|
|
@UpdatesManager.compressAndSaveRawUpdates @project_id, @doc_id, @rawUpdates, @callback
|
|
|
|
it "should only compress the more recent raw ops", ->
|
|
@UpdateCompressor.compressRawUpdates
|
|
.calledWith(@lastCompressedUpdate, @rawUpdates.slice(-2))
|
|
.should.equal true
|
|
|
|
describe "when the raw ops do not follow from the last compressed op version", ->
|
|
beforeEach ->
|
|
@rawUpdates = [{ v: 13, op: "mock-op-13" }]
|
|
@UpdatesManager.compressAndSaveRawUpdates @project_id, @doc_id, @rawUpdates, @callback
|
|
|
|
it "should call the callback with an error", ->
|
|
@callback
|
|
.calledWith(new Error("Tried to apply raw op at version 13 to last compressed update with version 11"))
|
|
.should.equal true
|
|
|
|
it "should put the popped update back into mongo", ->
|
|
@MongoManager.insertCompressedUpdates.calledOnce.should.equal true
|
|
@MongoManager.insertCompressedUpdates
|
|
.calledWith(@project_id, @doc_id, [@lastCompressedUpdate])
|
|
.should.equal true
|
|
|
|
describe "processUncompressedUpdates", ->
|
|
describe "when there is fewer than one batch to send", ->
|
|
beforeEach ->
|
|
@updates = ["mock-update"]
|
|
@RedisManager.getOldestRawUpdates = sinon.stub().callsArgWith(2, null, @updates)
|
|
@UpdatesManager.compressAndSaveRawUpdates = sinon.stub().callsArgWith(3)
|
|
@RedisManager.deleteOldestRawUpdates = sinon.stub().callsArg(2)
|
|
@UpdatesManager.processUncompressedUpdates @project_id, @doc_id, @callback
|
|
|
|
it "should get the oldest updates", ->
|
|
@RedisManager.getOldestRawUpdates
|
|
.calledWith(@doc_id, @UpdatesManager.REDIS_READ_BATCH_SIZE)
|
|
.should.equal true
|
|
|
|
it "should compress and save the updates", ->
|
|
@UpdatesManager.compressAndSaveRawUpdates
|
|
.calledWith(@project_id, @doc_id, @updates)
|
|
.should.equal true
|
|
|
|
it "should delete the batch of uncompressed updates that was just processed", ->
|
|
@RedisManager.deleteOldestRawUpdates
|
|
.calledWith(@doc_id, @updates.length)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "when there are multiple batches to send", ->
|
|
beforeEach (done) ->
|
|
@UpdatesManager.REDIS_READ_BATCH_SIZE = 2
|
|
@updates = ["mock-update-0", "mock-update-1", "mock-update-2", "mock-update-3", "mock-update-4"]
|
|
@redisArray = @updates.slice()
|
|
@RedisManager.getOldestRawUpdates = (doc_id, batchSize, callback = (error, updates) ->) =>
|
|
updates = @redisArray.slice(0, batchSize)
|
|
@redisArray = @redisArray.slice(batchSize)
|
|
callback null, updates
|
|
sinon.spy @RedisManager, "getOldestRawUpdates"
|
|
@UpdatesManager.compressAndSaveRawUpdates = sinon.stub().callsArgWith(3)
|
|
@RedisManager.deleteOldestRawUpdates = sinon.stub().callsArg(2)
|
|
@UpdatesManager.processUncompressedUpdates @project_id, @doc_id, (args...) =>
|
|
@callback(args...)
|
|
done()
|
|
|
|
it "should get the oldest updates in three batches ", ->
|
|
@RedisManager.getOldestRawUpdates.callCount.should.equal 3
|
|
|
|
it "should compress and save the updates in batches", ->
|
|
@UpdatesManager.compressAndSaveRawUpdates
|
|
.calledWith(@project_id, @doc_id, @updates.slice(0,2))
|
|
.should.equal true
|
|
@UpdatesManager.compressAndSaveRawUpdates
|
|
.calledWith(@project_id, @doc_id, @updates.slice(2,4))
|
|
.should.equal true
|
|
@UpdatesManager.compressAndSaveRawUpdates
|
|
.calledWith(@project_id, @doc_id, @updates.slice(4,5))
|
|
.should.equal true
|
|
|
|
it "should delete the batches of uncompressed updates", ->
|
|
@RedisManager.deleteOldestRawUpdates.callCount.should.equal 3
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "processCompressedUpdatesWithLock", ->
|
|
beforeEach ->
|
|
@UpdatesManager.processUncompressedUpdates = sinon.stub().callsArg(2)
|
|
@LockManager.runWithLock = sinon.stub().callsArg(2)
|
|
@UpdatesManager.processUncompressedUpdatesWithLock @project_id, @doc_id, @callback
|
|
|
|
it "should run processUncompressedUpdates with the lock", ->
|
|
@LockManager.runWithLock
|
|
.calledWith(
|
|
"HistoryLock:#{@doc_id}"
|
|
)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "getUpdates", ->
|
|
beforeEach ->
|
|
@updates = ["mock-updates"]
|
|
@options = { to: "mock-to", limit: "mock-limit" }
|
|
@MongoManager.getUpdates = sinon.stub().callsArgWith(2, null, @updates)
|
|
@UpdatesManager.processUncompressedUpdatesWithLock = sinon.stub().callsArg(2)
|
|
@UpdatesManager.getUpdates @project_id, @doc_id, @options, @callback
|
|
|
|
it "should process outstanding updates", ->
|
|
@UpdatesManager.processUncompressedUpdatesWithLock
|
|
.calledWith(@project_id, @doc_id)
|
|
.should.equal true
|
|
|
|
it "should get the updates from the database", ->
|
|
@MongoManager.getUpdates
|
|
.calledWith(@doc_id, @options)
|
|
.should.equal true
|
|
|
|
it "should return the updates", ->
|
|
@callback
|
|
.calledWith(null, @updates)
|
|
.should.equal true
|
|
|
|
describe "getUpdatesWithUserInfo", ->
|
|
beforeEach ->
|
|
@updates = ["mock-updates"]
|
|
@options = { to: "mock-to", limit: "mock-limit" }
|
|
@updatesWithUserInfo = ["updates-with-user-info"]
|
|
@UpdatesManager.getUpdates = sinon.stub().callsArgWith(3, null, @updates)
|
|
@UpdatesManager.fillUserInfo = sinon.stub().callsArgWith(1, null, @updatesWithUserInfo)
|
|
@UpdatesManager.getUpdatesWithUserInfo @project_id, @doc_id, @options, @callback
|
|
|
|
it "should get the updates", ->
|
|
@UpdatesManager.getUpdates
|
|
.calledWith(@project_id, @doc_id, @options)
|
|
.should.equal true
|
|
|
|
it "should file the updates with the user info", ->
|
|
@UpdatesManager.fillUserInfo
|
|
.calledWith(@updates)
|
|
.should.equal true
|
|
|
|
it "should return the updates with the filled details", ->
|
|
@callback.calledWith(null, @updatesWithUserInfo).should.equal true
|
|
|
|
describe "_extendBatchOfSummarizedUpdates", ->
|
|
beforeEach ->
|
|
@to = 42
|
|
@limit = 2
|
|
@existingSummarizedUpdates = ["summarized-updates-3"]
|
|
@summarizedUpdates = ["summarized-updates-3", "summarized-update-2", "summarized-update-1"]
|
|
|
|
describe "when there are updates to get", ->
|
|
beforeEach ->
|
|
@updates = ["mock-updates"]
|
|
@existingSummarizedUpdates = ["summarized-updates-3"]
|
|
@summarizedUpdates = ["summarized-updates-3", "summarized-update-2", "summarized-update-1"]
|
|
@UpdatesManager._summarizeUpdates = sinon.stub().returns(@summarizedUpdates)
|
|
@UpdatesManager.getUpdatesWithUserInfo = sinon.stub().callsArgWith(3, null, @updates)
|
|
@UpdatesManager._extendBatchOfSummarizedUpdates @project_id, @doc_id, @existingSummarizedUpdates, @to, @limit, @callback
|
|
|
|
it "should get the updates", ->
|
|
@UpdatesManager.getUpdatesWithUserInfo
|
|
.calledWith(@project_id, @doc_id, { to: @to, limit: 3 * @limit })
|
|
.should.equal true
|
|
|
|
it "should summarize the updates", ->
|
|
@UpdatesManager._summarizeUpdates
|
|
.calledWith(@updates, @existingSummarizedUpdates)
|
|
.should.equal true
|
|
|
|
it "should call the callback with the summarized updates and false for end-of-databse", ->
|
|
@callback.calledWith(null, @summarizedUpdates.slice(0, @limit), false).should.equal true
|
|
|
|
describe "when there are no more updates", ->
|
|
beforeEach ->
|
|
@updates = []
|
|
@UpdatesManager._summarizeUpdates = sinon.stub().returns(@summarizedUpdates)
|
|
@UpdatesManager.getUpdatesWithUserInfo = sinon.stub().callsArgWith(3, null, @updates)
|
|
@UpdatesManager._extendBatchOfSummarizedUpdates @project_id, @doc_id, @existingSummarizedUpdates, @to, @limit, @callback
|
|
|
|
it "should call the callback with the summarized updates and true for end-of-database", ->
|
|
@callback.calledWith(null, @summarizedUpdates.slice(0, @limit), true).should.equal true
|
|
|
|
describe "getSummarizedUpdates", ->
|
|
describe "when one batch of updates is enough to meet the limit", ->
|
|
beforeEach ->
|
|
@to = 42
|
|
@limit = 2
|
|
@updates = ["summarized-updates-3", "summarized-updates-2"]
|
|
@UpdatesManager._extendBatchOfSummarizedUpdates = sinon.stub().callsArgWith(5, null, @updates)
|
|
@UpdatesManager.getSummarizedUpdates @project_id, @doc_id, { to: @to, limit: @limit }, @callback
|
|
|
|
it "should get the batch of summarized updates", ->
|
|
@UpdatesManager._extendBatchOfSummarizedUpdates
|
|
.calledWith(@project_id, @doc_id, [], @to, @limit)
|
|
.should.equal true
|
|
|
|
it "should call the callback with the updates", ->
|
|
@callback.calledWith(null, @updates).should.equal true
|
|
|
|
describe "when multiple batches are needed to meet the limit", ->
|
|
beforeEach ->
|
|
@to = 6
|
|
@limit = 4
|
|
@firstBatch = [{ toV: 6, fromV: 6 }, { toV: 5, fromV: 5 }]
|
|
@secondBatch = [{ toV: 4, fromV: 4 }, { toV: 3, fromV: 3 }]
|
|
@UpdatesManager._extendBatchOfSummarizedUpdates = (project_id, doc_id, existingUpdates, to, limit, callback) =>
|
|
if existingUpdates.length == 0
|
|
callback null, @firstBatch, false
|
|
else
|
|
callback null, @firstBatch.concat(@secondBatch), false
|
|
sinon.spy @UpdatesManager, "_extendBatchOfSummarizedUpdates"
|
|
@UpdatesManager.getSummarizedUpdates @project_id, @doc_id, { to: @to, limit: @limit }, @callback
|
|
|
|
it "should get the first batch of summarized updates", ->
|
|
@UpdatesManager._extendBatchOfSummarizedUpdates
|
|
.calledWith(@project_id, @doc_id, [], @to, @limit)
|
|
.should.equal true
|
|
|
|
it "should get the second batch of summarized updates", ->
|
|
@UpdatesManager._extendBatchOfSummarizedUpdates
|
|
.calledWith(@project_id, @doc_id, @firstBatch, 4, @limit)
|
|
.should.equal true
|
|
|
|
it "should call the callback with all the updates", ->
|
|
@callback.calledWith(null, @firstBatch.concat(@secondBatch)).should.equal true
|
|
|
|
describe "when the end of the database is hit", ->
|
|
beforeEach ->
|
|
@to = 6
|
|
@limit = 4
|
|
@updates = [{ toV: 6, fromV: 6 }, { toV: 5, fromV: 5 }]
|
|
@UpdatesManager._extendBatchOfSummarizedUpdates = sinon.stub().callsArgWith(5, null, @updates, true)
|
|
@UpdatesManager.getSummarizedUpdates @project_id, @doc_id, { to: @to, limit: @limit }, @callback
|
|
|
|
it "should get the batch of summarized updates", ->
|
|
@UpdatesManager._extendBatchOfSummarizedUpdates
|
|
.calledWith(@project_id, @doc_id, [], @to, @limit)
|
|
.should.equal true
|
|
|
|
it "should call the callback with the updates", ->
|
|
@callback.calledWith(null, @updates).should.equal true
|
|
|
|
describe "fillUserInfo", ->
|
|
describe "with valid users", ->
|
|
beforeEach (done) ->
|
|
{ObjectId} = require "mongojs"
|
|
@user_id_1 = ObjectId().toString()
|
|
@user_id_2 = ObjectId().toString()
|
|
@updates = [{
|
|
meta:
|
|
user_id: @user_id_1
|
|
op: "mock-op-1"
|
|
}, {
|
|
meta:
|
|
user_id: @user_id_1
|
|
op: "mock-op-2"
|
|
}, {
|
|
meta:
|
|
user_id: @user_id_2
|
|
op: "mock-op-3"
|
|
}]
|
|
@user_info = {}
|
|
@user_info[@user_id_1] = email: "user1@sharelatex.com"
|
|
@user_info[@user_id_2] = email: "user2@sharelatex.com"
|
|
|
|
@WebApiManager.getUserInfo = (user_id, callback = (error, userInfo) ->) =>
|
|
callback null, @user_info[user_id]
|
|
sinon.spy @WebApiManager, "getUserInfo"
|
|
|
|
@UpdatesManager.fillUserInfo @updates, (error, @results) =>
|
|
done()
|
|
|
|
it "should only call getUserInfo once for each user_id", ->
|
|
@WebApiManager.getUserInfo.calledTwice.should.equal true
|
|
@WebApiManager.getUserInfo
|
|
.calledWith(@user_id_1)
|
|
.should.equal true
|
|
@WebApiManager.getUserInfo
|
|
.calledWith(@user_id_2)
|
|
.should.equal true
|
|
|
|
it "should return the updates with the user info filled", ->
|
|
expect(@results).to.deep.equal [{
|
|
meta:
|
|
user:
|
|
email: "user1@sharelatex.com"
|
|
op: "mock-op-1"
|
|
}, {
|
|
meta:
|
|
user:
|
|
email: "user1@sharelatex.com"
|
|
op: "mock-op-2"
|
|
}, {
|
|
meta:
|
|
user:
|
|
email: "user2@sharelatex.com"
|
|
op: "mock-op-3"
|
|
}]
|
|
|
|
|
|
describe "with invalid user ids", ->
|
|
beforeEach (done) ->
|
|
@updates = [{
|
|
meta:
|
|
user_id: null
|
|
op: "mock-op-1"
|
|
}, {
|
|
meta:
|
|
user_id: "anonymous-user"
|
|
op: "mock-op-2"
|
|
}]
|
|
@WebApiManager.getUserInfo = (user_id, callback = (error, userInfo) ->) =>
|
|
callback null, @user_info[user_id]
|
|
sinon.spy @WebApiManager, "getUserInfo"
|
|
|
|
@UpdatesManager.fillUserInfo @updates, (error, @results) =>
|
|
done()
|
|
|
|
it "should not call getUserInfo", ->
|
|
@WebApiManager.getUserInfo.called.should.equal false
|
|
|
|
it "should return the updates without the user info filled", ->
|
|
expect(@results).to.deep.equal [{
|
|
meta: {}
|
|
op: "mock-op-1"
|
|
}, {
|
|
meta: {}
|
|
op: "mock-op-2"
|
|
}]
|
|
|
|
describe "_buildUpdatesView", ->
|
|
beforeEach ->
|
|
@now = Date.now()
|
|
|
|
it "should concat updates that are close in time", ->
|
|
expect(@UpdatesManager._summarizeUpdates [{
|
|
meta:
|
|
user: @user_1 = { id: "mock-user-1" }
|
|
start_ts: @now + 20
|
|
end_ts: @now + 30
|
|
v: 5
|
|
}, {
|
|
meta:
|
|
user: @user_2 = { id: "mock-user-2" }
|
|
start_ts: @now
|
|
end_ts: @now + 10
|
|
v: 4
|
|
}]).to.deep.equal [{
|
|
meta:
|
|
users: [@user_1, @user_2]
|
|
start_ts: @now
|
|
end_ts: @now + 30
|
|
fromV: 4
|
|
toV: 5
|
|
}]
|
|
|
|
it "should leave updates that are far apart in time", ->
|
|
oneDay = 1000 * 60 * 60 * 24
|
|
expect(@UpdatesManager._summarizeUpdates [{
|
|
meta:
|
|
user: @user_2 = { id: "mock-user-2" }
|
|
start_ts: @now + oneDay
|
|
end_ts: @now + oneDay + 10
|
|
v: 5
|
|
}, {
|
|
meta:
|
|
user: @user_1 = { id: "mock-user-2" }
|
|
start_ts: @now
|
|
end_ts: @now + 10
|
|
v: 4
|
|
}]).to.deep.equal [{
|
|
meta:
|
|
users: [@user_2]
|
|
start_ts: @now + oneDay
|
|
end_ts: @now + oneDay + 10
|
|
fromV: 5
|
|
toV: 5
|
|
}, {
|
|
meta:
|
|
users: [@user_1]
|
|
start_ts: @now
|
|
end_ts: @now + 10
|
|
fromV: 4
|
|
toV: 4
|
|
}]
|
|
|
|
it "should concat onto existing summarized updates", ->
|
|
@user_1 = { id: "mock-user-1" }
|
|
@user_2 = { id: "mock-user-2" }
|
|
expect(@UpdatesManager._summarizeUpdates [{
|
|
meta:
|
|
user: @user_1
|
|
start_ts: @now + 20
|
|
end_ts: @now + 30
|
|
v: 5
|
|
}, {
|
|
meta:
|
|
user: @user_2
|
|
start_ts: @now
|
|
end_ts: @now + 10
|
|
v: 4
|
|
}], [{
|
|
meta:
|
|
users: [@user_1]
|
|
start_ts: @now + 40
|
|
end_ts: @now + 50
|
|
fromV: 6
|
|
toV: 8
|
|
}]).to.deep.equal [{
|
|
meta:
|
|
users: [@user_1, @user_2]
|
|
start_ts: @now
|
|
end_ts: @now + 50
|
|
fromV: 4
|
|
toV: 8
|
|
}]
|