iosignal 5.2.0 → 6.1.0

package/src/server/Server.js

@@ -1,236 +0,0 @@
-import net from 'net'
-import EventEmitter from 'events'
-import { WebSocketServer } from 'ws'
-import { Manager } from './Manager.js'
-import { serverOption } from './serverOption.js'
-import { STATUS } from '../services/constant.js'
-
-export class Server extends EventEmitter {
-
-  constructor(options, authManager) {
-    super();
-    this.serviceNames = 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.membersOnly) {
-      serverOption.membersOnly = options.membersOnly
-    }
-
-
-    if (options.port || options.port == 0) {
-      this.port = parseInt(options.port)
-    }
-
-    if (options.httpServer) {
-      this.httpServer = options.httpServer
-    }
-
-    if (options.wsPath) {
-      this.wsPath = options.wsPath
-    }
-
-    if (options.congPort || options.congPort == 0) {
-      this.congPort = parseInt(options.congPort)
-    }
-
-    this.manager = new Manager(this, authManager)
-
-    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() {
-    // 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"' +
-        'must be specified'
-      );
-    }
-
-    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') {
-        process.exit()
-      }
-    })
-
-    this.wss.on('close', () => {
-      // console.log('### WS server is closed.')
-    })
-
-    this.wss.on('connection', (ws, req) => {
-      ws.socketType = 'websocket'
-      this.manager.addRemote(ws, req)
-    })
-
-
-  }
-
-  startCongServer() {
-    this.congServer = net.createServer((socket) => {
-      this.manager.addRemote(socket)
-    })
-      .on('error', (err) => {
-        console.log('### cong server error:', err.message)
-        if (err.code == 'EADDRINUSE') {
-          process.exit()
-        }
-      }).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');
-        }
-      });
-  }
-
-/**
- * RPC service register.
- * service: service_name <string>
- * service_module <function module|class instance>
- * return this
- */
-  attach(service, service_module) {
-
-    if( typeof service !== 'string'){
-      throw new Error(`attach service name is not a string.`)
-    }
-    if (!service_module.checkPermission || typeof service_module.checkPermission != 'function') {
-      throw new Error(`Service ${service} : no checkPermission or not a function.`)
-    }
-    if(!service_module.commands || !Array.isArray(service_module.commands) ){
-      throw new Error(`Service ${service} : no commands or !Array.`)
-    }
-    
-    // Service TYPE 1. single call() function.
-    if ( service_module.call && typeof service_module.call == 'function' ) {
-      this.on(service, (remote, req) => {
-        try {
-          if (!service_module.checkPermission(remote, req)) {
-            remote.response(req.mid, STATUS.ERROR, "NO_PERMISSION.")
-            return
-          }
-          if( service_module.commands.includes( req.topic )){
-            // console.log('server service_module req', req )
-            service_module.call(remote, req)
-          }else{
-            remote.response(req.mid, STATUS.ERROR, "UNKNOWN_COMMAND");
-          }
-        } catch (error) {
-          console.error(`Unhandled Service Error in service [${service}]:`, error);
-          remote.response(req.mid, STATUS.ERROR, "INTERNAL_SERVER_ERROR");
-        }
-      })
-    } else {
-      // Service TYPE 2. multiple functions.
-      this.on(service, (remote, req) => {
-        try {
-          if (!service_module.checkPermission(remote, req)) {
-            remote.response(req.mid, STATUS.ERROR, "NO_PERMISSION.")
-            return
-          }
-          if( service_module.commands.includes( req.topic )){
-            service_module[req.topic](remote, req)
-          }else{
-            remote.response(req.mid, STATUS.ERROR, "UNKNOWN_COMMAND");
-          }
-        } catch (error) {
-          console.error(`Unhandled Service Error in service [${service}]:`, error);
-          remote.response(req.mid, STATUS.ERROR, "INTERNAL_SERVER_ERROR");
-        }
-      })
-    }
-    this.serviceNames.add(service)
-    // console.log(`[Service attached: ${service} ] accept commands: ${service_module.commands}`)
-    return this
-  }
-
-  close(callback) {
-    console.log('closing iosignal server...')
-    if (this.manager) {
-      this.manager.close()
-    }
-
-    this.serviceNames.forEach(v => this.removeAllListeners(v))
-    this.serviceNames.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()
-      })
-    }
-
-    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

@@ -1,56 +0,0 @@
-
-
-export let serverOption = {
-  clientTracking: false,
-  port: null, // WebSocket
-  congPort: null, // CongSocket
-  httpServer: null,
-  wsPath: null,
-  timeout: 50000,
-  showMessage: 'none',
-  showMetric: 0,
-  showChannel: 0,
-  monitorPeriod: 5000,
-  fileLogger: {
-    connection: {
-      use: false,
-      path: 'connection.log'
-    },
-    auth: {
-      use: false,
-      path: 'auth.log'
-    },
-    attack: {
-      use: false,
-      path: 'attack.log'
-    }
-  },
-  useQuota: {
-    signalSize: false,
-    publishCounter: false,
-    trafficRate: false,
-    disconnect: false
-  },
-  defaultQuotaIndex: 3,
-  adminLevel: 255,
-
-  debug: {
-    slow: false,
-    delay: 500,
-    showAuthInfo: false
-  },
-
-  retain: {
-    isAvailable: true,
-    limitSize: 100000,
-    limitCounter: 1000
-  },
-
-  auth: {
-    delay_auth_fail: 600
-  },
-  membersOnly: false
-
-}
-
-

package/src/services/RedisService.js

@@ -1,53 +0,0 @@
-/**
- * RedisService <IOSignal RPC Service>
- * 
- * iosignal 클라이언트의 redis 질의 요청을 받으면, 
- * redisClient 로 연결된 redis-server 에게 질의 후 결과를 되돌려 준다. 
- * 
- * client ex:  
- * await io.call('redis','hget','user:id' )
- * 
- */
-import { STATUS } from './constant.js'
-
-const MIN_LEVEL = 200;
-const COMMANDS = [
-  'GET', 'SET', 'HGETALL', 'HGET', 'HSET', 'SADD', 'SISMEMBER',
-  'SMEMBERS', 'EXISTS', 'SREM', 'DEL', 'KEYS', 'SAVE',
-  'get', 'set', 'hGetAll', 'hGet', 'hSet', 'sAdd', 'sIsMember',
-  'sMembers', 'exists', 'sRem', 'del', 'keys', 'save'
-]
-
-export class RedisService {
-  constructor(redisClient, _minLevel) {
-    if (!redisClient) {
-      throw new Error("RedisService constructor: no redisClient")
-    }
-    this.redisClient = redisClient
-    this.minLevel = _minLevel ? _minLevel : MIN_LEVEL
-    this.commands = COMMANDS
-  }
-
-  checkPermission(remote, req) {
-    return (remote.level >= this.minLevel) ? true : false;
-  }
-
-  async call(remote, req) {
-    let result;
-    try {
-      let cmd = req.topic
-      if (req.args?.length > 0) {
-        result = await this.redisClient[cmd](...req.args)
-      } else {
-        result = await this.redisClient[cmd]()
-      }
-      remote.response(req.mid, STATUS.OK, result)
-    } catch (e) {
-      remote.response(req.mid, STATUS.ERROR, e.message)
-    }
-  }
-
-}
-
-
-

package/src/services/constant.js

@@ -1,7 +0,0 @@
-
-export const STATUS = {
-  OK: 0,
-  //0~127: success
-  //128~255: fail
-  ERROR: 255
-}

package/src/services/replyService.js

@@ -1,39 +0,0 @@
-
-/**
- * simple IOSignal RPC Service example.
- */
-
-import { STATUS } from './constant.js'
-export const commands = ['echo', 'date', 'unixtime'];
-
-const MIN_LEVEL = 0;
-export function checkPermission(remote) {
-  return (remote.level >= MIN_LEVEL) ? true : false;
-}
-
-/**
- * client api call example:  await io.call('reply','echo','hello')
- */
-export async function echo(remote, req) {
-  if (!req.args)
-    remote.response(req.mid, STATUS.ERROR, 'no message to echo')
-  else
-    remote.response(req.mid, STATUS.OK, req.args)
-}
-
-/**
- * client api call example:  await io.call('reply','date')
- */
-export async function date(remote, req) {
-  let r = new Date().toUTCString()
-  remote.response(req.mid, STATUS.OK, r)
-}
-
-/**
- * client api call example:  await io.call('reply','unixtime')
- */
-export async function unixtime(remote, req) {
-  let r = Math.floor(Date.now() / 1000)
-  remote.response(req.mid, STATUS.OK, r)
-}
-

package/src/services/sudoService.js

@@ -1,85 +0,0 @@
-import { STATUS } from './constant.js'
-
-export const commands = [
-  'cid', 'remotes', 'clients',
-  'channels', 'subscribers',
-  'remote', 'client', 'close',
-  'addauth', 'getauth', 'delauth',
-  'getauthidlist', 'getdevicelist',
-  'adddevice', 'getdevice', 'deldevice'
-]
-
-const MIN_LEVEL = 255;
-export function checkPermission(remote) {
-  return (remote.level >= MIN_LEVEL) ? true : false;
-}
-
-export async function call(remote, req) {
-  let result;
-  let status = 0;
-  try {
-    let cmd = req.topic;
-    cmd = cmd.toLowerCase()
-    if (cmd == 'cid') {
-      result = remote.manager.metrics.getCIdList()
-    } else if (cmd == 'remotes' || cmd == 'clients') {
-      result = remote.manager.metrics.getRemotes()
-    } else if (cmd == 'channels') {
-      result = remote.manager.metrics.getChannelList()
-    } else if (cmd == 'subscribers') {
-      let ch = req.$[0]
-      if (ch) result = remote.manager.metrics.getSubscribers(ch)
-    } else if (cmd == 'remote' || cmd == 'client') {
-      let cid = req.$[0]
-      let mode = req.$[1]
-      if (cid) result = remote.manager.metrics.getRemoteByCId(cid, mode)
-
-    } else if (cmd == 'close') {
-      if (req.$[0]) result = remote.manager.closeRemoteByCId(req.$[0])
-
-    } else if (cmd == 'addauth' || cmd == 'adddevice') {
-      if (remote.manager.authManager && req.$.length == 4) {
-        if (remote.manager.authManager.addAuth) {
-          let did = req.$[0]
-          let dkey = req.$[1]
-          let cid = req.$[2]
-          let level = req.$[3]
-          result = await remote.manager.authManager.addAuth(did, dkey, cid, level)
-        }
-
-      }
-    } else if (cmd == 'delauth' || cmd == 'deldevice') {
-      if (remote.manager.authManager && req.$.length == 1) {
-        if (remote.manager.authManager.delAuth) {
-          let did = req.$[0]
-          result = await remote.manager.authManager.delAuth(did)
-        }
-      }
-    } else if (cmd == 'getauth' || cmd == 'getdevice') {
-      if (remote.manager.authManager && req.$.length == 1) {
-        if (remote.manager.authManager.getAuth) {
-          let did = req.$[0]
-          result = await remote.manager.authManager.getAuth(did)
-        }
-      }
-    } else if (cmd == 'getauthidlist' || cmd == 'getdevicelist') {
-      if (remote.manager.authManager) {
-        if (remote.manager.authManager.getAuthIdList) {
-          result = await remote.manager.authManager.getAuthIdList()
-        }
-      }
-    } else {
-      status = STATUS.ERROR;
-      result = "service sudo: no such a cmd: " + cmd
-    }
-
-    remote.response(req.mid, status, result)
-
-  } catch (e) {
-    remote.response(req.mid, STATUS.ERROR, e.message)
-  }
-
-}
-
-
-

package/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "compilerOptions": {
-    "declaration": true,
-    "emitDeclarationOnly": true,
-    "rootDir": "./src",
-    "outDir": "./dist/types",
-    "allowJs": true,
-    "module": "nodenext",    
-    "moduleResolution": "nodenext",
-    "target": "es2020",
-    "lib": ["es2020", "dom"],
-    "paths": {
-      "@src/*": ["./src/*"]
-    }
-  },
-  "include": [
-    "src/client/browser/IOWebSocket.js",
-    "src/client/IOCore.js",
-    "src/common/constants.js"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
-}