chai = require('chai') should = chai.should() sinon = require("sinon") modulePath = "../../../app/js/WebsocketController.js" SandboxedModule = require('sandboxed-module') tk = require "timekeeper" describe 'WebsocketController', -> beforeEach -> tk.freeze(new Date()) @project_id = "project-id-123" @user = { _id: "user-id-123" first_name: "James" last_name: "Allen" email: "james@example.com" signUpDate: new Date("2014-01-01") loginCount: 42 } @callback = sinon.stub() @client = params: {} set: sinon.stub() get: (param, cb) -> cb null, @params[param] join: sinon.stub() leave: sinon.stub() @WebsocketController = SandboxedModule.require modulePath, requires: "./WebApiManager": @WebApiManager = {} "./AuthorizationManager": @AuthorizationManager = {} "./DocumentUpdaterManager": @DocumentUpdaterManager = {} "logger-sharelatex": @logger = { log: sinon.stub(), error: sinon.stub() } afterEach -> tk.reset() describe "joinProject", -> describe "when authorised", -> beforeEach -> @project = { name: "Test Project" owner: { _id: @owner_id = "mock-owner-id-123" } } @privilegeLevel = "owner" @WebApiManager.joinProject = sinon.stub().callsArgWith(2, null, @project, @privilegeLevel) @WebsocketController.joinProject @client, @user, @project_id, @callback it "should load the project from web", -> @WebApiManager.joinProject .calledWith(@project_id, @user._id) .should.equal true it "should set the privilege level on the client", -> @client.set.calledWith("privilege_level", @privilegeLevel).should.equal true it "should set the user's id on the client", -> @client.set.calledWith("user_id", @user._id).should.equal true it "should set the user's email on the client", -> @client.set.calledWith("email", @user.email).should.equal true it "should set the user's first_name on the client", -> @client.set.calledWith("first_name", @user.first_name).should.equal true it "should set the user's last_name on the client", -> @client.set.calledWith("last_name", @user.last_name).should.equal true it "should set the user's sign up date on the client", -> @client.set.calledWith("signup_date", @user.signUpDate).should.equal true it "should set the user's login_count on the client", -> @client.set.calledWith("login_count", @user.loginCount).should.equal true it "should set the connected time on the client", -> @client.set.calledWith("connected_time", new Date()).should.equal true it "should set the project_id on the client", -> @client.set.calledWith("project_id", @project_id).should.equal true it "should set the project owner id on the client", -> @client.set.calledWith("owner_id", @owner_id).should.equal true it "should call the callback with the project, privilegeLevel and protocolVersion", -> @callback .calledWith(null, @project, @privilegeLevel, @WebsocketController.PROTOCOL_VERSION) .should.equal true describe "when not authorized", -> beforeEach -> @WebApiManager.joinProject = sinon.stub().callsArgWith(2, null, null, null) @WebsocketController.joinProject @client, @user, @project_id, @callback it "should return an error", -> @callback .calledWith(new Error("not authorized")) .should.equal true describe "joinDoc", -> beforeEach -> @doc_id = "doc-id-123" @doc_lines = ["doc", "lines"] @version = 42 @ops = ["mock", "ops"] @client.params.project_id = @project_id @AuthorizationManager.assertClientCanViewProject = sinon.stub().callsArgWith(1, null) @DocumentUpdaterManager.getDocument = sinon.stub().callsArgWith(3, null, @doc_lines, @version, @ops) describe "with a fromVersion", -> beforeEach -> @fromVersion = 40 @WebsocketController.joinDoc @client, @doc_id, @fromVersion, @callback it "should check that the client is authorized to view the project", -> @AuthorizationManager.assertClientCanViewProject .calledWith(@client) .should.equal true it "should get the document from the DocumentUpdaterManager", -> @DocumentUpdaterManager.getDocument .calledWith(@project_id, @doc_id, @fromVersion) .should.equal true it "should join the client to room for the doc_id", -> @client.join .calledWith(@doc_id) .should.equal true it "should call the callback with the lines, version and ops", -> @callback .calledWith(null, @doc_lines, @version, @ops) .should.equal true describe "with doclines that need escaping", -> beforeEach -> @doc_lines.push ["räksmörgås"] @WebsocketController.joinDoc @client, @doc_id, -1, @callback it "should call the callback with the escaped lines", -> escaped_lines = @callback.args[0][1] escaped_word = escaped_lines.pop() escaped_word.should.equal 'räksmörgÃ¥s' # Check that unescaping works decodeURIComponent(escape(escaped_word)).should.equal "räksmörgås" describe "when not authorized", -> beforeEach -> @AuthorizationManager.assertClientCanViewProject = sinon.stub().callsArgWith(1, @err = new Error("not authorized")) @WebsocketController.joinDoc @client, @doc_id, -1, @callback it "should call the callback with an error", -> @callback.calledWith(@err).should.equal true it "should not call the DocumentUpdaterManager", -> @DocumentUpdaterManager.getDocument.called.should.equal false describe "leaveDoc", -> beforeEach -> @doc_id = "doc-id-123" @client.params.project_id = @project_id @WebsocketController.leaveDoc @client, @doc_id, @callback it "should remove the client from the doc_id room", -> @client.leave .calledWith(@doc_id).should.equal true it "should call the callback", -> @callback.called.should.equal true