oox 0.3.0-beta5 → 0.3.0-beta6

package/app.js

@@ -1,9 +1,11 @@
 "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;
+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");
+// import { wrappedActions, actionMiddlewares, middlewares } from './middleware'
+exports.logger = require("./logger");
 class Context {
     // 请求溯源ID
     traceId = '';

package/bin/loader.mjs

@@ -0,0 +1,279 @@
+
+import path from 'node:path'
+
+import os from 'node:os'
+
+import fs from 'node:fs'
+
+import { get as httpGet } from 'node:http'
+
+import { get as httpsGet } from 'node:https'
+
+import oox from '../index.mjs'
+
+
+
+function generateRPCProxyScript ( name, attributes = [ ] ) {
+
+    let attrExports = ''
+
+    for ( const attr of attributes ) {
+    
+        attrExports += `\nexport const ${attr} = proxyer.${attr}\n`
+    }
+    
+    const script = `
+import oox from 'oox'
+function RPC_${name} ( ) { }
+function dotCall ( name, action ) {
+	
+	return new Proxy ( RPC_${name}, {
+
+        get ( target, key ) {
+
+			return dotCall ( name, action ? action + '.' + key : key )
+		},
+		
+		has ( target, key ) { return true },
+		
+		apply ( target, thisArg, args ) {
+
+            return oox.rpc ( name, action, args )
+		}
+	} )
+}
+const proxyer = dotCall ( '${name}', '' )
+export default proxyer
+${attrExports}
+`
+
+    return script
+}
+
+
+
+function generateRPCProxyURL ( name, attributes ) {
+    
+    let searchText = ''
+
+    if ( attributes.length ) {
+
+        const search = new URLSearchParams ( )
+
+        for ( const attr of attributes ) {
+    
+            search.append ( 'attr', attr )
+        }
+
+        searchText = '?' + search.toString ( )
+    }
+
+    return `oox://rpc/${name}.mjs${searchText}`
+}
+
+
+
+function isWebURL ( url ) {
+
+    return url && ( url.startsWith ( 'https://' ) || url.startsWith ( 'http://' ) )
+}
+
+
+
+function isOOXURL ( url ) {
+
+    return url && url.startsWith ( 'oox://' )
+}
+
+
+
+/**
+ * make ESModule support dynamic <export *> attributes import
+ * @param {string} importerSpecifier the import url
+ * @param {string} specifier parentURL
+ * @returns {string[]}
+ */
+function getImportAttributes ( importerSpecifier, specifier ) {
+
+    const attributes = [ ]
+
+    const contents = fs.readFileSync ( importerSpecifier, 'utf-8' )
+
+    // import * as xxx from "xxx"
+    const mergeImport = contents.match ( new RegExp ( `import.+\\*\\s*as\\s+(\\w+)\\s+from\\s*["']${specifier}["']` ) )
+
+    if ( mergeImport ) {
+
+        const mergeName = mergeImport [ 1 ]
+
+        const attributesIterator = contents.matchAll ( new RegExp ( `${mergeName}\\s*\\.\\s*(\\w+)`, 'g' ) )
+
+        for ( const caseItem of attributesIterator ) {
+
+            attributes.push ( caseItem [ 1 ] )
+        }
+    }
+
+    // import { a, b, c } from 'xxx'
+    const attributeImport = contents.match ( new RegExp ( `import.+{(.+)}\\s*from\\s*["']${specifier}["']` ) )
+
+    if ( attributeImport ) {
+
+        const definedAttributes = attributeImport [ 1 ].split ( ',' ).map ( v => v.trim ( ) ).filter ( v => !v.startsWith ( 'default' ) )
+        
+        attributes.push ( ...definedAttributes )
+    }
+
+    return Array.from ( new Set ( attributes ) )
+}
+
+
+
+/**
+ * @param {string} specifier
+ * @param {{
+ *   conditions: string[],
+ *   parentURL: string | undefined,
+ * }} context
+ * @param {Function} defaultResolve
+ * @returns {Promise<{ url: string }>}
+ */
+export async function resolve ( specifier, context, defaultResolve ) {
+
+    const defaultSpecifer = specifier
+
+    const { parentURL } = context
+
+    // HTTP & HTTPS
+    if ( isWebURL ( specifier ) ) {
+
+        return { url: specifier }
+    } else if ( isWebURL ( parentURL ) && ( specifier.startsWith ( '.' ) || specifier.startsWith ( '/' ) ) ) {
+
+        return { url: new URL ( specifier, parentURL ).href }
+    }
+
+    // OOX special alias for web package
+    if ( specifier === 'oox' ) {
+
+        return {
+            url: 'file://' + path.resolve ( './node_modules/oox/index.mjs' )
+        }
+    }
+
+    const { entryFile } = oox.config
+
+    // Relative specifier concat to absolute path
+    if ( specifier.startsWith ( '.' ) && parentURL ) {
+
+        specifier = path.posix.join ( path.dirname ( parentURL.replace ( 'file://', '' ) ), specifier )
+    }
+
+    // Windows pathname remove root sep
+    if ( os.platform ( ) === 'win32' && specifier.startsWith ( '/' ) ) {
+
+        specifier = specifier.replace ( '/', '' )
+    }
+
+    // OOX RPC Proxy URL generation
+    if ( !specifier.endsWith ( entryFile.path ) && entryFile.group && specifier.startsWith ( entryFile.group ) ) {
+
+        const subSpecifier = specifier.slice ( entryFile.group.length )
+
+        const matchResult = subSpecifier.match ( /^\/?([\w-]+)(\/index)?(\.m?js)?$/ )
+
+        if ( matchResult ) {
+
+            const importerSpecifier = parentURL.replace ( os.platform ( ) === 'win32' ? /file:\/+/ : 'file://', '' )
+            
+            const attributes = getImportAttributes ( importerSpecifier, defaultSpecifer )
+
+            return { url: generateRPCProxyURL ( matchResult [ 1 ], attributes ) }
+        }
+    }
+
+    // restore Windows specifier protocol
+    if ( os.platform ( ) === 'win32' && specifier.includes ( '/' ) && !specifier.startsWith ( 'file://' ) ) {
+
+        specifier = 'file://' + specifier
+    }
+
+    return defaultResolve ( specifier, context, defaultResolve )
+}
+
+
+
+/**
+ * @param {string} url
+ * @param {{
+ *   format: string,
+ * }} context If resolve settled with a `format`, that value is included here.
+ * @param {Function} defaultLoad
+ * @returns {Promise<{
+ *   format: string,
+ *   source: string | ArrayBuffer | SharedArrayBuffer | Uint8Array,
+ * }>}
+ */
+export async function load ( url, context, defaultLoad ) {
+
+    if ( isWebURL ( url ) || isOOXURL ( url ) ) {
+
+        return getSource ( url, context, defaultLoad )
+    }
+
+    return defaultLoad ( url, context, defaultLoad )
+}
+
+
+
+export function getFormat ( url, context, defaultGetFormat ) {
+
+    if ( isWebURL ( url ) || isOOXURL ( url ) ) {
+
+        return {
+            format: 'module'
+        }
+    }
+
+    return defaultGetFormat ( url, context, defaultGetFormat )
+}
+
+
+
+export function getSource ( url, context, defaultGetSource ) {
+
+    if ( isWebURL ( url ) ) {
+
+        const getMethod = url.startsWith ( 'https://' ) ? httpsGet : httpGet
+
+        return new Promise ( ( resolve, reject ) => getMethod ( url, res => {
+            let source = ''
+            res
+            .on ( 'data', chunk => source += chunk )
+            .on ( 'end', () => resolve ( { format: 'module', source } ) )
+        } ).on ( 'error', reject ) )
+    } else if ( isOOXURL ( url ) ) {
+
+        const mURL = new URL ( url )
+
+        if ( mURL.host === 'rpc' ) {
+
+            const regexp = /\/([\w-]+)\.mjs$/
+
+            const matchResult = mURL.pathname.match ( regexp )
+
+            // read all import attributes
+            const attributes = mURL.searchParams.getAll ( 'attr' )
+        
+            const source = generateRPCProxyScript ( matchResult [ 1 ], attributes )
+
+            return { format: 'module', source }
+        }
+    }
+  
+    return defaultGetSource ( url, context, defaultGetSource )
+}
+
+
+
+process.on ( 'unhandledRejection', console.error )

package/bin/starter.js

@@ -24,10 +24,11 @@ function getEntryFile(env) {
     var name = filename === 'index.js' && groupFullDirectory !== fullDirectory ? directory : filename.split('.js')[0];
     return { name, path: fullPath, group: groupFullDirectory };
 }
-function loadEntry(name, entryPath) {
+async function loadEntry(name, entryPath) {
     oox.config.name = name;
-    const methods = require(entryPath);
-    oox.setMethods(methods);
+    // Typescript 4.7.3, not supported import() expression
+    const methods = await eval(`import('file://${entryPath.replace(/\\/g, '/')}')`);
+    oox.setMethods(methods.default || methods);
 }
 async function startup() {
     // 加载环境变量
@@ -35,6 +36,10 @@ async function startup() {
     Object.assign(oox.config, env);
     // 获取服务入口地址
     const entryFile = getEntryFile(env);
+    oox.config.entryFile = {
+        path: entryFile.path.replace(/\\/g, '/'),
+        group: entryFile.group.replace(/\\/g, '/'),
+    };
     // 代理<服务间调用>
     if (env.group) {
         const excludes = [entryFile.name];
@@ -43,28 +48,10 @@ async function startup() {
         (0, proxyer_1.proxyGroup)(entryFile.group, excludes);
     }
     // 加载服务
-    loadEntry(entryFile.name, entryFile.path);
-    // 服务配置
-    if (!env.port && !env.http && !env.socketio)
-        env.port = 0;
+    await loadEntry(entryFile.name, entryFile.path);
+    // 模块配置
+    oox.modules.setConfig(oox.config);
     const httpConfig = oox.modules.builtins.http.config, socketioConfig = socketio.config;
-    if ('number' === typeof env.port) {
-        httpConfig.port = socketioConfig.port = env.port;
-    }
-    if (env.origin)
-        httpConfig.origin = env.origin;
-    if ('http' in env) {
-        if (env.http)
-            Object.assign(httpConfig, env.http);
-        else
-            httpConfig.disabled = true;
-    }
-    if ('socketio' in env) {
-        if (env.socketio)
-            Object.assign(socketioConfig, env.socketio);
-        else
-            socketioConfig.disabled = true;
-    }
     // 服务启动
     await oox.serve();
     console.log();

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rpc = exports.removeKeepAliveConnection = exports.addKeepAliveConnection = exports.getKeepAliveConnection = exports.getKeepAliveConnections = exports.keepAliveConnections = exports.RPCKeepAliveConnection = exports.stop = exports.serve = exports.getContext = exports.genContext = exports.genTraceId = exports.setGenTraceIdFunction = exports.getConfig = exports.config = exports.Config = exports.Context = exports.on = exports.execute = exports.call = exports.sourceKVMethods = exports.kvMethods = exports.getMethods = exports.setMethods = exports.asyncStore = exports.modules = exports.ModuleConfig = exports.Module = void 0;
+exports.rpc = exports.removeKeepAliveConnection = exports.addKeepAliveConnection = exports.getKeepAliveConnection = exports.getKeepAliveConnections = exports.keepAliveConnections = exports.RPCKeepAliveConnection = exports.stop = exports.serve = exports.getContext = exports.genContext = exports.genTraceId = exports.setGenTraceIdFunction = exports.config = exports.Config = exports.Context = exports.on = exports.execute = exports.call = exports.sourceKVMethods = exports.kvMethods = exports.getMethods = exports.setMethods = exports.asyncStore = exports.modules = exports.ModuleConfig = exports.Module = void 0;
 const node_crypto_1 = require("node:crypto");
 const app = require("./app");
 const utils_1 = require("./utils");
@@ -31,14 +31,22 @@ exports.Context = Context;
 class Config {
     // 服务名称
     name = 'local';
+    // 启动文件
+    entryFile = {
+        // 启动文件路径
+        path: '',
+        // 服务列表路径
+        group: '',
+    };
     // 主机地址
     host = (0, utils_1.getIPAddress)(4)[0];
+    // 默认监听端口
+    port = 0;
+    // 默认跨域设置
+    origin = '';
 }
 exports.Config = Config;
 exports.config = new Config();
-function getConfig() {
-}
-exports.getConfig = getConfig;
 let genTraceIdFunction = () => (0, node_crypto_1.randomUUID)();
 function setGenTraceIdFunction(fn) {
     genTraceIdFunction = fn;

package/index.mjs

@@ -1,4 +1,5 @@
 
 import * as oox from './index.js'
 
+export * from './index.js'
 export default oox

package/logger.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.error = exports.warning = exports.info = void 0;
+const app_1 = require("./app");
+function log(tag, ...msgs) {
+    const context = app_1.asyncStore.getStore();
+    app_1.eventHub.emit('log', context, { tag, msgs });
+}
+function info(...msgs) {
+    return log('info', ...msgs);
+}
+exports.info = info;
+function warning(...msgs) {
+    return log('warning', ...msgs);
+}
+exports.warning = warning;
+function error(...msgs) {
+    return log('error', ...msgs);
+}
+exports.error = error;

package/modules/http/index.js

@@ -20,6 +20,12 @@ class HTTPModule extends module_1.default {
     server = null;
     setConfig(config) {
         Object.assign(this.config, config);
+        if (!config.hasOwnProperty('port')) {
+            this.config.port = oox.config.port;
+        }
+        if (!config.hasOwnProperty('origin')) {
+            this.config.origin = oox.config.origin;
+        }
     }
     getConfig() {
         return this.config;

package/modules/index.js

@@ -57,6 +57,10 @@ class Modules extends module_1.default {
                     module.setConfig({ disabled: true });
                 }
             }
+            else {
+                module.setConfig({});
+            }
+            config[module.name] = module.getConfig();
         }
     }
     async serve() {

package/package.json

@@ -1,12 +1,13 @@
 {
     "name": "oox",
-    "version": "0.3.0-beta5",
+    "version": "0.3.0-beta6",
     "description": "Graceful NodeJS distributed application solution",
     "keywords": [
         "http",
         "websocket",
         "socket.io",
         "rpc",
+        "framework",
         "microservice",
         "distributed",
         "tracing"
@@ -15,9 +16,11 @@
     "main": "index.js",
     "types": "types/index.d.ts",
     "exports": {
-        "require": "./index.js",
-        "import": "./index.mjs",
-        "types": "./types/index.d.ts"
+        ".": {
+            "import": "./index.mjs",
+            "require": "./index.js"
+        },
+        "./loader": "./bin/loader.mjs"
     },
     "bin": {
         "oox": "bin/cli.js"
@@ -26,7 +29,7 @@
     "homepage": "https://github.com/lipingruan/oox",
     "license": "MIT",
     "dependencies": {
-        "@oox/module-socketio": "^0.0.3",
+        "@oox/module-socketio": "../oox-module-socketio/dist/",
         "chalk": "^4.1.0"
     },
     "engines": {

package/types/app.d.ts

@@ -2,6 +2,7 @@
 /// <reference types="node" />
 import { EventEmitter } from 'node:events';
 import { AsyncLocalStorage } from 'node:async_hooks';
+export * as logger from './logger';
 export interface ReturnsBody {
     traceId: string;
     success: boolean;
@@ -12,6 +13,7 @@ export interface ReturnsBody {
     };
 }
 export declare class Context {
+    [x: string]: any;
     traceId?: string;
 }
 export declare const asyncStore: AsyncLocalStorage<Context>;
@@ -26,6 +28,7 @@ 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;
+export declare function on(event: 'log', listener: (context: Context, ...msgs: any[]) => void): void;
 /**
  * Call an Function on RPC server
  * @param action

package/types/index.d.ts

@@ -17,10 +17,15 @@ export declare class Context extends app.Context {
 export declare class Config {
     [x: string]: any;
     name: string;
+    entryFile: {
+        path: string;
+        group: string;
+    };
     host: string;
+    port: number;
+    origin: string;
 }
 export declare const config: Config;
-export declare function getConfig(): void;
 export declare function setGenTraceIdFunction(fn: () => string): void;
 /**
  * 生成随机不重复id

package/types/logger.d.ts

@@ -0,0 +1,3 @@
+export declare function info(...msgs: any[]): void;
+export declare function warning(...msgs: any[]): void;
+export declare function error(...msgs: any[]): void;