oox 0.3.6 → 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/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

@@ -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/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/http/index.js

@@ -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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "oox",
-    "version": "0.3.6",
+    "version": "0.3.7",
     "description": "OOX Service Engine",
     "keywords": [
         "http",
@@ -40,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/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/http/index.d.ts

@@ -27,6 +27,7 @@ export default class HTTPModule extends Module {
     use(middleware: Middleware): this;
     setConfig(config: HTTPConfig): void;
     getConfig(): HTTPConfig;
+    get serviceURL(): URL;
     /**
      * start http service
      */

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';
 /**
  * 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/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/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;