oox 0.0.9 → 0.3.0-beta1

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,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("node:path");
+const module_1 = require("./module");
+const http_1 = require("./http");
+const socketio_1 = require("./socketio");
+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,
+        socketio: new socketio_1.default
+    };
+    constructor() {
+        super();
+        this.add(this.builtins.http)
+            .add(this.builtins.socketio);
+    }
+    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.name === 'oox:socketio') {
+                    // http & socketio shared port
+                    const _socketio = module, _http = this.builtins.http;
+                    const httpConfig = this.builtins.http.getConfig(), socketioConfig = _socketio.getConfig();
+                    let isShareServer = false;
+                    // 都没设置端口
+                    isShareServer = !httpConfig.port && !socketioConfig.port;
+                    // 都设置相同端口
+                    isShareServer = isShareServer || httpConfig.port === socketioConfig.port;
+                    // http 模块未被禁用
+                    isShareServer = isShareServer && !httpConfig.disabled;
+                    if (isShareServer) {
+                        socketioConfig.path = path.posix.join(httpConfig.path, socketioConfig.path);
+                        _socketio.server = _http.server;
+                    }
+                }
+                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/modules/socketio/client.js

@@ -0,0 +1,101 @@
+"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

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