oox 0.3.7 → 0.3.8

package/bin/starter.js

@@ -56,8 +56,8 @@ export async function startup() {
     await loadEntry(config.name, config.entryInfo.path);
     // 服务启动
     await oox.serve();
+    // 服务启动完成
     oox.emit('app:served');
-    const { http } = oox.modules.builtins;
     console.log();
     console.log('Service', chalk.bold(`${oox.config.name}`), 'running.');
     // 打包服务地址

package/modules/index.js

@@ -1,4 +1,4 @@
-import HTTP from './http/index.js';
+import HTTP from '@oox/http';
 /**
  * FIFO queue for modules starting
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "oox",
-    "version": "0.3.7",
+    "version": "0.3.8",
     "description": "OOX Service Engine",
     "keywords": [
         "http",
@@ -40,6 +40,7 @@
     "homepage": "https://gitee.com/lipingruan/oox",
     "license": "MIT",
     "dependencies": {
+        "@oox/http": "^1.0.0",
         "chalk": "^5.6.2"
     },
     "engines": {

package/types/modules/index.d.ts

@@ -1,5 +1,5 @@
 import { Module } from './module.js';
-import HTTP from './http/index.js';
+import HTTP from '@oox/http';
 /**
  * FIFO queue for modules starting
  */

package/modules/http/index.js

@@ -1,278 +0,0 @@
-import * as http from 'node:http';
-import * as https from 'node:https';
-import { parseHTTPBody } from './utils.js';
-import Router from './router.js';
-import * as oox from '../../index.js';
-import { Module } from '../module.js';
-export class HTTPConfig {
-    enabled = true;
-    // listen port
-    port = 0;
-    // service path
-    path = '/';
-    // browser cross origin
-    origin = '';
-    // https options
-    ssl = {
-        // enable https
-        enabled: false,
-        // ssl certificate path
-        cert: '',
-        // ssl private key path
-        key: '',
-        // ssl ca path
-        ca: ''
-    };
-}
-export default class HTTPModule extends Module {
-    name = 'http';
-    config = new HTTPConfig;
-    server = null;
-    router = new Router();
-    getURL() {
-        const { host } = oox.config;
-        const { port, path } = this.config;
-        const protocol = this.config.ssl.enabled ? `https:` : `http:`;
-        return new URL(`${protocol}//${host}:${port}${path}`);
-    }
-    // 注册GET路由
-    get(path, ...args) {
-        this.router.get(path, ...args);
-        return this;
-    }
-    // 注册POST路由
-    post(path, ...args) {
-        this.router.post(path, ...args);
-        return this;
-    }
-    // 注册PUT路由
-    put(path, ...args) {
-        this.router.put(path, ...args);
-        return this;
-    }
-    // 注册DELETE路由
-    delete(path, ...args) {
-        this.router.delete(path, ...args);
-        return this;
-    }
-    // 注册全局中间件
-    use(middleware) {
-        this.router.use(middleware);
-        return this;
-    }
-    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;
-    }
-    get serviceURL() {
-        return this.getURL();
-    }
-    /**
-     * start http service
-     */
-    async serve() {
-        await this.stop();
-        const { port, ssl } = this.config;
-        if (ssl.enabled) {
-            const fs = await import('node:fs');
-            const options = {
-                key: ssl.key ? fs.readFileSync(ssl.key) : undefined,
-                cert: ssl.cert ? fs.readFileSync(ssl.cert) : undefined,
-                ca: ssl.ca ? fs.readFileSync(ssl.ca) : undefined
-            };
-            if (!options.key || !options.cert) {
-                throw new Error('HTTPS enabled but missing key or cert');
-            }
-            this.server = https.createServer(options, this.requestHandler.bind(this));
-        }
-        else {
-            this.server = http.createServer(this.requestHandler.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
-     */
-    async stop() {
-        const { server } = this;
-        if (!server || !server.listening)
-            return Promise.resolve();
-        return new Promise((resolve, reject) => {
-            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) {
-            let allow = false;
-            if ('string' === typeof origin) {
-                allow = origin === '*' || new RegExp(origin).test(requestOrigin);
-            }
-            else if (Array.isArray(origin)) {
-                allow = origin.some(item => item === '*' || new RegExp(item).test(requestOrigin));
-            }
-            if (allow) {
-                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,x-token,content-type');
-            response.setHeader('Access-Control-Allow-Methods', '*');
-        }
-        if (request.method === 'OPTIONS') {
-            response.statusCode = 204;
-            response.end();
-            return false;
-        }
-        return true;
-    }
-    async requestHandler(request, response) {
-        const url = new URL(request.url || '', `http://${request.headers.host || 'localhost'}`);
-        const method = request.method || 'GET';
-        // 尝试匹配路由
-        const matched = this.router.match(method, url.pathname);
-        if (matched) {
-            const req = this.router.createRequestObject(request, url);
-            const res = this.router.createResponseObject(response);
-            // 解析请求体
-            if (request.method !== 'GET' && request.method !== 'HEAD') {
-                try {
-                    req.body = await parseHTTPBody(request);
-                }
-                catch (error) {
-                    return this.respond(request, response, {
-                        success: false,
-                        error: {
-                            message: error.message,
-                            stack: error.stack
-                        }
-                    });
-                }
-            }
-            await this.router.handleRoute(matched.route, matched.params, req, res);
-            return;
-        }
-        // 内置cors仅处理RPC请求
-        if (!this.cors(request, response))
-            return;
-        // 回退到RPC调用
-        if (url.pathname === this.config.path) {
-            await this.call(request, response);
-        }
-        else {
-            const error = new Error('Invalid URL');
-            return this.respond(request, response, {
-                success: false,
-                error: {
-                    message: error.message,
-                    stack: error.stack
-                }
-            });
-        }
-    }
-    /**
-     * 从请求里获取调用的接口和参数
-     */
-    async getCallArgsFromRequest(request) {
-        const args = await parseHTTPBody(request);
-        if (!args || 'object' !== typeof args || !args.action)
-            throw new Error('Content Invalid');
-        else
-            return args;
-    }
-    /**
-     * HTTP-RPC服务器请求监听方法
-     */
-    async call(request, response) {
-        // 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-real-ip'] || request.socket.remoteAddress || '');
-        // startup client ip
-        const sourceIP = String(request.headers['x-source-ip'] || request.socket.remoteAddress || '');
-        // check token
-        const token = String(request.headers['x-token'] || '');
-        const { allow, reason } = oox.checkAllow(ip, caller, token);
-        if (!allow)
-            return this.respond(request, response, {
-                success: false,
-                error: {
-                    message: reason
-                }
-            });
-        let callArgs = Object.create(null);
-        try {
-            callArgs = await this.getCallArgsFromRequest(request);
-        }
-        catch (error) {
-            return this.respond(request, response, {
-                success: false,
-                error: {
-                    message: error.message,
-                    stack: error.stack
-                }
-            });
-        }
-        const { action, params = [] } = callArgs;
-        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, returns) {
-        let returnsString = '';
-        if (!oox.config.errorStack && returns.error) {
-            // 不返回错误调用栈信息
-            delete returns.error.stack;
-        }
-        try {
-            returnsString = JSON.stringify(returns);
-        }
-        catch (error) {
-            delete returns.body;
-            returns.success = false;
-            returns.error = {
-                message: error.message
-            };
-            if (oox.config.errorStack) {
-                // 返回错误调用栈信息
-                returns.error.stack = error.stack;
-            }
-            returnsString = JSON.stringify(returns);
-        }
-        response.setHeader('Content-Type', 'application/json');
-        response.setHeader('Content-Length', Buffer.byteLength(returnsString));
-        response.end(returnsString);
-    }
-}

package/modules/http/router.js

@@ -1,210 +0,0 @@
-export default class Router {
-    routes = new Map();
-    globalMiddleware = [];
-    // 注册GET路由
-    get(path, ...args) {
-        const { handler, middleware } = this.parseRouteArgs(args);
-        this.addRoute('GET', path, handler, middleware);
-    }
-    // 注册POST路由
-    post(path, ...args) {
-        const { handler, middleware } = this.parseRouteArgs(args);
-        this.addRoute('POST', path, handler, middleware);
-    }
-    // 注册PUT路由
-    put(path, ...args) {
-        const { handler, middleware } = this.parseRouteArgs(args);
-        this.addRoute('PUT', path, handler, middleware);
-    }
-    // 注册DELETE路由
-    delete(path, ...args) {
-        const { handler, middleware } = this.parseRouteArgs(args);
-        this.addRoute('DELETE', path, handler, middleware);
-    }
-    // 解析路由参数，支持多种传入方式
-    parseRouteArgs(args) {
-        let handler;
-        let middleware = [];
-        if (args.length === 0) {
-            throw new Error('No handler provided for route');
-        }
-        // 方式1: [handler] 或 [middlewareArray, handler]
-        if (args.length === 1) {
-            if (typeof args[0] === 'function') {
-                handler = args[0];
-            }
-            else {
-                throw new Error('Invalid route handler');
-            }
-        }
-        // 方式2: [handler, middlewareArray] 或 [middleware1, middleware2, handler] 或 [middlewareArray, handler]
-        else {
-            // 检查最后一个参数是否是函数（处理器）
-            if (typeof args[args.length - 1] === 'function') {
-                handler = args[args.length - 1];
-                // 前面的所有都是中间件
-                const middleArgs = args.slice(0, -1);
-                // 展平中间件数组
-                for (const arg of middleArgs) {
-                    if (Array.isArray(arg)) {
-                        middleware.push(...arg);
-                    }
-                    else if (typeof arg === 'function') {
-                        middleware.push(arg);
-                    }
-                }
-            }
-            // 检查第一个参数是否是函数
-            else if (typeof args[0] === 'function') {
-                handler = args[0];
-                // 后面的是中间件
-                const middleArgs = args.slice(1);
-                for (const arg of middleArgs) {
-                    if (Array.isArray(arg)) {
-                        middleware.push(...arg);
-                    }
-                    else if (typeof arg === 'function') {
-                        middleware.push(arg);
-                    }
-                }
-            }
-            else {
-                throw new Error('Invalid route arguments');
-            }
-        }
-        return { handler, middleware };
-    }
-    // 注册全局中间件
-    use(middleware) {
-        this.globalMiddleware.push(middleware);
-    }
-    // 注册特定路径的中间件
-    usePath(path, middleware) {
-        // 实现路径级中间件
-    }
-    // 添加路由
-    addRoute(method, path, handler, middleware = []) {
-        // 编译路径为正则表达式，支持路径参数
-        const { regex, paramNames } = this.compilePath(path);
-        let routes = [];
-        if (this.routes.has(method)) {
-            routes = this.routes.get(method) || [];
-        }
-        else {
-            routes = [];
-            this.routes.set(method, routes);
-        }
-        routes.push({
-            path,
-            method,
-            handler,
-            middleware,
-            regex,
-            paramNames
-        });
-    }
-    // 编译路径为正则表达式
-    compilePath(path) {
-        const paramNames = [];
-        const regexPattern = path
-            .replace(/:([^/]+)/g, (_, paramName) => {
-            paramNames.push(paramName);
-            return '([^/]+)';
-        })
-            .replace(/\//g, '\\/')
-            .replace(/\*/g, '.*');
-        return {
-            regex: new RegExp(`^${regexPattern}$`),
-            paramNames
-        };
-    }
-    // 匹配路由
-    match(method, path) {
-        const routes = this.routes.get(method) || [];
-        for (const route of routes) {
-            const match = path.match(route.regex);
-            if (match) {
-                const params = {};
-                route.paramNames.forEach((paramName, index) => {
-                    params[paramName] = match[index + 1];
-                });
-                return { route, params };
-            }
-        }
-        return null;
-    }
-    // 创建请求对象
-    createRequestObject(originalRequest, url) {
-        return {
-            originalRequest,
-            url,
-            method: originalRequest.method || 'GET',
-            path: url.pathname,
-            query: Object.fromEntries(url.searchParams),
-            params: {},
-            headers: originalRequest.headers,
-            body: null
-        };
-    }
-    // 创建响应对象
-    createResponseObject(originalResponse) {
-        let statusCode = 200;
-        return {
-            originalResponse,
-            status(code) {
-                statusCode = code;
-                return this;
-            },
-            json(data) {
-                const jsonString = JSON.stringify(data);
-                this.originalResponse.statusCode = statusCode;
-                this.originalResponse.setHeader('Content-Type', 'application/json');
-                this.originalResponse.setHeader('Content-Length', Buffer.byteLength(jsonString));
-                this.originalResponse.end(jsonString);
-            },
-            send(data) {
-                const dataString = typeof data === 'string' ? data : JSON.stringify(data);
-                this.originalResponse.statusCode = statusCode;
-                this.originalResponse.setHeader('Content-Type', 'text/plain');
-                this.originalResponse.setHeader('Content-Length', Buffer.byteLength(dataString));
-                this.originalResponse.end(dataString);
-            },
-            end(data) {
-                this.originalResponse.statusCode = statusCode;
-                this.originalResponse.end(data);
-            }
-        };
-    }
-    // 执行中间件
-    async executeMiddleware(middleware, req, res) {
-        for (const fn of middleware) {
-            let nextCalled = false;
-            const next = () => { nextCalled = true; };
-            const result = fn(req, res, next);
-            if (result instanceof Promise) {
-                await result;
-            }
-            if (!nextCalled) {
-                return false; // 中间件已结束响应
-            }
-        }
-        return true; // 所有中间件都已执行
-    }
-    // 处理路由请求
-    async handleRoute(route, params, req, res) {
-        req.params = params;
-        // 执行全局中间件
-        const globalMiddlewareContinue = await this.executeMiddleware(this.globalMiddleware, req, res);
-        if (!globalMiddlewareContinue)
-            return;
-        // 执行路由中间件
-        const routeMiddlewareContinue = await this.executeMiddleware(route.middleware, req, res);
-        if (!routeMiddlewareContinue)
-            return;
-        // 执行路由处理函数
-        const result = route.handler(req, res);
-        if (result instanceof Promise) {
-            await result;
-        }
-    }
-}

package/modules/http/utils.js

@@ -1,75 +0,0 @@
-import * as http from 'node:http';
-import * as https from 'node:https';
-/**
- * Stream => Buffer
- */
-export 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)); });
-    });
-}
-/**
- * Request => JSONObject
- */
-export 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 contentLength = request.headers['content-length'];
-    if (!contentLength || contentLength === '0')
-        return null;
-    const contentSize = +contentLength;
-    const buffer = await stream2buffer(request, contentSize);
-    if (buffer.length !== contentSize)
-        throw new Error('Content-Length Incorrect');
-    switch (contentType) {
-        case 'application/json':
-            return JSON.parse(buffer.toString());
-        case 'text/plain':
-            return buffer.toString();
-        default:
-            return buffer;
-    }
-}
-/**
- * http request
- */
-export function httpRequest(url, options, body) {
-    return new Promise(function (resolve, reject) {
-        const urlObj = typeof url === 'string' ? new URL(url) : url;
-        const protocol = urlObj.protocol;
-        const client = protocol === 'https:' ? https : http;
-        const request = client.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();
-    });
-}

package/types/modules/http/index.d.ts

@@ -1,63 +0,0 @@
-import * as http from 'node:http';
-import * as https from 'node:https';
-import Router, { Middleware } from './router.js';
-import { Module, ModuleConfig } from '../module.js';
-export declare class HTTPConfig implements ModuleConfig {
-    enabled: boolean;
-    port: number;
-    path: string;
-    origin: string | string[];
-    ssl: {
-        enabled: boolean;
-        cert: string;
-        key: string;
-        ca: string;
-    };
-}
-export default class HTTPModule extends Module {
-    name: string;
-    config: HTTPConfig;
-    server: http.Server | https.Server | null;
-    router: Router;
-    getURL(): URL;
-    get(path: string, ...args: any[]): this;
-    post(path: string, ...args: any[]): this;
-    put(path: string, ...args: any[]): this;
-    delete(path: string, ...args: any[]): this;
-    use(middleware: Middleware): this;
-    setConfig(config: HTTPConfig): void;
-    getConfig(): HTTPConfig;
-    get serviceURL(): URL;
-    /**
-     * start http service
-     */
-    serve(): Promise<void>;
-    /**
-     * stop http service
-     */
-    stop(): Promise<void>;
-    /**
-     * browser cross origin
-     */
-    cors(request: http.IncomingMessage, response: http.ServerResponse): boolean;
-    requestHandler(request: http.IncomingMessage, response: http.ServerResponse): Promise<void>;
-    /**
-     * 从请求里获取调用的接口和参数
-     */
-    getCallArgsFromRequest(request: http.IncomingMessage): Promise<any>;
-    /**
-     * HTTP-RPC服务器请求监听方法
-     */
-    call(request: http.IncomingMessage, response: http.ServerResponse): Promise<void>;
-    /**
-     * HTTP Response Catch
-     */
-    respond(_request: http.IncomingMessage, response: http.ServerResponse, returns: {
-        body?: any;
-        success: boolean;
-        error?: {
-            message: any;
-            stack?: any;
-        };
-    }): void;
-}

package/types/modules/http/router.d.ts

@@ -1,49 +0,0 @@
-import * as http from 'node:http';
-export type RouteHandler = (req: Request, res: Response) => Promise<any> | any;
-export type Middleware = (req: Request, res: Response, next: () => void) => Promise<any> | any;
-export interface Route {
-    path: string;
-    method: string;
-    handler: RouteHandler;
-    middleware: Middleware[];
-    regex: RegExp;
-    paramNames: string[];
-}
-export interface Request {
-    originalRequest: http.IncomingMessage;
-    url: URL;
-    method: string;
-    path: string;
-    query: Record<string, string>;
-    params: Record<string, string>;
-    headers: Record<string, string>;
-    body: any;
-}
-export interface Response {
-    originalResponse: http.ServerResponse;
-    status(code: number): Response;
-    json(data: any): void;
-    send(data: any): void;
-    end(data?: any): void;
-}
-export default class Router {
-    private routes;
-    private globalMiddleware;
-    get(path: string, ...args: any[]): void;
-    post(path: string, ...args: any[]): void;
-    put(path: string, ...args: any[]): void;
-    delete(path: string, ...args: any[]): void;
-    private parseRouteArgs;
-    use(middleware: Middleware): void;
-    usePath(path: string, middleware: Middleware): void;
-    private addRoute;
-    private compilePath;
-    match(method: string, path: string): {
-        route: Route;
-        params: Record<string, string>;
-    } | null;
-    createRequestObject(originalRequest: http.IncomingMessage, url: URL): Request;
-    createResponseObject(originalResponse: http.ServerResponse): Response;
-    private executeMiddleware;
-    handleRoute(route: Route, params: Record<string, string>, req: Request, res: Response): Promise<void>;
-}

package/types/modules/http/utils.d.ts

@@ -1,14 +0,0 @@
-import * as http from 'node:http';
-import { Readable } from 'node:stream';
-/**
- * Stream => Buffer
- */
-export declare function stream2buffer(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>;