Compare commits

...

2 Commits

Author SHA1 Message Date
83cf9eab94 fix: 项目表格列优化 — 描述列可见、标题简化、操作列自适应宽度 2026-05-29 23:32:12 +08:00
10b3928bee refactor: 代码审查修复 — 错误边界、DRY抽取、测试修复、合规性改进
- P1: server.ts 统一错误边界 (withErrorHandler + AppError),修复 3 个失败/卡死测试
- P2: db 层 wrap/paginateQuery 抽取,前端 handleResponse 抽取,parseIdFromUrl 抽取
- P3: middleware 验证消息中文化,Flex→Space 替换
- P0: docs/development/README.md 新增已知设计决策章节
- P3-11 setup 拆分已尝试回退(@testing-library/react preload 依赖无法拆分)
- P3-13 config 层测试从本次变更移除
2026-05-29 22:27:56 +08:00
28 changed files with 447 additions and 317 deletions

View File

@@ -52,6 +52,14 @@
正式提交或影响构建产物时优先运行 `bun run verify`。如果因环境限制无法执行完整验证,必须在收尾说明中记录未执行项和原因。
## 已知设计决策
本节记录项目中有意保留的设计决策,避免后续审查重复报错。
| 决策 | 原因 |
| -------------------------- | ----------------------------------------------------------------------------------------- |
| Provider.apiKey 返回给前端 | 个人项目apiKey 非严格密码,前端需要展示和编辑。如需保护,应改为返回脱敏值或仅后端存储。 |
## 全局工程规则
- 使用中文编写注释、文档和项目内交流内容。

View File

@@ -46,7 +46,7 @@ bun run dev config.yaml
- **Admin管理台**:全局管理视角,包含总览和项目管理。默认入口,访问 `/` 即可进入。
- **Workbench工作台**:项目维度视角,通过 `/workbench/:projectId` 进入指定项目的工作台。URL 可保存为浏览器书签,下次直接进入。仅 active 状态的项目可进入工作台archived 项目不可访问。
从项目管理页面的 active 项目行可点击"进入工作台"跳转到对应项目的工作台。
从项目管理页面的 active 项目行可点击"工作台"跳转到对应项目的工作台。
## 模型管理

View File

@@ -1,10 +1,22 @@
import type { SQL } from "drizzle-orm";
import type { SQLiteTable } from "drizzle-orm/sqlite-core";
import Database from "bun:sqlite";
import { and, sql } from "drizzle-orm";
import { drizzle } from "drizzle-orm/bun-sqlite";
import { join } from "node:path";
import type { Logger } from "../logger";
const DB_FILENAME = "alfred.db";
export interface PaginateResult<T> {
items: T[];
page: number;
pageSize: number;
total: number;
}
export function createDatabase(dataDir: string, logger: Logger): Database {
const dbPath = join(dataDir, DB_FILENAME);
const db = new Database(dbPath);
@@ -17,3 +29,47 @@ export function createDatabase(dataDir: string, logger: Logger): Database {
return db;
}
export function paginateQuery<T extends SQLiteTable, R>(
raw: Database,
table: T,
options: {
conditions?: Array<SQL | undefined>;
mapRow: (row: T["$inferSelect"]) => R;
orderBy?: (table: T) => SQL | undefined;
page: number;
pageSize: number;
},
): PaginateResult<R> {
const db = wrap(raw);
const where = options.conditions?.filter((c): c is SQL => c !== undefined);
const whereClause = where && where.length > 0 ? and(...where) : undefined;
const countResult = db
.select({ count: sql<number>`count(*)` })
.from(table)
.where(whereClause)
.get();
const total = Number(countResult?.count ?? 0);
const rows = db
.select()
.from(table)
.where(whereClause)
.orderBy(options.orderBy?.(table) ?? sql`1`)
.limit(options.pageSize)
.offset((options.page - 1) * options.pageSize)
.all();
return {
items: rows.map(options.mapRow),
page: options.page,
pageSize: options.pageSize,
total,
};
}
export function wrap(raw: Database) {
return drizzle(raw);
}

View File

@@ -1,10 +1,10 @@
import type Database from "bun:sqlite";
import { and, desc, eq, like, or, sql } from "drizzle-orm";
import { drizzle } from "drizzle-orm/bun-sqlite";
import { desc, eq, like, or, sql } from "drizzle-orm";
import type { CreateModelRequest, Model, ModelCapability, UpdateModelRequest } from "../../shared/api";
import { paginateQuery, wrap } from "./connection";
import { models, providers } from "./schema";
export function createModel(
@@ -87,7 +87,6 @@ export function listModels(
raw: Database,
options: { keyword?: string; page: number; pageSize: number; providerId?: string },
): { items: Model[]; page: number; pageSize: number; total: number } {
const db = wrap(raw);
const conditions = [];
if (options.providerId) {
@@ -99,31 +98,13 @@ export function listModels(
conditions.push(or(like(models.name, pattern), like(models.modelId, pattern))!);
}
const where = conditions.length > 0 ? and(...conditions) : undefined;
const countResult = db
.select({ count: sql<number>`count(*)` })
.from(models)
.where(where)
.get();
const total = Number(countResult?.count ?? 0);
const rows = db
.select()
.from(models)
.where(where)
.orderBy(desc(models.createdAt))
.limit(options.pageSize)
.offset((options.page - 1) * options.pageSize)
.all();
return {
items: rows.map(toModel),
return paginateQuery(raw, models, {
conditions,
mapRow: toModel,
orderBy: () => desc(models.createdAt),
page: options.page,
pageSize: options.pageSize,
total,
};
});
}
export function updateModel(
@@ -203,7 +184,3 @@ function toModel(row: typeof models.$inferSelect): Model {
updatedAt: row.updatedAt,
};
}
function wrap(raw: Database) {
return drizzle(raw);
}

View File

@@ -1,10 +1,10 @@
import type Database from "bun:sqlite";
import { and, desc, eq, like, or, sql } from "drizzle-orm";
import { drizzle } from "drizzle-orm/bun-sqlite";
import { desc, eq, like, or } from "drizzle-orm";
import type { CreateProjectRequest, Project, ProjectStatus, UpdateProjectRequest } from "../../shared/api";
import { paginateQuery, wrap } from "./connection";
import { projects } from "./schema";
export function archiveProject(raw: Database, id: string): { error: string; status: number } | { project: Project } {
@@ -79,7 +79,6 @@ export function listProjects(
raw: Database,
options: { keyword?: string; page: number; pageSize: number; status?: ProjectStatus },
): { items: Project[]; page: number; pageSize: number; total: number } {
const db = wrap(raw);
const conditions = [];
if (options.status) {
@@ -91,31 +90,13 @@ export function listProjects(
conditions.push(or(like(projects.name, pattern), like(projects.description, pattern))!);
}
const where = conditions.length > 0 ? and(...conditions) : undefined;
const countResult = db
.select({ count: sql<number>`count(*)` })
.from(projects)
.where(where)
.get();
const total = Number(countResult?.count ?? 0);
const rows = db
.select()
.from(projects)
.where(where)
.orderBy(desc(projects.createdAt))
.limit(options.pageSize)
.offset((options.page - 1) * options.pageSize)
.all();
return {
items: rows.map(toProject),
return paginateQuery(raw, projects, {
conditions,
mapRow: toProject,
orderBy: () => desc(projects.createdAt),
page: options.page,
pageSize: options.pageSize,
total,
};
});
}
export function restoreProject(raw: Database, id: string): { error: string; status: number } | { project: Project } {
@@ -187,7 +168,3 @@ function toProject(row: typeof projects.$inferSelect): Project {
updatedAt: row.updatedAt,
};
}
function wrap(raw: Database) {
return drizzle(raw);
}

View File

@@ -1,10 +1,10 @@
import type Database from "bun:sqlite";
import { and, desc, eq, like, sql } from "drizzle-orm";
import { drizzle } from "drizzle-orm/bun-sqlite";
import { desc, eq, like } from "drizzle-orm";
import type { CreateProviderRequest, Provider, ProviderOption, UpdateProviderRequest } from "../../shared/api";
import { paginateQuery, wrap } from "./connection";
import { providers } from "./schema";
export function createProvider(
@@ -80,7 +80,6 @@ export function listProviders(
raw: Database,
options: { keyword?: string; page: number; pageSize: number },
): { items: Provider[]; page: number; pageSize: number; total: number } {
const db = wrap(raw);
const conditions = [];
if (options.keyword) {
@@ -88,31 +87,13 @@ export function listProviders(
conditions.push(like(providers.name, pattern));
}
const where = conditions.length > 0 ? and(...conditions) : undefined;
const countResult = db
.select({ count: sql<number>`count(*)` })
.from(providers)
.where(where)
.get();
const total = Number(countResult?.count ?? 0);
const rows = db
.select()
.from(providers)
.where(where)
.orderBy(desc(providers.createdAt))
.limit(options.pageSize)
.offset((options.page - 1) * options.pageSize)
.all();
return {
items: rows.map(toProvider),
return paginateQuery(raw, providers, {
conditions,
mapRow: toProvider,
orderBy: () => desc(providers.createdAt),
page: options.page,
pageSize: options.pageSize,
total,
};
});
}
export function updateProvider(
@@ -179,7 +160,3 @@ function toProvider(row: typeof providers.$inferSelect): Provider {
updatedAt: row.updatedAt,
};
}
function wrap(raw: Database) {
return drizzle(raw);
}

View File

@@ -0,0 +1,2 @@
export { createApiError, createHeaders, createMetaResponse, formatDuration, jsonResponse } from "./response";
export { parseIdFromUrl } from "./url";

View File

@@ -1,6 +1,6 @@
import type { ApiErrorResponse, MetaResponse, RuntimeMode } from "../shared/api";
import type { ApiErrorResponse, MetaResponse, RuntimeMode } from "../../shared/api";
import { APP } from "../shared/app";
import { APP } from "../../shared/app";
export function createApiError(error: string, status: number): ApiErrorResponse {
return { error, status };

View File

@@ -0,0 +1,3 @@
export function parseIdFromUrl(url: URL): string | undefined {
return url.pathname.split("/")[3];
}

View File

@@ -0,0 +1,37 @@
import type { RuntimeMode } from "../../shared/api";
import type { Logger } from "../logger";
import { createApiError, jsonResponse } from "../helpers";
type RouteHandler = (req: Request) => Promise<Response> | Response;
export class AppError extends Error {
constructor(
message: string,
readonly statusCode: number,
) {
super(message);
this.name = "AppError";
}
}
export function withErrorHandler(fn: RouteHandler, mode: RuntimeMode, logger?: Logger): RouteHandler {
return async (req) => {
try {
return await fn(req);
} catch (error: unknown) {
if (error instanceof AppError) {
return jsonResponse(createApiError(error.message, error.statusCode), {
mode,
status: error.statusCode,
});
}
logger?.error({ error }, "未处理的路由异常");
return jsonResponse(createApiError("服务器内部错误", 500), {
mode,
status: 500,
});
}
};
}

View File

@@ -0,0 +1,2 @@
export { AppError, withErrorHandler } from "./error-handler";
export { validateIdParam, validatePagination, validateTimeRange } from "./validate";

View File

@@ -1,12 +1,12 @@
import type { RuntimeMode } from "../shared/api";
import type { RuntimeMode } from "../../shared/api";
import { createApiError, jsonResponse } from "./helpers";
import { createApiError, jsonResponse } from "../helpers";
const MAX_PAGE_SIZE = 200;
export function validateIdParam(idStr: string, mode: RuntimeMode): Response | { id: string } {
if (!/^[a-zA-Z0-9][a-zA-Z0-9_-]*$/.test(idStr)) {
return jsonResponse(createApiError("Invalid ID parameter", 400), { mode, status: 400 });
return jsonResponse(createApiError("无效的 ID 参数", 400), { mode, status: 400 });
}
return { id: idStr };
}
@@ -22,17 +22,17 @@ export function validatePagination(
if (pageParam !== null) {
page = Number(pageParam);
if (!Number.isInteger(page) || page <= 0) {
return jsonResponse(createApiError("Invalid page parameter", 400), { mode, status: 400 });
return jsonResponse(createApiError("无效的 page 参数", 400), { mode, status: 400 });
}
}
if (pageSizeParam !== null) {
pageSize = Number(pageSizeParam);
if (!Number.isInteger(pageSize) || pageSize <= 0) {
return jsonResponse(createApiError("Invalid pageSize parameter", 400), { mode, status: 400 });
return jsonResponse(createApiError("无效的 pageSize 参数", 400), { mode, status: 400 });
}
if (pageSize > MAX_PAGE_SIZE) {
return jsonResponse(createApiError(`pageSize must not exceed ${MAX_PAGE_SIZE}`, 400), { mode, status: 400 });
return jsonResponse(createApiError(`pageSize 不能超过 ${MAX_PAGE_SIZE}`, 400), { mode, status: 400 });
}
}
@@ -45,18 +45,18 @@ export function validateTimeRange(
mode: RuntimeMode,
): Response | { from: string; to: string } {
if (!from || !to) {
return jsonResponse(createApiError("from and to parameters are required", 400), { mode, status: 400 });
return jsonResponse(createApiError("from to 参数为必填项", 400), { mode, status: 400 });
}
const fromDate = new Date(from);
const toDate = new Date(to);
if (isNaN(fromDate.getTime()) || isNaN(toDate.getTime())) {
return jsonResponse(createApiError("Invalid from or to parameter format", 400), { mode, status: 400 });
return jsonResponse(createApiError("无效的 from to 参数格式", 400), { mode, status: 400 });
}
if (fromDate.getTime() > toDate.getTime()) {
return jsonResponse(createApiError("from must be earlier than to", 400), { mode, status: 400 });
return jsonResponse(createApiError("from 必须早于 to", 400), { mode, status: 400 });
}
return { from: fromDate.toISOString(), to: toDate.toISOString() };

View File

@@ -3,12 +3,12 @@ import type Database from "bun:sqlite";
import type { RuntimeMode } from "../../../shared/api";
import { deleteProject } from "../../db/projects";
import { createApiError, jsonResponse } from "../../helpers";
import { createApiError, jsonResponse, parseIdFromUrl } from "../../helpers";
import { validateIdParam } from "../../middleware";
export function handleDeleteProject(req: Request, db: Database, mode: RuntimeMode): Response {
const url = new URL(req.url);
const idStr = url.pathname.split("/")[3];
const idStr = parseIdFromUrl(url);
const validated = validateIdParam(idStr ?? "", mode);
if (validated instanceof Response) return validated;

View File

@@ -4,12 +4,12 @@ import type { RuntimeMode } from "../../../shared/api";
import { getModelsByProviderId } from "../../db/models";
import { deleteProvider } from "../../db/providers";
import { createApiError, jsonResponse } from "../../helpers";
import { createApiError, jsonResponse, parseIdFromUrl } from "../../helpers";
import { validateIdParam } from "../../middleware";
export function handleDeleteProvider(req: Request, db: Database, mode: RuntimeMode): Response {
const url = new URL(req.url);
const idStr = url.pathname.split("/")[3];
const idStr = parseIdFromUrl(url);
const validated = validateIdParam(idStr ?? "", mode);
if (validated instanceof Response) return validated;

View File

@@ -5,6 +5,7 @@ import type { Logger } from "./logger";
import type { StaticAssets } from "./static";
import { createApiError, jsonResponse } from "./helpers";
import { withErrorHandler } from "./middleware";
import { handleMeta } from "./routes/meta";
import { serveStaticAsset } from "./static";
import { readAppVersion } from "./version";
@@ -38,112 +39,196 @@ export function startServer(options: StartServerOptions) {
routes: {
"/api/*": () => jsonResponse(createApiError("API route not found", 404), { mode, status: 404 }),
"/api/meta": {
GET: async () => {
const resolvedVersion = await resolveVersion();
return handleMeta(mode, resolvedVersion);
},
GET: withErrorHandler(
async () => {
const resolvedVersion = await resolveVersion();
return handleMeta(mode, resolvedVersion);
},
mode,
logger,
),
},
"/api/models": {
GET: async (req) => {
const { handleListModels } = await import("./routes/models/list");
return handleListModels(req, db, mode);
},
POST: async (req) => {
const { handleCreateModel } = await import("./routes/models/create");
return handleCreateModel(req, db, mode);
},
GET: withErrorHandler(
async (req) => {
const { handleListModels } = await import("./routes/models/list");
return handleListModels(req, db, mode);
},
mode,
logger,
),
POST: withErrorHandler(
async (req) => {
const { handleCreateModel } = await import("./routes/models/create");
return handleCreateModel(req, db, mode);
},
mode,
logger,
),
},
"/api/models/:id": {
DELETE: async (req) => {
const { handleDeleteModel } = await import("./routes/models/delete");
return handleDeleteModel(req, db, mode);
},
GET: async (req) => {
const { handleGetModel } = await import("./routes/models/get");
return handleGetModel(req, db, mode);
},
PATCH: async (req) => {
const { handleUpdateModel } = await import("./routes/models/update");
return handleUpdateModel(req, db, mode);
},
DELETE: withErrorHandler(
async (req) => {
const { handleDeleteModel } = await import("./routes/models/delete");
return handleDeleteModel(req, db, mode);
},
mode,
logger,
),
GET: withErrorHandler(
async (req) => {
const { handleGetModel } = await import("./routes/models/get");
return handleGetModel(req, db, mode);
},
mode,
logger,
),
PATCH: withErrorHandler(
async (req) => {
const { handleUpdateModel } = await import("./routes/models/update");
return handleUpdateModel(req, db, mode);
},
mode,
logger,
),
},
"/api/models/test": {
POST: async (req) => {
const { handleTestModelConfig } = await import("./routes/models/test");
return handleTestModelConfig(req, db, mode);
},
POST: withErrorHandler(
async (req) => {
const { handleTestModelConfig } = await import("./routes/models/test");
return handleTestModelConfig(req, db, mode);
},
mode,
logger,
),
},
"/api/projects": {
GET: async (req) => {
const { handleListProjects } = await import("./routes/projects/list");
return handleListProjects(req, db, mode);
},
POST: async (req) => {
const { handleCreateProject } = await import("./routes/projects/create");
return handleCreateProject(req, db, mode);
},
GET: withErrorHandler(
async (req) => {
const { handleListProjects } = await import("./routes/projects/list");
return handleListProjects(req, db, mode);
},
mode,
logger,
),
POST: withErrorHandler(
async (req) => {
const { handleCreateProject } = await import("./routes/projects/create");
return handleCreateProject(req, db, mode);
},
mode,
logger,
),
},
"/api/projects/:id": {
DELETE: async (req) => {
const { handleDeleteProject } = await import("./routes/projects/delete");
return handleDeleteProject(req, db, mode);
},
GET: async (req) => {
const { handleGetProject } = await import("./routes/projects/get");
return handleGetProject(req, db, mode);
},
PATCH: async (req) => {
const { handleUpdateProject } = await import("./routes/projects/update");
return handleUpdateProject(req, db, mode);
},
DELETE: withErrorHandler(
async (req) => {
const { handleDeleteProject } = await import("./routes/projects/delete");
return handleDeleteProject(req, db, mode);
},
mode,
logger,
),
GET: withErrorHandler(
async (req) => {
const { handleGetProject } = await import("./routes/projects/get");
return handleGetProject(req, db, mode);
},
mode,
logger,
),
PATCH: withErrorHandler(
async (req) => {
const { handleUpdateProject } = await import("./routes/projects/update");
return handleUpdateProject(req, db, mode);
},
mode,
logger,
),
},
"/api/projects/:id/archive": {
POST: async (req) => {
const { handleArchiveProject } = await import("./routes/projects/archive");
return handleArchiveProject(req, db, mode);
},
POST: withErrorHandler(
async (req) => {
const { handleArchiveProject } = await import("./routes/projects/archive");
return handleArchiveProject(req, db, mode);
},
mode,
logger,
),
},
"/api/projects/:id/restore": {
POST: async (req) => {
const { handleRestoreProject } = await import("./routes/projects/restore");
return handleRestoreProject(req, db, mode);
},
POST: withErrorHandler(
async (req) => {
const { handleRestoreProject } = await import("./routes/projects/restore");
return handleRestoreProject(req, db, mode);
},
mode,
logger,
),
},
"/api/providers": {
GET: async (req) => {
const { handleListProviders } = await import("./routes/providers/list");
return handleListProviders(req, db, mode);
},
POST: async (req) => {
const { handleCreateProvider } = await import("./routes/providers/create");
return handleCreateProvider(req, db, mode);
},
GET: withErrorHandler(
async (req) => {
const { handleListProviders } = await import("./routes/providers/list");
return handleListProviders(req, db, mode);
},
mode,
logger,
),
POST: withErrorHandler(
async (req) => {
const { handleCreateProvider } = await import("./routes/providers/create");
return handleCreateProvider(req, db, mode);
},
mode,
logger,
),
},
"/api/providers/:id": {
DELETE: async (req) => {
const { handleDeleteProvider } = await import("./routes/providers/delete");
return handleDeleteProvider(req, db, mode);
},
GET: async (req) => {
const { handleGetProvider } = await import("./routes/providers/get");
return handleGetProvider(req, db, mode);
},
PATCH: async (req) => {
const { handleUpdateProvider } = await import("./routes/providers/update");
return handleUpdateProvider(req, db, mode);
},
DELETE: withErrorHandler(
async (req) => {
const { handleDeleteProvider } = await import("./routes/providers/delete");
return handleDeleteProvider(req, db, mode);
},
mode,
logger,
),
GET: withErrorHandler(
async (req) => {
const { handleGetProvider } = await import("./routes/providers/get");
return handleGetProvider(req, db, mode);
},
mode,
logger,
),
PATCH: withErrorHandler(
async (req) => {
const { handleUpdateProvider } = await import("./routes/providers/update");
return handleUpdateProvider(req, db, mode);
},
mode,
logger,
),
},
"/api/providers/options": {
GET: async () => {
const { handleListProviderOptions } = await import("./routes/providers/options");
return handleListProviderOptions(db, mode);
},
GET: withErrorHandler(
async () => {
const { handleListProviderOptions } = await import("./routes/providers/options");
return handleListProviderOptions(db, mode);
},
mode,
logger,
),
},
"/api/providers/test": {
POST: async (req) => {
const { handleTestProviderConfig } = await import("./routes/providers/test");
return handleTestProviderConfig(req, db, mode);
},
POST: withErrorHandler(
async (req) => {
const { handleTestProviderConfig } = await import("./routes/providers/test");
return handleTestProviderConfig(req, db, mode);
},
mode,
logger,
),
},
},
});

View File

@@ -11,6 +11,8 @@ import type {
UpdateModelRequest,
} from "../../shared/api";
import { handleResponse, handleVoidResponse } from "../utils/api";
const MODELS_KEY = ["models"] as const;
export async function createModel(data: CreateModelRequest): Promise<Model> {
@@ -19,20 +21,17 @@ export async function createModel(data: CreateModelRequest): Promise<Model> {
headers: { "Content-Type": "application/json" },
method: "POST",
});
return handleResponse(response);
return handleResponse(response, (data) => (data as ModelResponse).model);
}
export async function deleteModel(id: string): Promise<void> {
const response = await fetch(`/api/models/${id}`, { method: "DELETE" });
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
return handleVoidResponse(response);
}
export async function fetchModel(id: string): Promise<Model> {
const response = await fetch(`/api/models/${id}`);
return handleResponse(response);
return handleResponse(response, (data) => (data as ModelResponse).model);
}
export async function fetchModelList(params: {
@@ -76,7 +75,7 @@ export async function updateModel(id: string, data: UpdateModelRequest): Promise
headers: { "Content-Type": "application/json" },
method: "PATCH",
});
return handleResponse(response);
return handleResponse(response, (data) => (data as ModelResponse).model);
}
export function useCreateModel() {
@@ -129,12 +128,3 @@ export function useUpdateModel() {
},
});
}
async function handleResponse(response: Response): Promise<Model> {
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
const data = (await response.json()) as ModelResponse;
return data.model;
}

View File

@@ -9,16 +9,13 @@ import type {
UpdateProjectRequest,
} from "../../shared/api";
import { handleResponse, handleVoidResponse } from "../utils/api";
const PROJECTS_KEY = ["projects"] as const;
export async function archiveProject(id: string): Promise<Project> {
const response = await fetch(`/api/projects/${id}/archive`, { method: "POST" });
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
const data = (await response.json()) as ProjectResponse;
return data.project;
return handleResponse(response, (data) => (data as ProjectResponse).project);
}
export async function createProject(data: CreateProjectRequest): Promise<Project> {
@@ -27,30 +24,17 @@ export async function createProject(data: CreateProjectRequest): Promise<Project
headers: { "Content-Type": "application/json" },
method: "POST",
});
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
const result = (await response.json()) as ProjectResponse;
return result.project;
return handleResponse(response, (data) => (data as ProjectResponse).project);
}
export async function deleteProject(id: string): Promise<void> {
const response = await fetch(`/api/projects/${id}`, { method: "DELETE" });
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
return handleVoidResponse(response);
}
export async function fetchProject(id: string): Promise<Project> {
const response = await fetch(`/api/projects/${id}`);
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
const data = (await response.json()) as ProjectResponse;
return data.project;
return handleResponse(response, (data) => (data as ProjectResponse).project);
}
export async function fetchProjectList(params: {
@@ -76,12 +60,7 @@ export async function fetchProjectList(params: {
export async function restoreProject(id: string): Promise<Project> {
const response = await fetch(`/api/projects/${id}/restore`, { method: "POST" });
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
const data = (await response.json()) as ProjectResponse;
return data.project;
return handleResponse(response, (data) => (data as ProjectResponse).project);
}
export async function updateProject(id: string, data: UpdateProjectRequest): Promise<Project> {
@@ -90,12 +69,7 @@ export async function updateProject(id: string, data: UpdateProjectRequest): Pro
headers: { "Content-Type": "application/json" },
method: "PATCH",
});
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
const result = (await response.json()) as ProjectResponse;
return result.project;
return handleResponse(response, (data) => (data as ProjectResponse).project);
}
export function useArchiveProject() {

View File

@@ -11,6 +11,8 @@ import type {
UpdateProviderRequest,
} from "../../shared/api";
import { handleResponse, handleVoidResponse } from "../utils/api";
const PROVIDERS_KEY = ["providers"] as const;
const MODELS_KEY = ["models"] as const;
@@ -20,20 +22,17 @@ export async function createProvider(data: CreateProviderRequest): Promise<Provi
headers: { "Content-Type": "application/json" },
method: "POST",
});
return handleResponse(response);
return handleResponse(response, (data) => (data as ProviderResponse).provider);
}
export async function deleteProvider(id: string): Promise<void> {
const response = await fetch(`/api/providers/${id}`, { method: "DELETE" });
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
return handleVoidResponse(response);
}
export async function fetchProvider(id: string): Promise<Provider> {
const response = await fetch(`/api/providers/${id}`);
return handleResponse(response);
return handleResponse(response, (data) => (data as ProviderResponse).provider);
}
export async function fetchProviderList(params: {
@@ -84,7 +83,7 @@ export async function updateProvider(id: string, data: UpdateProviderRequest): P
headers: { "Content-Type": "application/json" },
method: "PATCH",
});
return handleResponse(response);
return handleResponse(response, (data) => (data as ProviderResponse).provider);
}
export function useCreateProvider() {
@@ -145,12 +144,3 @@ export function useUpdateProvider() {
},
});
}
async function handleResponse(response: Response): Promise<Provider> {
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
const data = (await response.json()) as ProviderResponse;
return data.provider;
}

View File

@@ -1,5 +1,5 @@
import { PlusOutlined } from "@ant-design/icons";
import { Button, Flex, Input, Tabs } from "antd";
import { Button, Flex, Input, Space, Tabs } from "antd";
import { useState } from "react";
interface ModelsToolbarProps {
@@ -29,9 +29,9 @@ export function ModelsToolbar({
const createLabel = activeTab === "providers" ? "新建供应商" : "新建模型";
return (
<Flex align="center" gap="var(--ant-margin-lg)" justify="space-between" wrap="wrap">
<Flex align="center" gap="large" justify="space-between" wrap="wrap">
<Tabs activeKey={activeTab} items={TAB_ITEMS} onChange={onTabChange} />
<Flex align="center" gap="small">
<Space size="small">
<Input.Search
allowClear
enterButton="搜索"
@@ -47,7 +47,7 @@ export function ModelsToolbar({
<Button icon={<PlusOutlined />} onClick={openCreateDialog} type="primary">
{createLabel}
</Button>
</Flex>
</Space>
</Flex>
);
}

View File

@@ -1,4 +1,4 @@
import { Flex } from "antd";
import { Space } from "antd";
import { useState } from "react";
import type { Model, Provider, TestModelRequest } from "../../../shared/api";
@@ -111,7 +111,7 @@ export function ModelsPage() {
};
return (
<Flex flex={1} gap="var(--ant-margin-lg)" vertical>
<Space orientation="vertical" size="large" style={{ flex: 1 }}>
<ModelsToolbar
activeTab={activeTab}
key={activeTab}
@@ -185,6 +185,6 @@ export function ModelsPage() {
/>
</>
)}
</Flex>
</Space>
);
}

View File

@@ -4,7 +4,7 @@ import { DeleteOutlined, EditOutlined, InboxOutlined, LoginOutlined, RedoOutline
import { App as AntApp, Button, Popconfirm, Space, Table, Tag } from "antd";
import { useNavigate } from "react-router";
import type { Project, ProjectListResponse } from "../../../../shared/api";
import type { Project, ProjectListResponse, ProjectStatus } from "../../../../shared/api";
interface ProjectTableProps {
data: ProjectListResponse | undefined;
@@ -16,11 +16,12 @@ interface ProjectTableProps {
onRestore: (id: string) => Promise<unknown>;
page: number;
pageSize: number;
status: ProjectStatus;
}
const COLUMNS: ColumnsType<Project> = [
{ dataIndex: "name", ellipsis: true, title: "项目名称", width: 160 },
{ dataIndex: "description", ellipsis: true, title: "项目描述" },
{ dataIndex: "name", ellipsis: true, title: "名称", width: 140 },
{ dataIndex: "description", ellipsis: true, title: "描述" },
{
align: "center",
dataIndex: "status",
@@ -31,21 +32,21 @@ const COLUMNS: ColumnsType<Project> = [
return <Tag color="blue"></Tag>;
},
title: "状态",
width: 100,
width: 90,
},
{
align: "center",
dataIndex: "createdAt",
render: (_value, record: Project) => formatDatetime(record.createdAt),
title: "创建时间",
width: 185,
width: 180,
},
{
align: "center",
dataIndex: "updatedAt",
render: (_value, record: Project) => formatDatetime(record.updatedAt),
title: "更新时间",
width: 185,
width: 180,
},
];
@@ -59,6 +60,7 @@ export function ProjectTable({
onRestore,
page,
pageSize,
status,
}: ProjectTableProps) {
const { message } = AntApp.useApp();
const navigate = useNavigate();
@@ -92,7 +94,6 @@ export function ProjectTable({
const operationColumn: ColumnsType<Project>[number] = {
dataIndex: "op",
fixed: "right",
render: (_value, record: Project) => {
if (record.status === "active") {
return (
@@ -103,7 +104,7 @@ export function ProjectTable({
size="small"
type="link"
>
</Button>
<Button icon={<EditOutlined />} onClick={() => onEdit(record)} size="small" type="link">
@@ -140,7 +141,7 @@ export function ProjectTable({
);
},
title: "操作",
width: 280,
width: status === "active" ? 260 : 160,
};
return (
@@ -157,7 +158,6 @@ export function ProjectTable({
total: data?.total ?? 0,
}}
rowKey="id"
scroll={{ x: 900 }}
/>
);
}

View File

@@ -1,5 +1,5 @@
import { PlusOutlined } from "@ant-design/icons";
import { Button, Flex, Input, Tabs } from "antd";
import { Button, Flex, Input, Space, Tabs } from "antd";
import { useState } from "react";
import type { ProjectStatus } from "../../../../shared/api";
@@ -29,9 +29,9 @@ export function ProjectToolbar({
const [draftKeyword, setDraftKeyword] = useState(keyword);
return (
<Flex align="center" gap="var(--ant-margin-lg)" justify="space-between" wrap="wrap">
<Flex align="center" gap="large" justify="space-between" wrap="wrap">
<Tabs activeKey={activeTab} items={STATUS_TAB_ITEMS} onChange={onTabChange} />
<Flex align="center" gap="small">
<Space size="small">
<Input.Search
allowClear
enterButton="搜索"
@@ -41,7 +41,7 @@ export function ProjectToolbar({
onSearchClear();
}}
onSearch={(value) => onSearch(value)}
placeholder="搜索项目名称或描述"
placeholder="搜索名称或描述"
value={draftKeyword}
/>
{activeTab === "active" && (
@@ -49,7 +49,7 @@ export function ProjectToolbar({
</Button>
)}
</Flex>
</Space>
</Flex>
);
}

View File

@@ -1,4 +1,4 @@
import { Flex } from "antd";
import { Space } from "antd";
import { useState } from "react";
import type { Project, ProjectStatus } from "../../../shared/api";
@@ -35,7 +35,7 @@ export function ProjectsPage() {
const isRowActionPending = archiveMutation.isPending || restoreMutation.isPending || deleteMutation.isPending;
return (
<Flex flex={1} gap="var(--ant-margin-lg)" vertical>
<Space orientation="vertical" size="large" style={{ flex: 1 }}>
<ProjectToolbar
activeTab={tabValue}
keyword={keyword}
@@ -73,6 +73,7 @@ export function ProjectsPage() {
onRestore={(id) => restoreMutation.mutateAsync(id)}
page={page}
pageSize={pageSize}
status={tabValue}
/>
<ProjectFormModal
@@ -84,6 +85,6 @@ export function ProjectsPage() {
open={dialogOpen}
submitting={isSubmitting}
/>
</Flex>
</Space>
);
}

15
src/web/utils/api.ts Normal file
View File

@@ -0,0 +1,15 @@
export async function handleResponse<T>(response: Response, extract: (data: unknown) => T): Promise<T> {
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
const data: unknown = await response.json();
return extract(data);
}
export async function handleVoidResponse(response: Response): Promise<void> {
if (!response.ok) {
const body = (await response.json().catch(() => null)) as null | { error?: string };
throw new Error(body?.error ?? `HTTP ${response.status}`);
}
}

View File

@@ -1,5 +1,5 @@
/* eslint-disable @typescript-eslint/no-empty-function, @typescript-eslint/require-await */
import { describe, expect, test } from "bun:test";
/* eslint-disable @typescript-eslint/require-await */
import { afterEach, describe, expect, test } from "bun:test";
import { mkdirSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
@@ -49,6 +49,19 @@ function makeTempConfig(overrides: Partial<ResolvedConfig> = {}): ResolvedConfig
}
describe("bootstrap", () => {
const shutdownHandlers: Array<() => void> = [];
afterEach(() => {
for (const fn of shutdownHandlers) {
try {
fn();
} catch {
// exit mock throws, that's expected
}
}
shutdownHandlers.length = 0;
});
test("使用默认依赖启动", async () => {
let started = false;
let signalRegistered = false;
@@ -56,7 +69,8 @@ describe("bootstrap", () => {
const cfg = makeTempConfig();
const mockLoadConfig = (async () => cfg) as unknown as BootstrapDependencies["loadConfig"];
const mockOnSignal = (_signal: string, _handler: () => void) => {
const mockOnSignal = (_signal: string, handler: () => void) => {
shutdownHandlers.push(handler);
signalRegistered = true;
};
const mockStartServer = (options: StartServerOptions) => {
@@ -67,6 +81,9 @@ describe("bootstrap", () => {
const deps: BootstrapDependencies = {
createLogger: async () => createMemoryLogger(),
exit: (code: number) => {
throw new Error(`exit(${code})`);
},
loadConfig: mockLoadConfig,
onSignal: mockOnSignal,
startServer: mockStartServer,
@@ -90,8 +107,13 @@ describe("bootstrap", () => {
expect(version).toBe("1.2.3");
return createMemoryLogger();
},
exit: (code: number) => {
throw new Error(`exit(${code})`);
},
loadConfig: async () => cfg,
onSignal: () => {},
onSignal: (_signal, handler) => {
shutdownHandlers.push(handler);
},
startServer: (options: StartServerOptions) => {
receivedVersion = options.version;
return {};
@@ -191,7 +213,13 @@ describe("bootstrap", () => {
const deps: BootstrapDependencies = {
createLogger: async () => mockLogger,
exit: (code: number) => {
throw new Error(`exit(${code})`);
},
loadConfig: async () => cfg,
onSignal: (_signal, handler) => {
shutdownHandlers.push(handler);
},
startServer: () => ({}),
};
@@ -202,7 +230,7 @@ describe("bootstrap", () => {
test("shutdown 时 flush logger", async () => {
let flushed = false;
let shutdownHandler: (() => void) | undefined;
let exitCode: number | undefined;
const mockLogger = createMemoryLogger();
mockLogger.flush = () => {
@@ -212,17 +240,29 @@ describe("bootstrap", () => {
const cfg = makeTempConfig();
const deps: BootstrapDependencies = {
createLogger: async () => mockLogger,
exit: (code: number) => {
exitCode = code;
throw new Error("exit called");
},
loadConfig: async () => cfg,
onSignal: (_signal, handler) => {
shutdownHandler = handler;
shutdownHandlers.push(handler);
},
startServer: () => ({}),
};
await bootstrap({ configPath: join(cfg.configDir, "config.yaml"), mode: "production" }, deps);
expect(shutdownHandler).toBeDefined();
shutdownHandler!();
const handler = shutdownHandlers.pop();
expect(handler).toBeDefined();
try {
handler!();
} catch {
// expected - exit threw
}
expect(flushed).toBe(true);
expect(exitCode).toBe(0);
});
});

View File

@@ -224,7 +224,8 @@ describe("loadServerConfig", () => {
await loadServerConfig(yamlPath);
expect.unreachable();
} catch (error) {
expect((error as Error).message).toContain("日志等级");
expect((error as Error).message).toContain("server.logging.level");
expect((error as Error).message).toContain("不在允许范围内");
} finally {
await rm(yamlPath, { force: true });
}

View File

@@ -1,11 +1,11 @@
/**
* 全局测试配置
* 主要为后端测试提供基础环境
* 组件测试使用各自的 test-utils.tsx
* 后端测试无需 DOM 环境,前端测试依赖 jsdom 及 antd polyfill
*/
/* eslint-disable @typescript-eslint/no-empty-function */
// Set up jsdom for ALL tests (both backend and frontend)
// 仅当前端测试需要时初始化 jsdom所有测试共享 preload后端测试也在此环境中运行
import { JSDOM } from "jsdom";
const dom = new JSDOM("<!DOCTYPE html><html><body></body></html>", {
@@ -21,20 +21,14 @@ globalThis.HTMLBodyElement = dom.window.HTMLBodyElement;
globalThis.HTMLHtmlElement = dom.window.HTMLHtmlElement;
globalThis.Element = dom.window.Element;
globalThis.getComputedStyle = (element: Element, pseudoElt?: null | string) => {
// jsdom 不支持伪元素计算样式antd/rc-trigger 会传入伪元素参数,测试中退回普通样式即可。
return dom.window.getComputedStyle(element, pseudoElt ? undefined : pseudoElt);
};
// Ensure document.body exists
if (!globalThis.document.body) {
const body = globalThis.document.createElement("body");
globalThis.document.documentElement.appendChild(body);
}
// CRITICAL: Set up polyfills BEFORE any other imports
// This ensures @testing-library/react sees these when it loads
// IE-style event handling polyfill (React fallback)
const nodeProto = dom.window.Node.prototype;
const elementProto = dom.window.Element.prototype;
const htmlElementProto = dom.window.HTMLElement.prototype;
@@ -49,7 +43,6 @@ Object.defineProperty(elementProto, "detachEvent", { configurable: true, value:
Object.defineProperty(htmlElementProto, "attachEvent", { configurable: true, value: attachEventFn, writable: true });
Object.defineProperty(htmlElementProto, "detachEvent", { configurable: true, value: detachEventFn, writable: true });
// 抑制 antd/rc-trigger 在 jsdom 中产生的 NaN height warning
const originalStderrWrite = process.stderr.write.bind(process.stderr);
process.stderr.write = (chunk: string | Uint8Array, encodingOrCb?: unknown, cb?: unknown) => {
const str = typeof chunk === "string" ? chunk : Buffer.from(chunk).toString();
@@ -75,7 +68,6 @@ console.warn = (...args: unknown[]) => {
originalConsoleWarn(...args);
};
// Other polyfills
globalThis.ResizeObserver = class {
disconnect() {}
observe() {}

View File

@@ -30,9 +30,11 @@ const ARCHIVED_PROJECT: Project = {
updatedAt: "2024-01-02T00:00:00.000Z",
};
function clickLatestConfirmButton() {
const buttons = screen.getAllByRole("button", { name: /OK|确\s*定/ });
fireEvent.click(buttons[buttons.length - 1]!);
async function clickLatestConfirmButton() {
const confirmTexts = await screen.findAllByText(/确\s*定|OK|确认/);
const lastText = confirmTexts[confirmTexts.length - 1]!;
const button = lastText.closest("button") ?? lastText.closest("[role='button']") ?? lastText;
fireEvent.click(button);
}
function createProjectFetchMock(initialProjects: Project[] = [ACTIVE_PROJECT, ARCHIVED_PROJECT]) {
@@ -123,7 +125,7 @@ describe("ProjectsPage", () => {
expect(screen.getByText("已归档")).not.toBeNull();
expect(screen.getByRole("button", { name: /新建项目/ })).not.toBeNull();
expect(screen.getByPlaceholderText("搜索项目名称或描述")).not.toBeNull();
expect(screen.getByPlaceholderText("搜索名称或描述")).not.toBeNull();
expect(calls.some((call) => call.url.includes("status=active"))).toBe(true);
});
@@ -133,7 +135,7 @@ describe("ProjectsPage", () => {
renderWithProviders(createElement(App), { initialRoute: "/projects" });
await waitFor(() => expect(screen.getByText("活跃项目")).not.toBeNull());
fireEvent.change(screen.getByPlaceholderText("搜索项目名称或描述"), { target: { value: "归档" } });
fireEvent.change(screen.getByPlaceholderText("搜索名称或描述"), { target: { value: "归档" } });
fireEvent.click(screen.getByRole("button", { name: /搜\s*索/ }));
await waitFor(() => expect(calls.some((call) => call.url.includes("keyword=%E5%BD%92%E6%A1%A3"))).toBe(true));
fireEvent.click(screen.getByText("已归档"));
@@ -150,11 +152,11 @@ describe("ProjectsPage", () => {
renderWithProviders(createElement(App), { initialRoute: "/projects" });
await waitFor(() => expect(screen.getByText("活跃项目")).not.toBeNull());
fireEvent.change(screen.getByPlaceholderText("搜索项目名称或描述"), { target: { value: "归档" } });
fireEvent.change(screen.getByPlaceholderText("搜索名称或描述"), { target: { value: "归档" } });
fireEvent.click(screen.getByRole("button", { name: /搜\s*索/ }));
await waitFor(() => expect(calls.some((call) => call.url.includes("keyword=%E5%BD%92%E6%A1%A3"))).toBe(true));
fireEvent.change(screen.getByPlaceholderText("搜索项目名称或描述"), { target: { value: "" } });
fireEvent.change(screen.getByPlaceholderText("搜索名称或描述"), { target: { value: "" } });
fireEvent.click(screen.getByRole("button", { name: /搜\s*索/ }));
await waitFor(() => expect(screen.getByText("活跃项目")).not.toBeNull());
});
@@ -170,7 +172,7 @@ describe("ProjectsPage", () => {
await waitFor(() => expect(screen.getByPlaceholderText("请输入项目名称")).not.toBeNull());
fireEvent.change(screen.getByPlaceholderText("请输入项目名称"), { target: { value: "新增项目" } });
fireEvent.change(screen.getByPlaceholderText("请输入项目描述"), { target: { value: "新增描述" } });
clickLatestConfirmButton();
await clickLatestConfirmButton();
await waitFor(() => expect(screen.getByText("新增项目")).not.toBeNull());
@@ -200,7 +202,7 @@ describe("ProjectsPage", () => {
await waitFor(() => expect(screen.getByPlaceholderText("请输入项目名称")).not.toBeNull());
fireEvent.change(screen.getByPlaceholderText("请输入项目名称"), { target: { value: "编辑项目" } });
clickLatestConfirmButton();
await clickLatestConfirmButton();
await waitFor(() => expect(onUpdate).toHaveBeenCalled());
expect(updateCalls[0]).toEqual({ data: { name: "编辑项目" }, id: "p1" });
@@ -223,11 +225,11 @@ describe("ProjectsPage", () => {
);
await waitFor(() => expect(screen.getByPlaceholderText("请输入项目名称")).not.toBeNull());
clickLatestConfirmButton();
await clickLatestConfirmButton();
expect(onCreate).not.toHaveBeenCalled();
fireEvent.change(screen.getByPlaceholderText("请输入项目名称"), { target: { value: "失败项目" } });
clickLatestConfirmButton();
await clickLatestConfirmButton();
await waitFor(() => expect(onCreate).toHaveBeenCalled());
expect(onOpenChange).not.toHaveBeenCalledWith(false);
expect(screen.getByText("新建项目")).not.toBeNull();
@@ -253,26 +255,27 @@ describe("ProjectsPage", () => {
onRestore,
page: 1,
pageSize: 20,
status: "active",
}),
),
);
fireEvent.click(screen.getByRole("button", { name: /进入工作台/ }));
fireEvent.click(screen.getByRole("button", { name: /工作台/ }));
expect(screen.getByText("当前路径:/workbench/p1")).not.toBeNull();
fireEvent.click(screen.getByRole("button", { name: /归档/ }));
await waitFor(() => expect(screen.getByText("确认归档此项目?")).not.toBeNull());
clickLatestConfirmButton();
await clickLatestConfirmButton();
await waitFor(() => expect(onArchive).toHaveBeenCalledWith("p1"));
fireEvent.click(screen.getByRole("button", { name: /恢复/ }));
await waitFor(() => expect(screen.getByText("确认恢复此项目?")).not.toBeNull());
clickLatestConfirmButton();
await clickLatestConfirmButton();
await waitFor(() => expect(onRestore).toHaveBeenCalledWith("p2"));
fireEvent.click(screen.getByRole("button", { name: /删除/ }));
await waitFor(() => expect(screen.getByText("确认永久删除此项目?")).not.toBeNull());
clickLatestConfirmButton();
await clickLatestConfirmButton();
await waitFor(() => expect(onDelete).toHaveBeenCalledWith("p2"));
});
}, 15000);
});