DocumentUpdaterController.coffee 4.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. logger = require "logger-sharelatex"
  2. settings = require 'settings-sharelatex'
  3. RedisClientManager = require "./RedisClientManager"
  4. SafeJsonParse = require "./SafeJsonParse"
  5. EventLogger = require "./EventLogger"
  6. HealthCheckManager = require "./HealthCheckManager"
  7. RoomManager = require "./RoomManager"
  8. ChannelManager = require "./ChannelManager"
  9. metrics = require "metrics-sharelatex"
  10. MESSAGE_SIZE_LOG_LIMIT = 1024 * 1024 # 1Mb
  11. module.exports = DocumentUpdaterController =
  12. # DocumentUpdaterController is responsible for updates that come via Redis
  13. # Pub/Sub from the document updater.
  14. rclientList: RedisClientManager.createClientList(settings.redis.pubsub)
  15. listenForUpdatesFromDocumentUpdater: (io) ->
  16. logger.log {rclients: @rclientList.length}, "listening for applied-ops events"
  17. for rclient, i in @rclientList
  18. rclient.subscribe "applied-ops"
  19. rclient.on "message", (channel, message) ->
  20. metrics.inc "rclient", 0.001 # global event rate metric
  21. EventLogger.debugEvent(channel, message) if settings.debugEvents > 0
  22. DocumentUpdaterController._processMessageFromDocumentUpdater(io, channel, message)
  23. # create metrics for each redis instance only when we have multiple redis clients
  24. if @rclientList.length > 1
  25. for rclient, i in @rclientList
  26. do (i) ->
  27. rclient.on "message", () ->
  28. metrics.inc "rclient-#{i}", 0.001 # per client event rate metric
  29. @handleRoomUpdates(@rclientList)
  30. handleRoomUpdates: (rclientSubList) ->
  31. roomEvents = RoomManager.eventSource()
  32. roomEvents.on 'doc-active', (doc_id) ->
  33. subscribePromises = for rclient in rclientSubList
  34. ChannelManager.subscribe rclient, "applied-ops", doc_id
  35. RoomManager.emitOnCompletion(subscribePromises, "doc-subscribed-#{doc_id}")
  36. roomEvents.on 'doc-empty', (doc_id) ->
  37. for rclient in rclientSubList
  38. ChannelManager.unsubscribe rclient, "applied-ops", doc_id
  39. _processMessageFromDocumentUpdater: (io, channel, message) ->
  40. SafeJsonParse.parse message, (error, message) ->
  41. if error?
  42. logger.error {err: error, channel}, "error parsing JSON"
  43. return
  44. if message.op?
  45. if message._id? && settings.checkEventOrder
  46. status = EventLogger.checkEventOrder("applied-ops", message._id, message)
  47. if status is 'duplicate'
  48. return # skip duplicate events
  49. DocumentUpdaterController._applyUpdateFromDocumentUpdater(io, message.doc_id, message.op)
  50. else if message.error?
  51. DocumentUpdaterController._processErrorFromDocumentUpdater(io, message.doc_id, message.error, message)
  52. else if message.health_check?
  53. logger.debug {message}, "got health check message in applied ops channel"
  54. HealthCheckManager.check channel, message.key
  55. _applyUpdateFromDocumentUpdater: (io, doc_id, update) ->
  56. clientList = io.sockets.clients(doc_id)
  57. # avoid unnecessary work if no clients are connected
  58. if clientList.length is 0
  59. return
  60. # send updates to clients
  61. logger.log doc_id: doc_id, version: update.v, source: update.meta?.source, socketIoClients: (client.id for client in clientList), "distributing updates to clients"
  62. seen = {}
  63. # send messages only to unique clients (due to duplicate entries in io.sockets.clients)
  64. for client in clientList when not seen[client.id]
  65. seen[client.id] = true
  66. if client.id == update.meta.source
  67. logger.log doc_id: doc_id, version: update.v, source: update.meta?.source, "distributing update to sender"
  68. client.emit "otUpdateApplied", v: update.v, doc: update.doc
  69. else if !update.dup # Duplicate ops should just be sent back to sending client for acknowledgement
  70. logger.log doc_id: doc_id, version: update.v, source: update.meta?.source, client_id: client.id, "distributing update to collaborator"
  71. client.emit "otUpdateApplied", update
  72. if Object.keys(seen).length < clientList.length
  73. metrics.inc "socket-io.duplicate-clients", 0.1
  74. logger.log doc_id: doc_id, socketIoClients: (client.id for client in clientList), "discarded duplicate clients"
  75. _processErrorFromDocumentUpdater: (io, doc_id, error, message) ->
  76. for client in io.sockets.clients(doc_id)
  77. logger.warn err: error, doc_id: doc_id, client_id: client.id, "error from document updater, disconnecting client"
  78. client.emit "otUpdateError", error, message
  79. client.disconnect()