186 lines
6.0 KiB
TypeScript
186 lines
6.0 KiB
TypeScript
import type { Bot } from "grammy";
|
|
import { createFinalizableDraftLifecycle } from "../channels/draft-stream-controls.js";
|
|
import { buildTelegramThreadParams, type TelegramThreadSpec } from "./bot/helpers.js";
|
|
|
|
const TELEGRAM_STREAM_MAX_CHARS = 4096;
|
|
const DEFAULT_THROTTLE_MS = 1000;
|
|
|
|
export type TelegramDraftStream = {
|
|
update: (text: string) => void;
|
|
flush: () => Promise<void>;
|
|
messageId: () => number | undefined;
|
|
clear: () => Promise<void>;
|
|
stop: () => Promise<void>;
|
|
/** Reset internal state so the next update creates a new message instead of editing. */
|
|
forceNewMessage: () => void;
|
|
};
|
|
|
|
type TelegramDraftPreview = {
|
|
text: string;
|
|
parseMode?: "HTML";
|
|
};
|
|
|
|
type SupersededTelegramPreview = {
|
|
messageId: number;
|
|
textSnapshot: string;
|
|
parseMode?: "HTML";
|
|
};
|
|
|
|
export function createTelegramDraftStream(params: {
|
|
api: Bot["api"];
|
|
chatId: number;
|
|
maxChars?: number;
|
|
thread?: TelegramThreadSpec | null;
|
|
replyToMessageId?: number;
|
|
throttleMs?: number;
|
|
/** Minimum chars before sending first message (debounce for push notifications) */
|
|
minInitialChars?: number;
|
|
/** Optional preview renderer (e.g. markdown -> HTML + parse mode). */
|
|
renderText?: (text: string) => TelegramDraftPreview;
|
|
/** Called when a late send resolves after forceNewMessage() switched generations. */
|
|
onSupersededPreview?: (preview: SupersededTelegramPreview) => void;
|
|
log?: (message: string) => void;
|
|
warn?: (message: string) => void;
|
|
}): TelegramDraftStream {
|
|
const maxChars = Math.min(
|
|
params.maxChars ?? TELEGRAM_STREAM_MAX_CHARS,
|
|
TELEGRAM_STREAM_MAX_CHARS,
|
|
);
|
|
const throttleMs = Math.max(250, params.throttleMs ?? DEFAULT_THROTTLE_MS);
|
|
const minInitialChars = params.minInitialChars;
|
|
const chatId = params.chatId;
|
|
const threadParams = buildTelegramThreadParams(params.thread);
|
|
const replyParams =
|
|
params.replyToMessageId != null
|
|
? { ...threadParams, reply_to_message_id: params.replyToMessageId }
|
|
: threadParams;
|
|
|
|
const streamState = { stopped: false, final: false };
|
|
let streamMessageId: number | undefined;
|
|
let lastSentText = "";
|
|
let lastSentParseMode: "HTML" | undefined;
|
|
let generation = 0;
|
|
|
|
const sendOrEditStreamMessage = async (text: string): Promise<boolean> => {
|
|
// Allow final flush even if stopped (e.g., after clear()).
|
|
if (streamState.stopped && !streamState.final) {
|
|
return false;
|
|
}
|
|
const trimmed = text.trimEnd();
|
|
if (!trimmed) {
|
|
return false;
|
|
}
|
|
const rendered = params.renderText?.(trimmed) ?? { text: trimmed };
|
|
const renderedText = rendered.text.trimEnd();
|
|
const renderedParseMode = rendered.parseMode;
|
|
if (!renderedText) {
|
|
return false;
|
|
}
|
|
if (renderedText.length > maxChars) {
|
|
// Telegram text messages/edits cap at 4096 chars.
|
|
// Stop streaming once we exceed the cap to avoid repeated API failures.
|
|
streamState.stopped = true;
|
|
params.warn?.(
|
|
`telegram stream preview stopped (text length ${renderedText.length} > ${maxChars})`,
|
|
);
|
|
return false;
|
|
}
|
|
if (renderedText === lastSentText && renderedParseMode === lastSentParseMode) {
|
|
return true;
|
|
}
|
|
const sendGeneration = generation;
|
|
|
|
// Debounce first preview send for better push notification quality.
|
|
if (typeof streamMessageId !== "number" && minInitialChars != null && !streamState.final) {
|
|
if (renderedText.length < minInitialChars) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
lastSentText = renderedText;
|
|
lastSentParseMode = renderedParseMode;
|
|
try {
|
|
if (typeof streamMessageId === "number") {
|
|
if (renderedParseMode) {
|
|
await params.api.editMessageText(chatId, streamMessageId, renderedText, {
|
|
parse_mode: renderedParseMode,
|
|
});
|
|
} else {
|
|
await params.api.editMessageText(chatId, streamMessageId, renderedText);
|
|
}
|
|
return true;
|
|
}
|
|
const sendParams = renderedParseMode
|
|
? {
|
|
...replyParams,
|
|
parse_mode: renderedParseMode,
|
|
}
|
|
: replyParams;
|
|
const sent = await params.api.sendMessage(chatId, renderedText, sendParams);
|
|
const sentMessageId = sent?.message_id;
|
|
if (typeof sentMessageId !== "number" || !Number.isFinite(sentMessageId)) {
|
|
streamState.stopped = true;
|
|
params.warn?.("telegram stream preview stopped (missing message id from sendMessage)");
|
|
return false;
|
|
}
|
|
const normalizedMessageId = Math.trunc(sentMessageId);
|
|
if (sendGeneration !== generation) {
|
|
params.onSupersededPreview?.({
|
|
messageId: normalizedMessageId,
|
|
textSnapshot: renderedText,
|
|
parseMode: renderedParseMode,
|
|
});
|
|
return true;
|
|
}
|
|
streamMessageId = normalizedMessageId;
|
|
return true;
|
|
} catch (err) {
|
|
streamState.stopped = true;
|
|
params.warn?.(
|
|
`telegram stream preview failed: ${err instanceof Error ? err.message : String(err)}`,
|
|
);
|
|
return false;
|
|
}
|
|
};
|
|
|
|
const { loop, update, stop, clear } = createFinalizableDraftLifecycle({
|
|
throttleMs,
|
|
state: streamState,
|
|
sendOrEditStreamMessage,
|
|
readMessageId: () => streamMessageId,
|
|
clearMessageId: () => {
|
|
streamMessageId = undefined;
|
|
},
|
|
isValidMessageId: (value): value is number =>
|
|
typeof value === "number" && Number.isFinite(value),
|
|
deleteMessage: async (messageId) => {
|
|
await params.api.deleteMessage(chatId, messageId);
|
|
},
|
|
onDeleteSuccess: (messageId) => {
|
|
params.log?.(`telegram stream preview deleted (chat=${chatId}, message=${messageId})`);
|
|
},
|
|
warn: params.warn,
|
|
warnPrefix: "telegram stream preview cleanup failed",
|
|
});
|
|
|
|
const forceNewMessage = () => {
|
|
generation += 1;
|
|
streamMessageId = undefined;
|
|
lastSentText = "";
|
|
lastSentParseMode = undefined;
|
|
loop.resetPending();
|
|
loop.resetThrottleWindow();
|
|
};
|
|
|
|
params.log?.(`telegram stream preview ready (maxChars=${maxChars}, throttleMs=${throttleMs})`);
|
|
|
|
return {
|
|
update,
|
|
flush: loop.flush,
|
|
messageId: () => streamMessageId,
|
|
clear,
|
|
stop,
|
|
forceNewMessage,
|
|
};
|
|
}
|