@mindbase/express-common 1.0.0 → 1.0.1

package/tests/FileScanner.test.ts

@@ -1,85 +0,0 @@
-import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
-import path from "path";
-import fs from "fs";
-import { glob } from "glob";
-import * as FileScanner from "../feature/scanner/FileScanner";
-
-// Mock dependencies
-vi.mock("fs");
-vi.mock("glob");
-vi.mock("../../utils/Logger");
-
-// Helper to mock dynamic import
-const mockImport = vi.fn();
-// @ts-ignore
-global.import = mockImport;
-
-describe("文件扫描器", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  afterEach(() => {
-    // Clean up cache file after each test
-    const cacheFile = path.join(process.cwd(), "node_modules/.cache/mindbase/startup-cache.json");
-    if (fs.existsSync(cacheFile)) {
-      // @ts-ignore
-      fs.unlinkSync(cacheFile);
-    }
-  });
-
-  describe("添加扫描路径", () => {
-    it("非绝对路径应该抛出错误", () => {
-      expect(() => FileScanner.addScanPath("./relative")).toThrow("路径必须是绝对路径");
-    });
-
-    it("目录不存在时应该抛出错误", () => {
-      const absPath = path.resolve("/abs/path");
-      vi.mocked(fs.existsSync).mockReturnValue(false);
-      expect(() => FileScanner.addScanPath(absPath)).toThrow("目录不存在");
-    });
-
-    it("路径不是目录时应该抛出错误", () => {
-      const absPath = path.resolve("/abs/path");
-      vi.mocked(fs.existsSync).mockReturnValue(true);
-      vi.mocked(fs.statSync).mockReturnValue({ isDirectory: () => false } as any);
-      expect(() => FileScanner.addScanPath(absPath)).toThrow("路径不是目录");
-    });
-
-    it("应该将有效目录添加到扫描路径", () => {
-      const absPath = path.resolve("/abs/path");
-      vi.mocked(fs.existsSync).mockReturnValue(true);
-      vi.mocked(fs.statSync).mockReturnValue({ isDirectory: () => true } as any);
-
-      expect(() => FileScanner.addScanPath(absPath)).not.toThrow();
-    });
-  });
-
-  describe("执行扫描", () => {
-    it("应该扫描并从添加的路径返回结果", async () => {
-      const absPath = path.resolve("/abs/path");
-      vi.mocked(fs.existsSync).mockReturnValue(true);
-      vi.mocked(fs.statSync).mockReturnValue({ isDirectory: () => true } as any);
-      FileScanner.addScanPath(absPath);
-
-      const mockFiles = [path.join(absPath, "user.route.ts"), path.join(absPath, "auth.middleware.ts")];
-
-      vi.mocked(glob).mockResolvedValue(mockFiles as any);
-
-      // Since we can't easily mock `import()`, we rely on the implementation's try-catch
-      // or we can mock the behavior if we wrap the import.
-      // But FileScanner uses `await import(file)`.
-      // Vitest handles dynamic imports in tests, but we need to ensure the files "exist" for the import to work or be mocked.
-
-      // A better way is to mock the internal logic if possible,
-      // but here we want to test the scanner.
-
-      // Let's mock the glob return to be something we can work with.
-      const results = await FileScanner.scan();
-
-      expect(glob).toHaveBeenCalled();
-      // Even if imports fail in test environment without real files,
-      // we check if it attempted to scan the correct patterns.
-    });
-  });
-});

package/tests/GetModulePath.test.ts

@@ -1,32 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { getModulePath, getModuleDir } from "../core/module/GetModulePath";
-import path from "path";
-
-describe("获取模块路径", () => {
-  it("应该返回路径字符串", () => {
-    const p = getModulePath();
-    expect(typeof p).toBe("string");
-    expect(path.isAbsolute(p)).toBe(true);
-  });
-
-  it("应该返回目录字符串", () => {
-    const d = getModuleDir();
-    expect(typeof d).toBe("string");
-    expect(path.isAbsolute(d)).toBe(true);
-    expect(getModulePath()).toContain(d);
-  });
-
-  it("当 __filename 未定义时应该抛出错误", () => {
-    const originalFilename = global.__filename;
-    // @ts-ignore
-    delete global.__filename;
-
-    // In Vitest/Node environment, __filename is usually defined.
-    // This test might be tricky if we can't delete it.
-    // But let's try.
-
-    // Actually, getModulePath uses `typeof __filename !== "undefined"`
-    // We can mock this behavior by using a fresh import or other means,
-    // but since it's a simple check, we can skip if it's too hard to trigger.
-  });
-});

package/tests/IpParser.test.ts

@@ -1,72 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from "vitest";
-import { Request, Response } from "express";
-
-// Mock Logger
-vi.mock("../utils/Logger");
-
-const { mockFindMap } = vi.hoisted(() => ({
-  mockFindMap: vi.fn(),
-}));
-
-vi.mock("ipip-ipdb", () => {
-  class MockCity {
-    findMap = mockFindMap;
-  }
-  return {
-    City: MockCity,
-    default: {
-      City: MockCity,
-    },
-  };
-});
-
-// Import after mocking
-import ipParser from "../middleware/IpParser";
-
-describe("IP 解析中间件", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it("应该处理本地回环地址", () => {
-    const req = {
-      headers: {},
-      ip: "127.0.0.1",
-    } as unknown as Request;
-    const res = {
-      locals: {},
-    } as unknown as Response;
-    const next = vi.fn();
-
-    ipParser(req, res, next);
-
-    expect(res.locals.ip.isLocal).toBe(true);
-    expect(res.locals.ip.location).toBe("本机");
-    expect(next).toHaveBeenCalled();
-  });
-
-  it("应该从请求头解析 IP", () => {
-    const req = {
-      headers: { "x-real-ip": "1.2.3.4" },
-      ip: "127.0.0.1",
-    } as unknown as Request;
-    const res = {
-      locals: {},
-    } as unknown as Response;
-    const next = vi.fn();
-
-    mockFindMap.mockReturnValue({
-      country_name: "中国",
-      region_name: "北京",
-      city_name: "北京",
-      isp_domain: "测试",
-    });
-
-    ipParser(req, res, next);
-
-    expect(res.locals.ip.address).toBe("1.2.3.4");
-    expect(res.locals.ip.country).toBe("中国");
-    expect(res.locals.ip.location).toBe("中国 北京 北京");
-    expect(next).toHaveBeenCalled();
-  });
-});

package/tests/Logger.test.ts

@@ -1,68 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from "vitest";
-import logger from "../utils/Logger";
-
-describe("Logger", () => {
-  let logSpy: any;
-  let warnSpy: any;
-  let errorSpy: any;
-
-  beforeEach(() => {
-    vi.clearAllMocks();
-    logSpy = vi.spyOn(console, "log").mockImplementation(() => {});
-    warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
-    errorSpy = vi.spyOn(console, "error").mockImplementation(() => {});
-  });
-
-  it("should log info messages", () => {
-    logger.info("Test info message");
-    expect(logSpy).toHaveBeenCalled();
-    const output = logSpy.mock.calls[0][0];
-    expect(output).toContain("Test info message");
-    expect(output).toContain("\x1b[32m"); // Green for info
-  });
-
-  it("应该记录 error 级别日志", () => {
-    logger.error("Test error message");
-    expect(errorSpy).toHaveBeenCalled();
-    const output = errorSpy.mock.calls[0][0];
-    expect(output).toContain("Test error message");
-    expect(output).toContain("\x1b[31m"); // Red for error
-  });
-
-  it("应该截断过长的消息", () => {
-    // Mock terminal width
-    const originalColumns = process.stdout.columns;
-    Object.defineProperty(process.stdout, "columns", { value: 20, configurable: true });
-
-    logger.info("This is a very very long message that should be truncated");
-
-    const output = logSpy.mock.calls[0][0];
-    expect(output).toContain("...");
-
-    // Restore
-    Object.defineProperty(process.stdout, "columns", { value: originalColumns, configurable: true });
-  });
-
-  it("计算视觉宽度时应该处理中日韩字符", () => {
-    logger.info("你好世界");
-    expect(logSpy).toHaveBeenCalled();
-  });
-
-  it("应该能设置和获取日志级别", () => {
-    logger.setLevel("silent");
-    expect(logger.getLevel()).toBe("silent");
-
-    logger.info("This should not be logged");
-    expect(logSpy).not.toHaveBeenCalled();
-
-    logger.setLevel("info");
-    expect(logger.getLevel()).toBe("info");
-  });
-
-  it("当级别为 debug 时应该记录 debug 日志", () => {
-    logger.setLevel("debug");
-    logger.debug("Debug message");
-    expect(logSpy).toHaveBeenCalled();
-    logger.setLevel("info"); // Reset
-  });
-});

package/tests/UaParser.test.ts

@@ -1,41 +0,0 @@
-import { describe, it, expect, vi } from "vitest";
-import uaParser from "../middleware/UaParser";
-import { Request, Response } from "express";
-
-describe("UA 解析中间件", () => {
-  it("应该解析 User-Agent 请求头", () => {
-    const uaString = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36";
-    const req = {
-      headers: { "user-agent": uaString },
-    } as unknown as Request;
-    const res = {
-      locals: {},
-    } as unknown as Response;
-    const next = vi.fn();
-
-    uaParser(req, res, next);
-
-    expect(res.locals.UA.ua).toBe(uaString);
-    expect(res.locals.UA.os.name).toBe("Windows");
-    expect(res.locals.UA.browser.name).toBe("Chrome");
-    expect(res.locals.UA.isMobile).toBe(false);
-    expect(next).toHaveBeenCalled();
-  });
-
-  it("应该检测出移动设备", () => {
-    const uaString = "Mozilla/5.0 (iPhone; CPU iPhone OS 16_6 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Mobile/15E148 Safari/604.1";
-    const req = {
-      headers: { "user-agent": uaString },
-    } as unknown as Request;
-    const res = {
-      locals: {},
-    } as unknown as Response;
-    const next = vi.fn();
-
-    uaParser(req, res, next);
-
-    expect(res.locals.UA.isMobile).toBe(true);
-    expect(res.locals.UA.os.name).toBe("iOS");
-    expect(next).toHaveBeenCalled();
-  });
-});

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": "."
-  },
-  "include": ["./**/*"],
-  "exclude": ["node_modules", "dist"]
-}

package/types/DocTypes.ts

@@ -1,111 +0,0 @@
-import { Request, Response } from "express";
-
-/**
- * 标准 API 响应结构
- */
-export interface ApiResponse<T = any> {
-  code: number;
-  data: T;
-  msg: string;
-}
-
-/**
- * 字段约束规则
- */
-export interface FieldConstraints {
-  min?: number;
-  max?: number;
-  minLength?: number;
-  maxLength?: number;
-  pattern?: string;
-  email?: boolean;
-  url?: boolean;
-  uuid?: boolean;
-  int?: boolean;
-  positive?: boolean;
-  nonnegative?: boolean;
-  custom?: string[];  // 自定义错误消息
-}
-
-/**
- * 字段验证规则
- */
-export interface FieldValidation {
-  type: "string" | "number" | "boolean" | "array" | "object" | "date" | "file" | "any";
-  required: boolean;
-  optional?: boolean;
-  nullable?: boolean;
-  defaultValue?: any;
-  constraints?: FieldConstraints;
-  items?: FieldValidation;  // 数组元素类型
-  properties?: Record<string, FieldValidation>;  // 对象属性
-}
-
-/**
- * 请求 Schema 结构
- */
-export interface RequestSchema {
-  target: "body" | "query" | "params";
-  fields: Record<string, FieldValidation>;
-}
-
-/**
- * 响应 Schema 结构
- */
-export interface ResponseSchema {
-  description?: string;
-  fields: Record<string, FieldValidation>;
-}
-
-/**
- * 路由文档配置
- */
-export interface RouteDocConfig<TRequest = any, TResponse = any> {
-  summary?: string;
-  description?: string;
-  request?: TRequest;
-  response?: TResponse;
-}
-
-/**
- * 路由信息接口
- */
-export interface RouteInfo {
-  id?: number;
-  module: string;
-  method: string;
-  path: string;
-  fullPath: string;
-  summary: string;
-  description: string;
-  requestSchema?: RequestSchema;
-  responseSchema?: ResponseSchema;
-  middlewares?: string[];
-  filePath: string;
-  createdAt?: number;
-  updatedAt?: number;
-}
-
-/**
- * 标记路由文档配置
- */
-export function RouteDoc<TRequest = any, TResponse = any>(config: RouteDocConfig<TRequest, TResponse>) {
-  return function (target: any, propertyKey: string, descriptor: PropertyDescriptor) {
-    // 运行时不做任何处理，仅用于类型定义和静态分析
-  };
-}
-
-/**
- * 模块列表项接口
- */
-export interface ModuleItem {
-  name: string;
-  count: number;
-}
-
-/**
- * 文档数据库配置接口
- */
-export interface DocDatabaseConfig {
-  path: string;
-}

package/types/index.ts

@@ -1,19 +0,0 @@
-export { AppState, MindBaseAppOptions } from "../core/state";
-export { MindBaseApp } from "../core/app";
-export { LogLevel } from "../utils/Logger";
-export { IpInfo } from "../middleware/IpParser";
-export { UaInfo } from "../middleware/UaParser";
-export { ScanResult } from "../feature/scanner/FileScanner";
-export { CronConfig } from "../feature/cron/CronManager";
-export {
-  RouteDoc,
-  ApiResponse,
-  RouteInfo,
-  ModuleItem,
-  DocDatabaseConfig,
-  FieldValidation,
-  FieldConstraints,
-  RequestSchema,
-  ResponseSchema,
-  RouteDocConfig
-} from "./DocTypes";

package/utils/ComponentRegistry.ts

@@ -1,34 +0,0 @@
-import { AppState } from "../core/state";
-import { ScanResult } from "../types/Index";
-import { registerMiddleware } from "./MiddlewareRegistry";
-import { registerRoute } from "./RouteRegistry";
-import logger from "./Logger";
-
-/**
- * 封装细节：遍历扫描结果并注册所有组件（中间件和路由）
- */
-export async function registerComponents(state: AppState, scannedResults: ScanResult[]) {
-  // 1. 先注册所有中间件
-  for (const item of scannedResults) {
-    if (item.type === "middleware") {
-      registerMiddleware(state.express, item);
-    }
-  }
-
-  // 2. 再注册所有路由
-  for (const item of scannedResults) {
-    if (item.type === "route") {
-      registerRoute(state.express, item, state.options.apiPrefix);
-    }
-  }
-
-  // 3. 所有组件注册完成后，触发路由资源同步（如果有）
-  const syncAppRoutes = state.express.get("syncAppRoutes");
-  if (syncAppRoutes && typeof syncAppRoutes === "function") {
-    try {
-      await syncAppRoutes();
-    } catch (error) {
-      logger.error("[ComponentRegistry] 路由资源同步失败:", error);
-    }
-  }
-}

package/utils/DatabaseMigration.ts

@@ -1,121 +0,0 @@
-import { AppState } from "../core/state";
-import logger from "./Logger";
-
-/**
- * 通过代码调用的方式执行数据库迁移
- * @param db 数据库实例
- * @param schemas 数据库 schema 定义
- * @returns 迁移是否成功
- */
-export async function executeDatabaseMigration(db: any, schemas: Record<string, any>): Promise<boolean> {
-  try {
-    if (!db) {
-      logger.error("数据库实例不能为空");
-      return false;
-    }
-
-    if (!schemas) {
-      logger.error("数据库 schema 定义不能为空");
-      return false;
-    }
-
-    logger.startup("数据库", "开始执行数据库表结构同步...");
-
-    // 方案：调用 drizzle-kit push 命令
-    try {
-      const { spawn } = await import("child_process");
-
-      logger.startup("数据库", "正在调用 drizzle-kit push 同步表结构...");
-
-      // 使用 drizzle-kit push 命令，捕获输出以判断错误类型
-      const result = await new Promise<boolean>((resolve) => {
-        let output = "";
-        let errorOutput = "";
-
-        const push = spawn("npx", ["drizzle-kit", "push"], {
-          shell: true,
-        });
-
-        push.stdout?.on("data", (data) => {
-          const text = data.toString();
-          output += text;
-        });
-
-        push.stderr?.on("data", (data) => {
-          const text = data.toString();
-          errorOutput += text;
-        });
-
-        push.on("close", (code) => {
-          if (code === 0) {
-            logger.startup("数据库", "✅ drizzle-kit push 执行成功");
-            resolve(true);
-          } else {
-            // 检查是否是已存在对象的良性错误
-            const errorMsg = errorOutput || output;
-            const benignErrors = [
-              "already exists",
-              "索引.*已存在",
-              "index.*already exists",
-              "table.*already exists",
-            ];
-
-            const isBenign = benignErrors.some((pattern) =>
-              new RegExp(pattern, "i").test(errorMsg)
-            );
-
-            if (isBenign) {
-              logger.startup("数据库", "✅ 数据库结构已同步（索引/表已存在）");
-              resolve(true);
-            } else {
-              logger.error(`❌ drizzle-kit push 执行失败，退出码: ${code}`);
-              if (errorMsg) {
-                logger.error(errorMsg);
-              }
-              resolve(false);
-            }
-          }
-        });
-
-        push.on("error", (error) => {
-          logger.error("执行 drizzle-kit push 时出错:", error);
-          resolve(false);
-        });
-      });
-
-      return result;
-    } catch (pushError) {
-      logger.error("调用 drizzle-kit push 失败:", pushError);
-      logger.info("💡 提示：请手动运行 'npx drizzle-kit push' 来同步表结构");
-      return false;
-    }
-  } catch (error) {
-    logger.error("数据库迁移执行失败:", error);
-    return false;
-  }
-}
-
-/**
- * 检查并执行数据库迁移（如果需要）
- * @param state 应用状态
- * @returns 迁移是否成功
- */
-export async function checkAndMigrateDatabase(state: AppState): Promise<boolean> {
-  try {
-    if (!state || !state.db || !state.schemas) {
-      logger.error("应用状态、数据库实例或 schema 定义不能为空");
-      return false;
-    }
-
-    // 检查 schema 是否有定义
-    if (Object.keys(state.schemas).length === 0) {
-      return true;
-    }
-
-    // 执行数据库迁移
-    return await executeDatabaseMigration(state.db, state.schemas);
-  } catch (error) {
-    logger.error("检查并执行数据库迁移失败:", error);
-    return false;
-  }
-}

package/utils/Dayjs.ts

@@ -1,16 +0,0 @@
-import dayjs from "dayjs";
-import "dayjs/locale/zh-cn";
-import duration from "dayjs/plugin/duration";
-import relativeTime from "dayjs/plugin/relativeTime";
-import utc from "dayjs/plugin/utc";
-
-// 设置中文语言包
-dayjs.locale("zh-cn");
-
-// 注册常用插件
-dayjs.extend(utc);
-dayjs.extend(duration);
-dayjs.extend(relativeTime);
-
-export default dayjs;
-export { dayjs };