oox 0.3.5 → 0.3.7

package/README.md

@@ -5,7 +5,7 @@
 graceful microservice framework.
 
 ### Features
-- [x] HTTP & socket.io support (native SSL supported)
+- [x] HTTP & WebSocket support (native SSL supported)
 - [x] Zero configure startup
 - [x] Non-invasive coding style
 - [x] Intuitive route style

package/app.js

@@ -1,12 +1,6 @@
 import { EventEmitter } from 'node:events';
-import { AsyncLocalStorage } from 'node:async_hooks';
 import { genKVMethods } from './utils.js';
-export * as logger from './logger.js';
-export class AppContext {
-    // 请求溯源ID
-    traceId = '';
-}
-export const asyncStore = new AsyncLocalStorage();
+import { asyncStore } from './context.js';
 export const eventHub = new EventEmitter();
 /**
  * sourceMethods => methods

package/bin/cli.js

@@ -63,11 +63,6 @@ if (execFilename.endsWith('oox') || fileURLToPath(import.meta.url) === execFilen
             ['http.ssl.cert', 'file', 'set HTTPS certificate path'],
             ['http.ssl.key', 'file', 'set HTTPS private key path'],
             ['http.ssl.ca', 'file', 'set HTTPS CA path'],
-            ['socketio', 'json/bool', 'SocketIO server options, support flat name, or set no to disable SocketIO server'],
-            ['socketio.port', 'int server port'],
-            ['socketio.path', 'string', 'set SocketIO server path'],
-            ['socketio.origin', 'urls', 'set SocketIO server origin, support string | array<string>'],
-            ['socketio.ssl', 'json', 'like http.ssl'],
         ];
         console.log(mergeCommandParams(params_base));
         console.log(chalk.bold('Registry:'));

package/bin/proxy-require.js

@@ -4,10 +4,6 @@ import * as path from 'node:path';
 import * as oox from '../index.js';
 import { Module } from 'node:module';
 const require = createRequire(import.meta.url);
-/**
- * 为了不重复创建Proxy，这个对象用于保存各个RPC服务的各个属性Proxy
- */
-const rpcServiceAttrMap = Object.create(null);
 /**
  * 重写 require 缓存
  */
@@ -24,24 +20,6 @@ function rewriteModuleCache(id, exports) {
     m.paths = paths;
     require.cache[id] = m;
 }
-function dotCall(name, action) {
-    return new Proxy(function () { }, {
-        get(target, key) {
-            const attrKey = name + '.' + (action ? action + '.' + key : key);
-            if (rpcServiceAttrMap) {
-                // 不重复创建Proxy
-                return rpcServiceAttrMap[attrKey];
-            }
-            const attrProxy = dotCall(name, attrKey);
-            rpcServiceAttrMap[attrKey] = attrProxy;
-            return attrProxy;
-        },
-        has(target, key) { return true; },
-        apply(target, thisArg, args) {
-            return oox.rpc(name, action, args);
-        }
-    });
-}
 export function proxyGroup(groupDirectory, excludes = []) {
     if (!groupDirectory)
         return;
@@ -70,7 +48,7 @@ export function proxyGroup(groupDirectory, excludes = []) {
             name = scriptMatch[1];
         }
         if (!excludes.includes(name))
-            rewriteModuleCache(id, dotCall(name, ''));
+            rewriteModuleCache(id, oox.proxy(name));
     }
 }
 /**

package/bin/starter.js

@@ -1,6 +1,6 @@
 import * as path from 'node:path';
 import chalk from 'chalk';
-import { formatters as configFormatters } from '../config.js';
+import { configFormatters } from '../config.js';
 import * as oox from '../index.js';
 import { buildConfig } from './configurer.js';
 import { registry } from './register.js';
@@ -57,13 +57,16 @@ export async function startup() {
     // 服务启动
     await oox.serve();
     oox.emit('app:served');
-    const { http, socketio } = oox.modules.builtins;
+    const { http } = oox.modules.builtins;
     console.log();
     console.log('Service', chalk.bold(`${oox.config.name}`), 'running.');
-    if (http.config.enabled)
-        console.log('  at', chalk.underline.green(http.getURL()));
-    if (socketio.config.enabled)
-        console.log('  at', chalk.underline.green(socketio.getURL()));
+    // 打包服务地址
+    const maxNameLength = Math.max(...oox.modules.queue.map(module => module.name.length));
+    for (const module of oox.modules.queue) {
+        const spaces = ' '.repeat(Math.max(0, maxNameLength - module.name.length));
+        if (module.config.enabled && module.serviceURL)
+            console.log(`  ${spaces}${chalk.bold(module.name)} at`, chalk.underline.green(module.serviceURL.toString()));
+    }
     console.log();
     // 服务注册
     if (config.registry)

package/config.js

@@ -43,7 +43,7 @@ export class Config {
         caller: [],
     };
 }
-export const formatters = {
+export const configFormatters = {
     id: function (value) {
         return String(value || randomUUID());
     },
@@ -114,3 +114,32 @@ export const formatters = {
         return value;
     }
 };
+/**
+ * 检查连接是否被允许
+ * @param ip 连接主机 IP
+ * @param caller 连接服务名称
+ * @param token 令牌
+ * @returns 是否被允许
+ */
+export function checkAllow(ip, caller, token) {
+    // check trusted token
+    const trusted = !config.token || token === config.token;
+    if (!trusted) {
+        const { allow } = config;
+        if (!allow.untrusted) {
+            return { allow: false, reason: 'untrusted' };
+        }
+        if (Array.isArray(allow.ip) && allow.ip.length) {
+            let allowed = allow.ip.some(item => item === '*' || new RegExp(item).test(ip));
+            if (!allowed)
+                return { allow: false, reason: 'not allow ip=' + ip };
+        }
+        if (Array.isArray(allow.caller) && allow.caller.length) {
+            let allowed = allow.caller.some(item => item === '*' || new RegExp(item).test(caller));
+            if (!allowed)
+                return { allow: false, reason: 'not allow caller=' + caller };
+        }
+    }
+    return { allow: true };
+}
+export const config = new Config();

package/context.js

@@ -0,0 +1,58 @@
+import { randomUUID } from 'node:crypto';
+import { AsyncLocalStorage } from 'node:async_hooks';
+export const asyncStore = new AsyncLocalStorage();
+export class AppContext {
+    // 请求溯源ID
+    traceId = '';
+}
+export class Context extends AppContext {
+    // 请求溯源IP
+    sourceIP = '';
+    // 请求者IP
+    ip = '';
+    // 请求者名称
+    caller = 'anonymous';
+    // 请求者ID (长连接专用)
+    callerId = '';
+    // 请求者连接把柄
+    connection;
+    constructor(context) {
+        super();
+        if (context) {
+            if ('toJSON' in context && typeof context.toJSON !== 'function') {
+                throw new Error('Context.toJSON must be a function');
+            }
+            Object.assign(this, context);
+        }
+    }
+    toJSON() {
+        const context = Object.assign({}, this);
+        delete context.connection;
+        return context;
+    }
+}
+let genTraceIdFunction = () => randomUUID();
+export function setGenTraceIdFunction(fn) {
+    genTraceIdFunction = fn;
+}
+/**
+ * 生成随机不重复id
+ */
+export function genTraceId() {
+    return genTraceIdFunction();
+}
+/**
+ * 获取链路跟踪上下文
+ */
+export function genContext(context) {
+    const newContext = new Context(context);
+    if (!newContext.traceId)
+        newContext.traceId = genTraceId();
+    if (!newContext.sourceIP)
+        newContext.sourceIP = newContext.ip;
+    return newContext;
+}
+export function getContext() {
+    const context = asyncStore.getStore();
+    return context || genContext();
+}

package/index.js

@@ -1,61 +1,3 @@
-import { randomUUID } from 'node:crypto';
-import { asyncStore, AppContext, } from './app.js';
-import * as registry from './registry.js';
-import { Config } from './config.js';
-import Module from './modules/module.js';
-import { KeepAliveConnection, keepAliveConnections, enabledKeepAliveConnections, KeepAliveConnectionError, } from './keepalive-connection.js';
-export class Context extends AppContext {
-    // 请求溯源IP
-    sourceIP = '';
-    // 请求者IP
-    ip = '';
-    // 请求者名称
-    caller = 'anonymous';
-    // 请求者ID (长连接专用)
-    callerId = '';
-    // 请求者连接把柄
-    connection;
-    constructor(context) {
-        super();
-        if (context) {
-            if ('toJSON' in context && typeof context.toJSON !== 'function') {
-                throw new Error('Context.toJSON must be a function');
-            }
-            Object.assign(this, context);
-        }
-    }
-    toJSON() {
-        const context = Object.assign({}, this);
-        delete context.connection;
-        return context;
-    }
-}
-export const config = new Config();
-let genTraceIdFunction = () => randomUUID();
-export function setGenTraceIdFunction(fn) {
-    genTraceIdFunction = fn;
-}
-/**
- * 生成随机不重复id
- */
-export function genTraceId() {
-    return genTraceIdFunction();
-}
-/**
- * 获取链路跟踪上下文
- */
-export function genContext(context) {
-    const newContext = new Context(context);
-    if (!newContext.traceId)
-        newContext.traceId = genTraceId();
-    if (!newContext.sourceIP)
-        newContext.sourceIP = newContext.ip;
-    return newContext;
-}
-export function getContext() {
-    const context = asyncStore.getStore();
-    return context || genContext();
-}
 export async function serve() {
     await modules.serve();
     registry.startBroadcastTimer();
@@ -64,96 +6,14 @@ export async function stop() {
     await modules.stop();
     registry.stopBroadcastTimer();
 }
-/**
- * 检查连接是否被允许
- * @param ip 连接主机 IP
- * @param caller 连接服务名称
- * @param token 令牌
- * @returns 是否被允许
- */
-export function checkAllow(ip, caller, token) {
-    // check trusted token
-    const trusted = !config.token || token === config.token;
-    if (!trusted) {
-        const { allow } = config;
-        if (!allow.untrusted) {
-            return { allow: false, reason: 'untrusted' };
-        }
-        if (Array.isArray(allow.ip) && allow.ip.length) {
-            let allowed = allow.ip.some(item => item === '*' || new RegExp(item).test(ip));
-            if (!allowed)
-                return { allow: false, reason: 'not allow ip=' + ip };
-        }
-        if (Array.isArray(allow.caller) && allow.caller.length) {
-            let allowed = allow.caller.some(item => item === '*' || new RegExp(item).test(caller));
-            if (!allowed)
-                return { allow: false, reason: 'not allow caller=' + caller };
-        }
-    }
-    return { allow: true };
-}
-/**
- * 添加长连接
- * @throws {KeepAliveConnectionError} 连接已存在
- * @param connection
- */
-export function addKeepAliveConnection(connection) {
-    if (keepAliveConnections.has(connection.data.name, connection.data.id)) {
-        connection.disconnect();
-        throw new KeepAliveConnectionError('Connection already exists', connection);
-    }
-    keepAliveConnections.add(connection);
-}
-export function removeKeepAliveConnection(arg1, arg2) {
-    if (typeof arg1 === 'string') {
-        const connection = keepAliveConnections.get(arg1, arg2);
-        if (connection)
-            connection.disconnect();
-        keepAliveConnections.remove(arg1, arg2);
-        enabledKeepAliveConnections.remove(arg1, arg2);
-    }
-    else {
-        arg1.disconnect();
-        keepAliveConnections.remove(arg1);
-        enabledKeepAliveConnections.remove(arg1);
-    }
-}
-/**
-* random connection select for default load balance policy
-* @param name service name
-* @returns selected connection
-*/
-let loadBalancePolicy = (name) => {
-    const connections = enabledKeepAliveConnections.getConnectionsOfService(name);
-    if (!connections || !connections.size)
-        return null;
-    const arrayConnections = Array.from(connections.values());
-    const index = Math.floor(Math.random() * arrayConnections.length);
-    return arrayConnections[index];
-};
-export function setLoadBalancePolicy(policy) {
-    loadBalancePolicy = policy;
-}
-export async function rpc(arg1, action, params, context) {
-    if (!context || !context.traceId) {
-        context = getContext();
-    }
-    let connection = null;
-    if (arg1 instanceof KeepAliveConnection) {
-        connection = arg1;
-    }
-    else if ('string' === typeof arg1) {
-        connection = loadBalancePolicy(arg1);
-    }
-    else
-        throw new Error(`Unknown rpc arg1<${arg1}>`);
-    if (!connection)
-        throw new Error(`Connection<${arg1}> not found`);
-    return connection.adapter.rpc(connection, action, params, context);
-}
 export * from './app.js';
+export * from './config.js';
+export * from './context.js';
 export * from './keepalive-connection.js';
-export { Module };
+export * from './modules/module.js';
+export * as logger from './logger.js';
+export * from './proxy.js';
+import * as registry from './registry.js';
 export { registry };
 // 放在最后导入，避免循环依赖问题
 import * as modules from './modules/index.js';

package/keepalive-connection.js

@@ -1,4 +1,5 @@
 import EventEmitter from 'node:events';
+import { getContext } from './context.js';
 export class KeepAliveConnectionError extends Error {
     connection;
     constructor(message, connection) {
@@ -29,13 +30,13 @@ export class KeepAliveConnection extends EventEmitter {
     set enabled(enabled) {
         if (enabled !== this.#enabled) {
             this.#enabled = enabled;
-            this.emit(enabled ? 'enabled' : 'disabled');
             if (enabled) {
                 enabledKeepAliveConnections.add(this);
             }
             else {
                 enabledKeepAliveConnections.remove(this);
             }
+            this.emit(enabled ? 'enabled' : 'disabled');
         }
     }
     get enabled() {
@@ -104,6 +105,65 @@ export class KeepAliveConnectionStore {
         }
     }
 }
+/**
+ * 添加长连接
+ * @throws {KeepAliveConnectionError} 连接已存在
+ * @param connection
+ */
+export function addKeepAliveConnection(connection) {
+    if (keepAliveConnections.has(connection.data.name, connection.data.id)) {
+        connection.disconnect();
+        throw new KeepAliveConnectionError('Connection already exists', connection);
+    }
+    keepAliveConnections.add(connection);
+}
+export function removeKeepAliveConnection(arg1, arg2) {
+    if (typeof arg1 === 'string') {
+        const connection = keepAliveConnections.get(arg1, arg2);
+        keepAliveConnections.remove(arg1, arg2);
+        enabledKeepAliveConnections.remove(arg1, arg2);
+        if (connection)
+            connection.disconnect();
+    }
+    else {
+        keepAliveConnections.remove(arg1);
+        enabledKeepAliveConnections.remove(arg1);
+        arg1.disconnect();
+    }
+}
+/**
+ * random connection select for default load balance policy
+ * @param name service name
+ * @returns selected connection
+ */
+let loadBalancePolicy = (name) => {
+    const connections = enabledKeepAliveConnections.getConnectionsOfService(name);
+    if (!connections || !connections.size)
+        return null;
+    const arrayConnections = Array.from(connections.values());
+    const index = Math.floor(Math.random() * arrayConnections.length);
+    return arrayConnections[index];
+};
+export function setLoadBalancePolicy(policy) {
+    loadBalancePolicy = policy;
+}
+export async function rpc(arg1, action, params, context) {
+    if (!context || !context.traceId) {
+        context = getContext();
+    }
+    let connection = null;
+    if (arg1 instanceof KeepAliveConnection) {
+        connection = arg1;
+    }
+    else if ('string' === typeof arg1) {
+        connection = loadBalancePolicy(arg1);
+    }
+    else
+        throw new Error(`Unknown rpc arg1<${arg1}>`);
+    if (!connection)
+        throw new Error(`Connection<${arg1}> not found`);
+    return connection.adapter.rpc(connection, action, params, context);
+}
 export const keepAliveConnectionAdapters = new Map();
 export const keepAliveConnections = new KeepAliveConnectionStore();
 export const enabledKeepAliveConnections = new KeepAliveConnectionStore();

package/logger.js

@@ -1,4 +1,5 @@
-import { emit, asyncStore } from './app.js';
+import { emit } from './app.js';
+import { asyncStore } from './context.js';
 export function info(...content) {
     const context = asyncStore.getStore() || null;
     emit('log', Date.now(), context, 'info', content);

package/modules/http/index.js

@@ -3,7 +3,7 @@ import * as https from 'node:https';
 import { parseHTTPBody } from './utils.js';
 import Router from './router.js';
 import * as oox from '../../index.js';
-import Module from '../module.js';
+import { Module } from '../module.js';
 export class HTTPConfig {
     enabled = true;
     // listen port
@@ -72,6 +72,9 @@ export default class HTTPModule extends Module {
     getConfig() {
         return this.config;
     }
+    get serviceURL() {
+        return this.getURL();
+    }
     /**
      * start http service
      */

package/modules/index.js

@@ -1,5 +1,4 @@
 import HTTP from './http/index.js';
-import SocketIO from './socketio/index.js';
 /**
  * FIFO queue for modules starting
  */
@@ -84,7 +83,5 @@ export async function stop() {
  */
 export const builtins = {
     http: new HTTP,
-    socketio: new SocketIO,
 };
 add(builtins.http);
-add(builtins.socketio);

package/modules/module.js

@@ -1,2 +1,2 @@
-export default class Module {
+export class Module {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "oox",
-    "version": "0.3.5",
+    "version": "0.3.7",
     "description": "OOX Service Engine",
     "keywords": [
         "http",
@@ -24,7 +24,10 @@
             "types": "./types/index.d.ts"
         },
         "./loader": "./bin/loader.mjs",
-        "./cli": "./bin/cli.js",
+        "./cli": {
+            "default": "./bin/cli.js",
+            "types": "./types/bin/cli.d.ts"
+        },
         "./samples": {
             "types": "./types/samples/index.d.ts",
             "default": "./samples/index.js"
@@ -37,9 +40,7 @@
     "homepage": "https://gitee.com/lipingruan/oox",
     "license": "MIT",
     "dependencies": {
-        "chalk": "^5.6.2",
-        "socket.io": "^4.8.3",
-        "socket.io-client": "^4.8.3"
+        "chalk": "^5.6.2"
     },
     "engines": {
         "node": ">=18.0.0"

package/proxy.js

@@ -0,0 +1,30 @@
+import { rpc } from './keepalive-connection.js';
+/**
+ * 为了不重复创建Proxy，这个对象用于保存各个RPC服务的各个属性Proxy
+ */
+const rpcServiceAttrMap = Object.create(null);
+export function proxy(name, action = '') {
+    return new Proxy(function () { }, {
+        get(target, key) {
+            if (typeof key !== 'string')
+                return undefined;
+            const attrKey = action ? action + '.' + key : key;
+            const attrKeyPath = name + '.' + attrKey;
+            if (attrKeyPath in rpcServiceAttrMap) {
+                // 不重复创建Proxy
+                return rpcServiceAttrMap[attrKeyPath];
+            }
+            const attrProxy = proxy(name, attrKey);
+            rpcServiceAttrMap[attrKeyPath] = attrProxy;
+            return attrProxy;
+        },
+        has(target, key) {
+            if (typeof key !== 'string')
+                return false;
+            return true;
+        },
+        apply(target, thisArg, args) {
+            return rpc(name, action, args);
+        }
+    });
+}

package/registry.js

@@ -1,4 +1,4 @@
-import { config } from './index.js';
+import { config } from './config.js';
 import { enabledKeepAliveConnections, keepAliveConnectionAdapters, keepAliveConnections } from './keepalive-connection.js';
 const unsubscribeListeners = new Map();
 const subscribes = new Map();

package/samples/index.js

@@ -1 +1 @@
-export { SampleKeepAliveConnectionAdapter } from './keepalive-connection-sample.js';
+export * from './keepalive-connection-sample.js';