oox 0.3.3 → 0.3.5

package/modules/socketio/server.js

@@ -2,10 +2,11 @@ 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, ModuleConfig } from '../../index.js';
+import { Module } from '../../index.js';
 import SocketIOAdapter from './adapter.js';
-import { isWebSocketURL, OOXEvent } from './utils.js';
-export class SocketIOConfig extends ModuleConfig {
+import { OOXEvent } from './utils.js';
+export class SocketIOConfig {
+    enabled = true;
     // listen port
     port = 0;
     // service path
@@ -34,6 +35,10 @@ export default class SocketIOServer extends Module {
     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;
@@ -53,21 +58,22 @@ export default class SocketIOServer extends Module {
         return this.config;
     }
     async serve() {
-        oox.rpcKeepAliveConnectionAdapters.set(this.name, this.adapter);
         await this.stop();
         const { port, ssl } = this.config;
         const isSelfServer = this.#isSelfServer = this.server ? true : false;
-        let server;
+        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) : null,
-                    cert: ssl.cert ? fs.readFileSync(ssl.cert) : null,
-                    ca: ssl.ca ? fs.readFileSync(ssl.ca) : null
+                    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');
@@ -88,10 +94,11 @@ export default class SocketIOServer extends Module {
         this.createSocketIOServer();
     }
     async stop() {
-        if (this.socketServer)
-            await new Promise((resolve, reject) => this.socketServer.close(error => error ? reject(error) : resolve()));
+        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) => this.server.listening && this.server.close(error => error ? reject(error) : resolve()));
+            await new Promise((resolve, reject) => server?.close(error => error ? reject(error) : resolve()));
     }
     genSocketIOServerOptions() {
         const options = {
@@ -127,7 +134,10 @@ export default class SocketIOServer extends Module {
         return options;
     }
     createSocketIOServer() {
-        const socketServer = this.socketServer = new Server(this.server, this.genSocketIOServerOptions());
+        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);
@@ -145,40 +155,30 @@ export default class SocketIOServer extends Module {
         const headers = socket.handshake.headers;
         const callerId = String(headers['x-caller-id'] || '') || socket.id;
         // client ip or caller service ip
-        const ip = String(headers['x-real-ip'] || headers['x-ip'] || socket.handshake.address);
+        const ip = String(headers['x-real-ip'] || socket.handshake.address);
         // service name
         const caller = String(headers['x-caller'] || 'anonymous');
-        const connection = new oox.RPCKeepAliveConnection(this.adapter, socket, {
-            host: ip,
+        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);
-        connection.enabled = true;
-        socket.emit(OOXEvent.CONNECTED, {
+        socket.emit(OOXEvent.READY, {
             id: oox.config.id,
             name: oox.config.name
         });
-    }
-    /**
-    * 服务器发送连接列表
-    * @param connection
-    */
-    [OOXEvent.SYNC_CONNECTIONS](connection) {
-        const socket = connection.nativeConnection;
-        const datas = [];
-        for (const [name, connections] of oox.enabledKeepAliveConnections.entries()) {
-            if (name === connection.data.name)
-                continue;
-            for (const conn of Array.from(connections.values())) {
-                if (!conn.data.url || !isWebSocketURL(conn.data.url))
-                    continue;
-                datas.push(conn.data);
-            }
-        }
-        return datas;
+        connection.enabled = true;
     }
     /**
      * 绑定服务器连接事件
@@ -186,11 +186,10 @@ export default class SocketIOServer extends Module {
      */
     bindServerConnectionEvents(connection) {
         const socket = connection.nativeConnection;
-        socket.on(OOXEvent.SYNC_CONNECTIONS, async (fn) => {
+        socket.on(OOXEvent.REGISTRY_SYNC_CONNECTIONS, async (fn) => {
             if ('function' !== typeof fn)
                 return;
-            const datas = this[OOXEvent.SYNC_CONNECTIONS](connection);
-            fn(datas);
+            oox.registry.onSyncConnections(connection, {}, fn);
         });
         socket.on('disconnecting', (reason) => {
             oox.removeKeepAliveConnection(connection);

package/modules/socketio/utils.js

@@ -1,8 +1,11 @@
 export var OOXEvent;
 (function (OOXEvent) {
-    OOXEvent["CONNECTED"] = "oox:connected";
+    OOXEvent["READY"] = "oox:ready";
+    OOXEvent["ENABLED"] = "oox:enabled";
     OOXEvent["DISABLED"] = "oox:disabled";
-    OOXEvent["SYNC_CONNECTIONS"] = "oox:sync_connections";
+    OOXEvent["REGISTRY_SYNC_CONNECTIONS"] = "oox:registry:sync_connections";
+    OOXEvent["REGISTRY_SUBSCRIBE"] = "oox:registry:subscribe";
+    OOXEvent["REGISTRY_NOTIFY"] = "oox:registry:notify";
 })(OOXEvent || (OOXEvent = {}));
 export function isWebSocketURL(url) {
     if ('string' === typeof url) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "oox",
-    "version": "0.3.3",
+    "version": "0.3.5",
     "description": "OOX Service Engine",
     "keywords": [
         "http",
@@ -10,7 +10,9 @@
         "framework",
         "microservice",
         "distributed",
-        "tracing"
+        "tracing",
+        "service-discovery",
+        "load-balancing"
     ],
     "type": "module",
     "main": "./index.js",
@@ -22,13 +24,17 @@
             "types": "./types/index.d.ts"
         },
         "./loader": "./bin/loader.mjs",
-        "./cli": "./bin/cli.js"
+        "./cli": "./bin/cli.js",
+        "./samples": {
+            "types": "./types/samples/index.d.ts",
+            "default": "./samples/index.js"
+        }
     },
     "bin": {
         "oox": "./bin/cli.js"
     },
     "author": "lipingruan",
-    "homepage": "https://github.com/lipingruan/oox",
+    "homepage": "https://gitee.com/lipingruan/oox",
     "license": "MIT",
     "dependencies": {
         "chalk": "^5.6.2",

package/registry.js

@@ -0,0 +1,145 @@
+import { config } from './index.js';
+import { enabledKeepAliveConnections, keepAliveConnectionAdapters, keepAliveConnections } from './keepalive-connection.js';
+const unsubscribeListeners = new Map();
+const subscribes = new Map();
+let broadcastTimer = null;
+/**
+ * 取消订阅连接列表
+ * @param connection
+ */
+export function unsubscribe(connection) {
+    subscribes.delete(connection);
+}
+/**
+ * 订阅连接列表
+ * @param connection
+ * @param query
+ * @returns
+ */
+export function subscribe(connection, query) {
+    if (!config.isRegistry)
+        return;
+    if (!unsubscribeListeners.has(connection)) {
+        const listener = () => {
+            unsubscribe(connection);
+        };
+        unsubscribeListeners.set(connection, listener);
+        connection.once('disconnect', listener);
+    }
+    subscribes.set(connection, query);
+}
+/**
+ * 停止广播连接列表
+ */
+export function stopBroadcastTimer() {
+    if (!broadcastTimer)
+        return;
+    clearInterval(broadcastTimer);
+    broadcastTimer = null;
+}
+/**
+ * 开始广播连接列表
+ */
+export function startBroadcastTimer() {
+    if (!config.isRegistry)
+        return;
+    if (broadcastTimer)
+        clearInterval(broadcastTimer);
+    broadcastTimer = setInterval(broadcast, 1000);
+}
+/**
+ * 广播连接列表
+ */
+export function broadcast() {
+    if (!config.isRegistry)
+        return;
+    for (const [connection, query] of subscribes.entries()) {
+        try {
+            onSyncConnections(connection, query, returns => {
+                if (!returns.success)
+                    return;
+                connection.adapter['registry:notify'](connection, returns.body || []);
+            });
+        }
+        catch (error) {
+            console.error(error);
+        }
+    }
+}
+/**
+ * 服务器发送连接列表
+ * @param connection
+ * @param query
+ * @param callback
+ */
+export function onSyncConnections(connection, query, callback) {
+    // 检查是否开启服务注册功能
+    if (!config.isRegistry) {
+        const returns = {
+            success: false,
+            error: {
+                message: 'Service registration is not enabled',
+            }
+        };
+        callback(returns);
+        return;
+    }
+    const datas = [];
+    if (query.name) {
+        const names = Array.isArray(query.name) ? query.name : [query.name];
+        for (const [name, connections] of enabledKeepAliveConnections.entries()) {
+            if (names.includes(name))
+                continue;
+            for (const conn of Array.from(connections.values())) {
+                if (!conn.data.url)
+                    continue;
+                datas.push(conn.data);
+            }
+        }
+    }
+    else {
+        for (const [name, connections] of enabledKeepAliveConnections.entries()) {
+            if (name === connection.data.name)
+                continue;
+            for (const conn of Array.from(connections.values())) {
+                if (!conn.data.url)
+                    continue;
+                datas.push(conn.data);
+            }
+        }
+    }
+    const returns = {
+        success: true,
+        body: datas,
+    };
+    callback(returns);
+}
+/**
+ * 同步连接列表
+ * @param datas 连接参数列表
+ */
+export function syncConnections(returns) {
+    if (!returns.success) {
+        if (returns.error) {
+            console.error(new Error(returns.error.message || 'Sync connections failed'));
+        }
+        return;
+    }
+    for (const data of returns.body || []) {
+        // 获取适配器
+        const adapter = keepAliveConnectionAdapters.get(data.adapter);
+        if (!adapter)
+            continue;
+        // 忽略自己
+        if (data.name === config.name)
+            continue;
+        // 忽略无效URL
+        if (!data.url)
+            continue;
+        // 忽略已存在连接
+        if (keepAliveConnections.has(data.name, data.id))
+            continue;
+        // 建立连接
+        adapter.open(data).catch((error) => console.error(error));
+    }
+}

package/samples/index.js

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

package/samples/keepalive-connection-sample.js

@@ -0,0 +1,147 @@
+import * as oox from '../index.js';
+export class SampleKeepAliveConnectionAdapter {
+    OOXEvent = {
+        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',
+    };
+    nativeEvent = {
+        CONNECT: 'connect',
+        DISCONNECT: 'disconnect',
+        ERROR: 'error',
+    };
+    /**
+     * 通知连接列表
+     */
+    ['registry:notify'](connection, datas) {
+        connection.nativeConnection.emit(this.OOXEvent.REGISTRY_NOTIFY, datas);
+    }
+    /**
+     * 订阅连接列表
+     */
+    ['registry:subscribe'](connection, query) {
+        connection.nativeConnection.emit(this.OOXEvent.REGISTRY_SUBSCRIBE, query);
+    }
+    bindConnectionEvents(connection) {
+        const socket = connection.nativeConnection;
+        socket.on(this.OOXEvent.READY, (params) => {
+            connection.ready(params);
+            socket.emit(this.OOXEvent.REGISTRY_SYNC_CONNECTIONS, oox.registry.syncConnections);
+        });
+        socket.on(this.OOXEvent.REGISTRY_NOTIFY, (datas) => {
+            oox.registry.syncConnections({
+                success: true,
+                body: datas,
+            });
+        });
+        socket.on(this.OOXEvent.ENABLED, () => {
+            connection.enabled = true;
+        });
+        socket.on(this.OOXEvent.DISABLED, () => {
+            connection.enabled = false;
+        });
+        socket.on(this.nativeEvent.DISCONNECT, (reason) => {
+            oox.removeKeepAliveConnection(connection);
+            socket.removeAllListeners();
+            connection.emit('disconnect');
+        });
+        socket.on(this.nativeEvent.CONNECT, () => {
+            connection.emit('connect');
+        });
+        socket.on(this.nativeEvent.ERROR, (error) => {
+            oox.removeKeepAliveConnection(connection);
+            socket.removeAllListeners();
+            connection.emit('error', new oox.KeepAliveConnectionError(error.message, connection));
+        });
+    }
+    async open(identify) {
+        const connection = this.newConnection(identify);
+        oox.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'));
+            });
+            if (connection.nativeConnection.connect) {
+                connection.nativeConnection.connect();
+            }
+        });
+        return connection;
+    }
+    async close(connection) {
+        connection.nativeConnection.disconnect();
+        return Promise.resolve();
+    }
+    /**
+     * 发送事件
+     * @param socket
+     * @param event
+     * @param params
+     */
+    async emit(socket, event, params) {
+        if (!socket.connected)
+            throw new Error('Socket not connected');
+        return await new Promise((resolve, reject) => {
+            const onError = (reason) => {
+                const message = 'string' === typeof reason ? reason : reason instanceof Error ? reason.message : 'connect error';
+                reject(new Error(message));
+            };
+            // RPC 执行时中断连接
+            socket.once(this.nativeEvent.DISCONNECT, onError);
+            socket.emit(event, ...params, (returns) => {
+                socket.off(this.nativeEvent.DISCONNECT, onError);
+                resolve(returns);
+            });
+        });
+    }
+    /**
+     * RPC
+     */
+    async rpc(connection, action, params, context) {
+        if (!context)
+            context = oox.getContext();
+        const miniContext = {
+            sourceIP: context.sourceIP,
+            traceId: context.traceId,
+        };
+        const { success, error, body } = await this.emit(connection.nativeConnection, 'call', [action, params, miniContext]);
+        if (success)
+            return body;
+        else if (error)
+            throw new Error(error.message);
+        else
+            throw new Error('[RPC] Unknown Error');
+    }
+    /**
+     * 绑定 call 事件
+     * @param connection
+     */
+    bindCall(connection) {
+        const { id, name, ip } = connection.data;
+        connection.nativeConnection.on('call', async (action, params, context, callback) => {
+            const validContext = new oox.Context({
+                ...context,
+                ip: ip,
+                caller: name,
+                callerId: id,
+                connection
+            });
+            this.call(action, params, validContext, callback);
+        });
+    }
+    async call(action, params, context, callback) {
+        const returns = await oox.call(action, params, context);
+        if (returns.error && !oox.config.errorStack) {
+            // 不返回错误调用栈信息
+            delete returns.error.stack;
+        }
+        'function' === typeof callback && callback(returns);
+        return returns;
+    }
+}

package/types/app.d.ts

@@ -1,20 +1,20 @@
 import { EventEmitter } from 'node:events';
 import { AsyncLocalStorage } from 'node:async_hooks';
 export * as logger from './logger.js';
-export interface ReturnsBody {
-    traceId: string;
+export interface ReturnsBody<T = any> {
+    traceId?: string;
     success: boolean;
-    body?: any;
+    body?: T;
     error?: {
         message: string;
         stack?: string;
     };
 }
-export declare class Context {
+export declare class AppContext {
     [x: string]: any;
-    traceId?: string;
+    traceId?: string | undefined;
 }
-export declare const asyncStore: AsyncLocalStorage<Context>;
+export declare const asyncStore: AsyncLocalStorage<AppContext>;
 export declare const eventHub: EventEmitter<[never]>;
 /**
  * the kvMethods is all actions refs [has bind this]
@@ -24,21 +24,21 @@ export declare const sourceKVMethods: Map<string, Function>;
 export declare function setMethods(methods: any): void;
 export declare function getMethods(): any;
 export declare function on(event: 'app:configured' | 'app:served' | 'app:stopped', listener: () => void): void;
-export declare function on(event: 'call:start', listener: (timestamp: number, action: string, params: any[], context: Context) => void): void;
-export declare function on(event: 'call:success', listener: (timestamp: number, action: string, params: any[], context: Context, result: ReturnsBody) => void): void;
-export declare function on(event: 'call:fail', listener: (timestamp: number, action: string, params: any[], context: Context, error: Error) => void): void;
-export declare function on(event: 'log', listener: (timestamp: number, context: Context | null, level: string, msgs: any[]) => void): void;
+export declare function on(event: 'call:start', listener: (timestamp: number, action: string, params: any[], context: AppContext) => void): void;
+export declare function on(event: 'call:success', listener: (timestamp: number, action: string, params: any[], context: AppContext, result: ReturnsBody) => void): void;
+export declare function on(event: 'call:fail', listener: (timestamp: number, action: string, params: any[], context: AppContext, error: Error) => void): void;
+export declare function on(event: 'log', listener: (timestamp: number, context: AppContext | null, level: string, msgs: any[]) => void): void;
 export declare function once(event: 'app:configured' | 'app:served' | 'app:stopped', listener: (...args: any[]) => void): void;
-export declare function once(event: 'call:start', listener: (timestamp: number, action: string, params: any[], context: Context) => void): void;
-export declare function once(event: 'call:success', listener: (timestamp: number, action: string, params: any[], context: Context, result: ReturnsBody) => void): void;
-export declare function once(event: 'call:fail', listener: (timestamp: number, action: string, params: any[], context: Context, error: Error) => void): void;
-export declare function once(event: 'log', listener: (timestamp: number, context: Context | null, level: string, msgs: any[]) => void): void;
+export declare function once(event: 'call:start', listener: (timestamp: number, action: string, params: any[], context: AppContext) => void): void;
+export declare function once(event: 'call:success', listener: (timestamp: number, action: string, params: any[], context: AppContext, result: ReturnsBody) => void): void;
+export declare function once(event: 'call:fail', listener: (timestamp: number, action: string, params: any[], context: AppContext, error: Error) => void): void;
+export declare function once(event: 'log', listener: (timestamp: number, context: AppContext | null, level: string, msgs: any[]) => void): void;
 export declare function off(event: 'app:configured' | 'app:served' | 'app:stopped' | 'call:start' | 'call:success' | 'call:fail' | 'log', listener: (...args: any[]) => void): void;
 export declare function emit(event: 'app:configured' | 'app:served' | 'app:stopped'): boolean;
-export declare function emit(event: 'call:start', timestamp: number, action: string, params: any[], context: Context): boolean;
-export declare function emit(event: 'call:success', timestamp: number, action: string, params: any[], context: Context, result: ReturnsBody): boolean;
-export declare function emit(event: 'call:fail', timestamp: number, action: string, params: any[], context: Context, error: Error): boolean;
-export declare function emit(event: 'log', timestamp: number, context: Context | null, level: string, content: any): boolean;
+export declare function emit(event: 'call:start', timestamp: number, action: string, params: any[], context: AppContext): boolean;
+export declare function emit(event: 'call:success', timestamp: number, action: string, params: any[], context: AppContext, result: ReturnsBody): boolean;
+export declare function emit(event: 'call:fail', timestamp: number, action: string, params: any[], context: AppContext, error: Error): boolean;
+export declare function emit(event: 'log', timestamp: number, context: AppContext | null, level: string, content: any): boolean;
 /**
  * Call an Function on RPC server
  * @param action
@@ -46,5 +46,5 @@ export declare function emit(event: 'log', timestamp: number, context: Context |
  * @param context
  * @returns
  */
-export declare function call(action: string, params: any[], context: Context): Promise<ReturnsBody>;
-export declare function execute(action: string, params: Array<any>, context: Context): Promise<any>;
+export declare function call(action: string, params: any[] | undefined, context: AppContext): Promise<ReturnsBody>;
+export declare function execute(action: string, params: Array<any>, context: AppContext): Promise<any>;

package/types/bin/configurer.d.ts

@@ -1,3 +1,5 @@
 export declare function buildConfig(mergeEnv?: {
     [x: string]: any;
-}): Promise<any>;
+}): Promise<{
+    [x: string]: any;
+}>;

package/types/bin/register.d.ts

@@ -1 +1,2 @@
-export declare function registry(urls: string | string[]): Promise<void>;
+import * as oox from '../index.js';
+export declare function registry(identifies: string[] | oox.KeepAliveConnectionData[]): Promise<void>;

package/types/bin/starter.d.ts

@@ -1,5 +1,4 @@
-import * as oox from '../index.js';
 export declare function configure(env?: {
     [x: string]: any;
-}, entryFilename?: string): Promise<oox.Config>;
+}, entryFilename?: string): Promise<import("../config.js").Config>;
 export declare function startup(): Promise<void>;

package/types/config.d.ts

@@ -0,0 +1,54 @@
+import { KeepAliveConnectionData } from "./keepalive-connection.js";
+export interface ConfigAllow {
+    untrusted: boolean;
+    ip: string[];
+    caller: string[];
+}
+interface ConfigInterface {
+    id: string;
+    name: string;
+    group: string;
+    ignore: string[];
+    entryInfo: {
+        path: string;
+        group: string;
+    };
+    host: string;
+    port: number;
+    origin: string | string[];
+    errorStack: boolean;
+    isRegistry: boolean;
+    registry: string[] | KeepAliveConnectionData[];
+    registryToken: string;
+    registryAdapter: string;
+    token: string;
+    allow: ConfigAllow;
+}
+export declare class Config implements ConfigInterface {
+    [x: string]: any;
+    id: string;
+    name: string;
+    group: string;
+    ignore: string[];
+    entryInfo: {
+        path: string;
+        group: string;
+    };
+    host: string;
+    port: number;
+    origin: string | string[];
+    errorStack: boolean;
+    isRegistry: boolean;
+    registry: string[] | KeepAliveConnectionData[];
+    registryToken: string;
+    registryAdapter: string;
+    token: string;
+    allow: ConfigAllow;
+}
+type StrictFormatter<T> = {
+    [K in keyof T]: (value: any) => T[K];
+};
+export declare const formatters: StrictFormatter<ConfigInterface> & {
+    [x: string]: (v: any) => any;
+};
+export {};