mirror of
https://github.com/overleaf/overleaf.git
synced 2024-10-31 21:21:03 -04:00
a3847d21d5
In Javascript, characters are 16-bits wide. It does not understand surrogates as characters. From Wikipedia (http://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_Multilingual_Plane): "The High Surrogates (U+D800–U+DBFF) and Low Surrogate (U+DC00–U+DFFF) codes are reserved for encoding non-BMP characters in UTF-16 by using a pair of 16-bit codes: one High Surrogate and one Low Surrogate. A single surrogate code point will never be assigned a character."" The main offender seems to be \uD835 as a stand alone character, which would be the first 16-bit character of a blackboard bold character (http://www.fileformat.info/info/unicode/char/1d400/index.htm). Something must be going on client side that is screwing up the encoding and splitting the two 16-bit characters so that \uD835 is standalone.
218 lines
8.1 KiB
CoffeeScript
218 lines
8.1 KiB
CoffeeScript
sinon = require('sinon')
|
|
chai = require('chai')
|
|
should = chai.should()
|
|
modulePath = "../../../../app/js/UpdateManager.js"
|
|
SandboxedModule = require('sandboxed-module')
|
|
|
|
describe "UpdateManager", ->
|
|
beforeEach ->
|
|
@project_id = "project-id-123"
|
|
@doc_id = "document-id-123"
|
|
@callback = sinon.stub()
|
|
@UpdateManager = SandboxedModule.require modulePath, requires:
|
|
"./LockManager" : @LockManager = {}
|
|
"./RedisManager" : @RedisManager = {}
|
|
"./ShareJsUpdateManager" : @ShareJsUpdateManager = {}
|
|
"logger-sharelatex": @logger = { log: sinon.stub() }
|
|
"./Metrics": @Metrics =
|
|
Timer: class Timer
|
|
done: sinon.stub()
|
|
|
|
describe "resumeProcessing", ->
|
|
beforeEach (done) ->
|
|
@docs = [{
|
|
doc_id: "doc-1"
|
|
project_id: "project-1"
|
|
}, {
|
|
doc_id: "doc-2"
|
|
project_id: "project-2"
|
|
}, {
|
|
doc_id: "doc-3"
|
|
project_id: "project-3"
|
|
}]
|
|
@RedisManager.getDocsWithPendingUpdates = sinon.stub().callsArgWith(0, null, @docs)
|
|
@UpdateManager.processOutstandingUpdatesWithLock = sinon.stub().callsArg(2)
|
|
@UpdateManager.resumeProcessing(done)
|
|
|
|
it "should the docs that haven't been processed yet", ->
|
|
@RedisManager.getDocsWithPendingUpdates
|
|
.called.should.equal true
|
|
|
|
it "should call processOutstandingUpdatesWithLock for each doc", ->
|
|
for doc in @docs
|
|
@UpdateManager.processOutstandingUpdatesWithLock
|
|
.calledWith(doc.project_id, doc.doc_id)
|
|
.should.equal true
|
|
|
|
describe "processOutstandingUpdates", ->
|
|
beforeEach ->
|
|
@UpdateManager.fetchAndApplyUpdates = sinon.stub().callsArg(2)
|
|
@RedisManager.clearDocFromPendingUpdatesSet = sinon.stub().callsArg(2)
|
|
@UpdateManager.processOutstandingUpdates @project_id, @doc_id, @callback
|
|
|
|
it "should apply the updates", ->
|
|
@UpdateManager.fetchAndApplyUpdates.calledWith(@project_id, @doc_id).should.equal true
|
|
|
|
it "should clear the doc from the process pending set", ->
|
|
@RedisManager.clearDocFromPendingUpdatesSet
|
|
.calledWith(@project_id, @doc_id)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
it "should time the execution", ->
|
|
@Metrics.Timer::done.called.should.equal true
|
|
|
|
describe "processOutstandingUpdatesWithLock", ->
|
|
describe "when the lock is free", ->
|
|
beforeEach ->
|
|
@LockManager.tryLock = sinon.stub().callsArgWith(1, null, true)
|
|
@LockManager.releaseLock = sinon.stub().callsArg(1)
|
|
@UpdateManager.continueProcessingUpdatesWithLock = sinon.stub().callsArg(2)
|
|
@UpdateManager.processOutstandingUpdates = sinon.stub().callsArg(2)
|
|
|
|
describe "successfully", ->
|
|
beforeEach ->
|
|
@UpdateManager.processOutstandingUpdatesWithLock @project_id, @doc_id, @callback
|
|
|
|
it "should acquire the lock", ->
|
|
@LockManager.tryLock.calledWith(@doc_id).should.equal true
|
|
|
|
it "should free the lock", ->
|
|
@LockManager.releaseLock.calledWith(@doc_id).should.equal true
|
|
|
|
it "should process the outstanding updates", ->
|
|
@UpdateManager.processOutstandingUpdates.calledWith(@project_id, @doc_id).should.equal true
|
|
|
|
it "should do everything with the lock acquired", ->
|
|
@UpdateManager.processOutstandingUpdates.calledAfter(@LockManager.tryLock).should.equal true
|
|
@UpdateManager.processOutstandingUpdates.calledBefore(@LockManager.releaseLock).should.equal true
|
|
|
|
it "should continue processing new updates that may have come in", ->
|
|
@UpdateManager.continueProcessingUpdatesWithLock.calledWith(@project_id, @doc_id).should.equal true
|
|
|
|
it "should return the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "when processOutstandingUpdates returns an error", ->
|
|
beforeEach ->
|
|
@UpdateManager.processOutstandingUpdates = sinon.stub().callsArgWith(2, @error = new Error("Something went wrong"))
|
|
@UpdateManager.processOutstandingUpdatesWithLock @project_id, @doc_id, @callback
|
|
|
|
it "should free the lock", ->
|
|
@LockManager.releaseLock.calledWith(@doc_id).should.equal true
|
|
|
|
it "should return the error in the callback", ->
|
|
@callback.calledWith(@error).should.equal true
|
|
|
|
describe "when the lock is taken", ->
|
|
beforeEach ->
|
|
@LockManager.tryLock = sinon.stub().callsArgWith(1, null, false)
|
|
@UpdateManager.processOutstandingUpdates = sinon.stub().callsArg(2)
|
|
@UpdateManager.processOutstandingUpdatesWithLock @project_id, @doc_id, @callback
|
|
|
|
it "should return the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
it "should not process the updates", ->
|
|
@UpdateManager.processOutstandingUpdates.called.should.equal false
|
|
|
|
describe "continueProcessingUpdatesWithLock", ->
|
|
describe "when there are outstanding updates", ->
|
|
beforeEach ->
|
|
@RedisManager.getUpdatesLength = sinon.stub().callsArgWith(1, null, 3)
|
|
@UpdateManager.processOutstandingUpdatesWithLock = sinon.stub().callsArg(2)
|
|
@UpdateManager.continueProcessingUpdatesWithLock @project_id, @doc_id, @callback
|
|
|
|
it "should process the outstanding updates", ->
|
|
@UpdateManager.processOutstandingUpdatesWithLock.calledWith(@project_id, @doc_id).should.equal true
|
|
|
|
it "should return the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "when there are no outstanding updates", ->
|
|
beforeEach ->
|
|
@RedisManager.getUpdatesLength = sinon.stub().callsArgWith(1, null, 0)
|
|
@UpdateManager.processOutstandingUpdatesWithLock = sinon.stub().callsArg(2)
|
|
@UpdateManager.continueProcessingUpdatesWithLock @project_id, @doc_id, @callback
|
|
|
|
it "should not try to process the outstanding updates", ->
|
|
@UpdateManager.processOutstandingUpdatesWithLock.called.should.equal false
|
|
|
|
it "should return the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "fetchAndApplyUpdates", ->
|
|
describe "with updates", ->
|
|
beforeEach ->
|
|
@updates = [{p: 1, t: "foo"}]
|
|
@updatedDocLines = ["updated", "lines"]
|
|
@version = 34
|
|
@RedisManager.getPendingUpdatesForDoc = sinon.stub().callsArgWith(1, null, @updates)
|
|
@UpdateManager.applyUpdates = sinon.stub().callsArgWith(3, null, @updatedDocLines, @version)
|
|
@UpdateManager.fetchAndApplyUpdates @project_id, @doc_id, @callback
|
|
|
|
it "should get the pending updates", ->
|
|
@RedisManager.getPendingUpdatesForDoc.calledWith(@doc_id).should.equal true
|
|
|
|
it "should apply the updates", ->
|
|
@UpdateManager.applyUpdates
|
|
.calledWith(@project_id, @doc_id, @updates)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "when there are no updates", ->
|
|
beforeEach ->
|
|
@updates = []
|
|
@RedisManager.getPendingUpdatesForDoc = sinon.stub().callsArgWith(1, null, @updates)
|
|
@UpdateManager.applyUpdates = sinon.stub()
|
|
@RedisManager.setDocument = sinon.stub()
|
|
@UpdateManager.fetchAndApplyUpdates @project_id, @doc_id, @callback
|
|
|
|
it "should not call applyUpdates", ->
|
|
@UpdateManager.applyUpdates.called.should.equal false
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "applyUpdates", ->
|
|
beforeEach ->
|
|
@updates = [{op: [{p: 42, i: "foo"}]}]
|
|
@updatedDocLines = ["updated", "lines"]
|
|
@version = 34
|
|
@ShareJsUpdateManager.applyUpdates = sinon.stub().callsArgWith(3, null, @updatedDocLines, @version)
|
|
@RedisManager.setDocument = sinon.stub().callsArg(3)
|
|
|
|
describe "normally", ->
|
|
beforeEach ->
|
|
@UpdateManager.applyUpdates @project_id, @doc_id, @updates, @callback
|
|
|
|
it "should apply the updates via ShareJS", ->
|
|
@ShareJsUpdateManager.applyUpdates
|
|
.calledWith(@project_id, @doc_id, @updates)
|
|
.should.equal true
|
|
|
|
it "should save the document", ->
|
|
@RedisManager.setDocument
|
|
.calledWith(@doc_id, @updatedDocLines, @version)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "with UTF-16 surrogate pairs in the update", ->
|
|
beforeEach ->
|
|
@updates = [{op: [{p: 42, i: "\uD835\uDC00"}]}]
|
|
@UpdateManager.applyUpdates @project_id, @doc_id, @updates, @callback
|
|
|
|
it "should apply the update but with surrogate pairs removed", ->
|
|
@ShareJsUpdateManager.applyUpdates
|
|
.calledWith(@project_id, @doc_id, @updates)
|
|
.should.equal true
|
|
|
|
# \uFFFD is 'replacement character'
|
|
@updates[0].op[0].i.should.equal "\uFFFD\uFFFD"
|
|
|