ConnectedUsersManager.coffee 3.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. async = require("async")
  2. Settings = require('settings-sharelatex')
  3. logger = require("logger-sharelatex")
  4. redis = require("redis-sharelatex")
  5. rclient = redis.createClient(Settings.redis.realtime)
  6. Keys = Settings.redis.realtime.key_schema
  7. ONE_HOUR_IN_S = 60 * 60
  8. ONE_DAY_IN_S = ONE_HOUR_IN_S * 24
  9. FOUR_DAYS_IN_S = ONE_DAY_IN_S * 4
  10. USER_TIMEOUT_IN_S = ONE_HOUR_IN_S / 4
  11. REFRESH_TIMEOUT_IN_S = 10 # only show clients which have responded to a refresh request in the last 10 seconds
  12. module.exports =
  13. # Use the same method for when a user connects, and when a user sends a cursor
  14. # update. This way we don't care if the connected_user key has expired when
  15. # we receive a cursor update.
  16. updateUserPosition: (project_id, client_id, user, cursorData, callback = (err)->)->
  17. logger.log project_id:project_id, client_id:client_id, "marking user as joined or connected"
  18. multi = rclient.multi()
  19. multi.sadd Keys.clientsInProject({project_id}), client_id
  20. multi.expire Keys.clientsInProject({project_id}), FOUR_DAYS_IN_S
  21. multi.hset Keys.connectedUser({project_id, client_id}), "last_updated_at", Date.now()
  22. multi.hset Keys.connectedUser({project_id, client_id}), "user_id", user._id
  23. multi.hset Keys.connectedUser({project_id, client_id}), "first_name", user.first_name or ""
  24. multi.hset Keys.connectedUser({project_id, client_id}), "last_name", user.last_name or ""
  25. multi.hset Keys.connectedUser({project_id, client_id}), "email", user.email or ""
  26. if cursorData?
  27. multi.hset Keys.connectedUser({project_id, client_id}), "cursorData", JSON.stringify(cursorData)
  28. multi.expire Keys.connectedUser({project_id, client_id}), USER_TIMEOUT_IN_S
  29. multi.exec (err)->
  30. if err?
  31. logger.err err:err, project_id:project_id, client_id:client_id, "problem marking user as connected"
  32. callback(err)
  33. refreshClient: (project_id, client_id, callback = (err) ->) ->
  34. logger.log project_id:project_id, client_id:client_id, "refreshing connected client"
  35. multi = rclient.multi()
  36. multi.hset Keys.connectedUser({project_id, client_id}), "last_updated_at", Date.now()
  37. multi.expire Keys.connectedUser({project_id, client_id}), USER_TIMEOUT_IN_S
  38. multi.exec (err)->
  39. if err?
  40. logger.err err:err, project_id:project_id, client_id:client_id, "problem refreshing connected client"
  41. callback(err)
  42. markUserAsDisconnected: (project_id, client_id, callback)->
  43. logger.log project_id:project_id, client_id:client_id, "marking user as disconnected"
  44. multi = rclient.multi()
  45. multi.srem Keys.clientsInProject({project_id}), client_id
  46. multi.expire Keys.clientsInProject({project_id}), FOUR_DAYS_IN_S
  47. multi.del Keys.connectedUser({project_id, client_id})
  48. multi.exec callback
  49. _getConnectedUser: (project_id, client_id, callback)->
  50. rclient.hgetall Keys.connectedUser({project_id, client_id}), (err, result)->
  51. if !result? or Object.keys(result).length == 0 or !result.user_id
  52. result =
  53. connected : false
  54. client_id:client_id
  55. else
  56. result.connected = true
  57. result.client_id = client_id
  58. result.client_age = (Date.now() - parseInt(result.last_updated_at,10)) / 1000
  59. if result.cursorData?
  60. try
  61. result.cursorData = JSON.parse(result.cursorData)
  62. catch e
  63. logger.error {err: e, project_id, client_id, cursorData: result.cursorData}, "error parsing cursorData JSON"
  64. return callback e
  65. callback err, result
  66. getConnectedUsers: (project_id, callback)->
  67. self = @
  68. rclient.smembers Keys.clientsInProject({project_id}), (err, results)->
  69. return callback(err) if err?
  70. jobs = results.map (client_id)->
  71. (cb)->
  72. self._getConnectedUser(project_id, client_id, cb)
  73. async.series jobs, (err, users = [])->
  74. return callback(err) if err?
  75. users = users.filter (user) ->
  76. user?.connected && user?.client_age < REFRESH_TIMEOUT_IN_S
  77. callback null, users