WebHooker/server/lib/formatters/workflow.ts
RhenCloud a5324fb0ea
fix(formatters): localize PR buttons, cap oversized content, dedupe status logic
- PR merge/close button labels now follow the group language (actions.merge/close)
  instead of hardcoded Chinese
- clamp content to Discord embed limits (title 256, description 4096, field value
  1024, 25 fields) in formatters plus a render-layer safety net; Telegram gets a
  tag-safe 4096-char cap (capHtml closes dangling tags)
- raise commit subject truncation from 72 to 200 chars (MAX_COMMIT_SUBJECT)
- extract workflowStatus/workflowRunStatus/statusColorKey helpers shared by
  check_run/check_suite/workflow_run/workflow_job
- dedupe deployment ref/sha fields via addDeploymentRefFields
- commit_comment without a commit id uses title_plain (no dangling ???????)
- tag pushes now report 'Tag created'; zh push title includes the {ref}
- sender profile link derives from the repo's forge origin instead of github.com
- group webhook log emoji injected via emojiPrefix, removed from locale files
- dispatchEvent accepts preloaded groups (single KV read per webhook)
- webhook 401 logs distinguish 'secret not configured' from 'invalid signature'
2026-08-14 07:41:19 +08:00

190 lines
4.6 KiB
TypeScript

import type { NeutralMessage, NeutralAuthor } from "../types";
import { GITHUB_COLORS, WORKFLOW_CONCLUSION_EMOJI } from "./colors";
import {
branchLink,
cap,
commitLink,
emojiPrefix,
MAX_FIELD_VALUE,
statusColorKey,
type T,
buildMessage,
repoBaseUrl,
workflowRunStatus,
workflowStatus,
} from "./helpers";
export function formatWorkflowJob(
payload: Record<string, unknown>,
repo: string | undefined,
author: NeutralAuthor,
t: T,
showEmoji: boolean,
): NeutralMessage {
const job = payload.workflow_job as {
name?: string;
status?: string;
conclusion?: string | null;
head_branch?: string;
head_sha?: string;
html_url?: string;
workflow_name?: string;
run_id?: number;
};
const status = workflowStatus(job.status, job.conclusion ?? undefined);
const emoji = WORKFLOW_CONCLUSION_EMOJI[status] ?? "⏳";
const em = (e: string): string => emojiPrefix(e, showEmoji);
const baseUrl = repoBaseUrl(payload, repo);
const colorKey = statusColorKey("workflow_run", status);
const fields: Array<{ name: string; value: string; inline?: boolean }> = [];
fields.push({
name: t("fields.status"),
value: `${em(emoji)}${status}`,
inline: true,
});
if (job.name) {
fields.push({
name: t("fields.job"),
value: job.name,
inline: true,
});
}
if (job.workflow_name) {
fields.push({
name: t("fields.workflow"),
value: job.workflow_name,
inline: true,
});
}
if (job.head_branch) {
fields.push({
name: t("fields.branch"),
value: branchLink(baseUrl, job.head_branch),
inline: true,
});
}
if (job.head_sha) {
fields.push({
name: t("fields.commit"),
value: commitLink(baseUrl, job.head_sha),
inline: true,
});
}
return buildMessage(
{
author,
title: t("events.workflow_job.title", {
repo: repo ?? t("common.repository"),
name: job.name ?? "Job",
conclusion: status,
}),
url: job.html_url,
color: GITHUB_COLORS[colorKey],
fields,
},
t,
repo,
);
}
export function formatWorkflowRun(
payload: Record<string, unknown>,
repo: string | undefined,
author: NeutralAuthor,
t: T,
showEmoji: boolean,
): NeutralMessage {
const workflow = payload.workflow_run as {
id?: number;
name?: string;
conclusion?: string;
html_url?: string;
head_branch?: string;
run_number?: number;
created_at?: string;
updated_at?: string;
elapsed_seconds?: number;
jobs?: Array<{ name?: string; conclusion?: string }>;
};
const action = payload.action as string | undefined;
const status = workflowRunStatus(action, workflow.conclusion);
const emoji = WORKFLOW_CONCLUSION_EMOJI[status] ?? "⏳";
const em = (e: string): string => emojiPrefix(e, showEmoji);
const baseUrl = repoBaseUrl(payload, repo);
const colorKey = statusColorKey("workflow_run", status);
const fields: Array<{ name: string; value: string; inline?: boolean }> = [];
fields.push({
name: t("fields.status"),
value: `${em(emoji)}${status}`,
inline: true,
});
if (workflow.jobs?.length) {
// Many-jobs workflows must stay under the Discord field value limit.
const jobLines = workflow.jobs.map(
(j) => `${em(WORKFLOW_CONCLUSION_EMOJI[j.conclusion ?? ""] ?? "⏳")}${cap(j.name ?? "", 200)}`,
);
fields.push({
name: t("fields.job"),
value: cap(jobLines.join("\n"), MAX_FIELD_VALUE),
inline: false,
});
}
if (workflow.head_branch) {
fields.push({
name: t("fields.branch"),
value: branchLink(baseUrl, workflow.head_branch),
inline: true,
});
}
if (workflow.run_number) {
fields.push({
name: t("fields.run"),
value: `#${workflow.run_number}`,
inline: true,
});
}
if (workflow.elapsed_seconds != null) {
const mins = Math.floor(workflow.elapsed_seconds / 60);
const secs = workflow.elapsed_seconds % 60;
fields.push({
name: t("fields.duration"),
value: `${mins}m ${secs}s`,
inline: true,
});
}
const runLabel = workflow.html_url
? `[${workflow.name ?? "Workflow"}${status}](${workflow.html_url})`
: `${workflow.name ?? "Workflow"}${status}`;
return buildMessage(
{
author,
title: t("events.workflow_run.title", {
repo: repo ?? t("common.repository"),
run: runLabel,
}),
url: workflow.html_url,
color: GITHUB_COLORS[colorKey],
fields,
updateKey: repo && workflow.id != null ? `workflow_run:${repo}:${workflow.id}` : undefined,
},
t,
repo,
);
}