diff --git a/bun.lockb b/bun.lockb index 4c6db08..2ea389c 100755 Binary files a/bun.lockb and b/bun.lockb differ diff --git a/controllers/managePipeLine/index.ts b/controllers/managePipeLine/index.ts index a24b9db..6b701bd 100644 --- a/controllers/managePipeLine/index.ts +++ b/controllers/managePipeLine/index.ts @@ -7,6 +7,8 @@ import { Gitlab } from "../../types/gitlab" /** * 获取全部的pipeline列表 + * @param {DB.Project} project - 项目对象 + * @returns {Promise<(Gitlab.PipelineDetail & { created_at: string })[]>} - 返回包含详细信息的pipeline列表 */ const getFullPipelineList = async (project: DB.Project) => { // 先获取最新的pipelineID @@ -46,6 +48,13 @@ const getFullPipelineList = async (project: DB.Project) => { })[] } +/** + * 插入全部的pipeline列表到数据库 + * @param {(Gitlab.PipelineDetail & { created_at: string })[][]} fullPipelineList - 包含详细信息的pipeline列表 + * @param {Record} fullUserMap - 用户映射表 + * @param {Record} fullProjectMap - 项目映射表 + * @returns {Promise} + */ const insertFullPipelineList = async ( fullPipelineList: (Gitlab.PipelineDetail & { created_at: string })[][], fullUserMap: Record, diff --git a/controllers/managePipelineEvent/index.ts b/controllers/managePipelineEvent/index.ts index d928175..9d8e1f1 100644 --- a/controllers/managePipelineEvent/index.ts +++ b/controllers/managePipelineEvent/index.ts @@ -7,67 +7,79 @@ import { sec2minStr } from "../../utils/timeTools" /** * 判断是否是合并请求 - * @param pipeline - * @returns + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @returns {boolean} - 如果提交信息符合合并请求的格式，返回 true；否则返回 false */ -const checkIsMergeCommit = (pipeline: Gitlab.PipelineEvent) => { +const checkIsMergeCommit = (pipeline: Gitlab.PipelineEvent): boolean => { const regex = /^Merge branch '.*' into '.*'$/ return regex.test(pipeline.commit.title) } -/** - * 判断是否是成功的CI - * @param pipeline - * @returns - */ -const checkIsSuccess = async ( - pipeline: Gitlab.PipelineEvent, - stage?: string | null -) => { - /** - * 创建结果对象 - * @param buildId 构建ID - * @param continueFlag 是否继续 - * @returns 结果对象 - */ - const makeResult = (buildId: string, continueFlag: boolean) => ({ - buildId: continueFlag ? buildId : "", - continueFlag, - }) +enum NEXT_ACTION { + SKIP, + NOTIFY, + ADD_MONITOR, + REMOVE_MONITOR, + NOTIFY_AND_REMOVE_MONITOR, +} +/** + * 获取下一步操作 + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @param {string | null} [targetStage] - 目标阶段，可选 + * @returns {Promise} - 返回下一步操作的枚举值 + */ +const getNextAction = async ( + pipeline: Gitlab.PipelineEvent, + targetStage?: string | null +): Promise => { // 没有指定Stage则整个流水线成功即为成功 - if (!stage) - return makeResult( - pipeline.builds - .sort((a, b) => - (a.finished_at || "").localeCompare(b.finished_at || "") - )[0] - .id.toString(), - pipeline.object_attributes.status === "success" + if (!targetStage) { + if (pipeline.object_attributes.status === "success") { + return NEXT_ACTION.NOTIFY + } + return NEXT_ACTION.SKIP + } + // 指定了stage，但是流水线非成功状态，删除监控 + if ( + ["failed", "canceled", "skipped"].includes( + pipeline.object_attributes.status ) - // 指定了Stage，该Stage是否全部成功 - const builds = pipeline.builds.filter((build) => build.stage === stage) - // 没有该Stage的构建 - if (builds.length === 0) return makeResult("", false) - // 有该Stage的构建，但不全成功 - if (!builds.every((build) => build.status === "success")) - return makeResult("", false) - // 按finished_at排序，获取最后一个运行的id - const lastId = builds.sort((a, b) => - (a.finished_at || "").localeCompare(b.finished_at || "") - )[0].id - // 该ID的通知是否已经发送过 - const notify = await db.notify.getOne(lastId.toString()) - if (notify) return makeResult("", false) - return makeResult(lastId.toString(), true) + ) { + return NEXT_ACTION.REMOVE_MONITOR + } + // 指定了Stage，且流水线成功了，删除监控并发送通知 + if (pipeline.object_attributes.status === "success") { + return NEXT_ACTION.NOTIFY_AND_REMOVE_MONITOR + } + // 在流水线为`running`时，且该stage全部的job有非结束状态时即`created`、`pending`、`running`、`manual`、`scheduled`时，添加监控 + if (pipeline.object_attributes.status === "running") { + const jobs = await service.gitlab.pipeline.getJobs( + pipeline.project.id, + pipeline.object_attributes.id + ) + if ( + jobs.some( + (job) => + job.stage === targetStage && + !["success", "failed", "canceled", "skipped"].includes(job.status) + ) + ) { + return NEXT_ACTION.ADD_MONITOR + } + } + // 其他情况都跳过 + return NEXT_ACTION.SKIP } /** * 获取合并请求 - * @param pipeline - * @returns + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @returns {Promise} - 返回合并请求对象或 null */ -const getMergeRequest = async (pipeline: Gitlab.PipelineEvent) => { +const getMergeRequest = async ( + pipeline: Gitlab.PipelineEvent +): Promise => { if (!checkIsMergeCommit(pipeline)) return null const res = await service.gitlab.commit.getMr( pipeline.project.id, @@ -79,14 +91,14 @@ const getMergeRequest = async (pipeline: Gitlab.PipelineEvent) => { /** * 获取用户信息 - * @param pipeline - * @param mergeRequest - * @returns + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @param {Gitlab.MergeRequest | null} mergeRequest - 合并请求对象或 null + * @returns {{ participant: string, receiver: string[] }} - 返回包含参与者和接收者信息的对象 */ const getUserInfo = ( pipeline: Gitlab.PipelineEvent, mergeRequest: Gitlab.MergeRequest | null -) => { +): { participant: string; receiver: string[] } => { let participant = pipeline.user.name const receiver = [pipeline.user.username] // 有MR且用户不同 @@ -98,39 +110,16 @@ const getUserInfo = ( } /** - * 获取机器人消息 - * @param variable 模板变量 - * @returns + * 生成消息模板变量 + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @returns {Promise<{ receiver: string[], variable: EggMessage.CardVariable }>} - 返回包含接收者和模板变量的对象 */ -const getRobotMsg = async (variable: EggMessage.CardVariable) => - JSON.stringify({ - type: "template", - data: { - config: { - update_multi: true, - }, - template_id: "ctp_AA36QafWyob2", - template_variable: variable, - }, - }) - -/** - * 发送通知消息 - * @param pipeline - * @param apiKey - * @returns - */ -const sendNotifyMsg = async ( - pipeline: Gitlab.PipelineEvent, - apiKey: string, - params: URLSearchParams -) => { - const { continueFlag, buildId } = await checkIsSuccess( - pipeline, - params.get("stage") - ) - // 只处理成功的CICD - if (!continueFlag) return netTool.ok() +const genCardVariable = async ( + pipeline: Gitlab.PipelineEvent +): Promise<{ + receiver: string[] + variable: EggMessage.CardVariable +}> => { // 获取对应的合并请求 const mergeRequest = await getMergeRequest(pipeline) // 获取用户信息 @@ -156,18 +145,167 @@ const sendNotifyMsg = async ( mr_link: mergeRequest ? mergeRequest.web_url : "", sonar_link: `https://sonarqube.mioffice.cn/dashboard?${sonarParams}`, } + return { + receiver, + variable, + } +} + +/** + * 生成机器人消息 + * @param {EggMessage.CardVariable} variable - 模板变量 + * @returns {string} - 返回生成的机器人消息内容 + */ +const genLarkRobotMsgContent = (variable: EggMessage.CardVariable): string => + JSON.stringify({ + type: "template", + data: { + config: { + update_multi: true, + }, + template_id: "ctp_AA36QafWyob2", + template_variable: variable, + }, + }) + +/** + * 发送提醒消息 + * @param {Gitlab.PipelineEvent} pipeline - 流水线信息 + * @param {string} apiKey - API 密钥 + * @returns {Promise} - 无返回值 + */ +const sendNotify = async ( + pipeline: Gitlab.PipelineEvent, + apiKey: string +): Promise => { + // 获取消息信息 + const { receiver, variable } = await genCardVariable(pipeline) // 获取机器人消息 - const robotMsg = await getRobotMsg(variable) + const robotMsg = genLarkRobotMsgContent(variable) // 发送消息 service.message.byUserIdList(receiver, robotMsg, apiKey) // 记录日志 - await db.notify.create({ ...variable, build_id: buildId }) + await db.notify.create({ ...variable }) +} + +/** + * 添加监控 + * @param {Gitlab.PipelineEvent} pipeline - 流水线信息 + * @param {string} apiKey - API 密钥 + * @param {string} stage - 阶段名称 + * @returns {Promise} - 无返回值 + */ +const addMonitor = async ( + pipeline: Gitlab.PipelineEvent, + apiKey: string, + stage: string +): Promise => { + const monitor = await db.monitor.getOne( + pipeline.project.id.toString(), + pipeline.object_attributes.id.toString(), + stage, + apiKey + ) + if (monitor) return + // 获取消息信息 + const { receiver, variable } = await genCardVariable(pipeline) + await db.monitor.create({ + project_id: pipeline.project.id.toString(), + pipeline_id: pipeline.object_attributes.id.toString(), + stage, + api_key: apiKey, + receiver, + variable, + }) +} + +/** + * 移除监控 + * @param {Gitlab.PipelineEvent} pipeline - 流水线信息 + * @param {string} apiKey - API 密钥 + * @param {string} stage - 阶段名称 + * @returns {Promise} - 无返回值 + */ +const removeMonitor = async ( + pipeline: Gitlab.PipelineEvent, + apiKey: string, + stage: string +): Promise => { + const monitor = await db.monitor.getOne( + pipeline.project.id.toString(), + pipeline.object_attributes.id.toString(), + stage, + apiKey + ) + if (!monitor) return + await db.monitor.del(monitor.id) +} + +/** + * 移除监控并发送提醒消息 + * @param {Gitlab.PipelineEvent} pipeline - 流水线信息 + * @param {string} apiKey - API 密钥 + * @param {string} stage - 阶段名称 + * @returns {Promise} - 无返回值 + */ +const removeMonitorAndNotify = async ( + pipeline: Gitlab.PipelineEvent, + apiKey: string, + stage: string +): Promise => { + const monitor = await db.monitor.getOne( + pipeline.project.id.toString(), + pipeline.object_attributes.id.toString(), + stage, + apiKey + ) + if (!monitor) return + db.monitor.del(monitor.id) + sendNotify(pipeline, apiKey) +} + +/** + * 发送通知消息 + * @param {Gitlab.PipelineEvent} pipeline - GitLab 流水线事件对象 + * @param {string} apiKey - API 密钥 + * @param {URLSearchParams} params - URL 查询参数 + * @returns {Promise} - 返回操作结果 + */ +const manageRawEvent = async ( + pipeline: Gitlab.PipelineEvent, + apiKey: string, + params: URLSearchParams +): Promise => { + // 获取Stage参数 + const stage = params.get("stage") + // 获取下一步操作 + const action = await getNextAction(pipeline, stage) + // 发送通知 + if (action === NEXT_ACTION.NOTIFY) { + sendNotify(pipeline, apiKey) + } + // 添加监控 + if (action === NEXT_ACTION.ADD_MONITOR) { + addMonitor(pipeline, apiKey, stage!) + } + // 删除监控 + if (action === NEXT_ACTION.REMOVE_MONITOR) { + removeMonitor(pipeline, apiKey, stage!) + } + // 删除监控并发送通知 + if (action === NEXT_ACTION.NOTIFY_AND_REMOVE_MONITOR) { + removeMonitorAndNotify(pipeline, apiKey, stage!) + } // 返回成功 return netTool.ok() } +/** + * 管理流水线事件 + */ const managePipelineEvent = { - sendNotifyMsg, + manageRawEvent, + genLarkRobotMsgContent, } export default managePipelineEvent diff --git a/controllers/manageProject/index.ts b/controllers/manageProject/index.ts index 987f11a..7ece550 100644 --- a/controllers/manageProject/index.ts +++ b/controllers/manageProject/index.ts @@ -4,8 +4,10 @@ import { DB } from "../../types/db" /** * 填充项目信息 + * @param {DB.Project} project - 项目对象 + * @returns {Promise} - 返回填充后的项目对象 */ -const fillProj = async (project: DB.Project) => { +const fillProj = async (project: DB.Project): Promise => { const projDetail = await service.gitlab.project.getDetail(project.project_id) if (!projDetail) { return project @@ -22,10 +24,10 @@ const fillProj = async (project: DB.Project) => { } /** - * 获取到当前所有的项目列表 - * 并把信息不全的项目送给fillProj填充内容 + * 获取到当前所有的项目列表，并把信息不全的项目送给 fillProj 填充内容 + * @returns {Promise} - 返回完整的项目列表 */ -const getFullProjList = async () => { +const getFullProjList = async (): Promise => { const fullList = await db.project.getFullList() // 把信息不全的项目送过去填充 const filledProjList = await Promise.all( @@ -38,7 +40,14 @@ const getFullProjList = async () => { return filledFullProjList } -const getFullProjectMap = (fullProjList: DB.Project[]) => { +/** + * 获取完整的项目映射表 + * @param {DB.Project[]} fullProjList - 完整的项目列表 + * @returns {Record} - 返回项目映射表 + */ +const getFullProjectMap = ( + fullProjList: DB.Project[] +): Record => { const fullProjectMap: Record = {} fullProjList.forEach((item) => { fullProjectMap[item.project_id] = item.id diff --git a/controllers/manageRobot/index.ts b/controllers/manageRobot/index.ts index 88e55bc..ad14acc 100644 --- a/controllers/manageRobot/index.ts +++ b/controllers/manageRobot/index.ts @@ -3,6 +3,10 @@ import service from "../../service" import { calculateWeeklyRate } from "../../utils/robotTools" import { getPrevWeekWithYear, getWeekTimeWithYear } from "../../utils/timeTools" +/** + * 获取新的CI/CD状态 + * @returns {Promise<{ has_new_cicd_count: string, without_new_cicd_count: string }>} - 返回包含有新CI/CD和无新CI/CD的项目数量 + */ const getNewCicdStatus = async () => { const fullProjList = await db.project.getFullList() const has_new_cicd_count = String( @@ -21,6 +25,10 @@ const getNewCicdStatus = async () => { } } +/** + * 获取统计信息 + * @returns {Promise} - 返回包含统计信息的对象 + */ const getStatisticsInfo = async () => { const curWeekInfo = await db.view.getFullStatisticsByWeek( getWeekTimeWithYear() @@ -48,6 +56,10 @@ const getStatisticsInfo = async () => { } } +/** + * 获取项目差异信息 + * @returns {Promise} - 返回包含项目差异信息的数组 + */ const getProjDiffInfo = async () => { const curWeekInfo = (await db.view.getProjStatisticsByWeek(getWeekTimeWithYear())) || [] @@ -95,7 +107,7 @@ const getProjDiffInfo = async () => { /** * 获取机器人消息 - * @returns + * @returns {Promise} - 返回机器人消息的JSON字符串 */ const getRobotMsg = async () => JSON.stringify({ @@ -115,7 +127,8 @@ const getRobotMsg = async () => /** * 通过ChatID发送CI报告 - * @param chat_id + * @param {string} chat_id - ChatID + * @returns {Promise} */ const sendCIReportByChatId = async (chat_id: string) => { await service.message.byChatId(chat_id, await getRobotMsg()) @@ -123,7 +136,7 @@ const sendCIReportByChatId = async (chat_id: string) => { /** * 通过定时任务发送CI报告 - * @returns + * @returns {Promise} */ const sendCIReportByCron = async () => await service.message.byGroupId("52usf3w8l6z4vs1", await getRobotMsg()) diff --git a/controllers/manageUser/index.ts b/controllers/manageUser/index.ts index f027f98..3406ccc 100644 --- a/controllers/manageUser/index.ts +++ b/controllers/manageUser/index.ts @@ -1,7 +1,14 @@ import db from "../../db" import { Gitlab } from "../../types/gitlab" -const getFullUserMap = async (fullPipelineList: Gitlab.PipelineDetail[][]) => { +/** + * 获取完整的用户映射表 + * @param {Gitlab.PipelineDetail[][]} fullPipelineList - 完整的pipeline列表 + * @returns {Promise>} - 返回用户映射表 + */ +const getFullUserMap = async ( + fullPipelineList: Gitlab.PipelineDetail[][] +): Promise> => { const userList: Gitlab.User[] = [] fullPipelineList.forEach((fullPipeline) => { fullPipeline.forEach((item) => { diff --git a/db/index.ts b/db/index.ts index 7c59dab..e36b6d6 100644 --- a/db/index.ts +++ b/db/index.ts @@ -1,3 +1,4 @@ +import monitor from "./monitor" import notify from "./notify" import pipeline from "./pipeline" import project from "./project" @@ -10,6 +11,7 @@ const db = { user, view, notify, + monitor, } export default db diff --git a/db/monitor/index.ts b/db/monitor/index.ts new file mode 100644 index 0000000..4a61993 --- /dev/null +++ b/db/monitor/index.ts @@ -0,0 +1,57 @@ +import { DB } from "../../types/db" +import { managePb404 } from "../../utils/pbTools" +import pbClient from "../pbClient" + +/** + * 获取一个监控项 + * @param {string} project_id - 项目ID + * @param {string} pipeline_id - 流水线ID + * @param {string} stage - 阶段 + * @param {string} api_key - API密钥 + * @returns {Promise} - 返回监控项或null + */ +const getOne = ( + project_id: string, + pipeline_id: string, + stage: string, + api_key: string +) => + managePb404(() => + pbClient + .collection("monitor") + .getFirstListItem( + `project_id="${project_id}" && pipeline_id="${pipeline_id}" && stage="${stage}" && api_key="${api_key}"` + ) + ) + +/** + * 获取所有监控项的完整列表 + * @returns {Promise} - 返回监控项的完整列表 + */ +const getFullList = async (): Promise => + await pbClient.collection("monitor").getFullList() + +/** + * 创建一个监控项 + * @param {Partial} data - 监控项数据 + * @returns {Promise} - 返回创建的监控项 + */ +const create = async (data: Partial): Promise => + await pbClient.collection("monitor").create(data) + +/** + * 删除一个监控项 + * @param {string} id - 监控项ID + * @returns {Promise} + */ +const del = async (id: string): Promise => + await pbClient.collection("monitor").delete(id) + +const monitor = { + create, + getOne, + del, + getFullList, +} + +export default monitor diff --git a/db/notify/index.ts b/db/notify/index.ts index 3e7d93b..814cfc9 100644 --- a/db/notify/index.ts +++ b/db/notify/index.ts @@ -1,29 +1,16 @@ import { DB } from "../../types/db" -import { managePb404 } from "../../utils/pbTools" import pbClient from "../pbClient" -/** - * 从数据库检索一个通知。 - * @param id 要检索的通知的ID。 - * @returns 如果找到，返回解析为通知对象的promise；如果未找到，抛出404错误。 - */ -const getOne = (id: string) => - managePb404( - async () => - await pbClient.collection("notify").getFirstListItem(`build_id="${id}"`) - ) - /** * 创建一个新的通知。 - * @param data 新通知的数据。 - * @returns 返回解析为已创建通知对象的promise。 + * @param {Partial} data - 新通知的数据。 + * @returns {Promise} - 返回解析为已创建通知对象的promise。 */ const create = async (data: Partial) => await pbClient.collection("notify").create(data) const notify = { create, - getOne, } export default notify diff --git a/db/pipeline/index.ts b/db/pipeline/index.ts index 2008b67..2bf356a 100644 --- a/db/pipeline/index.ts +++ b/db/pipeline/index.ts @@ -4,34 +4,31 @@ import pbClient from "../pbClient" /** * 通过其 ID 检索一个管道。 - * @param id 管道的 ID。 - * @returns 一个解析为管道对象的 promise。 + * @param {string} id - 管道的 ID。 + * @returns {Promise} - 一个解析为管道对象的 promise。 */ const getOne = (id: string) => - managePb404( - async () => await pbClient.collection("pipeline").getOne(id) - ) + managePb404(() => pbClient.collection("pipeline").getOne(id)) /** * 检索项目的最新管道。 - * @param project_id 项目的 ID。 - * @returns 一个解析为最新管道对象的 promise。 + * @param {string} project_id - 项目的 ID。 + * @returns {Promise} - 一个解析为最新管道对象的 promise。 */ const getLatestOne = (project_id: string) => { - return managePb404( - async () => - await pbClient - .collection("pipeline") - .getFirstListItem(`project_id="${project_id}"`, { - sort: "-created_at", - }) + return managePb404(() => + pbClient + .collection("pipeline") + .getFirstListItem(`project_id="${project_id}"`, { + sort: "-created_at", + }) ) } /** * 创建一个新的管道。 - * @param data 新管道的数据。 - * @returns 一个解析为创建的管道对象的 promise。 + * @param {Partial} data - 新管道的数据。 + * @returns {Promise} - 一个解析为创建的管道对象的 promise。 */ const create = async (data: Partial) => await pbClient.collection("pipeline").create(data) diff --git a/db/project/index.ts b/db/project/index.ts index f2c574b..00b6458 100644 --- a/db/project/index.ts +++ b/db/project/index.ts @@ -4,28 +4,29 @@ import pbClient from "../pbClient" /** * 通过其 ID 检索单个项目。 - * @param id - 项目的 ID。 - * @returns 一个解析为项目对象的 promise。 + * @param {string} id - 项目的 ID。 + * @returns {Promise} - 一个解析为项目对象的 promise。 */ const getOne = (id: string) => - managePb404( - async () => await pbClient.collection("project").getOne(id) - ) + managePb404(() => pbClient.collection("project").getOne(id)) /** * 检索项目的完整列表。 - * @returns 一个解析为项目对象数组的 promise。 + * @returns {Promise} - 一个解析为项目对象数组的 promise。 */ const getFullList = async () => await pbClient.collection("project").getFullList() /** * 使用新数据更新项目。 - * @param id - 要更新的项目的 ID。 - * @param data - 用于更新项目的部分数据。 - * @returns 一个解析为更新后的项目对象的 promise。 + * @param {string} id - 要更新的项目的 ID。 + * @param {Partial} data - 用于更新项目的部分数据。 + * @returns {Promise} - 一个解析为更新后的项目对象的 promise。 */ -const update = async (id: string, data: Partial) => +const update = async ( + id: string, + data: Partial +): Promise => await pbClient.collection("project").update(id, data) /** diff --git a/db/user/index.ts b/db/user/index.ts index 52e8b00..061b143 100644 --- a/db/user/index.ts +++ b/db/user/index.ts @@ -4,32 +4,28 @@ import pbClient from "../pbClient" /** * 根据提供的ID从数据库检索单个用户。 - * @param id 要检索的用户的ID。 - * @returns 如果找到，返回解析为用户对象的promise；如果未找到，抛出404错误。 + * @param {string} id - 要检索的用户的ID。 + * @returns {Promise} - 如果找到，返回解析为用户对象的promise；如果未找到，抛出404错误。 */ const getOne = (id: string) => - managePb404(async () => await pbClient.collection("user").getOne(id)) + managePb404(() => pbClient.collection("user").getOne(id)) /** * 根据提供的用户ID从数据库检索单个用户。 - * @param user_id 要检索的用户的用户ID。 - * @returns 如果找到，返回解析为用户对象的promise；如果未找到，抛出404错误。 + * @param {number} user_id - 要检索的用户的用户ID。 + * @returns {Promise} - 如果找到，返回解析为用户对象的promise；如果未找到，抛出404错误。 */ -const getOneByUserId = (user_id: number) => { - return managePb404( - async () => - await pbClient - .collection("user") - .getFirstListItem(`user_id="${user_id}"`, { - sort: "-created", - }) +const getOneByUserId = (user_id: number) => + managePb404(() => + pbClient.collection("user").getFirstListItem(`user_id="${user_id}"`, { + sort: "-created", + }) ) -} /** * 在数据库中创建一个新用户。 - * @param data 新用户的数据。 - * @returns 返回解析为已创建用户对象的promise。 + * @param {Partial} data - 新用户的数据。 + * @returns {Promise} - 返回解析为已创建用户对象的promise。 */ const create = async (data: Partial) => await pbClient.collection("user").create(data) @@ -38,11 +34,10 @@ const create = async (data: Partial) => * 在数据库中插入或更新一个用户。 * 如果具有相同用户ID的用户已存在，则更新现有用户。 * 如果具有相同用户ID的用户不存在，则创建一个新用户。 - * @param data 要插入或更新的用户数据。 - * @returns 返回解析为插入或更新的用户对象的promise。 - * 如果数据不包含用户ID，则返回null。 + * @param {Partial} data - 要插入或更新的用户数据。 + * @returns {Promise} - 返回解析为插入或更新的用户对象的promise。如果数据不包含用户ID，则返回null。 */ -const upsert = async (data: Partial) => { +const upsert = async (data: Partial): Promise => { if (!data.user_id) return null const userInfo = await getOneByUserId(data.user_id) if (userInfo) return userInfo diff --git a/db/view/index.ts b/db/view/index.ts index fae65b6..ec5fee8 100644 --- a/db/view/index.ts +++ b/db/view/index.ts @@ -4,32 +4,29 @@ import pbClient from "../pbClient" /** * 根据给定的周来检索完整的统计信息。 - * @param week - 需要检索统计信息的周。 - * @returns 一个解析为指定周的完整统计信息的promise。 + * @param {string} week - 需要检索统计信息的周。 + * @returns {Promise} - 一个解析为指定周的完整统计信息的promise。 */ -const getFullStatisticsByWeek = (week: string) => { - return managePb404( - async () => - await pbClient - .collection("statisticsPerWeek") - .getFirstListItem(`week="${week}"`) +const getFullStatisticsByWeek = (week: string) => + managePb404(() => + pbClient.collection("statisticsPerWeek").getFirstListItem(`week="${week}"`) ) -} /** * 根据给定的周来检索项目统计信息。 - * @param week - 需要检索统计信息的周。 - * @returns 一个解析为指定周的项目统计信息数组的promise。 + * @param {string} week - 需要检索统计信息的周。 + * @returns {Promise} - 一个解析为指定周的项目统计信息数组的promise。 */ -const getProjStatisticsByWeek = (week: string) => { - return managePb404( - async () => - await pbClient - .collection("statisticsPerProj") - .getFullList({ filter: `week="${week}"` }) +const getProjStatisticsByWeek = (week: string) => + managePb404(() => + pbClient + .collection("statisticsPerProj") + .getFullList({ filter: `week="${week}"` }) ) -} +/** + * 提供与视图相关的数据库操作。 + */ const view = { getFullStatisticsByWeek, getProjStatisticsByWeek, diff --git a/package.json b/package.json index 09f5ec3..b727c31 100644 --- a/package.json +++ b/package.json @@ -38,6 +38,7 @@ "lodash": "^4.17.21", "moment": "^2.30.1", "node-schedule": "^2.1.1", + "p-limit": "^6.1.0", "pocketbase": "^0.21.1" } } \ No newline at end of file diff --git a/readme.md b/readme.md index 4a8f3f3..fb58f09 100644 --- a/readme.md +++ b/readme.md @@ -19,7 +19,16 @@ 组织卡片信息，给 Commit的用户以及 可能的 MR发起者发送通知 ## 处理在中间Stage需要提醒的情况 -在stage全部成功的情况下，按finish_at时间排序，找到最后一个stage，如果stage的状态是成功，且该build的id没有发送过通知，则发送通知 + +~~在stage全部成功的情况下，按finish_at时间排序，找到最后一个stage，如果stage的状态是成功，且该build的id没有发送过通知，则发送通知~~ + +流水线通知只是在Pipeline纬度上，所以某个stage的变化不会触发通知 + +在流水线为`running`时，如果需要监听Stage，且该stage全部的job有非结束状态时即`created`、`pending`、`running`、`manual`、`scheduled`时 + +加入数据库监控列表，每10s检查一次，如果stage状态全部成功的时候则发送通知，并删除监控 + +在流水线结束，即状态为`failed`、`canceled`、`skipped`、`success`，的时候，删除监控，并在状态为`success`的时候，发送通知 # 数据库表信息 diff --git a/routes/ci/index.ts b/routes/ci/index.ts index ea471ef..9cd1727 100644 --- a/routes/ci/index.ts +++ b/routes/ci/index.ts @@ -3,10 +3,10 @@ import netTool from "../../service/netTool" /** * 处理管理CI监视器的请求。 - * @param req - 请求对象。 - * @returns 响应对象。 + * @param {Request} req - 请求对象。 + * @returns {Response} - 响应对象。 */ -export const manageCIMonitorReq = (req: Request) => { +export const manageCIMonitorReq = (req: Request): Response => { const url = new URL(req.url) const chat_id = url.searchParams.get("chat_id") if (!chat_id) return netTool.badRequest("chat_id is required!") diff --git a/routes/event/index.ts b/routes/event/index.ts index b75970b..6344e05 100644 --- a/routes/event/index.ts +++ b/routes/event/index.ts @@ -4,10 +4,10 @@ import { Gitlab } from "../../types/gitlab" /** * 处理管理Gitlab事件的请求。 - * @param req - 请求对象。 - * @returns 响应对象。 + * @param {Request} req - 请求对象。 + * @returns {Promise} - 响应对象。 */ -export const manageGitlabEventReq = async (req: Request) => { +export const manageGitlabEventReq = async (req: Request): Promise => { const apiKey = req.headers.get("x-gitlab-token") if (!apiKey) return netTool.badRequest("x-gitlab-token is required!") const eventType = req.headers.get("x-gitlab-event") @@ -15,7 +15,7 @@ export const manageGitlabEventReq = async (req: Request) => { if (eventType === "Pipeline Hook") { const body = (await req.json()) as Gitlab.PipelineEvent const params = new URLSearchParams(req.url.split("?")[1]) - return managePipelineEvent.sendNotifyMsg(body, apiKey, params) + return managePipelineEvent.manageRawEvent(body, apiKey, params) } return netTool.ok() } diff --git a/schedule/index.ts b/schedule/index.ts index 1af9c6d..adbfa25 100644 --- a/schedule/index.ts +++ b/schedule/index.ts @@ -1,15 +1,20 @@ import { scheduleJob } from "node-schedule" import manageRobot from "../controllers/manageRobot" -import syncPipLine from "./syncPipLine" +import monitorJob from "./monitorJob" +import syncPipeLine from "./syncPipeLine" const initSchedule = async () => { // 每周五早上10点发送CI报告 scheduleJob("0 10 * * 5", manageRobot.sendCIReportByCron) // 每15分钟同步一次CI数据 - scheduleJob("*/15 * * * *", syncPipLine) + scheduleJob("*/15 * * * *", syncPipeLine) + // 每10秒执行一次监控任务 + scheduleJob("*/10 * * * * *", monitorJob) // 立即同步一次 - syncPipLine() + syncPipeLine() + // 立即执行一次监控任务 + monitorJob() } export default initSchedule diff --git a/schedule/monitorJob.ts b/schedule/monitorJob.ts new file mode 100644 index 0000000..880dfef --- /dev/null +++ b/schedule/monitorJob.ts @@ -0,0 +1,84 @@ +import pLimit from "p-limit" + +import managePipelineEvent from "../controllers/managePipelineEvent" +import db from "../db" +import service from "../service" +import { DB } from "../types/db" +import { sec2minStr } from "../utils/timeTools" + +/** + * 执行监控任务 + * @param {DB.Monitor} monitor - 监控项 + * @returns {Promise} + */ +const doMonitor = async (monitor: DB.Monitor): Promise => { + const { project_id, pipeline_id, api_key, stage, receiver, variable } = + monitor + // 获取Job列表 + const jobList = await service.gitlab.pipeline.getJobs( + Number(project_id), + Number(pipeline_id) + ) + // 是否所有Stage关联的Job都成功了 + const isAllSuccess = jobList.every( + (job) => job.stage === stage && job.status === "success" + ) + // 没全部成功跳过 + if (!isAllSuccess) return + // 先删除监控 + await db.monitor.del(monitor.id) + // 获取最新的执行时长 + const pipelineDetail = await service.gitlab.pipeline.getDetail( + Number(project_id), + Number(pipeline_id) + ) + if (pipelineDetail) { + variable["duration"] = sec2minStr(pipelineDetail.duration) + } + // 获取机器人消息 + const robotMsg = managePipelineEvent.genLarkRobotMsgContent(variable) + // 发送消息 + await service.message.byUserIdList(receiver, robotMsg, api_key) + // 记录日志 + await db.notify.create({ ...variable }) +} + +/** + * 移除超过24小时的监控项 + * @async + * @function removeOverTimeMonitor + * @returns {Promise} 无返回值 + * @description 该函数从数据库中获取所有监控项，并移除创建时间超过24小时的监控项。 + */ +const removeOverTimeMonitor = async (): Promise => { + const fullMonitorList = await db.monitor.getFullList() + const now = Date.now() + await Promise.all( + fullMonitorList.map(async (monitor) => { + const createdAtTimestamp = new Date(monitor.created_at).getTime() + if (now - createdAtTimestamp > 24 * 60 * 60 * 1000) { + await db.monitor.del(monitor.id) + } + }) + ) +} + +/** + * 监控任务的主函数 + * @returns {Promise} + */ +const monitorJob = async (): Promise => { + // 获取全部监控项 + const fullMonitorList = await db.monitor.getFullList() + if (fullMonitorList.length === 0) return + // 并发限制 + const limit = pLimit(3) + // 并发处理 + await Promise.all( + fullMonitorList.map((monitor) => limit(() => doMonitor(monitor))) + ) + // 移除超过24小时的监控项 + await removeOverTimeMonitor() +} + +export default monitorJob diff --git a/schedule/syncPipLine.ts b/schedule/syncPipeLine.ts similarity index 59% rename from schedule/syncPipLine.ts rename to schedule/syncPipeLine.ts index 8b7bc57..2aee567 100644 --- a/schedule/syncPipLine.ts +++ b/schedule/syncPipeLine.ts @@ -2,7 +2,17 @@ import managePipeline from "../controllers/managePipeLine" import manageProject from "../controllers/manageProject" import manageUser from "../controllers/manageUser" -const syncPipLine = async () => { +/** + * 同步管道函数 + * + * 该函数首先获取完整的项目列表，然后获取每个项目的完整管道列表。 + * 接着，它获取完整的用户映射和项目映射，最后将这些数据插入到管道列表中。 + * + * @async + * @function syncPipLine + * @returns {Promise} 不返回任何内容 + */ +const syncPipeLine = async (): Promise => { const fullProjList = await manageProject.getFullProjList() const fullPipelineList = await Promise.all( fullProjList.map((v) => managePipeline.getFullPipelineList(v)) @@ -16,4 +26,4 @@ const syncPipLine = async () => { ) } -export default syncPipLine +export default syncPipeLine diff --git a/script/pipline/jobs.json b/script/pipline/jobs.json new file mode 100644 index 0000000..58de391 --- /dev/null +++ b/script/pipline/jobs.json @@ -0,0 +1,181 @@ +[ + { + "id": 25820911, + "status": "running", + "stage": "deploy", + "name": "DEPLOY_STAGING", + "ref": "staging", + "tag": false, + "coverage": null, + "allow_failure": false, + "created_at": "2024-08-08T16:19:15.798+08:00", + "started_at": "2024-08-08T16:19:21.461+08:00", + "finished_at": null, + "duration": 19.551757848, + "queued_duration": 5.623183, + "user": { + "id": 10011, + "username": "zhaoyingbo", + "name": "赵英博", + "state": "active", + "avatar_url": "https://git.n.xiaomi.com/uploads/-/system/user/avatar/10011/avatar.png", + "web_url": "https://git.n.xiaomi.com/zhaoyingbo", + "created_at": "2020-08-24T19:34:30.822+08:00", + "bio": "", + "location": "", + "public_email": "zhaoyingbo@live.cn", + "skype": "", + "linkedin": "", + "twitter": "", + "website_url": "", + "organization": "", + "job_title": "", + "pronouns": null, + "bot": false, + "work_information": null, + "followers": 0, + "following": 0, + "bio_html": "" + }, + "commit": { + "id": "748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f", + "short_id": "748dfce3", + "created_at": "2024-08-08T14:52:03.000+08:00", + "parent_ids": [ + "cbbdf145bd5fbc631803bd9243bc4bdf8a6fa959", + "156d2b1c527f01976ce1b122452e8be1c8b5b199" + ], + "title": "Merge branch 'feature/modelService-ApprovalDeletion' into staging", + "message": "Merge branch 'feature/modelService-ApprovalDeletion' into staging\n", + "author_name": "jiangtong", + "author_email": "jiangtong@xiaomi.com", + "authored_date": "2024-08-08T14:52:03.000+08:00", + "committer_name": "jiangtong", + "committer_email": "jiangtong@xiaomi.com", + "committed_date": "2024-08-08T14:52:03.000+08:00", + "trailers": {}, + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/commit/748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f" + }, + "pipeline": { + "id": 8936993, + "project_id": 139032, + "sha": "748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f", + "ref": "staging", + "status": "running", + "source": "push", + "created_at": "2024-08-08T14:52:11.425+08:00", + "updated_at": "2024-08-08T16:19:16.880+08:00", + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/pipelines/8936993" + }, + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/jobs/25820911", + "artifacts": [], + "runner": { + "id": 9134, + "description": "cloudml-fe-bj", + "ip_address": "10.142.18.13", + "active": true, + "is_shared": false, + "runner_type": "group_type", + "name": "gitlab-runner", + "online": true, + "status": "online" + }, + "artifacts_expire_at": null, + "tag_list": [ + "cloudml-fe-bj" + ] + }, + { + "id": 25815806, + "status": "success", + "stage": "sonar_scan", + "name": "SONAR_SCAN", + "ref": "staging", + "tag": false, + "coverage": null, + "allow_failure": true, + "created_at": "2024-08-08T14:52:11.564+08:00", + "started_at": "2024-08-08T14:54:57.403+08:00", + "finished_at": "2024-08-08T14:57:57.990+08:00", + "duration": 180.587239, + "queued_duration": 6.876928, + "user": { + "id": 18608, + "username": "jiangtong", + "name": "姜通", + "state": "active", + "avatar_url": "https://git.n.xiaomi.com/uploads/-/system/user/avatar/18608/avatar.png", + "web_url": "https://git.n.xiaomi.com/jiangtong", + "created_at": "2021-12-09T12:43:41.266+08:00", + "bio": "", + "location": "", + "public_email": "", + "skype": "", + "linkedin": "", + "twitter": "", + "website_url": "", + "organization": "", + "job_title": "", + "pronouns": null, + "bot": false, + "work_information": null, + "followers": 0, + "following": 0, + "bio_html": "" + }, + "commit": { + "id": "748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f", + "short_id": "748dfce3", + "created_at": "2024-08-08T14:52:03.000+08:00", + "parent_ids": [ + "cbbdf145bd5fbc631803bd9243bc4bdf8a6fa959", + "156d2b1c527f01976ce1b122452e8be1c8b5b199" + ], + "title": "Merge branch 'feature/modelService-ApprovalDeletion' into staging", + "message": "Merge branch 'feature/modelService-ApprovalDeletion' into staging\n", + "author_name": "jiangtong", + "author_email": "jiangtong@xiaomi.com", + "authored_date": "2024-08-08T14:52:03.000+08:00", + "committer_name": "jiangtong", + "committer_email": "jiangtong@xiaomi.com", + "committed_date": "2024-08-08T14:52:03.000+08:00", + "trailers": {}, + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/commit/748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f" + }, + "pipeline": { + "id": 8936993, + "project_id": 139032, + "sha": "748dfce35d9f04c2da3ddde2f68f1c0b9a7f751f", + "ref": "staging", + "status": "running", + "source": "push", + "created_at": "2024-08-08T14:52:11.425+08:00", + "updated_at": "2024-08-08T16:19:16.880+08:00", + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/pipelines/8936993" + }, + "web_url": "https://git.n.xiaomi.com/cloudml-visuals/fe/cloud-ml-fe/-/jobs/25815806", + "artifacts": [ + { + "file_type": "trace", + "size": 57859, + "filename": "job.log", + "file_format": null + } + ], + "runner": { + "id": 9134, + "description": "cloudml-fe-bj", + "ip_address": "10.142.18.13", + "active": true, + "is_shared": false, + "runner_type": "group_type", + "name": "gitlab-runner", + "online": true, + "status": "online" + }, + "artifacts_expire_at": null, + "tag_list": [ + "cloudml-fe-bj" + ] + } +] \ No newline at end of file diff --git a/service/gitlab/badge.ts b/service/gitlab/badge.ts index 64e93d8..07e7423 100644 --- a/service/gitlab/badge.ts +++ b/service/gitlab/badge.ts @@ -11,10 +11,10 @@ export type BadgeSetParams = Omit & { /** * 为特定项目检索 GitLab 徽章。 - * @param project_id 项目的 ID。 - * @returns 一个承诺，解析为 GitLab 徽章的数组。 + * @param {number} project_id - 项目的 ID。 + * @returns {Promise} 一个承诺，解析为 GitLab 徽章的数组。 */ -const get = async (project_id: number) => { +const get = async (project_id: number): Promise => { const URL = `${GITLAB_BASE_URL}/projects/${project_id}/badges` return gitlabReqWarp( () => netTool.get(URL, {}, GITLAB_AUTH_HEADER), @@ -24,10 +24,10 @@ const get = async (project_id: number) => { /** * 设置 GitLab 徽章。 - * @param badge 徽章参数。 - * @returns 一个承诺，解析为更新后的徽章。 + * @param {BadgeSetParams} badge - 徽章参数。 + * @returns {Promise} 一个承诺，解析为更新后的徽章。 */ -const set = async (badge: BadgeSetParams) => { +const set = async (badge: BadgeSetParams): Promise => { const URL = `${GITLAB_BASE_URL}/projects/${badge.id}/badges/${badge.badge_id}` return gitlabReqWarp( () => netTool.put(URL, badge, {}, GITLAB_AUTH_HEADER), @@ -37,10 +37,10 @@ const set = async (badge: BadgeSetParams) => { /** * 添加 GitLab 徽章。 - * @param badge 徽章参数。 - * @returns 一个承诺，解析为添加的徽章。 + * @param {BadgeSetParams} badge - 徽章参数。 + * @returns {Promise} 一个承诺，解析为添加的徽章。 */ -const add = async (badge: BadgeSetParams) => { +const add = async (badge: BadgeSetParams): Promise => { const URL = `${GITLAB_BASE_URL}/projects/${badge.id}/badges` return gitlabReqWarp( () => netTool.post(URL, badge, {}, GITLAB_AUTH_HEADER), diff --git a/service/gitlab/commit.ts b/service/gitlab/commit.ts index ff794ec..4e14532 100644 --- a/service/gitlab/commit.ts +++ b/service/gitlab/commit.ts @@ -4,11 +4,14 @@ import { GITLAB_AUTH_HEADER, GITLAB_BASE_URL, gitlabReqWarp } from "./tools" /** * 检索与特定提交关联的合并请求。 - * @param project_id - 项目的ID。 - * @param sha - 提交的SHA。 - * @returns 一个解析为合并请求数组的promise。 + * @param {number} project_id - 项目的ID。 + * @param {string} sha - 提交的SHA。 + * @returns {Promise} 一个解析为合并请求数组的promise。 */ -const getMr = async (project_id: number, sha: string) => { +const getMr = async ( + project_id: number, + sha: string +): Promise => { const URL = `${GITLAB_BASE_URL}/projects/${project_id}/repository/commits/${sha}/merge_requests` return gitlabReqWarp( () => netTool.get(URL, {}, GITLAB_AUTH_HEADER), diff --git a/service/gitlab/pipeline.ts b/service/gitlab/pipeline.ts index e83c4f5..273d6ae 100644 --- a/service/gitlab/pipeline.ts +++ b/service/gitlab/pipeline.ts @@ -4,15 +4,14 @@ import { GITLAB_AUTH_HEADER, GITLAB_BASE_URL, gitlabReqWarp } from "./tools" /** * 获取特定GitLab流水线的详细信息。 - * @param project_id - 项目的ID。 - * @param pipeline_id - 流水线的ID。 - * @param created_at - 流水线的创建日期。 - * @returns 一个解析为流水线详细信息的promise。 + * @param {number} project_id - 项目的ID。 + * @param {number} pipeline_id - 流水线的ID。 + * @param {string} created_at - 流水线的创建日期。 */ const getDetail = async ( project_id: number, pipeline_id: number, - created_at: string + created_at?: string ) => { const URL = `${GITLAB_BASE_URL}/projects/${project_id}/pipelines/${pipeline_id}` const res = await gitlabReqWarp( @@ -25,11 +24,14 @@ const getDetail = async ( /** * 获取特定项目的GitLab流水线列表。 - * @param project_id - 项目的ID。 - * @param page - 结果的页码（默认值：1）。 - * @returns 一个解析为流水线数组的promise。 + * @param {number} project_id - 项目的ID。 + * @param {number} [page=1] - 结果的页码（默认值：1）。 + * @returns {Promise} 一个解析为流水线数组的promise。 */ -const getList = async (project_id: number, page = 1) => { +const getList = async ( + project_id: number, + page = 1 +): Promise => { const URL = `${GITLAB_BASE_URL}/projects/${project_id}/pipelines` const params = { scope: "finished", per_page: 100, page } return gitlabReqWarp( @@ -38,9 +40,27 @@ const getList = async (project_id: number, page = 1) => { ) } +/** + * 获取特定GitLab流水线的任务列表。 + * @param {number} project_id - 项目的ID。 + * @param {number} pipeline_id - 流水线的ID。 + * @returns {Promise} 一个解析为任务数组的promise。 + */ +const getJobs = async ( + project_id: number, + pipeline_id: number +): Promise => { + const URL = `${GITLAB_BASE_URL}/projects/${project_id}/pipelines/${pipeline_id}/jobs` + return gitlabReqWarp( + () => netTool.get(URL, {}, GITLAB_AUTH_HEADER), + [] + ) +} + const pipeline = { getDetail, getList, + getJobs, } export default pipeline diff --git a/service/gitlab/project.ts b/service/gitlab/project.ts index 243709a..7e61529 100644 --- a/service/gitlab/project.ts +++ b/service/gitlab/project.ts @@ -4,10 +4,12 @@ import { GITLAB_AUTH_HEADER, GITLAB_BASE_URL, gitlabReqWarp } from "./tools" /** * 获取 GitLab 项目的详细信息。 - * @param project_id - 项目的 ID 或 URL-encoded 路径。 - * @returns 一个解析为项目详细信息的 promise。 + * @param {number | string} project_id - 项目的 ID 或 URL-encoded 路径。 + * @returns {Promise} 一个解析为项目详细信息的 promise。 */ -const getDetail = async (project_id: number | string) => { +const getDetail = async ( + project_id: number | string +): Promise => { if (typeof project_id === "string") project_id = encodeURIComponent(project_id) const URL = `${GITLAB_BASE_URL}/projects/${project_id}` diff --git a/service/gitlab/tools.ts b/service/gitlab/tools.ts index 470763c..3424b95 100644 --- a/service/gitlab/tools.ts +++ b/service/gitlab/tools.ts @@ -1,5 +1,12 @@ import { Gitlab } from "../../types/gitlab" +/** + * 包装一个 GitLab 请求函数，处理错误并返回默认值。 + * @template T + * @param {() => Promise} func - 要执行的请求函数。 + * @param {any} default_value - 请求失败时返回的默认值。 + * @returns {Promise} 一个解析为请求结果或默认值的 promise。 + */ export const gitlabReqWarp = async ( func: () => Promise, default_value: any @@ -14,6 +21,14 @@ export const gitlabReqWarp = async ( } } +/** + * GitLab API 的基础 URL。 + * @type {string} + */ export const GITLAB_BASE_URL = "https://git.n.xiaomi.com/api/v4" +/** + * GitLab API 的认证头。 + * @type {object} + */ export const GITLAB_AUTH_HEADER = { "PRIVATE-TOKEN": "Zd1UASPcMwVox5tNS6ep" } diff --git a/service/message/index.ts b/service/message/index.ts index b582523..7543eea 100644 --- a/service/message/index.ts +++ b/service/message/index.ts @@ -3,7 +3,12 @@ import netTool from "../netTool" const API_KEY = "1dfz4wlpbbgiky0" const URL = "https://lark-egg.ai.xiaomi.com/message" -const message = async (body: any) => { +/** + * 发送消息到指定的 URL。 + * @param {object} body - 消息体。 + * @returns {Promise} 一个解析为响应的 promise。 + */ +const message = async (body: any): Promise => { try { const res = await netTool.post(URL, { api_key: API_KEY, @@ -15,7 +20,13 @@ const message = async (body: any) => { } } -message.byGroupId = async (group_id: string, content: string) => { +/** + * 通过群组 ID 发送消息。 + * @param {string} group_id - 群组 ID。 + * @param {string} content - 消息内容。 + * @returns {Promise} 一个解析为响应的 promise。 + */ +message.byGroupId = async (group_id: string, content: string): Promise => { return message({ group_id, msg_type: "interactive", @@ -23,7 +34,13 @@ message.byGroupId = async (group_id: string, content: string) => { }) } -message.byChatId = async (chat_id: string, content: string) => { +/** + * 通过聊天 ID 发送消息。 + * @param {string} chat_id - 聊天 ID。 + * @param {string} content - 消息内容。 + * @returns {Promise} 一个解析为响应的 promise。 + */ +message.byChatId = async (chat_id: string, content: string): Promise => { return message({ receive_id: chat_id, receive_id_type: "chat_id", @@ -32,7 +49,13 @@ message.byChatId = async (chat_id: string, content: string) => { }) } -message.byUserId = async (user_id: string, content: string) => { +/** + * 通过用户 ID 发送消息。 + * @param {string} user_id - 用户 ID。 + * @param {string} content - 消息内容。 + * @returns {Promise} 一个解析为响应的 promise。 + */ +message.byUserId = async (user_id: string, content: string): Promise => { return message({ receive_id: user_id, receive_id_type: "user_id", @@ -41,11 +64,18 @@ message.byUserId = async (user_id: string, content: string) => { }) } +/** + * 通过用户 ID 列表发送消息。 + * @param {string[]} user_id_list - 用户 ID 列表。 + * @param {string} content - 消息内容。 + * @param {string} [api_key] - 可选的 API 密钥。 + * @returns {Promise} 一个解析为响应的 promise。 + */ message.byUserIdList = async ( user_id_list: string[], content: string, api_key?: string -) => { +): Promise => { return message({ receive_id: user_id_list.join(","), receive_id_type: "user_id", diff --git a/service/netTool.ts b/service/netTool.ts index 082a37f..e059f9b 100644 --- a/service/netTool.ts +++ b/service/netTool.ts @@ -8,12 +8,12 @@ interface NetRequestParams { /** * 记录响应详情并返回响应日志对象。 - * @param response - 响应对象。 - * @param method - 请求使用的HTTP方法。 - * @param headers - 请求头。 - * @param requestBody - 请求体。 - * @param responseBody - 响应体。 - * @returns 响应日志对象。 + * @param {Response} response - 响应对象。 + * @param {string} method - 请求使用的HTTP方法。 + * @param {any} headers - 请求头。 + * @param {any} requestBody - 请求体。 + * @param {any} responseBody - 响应体。 + * @returns {object} 响应日志对象。 */ const logResponse = ( response: Response, @@ -39,12 +39,8 @@ const logResponse = ( /** * 发送网络请求并返回一个解析为响应数据的Promise。 - * @param url - 要发送请求的URL。 - * @param method - 请求使用的HTTP方法。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param payload - 请求的有效负载数据。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {NetRequestParams} params - 请求参数对象。 + * @returns {Promise} 一个解析为响应数据的Promise。 * @throws 如果网络响应不成功或存在解析错误，则抛出错误。 */ const netTool = async ({ @@ -109,10 +105,10 @@ const netTool = async ({ /** * 发送GET请求并返回一个解析为响应数据的Promise。 * - * @param url - 要发送请求的URL。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {string} url - 要发送请求的URL。 + * @param {any} [queryParams] - 要包含在URL中的查询参数。 + * @param {any} [additionalHeaders] - 要包含在请求中的附加头。 + * @returns {Promise} 一个解析为响应数据的Promise。 */ netTool.get = ( url: string, @@ -123,11 +119,11 @@ netTool.get = ( /** * 发送POST请求并返回一个解析为响应数据的Promise。 * - * @param url - 要发送请求的URL。 - * @param payload - 请求的有效负载数据。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {string} url - 要发送请求的URL。 + * @param {any} [payload] - 请求的有效负载数据。 + * @param {any} [queryParams] - 要包含在URL中的查询参数。 + * @param {any} [additionalHeaders] - 要包含在请求中的附加头。 + * @returns {Promise} 一个解析为响应数据的Promise。 */ netTool.post = ( url: string, @@ -140,11 +136,11 @@ netTool.post = ( /** * 发送PUT请求并返回一个解析为响应数据的Promise。 * - * @param url - 要发送请求的URL。 - * @param payload - 请求的有效负载数据。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {string} url - 要发送请求的URL。 + * @param {any} payload - 请求的有效负载数据。 + * @param {any} [queryParams] - 要包含在URL中的查询参数。 + * @param {any} [additionalHeaders] - 要包含在请求中的附加头。 + * @returns {Promise} 一个解析为响应数据的Promise。 */ netTool.put = ( url: string, @@ -157,11 +153,11 @@ netTool.put = ( /** * 发送DELETE请求并返回一个解析为响应数据的Promise。 * - * @param url - 要发送请求的URL。 - * @param payload - 请求的有效负载数据。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {string} url - 要发送请求的URL。 + * @param {any} payload - 请求的有效负载数据。 + * @param {any} [queryParams] - 要包含在URL中的查询参数。 + * @param {any} [additionalHeaders] - 要包含在请求中的附加头。 + * @returns {Promise} 一个解析为响应数据的Promise。 */ netTool.del = ( url: string, @@ -174,11 +170,11 @@ netTool.del = ( /** * 发送PATCH请求并返回一个解析为响应数据的Promise。 * - * @param url - 要发送请求的URL。 - * @param payload - 请求的有效负载数据。 - * @param queryParams - 要包含在URL中的查询参数。 - * @param additionalHeaders - 要包含在请求中的附加头。 - * @returns 一个解析为响应数据的Promise。 + * @param {string} url - 要发送请求的URL。 + * @param {any} payload - 请求的有效负载数据。 + * @param {any} [queryParams] - 要包含在URL中的查询参数。 + * @param {any} [additionalHeaders] - 要包含在请求中的附加头。 + * @returns {Promise} 一个解析为响应数据的Promise。 */ netTool.patch = ( url: string, @@ -191,9 +187,9 @@ netTool.patch = ( /** * 创建一个表示400 Bad Request的响应对象。 * - * @param msg - 错误消息。 - * @param requestId - 请求ID。 - * @returns 一个表示400 Bad Request的响应对象。 + * @param {string} msg - 错误消息。 + * @param {string} [requestId] - 请求ID。 + * @returns {Response} 一个表示400 Bad Request的响应对象。 */ netTool.badRequest = (msg: string, requestId?: string) => Response.json({ code: 400, msg, requestId }, { status: 400 }) @@ -201,9 +197,9 @@ netTool.badRequest = (msg: string, requestId?: string) => /** * 创建一个表示404 Not Found的响应对象。 * - * @param msg - 错误消息。 - * @param requestId - 请求ID。 - * @returns 一个表示404 Not Found的响应对象。 + * @param {string} msg - 错误消息。 + * @param {string} [requestId] - 请求ID。 + * @returns {Response} 一个表示404 Not Found的响应对象。 */ netTool.notFound = (msg: string, requestId?: string) => Response.json({ code: 404, msg, requestId }, { status: 404 }) @@ -211,10 +207,10 @@ netTool.notFound = (msg: string, requestId?: string) => /** * 创建一个表示500 Internal Server Error的响应对象。 * - * @param msg - 错误消息。 - * @param data - 错误数据。 - * @param requestId - 请求ID。 - * @returns 一个表示500 Internal Server Error的响应对象。 + * @param {string} msg - 错误消息。 + * @param {any} [data] - 错误数据。 + * @param {string} [requestId] - 请求ID。 + * @returns {Response} 一个表示500 Internal Server Error的响应对象。 */ netTool.serverError = (msg: string, data?: any, requestId?: string) => Response.json({ code: 500, msg, data, requestId }, { status: 500 }) @@ -222,9 +218,9 @@ netTool.serverError = (msg: string, data?: any, requestId?: string) => /** * 创建一个表示200 OK的响应对象。 * - * @param data - 响应数据。 - * @param requestId - 请求ID。 - * @returns 一个表示200 OK的响应对象。 + * @param {any} [data] - 响应数据。 + * @param {string} [requestId] - 请求ID。 + * @returns {Response} 一个表示200 OK的响应对象。 */ netTool.ok = (data?: any, requestId?: string) => Response.json({ code: 0, msg: "success", data, requestId }) diff --git a/types/db.ts b/types/db.ts index 2a215a2..a33b630 100644 --- a/types/db.ts +++ b/types/db.ts @@ -52,7 +52,14 @@ export namespace DB { ref: string } - export interface Notify extends RecordModel, EggMessage.CardVariable { - build_id: string + export type Notify = RecordModel & EggMessage.CardVariable + + export interface Monitor extends RecordModel { + project_id: string + pipeline_id: string + stage: string + receiver: string[] + api_key: string + variable: EggMessage.CardVariable } } diff --git a/types/gitlab.ts b/types/gitlab.ts index b9f32d3..6535915 100644 --- a/types/gitlab.ts +++ b/types/gitlab.ts @@ -154,6 +154,12 @@ export namespace Gitlab { web_url: string } + /* 任务 */ + export interface Job { + status: string + stage: string + } + /* 徽章 */ export interface Badge { /** diff --git a/utils/pathTools.ts b/utils/pathTools.ts index 6253f7c..aebd26f 100644 --- a/utils/pathTools.ts +++ b/utils/pathTools.ts @@ -1,12 +1,26 @@ +/** + * 创建一个路径检查工具，用于精确匹配和前缀匹配路径。 + * @param {string} url - 要检查的基础 URL。 + * @param {string} [prefix] - 可选的路径前缀。 + * @returns {object} 包含路径检查方法的对象。 + */ export const makeCheckPathTool = (url: string, prefix?: string) => { const { pathname } = new URL(url) const makePath = (path: string) => `${prefix || ""}${path}` return { - // 精确匹配 + /** + * 检查路径是否与基础 URL 的路径精确匹配。 + * @param {string} path - 要检查的路径。 + * @returns {boolean} 如果路径精确匹配则返回 true，否则返回 false。 + */ exactCheck: (path: string) => { return pathname === makePath(path) }, - // 前缀匹配 + /** + * 检查路径是否以基础 URL 的路径为前缀。 + * @param {string} path - 要检查的路径。 + * @returns {boolean} 如果路径以基础 URL 的路径为前缀则返回 true，否则返回 false。 + */ startsWithCheck: (path: string) => pathname.startsWith(makePath(path)), } } diff --git a/utils/pbTools.ts b/utils/pbTools.ts index ce6f962..5fc3de0 100644 --- a/utils/pbTools.ts +++ b/utils/pbTools.ts @@ -1,3 +1,12 @@ +/** + * 管理数据库函数的 404 错误。 + * 如果捕获到特定的 "The requested resource wasn't found." 错误消息，则返回 null。 + * 否则，重新抛出错误。 + * + * @template T + * @param {() => Promise} dbFunc - 要执行的数据库函数。 + * @returns {Promise} 一个解析为数据库函数结果或 null 的 promise。 + */ export const managePb404 = async ( dbFunc: () => Promise ): Promise => { diff --git a/utils/robotTools.ts b/utils/robotTools.ts index 1d152d8..b01aa99 100644 --- a/utils/robotTools.ts +++ b/utils/robotTools.ts @@ -1,7 +1,8 @@ /** * 计算百分比变化 - * @param a - * @param b + * @param {number} cur - 当前值。 + * @param {number} prev - 之前的值。 + * @returns {{ diff: number, percentage: string }} 包含差值和百分比变化的对象。 */ export const calculatePercentageChange = (cur: number, prev: number) => { // 计算差值 @@ -24,9 +25,10 @@ export const calculatePercentageChange = (cur: number, prev: number) => { /** * 计算周同比 - * @param cur - * @param prev - * @param needCN + * @param {string | number} cur - 当前值。 + * @param {string | number} prev - 之前的值。 + * @param {boolean} [needCN=true] - 是否需要中文描述。 + * @returns {{ text: string, diff: number, percentage: string }} 包含描述文本、差值和百分比变化的对象。 */ export const calculateWeeklyRate = ( cur: string | number, diff --git a/utils/timeTools.ts b/utils/timeTools.ts index 9552cdc..2056761 100644 --- a/utils/timeTools.ts +++ b/utils/timeTools.ts @@ -1,30 +1,36 @@ import moment from "moment" /** - * 获取今天是今年的第几周，like 2024-05 + * 获取今天是今年的第几周，格式为 YYYY-WW。 + * @returns {string} 今天是今年的第几周。 */ -export const getWeekTimeWithYear = () => { +export const getWeekTimeWithYear = (): string => { return moment().format("YYYY-WW") } /** - * 获取上周是今年的第几周，like 2024-04 + * 获取上周是今年的第几周，格式为 YYYY-WW。 + * @returns {string} 上周是今年的第几周。 */ -export const getPrevWeekWithYear = () => { +export const getPrevWeekWithYear = (): string => { return moment().subtract(1, "weeks").format("YYYY-WW") } /** - * 秒转分钟，保留一位小数 + * 将秒数转换为分钟，保留一位小数。 + * @param {number} sec - 秒数。 + * @returns {string} 转换后的分钟数，保留一位小数。 */ -export const sec2min = (sec: number) => { +export const sec2min = (sec: number): string => { return (sec / 60).toFixed(1) } /** - * 秒转分钟，格式为 1m 30s + * 将秒数转换为分钟和秒数，格式为 Xm Ys。 + * @param {number} sec - 秒数。 + * @returns {string} 转换后的分钟和秒数，格式为 Xm Ys。 */ -export const sec2minStr = (sec: number) => { +export const sec2minStr = (sec: number): string => { const min = Math.floor(sec / 60) const s = sec % 60 return `${min}m ${s}s`