mirror of
https://github.com/overleaf/overleaf.git
synced 2024-09-16 02:52:31 -04:00
112 lines
4.1 KiB
CoffeeScript
112 lines
4.1 KiB
CoffeeScript
SandboxedModule = require('sandboxed-module')
|
|
sinon = require('sinon')
|
|
require('chai').should()
|
|
modulePath = require('path').join __dirname, '../../../../app/js/HistoryManager'
|
|
|
|
describe "HistoryManager", ->
|
|
beforeEach ->
|
|
@HistoryManager = SandboxedModule.require modulePath, requires:
|
|
"request": @request = {}
|
|
"settings-sharelatex": @Settings = {}
|
|
"logger-sharelatex": @logger = { log: sinon.stub(), error: sinon.stub() }
|
|
"./HistoryRedisManager": @HistoryRedisManager = {}
|
|
@project_id = "mock-project-id"
|
|
@doc_id = "mock-doc-id"
|
|
@callback = sinon.stub()
|
|
|
|
describe "flushDocChanges", ->
|
|
beforeEach ->
|
|
@Settings.apis =
|
|
trackchanges: url: "http://trackchanges.example.com"
|
|
|
|
describe "successfully", ->
|
|
beforeEach ->
|
|
@request.post = sinon.stub().callsArgWith(1, null, statusCode: 204)
|
|
@HistoryManager.flushDocChanges @project_id, @doc_id, @callback
|
|
|
|
it "should send a request to the track changes api", ->
|
|
@request.post
|
|
.calledWith("#{@Settings.apis.trackchanges.url}/project/#{@project_id}/doc/#{@doc_id}/flush")
|
|
.should.equal true
|
|
|
|
it "should return the callback", ->
|
|
@callback.calledWith(null).should.equal true
|
|
|
|
describe "when the track changes api returns an error", ->
|
|
beforeEach ->
|
|
@request.post = sinon.stub().callsArgWith(1, null, statusCode: 500)
|
|
@HistoryManager.flushDocChanges @project_id, @doc_id, @callback
|
|
|
|
it "should return the callback with an error", ->
|
|
@callback.calledWith(new Error("track changes api return non-success code: 500")).should.equal true
|
|
|
|
describe "recordAndFlushHistoryOps", ->
|
|
beforeEach ->
|
|
@ops = ["mock-ops"]
|
|
@HistoryManager.flushDocChanges = sinon.stub().callsArg(2)
|
|
|
|
describe "pushing the op", ->
|
|
beforeEach ->
|
|
@HistoryRedisManager.recordDocHasHistoryOps = sinon.stub().callsArgWith(3, null)
|
|
@HistoryManager.recordAndFlushHistoryOps @project_id, @doc_id, @ops, 1, @callback
|
|
|
|
it "should push the ops into redis", ->
|
|
@HistoryRedisManager.recordDocHasHistoryOps
|
|
.calledWith(@project_id, @doc_id, @ops)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
it "should not try to flush the op", ->
|
|
@HistoryManager.flushDocChanges.called.should.equal false
|
|
|
|
describe "when we hit a multiple of FLUSH_EVERY_N_OPS ops", ->
|
|
beforeEach ->
|
|
@HistoryRedisManager.recordDocHasHistoryOps =
|
|
sinon.stub().callsArgWith(3, null)
|
|
@HistoryManager.recordAndFlushHistoryOps @project_id, @doc_id, @ops, 2 * @HistoryManager.FLUSH_EVERY_N_OPS,@callback
|
|
|
|
it "should tell the track changes api to flush", ->
|
|
@HistoryManager.flushDocChanges
|
|
.calledWith(@project_id, @doc_id)
|
|
.should.equal true
|
|
|
|
describe "when we go over a multiple of FLUSH_EVERY_N_OPS ops", ->
|
|
beforeEach ->
|
|
@ops = ["op1", "op2", "op3"]
|
|
@HistoryRedisManager.recordDocHasHistoryOps =
|
|
sinon.stub().callsArgWith(3, null)
|
|
@HistoryManager.recordAndFlushHistoryOps @project_id, @doc_id, @ops, 2 * @HistoryManager.FLUSH_EVERY_N_OPS + 1, @callback
|
|
|
|
it "should tell the track changes api to flush", ->
|
|
@HistoryManager.flushDocChanges
|
|
.calledWith(@project_id, @doc_id)
|
|
.should.equal true
|
|
|
|
describe "when HistoryManager errors", ->
|
|
beforeEach ->
|
|
@HistoryRedisManager.recordDocHasHistoryOps =
|
|
sinon.stub().callsArgWith(3, null)
|
|
@HistoryManager.flushDocChanges = sinon.stub().callsArgWith(2, @error = new Error("oops"))
|
|
@HistoryManager.recordAndFlushHistoryOps @project_id, @doc_id, @ops, 2 * @HistoryManager.FLUSH_EVERY_N_OPS, @callback
|
|
|
|
it "should log out the error", ->
|
|
@logger.error
|
|
.calledWith(
|
|
err: @error
|
|
doc_id: @doc_id
|
|
project_id: @project_id
|
|
"error flushing doc to track changes api"
|
|
)
|
|
.should.equal true
|
|
|
|
describe "with no ops", ->
|
|
beforeEach ->
|
|
@HistoryRedisManager.recordDocHasHistoryOps = sinon.stub().callsArgWith(3, null)
|
|
@HistoryManager.recordAndFlushHistoryOps @project_id, @doc_id, [], 1, @callback
|
|
|
|
it "should not call HistoryRedisManager.recordDocHasHistoryOps", ->
|
|
@HistoryRedisManager.recordDocHasHistoryOps.called.should.equal false
|
|
|
|
|