oox 0.3.0-beta8 → 0.3.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 lipingruan
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 lipingruan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,32 +1,29 @@
-![oox-logo-dark](https://user-images.githubusercontent.com/16621637/146079784-d4d5805f-903d-44bd-998e-ff374b91ccb4.png#gh-light-mode-only)
-
-![oox-logo-light](https://user-images.githubusercontent.com/16621637/146079978-29a0b6fc-ec6d-4d8f-9b80-9a089f716405.png#gh-dark-mode-only)
-
-graceful microservice framework.
-
-### Features
-- [x] HTTP & socket.io support (native SSL coming soon)
-- [x] Zero configure startup
-- [x] Non-invasive coding style
-- [x] Intuitive route style
-- [x] Intuitive RPC style
-- [x] Anywhere interceptor
-- [x] Distributed tracing
-- [x] Service nodes expand infinitely
-- [x] Automatic service discovery (P2P)
-- [x] Automatic load balancing (support customization)
-- [x] `Distributed / Standalone` seamless handoff
-- [x] Highly customizable
-
-### Installation
-```bash
-npm install -g oox
-```
-
-### Usage
-```bash
-oox --help
-```
-
-### Documentation
-[oox.js.org](https://oox.js.org/)
+![oox-logo-dark](https://user-images.githubusercontent.com/16621637/146079784-d4d5805f-903d-44bd-998e-ff374b91ccb4.png#gh-light-mode-only)
+
+![oox-logo-light](https://user-images.githubusercontent.com/16621637/146079978-29a0b6fc-ec6d-4d8f-9b80-9a089f716405.png#gh-dark-mode-only)
+
+graceful microservice framework.
+
+### Features
+- [x] HTTP & socket.io support (native SSL supported)
+- [x] Zero configure startup
+- [x] Non-invasive coding style
+- [x] Intuitive route style
+- [x] Intuitive RPC style
+- [x] Anywhere interceptor
+- [x] Distributed tracing
+- [x] Service nodes expand infinitely
+- [x] Automatic service discovery (P2P)
+- [x] Automatic load balancing (support customization)
+- [x] `Distributed / Standalone` seamless handoff
+- [x] Highly customizable
+
+### Installation
+```bash
+npm install oox
+```
+
+### Usage
+```bash
+npx oox --help
+```

package/app.js

@@ -1,131 +1,131 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.execute = exports.call = exports.on = exports.getMethods = exports.setMethods = exports.sourceKVMethods = exports.kvMethods = exports.eventHub = exports.asyncStore = exports.Context = exports.logger = void 0;
-const node_events_1 = require("node:events");
-const node_async_hooks_1 = require("node:async_hooks");
-const utils_1 = require("./utils");
-exports.logger = require("./logger");
-class Context {
-    // 请求溯源ID
-    traceId = '';
-}
-exports.Context = Context;
-exports.asyncStore = new node_async_hooks_1.AsyncLocalStorage();
-exports.eventHub = new node_events_1.EventEmitter();
-/**
- * sourceMethods => methods
- */
-let sourceMethods = {};
-/**
- * the kvMethods is all actions refs [has bind this]
- */
-exports.kvMethods = new Map();
-exports.sourceKVMethods = new Map();
-function setMethods(methods) {
-    sourceMethods = methods;
-    exports.kvMethods.clear();
-    exports.sourceKVMethods.clear();
-    (0, utils_1.genKVMethods)(methods, exports.kvMethods, exports.sourceKVMethods);
-}
-exports.setMethods = setMethods;
-function getMethods() {
-    return sourceMethods;
-}
-exports.getMethods = getMethods;
-function on(event, listener) {
-    return exports.eventHub.on(event, listener);
-}
-exports.on = on;
-/**
- * Call an Function on RPC server
- * @param action
- * @param params
- * @param context
- * @returns
- */
-async function call(action, params = [], context) {
-    if (!Array.isArray(params))
-        params = [params];
-    const { traceId } = context;
-    exports.eventHub.emit('request', action, params, context);
-    const returns = {
-        traceId,
-        success: false
-    };
-    try {
-        const result = await execute(action, [...params], context);
-        returns.body = result;
-        returns.success = true;
-        exports.eventHub.emit('success', action, params, context, result);
-    }
-    catch (error) {
-        returns.error = {
-            message: error.message,
-            stack: error.stack
-        };
-        exports.eventHub.emit('fail', action, params, context, error);
-    }
-    finally {
-        return returns;
-    }
-}
-exports.call = call;
-async function execute(action, params, context) {
-    const __proxy = '__proxy', _proxy = '_proxy';
-    if (__proxy === action || _proxy === action || action.endsWith(_proxy))
-        throw new Error('Invalid Action[' + action + ']');
-    const methods = exports.kvMethods;
-    // 目标函数
-    const target = methods.get(action);
-    // 目标代理函数
-    const targetProxy = methods.get(action + _proxy);
-    // 即不存在目标也不存在目标代理时, 报错函数不存在
-    if (!target && !targetProxy)
-        throw new Error('Unknown Action [' + action + ']');
-    exports.asyncStore.enterWith(context);
-    // ============================ PROXY BEGIN ============================
-    // 最顶层代理
-    const topProxy = methods.get(__proxy);
-    if (topProxy) {
-        const proxyReturns = await topProxy(action, params, context);
-        if (proxyReturns !== undefined)
-            return proxyReturns;
-    }
-    // 'x.y.z' => [ 'x', 'y', 'z' ]
-    const nameStack = action.split('.'), size = nameStack.length - 1;
-    let index = -1, proxyPrefix = '';
-    // 根代理遍历
-    while (++index < size) {
-        // x.
-        // x.y.
-        proxyPrefix += nameStack[index] + '.';
-        // x.__proxy
-        // x.y.__proxy
-        const rootProxy = methods.get(proxyPrefix + __proxy);
-        // x.__proxy ( 'y.z', ... )
-        // x.y.__proxy ( 'z', ... )
-        if (rootProxy) {
-            const proxyReturns = await rootProxy(nameStack.slice(index).join('.'), params, context);
-            if (proxyReturns !== undefined)
-                return proxyReturns;
-        }
-    }
-    // 同级代理
-    const layerProxy = methods.get(proxyPrefix + _proxy);
-    if (layerProxy) {
-        const proxyReturns = await layerProxy(nameStack[index], params, context);
-        if (proxyReturns !== undefined)
-            return proxyReturns;
-    }
-    if (targetProxy) {
-        const proxyReturns = await targetProxy(params, context);
-        if (proxyReturns !== undefined)
-            return proxyReturns;
-    }
-    // ============================= PROXY END =============================
-    // make sure target action execute after all proxies
-    if (target) {
-        return await target(...params);
-    }
-}
-exports.execute = execute;
+import { EventEmitter } from 'node:events';
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { genKVMethods } from './utils.js';
+export * as logger from './logger.js';
+export class Context {
+    // 请求溯源ID
+    traceId = '';
+}
+export const asyncStore = new AsyncLocalStorage();
+export const eventHub = new EventEmitter();
+/**
+ * sourceMethods => methods
+ */
+let sourceMethods = {};
+/**
+ * the kvMethods is all actions refs [has bind this]
+ */
+export const kvMethods = new Map();
+export const sourceKVMethods = new Map();
+export function setMethods(methods) {
+    sourceMethods = methods;
+    kvMethods.clear();
+    sourceKVMethods.clear();
+    genKVMethods(methods, kvMethods, sourceKVMethods);
+}
+export function getMethods() {
+    return sourceMethods;
+}
+export function on(event, listener) {
+    eventHub.on(event, listener);
+}
+export function once(event, listener) {
+    eventHub.once(event, listener);
+}
+export function off(event, listener) {
+    eventHub.off(event, listener);
+}
+export function emit(event, ...args) {
+    return eventHub.emit(event, ...args);
+}
+/**
+ * Call an Function on RPC server
+ * @param action
+ * @param params
+ * @param context
+ * @returns
+ */
+export async function call(action, params = [], context) {
+    asyncStore.enterWith(context);
+    if (!Array.isArray(params))
+        params = [params];
+    const { traceId } = context;
+    emit('call:start', Date.now(), action, params, context);
+    const returns = {
+        traceId,
+        success: true
+    };
+    try {
+        const result = await execute(action, [...params], context);
+        returns.body = result;
+        emit('call:success', Date.now(), action, params, context, result);
+    }
+    catch (error) {
+        returns.success = false;
+        returns.error = {
+            message: error.message,
+            stack: error.stack
+        };
+        emit('call:fail', Date.now(), action, params, context, error);
+    }
+    finally {
+        return returns;
+    }
+}
+export async function execute(action, params, context) {
+    const __proxy = '__proxy', _proxy = '_proxy';
+    if (__proxy === action || _proxy === action || action.endsWith(_proxy))
+        throw new Error('Invalid Action[' + action + ']');
+    const methods = kvMethods;
+    // 目标函数
+    const target = methods.get(action);
+    // 目标代理函数
+    const targetProxy = methods.get(action + _proxy);
+    // 即不存在目标也不存在目标代理时, 报错函数不存在
+    if (!target && !targetProxy)
+        throw new Error('Unknown Action [' + action + ']');
+    // ============================ PROXY BEGIN ============================
+    // 最顶层代理
+    const topProxy = methods.get(__proxy);
+    if (topProxy) {
+        const proxyReturns = await topProxy(action, params, context);
+        if (proxyReturns !== undefined)
+            return proxyReturns;
+    }
+    // 'x.y.z' => [ 'x', 'y', 'z' ]
+    const nameStack = action.split('.'), size = nameStack.length - 1;
+    let index = -1, proxyPrefix = '';
+    // 根代理遍历
+    while (++index < size) {
+        // x.
+        // x.y.
+        proxyPrefix += nameStack[index] + '.';
+        // x.__proxy
+        // x.y.__proxy
+        const rootProxy = methods.get(proxyPrefix + __proxy);
+        // x.__proxy ( 'y.z', ... )
+        // x.y.__proxy ( 'z', ... )
+        if (rootProxy) {
+            const proxyReturns = await rootProxy(nameStack.slice(index).join('.'), params, context);
+            if (proxyReturns !== undefined)
+                return proxyReturns;
+        }
+    }
+    // 同级代理
+    const layerProxy = methods.get(proxyPrefix + _proxy);
+    if (layerProxy) {
+        const proxyReturns = await layerProxy(nameStack[index], params, context);
+        if (proxyReturns !== undefined)
+            return proxyReturns;
+    }
+    if (targetProxy) {
+        const proxyReturns = await targetProxy(params, context);
+        if (proxyReturns !== undefined)
+            return proxyReturns;
+    }
+    // ============================= PROXY END =============================
+    // make sure target action execute after all proxies
+    if (target) {
+        return await target(...params);
+    }
+}

package/bin/argv.js

@@ -1,70 +1,63 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseEnvArg = exports.getEnvArg = exports.getEnvArgs = exports.getAllEnvArgs = void 0;
-function getAllEnvArgs() {
-    const args = process.argv.slice(2);
-    const env = {};
-    for (const arg of args) {
-        if (arg.startsWith('--')) {
-            env[arg.slice(2)] = true;
-        }
-        else if (arg.startsWith('-')) {
-            env[arg.slice(1)] = true;
-        }
-        else if (!arg.includes('=')) {
-            env[arg] = true;
-        }
-        else {
-            const index = arg.indexOf('=');
-            const key = arg.slice(0, index);
-            const val = arg.slice(index + 1);
-            env[key] = parseEnvArg(val);
-        }
-    }
-    return env;
-}
-exports.getAllEnvArgs = getAllEnvArgs;
-function getEnvArgs(names) {
-    const env = {};
-    for (let name of names) {
-        env[name] = getEnvArg(name);
-    }
-    return env;
-}
-exports.getEnvArgs = getEnvArgs;
-// 从命令行参数列表中获取参数值
-function getEnvArg(name) {
-    if (process.argv.includes(name) ||
-        process.argv.includes('-' + name) ||
-        process.argv.includes('--' + name)) {
-        return true;
-    }
-    else {
-        const prefix = name + '=';
-        const [argv] = process.argv.filter(arg => arg.startsWith(prefix));
-        if (!argv)
-            return null;
-        const arg = argv.slice(prefix.length);
-        return parseEnvArg(arg);
-    }
-}
-exports.getEnvArg = getEnvArg;
-function parseEnvArg(value) {
-    switch (value) {
-        case 'no': return false;
-        case 'yes': return true;
-        case 'none':
-        case 'NULL':
-        case 'nil': return null;
-        default:
-            try {
-                return JSON.parse(value);
-            }
-            catch (error) {
-                if (value.includes(','))
-                    return value.split(',');
-                return value;
-            }
-    }
-}
-exports.parseEnvArg = parseEnvArg;
+export function getAllEnvArgs() {
+    const args = process.argv.slice(2);
+    const env = {};
+    for (const arg of args) {
+        if (arg.startsWith('--')) {
+            env[arg.slice(2)] = true;
+        }
+        else if (arg.startsWith('-')) {
+            env[arg.slice(1)] = true;
+        }
+        else if (!arg.includes('=')) {
+            env[arg] = true;
+        }
+        else {
+            const index = arg.indexOf('=');
+            const key = arg.slice(0, index);
+            const val = arg.slice(index + 1);
+            env[key] = parseEnvArg(val);
+        }
+    }
+    return env;
+}
+export function getEnvArgs(names) {
+    const env = {};
+    for (let name of names) {
+        env[name] = getEnvArg(name);
+    }
+    return env;
+}
+// 从命令行参数列表中获取参数值
+export function getEnvArg(name) {
+    if (process.argv.includes(name) ||
+        process.argv.includes('-' + name) ||
+        process.argv.includes('--' + name)) {
+        return true;
+    }
+    else {
+        const prefix = name + '=';
+        const argv = process.argv.filter(arg => arg.startsWith(prefix)).pop();
+        if (!argv)
+            return null;
+        const arg = argv.slice(prefix.length);
+        return parseEnvArg(arg);
+    }
+}
+export function parseEnvArg(value) {
+    switch (value) {
+        case 'no': return false;
+        case 'yes': return true;
+        case 'none':
+        case 'NULL':
+        case 'nil': return null;
+        default:
+            try {
+                return JSON.parse(value);
+            }
+            catch (error) {
+                if (value.includes(','))
+                    return value.split(',');
+                return value;
+            }
+    }
+}

package/bin/cli.js

@@ -1,43 +1,57 @@
-#! /usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chalk_1 = require("chalk");
-const starter_1 = require("./starter");
-const pkg = require("../package.json");
-const args = process.argv.slice(2);
-const command = args[0];
-var isStartup = true;
-if (!command || ['help', '-h', '-help', '--help', 'version', '-v', '-version', '--version'].includes(command)) {
-    isStartup = false;
-    console.log();
-    console.log('OOX Service');
-    console.log((0, chalk_1.bold) `version`, chalk_1.bold.green `${pkg.version}`);
-    console.log((0, chalk_1.underline) `${pkg.homepage}`);
-    console.log();
-}
-if (['help', '-h', '-help', '--help'].includes(command)) {
-    console.log((0, chalk_1.bold) `Usage:`);
-    console.log('  oox entry.js');
-    console.log();
-    console.log('  oox entry.js port=8080');
-    console.log();
-    console.log('  oox app/entry/index.js group=app/ env=envs/entry.js ignore=core');
-    console.log();
-    console.log((0, chalk_1.bold) `Params:`);
-    const params = [
-        ['  default-env  [ file ]  ', '.js or .json file, merge to oox.config'],
-        ['  env          [ file ]  ', '.js or .json file, merge to oox.config', (0, chalk_1.bold) `(after default-env)`],
-        ['  port         [ int  ]  ', 'set', (0, chalk_1.bold) `0`, 'for random port, or any integer > 0'],
-        ['  group        [ dir  ]  ', 'service group directory, all LocalCall transform to RPC'],
-        ['  ignore       [ name ]  ', 'set a name for LocalCall do not transform to RPC, support string | array<string>'],
-        ['  http         [ json ]  ', 'HTTP server options, support flat name, ex: http.path=/api'],
-        ['  socketio     [ json ]  ', 'SocketIO server options, support flat name'],
-        ['  registry     [ urls ]  ', 'registry service url, support string | array<string>'],
-        ['  origin       [ urls ]  ', 'set', (0, chalk_1.bold) `*`, 'allow any connections <Access-Control-Allow-Origin>'],
-        ['  ...                    ', 'set params as', (0, chalk_1.bold) `foo=bar` + ',', 'usage as', (0, chalk_1.bold) `oox.config.foo`]
-    ];
-    params.forEach(row => console.log(...row, '\n'));
-    console.log();
-}
-if (isStartup)
-    (0, starter_1.startup)();
+#! /usr/bin/env node
+import chalk from 'chalk';
+import { fileURLToPath } from 'node:url';
+import * as oox from '../index.js';
+import { configure, startup } from './starter.js';
+import { inGroupConvertRequireToRPC } from './proxy-require.js';
+import { registModuleLoader } from './proxy-import.js';
+import pkg from '../package.json' with { type: 'json' };
+export const version = pkg.version;
+export { configure, startup, inGroupConvertRequireToRPC, registModuleLoader, };
+const execFilename = process.argv[1];
+if (execFilename.endsWith('oox') || fileURLToPath(import.meta.url) === execFilename) {
+    const args = process.argv.slice(2);
+    const command = args[0];
+    var isStartup = true;
+    if (!command || ['help', '-h', '-help', '--help', 'version', '-v', '-version', '--version'].includes(command)) {
+        isStartup = false;
+        console.log();
+        console.log('OOX Service Engine');
+        console.log(chalk.bold('version'), chalk.bold.green(`${pkg.version}`));
+        console.log(chalk.underline(`${pkg.homepage}`));
+        console.log();
+    }
+    if (['help', '-h', '-help', '--help'].includes(command)) {
+        console.log(chalk.bold('Usage:'));
+        console.log('  oox entry.js');
+        console.log();
+        console.log('  oox entry.js port=8080');
+        console.log();
+        console.log('  oox app/entry/index.js group=app/ env=envs/entry.js ignore=core');
+        console.log();
+        console.log(chalk.bold('Params:'));
+        const params = [
+            ['  default-env  [ file ]  ', '.js or .json file, merge to oox.config'],
+            ['  env          [ file ]  ', '.js or .json file, merge to oox.config', chalk.bold('(after default-env)')],
+            ['  port         [ int  ]  ', 'set', chalk.bold('0'), 'for random port, or any integer > 0'],
+            ['  group        [ dir  ]  ', 'service group directory, all LocalCall transform to RPC'],
+            ['  ignore       [ name ]  ', 'set a name for LocalCall do not transform to RPC, support string | array<string>'],
+            ['  http         [ json ]  ', 'HTTP server options, support flat name, ex: http.path=/api'],
+            ['  socketio     [ json ]  ', 'SocketIO server options, support flat name'],
+            ['  registry     [ urls ]  ', 'registry service url, support string | array<string>'],
+            ['  origin       [ urls ]  ', 'set', chalk.bold('*'), 'allow any connections <Access-Control-Allow-Origin>'],
+            ['  errorStack  [ bool ]  ', 'set no to hidden error stack return'],
+            ['  ...                    ', 'set params as', chalk.bold('foo=bar') + ',', 'usage as', chalk.bold('oox.config.foo')]
+        ];
+        params.forEach(row => console.log(...row, '\n'));
+        console.log();
+    }
+    if (isStartup) {
+        await configure();
+        if (oox.config.group) {
+            inGroupConvertRequireToRPC();
+            await registModuleLoader();
+        }
+        await startup();
+    }
+}