lint: lib/realtime

- add RealtimeModule type

Signed-off-by: Raccoon <[email protected]>

Author: a60814billy

lib/realtime/realtime-types.ts

@@ -0,0 +1,39 @@
+import SocketIO from "socket.io";
+import {Note} from "../models";
+import {ProcessQueue} from "./processQueue";
+import {RealtimeClientUserData, RealtimeNoteData, RealtimeUserData} from "./realtime";
+
+export interface RealtimeModule {
+  disconnectProcessQueue: ProcessQueue
+
+  queueForDisconnect(socket: SocketIO.Socket): void
+
+  disconnectSocketOnNote(note: RealtimeNoteData): void
+
+  getNotePool(): Record<string, RealtimeNoteData>
+
+  getUserPool(): Record<string, RealtimeUserData>
+
+  getUserFromUserPool(userId: string): RealtimeUserData | null
+
+  getNoteFromNotePool(noteId: string): RealtimeNoteData | null
+
+  checkViewPermission(req, note: RealtimeNoteData): boolean
+
+  emitRefresh(socket: SocketIO.Socket): void
+
+  emitUserStatus(socket: SocketIO.Socket): void
+
+  updateUserData(socket: SocketIO.Socket, user: RealtimeUserData): void
+
+  emitOnlineUsers(socket: SocketIO.Socket): void
+
+  buildUserOutData(user: RealtimeUserData): RealtimeClientUserData
+
+  emitCheck(note: RealtimeNoteData): void
+
+  updateNote(note: RealtimeNoteData, callback: (err: Error | null, note: Note) => void): void
+
+  io: SocketIO.Server
+}
+

lib/realtime/realtime.ts

@@ -497,7 +497,7 @@ export function emitRefresh(socket: SocketIO.Socket): void {
   socket.emit('refresh', out)
 }
 
-export function checkViewPermission(req, note: RealtimeNoteData) {
+export function checkViewPermission(req, note: RealtimeNoteData): boolean {
   if (note.permission === 'private') {
     if (req.user && req.user.logged_in && req.user.id === note.owner) {
       return true
@@ -636,7 +636,7 @@ export function queueForDisconnect(socket: SocketIO.Socket): void {
   })
 }
 
-interface RealtimeClientUserData {
+export interface RealtimeClientUserData {
   id?: string
   login?: boolean
   userid?: string

lib/realtime/realtimeCleanDanglingUserJob.ts

@@ -5,15 +5,16 @@ import async from "async";
 import config from "../config";
 import {logger} from "../logger";
 import {JobWorker} from "./jobWorker";
+import {RealtimeModule} from "./realtime-types";
 
 /**
  * clean when user not in any rooms or user not in connected list
  */
 export class CleanDanglingUserJob implements JobWorker {
-  private realtime: any;
+  private realtime: RealtimeModule;
   private timer: NodeJS.Timeout;
 
-  constructor(realtime: any) {
+  constructor(realtime: RealtimeModule) {
     this.realtime = realtime
   }
 
@@ -33,7 +34,7 @@ export class CleanDanglingUserJob implements JobWorker {
     async.each(Object.keys(users), (key, callback) => {
       const socket = this.realtime.io.sockets.connected[key]
       if ((!socket && users[key]) ||
-        (socket && (!socket.rooms || socket.rooms.length <= 0))) {
+        (socket && (!socket.rooms || Object.keys(socket.rooms).length <= 0))) {
         if (config.debug) {
           logger.info('cleaner found redundant user: ' + key)
         }

lib/realtime/realtimeClientConnection.ts

@@ -7,6 +7,7 @@ import config from "../config";
 import {Note} from "../models";
 import {logger} from "../logger";
 import {RealtimeNoteData, RealtimeUserData} from "./realtime";
+import {RealtimeModule} from "./realtime-types";
 
 export type CursorData = {line: number, ch: number}
 
@@ -17,7 +18,7 @@ export interface UserStatus {
 
 export class RealtimeClientConnection {
   private socket: Socket;
-  private realtime: any;
+  private realtime: RealtimeModule;
 
   constructor(socket: Socket) {
     this.socket = socket
@@ -56,7 +57,7 @@ export class RealtimeClientConnection {
   isNoteAndUserExists(): boolean {
     const note = this.realtime.getNoteFromNotePool(this.socket.noteId)
     const user = this.realtime.getUserFromUserPool(this.socket.id)
-    return note && user
+    return !!(note && user)
   }
 
   isNoteOwner(): boolean {

lib/realtime/realtimeSaveRevisionJob.ts

@@ -3,16 +3,17 @@
 import {logger} from "../logger";
 import {saveAllNotesRevision} from "../services/note";
 import {JobWorker} from "./jobWorker";
+import {RealtimeModule} from "./realtime-types";
 
 /**
  * clean when user not in any rooms or user not in connected list
  */
 export class SaveRevisionJob implements JobWorker {
-  private realtime: any;
+  private realtime: RealtimeModule;
   private saverSleep: boolean;
   private timer: NodeJS.Timeout;
 
-  constructor(realtime: any) {
+  constructor(realtime: RealtimeModule) {
     this.realtime = realtime
     this.saverSleep = false
   }

lib/realtime/realtimeUpdateDirtyNoteJob.ts

@@ -5,12 +5,13 @@ import {logger} from "../logger";
 import {Note} from "../models";
 import {JobWorker} from "./jobWorker";
 import {RealtimeNoteData} from "./realtime";
+import {RealtimeModule} from "./realtime-types";
 
 export class UpdateDirtyNoteJob implements JobWorker {
-  private realtime: any;
+  private realtime: RealtimeModule;
   private timer: NodeJS.Timeout;
 
-  constructor(realtime: any) {
+  constructor(realtime: RealtimeModule) {
     this.realtime = realtime
   }