oox 0.3.0-beta1 → 0.3.0-beta2

package/utils.js

@@ -1,63 +1,63 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.genKVMethods = exports.getAllCallablePropertyNames = exports.getIPAddress = void 0;
-const os_1 = require("os");
-function getIPAddress(version = 4) {
-    const interfaces = (0, os_1.networkInterfaces)();
-    const ip = [];
-    for (const name of Object.keys(interfaces))
-        for (const intf of interfaces[name])
-            if (intf.mac !== '00:00:00:00:00:00')
-                if ((version !== 4 && version !== 6) || 'IPv' + version === intf.family)
-                    ip.push(intf.address);
-    if (!ip.length) {
-        if (version !== 6)
-            ip.push('127.0.0.1');
-        if (version !== 4)
-            ip.push('::1');
-    }
-    return ip;
-}
-exports.getIPAddress = getIPAddress;
-function getAllCallablePropertyNames(obj) {
-    if (!obj)
-        return [];
-    let props = [], tmpProps = [], index = 0, size = 0, tmpProp = '';
-    const bans = ["constructor", "__defineGetter__", "__defineSetter__",
-        "hasOwnProperty", "__lookupGetter__", "__lookupSetter__",
-        "isPrototypeOf", "propertyIsEnumerable", "toString",
-        "valueOf", "__proto__", "toLocaleString"];
-    do {
-        tmpProps = Object.getOwnPropertyNames(obj);
-        index = -1, size = tmpProps.length;
-        while (++index < size) {
-            tmpProp = tmpProps[index];
-            if (!props.includes(tmpProp) && !bans.includes(tmpProp)) {
-                props.push(tmpProp);
-            }
-        }
-    } while (obj = Object.getPrototypeOf(obj));
-    return props;
-}
-exports.getAllCallablePropertyNames = getAllCallablePropertyNames;
-function genKVMethods(methods, kvMethods = new Map(), sourceKVMethods = new Map(), nameStack = []) {
-    let keys = getAllCallablePropertyNames(methods);
-    for (const key of keys) {
-        /**
-         * @type {Function}
-         */
-        let val = methods[key];
-        if ('function' === typeof val) {
-            const action = nameStack.concat(key).join('.');
-            // 原函数绑定
-            sourceKVMethods.set(action, val);
-            // 壳函数绑定
-            kvMethods.set(action, val.bind(methods));
-        }
-        else {
-            genKVMethods(val, kvMethods, sourceKVMethods, nameStack.concat(key));
-        }
-    }
-    return { kvMethods, sourceKVMethods };
-}
-exports.genKVMethods = genKVMethods;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.genKVMethods = exports.getAllCallablePropertyNames = exports.getIPAddress = void 0;
+const os_1 = require("os");
+function getIPAddress(version = 4) {
+    const interfaces = (0, os_1.networkInterfaces)();
+    const ip = [];
+    for (const name of Object.keys(interfaces))
+        for (const intf of interfaces[name])
+            if (intf.mac !== '00:00:00:00:00:00')
+                if ((version !== 4 && version !== 6) || 'IPv' + version === intf.family)
+                    ip.push(intf.address);
+    if (!ip.length) {
+        if (version !== 6)
+            ip.push('127.0.0.1');
+        if (version !== 4)
+            ip.push('::1');
+    }
+    return ip;
+}
+exports.getIPAddress = getIPAddress;
+function getAllCallablePropertyNames(obj) {
+    if (!obj)
+        return [];
+    let props = [], tmpProps = [], index = 0, size = 0, tmpProp = '';
+    const bans = ["constructor", "__defineGetter__", "__defineSetter__",
+        "hasOwnProperty", "__lookupGetter__", "__lookupSetter__",
+        "isPrototypeOf", "propertyIsEnumerable", "toString",
+        "valueOf", "__proto__", "toLocaleString"];
+    do {
+        tmpProps = Object.getOwnPropertyNames(obj);
+        index = -1, size = tmpProps.length;
+        while (++index < size) {
+            tmpProp = tmpProps[index];
+            if (!props.includes(tmpProp) && !bans.includes(tmpProp)) {
+                props.push(tmpProp);
+            }
+        }
+    } while (obj = Object.getPrototypeOf(obj));
+    return props;
+}
+exports.getAllCallablePropertyNames = getAllCallablePropertyNames;
+function genKVMethods(methods, kvMethods = new Map(), sourceKVMethods = new Map(), nameStack = []) {
+    let keys = getAllCallablePropertyNames(methods);
+    for (const key of keys) {
+        /**
+         * @type {Function}
+         */
+        let val = methods[key];
+        if ('function' === typeof val) {
+            const action = nameStack.concat(key).join('.');
+            // 原函数绑定
+            sourceKVMethods.set(action, val);
+            // 壳函数绑定
+            kvMethods.set(action, val.bind(methods));
+        }
+        else {
+            genKVMethods(val, kvMethods, sourceKVMethods, nameStack.concat(key));
+        }
+    }
+    return { kvMethods, sourceKVMethods };
+}
+exports.genKVMethods = genKVMethods;

package/modules/socketio/client.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const SocketIOClient = require("socket.io-client");
-const socket_1 = require("./socket");
-const server_1 = require("./server");
-const oox = require("../../index");
-class SocketIOCore extends server_1.default {
-    /**
-     * connect to <SocketIO RPC> service
-     */
-    async connect(url) {
-        let socket = socket_1.sockets.get(url);
-        // 已经连接的直接返回
-        if (socket) {
-            try {
-                await this.clientWaitConnection(socket);
-            }
-            catch (error) {
-                this.clientOnSocketDisconnect(socket, error.message);
-                throw error;
-            }
-            return socket;
-        }
-        const headers = {
-            'x-caller': oox.config.name
-        };
-        const { host } = oox.config;
-        const { port, path } = this.config;
-        headers['x-ip'] = host;
-        headers['x-caller-id'] = `ws://${host}:${port}${path}`;
-        // create socket handler
-        const mURL = new URL(url);
-        socket = SocketIOClient.io(mURL.origin, {
-            extraHeaders: headers,
-            path: mURL.pathname
-        });
-        socket.data = { name: 'anonymous', connected: false, id: url, host: mURL.host };
-        socket_1.sockets.set(url, socket);
-        try {
-            await this.clientWaitConnection(socket);
-        }
-        catch (error) {
-            this.clientOnSocketDisconnect(socket, error);
-            throw error;
-        }
-        return socket;
-    }
-    /**
-     * 客户端Socket连接事件
-     */
-    clientOnSocketConnection(socket) {
-        socket.data.connected = true;
-        socket.once('disconnect', reason => this.clientOnSocketDisconnect(socket, reason));
-        this.clientOnConnection(socket);
-    }
-    clientOnDisconnect(socket, reason) { }
-    clientOnConnection(socket) { }
-    /**
-     * 客户端Socket断开事件
-     * @param {Socket} socket
-     */
-    clientOnSocketDisconnect(socket, reason) {
-        socket.data.connected = false;
-        socket.disconnect();
-        socket_1.sockets.delete(socket.data.id);
-        this.clientOnDisconnect(socket, reason);
-    }
-    /**
-     * 等待socket连接
-     */
-    async clientWaitConnection(socket) {
-        if (socket.data.connected)
-            return;
-        if (socket.connect)
-            socket.connect();
-        try {
-            await new Promise((resolve, reject) => {
-                const onError = (reason) => {
-                    socket.offAny(onError);
-                    const message = 'string' === typeof reason ? reason : reason instanceof Error ? reason.message : 'connect error';
-                    reject(new Error(message));
-                };
-                socket.once('disconnect', onError);
-                socket.once('connect_error', onError);
-                socket.once('connect_timeout', onError);
-                socket.once('reconnect_error', onError);
-                socket.once('reconnect_failed', onError);
-                socket.once('oox_connected', ({ name }) => {
-                    socket.offAny(onError);
-                    socket.data.name = name;
-                    resolve();
-                });
-            });
-        }
-        catch (error) {
-            throw new Error(error.message);
-        }
-        this.clientOnSocketConnection(socket);
-    }
-}
-exports.default = SocketIOCore;

package/modules/socketio/index.js

@@ -1,148 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("./client");
-const oox = require("../../index");
-const index_1 = require("../../index");
-const socket_1 = require("./socket");
-class SocketIOModule extends client_1.default {
-    sockets = socket_1.sockets;
-    onSyncConnection(socket) {
-        const mSockets = Array.from(socket_1.sockets.values())
-            .filter(s => s !== socket &&
-            s.data.name !== socket.data.name &&
-            s.data.id.startsWith('ws://'));
-        return mSockets.map(s => s.data);
-    }
-    serverOnDisconnect(socket, reason) {
-        super.serverOnDisconnect(socket, reason);
-        (0, index_1.removeKeepAliveConnection)(socket.data.name, socket.data.id);
-    }
-    clientOnDisconnect(socket, reason) {
-        super.clientOnDisconnect(socket, reason);
-        (0, index_1.removeKeepAliveConnection)(socket.data.name, socket.data.id);
-    }
-    /**
-     *
-     * @param socket 是由哪个通道发送过来的
-     * @param connectionDatas
-     */
-    clientOnSyncConnection(socket, connectionDatas) {
-        for (const data of connectionDatas)
-            if (!socket_1.sockets.has(data.id))
-                this.connect(data.id).catch((error) => console.error(error));
-    }
-    onFetchActions(socket, search) {
-        const data = [];
-        for (const key of oox.kvMethods.keys())
-            if (!key.endsWith('_proxy') && key.includes(search))
-                data.push(key);
-        return data;
-    }
-    fetchActions(id, search = '') {
-        let socket = socket_1.sockets.get(id);
-        if (!socket) {
-            const connections = (0, index_1.getKeepAliveConnections)(id);
-            if (!connections || !connections.size)
-                throw new Error(`Unknown service identify<${id}>`);
-            id = connections.keys().next().value;
-            socket = socket_1.sockets.get(id);
-        }
-        if (!socket)
-            throw new Error(`Unknown service identify<${id}>`);
-        return this.emit(socket.data.id, 'fetchActions', [search]);
-    }
-    onConnection(socket) {
-        const { id, name, host } = socket.data;
-        const connection = new index_1.RPCKeepAliveConnection(this, id, socket.data);
-        (0, index_1.addKeepAliveConnection)(connection);
-        const connectionContext = {
-            sourceIP: '',
-            ip: host,
-            caller: name,
-            callerId: id,
-            connection
-        };
-        socket.on('fetchActions', async (search, fn) => {
-            if ('function' !== typeof fn)
-                return;
-            const data = await this.onFetchActions(socket, search);
-            fn(data);
-        });
-        socket.on('call', async (action, params, context, callback) => {
-            if ('object' !== typeof context)
-                context = oox.genContext(connectionContext);
-            else
-                context = oox.genContext(Object.assign(context, connectionContext));
-            this.call(action, params, context, callback);
-        });
-    }
-    /**
-     *
-     * @param {Socket} socket
-     */
-    serverOnConnection(socket) {
-        super.serverOnConnection(socket);
-        socket.setMaxListeners(0);
-        socket.on('syncConnection', async (fn) => {
-            if ('function' !== typeof fn)
-                return;
-            const data = this.onSyncConnection(socket);
-            fn(data);
-        });
-        this.onConnection(socket);
-    }
-    async call(action, params, context, callback) {
-        const returns = await oox.call(action, params, context);
-        'function' === typeof callback && callback(returns);
-        return returns;
-    }
-    clientOnConnection(socket) {
-        super.clientOnConnection(socket);
-        socket.emit('syncConnection', (socketDatas) => this.clientOnSyncConnection(socket, socketDatas));
-        this.onConnection(socket);
-    }
-    /**
-     * socketio emit
-     */
-    async emit(url, action, params) {
-        let socket = null;
-        try {
-            socket = await this.connect(url);
-        }
-        catch (error) {
-            // try again
-            socket = await this.connect(url);
-        }
-        try {
-            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('disconnect', onError);
-                socket.emit(action, ...params, (returns) => {
-                    socket.off('disconnect', onError);
-                    resolve(returns);
-                });
-            });
-        }
-        catch (error) {
-            throw new Error(error.message);
-        }
-    }
-    /**
-     * RPC
-     */
-    async rpc(url, action, params, context) {
-        if (!context || !context.traceId) {
-            context = oox.getContext();
-        }
-        const { error, body } = await this.emit(url, 'call', [action, params, context]);
-        if (error)
-            throw new Error(error.message);
-        else
-            return body;
-    }
-}
-exports.default = SocketIOModule;

package/modules/socketio/server.js

@@ -1,130 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SocketIOConfig = void 0;
-const http = require("http");
-const socket_io_1 = require("socket.io");
-const module_1 = require("../module");
-const socket_1 = require("./socket");
-const oox = require("../../index");
-class SocketIOConfig extends module_1.ModuleConfig {
-    // listen port
-    port = 0;
-    // service path
-    path = '/socket.io';
-    // browser cross origin
-    origin = '';
-}
-exports.SocketIOConfig = SocketIOConfig;
-class SocketIOServer extends module_1.default {
-    name = 'oox:socketio';
-    config = new SocketIOConfig;
-    /**
-     * means this.server created by myself<SocketIOServer>
-     */
-    #isSelfServer = false;
-    server = null;
-    socketServer = null;
-    setConfig(config) {
-        Object.assign(this.config, config);
-    }
-    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;

package/modules/socketio/socket.js

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

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

@@ -1,23 +0,0 @@
-import { ClientSocket as Socket } from './socket';
-import SocketIOServer from './server';
-export default class SocketIOCore extends SocketIOServer {
-    /**
-     * connect to <SocketIO RPC> service
-     */
-    connect(url: string): Promise<Socket>;
-    /**
-     * 客户端Socket连接事件
-     */
-    clientOnSocketConnection(socket: Socket): void;
-    clientOnDisconnect(socket: Socket, reason: any): void;
-    clientOnConnection(socket: Socket): void;
-    /**
-     * 客户端Socket断开事件
-     * @param {Socket} socket
-     */
-    clientOnSocketDisconnect(socket: Socket, reason: any): void;
-    /**
-     * 等待socket连接
-     */
-    clientWaitConnection(socket: Socket): Promise<void>;
-}

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

@@ -1,35 +0,0 @@
-import SocketIOClient from './client';
-import * as oox from '../../index';
-import { RPCKeepAliveConnectionData, RPCConnectionAdapter } from '../../index';
-import { Socket, ServerSocket, ClientSocket } from './socket';
-export default class SocketIOModule extends SocketIOClient implements RPCConnectionAdapter {
-    sockets: Map<string, Socket>;
-    onSyncConnection(socket: Socket): oox.RPCKeepAliveConnectionData[];
-    serverOnDisconnect(socket: ServerSocket, reason: string): void;
-    clientOnDisconnect(socket: ClientSocket, reason: any): void;
-    /**
-     *
-     * @param socket 是由哪个通道发送过来的
-     * @param connectionDatas
-     */
-    clientOnSyncConnection(socket: Socket, connectionDatas: RPCKeepAliveConnectionData[]): void;
-    onFetchActions(socket: Socket, search: string): string[];
-    fetchActions(url: string, search?: string): Promise<RPCKeepAliveConnectionData[]>;
-    fetchActions(name: string, search?: string): Promise<RPCKeepAliveConnectionData[]>;
-    onConnection(socket: Socket): void;
-    /**
-     *
-     * @param {Socket} socket
-     */
-    serverOnConnection(socket: ServerSocket): void;
-    call(action: string, params: any[], context: oox.Context, callback?: (returns: any) => void): Promise<oox.ReturnsBody>;
-    clientOnConnection(socket: ClientSocket): void;
-    /**
-     * socketio emit
-     */
-    emit(url: string, action: string, params: any[]): Promise<unknown>;
-    /**
-     * RPC
-     */
-    rpc(url: string, action: string, params: [], context?: oox.Context): Promise<any>;
-}

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

@@ -1,35 +0,0 @@
-/// <reference types="node" />
-import * as http from 'http';
-import { Server, ServerOptions } from 'socket.io';
-import Module, { ModuleConfig } from '../module';
-import { ServerSocket as Socket } from './socket';
-export declare class SocketIOConfig extends ModuleConfig {
-    port: number;
-    path: string;
-    origin: string;
-}
-export default class SocketIOServer extends Module {
-    #private;
-    name: string;
-    config: SocketIOConfig;
-    server: http.Server;
-    socketServer: Server;
-    setConfig(config: SocketIOConfig): void;
-    getConfig(): SocketIOConfig;
-    serve(): Promise<void>;
-    stop(): Promise<void>;
-    genSocketIOServerOptions(): Partial<ServerOptions>;
-    createSocketIOServer(): void;
-    /**
-     * 服务端Socket连接事件
-     */
-    serverOnSocketConnection(socket: Socket): void;
-    serverOnConnection(socket: Socket): void;
-    /**
-     * 服务端Socket断开事件
-     * @param {Socket} socket
-     * @param {Error} reason
-     */
-    serverOnSocketDisconnect(socket: Socket, reason: string): void;
-    serverOnDisconnect(socket: Socket, reason: string): void;
-}

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

@@ -1,11 +0,0 @@
-import { Socket as _ServerSocket } from 'socket.io';
-import { Socket as _ClientSocket } from 'socket.io-client';
-import { RPCKeepAliveConnectionData } from '../../index';
-export interface ServerSocket extends _ServerSocket {
-    data: RPCKeepAliveConnectionData;
-}
-export interface ClientSocket extends _ClientSocket {
-    data: RPCKeepAliveConnectionData;
-}
-export declare type Socket = ServerSocket | ClientSocket;
-export declare const sockets: Map<string, Socket>;