iosignal 3.3.0 → 4.5.0

package/src/client/IOCore.js

@@ -1,6 +1,6 @@
 import MBP from 'meta-buffer-pack'
 import EventEmitter from "eventemitter3";
-import { IOMsg, PAYLOAD_TYPE, SIZE_LIMIT, ENC_MODE, STATES } from '../common/constants.js'
+import { IOMsg, PAYLOAD_TYPE, SIZE_LIMIT, ENC_MODE, STATE } from '../common/constants.js'
 import { quotaTable } from '../common/quotaTable.js'
 import { getSignalPack } from '../common/payload.js';
 import Boho from "boho";
@@ -11,7 +11,7 @@ import Boho from "boho";
  * @typedef {import('../common/constants.js').PAYLOAD_TYPE} PAYLOAD_TYPE
  * @typedef {import('../common/constants.js').SIZE_LIMIT} SIZE_LIMIT
  * @typedef {import('../common/constants.js').ENC_MODE} ENC_MODE
- * @typedef {import('../common/constants.js').STATES} STATES
+ * @typedef {import('../common/constants.js').STATE} STATE
  * @typedef {import('../common/quotaTable.js').quotaTable} quotaTable
  
  * @typedef {import('boho').Boho} Boho
@@ -65,7 +65,7 @@ export class IOCore extends EventEmitter {
      * Current connection state (number).
      * @type {number}
      */
-    this.state = STATES.CLOSED;  // Number type
+    this.state = STATE.CLOSED;  // Number type
     /**
      * Current connection state (string).
      * @type {string}
@@ -207,7 +207,7 @@ export class IOCore extends EventEmitter {
   close() {
     if (this._closed) return;
     this._closed = true;
-// console.log('####### IOCOre.js close() called')
+    // console.log('####### IOCOre.js close() called')
     // If auto-reconnect is disabled, we must stop the keep-alive timer.
     if (this.autoReconnect === false) {
       clearInterval(this.connectionCheckerIntervalID);
@@ -222,7 +222,7 @@ export class IOCore extends EventEmitter {
         // To avoid the error, we wait for the connection to open, then immediately close it.
         // We also clear other handlers to prevent any other logic from running.
         const socket = this.socket;
-        socket.onopen = () => { if(socket) socket.close(); };
+        socket.onopen = () => { if (socket) socket.close(); };
         socket.onmessage = null;
         socket.onerror = null;
         socket.onclose = null;
@@ -230,7 +230,7 @@ export class IOCore extends EventEmitter {
         try {
           // For other sockets (like TCP) or other WebSocket states, close directly.
           this.socket.close?.();
-        } catch {}
+        } catch { }
       }
       this.socket = null;
     }
@@ -238,14 +238,15 @@ export class IOCore extends EventEmitter {
     this.emit('closed');
     this.stateChange('closed');
   }
-
+  
   /**
    * Disables auto-reconnect and closes the current connection.
    * The instance can be re-opened manually later. For complete cleanup, use destroy().
-   */
-  stop() {
-    this.autoReconnect = false;
-    this.close();
+  */
+ stop() {
+   this.autoReconnect = false;
+   this.close();
+   this.stateChange('stop','stop');
   }
 
   /**
@@ -261,7 +262,7 @@ export class IOCore extends EventEmitter {
 
     // Help GC
     this.boho = null;
-  }  
+  }
 
   /**
    * The core keep-alive logic. It checks if auto-reconnect is enabled.
@@ -278,8 +279,8 @@ export class IOCore extends EventEmitter {
    * @param {string} url2 - The new URL to redirect to.
    */
   redirect(url2) {
+    this.stateChange('redirecting','redirecting')
     this.close()
-    this.stateChange('redirecting')
     this.createConnection(url2)
   }
 
@@ -336,29 +337,27 @@ export class IOCore extends EventEmitter {
 
   /**
    * Manually logs in with provided ID and key.
-   * @param {string} id - The user ID.
+   * @param {string} id - The user ID. or 'id.key'
    * @param {string} key - The user key.
-   * @returns {boolean}
+   * @returns {this} 
    */
   login(id, key) {
-    if (!this.auth(id, key)) return false;
-
+    this.auth(id, key)
     this.useAuth = true
     let auth_pack = this.boho.auth_req()
     this.send(auth_pack)
-    return true
+    return this
   }
 
   /**
    * Sets up authentication for auto-login.
-   * @param {string} id - The user ID.
+   * @param {string} id - The user ID. or 'id.Key'
    * @param {string} key - The user key.
-   * @returns {boolean}
+   * @returns {this} 
    */
   auth(id, key) {
     if (!id && !key) {
       this.emit('error', new Error('auth failed. no id and key.'))
-      return false
     }
 
     if (!key && id.includes('.')) {
@@ -368,10 +367,9 @@ export class IOCore extends EventEmitter {
       this.boho.set_key(key)
     } else {
       this.emit('error', new Error('auth failed. no id or key.'))
-      return false
     }
     this.useAuth = true
-    return true
+    return this
   }
 
   /**
@@ -433,13 +431,13 @@ export class IOCore extends EventEmitter {
       case IOMsg.ECHO:
         try {
           let str = decoder.decode(buffer.subarray(1))
-          
+
           this.emit('echo', str)
         } catch (error) {
           this.emit('error', new Error('ECHO data error'))
         }
         break;
-        
+
       case IOMsg.IAM_RES:
         try {
           let str = decoder.decode(buffer.subarray(1))
@@ -448,8 +446,7 @@ export class IOCore extends EventEmitter {
           if (jsonInfo.nick) { this.nick = jsonInfo.nick; }
           if (jsonInfo.did) { this.did = jsonInfo.did; }
           if (jsonInfo.uid) { this.uid = jsonInfo.uid; }
-          // TIP. cid from [CID_RES], level from [QUOTA_LEVEL]
-          this.emit('iam_res', str )
+          this.emit('iam_res', str)
         } catch (error) {
           this.emit('error', new Error('IAM_RES data error'))
         }
@@ -461,21 +458,21 @@ export class IOCore extends EventEmitter {
 
         // **IMPORTANT** change state before subscribe.
         this.stateChange('ready', 'cid_ready')
-        this.subscribe_memory_channels()
+        this.subscribe_memory_channels()  // tags registered by listen() or link().
         break;
 
       case IOMsg.QUOTA_LEVEL:
         let quotaLevel = buffer[1]
         this.level = quotaLevel;
         this.quota = quotaTable[quotaLevel];
-        console.log('[QUOTA_LEVEL]', JSON.stringify(this.quota))
+        // console.log('[QUOTA_LEVEL]', JSON.stringify(this.quota))
         break;
 
-      case IOMsg.SERVER_CLEAR_AUTH:
+      case IOMsg.AUTH_CLEAR:
         this.useAuth = false;
         this.boho.clearAuth();
+        this.stateChange('auth_clear', 'server request auth_clear.')
         this.stop();
-        console.log('[SERVER_CLEAR_AUTH] io stop.')
         break;
 
       case IOMsg.SERVER_REDIRECT:
@@ -552,8 +549,11 @@ export class IOCore extends EventEmitter {
           switch (payloadType) {
 
             case PAYLOAD_TYPE.EMPTY:
-              if (tag.indexOf('@') === 0) this.emit('@', null, tag)
-              else this.emit(tag, null, tag)
+              if (tag.indexOf('@') === 0) this.emit('@', tag, null)
+              else {
+                this.emit(tag, tag, null)
+                this.emit('message', tag, null)
+              }
               break;
 
             case PAYLOAD_TYPE.TEXT:
@@ -564,33 +564,48 @@ export class IOCore extends EventEmitter {
                 payloadStringWithoutNull = payloadBuffer.subarray(0, payloadBuffer.byteLength - 1)
               }
               let oneString = decoder.decode(payloadStringWithoutNull)
-              if (tag.indexOf('@') === 0) this.emit('@', oneString, tag)
-              if (tag !== '@') this.emit(tag, oneString, tag)
+              if (tag.indexOf('@') === 0) this.emit('@', tag, oneString)
+              if (tag !== '@') {
+                this.emit(tag, tag, oneString)
+                this.emit('message', tag, oneString)
+              }
               break;
 
             case PAYLOAD_TYPE.BINARY:
-              if (tag.indexOf('@') === 0) this.emit('@', payloadBuffer, tag)
-              if (tag !== '@') this.emit(tag, payloadBuffer, tag)
+              if (tag.indexOf('@') === 0) this.emit('@', tag, payloadBuffer)
+              if (tag !== '@') {
+                this.emit(tag, tag, payloadBuffer)
+                this.emit('message', tag, payloadBuffer)
+              }
               break;
 
             case PAYLOAD_TYPE.OBJECT:
               let oneObjectBuffer = decoder.decode(payloadBuffer)
               let oneJSONObject = JSON.parse(oneObjectBuffer)
-              if (tag.indexOf('@') === 0) this.emit('@', oneJSONObject, tag)
-              if (tag !== '@') this.emit(tag, oneJSONObject, tag)
+              if (tag.indexOf('@') === 0) this.emit('@', tag, oneJSONObject)
+              if (tag !== '@') {
+                this.emit(tag, tag, oneJSONObject)
+                this.emit('message', tag, oneJSONObject)
+              }
               break;
 
             case PAYLOAD_TYPE.MJSON:
               let mjsonBuffer = decoder.decode(payloadBuffer)
               let mjson = JSON.parse(mjsonBuffer)
-              if (tag.indexOf('@') === 0) this.emit('@', ...mjson, tag)
-              if (tag !== '@') this.emit(tag, ...mjson, tag)
+              if (tag.indexOf('@') === 0) this.emit('@', tag, ...mjson)
+              if (tag !== '@') {
+                this.emit(tag, tag, ...mjson)
+                this.emit('message', tag, ...mjson)
+              }
               break;
 
             case PAYLOAD_TYPE.MBA:
               let mbaObject = MBP.unpack(payloadBuffer)
-              if (tag.indexOf('@') === 0) this.emit('@', ...mbaObject.args, tag)
-              if (tag !== '@') this.emit(tag, ...mbaObject.args, tag)
+              if (tag.indexOf('@') === 0) this.emit('@', tag, ...mbaObject.args)
+              if (tag !== '@') {
+                this.emit(tag, tag, ...mbaObject.args)
+                this.emit('message', tag, ...mbaObject.args)
+              }
               break;
 
             default:
@@ -598,7 +613,8 @@ export class IOCore extends EventEmitter {
           }
 
         } catch (err) {
-          this.emit('error', new Error('signal parse err'))
+          // this.emit('error', new Error('IOCore IOMsg.SIGNAL parser err', err))
+          console.log('IOCore IOMsg.SIGNAL parser err', err)
         }
         break;
 
@@ -607,24 +623,25 @@ export class IOCore extends EventEmitter {
         break;
 
       case Boho.BohoMsg.AUTH_NONCE:
+        this.stateChange('auth_nonce','server sent auth_nonce.')
         let auth_hmac = this.boho.auth_hmac(buffer)
         if (auth_hmac) {
           this.send(auth_hmac)
         } else {
-          this.stateChange('auth_fail', 'Invalid local auth_hmac.')
+          this.stateChange('auth_fail', 'boho.auth_hmac() invalid auth_nonce.')
         }
         break;
 
       case Boho.BohoMsg.AUTH_FAIL:
-        this.stateChange('auth_fail', 'server reject auth.')
+        this.stateChange('auth_fail', 'auth_fail from server.')
         break;
 
       case Boho.BohoMsg.AUTH_ACK:
         if (this.boho.check_auth_ack_hmac(buffer)) {
-          this.stateChange('auth_ready', 'server sent auth_ack')
+          this.stateChange('auth_ack', 'server sent auth_ack')
           this.send(Buffer.from([IOMsg.CID_REQ]))
         } else {
-          this.stateChange('auth_fail', 'invalid server_hmac')
+          this.stateChange('auth_fail', 'check_auth_ack_hmac() invalid server_hmac')
         }
         break;
 
@@ -811,14 +828,15 @@ export class IOCore extends EventEmitter {
 
 
   /**
-   * Publishes a signal.
+   * alias of signal()
+   * Sends a signal with a tag and arguments.
+   * @param {string} tag - The signal tag.
    * @param {...any} args - Arguments for the signal.
    */
-  publish(...args) {
-    this.signal(...args)
+  publish(tag, ...args) {
+    this.signal(tag, ...args)
   }
 
-
   /**
    * Sends a signal with a tag and arguments.
    * @param {string} tag - The signal tag.
@@ -827,7 +845,6 @@ export class IOCore extends EventEmitter {
    */
   signal(tag, ...args) {
     if (typeof tag !== 'string') throw TypeError('tag should be string.')
-
     let signalPack = getSignalPack(tag, ...args)
     this.send_enc_mode(signalPack)
   }
@@ -871,7 +888,6 @@ export class IOCore extends EventEmitter {
   }
 
 
-
   /**
    * Sets a value in the store.
    * @param {string} storeName - The name of the store.
@@ -939,21 +955,24 @@ export class IOCore extends EventEmitter {
    */
   subscribe(tag) {
     if (typeof tag !== 'string') throw TypeError('tag should be string.')
-    if (this.state !== STATES.READY) return
-
-    let tagList = tag.split(',')
-    tagList.forEach(tag => {
-      this.channels.add(tag)
-    })
-
-    let tagEncoded = encoder.encode(tag)
-    if (tagEncoded.byteLength > SIZE_LIMIT.TAG_LEN1) throw TypeError('please use tag string bytelength below:' + SIZE_LIMIT.TAG_LEN1)
-
-    this.send_enc_mode(
-      Buffer.concat([
-        MBP.NB('8', IOMsg.SUBSCRIBE),
-        MBP.NB('8', tagEncoded.byteLength),
-        tagEncoded]))
+    if (tag.length > SIZE_LIMIT.TAG_LEN1) throw TypeError('please check tag string length limit:' + SIZE_LIMIT.TAG_LEN1)
+    if (this.state !== STATE.READY) return
+
+    // subscribe 사용시,  사용 'ready' 이벤트시 메뉴얼 등록되므로 여기에 등록하면 2중 호출된다.
+    // 즉, channels 등록은 listen 같은 자동화 구독시만 사용. 
+    // let tagList = tag.split(',')
+    // tagList.forEach(tag => {
+    //   this.channels.add(tag)
+    // })
+
+    try {
+      let tagEncoded = encoder.encode(tag)
+      this.send_enc_mode(
+        Buffer.concat([
+          MBP.NB('8', IOMsg.SUBSCRIBE),
+          MBP.NB('8', tagEncoded.byteLength),
+          tagEncoded]))
+    } catch (error) { }
   }
 
   /**
@@ -964,20 +983,22 @@ export class IOCore extends EventEmitter {
    */
   subscribe_promise(tag) {
     if (typeof tag !== 'string') throw TypeError('tag should be string.')
-    if (this.state !== STATES.READY) {
+    if (tag.length > SIZE_LIMIT.TAG_LEN2) throw TypeError('please check tag string length limit:' + SIZE_LIMIT.TAG_LEN2)
+
+    if (this.state !== STATE.READY) {
       return Promise.reject('subscribe_promise:: connection is not ready')
     }
 
-    let tagEncoded = encoder.encode(tag)
-    if (tagEncoded.byteLength > SIZE_LIMIT.TAG_LEN2) throw TypeError('please use tag string bytelength: ' + SIZE_LIMIT.TAG_LEN2)
-
-    this.send_enc_mode(
-      Buffer.concat([
-        MBP.NB('8', IOMsg.SUBSCRIBE_REQ),
-        MBP.NB('16', ++this.mid),
-        MBP.NB('16', tagEncoded.byteLength),
-        tagEncoded]))
-    return this.setMsgPromise(this.mid)
+    try {
+      let tagEncoded = encoder.encode(tag)
+      this.send_enc_mode(
+        Buffer.concat([
+          MBP.NB('8', IOMsg.SUBSCRIBE_REQ),
+          MBP.NB('16', ++this.mid),
+          MBP.NB('16', tagEncoded.byteLength),
+          tagEncoded]))
+      return this.setMsgPromise(this.mid)
+    } catch (error) { }
   }
 
   /**
@@ -1039,7 +1060,7 @@ export class IOCore extends EventEmitter {
     }
     this.on(tag, handler)
     // do not subscribe now.
-    // will subscribe when receive CID_RES signal from server.
+    // will subscribe when io state is 'ready'. (receive CID_RES from server)
 
   }
 
@@ -1150,10 +1171,10 @@ export class IOCore extends EventEmitter {
    */
   getStateName() {
     //state <number>
-    //value of constant STATES.NAME < number >
-    //type of constant STATES.NAME name < string uppercase >
+    //value of constant STATE.NAME < number >
+    //type of constant STATE.NAME name < string uppercase >
     //stateName,eventName <string lowercase>
-    return (STATES[this.state]).toLowerCase()
+    return (STATE[this.state]).toLowerCase()
   }
 
   /**
@@ -1174,15 +1195,23 @@ export class IOCore extends EventEmitter {
    * Changes the connection state and emits events.
    * @param {string} state - The new state name (e.g., 'ready', 'closed').
    * @param {string} [emitEventAndMessage] - Optional message to emit with the state change event.
+   * 
+   * 주의. 
+   * 1. 상태가 변경 될 때만 'change' 이벤트 호출된다.
+   * 2. emitEventAndMessage 옵션 값이 지정되야 해당 이벤트 이름이 호출된다.
+   *   보통 이벤트 이름과 동일하게 적거나 이벤트 상황 안내문을 넣는다.
    */
   stateChange(state, emitEventAndMessage) {
-    // STATES constant name : string upperCase
-    // eventName, .stateName : string lowerCase
-    // .state : number
+    // STATE constant name <string> upperCase
+    // eventName and .stateName <string> lowerCase
+    // .state <number>
     // console.log('### stateChange reason:', emitEventAndMessage )
     let eventName = state.toLowerCase()
-    this.state = STATES[state.toUpperCase()] // state: number
-    if (emitEventAndMessage) this.emit(eventName, emitEventAndMessage)
+    this.state = STATE[state.toUpperCase()] // state: number
+
+    if (emitEventAndMessage) {
+      this.emit(eventName, emitEventAndMessage)
+    }
 
     if (this.stateName !== eventName) {
       this.stateName = eventName

package/src/client/IOWS.js

@@ -1,5 +1,5 @@
 import { IOCore } from "./IOCore.js";
-import { STATES } from "../common/constants.js";
+import { STATE } from "../common/constants.js";
 import { WebSocket } from "ws";
 
 //  Node.js 'ws' websocket
@@ -28,15 +28,17 @@ export class IOWS extends IOCore {
   keepAlive() {
     if (!this.autoReconnect) return;
     // Reconnect only if the socket is closed and the state reflects that.
-    if ((!this.socket || this.socket.readyState === WebSocket.CLOSED) && this.state === STATES.CLOSED) {
+    if ((!this.socket || this.socket.readyState === WebSocket.CLOSED) ) {
       this.open();
+    }else{
+      this.ping();
     }
   }
 
   createConnection(url) {
     // node WebSocket
     this.socket = new WebSocket(url);
-    this.stateChange('opening')
+    this.stateChange('connecting','connecting')
 
     this.socket.onopen = () => {
       this.socket.on('message', this.onWebSocketMessage.bind(this));

package/src/client/browser/IOWebSocket.js

@@ -104,13 +104,15 @@ export default class IO extends IOCore {
 
 
   /**
-   * Keeps the connection alive by re-opening if closed.
+   * Keeps the connection alive by re-connecting if closed.
    */
   keepAlive() {
     if (!this.autoReconnect) return;
     // Reconnect only if the socket is closed and the state reflects that.
-    if ((!this.socket || this.socket.readyState === WebSocket.CLOSED) && this.state === IO.constants.STATES.CLOSED) {
+    if ((!this.socket || this.socket.readyState === WebSocket.CLOSED) ) {
       this.open();
+    }else{
+      this.ping();
     }
   }
 
@@ -126,7 +128,7 @@ export default class IO extends IOCore {
     this.socket = new WebSocket(url);
     this.socket.binaryType = IO.binaryType
 
-    this.stateChange('opening')
+    this.stateChange('connecting','connecting')
 
     this.socket.onopen = () => {
 

package/src/common/constants.js

@@ -1,52 +1,40 @@
 
 /**
- * @typedef {object} STATES
- * @property {number} OPENING
+ * @typedef {object} STATE
+ * @property {number} CONNECTING
  * @property {number} OPEN
- * @property {number} CLOSING
- * @property {number} CLOSED
  * @property {number} SERVER_READY
- * @property {number} AUTH_FAIL
- * @property {number} AUTH_READY
+ * @property {number} AUTH_ACK
+ * @property {number} CLOSING
  * @property {number} READY
+ * @property {number} AUTH_FAIL
+ * @property {number} AUTH_CLEAR
+ * @property {number} CLOSING
+ * @property {number} CLOSED
+ * @property {number} STOP
  * @property {number} REDIRECTING
  */
-// Client STATES: name and number
-export const STATES = {
-  OPENING: 0,
-  OPEN: 1,
-  CLOSING: 2,
-  CLOSED: 3,
-  SERVER_READY: 4,
-  AUTH_FAIL: 5,
-  AUTH_READY: 6,
-  READY: 7,
-  REDIRECTING: 8
+// Client STATE: name and number
+export const STATE = {
+  CONNECTING:    0,
+  OPEN:          1,
+  SERVER_READY: 10,
+  AUTH_REQ:     11,
+  AUTH_NONCE:   12,
+  AUTH_HMAC:    13,
+  AUTH_ACK:     14,
+  AUTH_FAIL:    15,
+  AUTH_CLEAR:   16,
+  CID_REQ:      17,
+  CID_RES:      18,
+  READY:        19,
+  CLOSING:       2,
+  CLOSED:        3,
+  STOP:          4,
+  REDIRECTING:   5
 }
-for (let c in STATES) { STATES[STATES[c]] = c }
+for (let c in STATE) { STATE[STATE[c]] = c }
 
-/**
- * @typedef {object} CLIENT_STATE
- * @property {number} INIT
- * @property {number} SENT_SERVER_READY
- * @property {number} RECV_AUTH_REQ
- * @property {number} SENT_SERVER_NONCE
- * @property {number} RECV_AUTH_HMAC
- * @property {number} AUTH_FAIL
- * @property {number} AUTH_READY
- * @property {number} CID_READY
- */
-export const CLIENT_STATE = {
-  INIT: 0,
-  SENT_SERVER_READY: 1,
-  RECV_AUTH_REQ: 2,
-  SENT_SERVER_NONCE: 3,
-  RECV_AUTH_HMAC: 4,
-  AUTH_FAIL: 5,
-  AUTH_READY: 6,
-  CID_READY: 7
-}
-for (let c in CLIENT_STATE) { CLIENT_STATE[CLIENT_STATE[c]] = c }
 
 /**
  * @typedef {object} ENC_MODE
@@ -75,7 +63,7 @@ for (let c in ENC_MODE) { ENC_MODE[ENC_MODE[c]] = c }
 export const SIZE_LIMIT = {
   TAG_LEN1: 255,
   TAG_LEN2: 65535,
-  CONNECTION_CHECKER_PERIOD: 3000,
+  CONNECTION_CHECKER_PERIOD: 30000,
   PROMISE_TIMEOUT: 5000,
   DID: 8,
   CID: 12
@@ -107,7 +95,7 @@ for (let c in PAYLOAD_TYPE) { PAYLOAD_TYPE[PAYLOAD_TYPE[c]] = c }
  * @property {number} CID_REQ
  * @property {number} CID_RES
  * @property {number} QUOTA_LEVEL
- * @property {number} SERVER_CLEAR_AUTH
+ * @property {number} AUTH_CLEAR
  * @property {number} SERVER_REDIRECT
  * @property {number} LOOP
  * @property {number} ECHO
@@ -165,9 +153,8 @@ export let IOMsg = {
   CID_REQ: 0xC1,
   CID_RES: 0xC2,
   QUOTA_LEVEL: 0xC3,
-  SERVER_CLEAR_AUTH: 0xC4,
+  AUTH_CLEAR: 0xC4,
   SERVER_REDIRECT: 0xC5,
-
   // ..
   LOOP: 0xCB,
   ECHO: 0xCC,

package/src/common/util.js

@@ -59,3 +59,6 @@ export function getLocalAddress() {
   // console.log('localAddress:', localAddress)
   return localAddress
 }
+
+
+export const delay = ms => new Promise(resolve => setTimeout(resolve, ms));