ws comments and fixes

Author: maxchistt

client/src/Hooks/useDebouncedFunction.hook.js

@@ -8,10 +8,12 @@ import { useEffect, useReducer } from 'react';
  */
 function useDebouncedFunction(callback, delayms) {
     const [state, debounced] = useReducer((state, arg) => {
-        return { count: state.count++, arg: arg }
+        return { count: state.count + 1, arg: arg }
     }, { count: 0, arg: undefined })
     useEffect(() => {
-        const handler = setTimeout(() => callback(state.arg), delayms)
+        const handler = setTimeout(() => {
+            if (state.count) callback(state.arg)
+        }, delayms)
         return () => clearTimeout(handler)
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [state])

client/src/Hooks/useUpdaterSocket.hook.js

@@ -13,6 +13,11 @@ const WS_PORT = process.env.WS_PORT || 3030
  */
 function useUpdaterSocket(updateData, auth) {
     const { request } = useHttp()
+
+    /**дебонсированный обработчик входящего обновления */
+    const debouncedUpdate = useDebouncedFunction(updateData, 200)
+
+    /**колбек для получения url сокета */
     const getSocketUrl = useCallback(async () => {
         return new Promise(resolve => {
             request("/getIp")
@@ -27,15 +32,14 @@ function useUpdaterSocket(updateData, auth) {
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [])
 
-    const debouncedUpdate = useDebouncedFunction(updateData, 200)
-
+    /**опции обработки событий сокета */
     const socketOptions = {
         onOpen: (e) => {
             sendRegisterMsg()
             console.log("ws open")
         },
         onClose: (e) => {
-            console.log("ws close")
+            console.error("ws close")
         },
         onMessage: (e) => {
             console.log("ws update message")
@@ -46,22 +50,27 @@ function useUpdaterSocket(updateData, auth) {
         },
     }
 
+    /**подключение WebSocket */
     const { sendMessage } = useWebSocket(getSocketUrl, socketOptions)
 
-    const sendMsg = (target) => {
+    /**дебонсированный обработчик отсылаемого обновления */
+    const sendUpdateMsgDebounced = useDebouncedFunction(sendUpdateMsg, 200)
+
+    /** отпрака сообщения сокета */
+    function sendMsg(target) {
         const msg = JSON.stringify({
             userId: auth.userId,
             target
         })
         sendMessage(msg)
     }
 
-    const sendUpdateMsgDebounced = useDebouncedFunction(sendUpdateMsg, 200)
-
+    /**отправка отсылаемого обновления */
     function sendUpdateMsg() {
         sendMsg("update")
     }
 
+    /**отпрака сообщения регистрации сокета */
     function sendRegisterMsg() {
         sendMsg("register")
     }

client/src/Pages/NotesPage.js

@@ -78,15 +78,15 @@ function NotesPage() {
 
     /**
      * Внесение в полученных данных в массив
-     * @param {*} notes 
+     * @param {Array<{}>} notes 
      */
     function setLoadedNotes(notes) {
         setNotesArr([...notes])
     }
 
     /**
      * удаление карточки
-     * @param {*} id 
+     * @param {string} id 
      */
     function removeNote(id) {
         const index = getNoteIndexById(id)
@@ -97,7 +97,7 @@ function NotesPage() {
 
     /**
      * добавление карточки
-     * @param {*} noteData 
+     * @param {{}} noteData 
      */
     function addNote(noteData = {}) {
         const newId = String(auth.email) + String(Date.now()) + String(Math.random())
@@ -117,8 +117,8 @@ function NotesPage() {
 
     /**
      * Изменение цвета карточки
-     * @param {*} index 
-     * @param {*} color 
+     * @param {string} id  
+     * @param {string} color 
      */
     function changeNoteColor(id, color) {
         const index = getNoteIndexById(id)
@@ -129,9 +129,9 @@ function NotesPage() {
 
     /**
      * Изменение текстового содержания карточки
-     * @param {*} index 
-     * @param {*} name 
-     * @param {*} text 
+     * @param {string} id  
+     * @param {string} name 
+     * @param {string} text 
      */
     function editNoteContent(id, name, text) {
         const index = getNoteIndexById(id)
@@ -147,7 +147,7 @@ function NotesPage() {
 
     /**
      * Изменение порядка заметки
-     * @param {number} index 
+     * @param {string} id 
      * @param {boolean} orderOperationFlag 
      */
     function editNoteOrder(id, orderOperationFlag) {
@@ -164,7 +164,10 @@ function NotesPage() {
 
     ///////////
 
-    /**функция получения карточки по id */
+    /**
+     * функция получения карточки по id 
+     * @param {string} id 
+     */
     function getNoteById(id) {
         const byId = () => {
             let note = null
@@ -178,7 +181,10 @@ function NotesPage() {
         return id !== null ? byId() : null
     }
 
-    /**функция получения индекса карточки по id */
+    /**
+     * функция получения индекса карточки по id 
+     * @param {string} id 
+     */
     function getNoteIndexById(id) {
         const byId = () => {
             let index = null

server/socket/wss.js

@@ -3,45 +3,64 @@ const WebSocket = require('ws')
 
 /**
  * Подключение WebSocket сервера
+ * Он принимает сигналы об обновлении от клиента и рассылает остальным для синхронизации
  * @param {*} port 
  */
 function startWSS(port) {
-    let wsCount = 0
+    /**сервер ws */
     const wsServer = new WebSocket.Server({ port })
+    /**коллекция ws клиентов разделенная по id пользователя */
     const wsCollection = {}
+    // обработка событий сервера
     wsServer.on('connection', (wsClient) => {
-        wsClient.num = ++wsCount
-
+        // уникальный номер клиента
+        const clientNum = Date.now()
+        // проверка регистрации
+        setTimeout(() => {
+            if (!wsClient.userId) wsClient.close()
+        }, 60 * 1000)
+        // обработка сообщения клиента
         wsClient.on("message", (data) => {
             try {
-                const { userId, target } = tryParce(data)
-
+                // данные с клиента
+                const { userId, target } = JSON.parse(data)
+                // обработка сообщения регистрации
                 if (target == "register") {
                     wsClient.userId = userId
-                    let clients = getClients(userId)
-                    clients.push({
-                        num: wsClient.num,
-                        send: msg => wsClient.send(msg)
+                    wsClient.num = clientNum
+                    let clients = getClients(wsClient.userId)
+                    let match = false
+                    clients.forEach(val => {
+                        if (val.num == wsClient.num) match = true
                     })
-                    wsCollection[userId] = clients
+                    if (!match && wsClient.userId) {
+                        clients.push({
+                            num: wsClient.num,
+                            send: msg => wsClient.send(msg)
+                        })
+                        wsCollection[wsClient.userId] = clients
+                    } else throw new Error("ошибка регистрации сокета")
                 }
-
-                if (target == "update") {
+                // обработка сообщения об обновлении
+                if (target == "update" && wsClient.userId) {
                     getClients(wsClient.userId).forEach((wsc) => {
-                        if ((wsClient.num === undefined) || (wsClient.num !== wsc.num)) {
+                        if ((wsClient.num !== undefined) && (wsClient.num !== wsc.num)) {
                             wsc.send(data)
                         }
                     })
                 }
-
-            } catch (e) { }
+            } catch (e) { wsClient.close() }
         })
-
+        // обработка закрытия клиента
         wsClient.on("close", () => {
-            wsCollection[wsClient.userId] = getClients(wsClient.userId).filter((wsc) => {
+            if (wsClient.userId) wsCollection[wsClient.userId] = getClients(wsClient.userId).filter((wsc) => {
                 return (wsClient.num === undefined) || (wsClient.num !== wsc.num)
             })
         })
+        // обработка ошибки клиента
+        wsClient.on("error", () => {
+            wsClient.close()
+        })
     })
     wsServer.on("close", () => console.log("WSS closed"))
     wsServer.on("error", () => console.log("WSS error"))
@@ -55,11 +74,6 @@ function startWSS(port) {
     function getClients(userId) {
         return wsCollection[userId] || []
     }
-
-    function tryParce(str) {
-        try { return JSON.parse(str) }
-        catch (e) { return str }
-    }
 }
 
 module.exports = startWSS