sinon = require('sinon') chai = require('chai') should = chai.should() modulePath = "../../../../app/js/RedisManager.js" SandboxedModule = require('sandboxed-module') Errors = require "../../../../app/js/Errors" describe "RedisManager", -> beforeEach -> @rclient = auth: () -> exec: sinon.stub() @rclient.multi = () => @rclient @RedisManager = SandboxedModule.require modulePath, requires: "./RedisBackend": createClient: () => @rclient "./RedisKeyBuilder": blockingKey: ({doc_id}) -> "Blocking:#{doc_id}" docLines: ({doc_id}) -> "doclines:#{doc_id}" docOps: ({doc_id}) -> "DocOps:#{doc_id}" docVersion: ({doc_id}) -> "DocVersion:#{doc_id}" projectKey: ({doc_id}) -> "ProjectId:#{doc_id}" pendingUpdates: ({doc_id}) -> "PendingUpdates:#{doc_id}" docsInProject: ({project_id}) -> "DocsIn:#{project_id}" trackChangesEnabled: ({doc_id}) -> "TrackChangesEnabled:#{doc_id}" trackChangesEntries: ({doc_id}) -> "TrackChangesEntries:#{doc_id}" "logger-sharelatex": @logger = { error: sinon.stub(), log: sinon.stub(), warn: sinon.stub() } "./Metrics": @metrics = inc: sinon.stub() Timer: class Timer done: () -> "./Errors": Errors @doc_id = "doc-id-123" @project_id = "project-id-123" @callback = sinon.stub() describe "getDoc", -> beforeEach -> @lines = ["one", "two", "three"] @jsonlines = JSON.stringify @lines @version = 42 @track_changes_on = true @redis_track_changes_on = "1" @track_changes_entries = { comments: "mock", entries: "mock" } @json_track_changes_entries = JSON.stringify @track_changes_entries @rclient.get = sinon.stub() @rclient.exec = sinon.stub().callsArgWith(0, null, [@jsonlines, @version, @project_id, @redis_track_changes_on, @json_track_changes_entries]) describe "successfully", -> beforeEach -> @RedisManager.getDoc @project_id, @doc_id, @callback it "should get the lines from redis", -> @rclient.get .calledWith("doclines:#{@doc_id}") .should.equal true it "should get the version from", -> @rclient.get .calledWith("DocVersion:#{@doc_id}") .should.equal true it "should get the track changes state", -> @rclient.get .calledWith("TrackChangesEnabled:#{@doc_id}") .should.equal true it "should get the track changes entries", -> @rclient.get .calledWith("TrackChangesEntries:#{@doc_id}") .should.equal true it 'should return the document', -> @callback .calledWith(null, @lines, @version, @track_changes_on, @track_changes_entries) .should.equal true describe "getDoc with an invalid project id", -> beforeEach -> @another_project_id = "project-id-456" @rclient.exec = sinon.stub().callsArgWith(0, null, [@jsonlines, @version, @another_project_id, @redis_track_changes_on, @json_track_changes_entries]) @RedisManager.getDoc @project_id, @doc_id, @callback it 'should return an error', -> @callback .calledWith(new Errors.NotFoundError("not found")) .should.equal true describe "getPreviousDocOpsTests", -> describe "with a start and an end value", -> beforeEach -> @first_version_in_redis = 30 @version = 70 @length = @version - @first_version_in_redis @start = 50 @end = 60 @ops = [ { "mock": "op-1" }, { "mock": "op-2" } ] @jsonOps = @ops.map (op) -> JSON.stringify op @rclient.llen = sinon.stub().callsArgWith(1, null, @length) @rclient.get = sinon.stub().callsArgWith(1, null, @version.toString()) @rclient.lrange = sinon.stub().callsArgWith(3, null, @jsonOps) @RedisManager.getPreviousDocOps(@doc_id, @start, @end, @callback) it "should get the length of the existing doc ops", -> @rclient.llen .calledWith("DocOps:#{@doc_id}") .should.equal true it "should get the current version of the doc", -> @rclient.get .calledWith("DocVersion:#{@doc_id}") .should.equal true it "should get the appropriate docs ops", -> @rclient.lrange .calledWith("DocOps:#{@doc_id}", @start - @first_version_in_redis, @end - @first_version_in_redis) .should.equal true it "should return the docs with the doc ops deserialized", -> @callback.calledWith(null, @ops).should.equal true describe "with an end value of -1", -> beforeEach -> @first_version_in_redis = 30 @version = 70 @length = @version - @first_version_in_redis @start = 50 @end = -1 @ops = [ { "mock": "op-1" }, { "mock": "op-2" } ] @jsonOps = @ops.map (op) -> JSON.stringify op @rclient.llen = sinon.stub().callsArgWith(1, null, @length) @rclient.get = sinon.stub().callsArgWith(1, null, @version.toString()) @rclient.lrange = sinon.stub().callsArgWith(3, null, @jsonOps) @RedisManager.getPreviousDocOps(@doc_id, @start, @end, @callback) it "should get the appropriate docs ops to the end of list", -> @rclient.lrange .calledWith("DocOps:#{@doc_id}", @start - @first_version_in_redis, -1) .should.equal true it "should return the docs with the doc ops deserialized", -> @callback.calledWith(null, @ops).should.equal true describe "when the requested range is not in Redis", -> beforeEach -> @first_version_in_redis = 30 @version = 70 @length = @version - @first_version_in_redis @start = 20 @end = -1 @ops = [ { "mock": "op-1" }, { "mock": "op-2" } ] @jsonOps = @ops.map (op) -> JSON.stringify op @rclient.llen = sinon.stub().callsArgWith(1, null, @length) @rclient.get = sinon.stub().callsArgWith(1, null, @version.toString()) @rclient.lrange = sinon.stub().callsArgWith(3, null, @jsonOps) @RedisManager.getPreviousDocOps(@doc_id, @start, @end, @callback) it "should return an error", -> @callback.calledWith(new Errors.OpRangeNotAvailableError("doc ops range is not loaded in redis")).should.equal true it "should log out the problem", -> @logger.warn.called.should.equal true describe "updateDocument", -> beforeEach -> @rclient.set = sinon.stub() @rclient.rpush = sinon.stub() @rclient.expire = sinon.stub() @rclient.ltrim = sinon.stub() @RedisManager.getDocVersion = sinon.stub() @lines = ["one", "two", "three"] @ops = [{ op: [{ i: "foo", p: 4 }] },{ op: [{ i: "bar", p: 8 }] }] @version = 42 @track_changes_entries = { comments: "mock", entries: "mock" } @rclient.exec = sinon.stub().callsArg(0) describe "with a consistent version", -> beforeEach -> @RedisManager.getDocVersion.withArgs(@doc_id).yields(null, @version - @ops.length) @RedisManager.updateDocument @doc_id, @lines, @version, @ops, @track_changes_entries, @callback it "should get the current doc version to check for consistency", -> @RedisManager.getDocVersion .calledWith(@doc_id) .should.equal true it "should set the doclines", -> @rclient.set .calledWith("doclines:#{@doc_id}", JSON.stringify(@lines)) .should.equal true it "should set the version", -> @rclient.set .calledWith("DocVersion:#{@doc_id}", @version) .should.equal true it "should set the track changes entries", -> @rclient.set .calledWith("TrackChangesEntries:#{@doc_id}", JSON.stringify(@track_changes_entries)) .should.equal true it "should push the doc op into the doc ops list", -> @rclient.rpush .calledWith("DocOps:#{@doc_id}", JSON.stringify(@ops[0]), JSON.stringify(@ops[1])) .should.equal true it "should renew the expiry ttl on the doc ops array", -> @rclient.expire .calledWith("DocOps:#{@doc_id}", @RedisManager.DOC_OPS_TTL) .should.equal true it "should truncate the list to 100 members", -> @rclient.ltrim .calledWith("DocOps:#{@doc_id}", -@RedisManager.DOC_OPS_MAX_LENGTH, -1) .should.equal true it "should call the callback", -> @callback.called.should.equal true describe "with an inconsistent version", -> beforeEach -> @RedisManager.getDocVersion.withArgs(@doc_id).yields(null, @version - @ops.length - 1) @RedisManager.updateDocument @doc_id, @lines, @version, @ops, @track_changes_entries, @callback it "should not call multi.exec", -> @rclient.exec.called.should.equal false it "should call the callback with an error", -> @callback .calledWith(new Error("Version mismatch. '#{@doc_id}' is corrupted.")) .should.equal true describe "with no updates", -> beforeEach -> @RedisManager.getDocVersion.withArgs(@doc_id).yields(null, @version) @RedisManager.updateDocument @doc_id, @lines, @version, [], @track_changes_entries, @callback it "should not do an rpush", -> @rclient.rpush .called .should.equal false it "should still set the doclines", -> @rclient.set .calledWith("doclines:#{@doc_id}", JSON.stringify(@lines)) .should.equal true describe "putDocInMemory", -> beforeEach (done) -> @rclient.set = sinon.stub() @rclient.sadd = sinon.stub().yields() @rclient.exec.yields() @lines = ["one", "two", "three"] @version = 42 @track_changes_on = true @track_changes_entries = { comments: "mock", entries: "mock" } @RedisManager.putDocInMemory @project_id, @doc_id, @lines, @version, @track_changes_on, @track_changes_entries, done it "should set the lines", -> @rclient.set .calledWith("doclines:#{@doc_id}", JSON.stringify @lines) .should.equal true it "should set the version", -> @rclient.set .calledWith("DocVersion:#{@doc_id}", @version) .should.equal true it "should set the track changes entries", -> @rclient.set .calledWith("TrackChangesEntries:#{@doc_id}", JSON.stringify(@track_changes_entries)) .should.equal true it "should set the track changes state", -> @rclient.set .calledWith("TrackChangesEnabled:#{@doc_id}", "1") .should.equal true it "should set the project_id for the doc", -> @rclient.set .calledWith("ProjectId:#{@doc_id}", @project_id) .should.equal true it "should add the doc_id to the project set", -> @rclient.sadd .calledWith("DocsIn:#{@project_id}", @doc_id) .should.equal true describe "removeDocFromMemory", -> beforeEach (done) -> @rclient.del = sinon.stub() @rclient.srem = sinon.stub().yields() @rclient.exec.yields() @RedisManager.removeDocFromMemory @project_id, @doc_id, done it "should delete the lines", -> @rclient.del .calledWith("doclines:#{@doc_id}") .should.equal true it "should delete the version", -> @rclient.del .calledWith("DocVersion:#{@doc_id}") .should.equal true it "should delete the project_id for the doc", -> @rclient.del .calledWith("ProjectId:#{@doc_id}") .should.equal true it "should remove the doc_id from the project set", -> @rclient.srem .calledWith("DocsIn:#{@project_id}", @doc_id) .should.equal true