iosignal 4.6.1 → 4.8.0

package/src/client/IOCore.js

@@ -460,7 +460,7 @@ export class IOCore extends EventEmitter {
 
         // **IMPORTANT** change state before subscribe.
         this.stateChange('ready', 'cid_ready')
-        this.subscribe_memory_channels()  // tags registered by listen() or link().
+        this.subscribe_channels() 
         break;
 
       case IOMsg.QUOTA_LEVEL:
@@ -732,6 +732,7 @@ export class IOCore extends EventEmitter {
       console.log('## your maximum signalSize(bytes) is:', this.quota.signalSize)
       return
     }
+    // console.log(`C->[${IOMsg[ data[0]]}]`)
     this.socket_send(data);
   }
 
@@ -900,7 +901,7 @@ export class IOCore extends EventEmitter {
     if (!storeName || args.length == 0) {
       return Promise.reject(new Error('set need storeName and value)'))
     }
-    return this.req('store', 'set', storeName, ...args)
+    return this.call('store', 'set', storeName, ...args)
   }
 
   /**
@@ -912,26 +913,26 @@ export class IOCore extends EventEmitter {
     if (!storeName) {
       return Promise.reject(new Error('store get need storeName)'))
     }
-    let pack = await this.req('store', 'get', storeName)
+    let pack = await this.call('store', 'get', storeName)
     let { $ } = MBP.unpack(pack.body)
     return $
   }
 
 
   /**
-   * Sends a request to a target and topic.(remote api call)
-   * @param {string} target - The target(api name) of the request.
-   * @param {string} topic - The topic(api function name) of the request.
+   * Sends a request to a target and topic.(remote service call)
+   * @param {string} target - The target(service name) of the request.
+   * @param {string} topic - The topic(service function name) of the request.
    * @param {...any} args - Optional arguments for the request.
    * @returns {Promise<any>}
    */
-  req(target, topic, ...args) {
+  call(target, topic, ...args) {
     if (!target || !topic)
       return Promise.reject(new Error('request need target and topic)'))
     let sigPack;
     if (args.length > 0) {
       sigPack = MBP.pack(
-        MBP.MB('#MsgType', '8', IOMsg.REQUEST),
+        MBP.MB('#MsgType', '8', IOMsg.CALL),
         MBP.MB('mid', '16', ++this.mid),
         MBP.MB('target', target),
         MBP.MB('topic', topic),
@@ -939,7 +940,7 @@ export class IOCore extends EventEmitter {
       )
     } else {
       sigPack = MBP.pack(
-        MBP.MB('#MsgType', '8', IOMsg.REQUEST),
+        MBP.MB('#MsgType', '8', IOMsg.CALL),
         MBP.MB('mid', '16', ++this.mid),
         MBP.MB('target', target),
         MBP.MB('topic', topic)
@@ -958,14 +959,6 @@ export class IOCore extends EventEmitter {
   subscribe(tag) {
     if (typeof tag !== 'string') throw TypeError('tag should be string.')
     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)
@@ -975,47 +968,27 @@ export class IOCore extends EventEmitter {
           MBP.NB('8', tagEncoded.byteLength),
           tagEncoded]))
     } catch (error) { }
+
   }
 
+
   /**
-   * Subscribes to a channel or channels with a promise.
-   * @param {string} tag - The tag(s) of the channel(s) to subscribe to (comma-separated).
-   * @returns {Promise<any>}
-   * @throws {TypeError} If tag is not a string or exceeds length limit.
+   * Subscribes stored channels.
+   * called client state become 'ready'
    */
-  subscribe_promise(tag) {
-    if (typeof tag !== 'string') throw TypeError('tag should be string.')
-    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')
-    }
+  subscribe_channels() {
+    if (this.state !== STATE.READY) return
+    if (this.channels.size == 0) return
+    let tag = Array.from(this.channels).join(',')
 
     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),
+          MBP.NB('8', IOMsg.SUBSCRIBE),
+          MBP.NB('8', tagEncoded.byteLength),
           tagEncoded]))
-      return this.setMsgPromise(this.mid)
     } catch (error) { }
-  }
-
-  /**
-   * Subscribes to channels stored in memory (local cache).
-   */
-  subscribe_memory_channels() { //local cache . auto_resubscribe
-    if (this.channels.size == 0) return
-    let chList = Array.from(this.channels).join(',')
-
-    this.subscribe_promise(chList)
-      .then((res) => {
-        // console.log('>> SUBSCRIBE_REQ result', res ) // return code == map.size
-      }).catch((e) => {
-        console.log('>> SUBSCRIBE FAIL:', e)
-      })
 
   }
 

package/src/common/constants.js

@@ -116,7 +116,7 @@ for (let c in PAYLOAD_TYPE) { PAYLOAD_TYPE[PAYLOAD_TYPE[c]] = c }
  * @property {number} SET
  * @property {number} RESPONSE_CODE
  * @property {number} RESPONSE_MBP
- * @property {number} REQUEST
+ * @property {number} CALL
  * @property {number} RESPONSE
  * @property {number} FLOW_MODE
  * @property {number} WAIT
@@ -181,11 +181,10 @@ export let IOMsg = {
 
   //.. 
   SET: 0xDB,   //
-  RESPONSE_CODE: 0xDC,
+  // RESPONSE_CODE: 0xDC,
   RESPONSE_MBP: 0xDD,
-
-  REQUEST: 0xDE, //client public
-  RESPONSE: 0xDF,
+  CALL: 0xDE, // rpc call
+  // RESPONSE: 0xDF,
   // ~DF
 
 
@@ -203,22 +202,13 @@ export let IOMsg = {
 for (let c in IOMsg) { IOMsg[IOMsg[c]] = c }
 // console.log( IOMsg );
 
-/**
- * @typedef {object} API_TYPE
- * @property {string} REQUEST_RESPONSE
- * @property {string} ONE_WAY
- */
-export const API_TYPE = {
-  'REQUEST_RESPONSE': 'requet_response',
-  'ONE_WAY': 'one_way'
-}
 
 /**
  * @typedef {object} STATUS
  * @property {number} OK
  * @property {number} ERROR
  */
-// api response status code
+// service response status code
 export const STATUS = {
   OK: 0,
   //0~127: success

package/src/server/Manager.js

@@ -119,7 +119,7 @@ export class Manager {
     }
 
 
-    if (remote.uid && this.server.apiNames.has('account')) {
+    if (remote.uid && this.server.serviceNames.has('account')) {
       let req = { topic: 'detachUserRemote' }
       req.args = ['caller:manager.removeRemote']
       this.server.emit('account', remote, req)

package/src/server/Remote.js

@@ -187,6 +187,7 @@ export class Remote extends RemoteCore {
 
   // node.js server side remote.
   send(message, isBinary) {
+    // console.log(`<-S [${IOMsg[ message[0]]}]`)
     this.manager.txBytes += message.byteLength;
     this.socket.txCounter++;
     if (this.socketType === 'websocket') {

package/src/server/RemoteCore.js

@@ -265,15 +265,15 @@ export class RemoteCore {
           break;
 
 
-        case IOMsg.REQUEST: //api request
+        case IOMsg.CALL: //service request
           try {
             let req = MBP.unpack(message)
             if (req) {
               if (!req.target || !req.topic) return
-              if (this.manager.server.apiNames.has(req.target)) {
+              if (this.manager.server.serviceNames.has(req.target)) {
                 this.manager.server.emit(req.target, this, req)
               } else {
-                // console.log('UnKnown API req: ', req.target)
+                // console.log('UnKnown Service call: ', req.target)
               }
             }
           } catch (e) {

package/src/server/Server.js

@@ -3,13 +3,13 @@ import EventEmitter from 'events'
 import { WebSocketServer } from 'ws'
 import { Manager } from './Manager.js'
 import { serverOption } from './serverOption.js'
-import { STATUS } from '../api/api_constant.js'
+import { STATUS } from '../services/constant.js'
 
 export class Server extends EventEmitter {
 
   constructor(options, authManager) {
     super();
-    this.apiNames = new Set()
+    this.serviceNames = new Set()
     this.wss = {};
     this.port = null;
     this.congPort = null;
@@ -130,63 +130,63 @@ export class Server extends EventEmitter {
   }
 
 /**
- * API register.
- * target:  api_name <string>
- * api: api_module <function module|class instance>
+ * RPC service register.
+ * target:  service_name <string>
+ * service: service_module <function module|class instance>
  * return this
  */
-  api(target, api) {
+  attach(target, service_module) {
 
     if( typeof target !== 'string'){
-      throw new Error(`api( target ,api ) target name is not a string.`)
+      throw new Error(`service( target ,service ) target name is not a string.`)
     }
-    if (!api.checkPermission || typeof api.checkPermission != 'function') {
-      throw new Error(`API ${target} : no checkPermission or not a function.`)
+    if (!service_module.checkPermission || typeof service_module.checkPermission != 'function') {
+      throw new Error(`Service ${target} : no checkPermission or not a function.`)
     }
-    if(!api.commands || !Array.isArray(api.commands) ){
-      throw new Error(`API ${target} : no commands or !Array.`)
+    if(!service_module.commands || !Array.isArray(service_module.commands) ){
+      throw new Error(`Service ${target} : no commands or !Array.`)
     }
     
-    // API TYPE 1. single request() function.
-    if ( api.request && typeof api.request == 'function' ) {
+    // Service TYPE 1. single call() function.
+    if ( service_module.call && typeof service_module.call == 'function' ) {
       this.on(target, async (remote, req) => {
         try {
-          if (!api.checkPermission(remote, req)) {
+          if (!service_module.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)
+          if( service_module.commands.includes( req.topic )){
+            // console.log('server service_module req', req )
+            await service_module.call(remote, req)
           }else{
             remote.response(req.mid, STATUS.ERROR, "UNKNOWN_COMMAND");
           }
         } catch (error) {
-          console.error(`Unhandled API Error in target [${target}]:`, error);
+          console.error(`Unhandled Service Error in target [${target}]:`, error);
           remote.response(req.mid, STATUS.ERROR, "INTERNAL_SERVER_ERROR");
         }
       })
     } else {
-      // API TYPE 2. multiple functions.
+      // Service TYPE 2. multiple functions.
       this.on(target, async (remote, req) => {
         try {
-          if (!api.checkPermission(remote, req)) {
+          if (!service_module.checkPermission(remote, req)) {
             remote.response(req.mid, STATUS.ERROR, "NO_PERMISSION.")
             return
           }
-          if( api.commands.includes( req.topic )){
-            await api[req.topic](remote, req)
+          if( service_module.commands.includes( req.topic )){
+            await service_module[req.topic](remote, req)
           }else{
             remote.response(req.mid, STATUS.ERROR, "UNKNOWN_COMMAND");
           }
         } catch (error) {
-          console.error(`Unhandled API Error in target [${target}]:`, error);
+          console.error(`Unhandled Service 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}`)
+    this.serviceNames.add(target)
+    // console.log(`[Service attached: ${target} ] accept commands: ${service_module.commands}`)
     return this
   }
 
@@ -196,8 +196,8 @@ export class Server extends EventEmitter {
       this.manager.close()
     }
 
-    this.apiNames.forEach(v => this.removeAllListeners(v))
-    this.apiNames.clear()
+    this.serviceNames.forEach(v => this.removeAllListeners(v))
+    this.serviceNames.clear()
 
     let serverCount = 0;
     if (this.wss) serverCount++;

package/src/{api/RedisAPI.js → services/RedisService.js}

@@ -1,14 +1,14 @@
 /**
- * RedisAPI <IOSignal API>
+ * RedisService <IOSignal RPC Service>
  * 
  * iosignal 클라이언트의 redis 질의 요청을 받으면, 
  * redisClient 로 연결된 redis-server 에게 질의 후 결과를 되돌려 준다. 
  * 
  * client ex:  
- * await io.req('redis','hget','user:id' )
+ * await io.call('redis','hget','user:id' )
  * 
  */
-import { STATUS } from './api_constant.js'
+import { STATUS } from './constant.js'
 
 const MIN_LEVEL = 200;
 const COMMANDS = [
@@ -18,10 +18,10 @@ const COMMANDS = [
   'sMembers', 'exists', 'sRem', 'del', 'keys', 'save'
 ]
 
-export class RedisAPI {
+export class RedisService {
   constructor(redisClient, _minLevel) {
     if (!redisClient) {
-      throw new Error("RedisAPI constructor: no redisClient")
+      throw new Error("RedisService constructor: no redisClient")
     }
     this.redisClient = redisClient
     this.minLevel = _minLevel ? _minLevel : MIN_LEVEL
@@ -32,7 +32,7 @@ export class RedisAPI {
     return (remote.level >= this.minLevel) ? true : false;
   }
 
-  async request(remote, req) {
+  async call(remote, req) {
     let result;
     try {
       let cmd = req.topic

package/src/{api/api_reply.js → services/replyService.js}

@@ -1,9 +1,9 @@
 
 /**
- * simple IOSignal API example.
+ * simple IOSignal RPC Service example.
  */
 
-import { STATUS } from './api_constant.js'
+import { STATUS } from './constant.js'
 export const commands = ['echo', 'date', 'unixtime'];
 
 const MIN_LEVEL = 0;
@@ -12,7 +12,7 @@ export function checkPermission(remote) {
 }
 
 /**
- * client api call example:  await io.req('reply','echo','hello')
+ * client api call example:  await io.call('reply','echo','hello')
  */
 export async function echo(remote, req) {
   if (!req.args)
@@ -22,7 +22,7 @@ export async function echo(remote, req) {
 }
 
 /**
- * client api call example:  await io.req('reply','date')
+ * client api call example:  await io.call('reply','date')
  */
 export async function date(remote, req) {
   let r = new Date().toUTCString()
@@ -30,7 +30,7 @@ export async function date(remote, req) {
 }
 
 /**
- * client api call example:  await io.req('reply','unixtime')
+ * client api call example:  await io.call('reply','unixtime')
  */
 export async function unixtime(remote, req) {
   let r = Math.floor(Date.now() / 1000)

package/src/{api/api_sudo.js → services/sudoService.js}

@@ -1,4 +1,4 @@
-import { STATUS } from './api_constant.js'
+import { STATUS } from './constant.js'
 
 export const commands = [
   'cid', 'remotes', 'clients',
@@ -14,7 +14,7 @@ export function checkPermission(remote) {
   return (remote.level >= MIN_LEVEL) ? true : false;
 }
 
-export async function request(remote, req) {
+export async function call(remote, req) {
   let result;
   let status = 0;
   try {
@@ -70,7 +70,7 @@ export async function request(remote, req) {
       }
     } else {
       status = STATUS.ERROR;
-      result = "api sudo: no such a cmd: " + cmd
+      result = "service sudo: no such a cmd: " + cmd
     }
 
     remote.response(req.mid, status, result)

package/tsconfig.json

@@ -5,7 +5,7 @@
     "outDir": "./dist/types",
     "allowJs": true,
     "moduleResolution": "node",
-    "target": "es2015",
+    "target": "es2020",
     "lib": ["es2020", "dom"],
     "baseUrl": ".",
     "paths": {