Files
trade/data/config/validators.ts
T
Rekey 85a0031a78 feat(data): 实现 Binance WebSocket 适配器与架构重构
- 新增 exchanges/ 模块:MarketDataFeed 统一接口、BaseExchangeAdapter 抽象基类、
  BinanceAdapter 完整实现(WebSocket + REST)
- WebSocket 层基于 binance 官方 SDK 的 WebsocketClient,自动多路复用与断线重连
- REST 层使用 MainClient(Spot),实现 fetchKlines 自动分页补拉 + fetchMarkets 元数据解析
- 数据标准化:Ticker/Trade/OrderBook/Kline 类型定义与 Binance 原生格式互转
- 引入 RxJS Subject 作为统一事件流管道,按 eventType 运行时路由分发
- 重构 config/:YAML 驱动配置加载 + 零依赖运行时校验(fail-fast)
- 重构 db/:TypeORM DataSource 配置 + TimescaleDB K 线 Hypertable 实体
- 新增 utils/logger.ts:Pino 结构化日志(开发环境 pino-pretty 彩色输出)
- 新增 env.yaml 作为 TS/Python 共享的统一环境配置源
- 删除旧版手写 SQL schema 与散落配置文件,收敛到 TypeORM 实体管理
- 安装 rxjs@7.8.2 依赖
2026-06-08 01:24:48 +08:00

150 lines
4.9 KiB
TypeScript

// ============================================================
// validators.ts — env.yaml 配置类型定义与运行时校验
// ============================================================
// 职责:
// 1. 定义 env.yaml 的 TypeScript 接口
// 2. 提供运行时校验函数(零依赖,手动实现)
// 3. 为 config.ts 提供类型安全的配置读取
//
// 使用方式:
// import { validateConfig, type EnvConfig } from "./db/validators";
// const raw = validateConfig(parsedYaml);
// ============================================================
/** env.yaml 顶层结构 */
export interface EnvConfig {
db: DbConfig;
redis: RedisConfig;
logging: LoggingConfig;
}
export interface DbConfig {
host: string;
port: number;
name: string;
user: string;
password: string;
}
export interface RedisConfig {
url: string;
publish_enabled: boolean;
}
export interface LoggingConfig {
level: "trace" | "debug" | "info" | "warn" | "error" | "fatal";
node_env: "development" | "production" | "test";
}
// ============================================================
// 运行时校验(零依赖)
// ============================================================
const VALID_LOG_LEVELS = ["trace", "debug", "info", "warn", "error", "fatal"] as const;
const VALID_NODE_ENVS = ["development", "production", "test"] as const;
/**
* 校验并返回类型安全的配置对象。
* 校验失败时抛出明确错误信息,遵循 fail-fast 原则。
*/
export function validateConfig(raw: unknown): EnvConfig {
if (typeof raw !== "object" || raw === null) {
throw new Error(`[config] env.yaml 顶层必须为 object,实际: ${typeof raw}`);
}
const obj = raw as Record<string, unknown>;
// --- db ---
const db = obj["db"];
if (typeof db !== "object" || db === null) {
throw new Error("[config] env.yaml 缺少 db 配置段");
}
const dbObj = db as Record<string, unknown>;
const dbHost = assertString(dbObj["host"], "db.host");
const dbPort = assertPort(dbObj["port"], "db.port");
const dbName = assertString(dbObj["name"], "db.name");
const dbUser = assertString(dbObj["user"], "db.user");
const dbPassword = assertString(dbObj["password"], "db.password");
// --- redis ---
const redis = obj["redis"];
if (typeof redis !== "object" || redis === null) {
throw new Error("[config] env.yaml 缺少 redis 配置段");
}
const redisObj = redis as Record<string, unknown>;
const redisUrl = assertString(redisObj["url"], "redis.url");
const redisPublishEnabled = assertBoolean(redisObj["publish_enabled"], "redis.publish_enabled");
// --- logging ---
const logging = obj["logging"];
if (typeof logging !== "object" || logging === null) {
throw new Error("[config] env.yaml 缺少 logging 配置段");
}
const logObj = logging as Record<string, unknown>;
const logLevel = assertEnum(logObj["level"], VALID_LOG_LEVELS, "logging.level");
const nodeEnv = assertEnum(logObj["node_env"], VALID_NODE_ENVS, "logging.node_env");
return {
db: {
host: dbHost,
port: dbPort,
name: dbName,
user: dbUser,
password: dbPassword,
},
redis: {
url: redisUrl,
publish_enabled: redisPublishEnabled,
},
logging: {
level: logLevel,
node_env: nodeEnv,
},
};
}
// ============================================================
// 辅助校验函数
// ============================================================
function assertString(value: unknown, path: string): string {
if (typeof value !== "string" || value.trim() === "") {
throw new Error(`[config] ${path} 必须为非空字符串,实际: ${JSON.stringify(value)}`);
}
return value;
}
function assertPort(value: unknown, path: string): number {
if (typeof value === "number" && Number.isInteger(value) && value > 0 && value <= 65535) {
return value;
}
if (typeof value === "string" && /^\d+$/.test(value)) {
const n = parseInt(value, 10);
if (n > 0 && n <= 65535) return n;
}
throw new Error(`[config] ${path} 必须为有效端口号 (1-65535),实际: ${JSON.stringify(value)}`);
}
function assertBoolean(value: unknown, path: string): boolean {
if (typeof value === "boolean") return value;
if (value === "true" || value === "false") return value === "true";
throw new Error(`[config] ${path} 必须为 boolean,实际: ${JSON.stringify(value)}`);
}
function assertEnum<T extends readonly string[]>(
value: unknown,
allowed: T,
path: string,
): T[number] {
const s = String(value);
if ((allowed as readonly string[]).includes(s)) {
return s as T[number];
}
throw new Error(
`[config] ${path} 必须为 ${allowed.join(" | ")} 之一,实际: ${JSON.stringify(value)}`,
);
}