File size: 11,687 Bytes
fc93158 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 | import { type Block, type KnownBlock, type WebClient } from "@slack/web-api";
import {
chunkMarkdownTextWithMode,
resolveChunkMode,
resolveTextChunkLimit,
} from "../auto-reply/chunk.js";
import { isSilentReplyText } from "../auto-reply/tokens.js";
import { loadConfig, type OpenClawConfig } from "../config/config.js";
import { resolveMarkdownTableMode } from "../config/markdown-tables.js";
import { logVerbose } from "../globals.js";
import {
fetchWithSsrFGuard,
withTrustedEnvProxyGuardedFetchMode,
} from "../infra/net/fetch-guard.js";
import { loadWebMedia } from "../web/media.js";
import type { SlackTokenSource } from "./accounts.js";
import { resolveSlackAccount } from "./accounts.js";
import { buildSlackBlocksFallbackText } from "./blocks-fallback.js";
import { validateSlackBlocksArray } from "./blocks-input.js";
import { createSlackWebClient } from "./client.js";
import { markdownToSlackMrkdwnChunks } from "./format.js";
import { parseSlackTarget } from "./targets.js";
import { resolveSlackBotToken } from "./token.js";
const SLACK_TEXT_LIMIT = 4000;
const SLACK_UPLOAD_SSRF_POLICY = {
allowedHostnames: ["*.slack.com", "*.slack-edge.com", "*.slack-files.com"],
allowRfc2544BenchmarkRange: true,
};
type SlackRecipient =
| {
kind: "user";
id: string;
}
| {
kind: "channel";
id: string;
};
export type SlackSendIdentity = {
username?: string;
iconUrl?: string;
iconEmoji?: string;
};
type SlackSendOpts = {
cfg?: OpenClawConfig;
token?: string;
accountId?: string;
mediaUrl?: string;
mediaLocalRoots?: readonly string[];
client?: WebClient;
threadTs?: string;
identity?: SlackSendIdentity;
blocks?: (Block | KnownBlock)[];
};
function hasCustomIdentity(identity?: SlackSendIdentity): boolean {
return Boolean(identity?.username || identity?.iconUrl || identity?.iconEmoji);
}
function isSlackCustomizeScopeError(err: unknown): boolean {
if (!(err instanceof Error)) {
return false;
}
const maybeData = err as Error & {
data?: {
error?: string;
needed?: string;
response_metadata?: { scopes?: string[]; acceptedScopes?: string[] };
};
};
const code = maybeData.data?.error?.toLowerCase();
if (code !== "missing_scope") {
return false;
}
const needed = maybeData.data?.needed?.toLowerCase();
if (needed?.includes("chat:write.customize")) {
return true;
}
const scopes = [
...(maybeData.data?.response_metadata?.scopes ?? []),
...(maybeData.data?.response_metadata?.acceptedScopes ?? []),
].map((scope) => scope.toLowerCase());
return scopes.includes("chat:write.customize");
}
async function postSlackMessageBestEffort(params: {
client: WebClient;
channelId: string;
text: string;
threadTs?: string;
identity?: SlackSendIdentity;
blocks?: (Block | KnownBlock)[];
}) {
const basePayload = {
channel: params.channelId,
text: params.text,
thread_ts: params.threadTs,
...(params.blocks?.length ? { blocks: params.blocks } : {}),
};
try {
// Slack Web API types model icon_url and icon_emoji as mutually exclusive.
// Build payloads in explicit branches so TS and runtime stay aligned.
if (params.identity?.iconUrl) {
return await params.client.chat.postMessage({
...basePayload,
...(params.identity.username ? { username: params.identity.username } : {}),
icon_url: params.identity.iconUrl,
});
}
if (params.identity?.iconEmoji) {
return await params.client.chat.postMessage({
...basePayload,
...(params.identity.username ? { username: params.identity.username } : {}),
icon_emoji: params.identity.iconEmoji,
});
}
return await params.client.chat.postMessage({
...basePayload,
...(params.identity?.username ? { username: params.identity.username } : {}),
});
} catch (err) {
if (!hasCustomIdentity(params.identity) || !isSlackCustomizeScopeError(err)) {
throw err;
}
logVerbose("slack send: missing chat:write.customize, retrying without custom identity");
return params.client.chat.postMessage(basePayload);
}
}
export type SlackSendResult = {
messageId: string;
channelId: string;
};
function resolveToken(params: {
explicit?: string;
accountId: string;
fallbackToken?: string;
fallbackSource?: SlackTokenSource;
}) {
const explicit = resolveSlackBotToken(params.explicit);
if (explicit) {
return explicit;
}
const fallback = resolveSlackBotToken(params.fallbackToken);
if (!fallback) {
logVerbose(
`slack send: missing bot token for account=${params.accountId} explicit=${Boolean(
params.explicit,
)} source=${params.fallbackSource ?? "unknown"}`,
);
throw new Error(
`Slack bot token missing for account "${params.accountId}" (set channels.slack.accounts.${params.accountId}.botToken or SLACK_BOT_TOKEN for default).`,
);
}
return fallback;
}
function parseRecipient(raw: string): SlackRecipient {
const target = parseSlackTarget(raw);
if (!target) {
throw new Error("Recipient is required for Slack sends");
}
return { kind: target.kind, id: target.id };
}
async function resolveChannelId(
client: WebClient,
recipient: SlackRecipient,
): Promise<{ channelId: string; isDm?: boolean }> {
// Bare Slack user IDs (U-prefix) may arrive with kind="channel" when the
// target string had no explicit prefix (parseSlackTarget defaults bare IDs
// to "channel"). chat.postMessage tolerates user IDs directly, but
// files.uploadV2 → completeUploadExternal validates channel_id against
// ^[CGDZ][A-Z0-9]{8,}$ and rejects U-prefixed IDs. Always resolve user
// IDs via conversations.open to obtain the DM channel ID.
const isUserId = recipient.kind === "user" || /^U[A-Z0-9]+$/i.test(recipient.id);
if (!isUserId) {
return { channelId: recipient.id };
}
const response = await client.conversations.open({ users: recipient.id });
const channelId = response.channel?.id;
if (!channelId) {
throw new Error("Failed to open Slack DM channel");
}
return { channelId, isDm: true };
}
async function uploadSlackFile(params: {
client: WebClient;
channelId: string;
mediaUrl: string;
mediaLocalRoots?: readonly string[];
caption?: string;
threadTs?: string;
maxBytes?: number;
}): Promise<string> {
const { buffer, contentType, fileName } = await loadWebMedia(params.mediaUrl, {
maxBytes: params.maxBytes,
localRoots: params.mediaLocalRoots,
});
// Use the 3-step upload flow (getUploadURLExternal -> POST -> completeUploadExternal)
// instead of files.uploadV2 which relies on the deprecated files.upload endpoint
// and can fail with missing_scope even when files:write is granted.
const uploadUrlResp = await params.client.files.getUploadURLExternal({
filename: fileName ?? "upload",
length: buffer.length,
});
if (!uploadUrlResp.ok || !uploadUrlResp.upload_url || !uploadUrlResp.file_id) {
throw new Error(`Failed to get upload URL: ${uploadUrlResp.error ?? "unknown error"}`);
}
// Upload the file content to the presigned URL
const uploadBody = new Uint8Array(buffer) as BodyInit;
const { response: uploadResp, release } = await fetchWithSsrFGuard(
withTrustedEnvProxyGuardedFetchMode({
url: uploadUrlResp.upload_url,
init: {
method: "POST",
...(contentType ? { headers: { "Content-Type": contentType } } : {}),
body: uploadBody,
},
policy: SLACK_UPLOAD_SSRF_POLICY,
auditContext: "slack-upload-file",
}),
);
try {
if (!uploadResp.ok) {
throw new Error(`Failed to upload file: HTTP ${uploadResp.status}`);
}
} finally {
await release();
}
// Complete the upload and share to channel/thread
const completeResp = await params.client.files.completeUploadExternal({
files: [{ id: uploadUrlResp.file_id, title: fileName ?? "upload" }],
channel_id: params.channelId,
...(params.caption ? { initial_comment: params.caption } : {}),
...(params.threadTs ? { thread_ts: params.threadTs } : {}),
});
if (!completeResp.ok) {
throw new Error(`Failed to complete upload: ${completeResp.error ?? "unknown error"}`);
}
return uploadUrlResp.file_id;
}
export async function sendMessageSlack(
to: string,
message: string,
opts: SlackSendOpts = {},
): Promise<SlackSendResult> {
const trimmedMessage = message?.trim() ?? "";
if (isSilentReplyText(trimmedMessage) && !opts.mediaUrl && !opts.blocks) {
logVerbose("slack send: suppressed NO_REPLY token before API call");
return { messageId: "suppressed", channelId: "" };
}
const blocks = opts.blocks == null ? undefined : validateSlackBlocksArray(opts.blocks);
if (!trimmedMessage && !opts.mediaUrl && !blocks) {
throw new Error("Slack send requires text, blocks, or media");
}
const cfg = opts.cfg ?? loadConfig();
const account = resolveSlackAccount({
cfg,
accountId: opts.accountId,
});
const token = resolveToken({
explicit: opts.token,
accountId: account.accountId,
fallbackToken: account.botToken,
fallbackSource: account.botTokenSource,
});
const client = opts.client ?? createSlackWebClient(token);
const recipient = parseRecipient(to);
const { channelId } = await resolveChannelId(client, recipient);
if (blocks) {
if (opts.mediaUrl) {
throw new Error("Slack send does not support blocks with mediaUrl");
}
const fallbackText = trimmedMessage || buildSlackBlocksFallbackText(blocks);
const response = await postSlackMessageBestEffort({
client,
channelId,
text: fallbackText,
threadTs: opts.threadTs,
identity: opts.identity,
blocks,
});
return {
messageId: response.ts ?? "unknown",
channelId,
};
}
const textLimit = resolveTextChunkLimit(cfg, "slack", account.accountId);
const chunkLimit = Math.min(textLimit, SLACK_TEXT_LIMIT);
const tableMode = resolveMarkdownTableMode({
cfg,
channel: "slack",
accountId: account.accountId,
});
const chunkMode = resolveChunkMode(cfg, "slack", account.accountId);
const markdownChunks =
chunkMode === "newline"
? chunkMarkdownTextWithMode(trimmedMessage, chunkLimit, chunkMode)
: [trimmedMessage];
const chunks = markdownChunks.flatMap((markdown) =>
markdownToSlackMrkdwnChunks(markdown, chunkLimit, { tableMode }),
);
if (!chunks.length && trimmedMessage) {
chunks.push(trimmedMessage);
}
const mediaMaxBytes =
typeof account.config.mediaMaxMb === "number"
? account.config.mediaMaxMb * 1024 * 1024
: undefined;
let lastMessageId = "";
if (opts.mediaUrl) {
const [firstChunk, ...rest] = chunks;
lastMessageId = await uploadSlackFile({
client,
channelId,
mediaUrl: opts.mediaUrl,
mediaLocalRoots: opts.mediaLocalRoots,
caption: firstChunk,
threadTs: opts.threadTs,
maxBytes: mediaMaxBytes,
});
for (const chunk of rest) {
const response = await postSlackMessageBestEffort({
client,
channelId,
text: chunk,
threadTs: opts.threadTs,
identity: opts.identity,
});
lastMessageId = response.ts ?? lastMessageId;
}
} else {
for (const chunk of chunks.length ? chunks : [""]) {
const response = await postSlackMessageBestEffort({
client,
channelId,
text: chunk,
threadTs: opts.threadTs,
identity: opts.identity,
});
lastMessageId = response.ts ?? lastMessageId;
}
}
return {
messageId: lastMessageId || "unknown",
channelId,
};
}
|