iosignal 3.1.0 → 3.3.0

package/src/server/RemoteCore.js

@@ -27,15 +27,13 @@ export class RemoteCore {
     this.ssid = RemoteCore.ssid++;  // ordered index number
     this.manager = manager;
 
-    this.cid; // Communication Id
-    this.did; // Device Id
-    this.uid; // User Id
-    this.nick = ""
+    this.cid = ''; // Communication Id
+    this.did = ''; // Device Id
+    this.uid = ''; // User Id
+    this.nick = ''
 
-
-    this.lastEchoMessage = "N"
     this.privateNode = false
-    this.HOME_CHANNEL = ""
+    this.HOME_CHANNEL = ''
     this.level = serverOption.defaultQuotaIndex;
     this.quota = quotaTable[this.level];
     this.isAdmin = false;
@@ -51,7 +49,8 @@ export class RemoteCore {
   setState(state) {
     this.state = state
     if (serverOption.debug.showAuthInfo) {
-      this.stateLog.push(state)
+      // let s = state + ":" + CLIENT_STATE[ state] 
+      this.stateLog.push( state  )
       console.log(this.stateLog.join('>'))
     }
   }
@@ -66,7 +65,7 @@ export class RemoteCore {
 
 
   showMessageLog(message, isBinary) {
-    let from = this.boho.isAuthorized ? `did: ${this.did} ${this.cid}@` : `${this.cid}@`
+    let from = this.boho.isAuthorized ? `[FROM]did: ${this.did} cid:${this.cid}` : `[FROM]cid:${this.cid}`
     if (isBinary) {
       let msgTypeName = IOMsg[message[0]]
       if (!msgTypeName) msgTypeName = Boho.BohoMsg[message[0]]
@@ -165,6 +164,7 @@ export class RemoteCore {
         case IOMsg.CID_REQ:
           if (this.state < CLIENT_STATE.SENT_SERVER_READY) {
             // Protocol violation: CID_REQ was sent before receiving the SERVER_READY signal.
+            console.log('CID_REQ before SERVER_READY')
             this.close()
           }
 
@@ -182,22 +182,16 @@ export class RemoteCore {
           this.setState(CLIENT_STATE.CID_READY)
           break;
 
-
-        case IOMsg.ECHO: // TEXT only 
-          try {
-            let msg = decoder.decode(message.subarray(1))
-            this.lastEchoMessage = msg
-          } catch (error) {
-            // console.log('ECHO message is not a text')
+        case IOMsg.ECHO:
+          if( message.byteLength < 30) {      
+            this.send(message, isBinary)
           }
-          this.send(message, isBinary)
           break;
 
         case IOMsg.IAM:
-          if (message.byteLength > 1) {
-            let iamInfo = message.subarray(1)
-            this.nick = decoder.decode(iamInfo)
-            console.log('iam nick reset', this.nick)
+          if (message.byteLength > 1 && message.byteLength < 30) {            
+              // if iam request has a text message then reset the nick property.
+              this.nick = decoder.decode(message.subarray(1))
           }
           this.iamResponse()
           break;
@@ -218,7 +212,7 @@ export class RemoteCore {
 
         case IOMsg.UNSUBSCRIBE:
           if (message.byteLength == 2) {
-            this.manager.unsubscribe([""], this)
+            this.manager.unsubscribe([''], this)
           } else if (message.byteLength >= 3) {
             let tagLen = message.readUInt8(1)
 
@@ -292,7 +286,7 @@ export class RemoteCore {
         case Boho.BohoMsg.AUTH_REQ:
           if (!this.manager.authManager) return
           if (this.state < CLIENT_STATE.SENT_SERVER_READY) {
-            // console.log('protocol error. auth_req before server_ready')
+            console.log('protocol error. auth_req before server_ready')
             this.close();
           }
           this.setState(CLIENT_STATE.RECV_AUTH_REQ)
@@ -305,22 +299,23 @@ export class RemoteCore {
         case Boho.BohoMsg.AUTH_HMAC:
           if (!this.manager.authManager) return
           if (this.state < CLIENT_STATE.SENT_SERVER_NONCE) {
-            // console.log('protocol error. auth_hmac before server_nonce')
+            console.log('protocol error. auth_hmac before server_nonce')
             this.close();
           }
           this.setState(CLIENT_STATE.RECV_AUTH_HMAC)
           //async
           this.manager.authManager.verify_auth_hmac(message, this)
             .then(authInfo => {
-              if (authInfo) {
-                this.manager.deligateSignal(remote, '@$name', authInfo.name)
+              if (authInfo?.name) {
+                this.manager.deligateSignal(this, '@$name', authInfo.name)
                 // console.log('device login success authInfo', authInfo)
                 // this.manager.sender('@$name', authInfo.name )
               }
 
+              // console.log('[VERIFY AUTH_HMAC] SubClass of BohoAuth return authInfo:', authInfo )
             })
             .catch(e => {
-
+              console.log('authInfo return fail.', e )
             })
 
           return;
@@ -348,23 +343,19 @@ export class RemoteCore {
   response(msgId, statusCode, body) {
     // console.log('response body', body)
     if (body) {
-
       this.send_enc_mode(MBP.pack(
         MB('#type', '8', IOMsg.RESPONSE_MBP),
         MB('status', '8', statusCode),
         MB('mid', '16', msgId),
         MB('body', body)
       ))
-
     } else {
       this.send_enc_mode(MBP.pack(
         MB('#type', '8', IOMsg.RESPONSE_MBP),
         MB('status', '8', statusCode),
         MB('mid', '16', msgId)
       ))
-
     }
-
   }
 
 
@@ -407,9 +398,9 @@ export class RemoteCore {
 
 
 
-  iamResponse(info = "") {
+  iamResponse(info = '') {
 
-    if (info == "") {
+    if (info == '') {
       let channels = []
       for (let tag of this.channels.keys()) {
         channels.push(tag)
@@ -417,15 +408,17 @@ export class RemoteCore {
 
       info = {
         "ssid": this.ssid,
-        "uid": this.uid,
         "cid": this.cid,
         "did": this.did,
+        "uid": this.uid,
+        "level": this.level,
         "nick": this.nick,
         "ip": this.ip
         , 'tag': channels
       }
     }
 
+    // console.log( 'iam res info', info )
     let pack = MBP.pack(
       MB('#MsgType', '8', IOMsg.IAM_RES),
       MB('#info', info)

package/src/server/Server.js

@@ -11,58 +11,67 @@ export class Server extends EventEmitter {
     super();
     this.apiNames = new Set()
     this.wss = {};
+    this.port = null;
+    this.congPort = null;
 
     if (options.timeout) {
       let pingT = parseInt(options.timeout)
       if (pingT && pingT >= 1000) serverOption.timeout = pingT
     }
-
     if (options.monitorPeriod) {
       let monitorT = parseInt(options.monitorPeriod)
       if (monitorT && monitorT >= 1000) serverOption.monitorPeriod = monitorT
     }
-
-
     if (options.showMessage) {
       serverOption.showMessage = options.showMessage
     }
-
     if (options.showMetric) {
       serverOption.showMetric = options.showMetric
     }
-
-    if (options.timeout) {
-      serverOption.timeout = options.timeout
+    if (options.membersOnly) {
+      serverOption.membersOnly = options.membersOnly
     }
 
-    if (options.port) {
-      serverOption.port = parseInt(options.port)
+
+    if (options.port || options.port == 0) {
+      this.port = parseInt(options.port)
     }
 
     if (options.httpServer) {
-      serverOption.httpServer = options.httpServer
+      this.httpServer = options.httpServer
     }
 
-    if (options.congPort) {
-      serverOption.congPort = parseInt(options.congPort)
+    if (options.wsPath) {
+      this.wsPath = options.wsPath
+    }
+
+    if (options.congPort || options.congPort == 0) {
+      this.congPort = parseInt(options.congPort)
     }
 
     this.manager = new Manager(this, authManager)
 
-    if (serverOption.port || serverOption.httpServer) this.startWSServer(serverOption)
-    if (serverOption.congPort) this.startCongServer(serverOption.congPort)
+    this.serverCountToListen = 0;
+    this.listeningServerCount = 0;
+    if (this.port || this.port == 0 || this.httpServer) this.serverCountToListen++;
+    if (this.congPort || this.congPort == 0) this.serverCountToListen++;
 
-  }
+    if (this.serverCountToListen === 0) {
+      throw new Error('Cannot create Server: At least one of "port", "httpServer", or "congPort" must be specified.');
+    } else {
+      if (this.port || this.port == 0 || this.httpServer) this.startWSServer();
+      if (this.congPort || this.congPort == 0) this.startCongServer();
+    }
 
+  }
 
-  startWSServer(serverOption) {
 
-    if (serverOption.port) {
-      console.log('opening WebSocket Server port:', serverOption.port)
-      this.wss = new WebSocketServer({ port: serverOption.port })
-    } else if (serverOption.httpServer) {
-      console.log('opening WebSocket Server external httpServer:')
-      this.wss = new WebSocketServer({ server: serverOption.httpServer })
+  startWSServer() {
+    // console.log('optoins', options )
+    if (this.port || this.port == 0) {
+      this.wss = new WebSocketServer({ port: this.port , path: this.wsPath })
+    } else if (this.httpServer ) {
+      this.wss = new WebSocketServer({ server: this.httpServer, path: this.wsPath })
     } else {
       throw new TypeError(
         'One and only one of the "port", "httpServer"' +
@@ -70,9 +79,16 @@ export class Server extends EventEmitter {
       );
     }
 
+    this.wss.once('listening', () => {
+      this.port = this.wss.address().port;
+      console.log('wss server bound port:',  this.port );
+      this.listeningServerCount++;
+      if (this.listeningServerCount === this.serverCountToListen) {
+        this.emit('ready');
+      }
+    });
 
     // this.wss.setMaxListeners(0)
-
     this.wss.on('error', (err) => {
       console.error('### ws server error:', err.message)
       if (err.code == 'EADDRINUSE') {
@@ -80,8 +96,8 @@ export class Server extends EventEmitter {
       }
     })
 
-    this.wss.on('close', (err) => {
-      console.log('### WS server closed.', err)
+    this.wss.on('close', () => {
+      console.log('### WS server is closed.')
     })
 
     this.wss.on('connection', (ws, req) => {
@@ -92,9 +108,7 @@ export class Server extends EventEmitter {
 
   }
 
-  startCongServer(congPort) {
-    console.log('opening CongSocket Server:', congPort)
-
+  startCongServer() {
     this.congServer = net.createServer((socket) => {
       this.manager.addRemote(socket)
     })
@@ -103,61 +117,120 @@ export class Server extends EventEmitter {
         if (err.code == 'EADDRINUSE') {
           process.exit()
         }
-      }).listen(congPort, () => {
-        // console.log('congsocket server bound' );
+      }).on('close', () => {
+        console.log('### congsocket server is closed.')
+      }).listen(this.congPort, () => {
+        this.congPort = this.congServer.address().port;
+        console.log('congsocket server bound port:', this.congPort );
+        this.listeningServerCount++;
+        if (this.listeningServerCount === this.serverCountToListen) {
+          this.emit('ready');
+        }
       });
   }
 
-
-
+/**
+ * API register.
+ * target:  api_name <string>
+ * api: api_module <function module|class instance>
+ * return this
+ */
   api(target, api) {
 
-    this.apiNames.add(target)
-
+    if( typeof target !== 'string'){
+      throw new Error(`api( target ,api ) target name is not a string.`)
+    }
     if (!api.checkPermission || typeof api.checkPermission != 'function') {
-      throw new Error('wrong api interface. no checkPermission function.')
+      throw new Error(`API ${target} : no checkPermission or not a function.`)
     }
-
-
-    if (typeof api.request == 'function' && Array.isArray(api.commands)) {
-      console.log(`API TYPE1. A Class with one request function. target: ${target} list: ${api.commands}`)
-
-      this.on(target, (remote, req) => {
-        if (api.checkPermission(remote, req)) {
-          api.request(remote, req)
-        } else {
-          remote.response(req.mid, STATUS.ERROR, "NO_PERMISSION.")
+    if(!api.commands || !Array.isArray(api.commands) ){
+      throw new Error(`API ${target} : no commands or !Array.`)
+    }
+    
+    // API TYPE 1. single request() function.
+    if ( api.request && typeof api.request == 'function' ) {
+      this.on(target, async (remote, req) => {
+        try {
+          if (!api.checkPermission(remote, req)) {
+            remote.response(req.mid, STATUS.ERROR, "NO_PERMISSION.")
+            return
+          }
+          if( api.commands.includes( req.topic )){
+            console.log('server api req', req )
+            await api.request(remote, req)
+          }else{
+            remote.response(req.mid, STATUS.ERROR, "UNKNOWN_COMMAND");
+          }
+        } catch (error) {
+          console.error(`Unhandled API Error in target [${target}]:`, error);
+          remote.response(req.mid, STATUS.ERROR, "INTERNAL_SERVER_ERROR");
         }
       })
-
     } else {
-      let apiList = []
-      Object.keys(api).forEach(v => {
-        if (typeof api[v] === 'function') apiList.push(v)
-        console.log('api list', typeof api[v], v)
-      })
-
-      console.log(`API TYPE2. Multiple function list.  target: ${target} list:${apiList}`)
-
-      this.on(target, (remote, req) => {
-        let r;
-        if (!api.checkPermission(remote, req)) {
-          r = "NO_PERMISSION."
-        } else {
-          if (api[req.topic]) {
-            console.log(`API TYPE2. request target: ${target}  has topic:${req.topic}`)
-            api[req.topic](remote, req)
+      // API TYPE 2. multiple functions.
+      this.on(target, async (remote, req) => {
+        try {
+          if (!api.checkPermission(remote, req)) {
+            remote.response(req.mid, STATUS.ERROR, "NO_PERMISSION.")
             return
-          } else {
-            r = `target: ${req.target} has not topic name: ${req.topic}`
           }
+          if( api.commands.includes( req.topic )){
+            await api[req.topic](remote, req)
+          }else{
+            remote.response(req.mid, STATUS.ERROR, "UNKNOWN_COMMAND");
+          }
+        } catch (error) {
+          console.error(`Unhandled API Error in target [${target}]:`, error);
+          remote.response(req.mid, STATUS.ERROR, "INTERNAL_SERVER_ERROR");
         }
+      })
+    }
+    this.apiNames.add(target)
+    console.log(`[API registed: ${target} ] accept commands: ${api.commands}`)
+    return this
+  }
 
-        remote.response(req.mid, STATUS.ERROR, r)
+  close(callback) {
+    console.log('closing iosignal server...')
+    if (this.manager) {
+      this.manager.close()
+    }
+
+    this.apiNames.forEach(v => this.removeAllListeners(v))
+    this.apiNames.clear()
+
+    let serverCount = 0;
+    if (this.wss) serverCount++;
+    if (this.congServer) serverCount++;
+
+    if (serverCount === 0) {
+      if (callback) process.nextTick(callback);
+      return;
+    }
+
+    let closedCount = 0;
+    const onClosed = () => {
+      closedCount++;
+      if (closedCount === serverCount) {
+        console.log('IOSignal server is closed.')
+        if (callback) callback();
+      }
+    }
+
+    if (this.wss) {
+      this.wss.close(() => {
+        // console.log('wss server closed.')
+        onClosed()
       })
     }
 
-    return this
+    if (this.congServer) {
+      this.congServer.close((err) => {
+        if (err) console.error('congServer close error', err)
+        // console.log('cong server closed.')
+        onClosed()
+      })
+    }
   }
 
 }

package/src/server/serverOption.js

@@ -2,9 +2,10 @@
 
 export let serverOption = {
   clientTracking: false,
-  port: 0, //wsPort
+  port: null, // WebSocket
+  congPort: null, // CongSocket
   httpServer: null,
-  congPort: 0,
+  wsPath: null,
   timeout: 50000,
   showMessage: 'none',
   showMetric: 0,
@@ -46,10 +47,10 @@ export let serverOption = {
   },
 
   auth: {
-    delay_auth_fail: 1000,
+    delay_auth_fail: 600,
   },
 
-  memberOnly: false
+  membersOnly: false
 
 }
 

package/test-nodejs/client-playToggle.js

@@ -0,0 +1,19 @@
+
+import { IO } from "iosignal"
+
+const io = new IO('wss://io.iosignal.net/ws')
+
+// io.auth('id','key')
+
+io.on('ready', () => {
+  console.log('ready cid:', io.cid)
+  io.signal('#screen', 'playToggle')
+});
+
+io.listen('#notify', (...args) => {
+  console.log(args)
+})
+
+io.on('error', err => {
+  console.log('err', err)
+})