From d1f907cee59660289d5f18813abba171c8a0315c Mon Sep 17 00:00:00 2001
From: Henry Oswald <henry.oswald@sharelatex.com>
Date: Fri, 4 Jul 2014 16:18:46 +0100
Subject: [PATCH] first simple version of tracking who is active in the editor

---
 .../ConnectedUsersManager.coffee              | 49 ++++++++++
 .../ConnectedUsersManagerTests.coffee         | 93 +++++++++++++++++++
 2 files changed, 142 insertions(+)
 create mode 100644 services/web/app/coffee/Features/ConnectedUsers/ConnectedUsersManager.coffee
 create mode 100644 services/web/test/UnitTests/coffee/ConnectedUsersManager/ConnectedUsersManagerTests.coffee

diff --git a/services/web/app/coffee/Features/ConnectedUsers/ConnectedUsersManager.coffee b/services/web/app/coffee/Features/ConnectedUsers/ConnectedUsersManager.coffee
new file mode 100644
index 0000000000..0e1cd0324f
--- /dev/null
+++ b/services/web/app/coffee/Features/ConnectedUsers/ConnectedUsersManager.coffee
@@ -0,0 +1,49 @@
+_ = require("underscore")
+async = require("async")
+Settings = require('settings-sharelatex')
+redis = require('redis')
+rclient = redis.createClient(Settings.redis.web.port, Settings.redis.web.host)
+rclient.auth(Settings.redis.web.password)
+
+
+ONE_HOUR_IN_S = 60 * 60
+
+buildUserKey = (project_id, user_id)-> return "connected_user:#{project_id}:#{user_id}"
+buildProjectSetKey = (project_id)-> return "connected_user:#{project_id}"
+
+
+module.exports = 
+
+	markUserAsConnected: (project_id, user_id, callback = (err)->)->
+		async.series [
+			(cb)->
+				rclient.sadd buildProjectSetKey(project_id), user_id, cb
+			(cb)->
+				rclient.setex buildUserKey(project_id, user_id), new Date(), ONE_HOUR_IN_S * 6, cb
+		], callback
+
+
+	_getConnectedUser: (project_id, user_id, callback)->
+		rclient.get buildUserKey(project_id, user_id), (err, result)->
+			if !result?
+				connected = false
+			else
+				connected = true
+
+			callback err, {connected:connected, user_id:user_id}
+
+	getConnectedUsers: (project_id, callback)->
+		self = @
+		rclient.get "connected_users_list:#{project_id}", (err, results)->
+
+			jobs = results.map (user_id)->
+				(cb)->
+					self._getConnectedUser(project_id, user_id, cb)
+			async.series jobs, (err, users)->
+				users = _.filter users, (user)->
+					user.connected
+				user_ids = _.map users, (user)->
+					user.user_id
+				callback err, user_ids
+
+
diff --git a/services/web/test/UnitTests/coffee/ConnectedUsersManager/ConnectedUsersManagerTests.coffee b/services/web/test/UnitTests/coffee/ConnectedUsersManager/ConnectedUsersManagerTests.coffee
new file mode 100644
index 0000000000..c6616ab1b6
--- /dev/null
+++ b/services/web/test/UnitTests/coffee/ConnectedUsersManager/ConnectedUsersManagerTests.coffee
@@ -0,0 +1,93 @@
+
+should = require('chai').should()
+SandboxedModule = require('sandboxed-module')
+assert = require('assert')
+path = require('path')
+sinon = require('sinon')
+modulePath = path.join __dirname, "../../../../app/js/Features/ConnectedUsers/ConnectedUsersManager"
+expect = require("chai").expect
+tk = require("timekeeper")
+
+
+describe "ConnectedUsersManager", ->
+
+	beforeEach ->
+
+		@settings =
+			redis:
+				web:{}
+		@rClient =
+			auth:->
+			setex:sinon.stub()
+			sadd:sinon.stub()
+			get: sinon.stub()
+		tk.freeze(new Date())
+
+		@ConnectedUsersManager = SandboxedModule.require modulePath, requires:
+			"settings-sharelatex":@settings
+			"logger-sharelatex": log:->
+			"redis": createClient:=> 
+				return @rClient
+		@user_id = "32132132"
+		@project_id = "dskjh2u21321"
+
+	afterEach -> 
+		tk.reset()
+
+	describe "markUserAsConnected", ->
+		beforeEach ->
+			@rClient.setex.callsArgWith(3)
+			@rClient.sadd.callsArgWith(2)
+
+
+		it "should set a key with the date and give it a ttl", (done)->
+			@ConnectedUsersManager.markUserAsConnected @project_id, @user_id, (err)=>
+				@rClient.setex.calledWith("connected_user:#{@project_id}:#{@user_id}", new Date(), 60 * 60 * 6).should.equal true
+				done()
+
+		it "should push the user_id on to the project list", (done)->
+			@ConnectedUsersManager.markUserAsConnected @project_id, @user_id, (err)=>
+				@rClient.sadd.calledWith("connected_user:#{@project_id}", @user_id).should.equal true
+				done()
+
+
+	describe "_getConnectedUser", ->
+
+		it "should get the user returning connected if there is a value", (done)->
+			@rClient.get.callsArgWith(1, null, new Date())
+			@ConnectedUsersManager._getConnectedUser @project_id, @user_id, (err, result)=>
+				result.connected.should.equal true
+				result.user_id.should.equal @user_id
+				done()
+
+		it "should get the user returning connected if there is a value", (done)->
+			@rClient.get.callsArgWith(1)
+			@ConnectedUsersManager._getConnectedUser @project_id, @user_id, (err, result)=>
+				result.connected.should.equal false
+				result.user_id.should.equal @user_id
+				done()
+
+
+
+	describe "getConnectedUsers", ->
+
+		beforeEach ->
+			@users = ["1234", "5678", "9123"]
+			@rClient.get.callsArgWith(1, null, @users)
+			@ConnectedUsersManager._getConnectedUser = sinon.stub()
+			@ConnectedUsersManager._getConnectedUser.withArgs(@project_id, @users[0]).callsArgWith(2, null, {connected:true, user_id:@users[0]})
+			@ConnectedUsersManager._getConnectedUser.withArgs(@project_id, @users[1]).callsArgWith(2, null, {connected:false, user_id:@users[1]})
+			@ConnectedUsersManager._getConnectedUser.withArgs(@project_id, @users[2]).callsArgWith(2, null, {connected:true, user_id:@users[2]})
+
+
+		it "should only return the users in the list which are still in redis", (done)->
+			@ConnectedUsersManager.getConnectedUsers @project_id, (err, users)=>
+				users.length.should.equal 2
+				users[0].should.equal @users[0]
+				users[1].should.equal @users[2]
+				done()
+
+
+
+
+