mirror of
https://github.com/certd/certd.git
synced 2026-04-24 04:17:25 +08:00
perf: 通知标题优化
This commit is contained in:
@@ -10,7 +10,8 @@ import { Decorator } from "../decorator/index.js";
|
||||
import { ICnameProxyService, IEmailService, IPluginConfigService, IUrlService } from "../service/index.js";
|
||||
import { FileStore } from "./file-store.js";
|
||||
import { cloneDeep, forEach, merge } from "lodash-es";
|
||||
import { INotificationService, NotificationBody, NotificationContext, notificationRegistry } from "../notification/index.js";
|
||||
import { INotificationService } from "../notification/index.js";
|
||||
|
||||
export type SysInfo = {
|
||||
//系统标题
|
||||
title?: string;
|
||||
@@ -373,18 +374,17 @@ export class Executor {
|
||||
let subject = "";
|
||||
let content = "";
|
||||
const errorMessage = error?.message;
|
||||
const sysTitle = this.options.sysInfo?.title || "Certd";
|
||||
if (when === "start") {
|
||||
subject = `【${sysTitle}】开始执行,${this.pipeline.title}【${this.pipeline.id}】`;
|
||||
subject = `开始执行,${this.pipeline.title}【${this.pipeline.id}】`;
|
||||
content = `流水线ID:${this.pipeline.id},运行ID:${this.runtime.id}`;
|
||||
} else if (when === "success") {
|
||||
subject = `【${sysTitle}】执行成功,${this.pipeline.title}【${this.pipeline.id}】`;
|
||||
subject = `执行成功,${this.pipeline.title}【${this.pipeline.id}】`;
|
||||
content = `流水线ID:${this.pipeline.id},运行ID:${this.runtime.id}`;
|
||||
} else if (when === "turnToSuccess") {
|
||||
subject = `【${sysTitle}】执行成功(失败转成功),${this.pipeline.title}【${this.pipeline.id}】`;
|
||||
subject = `执行成功(失败转成功),${this.pipeline.title}【${this.pipeline.id}】`;
|
||||
content = `流水线ID:${this.pipeline.id},运行ID:${this.runtime.id}`;
|
||||
} else if (when === "error") {
|
||||
subject = `【${sysTitle}】执行失败,${this.pipeline.title}【${this.pipeline.id}】`;
|
||||
subject = `执行失败,${this.pipeline.title}【${this.pipeline.id}】`;
|
||||
content = `流水线ID:${this.pipeline.id},运行ID:${this.runtime.id}\n错误详情:${error.message}`;
|
||||
} else {
|
||||
return;
|
||||
@@ -407,43 +407,23 @@ export class Executor {
|
||||
}
|
||||
} else {
|
||||
try {
|
||||
//构建notification插件,发送通知
|
||||
let notifyConfig: any;
|
||||
if (notification.notificationId === 0) {
|
||||
notifyConfig = await this.options.notificationService.getDefault();
|
||||
} else {
|
||||
notifyConfig = await this.options.notificationService.getById(notification.notificationId);
|
||||
}
|
||||
if (notifyConfig == null) {
|
||||
throw new Error(`通知配置<id:${notification.notificationId}>不存在`);
|
||||
}
|
||||
|
||||
const notificationPlugin = notificationRegistry.get(notifyConfig.type);
|
||||
const notificationCls: any = notificationPlugin.target;
|
||||
const notificationSender = new notificationCls();
|
||||
const notificationCtx: NotificationContext = {
|
||||
http: utils.http,
|
||||
logger,
|
||||
utils,
|
||||
emailService: this.options.emailService,
|
||||
};
|
||||
//设置参数
|
||||
merge(notificationSender, notifyConfig.setting);
|
||||
notificationSender.setCtx(notificationCtx);
|
||||
await notificationSender.onInstance();
|
||||
const body: NotificationBody = {
|
||||
title: subject,
|
||||
content,
|
||||
userId: this.pipeline.userId,
|
||||
pipeline: this.pipeline,
|
||||
result: this.lastRuntime.pipeline.status,
|
||||
pipelineId: this.pipeline.id,
|
||||
historyId: this.runtime.id,
|
||||
errorMessage,
|
||||
url,
|
||||
};
|
||||
//发送通知
|
||||
await notificationSender.send(body);
|
||||
await this.options.notificationService.send({
|
||||
id: notification.notificationId,
|
||||
useDefault: true,
|
||||
useEmail: false,
|
||||
body: {
|
||||
title: subject,
|
||||
content,
|
||||
userId: this.pipeline.userId,
|
||||
pipeline: this.pipeline,
|
||||
result: this.lastRuntime.pipeline.status,
|
||||
pipelineId: this.pipeline.id,
|
||||
historyId: this.runtime.id,
|
||||
errorMessage,
|
||||
url,
|
||||
},
|
||||
});
|
||||
} catch (e) {
|
||||
logger.error("send notification error", e);
|
||||
}
|
||||
|
||||
@@ -48,9 +48,18 @@ export type NotificationInstanceConfig = {
|
||||
};
|
||||
};
|
||||
|
||||
export type NotificationSendReq = {
|
||||
id?: number;
|
||||
useDefault?: boolean;
|
||||
useEmail?: boolean;
|
||||
emailAddress?: string;
|
||||
logger?: ILogger;
|
||||
body: NotificationBody;
|
||||
};
|
||||
export interface INotificationService {
|
||||
getById(id: number): Promise<NotificationInstanceConfig>;
|
||||
getDefault(): Promise<NotificationInstanceConfig>;
|
||||
send(req: NotificationSendReq): Promise<void>;
|
||||
}
|
||||
|
||||
export interface INotification {
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
// src/decorator/memoryCache.decorator.ts
|
||||
import { Decorator } from "../decorator/index.js";
|
||||
import * as _ from "lodash-es";
|
||||
import { merge } from "lodash-es";
|
||||
import { notificationRegistry } from "./registry.js";
|
||||
import { BaseNotification, NotificationBody, NotificationContext, NotificationDefine, NotificationInputDefine, NotificationInstanceConfig } from "./api.js";
|
||||
import { isPlus } from "@certd/plus-core";
|
||||
|
||||
// 提供一个唯一 key
|
||||
export const NOTIFICATION_CLASS_KEY = "pipeline:notification";
|
||||
@@ -47,9 +47,7 @@ export async function newNotification(type: string, input: any, ctx: Notificatio
|
||||
|
||||
// @ts-ignore
|
||||
const plugin = new register.target();
|
||||
for (const key in input) {
|
||||
plugin[key] = input[key];
|
||||
}
|
||||
merge(plugin, input);
|
||||
if (!ctx) {
|
||||
throw new Error("ctx is required");
|
||||
}
|
||||
@@ -61,8 +59,5 @@ export async function newNotification(type: string, input: any, ctx: Notificatio
|
||||
|
||||
export async function sendNotification(opts: { config: NotificationInstanceConfig; ctx: NotificationContext; body: NotificationBody }) {
|
||||
const notification: BaseNotification = await newNotification(opts.config.type, opts.config.setting, opts.ctx);
|
||||
if (notification.define.needPlus && !isPlus()) {
|
||||
opts.body.content = `${opts.body.content}\n\n注意:此通知渠道已调整为专业版功能,后续版本将不再支持发送,请尽快修改或升级为专业版`;
|
||||
}
|
||||
await notification.doSend(opts.body);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user