chz-telegram-bot 0.3.1 → 0.3.3

package/services/actionProcessors/inlineQueryActionProcessor.ts

@@ -57,10 +57,13 @@ export class InlineQueryActionProcessor {
                     createTrace('InlineQuery', this.botName, ctx.inlineQuery.id)
                 );
 
-                this.logger.logWithTraceId(
+                const logger = this.logger.createScope(
                     this.botName,
                     query.traceId,
-                    'Query',
+                    'Query'
+                );
+
+                logger.logWithTraceId(
                     `${ctx.inlineQuery.from.username} (${ctx.inlineQuery.from.id}): Query for ${ctx.inlineQuery.query}`
                 );
 
@@ -68,10 +71,7 @@ export class InlineQueryActionProcessor {
                     query.userId
                 );
                 if (queryBeingProcessed) {
-                    this.logger.logWithTraceId(
-                        this.botName,
-                        query.traceId,
-                        'Query',
+                    logger.logWithTraceId(
                         `Aborting query ${queryBeingProcessed.queryId} (${queryBeingProcessed.query}): new query recieved from ${query.userId}`
                     );
 
@@ -91,7 +91,6 @@ export class InlineQueryActionProcessor {
                 async () => {
                     const ctx = new InlineQueryContext(
                         this.storage,
-                        this.logger,
                         this.scheduler
                     );
 
@@ -124,20 +123,11 @@ export class InlineQueryActionProcessor {
                                 const error = err as Error;
 
                                 if (error.name == 'AbortError') {
-                                    this.logger.logWithTraceId(
-                                        this.botName,
-                                        inlineQuery.traceId,
-                                        'Query',
+                                    ctx.logger.logWithTraceId(
                                         `Aborting query ${inlineQuery.queryId} (${inlineQuery.query}) successful.`
                                     );
                                 } else {
-                                    this.logger.errorWithTraceId(
-                                        ctx.botName,
-                                        ctx.traceId,
-                                        'Unknown',
-                                        error,
-                                        ctx
-                                    );
+                                    ctx.logger.errorWithTraceId(error, ctx);
                                 }
                             }
                         }
@@ -172,5 +162,7 @@ export class InlineQueryActionProcessor {
         ctx.isInitialized = true;
         ctx.queryResults = [];
         ctx.matchResults = [];
+
+        ctx.logger = this.logger.createScope(this.botName, traceId, 'Unknown');
     }
 }

package/services/actionProcessors/scheduledActionProcessor.ts

@@ -91,11 +91,7 @@ export class ScheduledActionProcessor {
     }
 
     private async runScheduled() {
-        const ctx = new ChatContext<IActionState>(
-            this.storage,
-            this.logger,
-            this.scheduler
-        );
+        const ctx = new ChatContext<IActionState>(this.storage, this.scheduler);
 
         for (const [chatName, chatId] of Object.entries(this.chats)) {
             for (const scheduledAction of this.scheduled) {
@@ -115,13 +111,7 @@ export class ScheduledActionProcessor {
                     this.api.enqueueBatchedResponses(responses);
                     ctx.isInitialized = false;
                 } catch (error) {
-                    this.logger.errorWithTraceId(
-                        ctx.botName,
-                        ctx.traceId,
-                        chatName,
-                        error,
-                        ctx
-                    );
+                    ctx.logger.errorWithTraceId(error, ctx);
                 }
             }
         }
@@ -141,5 +131,11 @@ export class ScheduledActionProcessor {
         ctx.action = action;
         ctx.chatInfo = chatInfo;
         ctx.traceId = traceId;
+
+        ctx.logger = this.logger.createScope(
+            this.botName,
+            traceId,
+            chatInfo.name
+        );
     }
 }

package/services/jsonLogger.ts

@@ -1,8 +1,8 @@
-import { ILogger } from '../types/logger';
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { ILogger, IScopedLogger } from '../types/logger';
 import { TraceId } from '../types/trace';
 
 export class JsonLogger implements ILogger {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     private serializeError(error: any) {
         const plainObject: Record<string, unknown> = {};
         Object.getOwnPropertyNames(error).forEach(function (key) {
@@ -11,11 +11,27 @@ export class JsonLogger implements ILogger {
         return JSON.stringify(plainObject);
     }
 
+    createScope(botName: string, traceId: TraceId, chatName: string) {
+        return {
+            logObjectWithTraceId: (data: any) =>
+                this.logObjectWithTraceId(botName, traceId, chatName, data),
+            logWithTraceId: (text: string) =>
+                this.logWithTraceId(botName, traceId, chatName, text),
+            errorWithTraceId: <TData>(errorObj: unknown, extraData?: TData) =>
+                this.errorWithTraceId(
+                    botName,
+                    traceId,
+                    chatName,
+                    errorObj,
+                    extraData
+                )
+        } as IScopedLogger;
+    }
+
     logObjectWithTraceId(
         botName: string,
         traceId: TraceId,
         chatName: string,
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         data: any
     ) {
         data.botName = botName;
@@ -40,7 +56,7 @@ export class JsonLogger implements ILogger {
         traceId: TraceId,
         chatName: string,
         errorObj: unknown,
-        extraData?: TData | undefined
+        extraData?: TData
     ) {
         console.error(
             `{"botName":"${botName}","traceId":"${traceId}","chatName":"${chatName}","error":${this.serializeError(

package/services/telegramApi.ts

@@ -9,6 +9,9 @@ import { IActionWithState } from '../types/action';
 import { IActionState } from '../types/actionState';
 import { TraceId } from '../types/trace';
 import { ChatInfo } from '../dtos/chatInfo';
+import { TelegramError } from 'telegraf';
+
+export const TELEGRAM_ERROR_QUOTE_INVALID = 'QUOTE_TEXT_INVALID';
 
 export class TelegramApiService {
     private readonly queue = new ResponseProcessingQueue();
@@ -53,18 +56,42 @@ export class TelegramApiService {
 
             const queueItem: QueueItem = {
                 callback: async () => {
+                    const scopedLogger = this.logger.createScope(
+                        this.botName,
+                        response.traceId,
+                        'chatInfo' in response
+                            ? response.chatInfo.name
+                            : 'Unknown'
+                    );
+
                     try {
                         await this.processResponse(response);
                     } catch (error) {
-                        this.logger.errorWithTraceId(
-                            this.botName,
-                            response.traceId,
-                            'chatInfo' in response
-                                ? response.chatInfo.name
-                                : 'Unknown',
-                            error,
-                            response
-                        );
+                        if ('message' in (error as TelegramError)) {
+                            const telegramResponse = error as TelegramError;
+
+                            if (
+                                telegramResponse.message.includes(
+                                    TELEGRAM_ERROR_QUOTE_INVALID
+                                )
+                            ) {
+                                scopedLogger.logWithTraceId(
+                                    'Quote error recieved, retrying without quote'
+                                );
+                                try {
+                                    await this.processResponse(response, true);
+                                } catch (error) {
+                                    scopedLogger.errorWithTraceId(
+                                        error,
+                                        response
+                                    );
+                                }
+
+                                return;
+                            }
+                        }
+
+                        scopedLogger.errorWithTraceId(error, response);
                     }
                 },
                 priority: response.createdAt + offset
@@ -95,7 +122,7 @@ export class TelegramApiService {
         }
     }
 
-    private async processResponse(response: BotResponse) {
+    private async processResponse(response: BotResponse, ignoreQuote = false) {
         let sentMessage: Message | null = null;
 
         switch (response.kind) {
@@ -107,7 +134,9 @@ export class TelegramApiService {
                         reply_parameters: response.replyInfo
                             ? {
                                   message_id: response.replyInfo.id,
-                                  quote: response.replyInfo.quote
+                                  quote: ignoreQuote
+                                      ? undefined
+                                      : response.replyInfo.quote
                               }
                             : undefined,
                         parse_mode: 'MarkdownV2',

package/types/capture.ts

@@ -5,10 +5,17 @@ import { IActionWithState } from './action';
 
 export interface ICaptureController {
     captureReplies: <TParentActionState extends IActionState>(
+        /**
+         * Defines action trigger.
+         * If `string` or `string[]` is provided, will be triggered only on exact message match.
+         * If `RegExp` or `RegExp[]` is provided, will be triggered on successful match.
+         */
         trigger: CommandTrigger[],
+        /** Callback that will be called on trigger */
         handler: (
             replyContext: ReplyContext<TParentActionState>
         ) => Promise<void>,
+        /** Abort controller to abort capturing manually */
         abortController: AbortController
     ) => void;
 }

package/types/commandCondition.ts

@@ -2,6 +2,8 @@ import { MessageContext } from '../entities/context/messageContext';
 import { IActionState } from './actionState';
 
 export type CommandCondition<TActionState extends IActionState> = (
+    /** Context of action executed in chat, in response to a message. */
     ctx: MessageContext<TActionState>,
+    /** State of an action being executed. */
     state: TActionState
 ) => boolean;

package/types/logger.ts

@@ -1,6 +1,26 @@
 import { TraceId } from './trace';
 
+export interface IScopedLogger {
+    logObjectWithTraceId(
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        data: any
+    ): void;
+
+    logWithTraceId(text: string): void;
+
+    errorWithTraceId<TData>(
+        errorObj: unknown,
+        extraData?: TData | undefined
+    ): void;
+}
+
 export interface ILogger {
+    createScope(
+        botName: string,
+        traceId: TraceId,
+        chatName: string
+    ): IScopedLogger;
+
     logObjectWithTraceId(
         botName: string,
         traceId: TraceId,

package/types/messageTypes.ts

@@ -3,6 +3,7 @@ import { Message, Update } from 'telegraf/types';
 export const INTERNAL_MESSAGE_TYPE_PREFIX = `__msg:`;
 
 export const MessageType = {
+    Any: `${INTERNAL_MESSAGE_TYPE_PREFIX}ANY`,
     Text: `${INTERNAL_MESSAGE_TYPE_PREFIX}Text`,
     Sticker: `${INTERNAL_MESSAGE_TYPE_PREFIX}Sticker`,
     Animation: `${INTERNAL_MESSAGE_TYPE_PREFIX}Animation`,