Adds support for Slack's Agents & AI Apps text streaming APIs (chat.startStream, chat.appendStream, chat.stopStream) to deliver LLM responses as a single updating message instead of separate messages per block. Changes: - New src/slack/streaming.ts with stream lifecycle helpers using the SDK's ChatStreamer (client.chatStream()) - New 'streaming' config option on SlackAccountConfig - Updated dispatch.ts to route block replies through the stream when enabled, with graceful fallback to normal delivery - Docs in docs/channels/slack.md covering setup and requirements The streaming integration works by intercepting the deliver callback in the reply dispatcher. When streaming is enabled and a thread context exists, the first text delivery starts a stream, subsequent deliveries append to it, and the stream is finalized after dispatch completes. Media payloads and error cases fall back to normal message delivery. Refs: - https://docs.slack.dev/ai/developing-ai-apps#streaming - https://docs.slack.dev/reference/methods/chat.startStream - https://docs.slack.dev/reference/methods/chat.appendStream - https://docs.slack.dev/reference/methods/chat.stopStream
347 lines
11 KiB
TypeScript
347 lines
11 KiB
TypeScript
import type { ReplyPayload } from "../../../auto-reply/types.js";
|
|
import type { SlackStreamSession } from "../../streaming.js";
|
|
import type { PreparedSlackMessage } from "./types.js";
|
|
import { resolveHumanDelayConfig } from "../../../agents/identity.js";
|
|
import { dispatchInboundMessage } from "../../../auto-reply/dispatch.js";
|
|
import { clearHistoryEntriesIfEnabled } from "../../../auto-reply/reply/history.js";
|
|
import { createReplyDispatcherWithTyping } from "../../../auto-reply/reply/reply-dispatcher.js";
|
|
import { removeAckReactionAfterReply } from "../../../channels/ack-reactions.js";
|
|
import { logAckFailure, logTypingFailure } from "../../../channels/logging.js";
|
|
import { createReplyPrefixOptions } from "../../../channels/reply-prefix.js";
|
|
import { createTypingCallbacks } from "../../../channels/typing.js";
|
|
import { resolveStorePath, updateLastRoute } from "../../../config/sessions.js";
|
|
import { danger, logVerbose, shouldLogVerbose } from "../../../globals.js";
|
|
import { removeSlackReaction } from "../../actions.js";
|
|
import { appendSlackStream, startSlackStream, stopSlackStream } from "../../streaming.js";
|
|
import { resolveSlackThreadTargets } from "../../threading.js";
|
|
import { createSlackReplyDeliveryPlan, deliverReplies } from "../replies.js";
|
|
|
|
/**
|
|
* Check whether a reply payload contains media (images, files, etc.)
|
|
* that cannot be delivered through the streaming API.
|
|
*/
|
|
function hasMedia(payload: ReplyPayload): boolean {
|
|
return Boolean(payload.mediaUrl) || (payload.mediaUrls?.length ?? 0) > 0;
|
|
}
|
|
|
|
/**
|
|
* Determine if Slack native text streaming should be used for this message.
|
|
*
|
|
* Streaming requires:
|
|
* 1. The `streaming` config option enabled on the account
|
|
* 2. A thread timestamp (streaming only works within threads)
|
|
*/
|
|
function shouldUseStreaming(params: {
|
|
streamingEnabled: boolean;
|
|
threadTs: string | undefined;
|
|
}): boolean {
|
|
if (!params.streamingEnabled) {
|
|
return false;
|
|
}
|
|
if (!params.threadTs) {
|
|
logVerbose("slack-stream: streaming disabled — no thread_ts available");
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
export async function dispatchPreparedSlackMessage(prepared: PreparedSlackMessage) {
|
|
const { ctx, account, message, route } = prepared;
|
|
const cfg = ctx.cfg;
|
|
const runtime = ctx.runtime;
|
|
|
|
if (prepared.isDirectMessage) {
|
|
const sessionCfg = cfg.session;
|
|
const storePath = resolveStorePath(sessionCfg?.store, {
|
|
agentId: route.agentId,
|
|
});
|
|
await updateLastRoute({
|
|
storePath,
|
|
sessionKey: route.mainSessionKey,
|
|
deliveryContext: {
|
|
channel: "slack",
|
|
to: `user:${message.user}`,
|
|
accountId: route.accountId,
|
|
},
|
|
ctx: prepared.ctxPayload,
|
|
});
|
|
}
|
|
|
|
const { statusThreadTs } = resolveSlackThreadTargets({
|
|
message,
|
|
replyToMode: ctx.replyToMode,
|
|
});
|
|
|
|
const messageTs = message.ts ?? message.event_ts;
|
|
const incomingThreadTs = message.thread_ts;
|
|
let didSetStatus = false;
|
|
|
|
// Shared mutable ref for "replyToMode=first". Both tool + auto-reply flows
|
|
// mark this to ensure only the first reply is threaded.
|
|
const hasRepliedRef = { value: false };
|
|
const replyPlan = createSlackReplyDeliveryPlan({
|
|
replyToMode: ctx.replyToMode,
|
|
incomingThreadTs,
|
|
messageTs,
|
|
hasRepliedRef,
|
|
});
|
|
|
|
const typingTarget = statusThreadTs ? `${message.channel}/${statusThreadTs}` : message.channel;
|
|
const typingCallbacks = createTypingCallbacks({
|
|
start: async () => {
|
|
didSetStatus = true;
|
|
await ctx.setSlackThreadStatus({
|
|
channelId: message.channel,
|
|
threadTs: statusThreadTs,
|
|
status: "is typing...",
|
|
});
|
|
},
|
|
stop: async () => {
|
|
if (!didSetStatus) {
|
|
return;
|
|
}
|
|
didSetStatus = false;
|
|
await ctx.setSlackThreadStatus({
|
|
channelId: message.channel,
|
|
threadTs: statusThreadTs,
|
|
status: "",
|
|
});
|
|
},
|
|
onStartError: (err) => {
|
|
logTypingFailure({
|
|
log: (message) => runtime.error?.(danger(message)),
|
|
channel: "slack",
|
|
action: "start",
|
|
target: typingTarget,
|
|
error: err,
|
|
});
|
|
},
|
|
onStopError: (err) => {
|
|
logTypingFailure({
|
|
log: (message) => runtime.error?.(danger(message)),
|
|
channel: "slack",
|
|
action: "stop",
|
|
target: typingTarget,
|
|
error: err,
|
|
});
|
|
},
|
|
});
|
|
|
|
const { onModelSelected, ...prefixOptions } = createReplyPrefixOptions({
|
|
cfg,
|
|
agentId: route.agentId,
|
|
channel: "slack",
|
|
accountId: route.accountId,
|
|
});
|
|
|
|
// -----------------------------------------------------------------------
|
|
// Slack native text streaming state
|
|
// -----------------------------------------------------------------------
|
|
const streamingEnabled = account.config.streaming === true;
|
|
const replyThreadTs = replyPlan.nextThreadTs();
|
|
|
|
const useStreaming = shouldUseStreaming({
|
|
streamingEnabled,
|
|
threadTs: replyThreadTs ?? incomingThreadTs ?? statusThreadTs,
|
|
});
|
|
|
|
let streamSession: SlackStreamSession | null = null;
|
|
let streamFailed = false;
|
|
|
|
/**
|
|
* Deliver a payload via Slack native text streaming when possible.
|
|
* Falls back to normal delivery for media payloads, errors, or if the
|
|
* streaming API call itself fails.
|
|
*/
|
|
const deliverWithStreaming = async (payload: ReplyPayload): Promise<void> => {
|
|
const effectiveThreadTs = replyPlan.nextThreadTs();
|
|
|
|
// Fall back to normal delivery for media, errors, or if streaming already failed
|
|
if (streamFailed || hasMedia(payload) || !payload.text?.trim()) {
|
|
await deliverReplies({
|
|
replies: [payload],
|
|
target: prepared.replyTarget,
|
|
token: ctx.botToken,
|
|
accountId: account.accountId,
|
|
runtime,
|
|
textLimit: ctx.textLimit,
|
|
replyThreadTs: effectiveThreadTs,
|
|
});
|
|
replyPlan.markSent();
|
|
return;
|
|
}
|
|
|
|
const text = payload.text.trim();
|
|
|
|
try {
|
|
if (!streamSession) {
|
|
// Determine the thread_ts for the stream (required by Slack API)
|
|
const streamThreadTs = effectiveThreadTs ?? incomingThreadTs ?? statusThreadTs;
|
|
|
|
if (!streamThreadTs) {
|
|
// No thread context — can't stream, fall back
|
|
logVerbose(
|
|
"slack-stream: no thread_ts for stream start, falling back to normal delivery",
|
|
);
|
|
streamFailed = true;
|
|
await deliverReplies({
|
|
replies: [payload],
|
|
target: prepared.replyTarget,
|
|
token: ctx.botToken,
|
|
accountId: account.accountId,
|
|
runtime,
|
|
textLimit: ctx.textLimit,
|
|
replyThreadTs: effectiveThreadTs,
|
|
});
|
|
replyPlan.markSent();
|
|
return;
|
|
}
|
|
|
|
// Start a new stream
|
|
streamSession = await startSlackStream({
|
|
client: ctx.app.client,
|
|
channel: message.channel,
|
|
threadTs: streamThreadTs,
|
|
text,
|
|
});
|
|
replyPlan.markSent();
|
|
} else {
|
|
// Append to existing stream
|
|
await appendSlackStream({
|
|
session: streamSession,
|
|
text: "\n" + text,
|
|
});
|
|
}
|
|
} catch (err) {
|
|
runtime.error?.(
|
|
danger(`slack-stream: streaming API call failed: ${String(err)}, falling back`),
|
|
);
|
|
streamFailed = true;
|
|
|
|
// Fall back to normal delivery for this payload
|
|
await deliverReplies({
|
|
replies: [payload],
|
|
target: prepared.replyTarget,
|
|
token: ctx.botToken,
|
|
accountId: account.accountId,
|
|
runtime,
|
|
textLimit: ctx.textLimit,
|
|
replyThreadTs: effectiveThreadTs,
|
|
});
|
|
replyPlan.markSent();
|
|
}
|
|
};
|
|
|
|
const { dispatcher, replyOptions, markDispatchIdle } = createReplyDispatcherWithTyping({
|
|
...prefixOptions,
|
|
humanDelay: resolveHumanDelayConfig(cfg, route.agentId),
|
|
deliver: async (payload) => {
|
|
if (useStreaming) {
|
|
await deliverWithStreaming(payload);
|
|
} else {
|
|
const effectiveThreadTs = replyPlan.nextThreadTs();
|
|
await deliverReplies({
|
|
replies: [payload],
|
|
target: prepared.replyTarget,
|
|
token: ctx.botToken,
|
|
accountId: account.accountId,
|
|
runtime,
|
|
textLimit: ctx.textLimit,
|
|
replyThreadTs: effectiveThreadTs,
|
|
});
|
|
replyPlan.markSent();
|
|
}
|
|
},
|
|
onError: (err, info) => {
|
|
runtime.error?.(danger(`slack ${info.kind} reply failed: ${String(err)}`));
|
|
typingCallbacks.onIdle?.();
|
|
},
|
|
onReplyStart: typingCallbacks.onReplyStart,
|
|
onIdle: typingCallbacks.onIdle,
|
|
});
|
|
|
|
const { queuedFinal, counts } = await dispatchInboundMessage({
|
|
ctx: prepared.ctxPayload,
|
|
cfg,
|
|
dispatcher,
|
|
replyOptions: {
|
|
...replyOptions,
|
|
skillFilter: prepared.channelConfig?.skills,
|
|
hasRepliedRef,
|
|
disableBlockStreaming:
|
|
// When native streaming is active, keep block streaming enabled so we
|
|
// get incremental block callbacks that we route through the stream.
|
|
useStreaming
|
|
? false
|
|
: typeof account.config.blockStreaming === "boolean"
|
|
? !account.config.blockStreaming
|
|
: undefined,
|
|
onModelSelected,
|
|
},
|
|
});
|
|
markDispatchIdle();
|
|
|
|
// -----------------------------------------------------------------------
|
|
// Finalize the stream if one was started
|
|
// -----------------------------------------------------------------------
|
|
if (streamSession && !streamSession.stopped) {
|
|
try {
|
|
await stopSlackStream({ session: streamSession });
|
|
} catch (err) {
|
|
runtime.error?.(danger(`slack-stream: failed to stop stream: ${String(err)}`));
|
|
}
|
|
}
|
|
|
|
const anyReplyDelivered = queuedFinal || (counts.block ?? 0) > 0 || (counts.final ?? 0) > 0;
|
|
|
|
if (!anyReplyDelivered) {
|
|
if (prepared.isRoomish) {
|
|
clearHistoryEntriesIfEnabled({
|
|
historyMap: ctx.channelHistories,
|
|
historyKey: prepared.historyKey,
|
|
limit: ctx.historyLimit,
|
|
});
|
|
}
|
|
return;
|
|
}
|
|
|
|
if (shouldLogVerbose()) {
|
|
const finalCount = counts.final;
|
|
logVerbose(
|
|
`slack: delivered ${finalCount} reply${finalCount === 1 ? "" : "ies"} to ${prepared.replyTarget}`,
|
|
);
|
|
}
|
|
|
|
removeAckReactionAfterReply({
|
|
removeAfterReply: ctx.removeAckAfterReply,
|
|
ackReactionPromise: prepared.ackReactionPromise,
|
|
ackReactionValue: prepared.ackReactionValue,
|
|
remove: () =>
|
|
removeSlackReaction(
|
|
message.channel,
|
|
prepared.ackReactionMessageTs ?? "",
|
|
prepared.ackReactionValue,
|
|
{
|
|
token: ctx.botToken,
|
|
client: ctx.app.client,
|
|
},
|
|
),
|
|
onError: (err) => {
|
|
logAckFailure({
|
|
log: logVerbose,
|
|
channel: "slack",
|
|
target: `${message.channel}/${message.ts}`,
|
|
error: err,
|
|
});
|
|
},
|
|
});
|
|
|
|
if (prepared.isRoomish) {
|
|
clearHistoryEntriesIfEnabled({
|
|
historyMap: ctx.channelHistories,
|
|
historyKey: prepared.historyKey,
|
|
limit: ctx.historyLimit,
|
|
});
|
|
}
|
|
}
|