完成流水线控制器重构和相关功能改进

This commit is contained in:
2025-11-21 23:30:05 +08:00
parent fd0cf782c4
commit f8697b87e1
33 changed files with 1262 additions and 538 deletions

View File

@@ -1,22 +1,175 @@
import type { Context } from 'koa';
import { Controller, Get, Post } from '../../decorators/route.ts';
import { Controller, Get, Post, Put, Delete } from '../../decorators/route.ts';
import prisma from '../../libs/db.ts';
import { log } from '../../libs/logger.ts';
import { BusinessError } from '../../middlewares/exception.ts';
import {
createPipelineSchema,
updatePipelineSchema,
pipelineIdSchema,
listPipelinesQuerySchema
} from './schema.ts';
@Controller('/pipelines')
export class PipelineController {
@Get('/:id')
async get(ctx: Context) {
const id = ctx.params.id;
const pipeline = await prisma.pipeline.findUnique({
where: {
id: id,
// GET /api/pipelines - 获取流水线列表
@Get('')
async list(ctx: Context) {
const query = listPipelinesQuerySchema.parse(ctx.query);
const whereCondition: any = {
valid: 1,
};
// 如果提供了项目ID参数
if (query?.projectId) {
whereCondition.projectId = query.projectId;
}
const pipelines = await prisma.pipeline.findMany({
where: whereCondition,
include: {
steps: {
where: {
valid: 1,
},
orderBy: {
order: 'asc',
},
},
},
});
return pipelines;
}
// GET /api/pipelines/:id - 获取单个流水线
@Get('/:id')
async get(ctx: Context) {
const { id } = pipelineIdSchema.parse(ctx.params);
const pipeline = await prisma.pipeline.findFirst({
where: {
id,
valid: 1,
},
include: {
steps: {
where: {
valid: 1,
},
orderBy: {
order: 'asc',
},
},
},
});
if (!pipeline) {
throw new BusinessError('流水线不存在', 3001, 404);
}
return pipeline;
}
// POST /api/pipelines - 创建流水线
@Post('')
async create(ctx: Context) {
const validatedData = createPipelineSchema.parse(ctx.request.body);
const pipeline = await prisma.pipeline.create({
data: {
name: validatedData.name,
description: validatedData.description || '',
projectId: validatedData.projectId,
createdBy: 'system',
updatedBy: 'system',
valid: 1,
},
});
log.info('pipeline', 'Created new pipeline: %s', pipeline.name);
return pipeline;
}
// PUT /api/pipelines/:id - 更新流水线
@Put('/:id')
async update(ctx: Context) {
const { id } = pipelineIdSchema.parse(ctx.params);
const validatedData = updatePipelineSchema.parse(ctx.request.body);
// 检查流水线是否存在
const existingPipeline = await prisma.pipeline.findFirst({
where: {
id,
valid: 1,
},
});
if (!existingPipeline) {
throw new BusinessError('流水线不存在', 3001, 404);
}
// 只更新提供的字段
const updateData: any = {
updatedBy: 'system',
};
if (validatedData.name !== undefined) {
updateData.name = validatedData.name;
}
if (validatedData.description !== undefined) {
updateData.description = validatedData.description;
}
const pipeline = await prisma.pipeline.update({
where: { id },
data: updateData,
});
log.info('pipeline', 'Updated pipeline: %s', pipeline.name);
return pipeline;
}
// DELETE /api/pipelines/:id - 删除流水线(软删除)
@Delete('/:id')
async destroy(ctx: Context) {
const { id } = pipelineIdSchema.parse(ctx.params);
// 检查流水线是否存在
const existingPipeline = await prisma.pipeline.findFirst({
where: {
id,
valid: 1,
},
});
if (!existingPipeline) {
throw new BusinessError('流水线不存在', 3001, 404);
}
// 软删除:将 valid 设置为 0
await prisma.pipeline.update({
where: { id },
data: {
valid: 0,
updatedBy: 'system',
},
});
// 同时软删除关联的步骤
await prisma.step.updateMany({
where: { pipelineId: id },
data: {
valid: 0,
updatedBy: 'system',
},
});
log.info('pipeline', 'Deleted pipeline: %s', existingPipeline.name);
// RESTful 删除成功返回 204 No Content
ctx.status = 204;
return null;
}
}

View File

@@ -0,0 +1,34 @@
import { z } from 'zod';
// 定义验证架构
export const createPipelineSchema = z.object({
name: z.string({
message: '流水线名称必须是字符串',
}).min(1, { message: '流水线名称不能为空' }).max(100, { message: '流水线名称不能超过100个字符' }),
description: z.string({
message: '流水线描述必须是字符串',
}).max(500, { message: '流水线描述不能超过500个字符' }).optional(),
projectId: z.number({
message: '项目ID必须是数字',
}).int().positive({ message: '项目ID必须是正整数' }).optional(),
});
export const updatePipelineSchema = z.object({
name: z.string({
message: '流水线名称必须是字符串',
}).min(1, { message: '流水线名称不能为空' }).max(100, { message: '流水线名称不能超过100个字符' }).optional(),
description: z.string({
message: '流水线描述必须是字符串',
}).max(500, { message: '流水线描述不能超过500个字符' }).optional(),
});
export const pipelineIdSchema = z.object({
id: z.coerce.number().int().positive({ message: '流水线 ID 必须是正整数' }),
});
export const listPipelinesQuerySchema = z.object({
projectId: z.coerce.number().int().positive({ message: '项目ID必须是正整数' }).optional(),
}).optional();

View File

@@ -0,0 +1,13 @@
import type { z } from 'zod';
import type {
createPipelineSchema,
updatePipelineSchema,
pipelineIdSchema,
listPipelinesQuerySchema
} from './schema.js';
// TypeScript 类型
export type CreatePipelineInput = z.infer<typeof createPipelineSchema>;
export type UpdatePipelineInput = z.infer<typeof updatePipelineSchema>;
export type PipelineIdParams = z.infer<typeof pipelineIdSchema>;
export type ListPipelinesQuery = z.infer<typeof listPipelinesQuerySchema>;