@roomkit/gateway 1.0.0

package/README.md

@@ -0,0 +1,93 @@
+# @roomkit/gateway
+
+WebSocket Gateway server for the RoomKit framework.
+
+## Installation
+
+```bash
+npm install @roomkit/gateway @roomkit/core
+```
+
+## Features
+
+- 🌐 **WebSocket Server** - High-performance WebSocket connections
+- 🔄 **Message Routing** - Route messages between clients and workers
+- 📊 **Metrics** - Built-in Prometheus metrics
+- 🔒 **Rate Limiting** - Protect against abuse
+- 💪 **Session Management** - Persistent sessions with Redis
+- 🔌 **Horizontal Scaling** - Multiple gateway instances supported
+
+## Quick Start
+
+### Environment Variables
+
+```bash
+# Server
+PORT=27100
+ADMIN_PORT=27200
+
+# Redis
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_PASSWORD=
+
+# Gateway
+GATEWAY_ID=gateway-1
+```
+
+### Run Gateway
+
+```bash
+# Using the binary
+npx @roomkit/gateway
+
+# Or using Node.js
+node node_modules/@roomkit/gateway/dist/main.js
+```
+
+### Docker
+
+```bash
+docker run -e REDIS_HOST=redis \
+  -e GATEWAY_ID=gateway-1 \
+  -p 27100:27100 \
+  -p 27200:27200 \
+  roomkit/gateway
+```
+
+## Configuration
+
+Create a `.env` file:
+
+```env
+PORT=27100
+ADMIN_PORT=27200
+REDIS_HOST=localhost
+REDIS_PORT=6379
+GATEWAY_ID=gateway-1
+```
+
+## Admin API
+
+The gateway provides an admin API on port `ADMIN_PORT`:
+
+- `GET /health` - Health check
+- `GET /metrics` - Prometheus metrics
+- `GET /admin/connections` - List active connections
+- `GET /admin/stats` - Gateway statistics
+
+## Architecture
+
+```
+Client <--WebSocket--> Gateway <--Redis--> Worker
+```
+
+The Gateway:
+1. Accepts WebSocket connections from clients
+2. Manages sessions and authentication
+3. Routes messages to appropriate workers via Redis
+4. Broadcasts responses back to clients
+
+## License
+
+MIT

package/dist/src/admin/admin.controller.d.ts

@@ -0,0 +1,187 @@
+import { AdminService } from './admin.service';
+/**
+ * Gateway Admin API 控制器
+ * 提供系统状态查询、连接管理、限流统计等管理功能
+ */
+export declare class AdminController {
+    private readonly adminService;
+    constructor(adminService: AdminService);
+    /**
+     * 健康检查
+     */
+    getHealth(): {
+        status: string;
+        timestamp: number;
+        gatewayId: string;
+    };
+    /**
+     * 获取系统状态
+     */
+    getStatus(): {
+        gatewayId: string;
+        uptime: number;
+        uptimeFormatted: string;
+        connections: {
+            total: number;
+            authenticated: number;
+            anonymous: number;
+            max: number;
+            utilization: number;
+        };
+        config: {
+            port: number;
+            heartbeatInterval: number;
+            heartbeatTimeout: number;
+            maxConnections: number;
+        };
+        rateLimit: {
+            connectionRate: number;
+            globalMessageRate: number;
+            trackedConnections: number;
+        };
+        memory: {
+            heapUsed: number;
+            heapTotal: number;
+            rss: number;
+            external: number;
+            unit: string;
+        };
+        timestamp: number;
+    };
+    /**
+     * 获取所有连接信息
+     */
+    getConnections(): {
+        count: number;
+        connections: {
+            id: string;
+            userId?: string;
+            status: string;
+            currentRoom?: string;
+            rooms?: string[];
+            lastActivity: number;
+            createdAt: number;
+            age: number;
+        }[];
+    };
+    /**
+     * 获取单个连接详情
+     */
+    getConnection(connectionId: string): {
+        id: string;
+        userId: string | undefined;
+        status: import("packages/core/dist").ConnectionStatus;
+        currentRoom: string | undefined;
+        lastActivity: number;
+        createdAt: number;
+        age: number;
+        idleDuration: number;
+    };
+    /**
+     * 强制断开连接
+     */
+    disconnectConnection(connectionId: string, body: {
+        reason?: string;
+    }): {
+        success: boolean;
+        connectionId: string;
+        reason: string;
+    };
+    /**
+     * 获取限流统计
+     */
+    getRateLimitStats(): {
+        config: {
+            connectionRateLimit: number;
+            messageRateLimitPerConnection: number;
+            messageBurstLimit: number;
+            globalMessageRateLimit: number;
+        };
+        connectionRate: number;
+        globalMessageRate: number;
+        trackedConnections: number;
+    };
+    /**
+     * 获取 Redis 连接状态
+     */
+    getRedisStatus(): {
+        connected: boolean;
+        status: "connect" | "wait" | "reconnecting" | "connecting" | "ready" | "close" | "end";
+        host: string;
+        port: number;
+    };
+    /**
+     * 获取按用户分组的连接
+     */
+    getUsers(): {
+        count: number;
+        users: {
+            userId: string;
+            connectionCount: number;
+            connectionIds: string[];
+        }[];
+    };
+    /**
+     * 获取指定用户的连接
+     */
+    getUser(userId: string): {
+        userId: string;
+        connectionId: string;
+        status: import("packages/core/dist").ConnectionStatus;
+        currentRoom: string | undefined;
+        lastActivity: number;
+        createdAt: number;
+    };
+    /**
+     * 强制用户下线
+     */
+    kickUser(userId: string, body: {
+        reason?: string;
+    }): {
+        success: boolean;
+        userId: string;
+        connectionId: string;
+        reason: string;
+    };
+    /**
+     * 广播系统消息给所有连接
+     */
+    broadcast(body: {
+        msgId: number;
+        payload: unknown;
+    }): {
+        success: boolean;
+        msgId: number;
+        sent: number;
+        failed: number;
+        total: number;
+    };
+    /**
+     * 获取指标数据
+     */
+    getMetrics(): {
+        timestamp: number;
+        gateway: {
+            id: string;
+            uptime: number;
+        };
+        connections: {
+            total: number;
+            authenticated: number;
+            anonymous: number;
+        };
+        rateLimit: {
+            connectionRate: number;
+            globalMessageRate: number;
+            trackedConnections: number;
+        };
+        memory: {
+            heapUsed: number;
+            heapTotal: number;
+            rss: number;
+            external: number;
+            unit: string;
+        };
+    };
+}
+//# sourceMappingURL=admin.controller.d.ts.map

package/dist/src/admin/admin.controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin.controller.d.ts","sourceRoot":"","sources":["../../../src/admin/admin.controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;GAGG;AACH,qBACa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,YAAY;gBAAZ,YAAY,EAAE,YAAY;IAEvD;;OAEG;IAEH,SAAS;;;;;IAIT;;OAEG;IAEH,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAIT;;OAEG;IAEH,cAAc;;;;;;;;;;;;;IAId;;OAEG;IAEH,aAAa,CAAwB,YAAY,EAAE,MAAM;;;;;;;;;;IAIzD;;OAEG;IAGH,oBAAoB,CACK,YAAY,EAAE,MAAM,EACnC,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;IAKnC;;OAEG;IAEH,iBAAiB;;;;;;;;;;;IAIjB;;OAEG;IAEH,cAAc;;;;;;IAId;;OAEG;IAEH,QAAQ;;;;;;;;IAIR;;OAEG;IAEH,OAAO,CAAkB,MAAM,EAAE,MAAM;;;;;;;;IAIvC;;OAEG;IAGH,QAAQ,CACW,MAAM,EAAE,MAAM,EACvB,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;IAKnC;;OAEG;IAGH,SAAS,CAAS,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE;;;;;;;IAI3D;;OAEG;IAEH,UAAU;;;;;;;;;;;;;;;;;;;;;;;;CAGX"}

package/dist/src/admin/admin.controller.js

@@ -0,0 +1,187 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminController = void 0;
+const common_1 = require("@nestjs/common");
+const admin_service_1 = require("./admin.service");
+/**
+ * Gateway Admin API 控制器
+ * 提供系统状态查询、连接管理、限流统计等管理功能
+ */
+let AdminController = class AdminController {
+    adminService;
+    constructor(adminService) {
+        this.adminService = adminService;
+    }
+    /**
+     * 健康检查
+     */
+    getHealth() {
+        return this.adminService.getHealth();
+    }
+    /**
+     * 获取系统状态
+     */
+    getStatus() {
+        return this.adminService.getStatus();
+    }
+    /**
+     * 获取所有连接信息
+     */
+    getConnections() {
+        return this.adminService.getConnections();
+    }
+    /**
+     * 获取单个连接详情
+     */
+    getConnection(connectionId) {
+        return this.adminService.getConnection(connectionId);
+    }
+    /**
+     * 强制断开连接
+     */
+    disconnectConnection(connectionId, body) {
+        return this.adminService.disconnectConnection(connectionId, body.reason);
+    }
+    /**
+     * 获取限流统计
+     */
+    getRateLimitStats() {
+        return this.adminService.getRateLimitStats();
+    }
+    /**
+     * 获取 Redis 连接状态
+     */
+    getRedisStatus() {
+        return this.adminService.getRedisStatus();
+    }
+    /**
+     * 获取按用户分组的连接
+     */
+    getUsers() {
+        return this.adminService.getUsers();
+    }
+    /**
+     * 获取指定用户的连接
+     */
+    getUser(userId) {
+        return this.adminService.getUser(userId);
+    }
+    /**
+     * 强制用户下线
+     */
+    kickUser(userId, body) {
+        return this.adminService.kickUser(userId, body.reason);
+    }
+    /**
+     * 广播系统消息给所有连接
+     */
+    broadcast(body) {
+        return this.adminService.broadcast(body.msgId, body.payload);
+    }
+    /**
+     * 获取指标数据
+     */
+    getMetrics() {
+        return this.adminService.getMetrics();
+    }
+};
+exports.AdminController = AdminController;
+__decorate([
+    (0, common_1.Get)('health'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "getHealth", null);
+__decorate([
+    (0, common_1.Get)('status'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "getStatus", null);
+__decorate([
+    (0, common_1.Get)('connections'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "getConnections", null);
+__decorate([
+    (0, common_1.Get)('connections/:connectionId'),
+    __param(0, (0, common_1.Param)('connectionId')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "getConnection", null);
+__decorate([
+    (0, common_1.Post)('connections/:connectionId/disconnect'),
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    __param(0, (0, common_1.Param)('connectionId')),
+    __param(1, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "disconnectConnection", null);
+__decorate([
+    (0, common_1.Get)('ratelimit/stats'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "getRateLimitStats", null);
+__decorate([
+    (0, common_1.Get)('redis/status'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "getRedisStatus", null);
+__decorate([
+    (0, common_1.Get)('users'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "getUsers", null);
+__decorate([
+    (0, common_1.Get)('users/:userId'),
+    __param(0, (0, common_1.Param)('userId')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "getUser", null);
+__decorate([
+    (0, common_1.Post)('users/:userId/kick'),
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    __param(0, (0, common_1.Param)('userId')),
+    __param(1, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "kickUser", null);
+__decorate([
+    (0, common_1.Post)('broadcast'),
+    (0, common_1.HttpCode)(common_1.HttpStatus.OK),
+    __param(0, (0, common_1.Body)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "broadcast", null);
+__decorate([
+    (0, common_1.Get)('metrics'),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], AdminController.prototype, "getMetrics", null);
+exports.AdminController = AdminController = __decorate([
+    (0, common_1.Controller)('admin'),
+    __metadata("design:paramtypes", [admin_service_1.AdminService])
+], AdminController);
+//# sourceMappingURL=admin.controller.js.map

package/dist/src/admin/admin.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin.controller.js","sourceRoot":"","sources":["../../../src/admin/admin.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA0F;AAC1F,mDAA+C;AAE/C;;;GAGG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAe;IACG;IAA7B,YAA6B,YAA0B;QAA1B,iBAAY,GAAZ,YAAY,CAAc;IAAG,CAAC;IAE3D;;OAEG;IAEH,SAAS;QACP,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;IACvC,CAAC;IAED;;OAEG;IAEH,SAAS;QACP,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;IACvC,CAAC;IAED;;OAEG;IAEH,cAAc;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IAEH,aAAa,CAAwB,YAAoB;QACvD,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IAGH,oBAAoB,CACK,YAAoB,EACnC,IAAyB;QAEjC,OAAO,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IAEH,iBAAiB;QACf,OAAO,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC;IAC/C,CAAC;IAED;;OAEG;IAEH,cAAc;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IAEH,QAAQ;QACN,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;IACtC,CAAC;IAED;;OAEG;IAEH,OAAO,CAAkB,MAAc;QACrC,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IAGH,QAAQ,CACW,MAAc,EACvB,IAAyB;QAEjC,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IAGH,SAAS,CAAS,IAAyC;QACzD,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IAEH,UAAU;QACR,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;IACxC,CAAC;CACF,CAAA;AA3GY,0CAAe;AAO1B;IADC,IAAA,YAAG,EAAC,QAAQ,CAAC;;;;gDAGb;AAMD;IADC,IAAA,YAAG,EAAC,QAAQ,CAAC;;;;gDAGb;AAMD;IADC,IAAA,YAAG,EAAC,aAAa,CAAC;;;;qDAGlB;AAMD;IADC,IAAA,YAAG,EAAC,2BAA2B,CAAC;IAClB,WAAA,IAAA,cAAK,EAAC,cAAc,CAAC,CAAA;;;;oDAEnC;AAOD;IAFC,IAAA,aAAI,EAAC,sCAAsC,CAAC;IAC5C,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IAErB,WAAA,IAAA,cAAK,EAAC,cAAc,CAAC,CAAA;IACrB,WAAA,IAAA,aAAI,GAAE,CAAA;;;;2DAGR;AAMD;IADC,IAAA,YAAG,EAAC,iBAAiB,CAAC;;;;wDAGtB;AAMD;IADC,IAAA,YAAG,EAAC,cAAc,CAAC;;;;qDAGnB;AAMD;IADC,IAAA,YAAG,EAAC,OAAO,CAAC;;;;+CAGZ;AAMD;IADC,IAAA,YAAG,EAAC,eAAe,CAAC;IACZ,WAAA,IAAA,cAAK,EAAC,QAAQ,CAAC,CAAA;;;;8CAEvB;AAOD;IAFC,IAAA,aAAI,EAAC,oBAAoB,CAAC;IAC1B,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IAErB,WAAA,IAAA,cAAK,EAAC,QAAQ,CAAC,CAAA;IACf,WAAA,IAAA,aAAI,GAAE,CAAA;;;;+CAGR;AAOD;IAFC,IAAA,aAAI,EAAC,WAAW,CAAC;IACjB,IAAA,iBAAQ,EAAC,mBAAU,CAAC,EAAE,CAAC;IACb,WAAA,IAAA,aAAI,GAAE,CAAA;;;;gDAEhB;AAMD;IADC,IAAA,YAAG,EAAC,SAAS,CAAC;;;;iDAGd;0BA1GU,eAAe;IAD3B,IAAA,mBAAU,EAAC,OAAO,CAAC;qCAEyB,4BAAY;GAD5C,eAAe,CA2G3B"}

package/dist/src/admin/admin.module.d.ts

@@ -0,0 +1,3 @@
+export declare class AdminModule {
+}
+//# sourceMappingURL=admin.module.d.ts.map

package/dist/src/admin/admin.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin.module.d.ts","sourceRoot":"","sources":["../../../src/admin/admin.module.ts"],"names":[],"mappings":"AAQA,qBAMa,WAAW;CAAG"}

package/dist/src/admin/admin.module.js

@@ -0,0 +1,28 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminModule = void 0;
+const common_1 = require("@nestjs/common");
+const admin_controller_1 = require("./admin.controller");
+const admin_service_1 = require("./admin.service");
+const config_module_1 = require("../config/config.module");
+const connection_module_1 = require("../connection/connection.module");
+const redis_module_1 = require("../redis/redis.module");
+const rate_limit_module_1 = require("../ratelimit/rate-limit.module");
+let AdminModule = class AdminModule {
+};
+exports.AdminModule = AdminModule;
+exports.AdminModule = AdminModule = __decorate([
+    (0, common_1.Module)({
+        imports: [config_module_1.ConfigModule, connection_module_1.ConnectionModule, redis_module_1.RedisModule, rate_limit_module_1.RateLimitModule],
+        controllers: [admin_controller_1.AdminController],
+        providers: [admin_service_1.AdminService],
+        exports: [admin_service_1.AdminService],
+    })
+], AdminModule);
+//# sourceMappingURL=admin.module.js.map

package/dist/src/admin/admin.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin.module.js","sourceRoot":"","sources":["../../../src/admin/admin.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,yDAAqD;AACrD,mDAA+C;AAC/C,2DAAuD;AACvD,uEAAmE;AACnE,wDAAoD;AACpD,sEAAiE;AAQ1D,IAAM,WAAW,GAAjB,MAAM,WAAW;CAAG,CAAA;AAAd,kCAAW;sBAAX,WAAW;IANvB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,4BAAY,EAAE,oCAAgB,EAAE,0BAAW,EAAE,mCAAe,CAAC;QACvE,WAAW,EAAE,CAAC,kCAAe,CAAC;QAC9B,SAAS,EAAE,CAAC,4BAAY,CAAC;QACzB,OAAO,EAAE,CAAC,4BAAY,CAAC;KACxB,CAAC;GACW,WAAW,CAAG"}