refactor(realtime): extract "refresh" and "user status" to class

1. extract client socket event handler "refresh" and "user status"
to SocketClient class
2. add testcase for this changes

Signed-off-by: BoHong Li <[email protected]>

Author: a60814billy

lib/realtime.js

@@ -86,7 +86,7 @@ setInterval(function () {
     if (note.server.isDirty) {
       if (config.debug) logger.info('updater found dirty note: ' + key)
       note.server.isDirty = false
-      updateNote(note, function (err, _note) {
+      exports.updateNote(note, function (err, _note) {
         // handle when note already been clean up
         if (!notes[key] || !notes[key].server) return callback(null, null)
         if (!_note) {
@@ -209,7 +209,7 @@ setInterval(function () {
       saverSleep = true
     }
   })
-}, 60000 * 5)
+}, 5 * 60 * 1000) // 5 mins
 
 function getStatus (callback) {
   models.Note.count().then(function (notecount) {
@@ -737,14 +737,60 @@ function updateHistory (userId, note, time) {
   if (note.server) history.updateHistory(userId, noteId, note.server.document, time)
 }
 
+function getUserPool () {
+  return users
+}
+
+function getUserFromUserPool (userId) {
+  return users[userId]
+}
+
+function getNotePool () {
+  return notes
+}
+
+function getNoteFromNotePool (noteId) {
+  return notes[noteId]
+}
+
+class SocketClient {
+  constructor (socket) {
+    this.socket = socket
+  }
+
+  registerEventHandler () {
+    // received client refresh request
+    this.socket.on('refresh', this.refreshEventHandler.bind(this))
+    // received user status
+    this.socket.on('user status', this.userStatusEventHandler.bind(this))
+  }
+
+  refreshEventHandler () {
+    exports.emitRefresh(this.socket)
+  }
+
+  userStatusEventHandler (data) {
+    const noteId = this.socket.noteId
+    const user = getUserFromUserPool(this.socket.id)
+    if (!noteId || !getNoteFromNotePool(noteId) || !user) return
+
+    if (config.debug) { logger.info('SERVER received [' + noteId + '] user status from [' + this.socket.id + ']: ' + JSON.stringify(data)) }
+    if (data) {
+      user.idle = data.idle
+      user.type = data.type
+    }
+    exports.emitUserStatus(this.socket)
+  }
+}
+
 function connection (socket) {
   if (realtime.maintenance) return
-  parseNoteIdFromSocket(socket, function (err, noteId) {
+  exports.parseNoteIdFromSocket(socket, function (err, noteId) {
     if (err) {
-      return failConnection(500, err, socket)
+      return exports.failConnection(500, err, socket)
     }
     if (!noteId) {
-      return failConnection(404, 'note id not found', socket)
+      return exports.failConnection(404, 'note id not found', socket)
     }
 
     if (isDuplicatedInSocketQueue(connectionSocketQueue, socket)) return
@@ -785,30 +831,15 @@ function connection (socket) {
       idle: false,
       type: null
     }
-    updateUserData(socket, users[socket.id])
+    exports.updateUserData(socket, users[socket.id])
 
     // start connection
     connectionSocketQueue.push(socket)
-    startConnection(socket)
-  })
-
-  // received client refresh request
-  socket.on('refresh', function () {
-    emitRefresh(socket)
+    exports.startConnection(socket)
   })
 
-  // received user status
-  socket.on('user status', function (data) {
-    var noteId = socket.noteId
-    var user = users[socket.id]
-    if (!noteId || !notes[noteId] || !user) return
-    if (config.debug) { logger.info('SERVER received [' + noteId + '] user status from [' + socket.id + ']: ' + JSON.stringify(data)) }
-    if (data) {
-      user.idle = data.idle
-      user.type = data.type
-    }
-    emitUserStatus(socket)
-  })
+  const socketClient = new SocketClient(socket)
+  socketClient.registerEventHandler()
 
   // received note permission change request
   socket.on('permission', function (permission) {
@@ -963,3 +994,14 @@ function connection (socket) {
 
 exports = module.exports = realtime
 exports.extractNoteIdFromSocket = extractNoteIdFromSocket
+exports.parseNoteIdFromSocket = parseNoteIdFromSocket
+exports.updateNote = updateNote
+exports.finishUpdateNote = finishUpdateNote
+exports.failConnection = failConnection
+exports.isDuplicatedInSocketQueue = isDuplicatedInSocketQueue
+exports.updateUserData = updateUserData
+exports.startConnection = startConnection
+exports.emitRefresh = emitRefresh
+exports.emitUserStatus = emitUserStatus
+exports.notes = notes
+exports.users = users