oox 0.3.6 → 0.3.8

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/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/starter.js

@@ -56,14 +56,17 @@ export async function startup() {
     await loadEntry(config.name, config.entryInfo.path);
     // 服务启动
     await oox.serve();
+    // 服务启动完成
     oox.emit('app:served');
-    const { http, socketio } = 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/keepalive-connection.js

@@ -30,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() {
@@ -120,15 +120,15 @@ export function addKeepAliveConnection(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);
+        if (connection)
+            connection.disconnect();
     }
     else {
-        arg1.disconnect();
         keepAliveConnections.remove(arg1);
         enabledKeepAliveConnections.remove(arg1);
+        arg1.disconnect();
     }
 }
 /**

package/modules/index.js

@@ -1,5 +1,4 @@
-import HTTP from './http/index.js';
-import SocketIO from './socketio/index.js';
+import HTTP from '@oox/http';
 /**
  * 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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "oox",
-    "version": "0.3.6",
+    "version": "0.3.8",
     "description": "OOX Service Engine",
     "keywords": [
         "http",
@@ -40,9 +40,8 @@
     "homepage": "https://gitee.com/lipingruan/oox",
     "license": "MIT",
     "dependencies": {
-        "chalk": "^5.6.2",
-        "socket.io": "^4.8.3",
-        "socket.io-client": "^4.8.3"
+        "@oox/http": "^1.0.0",
+        "chalk": "^5.6.2"
     },
     "engines": {
         "node": ">=18.0.0"

package/samples/keepalive-connection-sample.js

@@ -47,16 +47,16 @@ export class SampleKeepAliveConnectionAdapter {
             connection.enabled = false;
         });
         socket.on(this.OOXEvent.DISCONNECT, () => {
-            removeKeepAliveConnection(connection);
             socket.removeAllListeners();
+            removeKeepAliveConnection(connection);
             connection.emit('disconnect');
         });
         socket.on(this.OOXEvent.CONNECT, () => {
             connection.emit('connect');
         });
         socket.on(this.OOXEvent.ERROR, (error) => {
-            removeKeepAliveConnection(connection);
             socket.removeAllListeners();
+            removeKeepAliveConnection(connection);
             connection.emit('error', new KeepAliveConnectionError(error.message, connection));
         });
     }
@@ -64,17 +64,24 @@ export class SampleKeepAliveConnectionAdapter {
         const connection = this.newConnection(identify);
         addKeepAliveConnection(connection);
         this.bindConnectionEvents(connection);
-        this.bindCall(connection);
-        await new Promise((resolve, reject) => {
-            connection.once('enabled', resolve);
-            connection.once('error', reject);
-            connection.once('disconnect', () => {
-                reject(new Error('disconnect'));
+        try {
+            await new Promise((resolve, reject) => {
+                connection.once('enabled', resolve);
+                connection.once('error', reject);
+                connection.once('disconnect', () => {
+                    reject(new Error('disconnect'));
+                });
+                if (connection.nativeConnection.connect) {
+                    connection.nativeConnection.connect();
+                }
             });
-            if (connection.nativeConnection.connect) {
-                connection.nativeConnection.connect();
-            }
-        });
+        }
+        catch (error) {
+            connection.removeAllListeners();
+            removeKeepAliveConnection(connection);
+            throw error;
+        }
+        this.bindCall(connection);
         return connection;
     }
     async close(connection) {
@@ -126,6 +133,8 @@ export class SampleKeepAliveConnectionAdapter {
      * @param connection
      */
     bindCall(connection) {
+        if (!connection.enabled)
+            throw new Error('Connection not enabled');
         const { id, name, ip } = connection.data;
         connection.nativeConnection.on(this.OOXEvent.CALL, async (action, params, context, callback) => {
             const validContext = genContext({

package/types/modules/index.d.ts

@@ -1,6 +1,5 @@
 import { Module } from './module.js';
-import HTTP from './http/index.js';
-import SocketIO from './socketio/index.js';
+import HTTP from '@oox/http';
 /**
  * FIFO queue for modules starting
  */
@@ -35,5 +34,4 @@ export declare function stop(): Promise<void>;
  */
 export declare const builtins: {
     http: HTTP;
-    socketio: SocketIO;
 };

package/types/modules/module.d.ts

@@ -4,6 +4,7 @@ export interface ModuleConfig {
 export declare abstract class Module {
     abstract config: ModuleConfig;
     abstract name: string;
+    abstract serviceURL?: URL;
     abstract setConfig(config: any): void;
     abstract getConfig(): ModuleConfig;
     abstract serve(): Promise<void>;

package/modules/http/index.js

@@ -1,275 +0,0 @@
-import * as http from 'node:http';
-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';
-export class HTTPConfig {
-    enabled = true;
-    // listen port
-    port = 0;
-    // service path
-    path = '/';
-    // browser cross origin
-    origin = '';
-    // https options
-    ssl = {
-        // enable https
-        enabled: false,
-        // ssl certificate path
-        cert: '',
-        // ssl private key path
-        key: '',
-        // ssl ca path
-        ca: ''
-    };
-}
-export default class HTTPModule extends Module {
-    name = 'http';
-    config = new HTTPConfig;
-    server = null;
-    router = new Router();
-    getURL() {
-        const { host } = oox.config;
-        const { port, path } = this.config;
-        const protocol = this.config.ssl.enabled ? `https:` : `http:`;
-        return new URL(`${protocol}//${host}:${port}${path}`);
-    }
-    // 注册GET路由
-    get(path, ...args) {
-        this.router.get(path, ...args);
-        return this;
-    }
-    // 注册POST路由
-    post(path, ...args) {
-        this.router.post(path, ...args);
-        return this;
-    }
-    // 注册PUT路由
-    put(path, ...args) {
-        this.router.put(path, ...args);
-        return this;
-    }
-    // 注册DELETE路由
-    delete(path, ...args) {
-        this.router.delete(path, ...args);
-        return this;
-    }
-    // 注册全局中间件
-    use(middleware) {
-        this.router.use(middleware);
-        return this;
-    }
-    setConfig(config) {
-        Object.assign(this.config, config);
-        if (!config.hasOwnProperty('port')) {
-            this.config.port = oox.config.port;
-        }
-        if (!config.hasOwnProperty('origin')) {
-            this.config.origin = oox.config.origin;
-        }
-    }
-    getConfig() {
-        return this.config;
-    }
-    /**
-     * start http service
-     */
-    async serve() {
-        await this.stop();
-        const { port, ssl } = this.config;
-        if (ssl.enabled) {
-            const fs = await import('node:fs');
-            const options = {
-                key: ssl.key ? fs.readFileSync(ssl.key) : undefined,
-                cert: ssl.cert ? fs.readFileSync(ssl.cert) : undefined,
-                ca: ssl.ca ? fs.readFileSync(ssl.ca) : undefined
-            };
-            if (!options.key || !options.cert) {
-                throw new Error('HTTPS enabled but missing key or cert');
-            }
-            this.server = https.createServer(options, this.requestHandler.bind(this));
-        }
-        else {
-            this.server = http.createServer(this.requestHandler.bind(this));
-        }
-        this.server.listen(port);
-        const address = this.server.address();
-        if (!address || 'object' !== typeof address)
-            throw new Error('Cannot read http server port');
-        this.config.port = address.port;
-    }
-    /**
-     * stop http service
-     */
-    async stop() {
-        const { server } = this;
-        if (!server || !server.listening)
-            return Promise.resolve();
-        return new Promise((resolve, reject) => {
-            server.close(function (error) {
-                if (error)
-                    reject(error);
-                else
-                    resolve();
-            });
-        });
-    }
-    /**
-     * browser cross origin
-     */
-    cors(request, response) {
-        // origin checking
-        const origin = this.config.origin;
-        const requestOrigin = request.headers.origin;
-        if (origin && requestOrigin) {
-            let allow = false;
-            if ('string' === typeof origin) {
-                allow = origin === '*' || new RegExp(origin).test(requestOrigin);
-            }
-            else if (Array.isArray(origin)) {
-                allow = origin.some(item => item === '*' || new RegExp(item).test(requestOrigin));
-            }
-            if (allow) {
-                response.setHeader('Access-Control-Allow-Origin', requestOrigin);
-                response.setHeader('Vary', 'Origin');
-            }
-            else {
-                response.statusCode = 403;
-                response.end();
-                return false;
-            }
-            response.setHeader('Access-Control-Max-Age', 3600);
-            response.setHeader('Access-Control-Allow-Headers', 'x-caller,x-token,content-type');
-            response.setHeader('Access-Control-Allow-Methods', '*');
-        }
-        if (request.method === 'OPTIONS') {
-            response.statusCode = 204;
-            response.end();
-            return false;
-        }
-        return true;
-    }
-    async requestHandler(request, response) {
-        const url = new URL(request.url || '', `http://${request.headers.host || 'localhost'}`);
-        const method = request.method || 'GET';
-        // 尝试匹配路由
-        const matched = this.router.match(method, url.pathname);
-        if (matched) {
-            const req = this.router.createRequestObject(request, url);
-            const res = this.router.createResponseObject(response);
-            // 解析请求体
-            if (request.method !== 'GET' && request.method !== 'HEAD') {
-                try {
-                    req.body = await parseHTTPBody(request);
-                }
-                catch (error) {
-                    return this.respond(request, response, {
-                        success: false,
-                        error: {
-                            message: error.message,
-                            stack: error.stack
-                        }
-                    });
-                }
-            }
-            await this.router.handleRoute(matched.route, matched.params, req, res);
-            return;
-        }
-        // 内置cors仅处理RPC请求
-        if (!this.cors(request, response))
-            return;
-        // 回退到RPC调用
-        if (url.pathname === this.config.path) {
-            await this.call(request, response);
-        }
-        else {
-            const error = new Error('Invalid URL');
-            return this.respond(request, response, {
-                success: false,
-                error: {
-                    message: error.message,
-                    stack: error.stack
-                }
-            });
-        }
-    }
-    /**
-     * 从请求里获取调用的接口和参数
-     */
-    async getCallArgsFromRequest(request) {
-        const args = await parseHTTPBody(request);
-        if (!args || 'object' !== typeof args || !args.action)
-            throw new Error('Content Invalid');
-        else
-            return args;
-    }
-    /**
-     * HTTP-RPC服务器请求监听方法
-     */
-    async call(request, response) {
-        // global unique id
-        const traceId = String(request.headers['x-trace-id'] || '');
-        // service name, required
-        const caller = String(request.headers['x-caller'] || 'anonymous');
-        // client ip or caller service ip
-        const ip = String(request.headers['x-real-ip'] || request.socket.remoteAddress || '');
-        // startup client ip
-        const sourceIP = String(request.headers['x-source-ip'] || request.socket.remoteAddress || '');
-        // check token
-        const token = String(request.headers['x-token'] || '');
-        const { allow, reason } = oox.checkAllow(ip, caller, token);
-        if (!allow)
-            return this.respond(request, response, {
-                success: false,
-                error: {
-                    message: reason
-                }
-            });
-        let callArgs = Object.create(null);
-        try {
-            callArgs = await this.getCallArgsFromRequest(request);
-        }
-        catch (error) {
-            return this.respond(request, response, {
-                success: false,
-                error: {
-                    message: error.message,
-                    stack: error.stack
-                }
-            });
-        }
-        const { action, params = [] } = callArgs;
-        const context = oox.genContext({ traceId, caller, sourceIP, ip, callerId: '' });
-        const format = await oox.call(action, params, context);
-        this.respond(request, response, format);
-    }
-    /**
-     * HTTP Response Catch
-     */
-    respond(_request, response, returns) {
-        let returnsString = '';
-        if (!oox.config.errorStack && returns.error) {
-            // 不返回错误调用栈信息
-            delete returns.error.stack;
-        }
-        try {
-            returnsString = JSON.stringify(returns);
-        }
-        catch (error) {
-            delete returns.body;
-            returns.success = false;
-            returns.error = {
-                message: error.message
-            };
-            if (oox.config.errorStack) {
-                // 返回错误调用栈信息
-                returns.error.stack = error.stack;
-            }
-            returnsString = JSON.stringify(returns);
-        }
-        response.setHeader('Content-Type', 'application/json');
-        response.setHeader('Content-Length', Buffer.byteLength(returnsString));
-        response.end(returnsString);
-    }
-}

package/modules/http/router.js

@@ -1,210 +0,0 @@
-export default class Router {
-    routes = new Map();
-    globalMiddleware = [];
-    // 注册GET路由
-    get(path, ...args) {
-        const { handler, middleware } = this.parseRouteArgs(args);
-        this.addRoute('GET', path, handler, middleware);
-    }
-    // 注册POST路由
-    post(path, ...args) {
-        const { handler, middleware } = this.parseRouteArgs(args);
-        this.addRoute('POST', path, handler, middleware);
-    }
-    // 注册PUT路由
-    put(path, ...args) {
-        const { handler, middleware } = this.parseRouteArgs(args);
-        this.addRoute('PUT', path, handler, middleware);
-    }
-    // 注册DELETE路由
-    delete(path, ...args) {
-        const { handler, middleware } = this.parseRouteArgs(args);
-        this.addRoute('DELETE', path, handler, middleware);
-    }
-    // 解析路由参数，支持多种传入方式
-    parseRouteArgs(args) {
-        let handler;
-        let middleware = [];
-        if (args.length === 0) {
-            throw new Error('No handler provided for route');
-        }
-        // 方式1: [handler] 或 [middlewareArray, handler]
-        if (args.length === 1) {
-            if (typeof args[0] === 'function') {
-                handler = args[0];
-            }
-            else {
-                throw new Error('Invalid route handler');
-            }
-        }
-        // 方式2: [handler, middlewareArray] 或 [middleware1, middleware2, handler] 或 [middlewareArray, handler]
-        else {
-            // 检查最后一个参数是否是函数（处理器）
-            if (typeof args[args.length - 1] === 'function') {
-                handler = args[args.length - 1];
-                // 前面的所有都是中间件
-                const middleArgs = args.slice(0, -1);
-                // 展平中间件数组
-                for (const arg of middleArgs) {
-                    if (Array.isArray(arg)) {
-                        middleware.push(...arg);
-                    }
-                    else if (typeof arg === 'function') {
-                        middleware.push(arg);
-                    }
-                }
-            }
-            // 检查第一个参数是否是函数
-            else if (typeof args[0] === 'function') {
-                handler = args[0];
-                // 后面的是中间件
-                const middleArgs = args.slice(1);
-                for (const arg of middleArgs) {
-                    if (Array.isArray(arg)) {
-                        middleware.push(...arg);
-                    }
-                    else if (typeof arg === 'function') {
-                        middleware.push(arg);
-                    }
-                }
-            }
-            else {
-                throw new Error('Invalid route arguments');
-            }
-        }
-        return { handler, middleware };
-    }
-    // 注册全局中间件
-    use(middleware) {
-        this.globalMiddleware.push(middleware);
-    }
-    // 注册特定路径的中间件
-    usePath(path, middleware) {
-        // 实现路径级中间件
-    }
-    // 添加路由
-    addRoute(method, path, handler, middleware = []) {
-        // 编译路径为正则表达式，支持路径参数
-        const { regex, paramNames } = this.compilePath(path);
-        let routes = [];
-        if (this.routes.has(method)) {
-            routes = this.routes.get(method) || [];
-        }
-        else {
-            routes = [];
-            this.routes.set(method, routes);
-        }
-        routes.push({
-            path,
-            method,
-            handler,
-            middleware,
-            regex,
-            paramNames
-        });
-    }
-    // 编译路径为正则表达式
-    compilePath(path) {
-        const paramNames = [];
-        const regexPattern = path
-            .replace(/:([^/]+)/g, (_, paramName) => {
-            paramNames.push(paramName);
-            return '([^/]+)';
-        })
-            .replace(/\//g, '\\/')
-            .replace(/\*/g, '.*');
-        return {
-            regex: new RegExp(`^${regexPattern}$`),
-            paramNames
-        };
-    }
-    // 匹配路由
-    match(method, path) {
-        const routes = this.routes.get(method) || [];
-        for (const route of routes) {
-            const match = path.match(route.regex);
-            if (match) {
-                const params = {};
-                route.paramNames.forEach((paramName, index) => {
-                    params[paramName] = match[index + 1];
-                });
-                return { route, params };
-            }
-        }
-        return null;
-    }
-    // 创建请求对象
-    createRequestObject(originalRequest, url) {
-        return {
-            originalRequest,
-            url,
-            method: originalRequest.method || 'GET',
-            path: url.pathname,
-            query: Object.fromEntries(url.searchParams),
-            params: {},
-            headers: originalRequest.headers,
-            body: null
-        };
-    }
-    // 创建响应对象
-    createResponseObject(originalResponse) {
-        let statusCode = 200;
-        return {
-            originalResponse,
-            status(code) {
-                statusCode = code;
-                return this;
-            },
-            json(data) {
-                const jsonString = JSON.stringify(data);
-                this.originalResponse.statusCode = statusCode;
-                this.originalResponse.setHeader('Content-Type', 'application/json');
-                this.originalResponse.setHeader('Content-Length', Buffer.byteLength(jsonString));
-                this.originalResponse.end(jsonString);
-            },
-            send(data) {
-                const dataString = typeof data === 'string' ? data : JSON.stringify(data);
-                this.originalResponse.statusCode = statusCode;
-                this.originalResponse.setHeader('Content-Type', 'text/plain');
-                this.originalResponse.setHeader('Content-Length', Buffer.byteLength(dataString));
-                this.originalResponse.end(dataString);
-            },
-            end(data) {
-                this.originalResponse.statusCode = statusCode;
-                this.originalResponse.end(data);
-            }
-        };
-    }
-    // 执行中间件
-    async executeMiddleware(middleware, req, res) {
-        for (const fn of middleware) {
-            let nextCalled = false;
-            const next = () => { nextCalled = true; };
-            const result = fn(req, res, next);
-            if (result instanceof Promise) {
-                await result;
-            }
-            if (!nextCalled) {
-                return false; // 中间件已结束响应
-            }
-        }
-        return true; // 所有中间件都已执行
-    }
-    // 处理路由请求
-    async handleRoute(route, params, req, res) {
-        req.params = params;
-        // 执行全局中间件
-        const globalMiddlewareContinue = await this.executeMiddleware(this.globalMiddleware, req, res);
-        if (!globalMiddlewareContinue)
-            return;
-        // 执行路由中间件
-        const routeMiddlewareContinue = await this.executeMiddleware(route.middleware, req, res);
-        if (!routeMiddlewareContinue)
-            return;
-        // 执行路由处理函数
-        const result = route.handler(req, res);
-        if (result instanceof Promise) {
-            await result;
-        }
-    }
-}

package/modules/http/utils.js

@@ -1,75 +0,0 @@
-import * as http from 'node:http';
-import * as https from 'node:https';
-/**
- * Stream => Buffer
- */
-export function stream2buffer(stream, totalLength = 0) {
-    return new Promise(function (resolve, reject) {
-        let buffers = [];
-        stream.on('error', reject);
-        if (totalLength) {
-            stream.on('data', function (data) { buffers.push(data); });
-        }
-        else {
-            stream.on('data', function (data) {
-                buffers.push(data);
-                totalLength += data.length;
-            });
-        }
-        stream.on('end', function () { resolve(Buffer.concat(buffers, totalLength)); });
-    });
-}
-/**
- * Request => JSONObject
- */
-export async function parseHTTPBody(request) {
-    if (request.method === 'GET')
-        return null;
-    let contentType = request.headers['content-type'];
-    // application/json; charset=utf-8
-    if (contentType)
-        contentType = contentType.split(';')[0].trim();
-    const contentLength = request.headers['content-length'];
-    if (!contentLength || contentLength === '0')
-        return null;
-    const contentSize = +contentLength;
-    const buffer = await stream2buffer(request, contentSize);
-    if (buffer.length !== contentSize)
-        throw new Error('Content-Length Incorrect');
-    switch (contentType) {
-        case 'application/json':
-            return JSON.parse(buffer.toString());
-        case 'text/plain':
-            return buffer.toString();
-        default:
-            return buffer;
-    }
-}
-/**
- * http request
- */
-export function httpRequest(url, options, body) {
-    return new Promise(function (resolve, reject) {
-        const urlObj = typeof url === 'string' ? new URL(url) : url;
-        const protocol = urlObj.protocol;
-        const client = protocol === 'https:' ? https : http;
-        const request = client.request(url, options, async function (response) {
-            try {
-                const result = await parseHTTPBody(response);
-                resolve(result);
-            }
-            catch (error) {
-                const decoration = new Error(`${response.statusCode} - ${error.message}`);
-                reject(decoration);
-            }
-        });
-        request.on('error', reject);
-        if (body) {
-            request.method = 'POST';
-            request.setHeader('Content-Type', 'application/json');
-            request.setHeader('Content-Length', Buffer.byteLength(body));
-            request.write(body);
-        }
-        request.end();
-    });
-}

package/modules/socketio/adapter.js

@@ -1,48 +0,0 @@
-import * as SocketIOClient from 'socket.io-client';
-import * as oox from '../../index.js';
-import { OOXEvent, genWebSocketURL } from './utils.js';
-import { randomUUID } from 'node:crypto';
-import { SampleKeepAliveConnectionAdapter } from '../../samples/index.js';
-export default class SocketIOAdapter extends SampleKeepAliveConnectionAdapter {
-    name = 'socketio';
-    OOXEvent = OOXEvent;
-    newConnection(identify) {
-        const { id, name } = oox.config;
-        const headers = {
-            'x-caller': name,
-            'x-caller-id': id,
-        };
-        let mURL;
-        const connectionData = {
-            name: 'anonymous',
-            id: randomUUID(),
-            adapter: this.name,
-            ip: '',
-            token: ''
-        };
-        if ('string' === typeof identify) {
-            mURL = genWebSocketURL(identify);
-        }
-        else if (identify instanceof URL) {
-            mURL = identify;
-        }
-        else if (identify.url) {
-            // KeepAliveConnectionData
-            Object.assign(connectionData, identify);
-            mURL = new URL(identify.url);
-            if (identify.token) {
-                headers['x-token'] = identify.token;
-            }
-        }
-        else {
-            throw new Error('identify must be string, URL, or KeepAliveConnectionData');
-        }
-        const socket = SocketIOClient.io(mURL.origin, {
-            extraHeaders: headers,
-            path: mURL.pathname,
-            autoConnect: false,
-        });
-        const connection = new oox.KeepAliveConnection(this, socket, connectionData);
-        return connection;
-    }
-}

package/modules/socketio/index.js

@@ -1,23 +0,0 @@
-import * as PATH from 'node:path';
-import * as oox from '../../index.js';
-import SocketINServer from './server.js';
-export default class SocketIOModule extends SocketINServer {
-    async serve() {
-        await this.stop();
-        const _http = oox.modules.builtins.http;
-        const httpConfig = _http.getConfig(), config = this.getConfig();
-        let isShareServer = false;
-        // 都没设置端口
-        isShareServer = !httpConfig.port && !config.port;
-        // 都设置相同端口
-        isShareServer ||= httpConfig.port === config.port;
-        // http 模块未被禁用
-        isShareServer &&= httpConfig.enabled;
-        if (isShareServer) {
-            config.path = PATH.posix.join(httpConfig.path, config.path);
-            this.server = _http.server;
-            this.config.ssl = _http.config.ssl;
-        }
-        await super.serve();
-    }
-}

package/modules/socketio/server.js

@@ -1,203 +0,0 @@
-import * as http from 'node:http';
-import * as https from 'node:https';
-import { Server } from 'socket.io';
-import * as oox from '../../index.js';
-import { Module } from '../module.js';
-import SocketIOAdapter from './adapter.js';
-import { OOXEvent } from './utils.js';
-import { randomUUID } from 'node:crypto';
-export class SocketIOConfig {
-    enabled = true;
-    // listen port
-    port = 0;
-    // service path
-    path = '/socket.io';
-    // browser cross origin
-    origin = '';
-    // https options
-    ssl = {
-        // enable https
-        enabled: false,
-        // ssl certificate path
-        cert: '',
-        // ssl private key path
-        key: '',
-        // ssl ca path
-        ca: ''
-    };
-}
-export default class SocketIOServer extends Module {
-    name = 'socketio';
-    config = new SocketIOConfig;
-    /**
-     * means this.server created by myself<SocketIOServer>
-     */
-    #isSelfServer = false;
-    server = null;
-    socketServer = null;
-    adapter = new SocketIOAdapter();
-    constructor() {
-        super();
-        oox.keepAliveConnectionAdapters.set(this.name, this.adapter);
-    }
-    getURL() {
-        const { host } = oox.config;
-        const { port, path } = this.config;
-        const protocol = this.config.ssl.enabled ? 'wss:' : 'ws:';
-        return new URL(`${protocol}//${host}:${port}${path}`);
-    }
-    setConfig(config) {
-        Object.assign(this.config, config);
-        if (!config.hasOwnProperty('port')) {
-            this.config.port = oox.config.port;
-        }
-        if (!config.hasOwnProperty('origin')) {
-            this.config.origin = oox.config.origin;
-        }
-    }
-    getConfig() {
-        return this.config;
-    }
-    async serve() {
-        await this.stop();
-        const { port, ssl } = this.config;
-        const isSelfServer = this.#isSelfServer = this.server ? true : false;
-        let server = null;
-        if (isSelfServer) {
-            if (!this.server)
-                throw new Error('HTTP Server is not created');
-            server = this.server;
-        }
-        else {
-            if (ssl.enabled) {
-                const fs = await import('node:fs');
-                const options = {
-                    key: ssl.key ? fs.readFileSync(ssl.key) : undefined,
-                    cert: ssl.cert ? fs.readFileSync(ssl.cert) : undefined,
-                    ca: ssl.ca ? fs.readFileSync(ssl.ca) : undefined
-                };
-                if (!options.key || !options.cert) {
-                    throw new Error('HTTPS enabled but missing key or cert');
-                }
-                server = https.createServer(options, (_request, response) => response.end('No HTTP Gateway'));
-            }
-            else {
-                server = http.createServer((_request, response) => response.end('No HTTP Gateway'));
-            }
-        }
-        this.server = server;
-        if (!server.listening)
-            server.listen(port);
-        const address = server.address();
-        if (!address || 'object' !== typeof address)
-            throw new Error('Cannot read socket.io server port');
-        this.config.port = address.port;
-        this.createSocketIOServer();
-    }
-    async stop() {
-        const { server, socketServer } = this;
-        if (socketServer)
-            await new Promise((resolve, reject) => socketServer.close(error => error ? reject(error) : resolve()));
-        if (this.#isSelfServer)
-            await new Promise((resolve, reject) => server?.close(error => error ? reject(error) : resolve()));
-    }
-    genSocketIOServerOptions() {
-        const options = {
-            /**
-             * name of the path to capture
-             * @default "/socket.io"
-             */
-            path: this.config.path,
-            /**
-             * how many ms before a client without namespace is closed
-             * @default 45000
-             */
-            connectTimeout: 5000,
-            /**
-             * how many ms without a pong packet to consider the connection closed
-             * @default 5000
-             */
-            pingTimeout: 2000,
-            /**
-             * how many ms before sending a new ping packet
-             * @default 25000
-             */
-            pingInterval: 10000,
-            /**
-             * how many bytes or characters a message can be, before closing the session (to avoid DoS).
-             * @default 1e5 (100 KB)
-             */
-            maxHttpBufferSize: 1e5
-        };
-        const { origin } = this.config;
-        if (origin)
-            options.cors = { origin };
-        return options;
-    }
-    createSocketIOServer() {
-        const { server } = this;
-        if (!server)
-            throw new Error('HTTP Server is not created');
-        const socketServer = this.socketServer = new Server(server, {
-            ...this.genSocketIOServerOptions(),
-        });
-        socketServer.on('connection', async (socket) => {
-            try {
-                this.serverOnSocketConnection(socket);
-            }
-            catch (error) {
-                console.error(error);
-                socket.send(error.message).disconnect(true);
-            }
-        });
-    }
-    /**
-     * 服务端Socket连接事件
-     */
-    serverOnSocketConnection(socket) {
-        const headers = socket.handshake.headers;
-        const callerId = String(headers['x-caller-id'] || randomUUID());
-        // client ip or caller service ip
-        const ip = String(headers['x-real-ip'] || socket.handshake.address);
-        // service name
-        const caller = String(headers['x-caller'] || 'anonymous');
-        const token = String(headers['x-token'] || '');
-        // check token
-        const { allow, reason } = oox.checkAllow(ip, caller, token);
-        if (!allow) {
-            socket.send(reason).disconnect(true);
-            return;
-        }
-        const connection = new oox.KeepAliveConnection(this.adapter, socket, {
-            ip,
-            name: caller,
-            id: callerId,
-            token,
-        });
-        oox.addKeepAliveConnection(connection);
-        this.bindServerConnectionEvents(connection);
-        this.adapter.bindCall(connection);
-        socket.emit(OOXEvent.READY, {
-            id: oox.config.id,
-            name: oox.config.name
-        });
-        connection.enabled = true;
-    }
-    /**
-     * 绑定服务器连接事件
-     * @param connection
-     */
-    bindServerConnectionEvents(connection) {
-        const socket = connection.nativeConnection;
-        socket.on(OOXEvent.REGISTRY_SYNC_CONNECTIONS, async (fn) => {
-            if ('function' !== typeof fn)
-                return;
-            oox.registry.onSyncConnections(connection, {}, fn);
-        });
-        socket.on('disconnecting', (reason) => {
-            oox.removeKeepAliveConnection(connection);
-            socket.removeAllListeners();
-            connection.emit('disconnect');
-        });
-    }
-}

package/modules/socketio/socket.js

@@ -1 +0,0 @@
-export {};

package/modules/socketio/utils.js

@@ -1,44 +0,0 @@
-export const OOXEvent = {
-    CONNECT: 'connect',
-    DISCONNECT: 'disconnect',
-    ERROR: 'error',
-    CALL: 'call',
-    READY: 'oox:ready',
-    ENABLED: 'oox:enabled',
-    DISABLED: 'oox:disabled',
-    REGISTRY_SYNC_CONNECTIONS: 'oox:registry:sync_connections',
-    REGISTRY_SUBSCRIBE: 'oox:registry:subscribe',
-    REGISTRY_NOTIFY: 'oox:registry:notify',
-};
-export function isWebSocketURL(url) {
-    if ('string' === typeof url) {
-        return /^wss?:\/\/.+$/.test(url);
-    }
-    else {
-        return url.protocol === 'ws:' || url.protocol === 'wss:';
-    }
-}
-export function genWebSocketURL(url) {
-    // :6000
-    if (url.startsWith(':'))
-        url = 'ws://localhost' + url;
-    // 127.0.0.1:6000
-    if (!/^\w+?:\/.+$/.test(url))
-        url = 'ws://' + url;
-    const urlObject = new URL(url);
-    // :8000 => :8000/socket.io
-    const notSetPath = !urlObject.pathname || (urlObject.pathname === '/'
-        && !url.endsWith('/')
-        && !urlObject.search
-        && !urlObject.hash);
-    if (notSetPath) {
-        urlObject.pathname = '/socket.io';
-    }
-    if (urlObject.protocol !== 'wss:') {
-        if (urlObject.port === '443')
-            urlObject.protocol = 'wss:';
-        else
-            urlObject.protocol = 'ws:';
-    }
-    return urlObject;
-}

package/types/modules/http/index.d.ts

@@ -1,62 +0,0 @@
-import * as http from 'node:http';
-import * as https from 'node:https';
-import Router, { Middleware } from './router.js';
-import { Module, ModuleConfig } from '../module.js';
-export declare class HTTPConfig implements ModuleConfig {
-    enabled: boolean;
-    port: number;
-    path: string;
-    origin: string | string[];
-    ssl: {
-        enabled: boolean;
-        cert: string;
-        key: string;
-        ca: string;
-    };
-}
-export default class HTTPModule extends Module {
-    name: string;
-    config: HTTPConfig;
-    server: http.Server | https.Server | null;
-    router: Router;
-    getURL(): URL;
-    get(path: string, ...args: any[]): this;
-    post(path: string, ...args: any[]): this;
-    put(path: string, ...args: any[]): this;
-    delete(path: string, ...args: any[]): this;
-    use(middleware: Middleware): this;
-    setConfig(config: HTTPConfig): void;
-    getConfig(): HTTPConfig;
-    /**
-     * start http service
-     */
-    serve(): Promise<void>;
-    /**
-     * stop http service
-     */
-    stop(): Promise<void>;
-    /**
-     * browser cross origin
-     */
-    cors(request: http.IncomingMessage, response: http.ServerResponse): boolean;
-    requestHandler(request: http.IncomingMessage, response: http.ServerResponse): Promise<void>;
-    /**
-     * 从请求里获取调用的接口和参数
-     */
-    getCallArgsFromRequest(request: http.IncomingMessage): Promise<any>;
-    /**
-     * HTTP-RPC服务器请求监听方法
-     */
-    call(request: http.IncomingMessage, response: http.ServerResponse): Promise<void>;
-    /**
-     * HTTP Response Catch
-     */
-    respond(_request: http.IncomingMessage, response: http.ServerResponse, returns: {
-        body?: any;
-        success: boolean;
-        error?: {
-            message: any;
-            stack?: any;
-        };
-    }): void;
-}

package/types/modules/http/router.d.ts

@@ -1,49 +0,0 @@
-import * as http from 'node:http';
-export type RouteHandler = (req: Request, res: Response) => Promise<any> | any;
-export type Middleware = (req: Request, res: Response, next: () => void) => Promise<any> | any;
-export interface Route {
-    path: string;
-    method: string;
-    handler: RouteHandler;
-    middleware: Middleware[];
-    regex: RegExp;
-    paramNames: string[];
-}
-export interface Request {
-    originalRequest: http.IncomingMessage;
-    url: URL;
-    method: string;
-    path: string;
-    query: Record<string, string>;
-    params: Record<string, string>;
-    headers: Record<string, string>;
-    body: any;
-}
-export interface Response {
-    originalResponse: http.ServerResponse;
-    status(code: number): Response;
-    json(data: any): void;
-    send(data: any): void;
-    end(data?: any): void;
-}
-export default class Router {
-    private routes;
-    private globalMiddleware;
-    get(path: string, ...args: any[]): void;
-    post(path: string, ...args: any[]): void;
-    put(path: string, ...args: any[]): void;
-    delete(path: string, ...args: any[]): void;
-    private parseRouteArgs;
-    use(middleware: Middleware): void;
-    usePath(path: string, middleware: Middleware): void;
-    private addRoute;
-    private compilePath;
-    match(method: string, path: string): {
-        route: Route;
-        params: Record<string, string>;
-    } | null;
-    createRequestObject(originalRequest: http.IncomingMessage, url: URL): Request;
-    createResponseObject(originalResponse: http.ServerResponse): Response;
-    private executeMiddleware;
-    handleRoute(route: Route, params: Record<string, string>, req: Request, res: Response): Promise<void>;
-}

package/types/modules/http/utils.d.ts

@@ -1,14 +0,0 @@
-import * as http from 'node:http';
-import { Readable } from 'node:stream';
-/**
- * Stream => Buffer
- */
-export declare function stream2buffer(stream: Readable, totalLength?: number): Promise<Buffer>;
-/**
- * Request => JSONObject
- */
-export declare function parseHTTPBody(request: http.IncomingMessage): Promise<any>;
-/**
- * http request
- */
-export declare function httpRequest(url: URL | string, options: http.RequestOptions, body: string): Promise<any>;

package/types/modules/socketio/adapter.d.ts

@@ -1,19 +0,0 @@
-import * as oox from '../../index.js';
-import { Socket } from './socket.js';
-import { SampleKeepAliveConnectionAdapter } from '../../samples/index.js';
-export default class SocketIOAdapter extends SampleKeepAliveConnectionAdapter<Socket> {
-    name: string;
-    OOXEvent: {
-        CONNECT: string;
-        DISCONNECT: string;
-        ERROR: string;
-        CALL: string;
-        READY: string;
-        ENABLED: string;
-        DISABLED: string;
-        REGISTRY_SYNC_CONNECTIONS: string;
-        REGISTRY_SUBSCRIBE: string;
-        REGISTRY_NOTIFY: string;
-    };
-    newConnection(identify: string | URL | oox.KeepAliveConnectionData): oox.KeepAliveConnection<Socket>;
-}

package/types/modules/socketio/index.d.ts

@@ -1,4 +0,0 @@
-import SocketINServer from './server.js';
-export default class SocketIOModule extends SocketINServer {
-    serve(): Promise<void>;
-}

package/types/modules/socketio/server.d.ts

@@ -1,44 +0,0 @@
-import * as http from 'node:http';
-import * as https from 'node:https';
-import { Server, ServerOptions } from 'socket.io';
-import * as oox from '../../index.js';
-import { Module, ModuleConfig } from '../module.js';
-import { Socket } from './socket.js';
-import SocketIOAdapter from './adapter.js';
-export declare class SocketIOConfig implements ModuleConfig {
-    enabled: boolean;
-    port: number;
-    path: string;
-    origin: string | string[];
-    ssl: {
-        enabled: boolean;
-        cert: string;
-        key: string;
-        ca: string;
-    };
-}
-export default class SocketIOServer extends Module {
-    #private;
-    name: string;
-    config: SocketIOConfig;
-    server: http.Server | https.Server | null;
-    socketServer: Server | null;
-    adapter: SocketIOAdapter;
-    constructor();
-    getURL(): URL;
-    setConfig(config: SocketIOConfig): void;
-    getConfig(): SocketIOConfig;
-    serve(): Promise<void>;
-    stop(): Promise<void>;
-    genSocketIOServerOptions(): Partial<ServerOptions>;
-    createSocketIOServer(): void;
-    /**
-     * 服务端Socket连接事件
-     */
-    serverOnSocketConnection(socket: Socket<'server'>): void;
-    /**
-     * 绑定服务器连接事件
-     * @param connection
-     */
-    bindServerConnectionEvents(connection: oox.KeepAliveConnection<Socket<'server'>>): void;
-}

package/types/modules/socketio/socket.d.ts

@@ -1,8 +0,0 @@
-import { Socket as ServerSocket } from 'socket.io';
-import { Socket as ClientSocket } from 'socket.io-client';
-export type SocketMap = {
-    [key: string]: ServerSocket | ClientSocket;
-    server: ServerSocket;
-    client: ClientSocket;
-};
-export type Socket<T extends keyof SocketMap = keyof SocketMap> = SocketMap[T];

package/types/modules/socketio/utils.d.ts

@@ -1,14 +0,0 @@
-export declare const OOXEvent: {
-    CONNECT: string;
-    DISCONNECT: string;
-    ERROR: string;
-    CALL: string;
-    READY: string;
-    ENABLED: string;
-    DISABLED: string;
-    REGISTRY_SYNC_CONNECTIONS: string;
-    REGISTRY_SUBSCRIBE: string;
-    REGISTRY_NOTIFY: string;
-};
-export declare function isWebSocketURL(url: string | URL): boolean;
-export declare function genWebSocketURL(url: string): URL;