feat: 实现环境变量预设功能 & 移除稀疏检出

## 后端改动 - 添加 Project.envPresets 字段（JSON 格式） - 移除 Deployment.env 字段，统一使用 envVars - 更新部署 DTO，支持 envVars (Record<string, string>) - pipeline-runner 支持解析并注入 envVars 到环境 - 移除稀疏检出模板和相关环境变量 - 优化代码格式（Biome lint & format） ## 前端改动 - 新增 EnvPresetsEditor 组件（支持单选/多选/输入框类型） - 项目创建/编辑界面集成环境预设编辑器 - 部署界面基于预设动态生成环境变量表单 - 移除稀疏检出表单项 - 项目详情页添加环境变量预设配置 tab - 优化部署界面布局（基本参数 & 环境变量分区） ## 文档 - 添加完整文档目录结构（docs/） - 创建设计文档 design-0005（部署流程重构） - 添加 API 文档、架构设计文档等 ## 数据库 - 执行 prisma db push 同步 schema 变更
2026-01-03 22:59:20 +08:00
parent c40532c757
commit d22fdc9618
71 changed files with 9611 additions and 5849 deletions
--- a/apps/server/controllers/auth/index.ts
+++ b/apps/server/controllers/auth/index.ts
@@ -1,8 +1,8 @@
 import type { Context } from 'koa';
 import { Controller, Get, Post } from '../../decorators/route.ts';
-import { prisma } from '../../libs/prisma.ts';
-import { log } from '../../libs/logger.ts';
 import { gitea } from '../../libs/gitea.ts';
+import { log } from '../../libs/logger.ts';
+import { prisma } from '../../libs/prisma.ts';
 import { loginSchema } from './dto.ts';

@Controller('/auth')
--- a/apps/server/controllers/deployment/dto.ts
+++ b/apps/server/controllers/deployment/dto.ts
@@ -12,8 +12,7 @@ export const createDeploymentSchema = z.object({
  branch: z.string().min(1, { message: '分支不能为空' }),
  commitHash: z.string().min(1, { message: '提交哈希不能为空' }),
  commitMessage: z.string().min(1, { message: '提交信息不能为空' }),
-  env: z.string().optional(),
-  sparseCheckoutPaths: z.string().optional(), // 添加稀疏检出路径字段
+  envVars: z.record(z.string()).optional(), // 环境变量 key-value 对象
 });

 export type ListDeploymentsQuery = z.infer<typeof listDeploymentsQuerySchema>;
--- a/apps/server/controllers/deployment/index.ts
+++ b/apps/server/controllers/deployment/index.ts
@@ -1,15 +1,17 @@
+import type { Context } from 'koa';
 import { Controller, Get, Post } from '../../decorators/route.ts';
 import type { Prisma } from '../../generated/client.ts';
-import { prisma } from '../../libs/prisma.ts';
-import type { Context } from 'koa';
-import { listDeploymentsQuerySchema, createDeploymentSchema } from './dto.ts';
 import { ExecutionQueue } from '../../libs/execution-queue.ts';
+import { prisma } from '../../libs/prisma.ts';
+import { createDeploymentSchema, listDeploymentsQuerySchema } from './dto.ts';

@Controller('/deployments')
 export class DeploymentController {
  @Get('')
  async list(ctx: Context) {
-    const { page, pageSize, projectId } = listDeploymentsQuerySchema.parse(ctx.query);
+    const { page, pageSize, projectId } = listDeploymentsQuerySchema.parse(
+      ctx.query,
+    );
    const where: Prisma.DeploymentWhereInput = {
      valid: 1,
    };
@@ -50,8 +52,7 @@ export class DeploymentController {
          connect: { id: body.projectId },
        },
        pipelineId: body.pipelineId,
-        env: body.env || 'dev',
-        sparseCheckoutPaths: body.sparseCheckoutPaths || '', // 添加稀疏检出路径
+        envVars: body.envVars ? JSON.stringify(body.envVars) : null,
        buildLog: '',
        createdBy: 'system', // TODO: get from user
        updatedBy: 'system',
@@ -73,7 +74,7 @@ export class DeploymentController {

    // 获取原始部署记录
    const originalDeployment = await prisma.deployment.findUnique({
-      where: { id: Number(id) }
+      where: { id: Number(id) },
    });

    if (!originalDeployment) {
@@ -82,7 +83,7 @@ export class DeploymentController {
        code: 404,
        message: '部署记录不存在',
        data: null,
-        timestamp: Date.now()
+        timestamp: Date.now(),
      };
      return;
    }
@@ -96,8 +97,7 @@ export class DeploymentController {
        status: 'pending',
        projectId: originalDeployment.projectId,
        pipelineId: originalDeployment.pipelineId,
-        env: originalDeployment.env,
-        sparseCheckoutPaths: originalDeployment.sparseCheckoutPaths,
+        envVars: originalDeployment.envVars,
        buildLog: '',
        createdBy: 'system',
        updatedBy: 'system',
@@ -113,7 +113,7 @@ export class DeploymentController {
      code: 0,
      message: '重新执行任务已创建',
      data: newDeployment,
-      timestamp: Date.now()
+      timestamp: Date.now(),
    };
  }
 }
--- a/apps/server/controllers/git/dto.ts
+++ b/apps/server/controllers/git/dto.ts
@@ -1,12 +1,18 @@
 import { z } from 'zod';

 export const getCommitsQuerySchema = z.object({
-  projectId: z.coerce.number().int().positive({ message: 'Project ID is required' }),
+  projectId: z.coerce
+    .number()
+    .int()
+    .positive({ message: 'Project ID is required' }),
  branch: z.string().optional(),
 });

 export const getBranchesQuerySchema = z.object({
-  projectId: z.coerce.number().int().positive({ message: 'Project ID is required' }),
+  projectId: z.coerce
+    .number()
+    .int()
+    .positive({ message: 'Project ID is required' }),
 });

 export type GetCommitsQuery = z.infer<typeof getCommitsQuerySchema>;
--- a/apps/server/controllers/git/index.ts
+++ b/apps/server/controllers/git/index.ts
@@ -1,9 +1,9 @@
 import type { Context } from 'koa';
 import { Controller, Get } from '../../decorators/route.ts';
-import { prisma } from '../../libs/prisma.ts';
 import { gitea } from '../../libs/gitea.ts';
+import { prisma } from '../../libs/prisma.ts';
 import { BusinessError } from '../../middlewares/exception.ts';
-import { getCommitsQuerySchema, getBranchesQuerySchema } from './dto.ts';
+import { getBranchesQuerySchema, getCommitsQuerySchema } from './dto.ts';

@Controller('/git')
 export class GitController {
@@ -33,7 +33,11 @@ export class GitController {
    console.log('Access token present:', !!accessToken);

    if (!accessToken) {
-      throw new BusinessError('Gitea access token not found. Please login again.', 1004, 401);
+      throw new BusinessError(
+        'Gitea access token not found. Please login again.',
+        1004,
+        401,
+      );
    }

    try {
@@ -65,7 +69,11 @@ export class GitController {
    const accessToken = ctx.session?.gitea?.access_token;

    if (!accessToken) {
-      throw new BusinessError('Gitea access token not found. Please login again.', 1004, 401);
+      throw new BusinessError(
+        'Gitea access token not found. Please login again.',
+        1004,
+        401,
+      );
    }

    try {
@@ -85,7 +93,7 @@ export class GitController {

    // Handle SCP-like syntax: git@host:owner/repo.git
    if (!cleanUrl.includes('://') && cleanUrl.includes(':')) {
-      const scpMatch = cleanUrl.match(/:([^\/]+)\/([^\/]+?)(\.git)?$/);
+      const scpMatch = cleanUrl.match(/:([^/]+)\/([^/]+?)(\.git)?$/);
      if (scpMatch) {
        return { owner: scpMatch[1], repo: scpMatch[2] };
      }
@@ -96,13 +104,15 @@ export class GitController {
      const urlObj = new URL(cleanUrl);
      const parts = urlObj.pathname.split('/').filter(Boolean);
      if (parts.length >= 2) {
-        const repo = parts.pop()!.replace(/\.git$/, '');
-        const owner = parts.pop()!;
-        return { owner, repo };
+        const repo = parts.pop()?.replace(/\.git$/, '');
+        const owner = parts.pop();
+        if (repo && owner) {
+          return { owner, repo };
+        }
      }
-    } catch (e) {
+    } catch (_e) {
      // Fallback to simple regex
-      const match = cleanUrl.match(/([^\/]+)\/([^\/]+?)(\.git)?$/);
+      const match = cleanUrl.match(/([^/]+)\/([^/]+?)(\.git)?$/);
      if (match) {
        return { owner: match[1], repo: match[2] };
      }
--- a/apps/server/controllers/index.ts
+++ b/apps/server/controllers/index.ts
@@ -1,8 +1,9 @@
 // 控制器统一导出
-export { ProjectController } from './project/index.ts';
-export { UserController } from './user/index.ts';
+
 export { AuthController } from './auth/index.ts';
 export { DeploymentController } from './deployment/index.ts';
-export { PipelineController } from './pipeline/index.ts';
-export { StepController } from './step/index.ts'
 export { GitController } from './git/index.ts';
+export { PipelineController } from './pipeline/index.ts';
+export { ProjectController } from './project/index.ts';
+export { StepController } from './step/index.ts';
+export { UserController } from './user/index.ts';
--- a/apps/server/controllers/pipeline/dto.ts
+++ b/apps/server/controllers/pipeline/dto.ts
@@ -2,36 +2,59 @@ import { z } from 'zod';

 // 定义验证架构
 export const createPipelineSchema = z.object({
-  name: z.string({
-    message: '流水线名称必须是字符串',
-  }).min(1, { message: '流水线名称不能为空' }).max(100, { message: '流水线名称不能超过100个字符' }),
+  name: z
+    .string({
+      message: '流水线名称必须是字符串',
+    })
+    .min(1, { message: '流水线名称不能为空' })
+    .max(100, { message: '流水线名称不能超过100个字符' }),

-  description: z.string({
-    message: '流水线描述必须是字符串',
-  }).max(500, { message: '流水线描述不能超过500个字符' }).optional(),
+  description: z
+    .string({
+      message: '流水线描述必须是字符串',
+    })
+    .max(500, { message: '流水线描述不能超过500个字符' })
+    .optional(),

-  projectId: z.number({
-    message: '项目ID必须是数字',
-  }).int().positive({ message: '项目ID必须是正整数' }).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(),
+  name: z
+    .string({
+      message: '流水线名称必须是字符串',
+    })
+    .min(1, { message: '流水线名称不能为空' })
+    .max(100, { message: '流水线名称不能超过100个字符' })
+    .optional(),

-  description: z.string({
-    message: '流水线描述必须是字符串',
-  }).max(500, { message: '流水线描述不能超过500个字符' }).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();
+export const listPipelinesQuerySchema = z
+  .object({
+    projectId: z.coerce
+      .number()
+      .int()
+      .positive({ message: '项目ID必须是正整数' })
+      .optional(),
+  })
+  .optional();

 // 类型
 export type CreatePipelineInput = z.infer<typeof createPipelineSchema>;
--- a/apps/server/controllers/pipeline/index.ts
+++ b/apps/server/controllers/pipeline/index.ts
@@ -1,14 +1,17 @@
 import type { Context } from 'koa';
-import { Controller, Get, Post, Put, Delete } from '../../decorators/route.ts';
-import { prisma } from '../../libs/prisma.ts';
+import { Controller, Delete, Get, Post, Put } from '../../decorators/route.ts';
 import { log } from '../../libs/logger.ts';
+import {
+  createPipelineFromTemplate,
+  getAvailableTemplates,
+} from '../../libs/pipeline-template.ts';
+import { prisma } from '../../libs/prisma.ts';
 import { BusinessError } from '../../middlewares/exception.ts';
-import { getAvailableTemplates, createPipelineFromTemplate } from '../../libs/pipeline-template.ts';
 import {
  createPipelineSchema,
-  updatePipelineSchema,
-  pipelineIdSchema,
  listPipelinesQuerySchema,
+  pipelineIdSchema,
+  updatePipelineSchema,
 } from './dto.ts';

@Controller('/pipelines')
@@ -46,7 +49,7 @@ export class PipelineController {

  // GET /api/pipelines/templates - 获取可用的流水线模板
  @Get('/templates')
-  async getTemplates(ctx: Context) {
+  async getTemplates(_ctx: Context) {
    try {
      const templates = await getAvailableTemplates();
      return templates;
@@ -126,7 +129,7 @@ export class PipelineController {
        templateId,
        projectId,
        name,
-        description || ''
+        description || '',
      );

      // 返回新创建的流水线
--- a/apps/server/controllers/project/dto.ts
+++ b/apps/server/controllers/project/dto.ts
@@ -5,46 +5,83 @@ import { projectDirSchema } from '../../libs/path-validator.js';
 * 创建项目验证架构
 */
 export const createProjectSchema = z.object({
-  name: z.string({
-    message: '项目名称必须是字符串',
-  }).min(2, { message: '项目名称至少2个字符' }).max(50, { message: '项目名称不能超过50个字符' }),
+  name: z
+    .string({
+      message: '项目名称必须是字符串',
+    })
+    .min(2, { message: '项目名称至少2个字符' })
+    .max(50, { message: '项目名称不能超过50个字符' }),

-  description: z.string({
-    message: '项目描述必须是字符串',
-  }).max(200, { message: '项目描述不能超过200个字符' }).optional(),
+  description: z
+    .string({
+      message: '项目描述必须是字符串',
+    })
+    .max(200, { message: '项目描述不能超过200个字符' })
+    .optional(),

-  repository: z.string({
-    message: '仓库地址必须是字符串',
-  }).url({ message: '请输入有效的仓库地址' }).min(1, { message: '仓库地址不能为空' }),
+  repository: z
+    .string({
+      message: '仓库地址必须是字符串',
+    })
+    .url({ message: '请输入有效的仓库地址' })
+    .min(1, { message: '仓库地址不能为空' }),

  projectDir: projectDirSchema,
+
+  envPresets: z.string().optional(), // JSON 字符串格式
 });

 /**
 * 更新项目验证架构
 */
 export const updateProjectSchema = z.object({
-  name: z.string({
-    message: '项目名称必须是字符串',
-  }).min(2, { message: '项目名称至少2个字符' }).max(50, { message: '项目名称不能超过50个字符' }).optional(),
+  name: z
+    .string({
+      message: '项目名称必须是字符串',
+    })
+    .min(2, { message: '项目名称至少2个字符' })
+    .max(50, { message: '项目名称不能超过50个字符' })
+    .optional(),

-  description: z.string({
-    message: '项目描述必须是字符串',
-  }).max(200, { message: '项目描述不能超过200个字符' }).optional(),
+  description: z
+    .string({
+      message: '项目描述必须是字符串',
+    })
+    .max(200, { message: '项目描述不能超过200个字符' })
+    .optional(),

-  repository: z.string({
-    message: '仓库地址必须是字符串',
-  }).url({ message: '请输入有效的仓库地址' }).min(1, { message: '仓库地址不能为空' }).optional(),
+  repository: z
+    .string({
+      message: '仓库地址必须是字符串',
+    })
+    .url({ message: '请输入有效的仓库地址' })
+    .min(1, { message: '仓库地址不能为空' })
+    .optional(),
+
+  envPresets: z.string().optional(), // JSON 字符串格式
 });

 /**
 * 项目列表查询参数验证架构
 */
-export const listProjectQuerySchema = z.object({
-  page: z.coerce.number().int().min(1, { message: '页码必须大于0' }).optional().default(1),
-  limit: z.coerce.number().int().min(1, { message: '每页数量必须大于0' }).max(100, { message: '每页数量不能超过100' }).optional().default(10),
-  name: z.string().optional(),
-}).optional();
+export const listProjectQuerySchema = z
+  .object({
+    page: z.coerce
+      .number()
+      .int()
+      .min(1, { message: '页码必须大于0' })
+      .optional()
+      .default(1),
+    limit: z.coerce
+      .number()
+      .int()
+      .min(1, { message: '每页数量必须大于0' })
+      .max(100, { message: '每页数量不能超过100' })
+      .optional()
+      .default(10),
+    name: z.string().optional(),
+  })
+  .optional();

 /**
 * 项目ID验证架构
--- a/apps/server/controllers/project/index.ts
+++ b/apps/server/controllers/project/index.ts
@@ -1,14 +1,14 @@
 import type { Context } from 'koa';
-import { prisma } from '../../libs/prisma.ts';
-import { log } from '../../libs/logger.ts';
-import { BusinessError } from '../../middlewares/exception.ts';
-import { Controller, Get, Post, Put, Delete } from '../../decorators/route.ts';
+import { Controller, Delete, Get, Post, Put } from '../../decorators/route.ts';
 import { GitManager } from '../../libs/git-manager.ts';
+import { log } from '../../libs/logger.ts';
+import { prisma } from '../../libs/prisma.ts';
+import { BusinessError } from '../../middlewares/exception.ts';
 import {
  createProjectSchema,
-  updateProjectSchema,
  listProjectQuerySchema,
  projectIdSchema,
+  updateProjectSchema,
 } from './dto.ts';

@Controller('/projects')
@@ -135,6 +135,7 @@ export class ProjectController {
        description: validatedData.description || '',
        repository: validatedData.repository,
        projectDir: validatedData.projectDir,
+        envPresets: validatedData.envPresets,
        createdBy: 'system',
        updatedBy: 'system',
        valid: 1,
@@ -182,6 +183,9 @@ export class ProjectController {
    if (validatedData.repository !== undefined) {
      updateData.repository = validatedData.repository;
    }
+    if (validatedData.envPresets !== undefined) {
+      updateData.envPresets = validatedData.envPresets;
+    }

    const project = await prisma.project.update({
      where: { id },
--- a/apps/server/controllers/step/index.ts
+++ b/apps/server/controllers/step/index.ts
@@ -1,13 +1,13 @@
 import type { Context } from 'koa';
-import { prisma } from '../../libs/prisma.ts';
+import { Controller, Delete, Get, Post, Put } from '../../decorators/route.ts';
 import { log } from '../../libs/logger.ts';
+import { prisma } from '../../libs/prisma.ts';
 import { BusinessError } from '../../middlewares/exception.ts';
-import { Controller, Get, Post, Put, Delete } from '../../decorators/route.ts';
 import {
  createStepSchema,
-  updateStepSchema,
-  stepIdSchema,
  listStepsQuerySchema,
+  stepIdSchema,
+  updateStepSchema,
 } from './dto.ts';

@Controller('/steps')
--- a/apps/server/controllers/user/index.ts
+++ b/apps/server/controllers/user/index.ts
@@ -1,11 +1,11 @@
 import type { Context } from 'koa';
-import { Controller, Get, Post, Put, Delete } from '../../decorators/route.ts';
+import { Controller, Delete, Get, Post, Put } from '../../decorators/route.ts';
 import { BusinessError } from '../../middlewares/exception.ts';
 import {
-  userIdSchema,
  createUserSchema,
-  updateUserSchema,
  searchUserQuerySchema,
+  updateUserSchema,
+  userIdSchema,
 } from './dto.ts';

 /**
@@ -13,14 +13,18 @@ import {
 */
@Controller('/user')
 export class UserController {
-
  @Get('/list')
-  async list(ctx: Context) {
+  async list(_ctx: Context) {
    // 模拟用户列表数据
    const users = [
      { id: 1, name: 'Alice', email: 'alice@example.com', status: 'active' },
      { id: 2, name: 'Bob', email: 'bob@example.com', status: 'inactive' },
-      { id: 3, name: 'Charlie', email: 'charlie@example.com', status: 'active' }
+      {
+        id: 3,
+        name: 'Charlie',
+        email: 'charlie@example.com',
+        status: 'active',
+      },
    ];

    return users;
@@ -33,10 +37,10 @@ export class UserController {
    // 模拟根据ID查找用户
    const user = {
      id,
-      name: 'User ' + id,
+      name: `User ${id}`,
      email: `user${id}@example.com`,
      status: 'active',
-      createdAt: new Date().toISOString()
+      createdAt: new Date().toISOString(),
    };

    if (id > 100) {
@@ -55,7 +59,7 @@ export class UserController {
      id: Date.now(),
      ...body,
      createdAt: new Date().toISOString(),
-      status: body.status
+      status: body.status,
    };

    return newUser;
@@ -70,7 +74,7 @@ export class UserController {
    const updatedUser = {
      id,
      ...body,
-      updatedAt: new Date().toISOString()
+      updatedAt: new Date().toISOString(),
    };

    return updatedUser;
@@ -88,7 +92,7 @@ export class UserController {
    return {
      success: true,
      message: `用户 ${id} 已删除`,
-      deletedAt: new Date().toISOString()
+      deletedAt: new Date().toISOString(),
    };
  }

@@ -99,25 +103,26 @@ export class UserController {
    // 模拟搜索逻辑
    let results = [
      { id: 1, name: 'Alice', email: 'alice@example.com', status: 'active' },
-      { id: 2, name: 'Bob', email: 'bob@example.com', status: 'inactive' }
+      { id: 2, name: 'Bob', email: 'bob@example.com', status: 'inactive' },
    ];

    if (keyword) {
-      results = results.filter(user =>
-        user.name.toLowerCase().includes(keyword.toLowerCase()) ||
-        user.email.toLowerCase().includes(keyword.toLowerCase())
+      results = results.filter(
+        (user) =>
+          user.name.toLowerCase().includes(keyword.toLowerCase()) ||
+          user.email.toLowerCase().includes(keyword.toLowerCase()),
      );
    }

    if (status) {
-      results = results.filter(user => user.status === status);
+      results = results.filter((user) => user.status === status);
    }

    return {
      keyword,
      status,
      total: results.length,
-      results
+      results,
    };
  }
 }