@vectorx/functions-framework 1.0.1 → 1.1.0

package/lib/error.js

@@ -30,18 +30,26 @@ function decorateErrorStack(err) {
     return err.stack.split("\n").join("\n");
 }
 function newSysErr(err) {
-    return new AppError(ErrorCode.SYS_ERR, "System Error.", { cause: err });
+    return new AppError(ErrorCode.SYS_ERR, "System Error.", {
+        cause: err,
+    });
 }
 function newBadRequestErr(err) {
     const message = err instanceof Error ? err.message : err;
     return new AppError(ErrorCode.BAD_REQUEST, message, { cause: err });
 }
 function newTimeoutErr() {
-    return new AppError(ErrorCode.TIMEOUT, "Request timeout", { cause: new Error("Request timeout") });
+    return new AppError(ErrorCode.TIMEOUT, "Request timeout", {
+        cause: new Error("Request timeout"),
+    });
 }
 function newTooManyRequestsErr(err) {
-    return new AppError(ErrorCode.TOO_MANY_REQUESTS, "Too many requests", { cause: err });
+    return new AppError(ErrorCode.TOO_MANY_REQUESTS, "Too many requests", {
+        cause: err,
+    });
 }
 function newUnauthorizedErr(err) {
-    return new AppError(ErrorCode.UNAUTHORIZED, "Unauthorized", { cause: err });
+    return new AppError(ErrorCode.UNAUTHORIZED, "Unauthorized", {
+        cause: err,
+    });
 }

package/lib/framework.js

@@ -28,7 +28,9 @@ const apm_1 = require("./utils/apm");
 const console_intercept_1 = require("./utils/console-intercept");
 function getDependencyVersion(packageName, searchPath) {
     try {
-        const packagePath = require.resolve(packageName, { paths: [searchPath] });
+        const packagePath = require.resolve(packageName, {
+            paths: [searchPath],
+        });
         let currentPath = path_1.default.dirname(packagePath);
         let packageJsonPath = path_1.default.join(currentPath, "package.json");
         while (!(0, fs_1.existsSync)(packageJsonPath) && currentPath !== path_1.default.parse(currentPath).root) {
@@ -85,10 +87,14 @@ class AgentServerFramework {
             const stageEnvFilePath = path_1.default.join(process.cwd(), `.env.${stage}`);
             let dotEnvContent;
             if ((0, fs_1.existsSync)(defaultEnvFilePath)) {
-                dotEnvContent = dotenv_1.default.config({ path: path_1.default.resolve(defaultEnvFilePath) });
+                dotEnvContent = dotenv_1.default.config({
+                    path: path_1.default.resolve(defaultEnvFilePath),
+                });
             }
             else if ((0, fs_1.existsSync)(stageEnvFilePath)) {
-                dotEnvContent = dotenv_1.default.config({ path: path_1.default.resolve(stageEnvFilePath) });
+                dotEnvContent = dotenv_1.default.config({
+                    path: path_1.default.resolve(stageEnvFilePath),
+                });
             }
             if (dotEnvContent && dotEnvContent.parsed) {
                 const envKeys = Object.keys(dotEnvContent.parsed);

package/lib/function-loader.js

@@ -30,7 +30,10 @@ function loadFunctionsConfig(configPath) {
                             throw new Error(`Route '${fn.triggerPath}->${fn.name}' conflict with '${fn.triggerPath}->${existsTriggerFnName}', please check your functions config`);
                         }
                     }
-                    config.routes.push({ functionName: fn.name, path: fn.triggerPath });
+                    config.routes.push({
+                        functionName: fn.name,
+                        path: fn.triggerPath,
+                    });
                     routeMaps.set(fn.triggerPath, fn.name);
                 }
             }

package/lib/function-registry.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildFnId = buildFnId;
 exports.registerFunction = registerFunction;
 exports.getRegisteredFunction = getRegisteredFunction;
+exports.getAllRegisteredFunctions = getAllRegisteredFunctions;
 exports.clearRegistry = clearRegistry;
 const functionRegistry = new Map();
 function buildFnId(fnName, functionName) {
@@ -15,6 +16,13 @@ function registerFunction(fnName, fn) {
 function getRegisteredFunction(fnId) {
     return functionRegistry.get(fnId);
 }
+function getAllRegisteredFunctions() {
+    const result = [];
+    functionRegistry.forEach((fn, fnId) => {
+        result.push({ name: fnId, userFunction: fn });
+    });
+    return result;
+}
 function clearRegistry() {
     functionRegistry.clear();
 }

package/lib/index.js

@@ -20,5 +20,6 @@ __exportStar(require("./function-loader"), exports);
 __exportStar(require("./function-registry"), exports);
 __exportStar(require("./sse"), exports);
 __exportStar(require("./server"), exports);
+__exportStar(require("./wss"), exports);
 __exportStar(require("./logger"), exports);
 __exportStar(require("./async-context"), exports);

package/lib/middlewares/middle-common-logger.js

@@ -25,7 +25,7 @@ function loggerMiddleware() {
             yield next();
             return;
         }
-        process.stdout.write(chalk_1.default.greenBright(`▶️ ${chalk_1.default.gray(`[${new Date().toLocaleString()} - ${ctx.method}:${eventId}]`)} ${ctx.url}`));
+        process.stdout.write(chalk_1.default.greenBright(`▶️ ${chalk_1.default.gray(`[${new Date().toLocaleString()} - ${ctx.method}:${eventId}]`)} ${ctx.url}\n`));
         try {
             const accessLog = {
                 type: "HTTP_ACCESS",

package/lib/request.js

@@ -78,7 +78,7 @@ class Request {
     }
     request(options_1) {
         return __awaiter(this, arguments, void 0, function* (options, enableAbort = false) {
-            const { url, headers: _headers = {}, data, responseType, withCredentials, body, method: _method } = options, headers = Object.assign(Object.assign({}, this.defaultHeaders), (0, helper_1.obj2StrRecord)(_headers)), method = String(_method).toLowerCase() || "get";
+            const { url, headers: _headers = {}, data, responseType, withCredentials, body, method: _method, } = options, headers = Object.assign(Object.assign({}, this.defaultHeaders), (0, helper_1.obj2StrRecord)(_headers)), method = String(_method).toLowerCase() || "get";
             let queryParams = {};
             if (method === "get" || method === "head") {
                 queryParams = Object.assign(Object.assign({}, (data || {})), (body && typeof body === "object" ? body : {}));
@@ -151,7 +151,11 @@ class Request {
                 return Promise.reject(x);
             });
             const ret = {
-                data: stream ? (res.body ? stream_1.Readable.toWeb(res.body) : res.body) : yield res.json(),
+                data: stream
+                    ? res.body
+                        ? stream_1.Readable.toWeb(res.body)
+                        : res.body
+                    : yield res.json(),
                 statusCode: res.status,
                 header: res.headers,
             };

package/lib/server.js

@@ -17,8 +17,10 @@ const http_1 = __importDefault(require("http"));
 const koa_1 = __importDefault(require("koa"));
 const koa_body_1 = require("koa-body");
 const error_1 = require("./error");
+const function_registry_1 = require("./function-registry");
 const middlewares_1 = require("./middlewares");
 const unified_responder_1 = require("./unified-responder");
+const wss_1 = require("./wss");
 function corsMiddleware() {
     return (ctx, next) => __awaiter(this, void 0, void 0, function* () {
         ctx.set("Access-Control-Allow-Origin", "*");
@@ -35,6 +37,19 @@ function corsMiddleware() {
 function createServer(options, router, projectConfig) {
     const app = new koa_1.default();
     app.use(corsMiddleware());
+    app.use((ctx, next) => __awaiter(this, void 0, void 0, function* () {
+        if (ctx.path === "/@meta") {
+            const functions = (0, function_registry_1.getAllRegisteredFunctions)().map((fn) => ({
+                name: fn.name,
+                features: {
+                    websocket: typeof fn.userFunction.handleUpgrade === "function",
+                },
+            }));
+            ctx.body = { functions };
+            return;
+        }
+        yield next();
+    }));
     app.use((0, middlewares_1.logsQueryMiddleware)());
     app.use((0, middlewares_1.contextInjectionMiddleware)(options, projectConfig));
     app.use((0, middlewares_1.envVarsInjectionMiddleware)());
@@ -77,5 +92,6 @@ function createServer(options, router, projectConfig) {
     app.use((0, middlewares_1.openGwRequestMiddleware)(openGwAgentId, { mode: options.mode }));
     app.use((0, middlewares_1.functionRouteMiddleware)(router, projectConfig));
     const httpServer = http_1.default.createServer(app.callback());
+    (0, wss_1.createWebSocketServer)(httpServer, app, router, options, projectConfig);
     return httpServer;
 }

package/lib/sse.js

@@ -90,7 +90,9 @@ class ServerSentEvent extends events_1.EventEmitter {
             const openId = ctx.headers["open-id"] || undefined;
             const eventID = (_d = ctx.state) === null || _d === void 0 ? void 0 : _d.eventID;
             const agentInfo = ((_e = ctx.state) === null || _e === void 0 ? void 0 : _e.agentInfo) || {};
-            const name = [(agentInfo === null || agentInfo === void 0 ? void 0 : agentInfo.agentName) || (agentInfo === null || agentInfo === void 0 ? void 0 : agentInfo.name), agentInfo === null || agentInfo === void 0 ? void 0 : agentInfo.version].filter(Boolean).join("@");
+            const name = [(agentInfo === null || agentInfo === void 0 ? void 0 : agentInfo.agentName) || (agentInfo === null || agentInfo === void 0 ? void 0 : agentInfo.name), agentInfo === null || agentInfo === void 0 ? void 0 : agentInfo.version]
+                .filter(Boolean)
+                .join("@");
             const metadata = {
                 http: { method: ctx.method, path: ctx.path },
                 eventID,
@@ -108,7 +110,11 @@ class ServerSentEvent extends events_1.EventEmitter {
             });
             if (trace) {
                 ctx.state.langfuseTrace = trace;
-                (_g = trace.event) === null || _g === void 0 ? void 0 : _g.call(trace, { name: "sse:start", input: (_j = (_h = ctx.state) === null || _h === void 0 ? void 0 : _h.event) !== null && _j !== void 0 ? _j : null, metadata: { path: ctx.path } });
+                (_g = trace.event) === null || _g === void 0 ? void 0 : _g.call(trace, {
+                    name: "sse:start",
+                    input: (_j = (_h = ctx.state) === null || _h === void 0 ? void 0 : _h.event) !== null && _j !== void 0 ? _j : null,
+                    metadata: { path: ctx.path },
+                });
             }
         }
         catch (_k) { }

package/lib/utils/console-intercept.js

@@ -43,11 +43,10 @@ class Interceptor {
             anotherConsole[method] = (message, ...optionalParams) => {
                 if ((0, async_context_1.isInFrameworkAsyncContext)()) {
                     callAddUserCodeLog(method, message, ...optionalParams);
-                    process.stdout.write((0, util_1.formatWithOptions)({ colors: false }, message, ...optionalParams));
+                    process.stdout.write(`${(0, util_1.formatWithOptions)({ colors: false }, message, ...optionalParams)}\n`);
                 }
                 else {
                     originalConsole[method](message, ...optionalParams);
-                    process.stdout.write((0, util_1.formatWithOptions)({ colors: false }, message, ...optionalParams));
                 }
             };
         }

package/lib/utils/helper.js

@@ -13,13 +13,13 @@ exports.getDependencyVersion = getDependencyVersion;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 function deepFreeze(obj) {
-    if (obj === null || typeof obj !== "object") {
+    if (!isPlainObject(obj)) {
         return obj;
     }
-    Object.keys(obj).forEach((prop) => {
-        const value = obj[prop];
-        if (typeof value === "object" && value !== null) {
-            deepFreeze(value);
+    Object.getOwnPropertyNames(obj).forEach((name) => {
+        const prop = obj[name];
+        if (typeof prop === "object" && prop !== null && !Object.isFrozen(prop)) {
+            deepFreeze(prop);
         }
     });
     return Object.freeze(obj);
@@ -69,7 +69,9 @@ function formatUrl(PROTOCOL, url, query) {
 }
 function getDependencyVersion(packageName, searchPath) {
     try {
-        const packagePath = require.resolve(packageName, { paths: [searchPath] });
+        const packagePath = require.resolve(packageName, {
+            paths: [searchPath],
+        });
         let currentPath = path_1.default.dirname(packagePath);
         let packageJsonPath = path_1.default.join(currentPath, "package.json");
         while (!fs_1.default.existsSync(packageJsonPath) && currentPath !== path_1.default.parse(currentPath).root) {

package/lib/wss.js

@@ -0,0 +1,305 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VectorxWebSocket = void 0;
+exports.createWebSocketServer = createWebSocketServer;
+const events = __importStar(require("events"));
+const http = __importStar(require("http"));
+const koa_compose_1 = __importDefault(require("koa-compose"));
+const ws_1 = require("ws");
+const error_1 = require("./error");
+const function_registry_1 = require("./function-registry");
+const logger_1 = require("./logger");
+const middle_async_context_1 = require("./middlewares/middle-async-context");
+const middle_common_logger_1 = require("./middlewares/middle-common-logger");
+const middle_context_injection_1 = require("./middlewares/middle-context-injection");
+const middle_event_id_1 = require("./middlewares/middle-event-id");
+const router_1 = require("./router");
+const helper_1 = require("./utils/helper");
+const WS_ERROR_CODE = {
+    SERVICE_RESTART: 1012,
+};
+function respondError(socket, e) {
+    respond(socket, 500, `Internal Server Error: ${e && e.message ? e.message : e}`);
+}
+function respond(socket, statusCode, body, type = "text/plain") {
+    const statusMessage = http.STATUS_CODES[statusCode];
+    const head = [
+        `HTTP/1.1 ${statusCode} ${statusMessage}`,
+        `Content-Type: ${type}`,
+        `Content-Length: ${Buffer.byteLength(Buffer.from(body))}`,
+        "Content-Encoding: utf-8",
+        "Connection: close",
+    ].join("\r\n");
+    socket.write(head);
+    socket.write("\r\n\r\n");
+    socket.end(body);
+}
+function setupWebSocketsHeartbeat(wss, interval = 10000) {
+    const SYM_WS_IS_ALIVE = Symbol("WS_IS_ALIVE");
+    let checking = false;
+    let wsNotAliveCount = 0;
+    function doCheck() {
+        if (checking)
+            return;
+        checking = true;
+        wsNotAliveCount = 0;
+        wss.clients.forEach((ws) => {
+            if (Reflect.has(ws, SYM_WS_IS_ALIVE) === false) {
+                ws[SYM_WS_IS_ALIVE] = true;
+                ws.on("pong", function onPong() {
+                    this[SYM_WS_IS_ALIVE] = true;
+                });
+            }
+            if (ws.readyState !== ws.OPEN)
+                return;
+            if (ws[SYM_WS_IS_ALIVE] === false) {
+                wsNotAliveCount += 1;
+                ws.close(1001, "websocket client not alive");
+                return ws.terminate();
+            }
+            ws[SYM_WS_IS_ALIVE] = false;
+            ws.ping();
+        });
+        logger_1.functionsLogger.logError(`wss heartbeat finish, ws not alive count: ${wsNotAliveCount}, total: ${wss.clients.size}`);
+        checking = false;
+    }
+    const aliveCheckTimer = setInterval(doCheck, interval);
+    wss.once("close", () => {
+        clearInterval(aliveCheckTimer);
+    });
+}
+function setupGracefulShutdown(wss) {
+    for (const signal of ["SIGINT", "SIGTERM"]) {
+        process.on(signal, () => __awaiter(this, void 0, void 0, function* () {
+            logger_1.functionsLogger.logError(`received ${signal} signal, shutting down websocket server, ${wss.clients.size} ws clients need to be closed`);
+            wss.close();
+            wss.clients.forEach((ws) => {
+                ws.close(WS_ERROR_CODE.SERVICE_RESTART, "websocket server is shutting down, please try to reconnect");
+            });
+        }));
+    }
+}
+class VectorxWebSocket extends events.EventEmitter {
+    constructor(ws, eventCtx) {
+        super();
+        this.ws = ws;
+        this.ws.onopen = (openEvent) => {
+            this.emit("open", {
+                ctx: eventCtx,
+                type: openEvent.type,
+            });
+        };
+        this.ws.onerror = (errorEvent) => {
+            this.emit("error", {
+                ctx: eventCtx,
+                type: errorEvent.type,
+                message: errorEvent.message,
+                error: errorEvent.error,
+            });
+        };
+        this.ws.onclose = (closeEvent) => {
+            this.emit("close", {
+                ctx: eventCtx,
+                type: closeEvent.type,
+                code: closeEvent.code,
+                reason: closeEvent.reason,
+                wasClean: closeEvent.wasClean,
+            });
+        };
+        this.ws.onmessage = (messageEvent) => {
+            this.emit("message", {
+                ctx: eventCtx,
+                type: messageEvent.type,
+                data: messageEvent.data,
+            });
+        };
+        Object.defineProperty(this, "ws", {
+            configurable: false,
+            enumerable: false,
+            writable: false,
+        });
+    }
+    send(buf) {
+        this.ws.send(buf);
+    }
+    close(code, reason) {
+        this.ws.close(code, reason);
+    }
+}
+exports.VectorxWebSocket = VectorxWebSocket;
+function createWebSocketServer(httpServer, koaApp, router, options, projectConfig) {
+    const hasExportHandleUpgradeFunctions = [];
+    (0, function_registry_1.getAllRegisteredFunctions)().forEach((fn) => {
+        if (typeof fn.userFunction.handleUpgrade === "function") {
+            hasExportHandleUpgradeFunctions.push(fn.name);
+        }
+    });
+    if (hasExportHandleUpgradeFunctions.length === 0) {
+        return;
+    }
+    process.stdout.write(`[vectorx-ff] WebSocket feature is enabled. Enabled functions: ${hasExportHandleUpgradeFunctions.join(", ")}\n`);
+    const wss = new ws_1.WebSocketServer({
+        noServer: true,
+        clientTracking: true,
+        perMessageDeflate: {
+            zlibDeflateOptions: {
+                chunkSize: 1024,
+                memLevel: 7,
+                level: 3,
+            },
+            zlibInflateOptions: {
+                chunkSize: 10 * 1024,
+            },
+            clientNoContextTakeover: true,
+            serverNoContextTakeover: true,
+            serverMaxWindowBits: 10,
+            concurrencyLimit: 10,
+            threshold: 1024,
+        },
+    });
+    setupGracefulShutdown(wss);
+    setupWebSocketsHeartbeat(wss);
+    wss.on("error", (err) => {
+        logger_1.functionsLogger.logError(err, { scene: "ws_server_error" });
+    });
+    wss.on("close", () => {
+        logger_1.functionsLogger.logError("ws server has been closed");
+    });
+    const composedMiddleware = (0, koa_compose_1.default)([
+        (0, middle_event_id_1.eventIdMiddleware)(),
+        (0, middle_async_context_1.asyncContextMiddleware)(),
+        (0, middle_common_logger_1.loggerMiddleware)(),
+        (ctx, next) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield next();
+            }
+            catch (err) {
+                logger_1.functionsLogger.logError(err, { scene: "ws_middleware_error" });
+            }
+        }),
+        (0, middle_context_injection_1.contextInjectionMiddleware)(options, projectConfig),
+    ]);
+    httpServer.on("upgrade", (request, socket, head) => __awaiter(this, void 0, void 0, function* () {
+        const { handleFunction } = (0, router_1.routeFunction)(router, request.url || "/");
+        const userFunction = handleFunction;
+        if (typeof userFunction === "undefined" || typeof userFunction.handleUpgrade !== "function") {
+            socket.destroy();
+            return;
+        }
+        request.socket.setKeepAlive(true);
+        request.socket.setNoDelay(true);
+        request.socket.setTimeout(0);
+        try {
+            const ctx = koaApp.createContext(request, {});
+            yield composedMiddleware(ctx, () => {
+                return new Promise((resolve) => {
+                    if (typeof userFunction.handleUpgrade !== "function") {
+                        respond(socket, 404, "Not Found");
+                        return;
+                    }
+                    const upgradeContext = {
+                        ctxId: ctx.state.eventID,
+                        eventID: ctx.state.eventID,
+                        eventType: "websocket.upgrade",
+                        timestamp: new Date().toISOString(),
+                        httpContext: {
+                            url: request.url,
+                            httpMethod: request.method,
+                            headers: request.headers,
+                        },
+                    };
+                    ctx.state.contextInjected = upgradeContext;
+                    try {
+                        Promise.resolve(userFunction.handleUpgrade(upgradeContext))
+                            .then((result) => {
+                            if (!result.allowWebSocket) {
+                                respond(socket, result.statusCode || 404, result.body || "Not Found", result.contentType);
+                                return;
+                            }
+                            wss.handleUpgrade(request, socket, head, (ws) => __awaiter(this, void 0, void 0, function* () {
+                                const context = {
+                                    ctxId: ctx.state.eventID,
+                                    eventID: ctx.state.eventID,
+                                    eventType: "websocket.connection",
+                                    timestamp: new Date().toISOString(),
+                                    httpContext: {
+                                        url: request.url,
+                                        httpMethod: request.method,
+                                        headers: request.headers,
+                                    },
+                                    ws: new VectorxWebSocket(ws, { ctxId: ctx.state.eventID }),
+                                };
+                                (0, helper_1.deepFreeze)(context);
+                                process.nextTick(() => {
+                                    try {
+                                        userFunction(null, Object.assign({}, context));
+                                    }
+                                    catch (_e) {
+                                    }
+                                });
+                                resolve();
+                            }));
+                        })
+                            .catch((e) => {
+                            logger_1.functionsLogger.logError(`handleUpgrade promise-catch error: ${(0, error_1.decorateErrorStack)(e)}`);
+                            respondError(socket, e);
+                        });
+                    }
+                    catch (e) {
+                        logger_1.functionsLogger.logError(`handleUpgrade try-catch error: ${(0, error_1.decorateErrorStack)(e)}`);
+                        respondError(socket, e);
+                    }
+                });
+            });
+        }
+        catch (e) {
+            logger_1.functionsLogger.logError(e, { scene: "ws_upgrade_error" });
+            respondError(socket, e);
+        }
+    }));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vectorx/functions-framework",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "VectorX Functions Framework",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
@@ -22,16 +22,15 @@
   "author": "",
   "license": "ISC",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "dependencies": {
-    "@vectorx/ai-types": "1.0.1",
-    "@vectorx/endpoints": "1.0.1",
     "async_hooks": "^1.0.0",
     "chalk": "4",
     "commander": "^12.1.0",
     "dotenv": "^16.5.0",
     "koa": "^2.14.2",
+    "koa-compose": "^4.1.0",
     "koa-body": "^6.0.1",
     "koa-bodyparser": "^4.4.1",
     "koa-router": "^12.0.1",
@@ -42,8 +41,11 @@
     "radix3": "^1.1.2",
     "raw-body": "^2.5.2",
     "uuid": "^9.0.1",
+    "ws": "^8.18.0",
     "winston": "^3.11.0",
-    "winston-daily-rotate-file": "^4.7.1"
+    "winston-daily-rotate-file": "^4.7.1",
+    "@vectorx/endpoints": "1.1.0",
+    "@vectorx/ai-types": "1.1.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.12",
@@ -53,6 +55,7 @@
     "@types/node": "^20.11.24",
     "@types/supertest": "^6.0.2",
     "@types/uuid": "^9.0.8",
+    "@types/ws": "^8.5.12",
     "@typescript-eslint/eslint-plugin": "^7.1.0",
     "@typescript-eslint/parser": "^7.1.0",
     "eslint": "^8.57.0",
@@ -72,6 +75,5 @@
     "test:ci": "jest --ci --coverage",
     "lint": "eslint src --ext .ts",
     "run:demo": "node ./bin/rcb-ff.js"
-  },
-  "readme": "# VectorX Functions Framework\n\nVectorX Functions Framework 是一个用于构建和运行云函数的框架，提供了完整的日志系统支持。\n\n## 日志系统\n\n框架内置了完整的日志系统，支持请求日志记录和用户代码日志记录。\n\n### 配置\n\n在初始化框架时，可以配置日志系统：\n\n```typescript\nimport { createAgentServerFramework } from '@vectorx/functions-framework';\n\nconst framework = createAgentServerFramework({\n    port: 3000,\n    logging: {\n        dirname: '/path/to/logs',  // 日志存储目录\n        maxSize: '20m',           // 单个日志文件最大大小\n        maxFiles: 14              // 保留的日志文件数量\n    }\n});\n```\n\n### 日志类型\n\n框架支持两种类型的日志：\n\n- `ACCESS`: 访问日志，记录所有 HTTP 请求\n- `USERCODE`: 用户代码日志，记录用户函数中的日志\n\n### 日志查询 API\n\n框架提供了日志查询 API，用于查看和调试日志：\n\n```\nGET /@logs\n```\n\n#### 查询参数\n\n| 参数名 | 类型 | 必填 | 说明 |\n|--------|------|------|------|\n| type | string | 否 | 日志类型，可选值：ACCESS/USERCODE，默认 ACCESS |\n| limit | number | 否 | 返回的日志条数限制，默认 100 |\n| eventId | string | 否 | 按 eventId 过滤日志 |\n\n#### 示例\n\n1. 查询所有访问日志：\n```bash\ncurl 'http://localhost:3000/@logs?type=ACCESS'\n```\n\n2. 查询特定 eventId 的日志：\n```bash\ncurl 'http://localhost:3000/@logs?eventId=550e8400-e29b-41d4-a716-446655440000'\n```\n\n3. 限制返回条数：\n```bash\ncurl 'http://localhost:3000/@logs?limit=10'\n```\n\n4. 组合查询：\n```bash\ncurl 'http://localhost:3000/@logs?type=USERCODE&eventId=550e8400-e29b-41d4-a716-446655440000&limit=20'\n```\n\n#### 响应格式\n\n成功响应：\n```json\n{\n    \"success\": true,\n    \"data\": [\n        {\n            \"@timestamp\": \"2024-03-21T10:30:00.000Z\",\n            \"level\": \"info\",\n            \"eventId\": \"550e8400-e29b-41d4-a716-446655440000\",\n            \"message\": \"Request started\",\n            \"method\": \"GET\",\n            \"url\": \"/api/example\"\n        }\n    ]\n}\n```\n\n错误响应：\n```json\n{\n    \"success\": false,\n    \"error\": \"错误信息\"\n}\n```\n\n### 在代码中使用日志\n\n```typescript\nimport { functionsLogger } from '@vectorx/functions-framework';\nimport { LogLevel } from '@vectorx/functions-framework';\n\n// 记录访问日志\nfunctionsLogger.logAccesslog(LogLevel.INFO, 'Custom message', {\n    customField: 'value'\n});\n\n// 记录用户代码日志\nfunctionsLogger.logUserCodelog([\n    { message: 'User log message', level: 'info' }\n]);\n```\n\n### 日志格式\n\n每条日志都包含以下字段：\n\n- `@timestamp`: 日志时间戳\n- `level`: 日志级别\n- `eventId`: 请求 ID\n- `message`: 日志消息\n- 其他自定义字段\n\n## 开发\n\n### 运行测试\n\n```bash\nnpm test\n```\n\n### 构建\n\n```bash\nnpm run build\n``` \n\n### 环境管理\n读取 .env 文件，校验 env 文件的可用性，获取当前运行环境\n\n\n## rcb-ff 自动检测项目类型\n\n当直接使用 `rcb-ff` 命令启动服务时，如果未指定 `--mode` 参数，会自动检测项目类型：\n\n### 检测规则\n\n1. **Agent 项目检测**：\n   - 如果存在 `project.config.json` 文件且包含 `agentId` 字段，则判定为 `agent` 项目\n\n2. **Fun 项目检测**：\n   - 如果不存在 `project.config.json` 或 `project.config.json` 中不存在 `agentId` 字段\n   - 且存在 `agent-cloudbase-functions.json` 配置文件\n   - 则判定为 `fun` 项目\n\n3. **默认行为**：\n   - 如果无法确定项目类型，默认使用 `agent` 模式（保持向后兼容）\n\n### 使用示例\n\n```bash\n# 自动检测项目类型（推荐）\nrcb-ff --directory ./my-project\n\n# 明确指定模式（覆盖自动检测）\nrcb-ff --directory ./my-project --mode fun\nrcb-ff --directory ./my-project --mode agent\n```\n"
+  }
 }

package/types/function-registry.d.ts

@@ -1,4 +1,8 @@
 export declare function buildFnId(fnName: string, functionName: string): string;
 export declare function registerFunction(fnName: string, fn: Function): void;
 export declare function getRegisteredFunction(fnId: string): Function | undefined;
+export declare function getAllRegisteredFunctions(): Array<{
+    name: string;
+    userFunction: Function;
+}>;
 export declare function clearRegistry(): void;

package/types/index.d.ts

@@ -4,5 +4,6 @@ export * from "./function-loader";
 export * from "./function-registry";
 export * from "./sse";
 export * from "./server";
+export * from "./wss";
 export * from "./logger";
 export * from "./async-context";

package/types/server.d.ts

@@ -4,6 +4,7 @@ import type { ProjectConfig } from "./function-loader";
 import type { functionsLogger } from "./logger";
 import type { Request } from "./request";
 import type { Router } from "./router";
+import type { VectorxWebSocket } from "./wss";
 declare module "koa" {
     interface DefaultState {
         isTimeout?: boolean;
@@ -41,5 +42,6 @@ export interface RcbContext {
     setCookie: (name: string, value: string, options?: any) => void;
     clearCookie: (name: string, options?: any) => void;
     sse: () => any;
+    ws?: VectorxWebSocket;
 }
 export declare function createServer(options: FrameworkOptions, router: Router, projectConfig: ProjectConfig): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;

package/types/wss.d.ts

@@ -0,0 +1,56 @@
+import * as events from "events";
+import * as http from "http";
+import type Koa from "koa";
+import type { WebSocket as RawWebSocket } from "ws";
+import type { FrameworkOptions } from "./framework";
+import type { ProjectConfig } from "./function-loader";
+import type { Router } from "./router";
+export interface WsEventContext {
+    ctxId: string;
+}
+export interface WsOpenEvent {
+    ctx: WsEventContext;
+    type: string;
+}
+export interface WsErrorEvent {
+    ctx: WsEventContext;
+    type: string;
+    message: string;
+    error: any;
+}
+export interface WsCloseEvent {
+    ctx: WsEventContext;
+    type: string;
+    code: number;
+    reason: string;
+    wasClean: boolean;
+}
+export interface WsMessageEvent {
+    ctx: WsEventContext;
+    type: string;
+    data: any;
+}
+export interface HandleUpgradeResult {
+    allowWebSocket: boolean;
+    statusCode?: number;
+    body?: string;
+    contentType?: string;
+}
+export interface WsUpgradeContext {
+    ctxId: string;
+    eventID: string;
+    eventType: "websocket.upgrade";
+    timestamp: string;
+    httpContext: {
+        url: string | undefined;
+        httpMethod: string | undefined;
+        headers: http.IncomingHttpHeaders;
+    };
+}
+export declare class VectorxWebSocket extends events.EventEmitter {
+    private ws;
+    constructor(ws: RawWebSocket, eventCtx: WsEventContext);
+    send(buf: any): void;
+    close(code?: number, reason?: string): void;
+}
+export declare function createWebSocketServer(httpServer: http.Server, koaApp: Koa, router: Router, options: FrameworkOptions, projectConfig: ProjectConfig): void;