oox 0.0.9 → 0.3.0-beta1

package/README.md

@@ -1,4 +1,7 @@
-# OOX
+![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

package/app.js

@@ -0,0 +1,142 @@
+"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 = void 0;
+const node_events_1 = require("node:events");
+const node_async_hooks_1 = require("node:async_hooks");
+const utils_1 = require("./utils");
+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) {
+        /*
+        const sourceMethod = wrappedActions.get ( action )
+
+        const middlewareNames = actionMiddlewares.get ( sourceMethod )
+
+        if ( middlewareNames && middlewareNames.length ) for ( const name of middlewareNames ) {
+
+            const middleware = middlewares.get ( name )
+
+            await middleware ( action, params, context )
+        }
+        */
+        return await target(...params);
+    }
+}
+exports.execute = execute;

package/bin/argv.js

@@ -1,95 +1,70 @@
-
-
-
-exports.getAllEnvArgs = function ( ) {
-
-    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 ] = exports.parseEnvArg ( val )
+"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
+    return env;
 }
-
-
-
-exports.getEnvArgs = function ( names ) {
-
-    const env = { }
-
-    for ( let name of names ) {
-
-        env [ name ] = exports.getEnvArg ( name )
+exports.getAllEnvArgs = getAllEnvArgs;
+function getEnvArgs(names) {
+    const env = {};
+    for (let name of names) {
+        env[name] = getEnvArg(name);
     }
-
-    return env
+    return env;
 }
-
-
-
+exports.getEnvArgs = getEnvArgs;
 // 从命令行参数列表中获取参数值
-exports.getEnvArg = function ( 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 exports.parseEnvArg ( arg )
+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.parseEnvArg = function ( value ) {
-
-    switch ( value ) {
-        case 'no': return false
-        case 'yes': return true
-        case 'nil': return null
+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
-        }
+            try {
+                return JSON.parse(value);
+            }
+            catch (error) {
+                if (value.includes(','))
+                    return value.split(',');
+                return value;
+            }
     }
 }
+exports.parseEnvArg = parseEnvArg;

package/bin/cli.js

@@ -1,58 +1,43 @@
 #! /usr/bin/env node
-
-const chalk = require ( 'chalk' )
-
-const starter = require ( './starter' )
-
-const args = process.argv.slice ( 2 )
-
-const command = args [ 0 ]
-
-var startup = true
-
-if ( !command || [ 'help', '-h', '-help', '--help', 'version', '-v', '-version', '--version' ].includes ( command ) ) {
-
-    startup = false
-
-    const pkg = require ( '../package.json' )
-
-    console.log ( )
-    console.log ( 'OOX Service' )
-    console.log ( chalk.bold`version`, chalk.bold.green`${pkg.version}` )
-    console.log ( chalk.underline`${pkg.homepage}` )
-    console.log ( )
+"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 ( 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:` )
-
+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 global.oox' ],
-        [ '  env          [ file ]  ', '.js or .json file, merge to global.oox', 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>' ],
-        [ '  template     [ file ]  ', 'custom Service class file path' ],
-        [ '  origin       [ urls ]  ', 'set', chalk.bold`*`, 'allow any connections <Access-Control-Allow-Origin>' ],
-        [ '  ...                    ', 'set params as', chalk.bold`foo=bar`+',', 'usage as', chalk.bold`global.oox.foo` ]
-    ]
-
-    params.forEach ( row => console.log ( ...row, '\n' ) )
-    
-    console.log ( )
+        ['  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 ( startup ) starter.startup ( )
+if (isStartup)
+    (0, starter_1.startup)();

package/bin/configurer.js

@@ -1,78 +1,49 @@
-
-const fs = require ( 'fs' )
-
-const path = require ( 'path' )
-
-const argv = require ( './argv' )
-
-
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configure = void 0;
+const fs = require("node:fs");
+const path = require("node:path");
+const argv = require("./argv");
 /**
  * x.y=1 => { x: { y: 1 } }
- * @param {*} env 
  */
-function mergeFlatEnv ( env ) {
-
-    for ( const key of Object.keys ( env ) ) {
-
+function mergeFlatEnv(env) {
+    for (const key of Object.keys(env)) {
         // x.y.z
-        if ( key.includes ( '.' ) && !key.startsWith ( '.' ) && !key.endsWith ( '.' ) ) {
-
-            const subKeys = key.split ( '.' )
-
-            const valueKey = subKeys.pop ( )
-
-            let tmpEnv = env
-
-            for ( subKey of subKeys ) {
-
-                if ( subKey in tmpEnv ) { } else {
-
-                    tmpEnv [ subKey ] = { }
+        if (key.includes('.') && !key.startsWith('.') && !key.endsWith('.')) {
+            const subKeys = key.split('.');
+            const valueKey = subKeys.pop();
+            let tmpEnv = env;
+            for (const subKey of subKeys) {
+                if (subKey in tmpEnv) { }
+                else {
+                    tmpEnv[subKey] = {};
                 }
-
-                tmpEnv = tmpEnv [ subKey ]
+                tmpEnv = tmpEnv[subKey];
             }
-
-            tmpEnv [ valueKey ] = env [ key ]
+            tmpEnv[valueKey] = env[key];
         }
     }
 }
-
-
-
-exports.configure = ( ) => {
-
-    let env = Object.create ( null )
-
-    const defaultEnvPath = argv.getEnvArg ( 'default-env' )
-
-    if ( defaultEnvPath && fs.existsSync ( defaultEnvPath ) ) {
-
-        Object.assign ( env, require ( path.resolve ( defaultEnvPath ) ) )
+function configure() {
+    let env = Object.create(null);
+    const defaultEnvPath = argv.getEnvArg('default-env');
+    if (defaultEnvPath && fs.existsSync(defaultEnvPath)) {
+        Object.assign(env, require(path.resolve(defaultEnvPath)));
     }
-
-
-
-    const envPath = argv.getEnvArg ( 'env' )
-
-    if ( envPath && fs.existsSync ( envPath ) ) {
-
-        Object.assign ( env, require ( path.resolve ( envPath ) ) )
+    const envPath = argv.getEnvArg('env');
+    if (envPath && fs.existsSync(envPath)) {
+        Object.assign(env, require(path.resolve(envPath)));
     }
-
-    Object.assign ( env, argv.getAllEnvArgs ( ) )
-
-    mergeFlatEnv ( env )
-
-    if ( 'string' === typeof env.ignore ) env.ignore = env.ignore.split ( ',' )
-
-    if ( 'string' === typeof env.registry ) env.registry = env.registry.split ( ',' )
-
-    if ( 'string' === typeof env.origin && env.origin.includes ( ',' ) ) {
-
-        env.origin = env.origin.split ( ',' )
+    Object.assign(env, argv.getAllEnvArgs());
+    mergeFlatEnv(env);
+    if ('string' === typeof env.ignore)
+        env.ignore = env.ignore.split(',');
+    if ('string' === typeof env.registry)
+        env.registry = env.registry.split(',');
+    if ('string' === typeof env.origin && env.origin.includes(',')) {
+        env.origin = env.origin.split(',');
     }
-
-    return env
-}
+    return env;
+}
+exports.configure = configure;