oox 0.2.0 → 0.3.0-beta3

package/types/index.d.ts

@@ -0,0 +1,70 @@
+/// <reference types="node" />
+import * as app from './app';
+import Module, { ModuleConfig } from './modules/module';
+import Modules from './modules';
+export { ReturnsBody } from './app';
+export { Module, ModuleConfig };
+export declare const modules: Modules;
+export declare const asyncStore: import("async_hooks").AsyncLocalStorage<app.Context>, setMethods: typeof app.setMethods, getMethods: typeof app.getMethods, kvMethods: Map<string, Function>, sourceKVMethods: Map<string, Function>, call: typeof app.call, execute: typeof app.execute, on: typeof app.on;
+export declare class Context extends app.Context {
+    sourceIP: string;
+    ip: string;
+    caller: string;
+    callerId: string;
+    connection?: RPCKeepAliveConnection;
+    toJSON?(): string;
+}
+export declare class Config {
+    [x: string]: any;
+    name: string;
+    host: string;
+}
+export declare const config: Config;
+export declare function getConfig(): void;
+export declare function setGenTraceIdFunction(fn: () => string): void;
+/**
+ * 生成随机不重复id
+ */
+export declare function genTraceId(): string;
+/**
+ * 获取链路跟踪上下文
+ */
+export declare function genContext(context?: Context): Context;
+export declare function getContext(): Context;
+export declare function serve(): Promise<void>;
+export declare function stop(): Promise<void>;
+export interface RPCConnectionAdapter {
+    rpc(connection: any, action: string, params: any[], context: Context): Promise<any>;
+}
+export interface RPCKeepAliveConnectionData {
+    /**
+     * 是否连接成功
+     */
+    connected: boolean;
+    /**
+     * 连接主机地址
+     */
+    host: string;
+    /**
+     * 连接服务名称
+     */
+    name: string;
+    /**
+     * 目标服务网络唯一ID
+     */
+    id: string;
+}
+export declare class RPCKeepAliveConnection {
+    data: RPCKeepAliveConnectionData;
+    nativeConnection: any;
+    adapter: RPCConnectionAdapter;
+    constructor(adapter: RPCConnectionAdapter, nativeConnection: any, data?: RPCKeepAliveConnectionData);
+}
+export declare const keepAliveConnections: Map<string, Map<string, RPCKeepAliveConnection>>;
+export declare function getKeepAliveConnections(name: string): Map<string, RPCKeepAliveConnection>;
+export declare function getKeepAliveConnection(name: string, id: string): RPCKeepAliveConnection | null;
+export declare function addKeepAliveConnection(connection: RPCKeepAliveConnection): void;
+export declare function removeKeepAliveConnection(connection: RPCKeepAliveConnection): void;
+export declare function removeKeepAliveConnection(name: string, id: string): void;
+export declare function rpc(appName: string, action: string, params: any[], context?: Context): Promise<any>;
+export declare function rpc(connection: RPCKeepAliveConnection, action: string, params: any[], context?: Context): Promise<any>;

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

@@ -0,0 +1,47 @@
+/// <reference types="node" />
+import * as http from 'node:http';
+import * as oox from '../../index';
+import Module, { ModuleConfig } from '../module';
+export declare class HTTPConfig extends ModuleConfig {
+    port: number;
+    path: string;
+    origin: string;
+}
+export default class HTTPModule extends Module {
+    name: string;
+    config: HTTPConfig;
+    server: http.Server;
+    setConfig(config: HTTPConfig): void;
+    getConfig(): HTTPConfig;
+    /**
+     * start http service
+     */
+    serve(): Promise<void>;
+    /**
+     * stop http service
+     */
+    stop(): Promise<void>;
+    /**
+     * browser cross origin
+     */
+    cors(request: http.IncomingMessage, response: http.ServerResponse): boolean;
+    /**
+     * HTTP-RPC服务器请求监听方法
+     */
+    call(request: http.IncomingMessage, response: http.ServerResponse): Promise<void>;
+    /**
+     * HTTP Response Catch
+     */
+    respond(request: http.IncomingMessage, response: http.ServerResponse, format: {
+        body?: any;
+        success: boolean;
+        error?: {
+            message: any;
+            stack: any;
+        };
+    }): void;
+    /**
+     * HTTP RPC
+     */
+    rpc(url: string | URL, action: string, params: Array<any>, context?: oox.Context): Promise<any>;
+}

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

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

package/types/modules/index.d.ts

@@ -0,0 +1,22 @@
+import Module from './module';
+import HTTP from './http';
+export default class Modules extends Module {
+    #private;
+    /**
+     * the module unique name
+     */
+    name: string;
+    /**
+     * all builtin modules
+     */
+    builtins: {
+        http: HTTP;
+    };
+    constructor();
+    add(module: Module): this;
+    get(name: string): Module;
+    remove(name: string): Promise<void>;
+    setConfig(config: any): void;
+    serve(): Promise<void>;
+    stop(): Promise<void>;
+}

package/types/modules/module.d.ts

@@ -0,0 +1,13 @@
+export declare class ModuleConfig {
+    [x: string]: any;
+    disabled: boolean;
+}
+export default class Module {
+    [x: string]: any;
+    config: ModuleConfig;
+    name: string;
+    setConfig(config: any): void;
+    getConfig(): ModuleConfig;
+    serve(): Promise<void>;
+    stop(): Promise<void>;
+}

package/types/utils.d.ts

@@ -0,0 +1,6 @@
+export declare function getIPAddress(version?: number): string[];
+export declare function getAllCallablePropertyNames(obj: any): string[];
+export declare function genKVMethods(methods: any, kvMethods?: Map<string, Function>, sourceKVMethods?: Map<string, Function>, nameStack?: string[]): {
+    kvMethods: Map<string, Function>;
+    sourceKVMethods: Map<string, Function>;
+};

package/utils.js

@@ -0,0 +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;

package/.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

package/global.js

@@ -1,118 +0,0 @@
-
-if ( Error.stackTraceLimit < 20 ) Error.stackTraceLimit = 20
-
-const { AsyncLocalStorage } = require ( 'async_hooks' )
-
-const Context = require ( './rpc/context.class' )
-
-const RPC = require ( './rpc/rpc.interface.class' )
-
-const Socket = require ( './socketio/socket.class' )
-
-const SetMap = require ( './setMap.class' )
-
-const Middleware = require ( './middleware' )
-
-
-
-const Global = {
-
-
-
-    asyncStore: new AsyncLocalStorage ( ),
-
-
-
-    md: Middleware.handler,
-
-
-
-    /**
-     * @type {[RPC]}
-     */
-    instances: [ ],
-
-
-
-    /**
-     * @type {Map<String,Socket>}
-     */
-    sockets: new Map ( ),
-
-
-
-    /**
-     * @type {SocketIOServer[]}
-     */
-    socketIOServers: [ ],
-
-
-
-    /**
-     * @type {Map<String,Set<Socket>>}
-     */
-    socketIORegistry: new SetMap,
-
-
-
-    /**
-     * 生成随机不重复id
-     * @returns {String}
-     */
-    genTraceId ( ) {
-
-        const uid = [ 
-            Math.floor ( Date.now ( ) / 1000 ).toString ( 16 ),
-            Math.floor ( Math.random ( ) * 0xffffffff ).toString ( 16 ).padStart ( 8, '0' )
-        ]
-
-        return uid.join ( '' )
-    },
-
-
-
-    /**
-     * 获取链路跟踪上下文
-     * @param {Context} param0 
-     * @returns {Context}
-     */
-    genContext ( { caller, callerId, traceId, ip, sourceIP } = { } ) {
-
-        const context = new Context ( )
-
-        if ( caller ) {
-
-            context.caller = caller
-        } else {
-
-            const primaryService = this.instances [ 0 ]
-
-            if ( primaryService ) context.caller = primaryService.name
-        }
-
-        context.traceId = traceId || this.genTraceId ( )
-        context.ip = ip
-        context.sourceIP = sourceIP || ip
-        context.callerId = callerId
-
-        return context
-    },
-
-
-
-    /**
-     * 
-     * @returns {Context}
-     */
-    getContext ( ) {
-
-        const context = this.asyncStore.getStore ( )
-
-        return context || this.genContext ( )
-    },
-}
-
-/**
- * @type {Global}
- */
-global.oox = module.exports = global.oox || Global

package/middleware.js

@@ -1,167 +0,0 @@
-
-
-
-/**
- * Map<中间件名字,中间件函数>
- * @type {Map<String,Function>}
- */
-exports.middlewares = new Map ( )
-
-
-
-/**
- * WeakMap<殼函數，原函數>
- * @type {Map<String,Function>}
- */
-exports.wrappedActions = new Map ( )
-
-
-
-/**
- * Map<中间件名字,Set<接口函数>>
- * @type {Map<String,Set<Function>>}
- */
-exports.middlewareActions = new Map ( )
-
-
-
-/**
- * WeakMap<接口函数,[中间件名字]>
- * @type {WeakMap<Function,[String]>}
- */
-exports.actionMiddlewares = new WeakMap ( )
-
-
-
-/**
- * @type {Map<String,Proxy>}
- */
-exports.middlewareProxys = new Map ( )
-
-
-
-/**
- * 
- * @param {String} key 
- * @param {Function} middleware 
- * @returns {(Function)=>{}}
- */
-exports.define = ( key, middleware ) => {
-
-    if ( middleware ) {
-
-        exports.middlewares.set ( key, middleware )
-
-        exports.middlewareActions.set ( key, new Set ( ) )
-
-        const proxy = new Proxy ( middleware, {
-
-            has ( target, action ) {
-
-                const sourceMethod = exports.wrappedActions.get ( action )
-
-                return exports.middlewareActions.get ( key ).has ( sourceMethod )
-            }
-        } )
-
-        // save proxy
-        exports.middlewareProxys.set ( key, proxy )
-    } else {
-
-        return arg => exports.define ( key, arg )
-    }
-}
-
-
-
-/**
- * 
- * @param {String} key 
- * @param {Function} action 
- * @param {'start'|'end'} place 
- */
-exports.use = ( key, action, place='end' ) => {
-
-    if ( !exports.middlewareActions.has ( key ) ) exports.middlewareActions.set ( key, new Set ( ) )
-
-    if ( !exports.actionMiddlewares.has ( action ) ) exports.actionMiddlewares.set ( action, [ ] )
-
-    // 双向绑定
-
-    exports.middlewareActions.get ( key ).add ( action )
-
-    if ( place === 'end' ) {
-
-        exports.actionMiddlewares.get ( action ).push ( key )
-    } else {
-
-        exports.actionMiddlewares.get ( action ).unshift ( key )
-    }
-}
-
-
-
-exports.delete = ( key ) => {
-
-    exports.middlewares.delete ( key )
-
-    if ( exports.middlewareActions.has ( key ) ) {
-
-        const actions = exports.middlewareActions.get ( key ).values ( )
-
-        // remove action bindings
-        for ( const action of actions ) {
-
-            const middlewareNames = exports.actionMiddlewares.get ( action ).filter ( value => value !== key )
-
-            exports.actionMiddlewares.set ( action, middlewareNames )
-        }
-    }
-
-    exports.middlewareActions.get ( key ).clear ( )
-
-    exports.middlewareActions.delete ( key )
-}
-
-
-
-exports.handler = new Proxy ( o=>o, {
-
-
-
-    get ( target, key ) {
-
-        return exports.middlewareProxys.get ( key )
-    },
-
-
-
-    set ( target, key, action ) {
-
-        if ( exports.middlewares.has ( key ) ) {
-
-            exports.use ( key, action, 'start' )
-        } else {
-
-            exports.define ( key, action )
-        }
-
-        return true
-    },
-
-
-
-    deleteProperty ( target, key ) {
-
-        exports.delete ( key )
-
-        return true
-    },
-
-
-
-    apply ( target, thisArg, args ) {
-
-        return exports.define.apply ( exports, args )
-    }
-} )

package/rpc/config.class.js

@@ -1,48 +0,0 @@
-
-module.exports = class Config {
-
-
-
-    /**
-     * 服务名称
-     */
-    name = ''
-
-
-
-    /**
-     * 主机地址列表
-     */
-    host = ''
-
-
-
-    /**
-     * 跨域处理
-     */
-    origin = null
-
-
-
-    /**
-     * 网关地址
-     */
-    gateway = {
-
-
-
-        /**
-         * http 网关地址
-         * @type {{port:Number,path:String}}
-         */
-        http: null,
-
-
-
-        /**
-         * socketio 网关地址
-         * @type {{port:Number,path:String}}
-         */
-        socketio: null
-    }
-}

package/rpc/context.class.js

@@ -1,15 +0,0 @@
-
-
-module.exports = class Context {
-
-    // 请求溯源IP
-    sourceIP = ''
-    // 请求者IP
-    ip = ''
-    // 请求溯源ID
-    traceId = ''
-    // 请求者名称
-    caller = ''
-    // 请求者ID (长连接专用)
-    callerId = ''
-}