oox 0.3.0-beta9 → 0.3.2

package/modules/socketio/server.js

@@ -1,136 +1,188 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SocketIOConfig = void 0;
-const http = require("node:http");
-const socket_io_1 = require("socket.io");
-const oox = require("../../index");
-const index_1 = require("../../index");
-const socket_1 = require("./socket");
-class SocketIOConfig extends index_1.ModuleConfig {
-    // listen port
-    port = 0;
-    // service path
-    path = '/socket.io';
-    // browser cross origin
-    origin = '';
-}
-exports.SocketIOConfig = SocketIOConfig;
-class SocketIOServer extends index_1.Module {
-    name = 'socketio';
-    config = new SocketIOConfig;
-    /**
-     * means this.server created by myself<SocketIOServer>
-     */
-    #isSelfServer = false;
-    server = null;
-    socketServer = null;
-    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 = this.config.port;
-        const isSelfServer = this.#isSelfServer = this.server ? true : false;
-        const server = this.server = isSelfServer ? this.server :
-            http.createServer((request, response) => response.end('No HTTP Gateway'));
-        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() {
-        if (this.socketServer)
-            await new Promise((resolve, reject) => this.socketServer.close(error => error ? reject(error) : resolve()));
-        if (this.#isSelfServer)
-            await new Promise((resolve, reject) => this.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 socketServer = this.socketServer = new socket_io_1.Server(this.server, this.genSocketIOServerOptions());
-        socketServer.on('connection', async (socket) => {
-            try {
-                this.serverOnSocketConnection(socket);
-            }
-            catch (error) {
-                socket.send(error.message).disconnect(true);
-            }
-        });
-    }
-    /**
-     * 服务端Socket连接事件
-     */
-    serverOnSocketConnection(socket) {
-        const headers = socket.handshake.headers;
-        const callerId = String(headers['x-caller-id'] || '') || socket.id;
-        // 已经存在相同的连接
-        if (socket_1.sockets.has(callerId))
-            throw new Error('Connection Exists');
-        // client ip or caller service ip
-        const ip = String(headers['x-real-ip'] || headers['x-ip'] || socket.handshake.address);
-        // service name
-        const caller = String(headers['x-caller'] || 'anonymous');
-        socket.data = { connected: true, host: ip, name: caller, id: callerId };
-        // 保存 callerId 与 socket 对应关系
-        socket_1.sockets.set(callerId, socket);
-        socket.on('disconnect', reason => this.serverOnSocketDisconnect(socket, reason));
-        socket.emit('oox_connected', { name: oox.config.name });
-        this.serverOnConnection(socket);
-    }
-    serverOnConnection(socket) { }
-    /**
-     * 服务端Socket断开事件
-     * @param {Socket} socket
-     * @param {Error} reason
-     */
-    serverOnSocketDisconnect(socket, reason) {
-        socket.data.connected = false;
-        socket_1.sockets.delete(socket.data.id);
-        this.serverOnDisconnect(socket, reason);
-    }
-    serverOnDisconnect(socket, reason) { }
-}
-exports.default = SocketIOServer;
+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 { sockets } from './socket.js';
+export class SocketIOConfig extends ModuleConfig {
+    // 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;
+    static isWebSocketUrl(url) {
+        return /^wss?:\/\/.+$/.test(url);
+    }
+    static genWebSocketUrl(url) {
+        // :6000
+        if (url.startsWith(':'))
+            url = oox.config.host + url;
+        // 127.0.0.1:6000
+        if (!/^\w+?:\/.+$/.test(url))
+            url = 'ws://' + url;
+        const urlObject = new URL(url);
+        if (urlObject.protocol !== 'wss:') {
+            if (urlObject.port === '443')
+                urlObject.protocol = 'wss:';
+            else
+                urlObject.protocol = 'ws:';
+        }
+        return urlObject.toString();
+    }
+    getUrl() {
+        const { host } = oox.config;
+        const { port, path } = this.config;
+        const protocol = this.config.ssl.enabled ? 'wss:' : 'ws:';
+        return `${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;
+        if (isSelfServer) {
+            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
+                };
+                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() {
+        if (this.socketServer)
+            await new Promise((resolve, reject) => this.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()));
+    }
+    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 socketServer = this.socketServer = new Server(this.server, this.genSocketIOServerOptions());
+        socketServer.on('connection', async (socket) => {
+            try {
+                this.serverOnSocketConnection(socket);
+            }
+            catch (error) {
+                socket.send(error.message).disconnect(true);
+            }
+        });
+    }
+    /**
+     * 服务端Socket连接事件
+     */
+    serverOnSocketConnection(socket) {
+        const headers = socket.handshake.headers;
+        const callerId = String(headers['x-caller-id'] || '') || socket.id;
+        // 已经存在相同的连接
+        if (sockets.has(callerId))
+            throw new Error('Connection Exists');
+        // client ip or caller service ip
+        const ip = String(headers['x-real-ip'] || headers['x-ip'] || socket.handshake.address);
+        // service name
+        const caller = String(headers['x-caller'] || 'anonymous');
+        socket.data = { connected: true, host: ip, name: caller, id: callerId };
+        // 保存 callerId 与 socket 对应关系
+        sockets.set(callerId, socket);
+        socket.on('disconnect', reason => this.serverOnSocketDisconnect(socket, reason));
+        socket.emit('oox_connected', { name: oox.config.name });
+        this.serverOnConnection(socket);
+    }
+    serverOnConnection(socket) { }
+    /**
+     * 服务端Socket断开事件
+     * @param {Socket} socket
+     * @param {Error} reason
+     */
+    serverOnSocketDisconnect(socket, reason) {
+        socket.data.connected = false;
+        sockets.delete(socket.data.id);
+        this.serverOnDisconnect(socket, reason);
+    }
+    serverOnDisconnect(socket, reason) { }
+}

package/modules/socketio/socket.js

@@ -1,4 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sockets = void 0;
-exports.sockets = new Map();
+export const sockets = new Map();

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "oox",
-    "version": "0.3.0-beta9",
-    "description": "Graceful NodeJS distributed application solution",
+    "version": "0.3.2",
+    "description": "OOX Service Engine",
     "keywords": [
         "http",
         "websocket",
@@ -12,28 +12,30 @@
         "distributed",
         "tracing"
     ],
-    "type": "commonjs",
-    "main": "index.js",
-    "types": "types/index.d.ts",
+    "type": "module",
+    "main": "./index.js",
+    "types": "./types/index.d.ts",
     "exports": {
         ".": {
             "import": "./index.mjs",
-            "require": "./index.js"
+            "require": "./index.js",
+            "types": "./types/index.d.ts"
         },
-        "./loader": "./bin/loader.mjs"
+        "./loader": "./bin/loader.mjs",
+        "./cli": "./bin/cli.js"
     },
     "bin": {
-        "oox": "bin/cli.js"
+        "oox": "./bin/cli.js"
     },
     "author": "lipingruan",
     "homepage": "https://github.com/lipingruan/oox",
     "license": "MIT",
     "dependencies": {
-        "chalk": "^4.1.0",
-        "socket.io": "^4.4.0",
-        "socket.io-client": "^4.4.0"
+        "chalk": "^5.6.2",
+        "socket.io": "^4.8.3",
+        "socket.io-client": "^4.8.3"
     },
     "engines": {
-        "node": ">=12.0.0"
+        "node": ">=18.0.0"
     }
 }

package/types/app.d.ts

@@ -1,51 +1,50 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { EventEmitter } from 'node:events';
-import { AsyncLocalStorage } from 'node:async_hooks';
-export * as logger from './logger';
-export interface ReturnsBody {
-    traceId: string;
-    success: boolean;
-    body?: any;
-    error?: {
-        message: string;
-        stack: string;
-    };
-}
-export declare class Context {
-    [x: string]: any;
-    traceId?: string;
-}
-export declare const asyncStore: AsyncLocalStorage<Context>;
-export declare const eventHub: EventEmitter;
-/**
- * the kvMethods is all actions refs [has bind this]
- */
-export declare const kvMethods: Map<string, Function>;
-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: 'request', listener: (action: string, params: any[], context: Context) => void): void;
-export declare function on(event: 'success', listener: (action: string, params: any[], context: Context, result: ReturnsBody) => void): void;
-export declare function on(event: 'fail', listener: (action: string, params: any[], context: Context, error: Error) => void): void;
-export declare function on(event: 'log', listener: (context: Context, tag: string, msgs: any[]) => void): void;
-export declare function on(event: string, listener: (...args: any[]) => void): void;
-export declare function once(event: 'app:configured' | 'app:served' | 'app:stopped', listener: (...args: any[]) => void): void;
-export declare function once(event: 'request', listener: (action: string, params: any[], context: Context) => void): void;
-export declare function once(event: 'success', listener: (action: string, params: any[], context: Context, result: ReturnsBody) => void): void;
-export declare function once(event: 'fail', listener: (action: string, params: any[], context: Context, error: Error) => void): void;
-export declare function once(event: 'log', listener: (context: Context, tag: string, msgs: any[]) => void): void;
-export declare function once(event: string, listener: (...args: any[]) => void): void;
-export declare function off(event: 'app:configured' | 'app:served' | 'app:stopped' | 'request' | 'success' | 'fail' | 'log', listener: (...args: any[]) => void): void;
-export declare function off(event: string, listener: (...args: any[]) => void): void;
-export declare function emit(event: string, ...args: any[]): boolean;
-/**
- * Call an Function on RPC server
- * @param action
- * @param params
- * @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>;
+import { EventEmitter } from 'node:events';
+import { AsyncLocalStorage } from 'node:async_hooks';
+export * as logger from './logger.js';
+export interface ReturnsBody {
+    traceId: string;
+    success: boolean;
+    body?: any;
+    error?: {
+        message: string;
+        stack: string;
+    };
+}
+export declare class Context {
+    [x: string]: any;
+    traceId?: string;
+}
+export declare const asyncStore: AsyncLocalStorage<Context>;
+export declare const eventHub: EventEmitter<[never]>;
+/**
+ * the kvMethods is all actions refs [has bind this]
+ */
+export declare const kvMethods: Map<string, Function>;
+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 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 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;
+/**
+ * Call an Function on RPC server
+ * @param action
+ * @param params
+ * @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>;

package/types/bin/argv.d.ts

@@ -1,8 +1,8 @@
-export declare function getAllEnvArgs(): {
-    [x: string]: any;
-};
-export declare function getEnvArgs(names: string[]): {
-    [x: string]: any;
-};
-export declare function getEnvArg(name: string): any;
-export declare function parseEnvArg(value: string): any;
+export declare function getAllEnvArgs(): {
+    [x: string]: any;
+};
+export declare function getEnvArgs(names: string[]): {
+    [x: string]: any;
+};
+export declare function getEnvArg(name: string): any;
+export declare function parseEnvArg(value: string): any;

package/types/bin/cli.d.ts

@@ -1,2 +1,6 @@
-#! /usr/bin/env node
-export {};
+#! /usr/bin/env node
+import { configure, startup } from './starter.js';
+import { inGroupConvertRequireToRPC } from './proxy-require.js';
+import { registModuleLoader } from './proxy-import.js';
+export declare const version: string;
+export { configure, startup, inGroupConvertRequireToRPC, registModuleLoader, };

package/types/bin/configurer.d.ts

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

package/types/bin/proxy-import.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 注册ECMAScript Module加载器
+ */
+export declare function registModuleLoader(): Promise<void>;

package/types/bin/proxy-require.d.ts

@@ -0,0 +1,5 @@
+export declare function proxyGroup(groupDirectory: string, excludes?: string[]): void;
+/**
+ * 将所有 group 目录下的 commonjs require 转换为 RPC
+ */
+export declare function inGroupConvertRequireToRPC(): void;

package/types/bin/register.d.ts

@@ -1 +1 @@
-export declare function registry(urls: string | string[]): Promise<void>;
+export declare function registry(urls: string | string[]): Promise<void>;

package/types/bin/starter.d.ts

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