oox 0.1.0 → 0.3.0-beta2

package/modules/http/index.js

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HTTPConfig = void 0;
+const http = require("node:http");
+const utils_1 = require("./utils");
+const oox = require("../../index");
+const module_1 = require("../module");
+class HTTPConfig extends module_1.ModuleConfig {
+    // listen port
+    port = 0;
+    // service path
+    path = '/';
+    // browser cross origin
+    origin = '';
+}
+exports.HTTPConfig = HTTPConfig;
+class HTTPModule extends module_1.default {
+    name = 'oox:http';
+    config = new HTTPConfig;
+    server = null;
+    setConfig(config) {
+        Object.assign(this.config, config);
+    }
+    getConfig() {
+        return this.config;
+    }
+    /**
+     * start http service
+     */
+    async serve() {
+        await this.stop();
+        const { port } = this.config;
+        this.server = http.createServer(this.call.bind(this));
+        this.server.listen(port);
+        const address = this.server.address();
+        if (!address || 'object' !== typeof address)
+            throw new Error('Cannot read http server port');
+        this.config.port = address.port;
+    }
+    /**
+     * stop http service
+     */
+    stop() {
+        if (this.server && this.server.listening)
+            return new Promise((resolve, reject) => {
+                this.server.close(function (error) {
+                    if (error)
+                        reject(error);
+                    else
+                        resolve();
+                });
+            });
+    }
+    /**
+     * browser cross origin
+     */
+    cors(request, response) {
+        // origin checking
+        const origin = this.config.origin;
+        const requestOrigin = request.headers.origin;
+        if (origin && requestOrigin) {
+            if (origin === '*' || origin === requestOrigin || Array.isArray(origin) && origin.includes(requestOrigin)) {
+                response.setHeader('Access-Control-Allow-Origin', requestOrigin);
+                response.setHeader('Vary', 'Origin');
+            }
+            else {
+                response.statusCode = 403;
+                response.end();
+                return false;
+            }
+            response.setHeader('Access-Control-Max-Age', 3600);
+            response.setHeader('Access-Control-Allow-Headers', 'x-caller,content-type');
+            response.setHeader('Access-Control-Allow-Methods', '*');
+        }
+        if (request.method === 'OPTIONS') {
+            response.statusCode = 204;
+            response.end();
+            return false;
+        }
+        return true;
+    }
+    /**
+     * HTTP-RPC服务器请求监听方法
+     */
+    async call(request, response) {
+        if (request.url !== this.config.path) {
+            const error = {
+                message: 'Invalid URL',
+                stack: ''
+            };
+            Error.captureStackTrace(error);
+            return this.respond(request, response, {
+                success: false,
+                error
+            });
+        }
+        if (!this.cors(request, response))
+            return;
+        let body = Object.create(null);
+        try {
+            body = await (0, utils_1.parseHTTPBody)(request);
+            if (!body || 'object' !== typeof body)
+                throw new Error('Content Invalid');
+        }
+        catch (error) {
+            return this.respond(request, response, {
+                success: false,
+                error: {
+                    message: error.message,
+                    stack: error.stack
+                }
+            });
+        }
+        // global unique id
+        const traceId = String(request.headers['x-trace-id'] || '');
+        // service name, required
+        const caller = String(request.headers['x-caller'] || 'anonymous');
+        // client ip or caller service ip
+        const ip = String(request.headers['x-ip'] || request.socket.remoteAddress || '');
+        // startup client ip
+        const sourceIP = String(request.headers['x-real-ip'] || '');
+        const { action, params = [] } = body;
+        const context = oox.genContext({ traceId, caller, sourceIP, ip, callerId: '' });
+        const format = await oox.call(action, params, context);
+        this.respond(request, response, format);
+    }
+    /**
+     * HTTP Response Catch
+     */
+    respond(request, response, format) {
+        let formatString = '';
+        try {
+            formatString = JSON.stringify(format);
+        }
+        catch ({ message, stack }) {
+            delete format.body;
+            format.success = false;
+            format.error = {
+                message,
+                stack
+            };
+            formatString = JSON.stringify(format);
+        }
+        response.setHeader('Content-Type', 'application/json');
+        response.setHeader('Content-Length', Buffer.byteLength(formatString));
+        response.end(formatString);
+    }
+    /**
+     * HTTP RPC
+     */
+    async rpc(url, action, params, context) {
+        if (!context || !context.traceId) {
+            context = oox.getContext();
+        }
+        const { traceId, caller, sourceIP } = context;
+        const headers = {
+            'Content-Type': 'application/json',
+            'x-trace-id': String(traceId),
+        };
+        if (caller)
+            headers['x-caller'] = String(caller);
+        if (sourceIP)
+            headers['x-real-ip'] = sourceIP;
+        // headers [ 'x-ip' ] = getIPAddress ( 4 ) [ 0 ]
+        const format = await (0, utils_1.httpRequest)(url, {
+            headers
+        }, JSON.stringify({ action, params }));
+        if ('string' === typeof format)
+            throw new Error(format);
+        const { error, body } = format;
+        if (error) {
+            const asyncError = new Error(error.message);
+            throw asyncError;
+        }
+        else {
+            return body;
+        }
+    }
+}
+exports.default = HTTPModule;

package/modules/http/utils.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.httpRequest = exports.parseHTTPBody = exports.stream2buffer = void 0;
+const http = require("node:http");
+/**
+ * Stream => Buffer
+ */
+function stream2buffer(stream, totalLength = 0) {
+    return new Promise(function (resolve, reject) {
+        let buffers = [];
+        stream.on('error', reject);
+        if (totalLength) {
+            stream.on('data', function (data) { buffers.push(data); });
+        }
+        else {
+            stream.on('data', function (data) {
+                buffers.push(data);
+                totalLength += data.length;
+            });
+        }
+        stream.on('end', function () { resolve(Buffer.concat(buffers, totalLength)); });
+    });
+}
+exports.stream2buffer = stream2buffer;
+/**
+ * Request => JSONObject
+ */
+async function parseHTTPBody(request) {
+    if (request.method === 'GET')
+        return null;
+    let contentType = request.headers['content-type'];
+    // application/json; charset=utf-8
+    if (contentType)
+        contentType = contentType.split(';')[0].trim();
+    const contentSize = request.headers['content-length'];
+    const buffer = await stream2buffer(request, +contentSize || 0);
+    if (contentSize && buffer.length !== +contentSize)
+        throw new Error('Content-Length Incorrect');
+    const bodyString = buffer.toString();
+    if ('application/json' === contentType) {
+        return JSON.parse(bodyString);
+    }
+    else {
+        return bodyString;
+    }
+}
+exports.parseHTTPBody = parseHTTPBody;
+/**
+ * http request
+ */
+function httpRequest(url, options, body) {
+    return new Promise(function (resolve, reject) {
+        const request = http.request(url, options, async function (response) {
+            try {
+                const result = await parseHTTPBody(response);
+                resolve(result);
+            }
+            catch (error) {
+                const decoration = new Error(`${response.statusCode} - ${error.message}`);
+                reject(decoration);
+            }
+        });
+        request.on('error', reject);
+        if (body) {
+            request.method = 'POST';
+            request.setHeader('Content-Type', 'application/json');
+            request.setHeader('Content-Length', Buffer.byteLength(body));
+            request.write(body);
+        }
+        request.end();
+    });
+}
+exports.httpRequest = httpRequest;

package/modules/index.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const module_1 = require("./module");
+const http_1 = require("./http");
+class Modules extends module_1.default {
+    /**
+     * the module unique name
+     */
+    name = 'oox:modules';
+    /**
+     * FIFO queue for modules starting
+     */
+    #queue = [];
+    /**
+     * all modules map
+     */
+    #map = new Map();
+    /**
+     * all builtin modules
+     */
+    builtins = {
+        http: new http_1.default,
+    };
+    constructor() {
+        super();
+        this.add(this.builtins.http);
+    }
+    add(module) {
+        if (!module.name || 'string' !== typeof module.name)
+            throw new Error(`Module<${module.name}> has noname`);
+        if (this.#map.has(module.name))
+            throw new Error(`Module<${module.name}> has exists`);
+        this.#map.set(module.name, module);
+        this.#queue.push(module);
+        return this;
+    }
+    get(name) {
+        return this.#map.get(name);
+    }
+    async remove(name) {
+        const module = this.get(name);
+        if (!module)
+            return;
+        await module.stop();
+        const index = this.#queue.indexOf(module);
+        this.#queue.splice(index, 1);
+        this.#map.delete(name);
+    }
+    async serve() {
+        try {
+            for (const module of this.#queue) {
+                if (!module.getConfig().disabled) {
+                    await module.serve();
+                }
+            }
+        }
+        catch (error) {
+            await this.stop();
+            throw error;
+        }
+    }
+    async stop() {
+        for (const module of this.#queue) {
+            await module.stop();
+        }
+    }
+}
+exports.default = Modules;

package/modules/module.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModuleConfig = void 0;
+class ModuleConfig {
+    disabled = false;
+}
+exports.ModuleConfig = ModuleConfig;
+class Module {
+    config;
+    name;
+    setConfig(config) { }
+    getConfig() { return this.config; }
+    async serve() { }
+    async stop() { }
+}
+exports.default = Module;

package/package.json

@@ -1,17 +1,35 @@
 {
-  "name": "oox",
-  "version": "0.1.0",
-  "description": "distributed api service",
-  "main": "index.js",
-  "bin": {
-    "oox": "bin/cli.js"
-  },
-  "author": "lipingruan",
-  "homepage": "https://github.com/lipingruan/oox",
-  "license": "MIT",
-  "dependencies": {
-    "chalk": "^4.1.0",
-    "socket.io": "^4.0.2",
-    "socket.io-client": "^4.0.2"
-  }
-}
+    "name": "oox",
+    "version": "0.3.0-beta2",
+    "description": "Graceful NodeJS distributed application solution",
+    "keywords": [
+        "http",
+        "websocket",
+        "socket.io",
+        "rpc",
+        "microservice",
+        "distributed",
+        "tracing"
+    ],
+    "type": "commonjs",
+    "main": "index.js",
+    "types": "types/index.d.ts",
+    "exports": {
+        "require": "./index.js",
+        "import": "./index.mjs",
+        "types": "./types/index.d.ts"
+    },
+    "bin": {
+        "oox": "bin/cli.js"
+    },
+    "author": "lipingruan",
+    "homepage": "https://github.com/lipingruan/oox",
+    "license": "MIT",
+    "dependencies": {
+        "@oox/module-socketio": "^0.0.1",
+        "chalk": "^4.1.0"
+    },
+    "engines": {
+        "node": ">=12.0.0"
+    }
+}

package/types/app.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { EventEmitter } from 'node:events';
+import { AsyncLocalStorage } from 'node:async_hooks';
+export interface ReturnsBody {
+    traceId: string;
+    success: boolean;
+    body?: any;
+    error?: {
+        message: string;
+        stack: string;
+    };
+}
+export declare class Context {
+    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: '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;
+/**
+ * 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

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

package/types/bin/cli.d.ts

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+export {};

package/types/bin/configurer.d.ts

@@ -0,0 +1 @@
+export declare function configure(): any;

package/types/bin/proxyer.d.ts

@@ -0,0 +1 @@
+export declare function proxyGroup(groupDirectory: string, excludes?: any[]): void;

package/types/bin/register.d.ts

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

package/types/bin/starter.d.ts

@@ -0,0 +1 @@
+export declare function startup(): Promise<void>;

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