chz-telegram-bot 0.3.7 → 0.3.8

package/dist/types/action.d.ts

@@ -1,4 +1,6 @@
+import { BaseContext } from '../entities/context/baseContext';
 import { IActionState } from './actionState';
+import { BotResponse } from './response';
 export type ActionKey = string & {
     __brand: 'actionKey';
 };
@@ -7,5 +9,6 @@ export interface IActionWithState<TActionState extends IActionState> extends IAc
 }
 export interface IAction {
     readonly key: ActionKey;
+    exec(ctx: BaseContext<IAction>): Promise<BotResponse[]>;
 }
 //# sourceMappingURL=action.d.ts.map

package/dist/types/action.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../types/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,OAAO,EAAE,WAAW,CAAA;CAAE,CAAC;AAE1D,MAAM,WAAW,gBAAgB,CAAC,YAAY,SAAS,YAAY,CAC/D,SAAQ,OAAO;IACf,QAAQ,CAAC,gBAAgB,EAAE,MAAM,YAAY,CAAC;CACjD;AAED,MAAM,WAAW,OAAO;IACpB,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;CAC3B"}
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../types/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,OAAO,EAAE,WAAW,CAAA;CAAE,CAAC;AAE1D,MAAM,WAAW,gBAAgB,CAAC,YAAY,SAAS,YAAY,CAC/D,SAAQ,OAAO;IACf,QAAQ,CAAC,gBAAgB,EAAE,MAAM,YAAY,CAAC;CACjD;AAED,MAAM,WAAW,OAAO;IACpB,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;IACxB,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;CAC3D"}

package/entities/context/baseContext.ts

@@ -0,0 +1,58 @@
+import { ChatInfo } from '../../dtos/chatInfo';
+import { IAction, IActionWithState } from '../../types/action';
+import { IActionState } from '../../types/actionState';
+import { IScopedLogger } from '../../types/logger';
+import { BotResponse } from '../../types/response';
+import { IScheduler } from '../../types/scheduler';
+import { IStorageClient } from '../../types/storage';
+import { TraceId } from '../../types/trace';
+
+export abstract class BaseContext<TAction extends IAction> {
+    isInitialized = false;
+    private _responses: BotResponse[] = [];
+
+    action!: TAction;
+
+    /** Storage client instance for the bot executing this action. */
+    readonly storage: IStorageClient;
+    /** Scheduler instance for the bot executing this action */
+    readonly scheduler: IScheduler;
+    logger!: IScopedLogger;
+    /** Trace id of a action execution. */
+    traceId!: TraceId;
+    /** Name of a bot that executes this action. */
+    botName!: string;
+    /** Chat information. */
+    chatInfo!: ChatInfo;
+
+    /** Ordered collection of responses to be processed  */
+    public get responses(): BotResponse[] {
+        return this._responses;
+    }
+    public set responses(value: BotResponse[]) {
+        this._responses = value;
+    }
+
+    constructor(storage: IStorageClient, scheduler: IScheduler) {
+        this.storage = storage;
+        this.scheduler = scheduler;
+    }
+
+    /**
+     * Loads state of another action for current chat.
+     * @param action Action to load state of.
+     * @template TAnotherActionState - Type of a state that is used by another action.
+     */
+    async loadStateOf<TAnotherActionState extends IActionState>(
+        action: IActionWithState<TAnotherActionState>
+    ) {
+        const allStates = await this.storage.load(action.key);
+        const stateForChat = allStates[this.chatInfo.id];
+
+        if (!stateForChat) {
+            return Object.freeze(action.stateConstructor());
+        }
+
+        return Object.freeze(stateForChat as TAnotherActionState);
+    }
+}

package/entities/context/chatContext.ts

@@ -10,44 +10,25 @@ import {
 } from '../../types/messageSendingOptions';
 import { IActionWithState } from '../../types/action';
 import { IActionState } from '../../types/actionState';
-import { BotResponse, IReplyResponse } from '../../types/response';
+import { IReplyResponse } from '../../types/response';
 import { Milliseconds } from '../../types/timeValues';
 import { DelayResponse } from '../../dtos/responses/delay';
-import { ChatInfo } from '../../dtos/chatInfo';
-import { IScopedLogger } from '../../types/logger';
 import { IScheduler } from '../../types/scheduler';
-import { TraceId } from '../../types/trace';
 import { ICaptureController } from '../../types/capture';
 import { CommandTrigger } from '../../types/commandTrigger';
 import { ReplyContext } from './replyContext';
+import { BaseContext } from './baseContext';
+import { ScheduledAction } from '../actions/scheduledAction';
 
 /**
  * Context of action executed in chat.
  */
-export class ChatContext<TActionState extends IActionState> {
-    action!: IActionWithState<TActionState>;
-
-    /** Storage client instance for the bot executing this action. */
-    readonly storage: IStorageClient;
-    /** Logger instance for the bot executing this action */
-    /** Scheduler instance for the bot executing this action */
-    readonly scheduler: IScheduler;
-
-    logger!: IScopedLogger;
-    /** Trace id of a action execution. */
-    traceId!: TraceId;
-    /** Name of a bot that executes this action. */
-    botName!: string;
-    /** Chat information. */
-    chatInfo!: ChatInfo;
-    /** Ordered collection of responses to be processed  */
-    responses: BotResponse[] = [];
-
-    isInitialized = false;
-
+export class ChatContext<
+    TActionState extends IActionState,
+    TAction extends IActionWithState<TActionState> = ScheduledAction<TActionState>
+> extends BaseContext<TAction> {
     constructor(storage: IStorageClient, scheduler: IScheduler) {
-        this.storage = storage;
-        this.scheduler = scheduler;
+        super(storage, scheduler);
     }
 
     protected createCaptureController(
@@ -71,24 +52,6 @@ export class ChatContext<TActionState extends IActionState> {
         };
     }
 
-    /**
-     * Loads state of another action for current chat.
-     * @param action Action to load state of.
-     * @template TAnotherActionState - Type of a state that is used by another action.
-     */
-    async loadStateOf<TAnotherActionState extends IActionState>(
-        action: IActionWithState<TAnotherActionState>
-    ) {
-        const allStates = await this.storage.load(action.key);
-        const stateForChat = allStates[this.chatInfo.id];
-
-        if (!stateForChat) {
-            return Object.freeze(action.stateConstructor());
-        }
-
-        return Object.freeze(stateForChat as TAnotherActionState);
-    }
-
     /**
      * Collection of actions that send something to chat as a standalone message.
      */

package/entities/context/inlineQueryContext.ts

@@ -1,27 +1,13 @@
 import { InlineQueryResult } from 'telegraf/types';
-import { IScopedLogger } from '../../types/logger';
 import { BotResponse } from '../../types/response';
 import { IScheduler } from '../../types/scheduler';
 import { IStorageClient } from '../../types/storage';
-import { TraceId } from '../../types/trace';
 import { InlineQueryAction } from '../actions/inlineQueryAction';
 import { InlineQueryResponse } from '../../dtos/responses/inlineQueryResponse';
+import { BaseContext } from './baseContext';
 
-export class InlineQueryContext {
-    action!: InlineQueryAction;
+export class InlineQueryContext extends BaseContext<InlineQueryAction> {
     queryResults: InlineQueryResult[] = [];
-
-    /** Storage client instance for the bot executing this action. */
-    readonly storage: IStorageClient;
-    /** Scheduler instance for the bot executing this action */
-    readonly scheduler: IScheduler;
-
-    /** Logger instance for the bot executing this action */
-    logger!: IScopedLogger;
-    /** Trace id of a action execution. */
-    traceId!: TraceId;
-    /** Name of a bot that executes this action. */
-    botName!: string;
     /**
      * Abort signal to be utilized in query handler.
      * Signal will be aborted if new query comes from the same user.
@@ -46,11 +32,8 @@ export class InlineQueryContext {
     /** Collection of Regexp match results on a message that triggered this action. Will be empty if trigger is not a Regexp. */
     matchResults: RegExpMatchArray[] = [];
 
-    isInitialized = false;
-
     constructor(storage: IStorageClient, scheduler: IScheduler) {
-        this.storage = storage;
-        this.scheduler = scheduler;
+        super(storage, scheduler);
     }
 
     /**

package/entities/context/messageContext.ts

@@ -17,13 +17,14 @@ import {
 } from '../../types/messageTypes';
 import { IScheduler } from '../../types/scheduler';
 import { ReplyInfo } from '../../dtos/replyInfo';
+import { CommandAction } from '../actions/commandAction';
 
 /**
  * Context of action executed in chat, in response to a message
  */
 export class MessageContext<
     TActionState extends IActionState
-> extends ChatContext<TActionState> {
+> extends ChatContext<TActionState, CommandAction<TActionState>> {
     /** Id of a message that triggered this action. */
     messageId!: number;
     /** Text of a message that triggered this action. */

package/entities/context/replyContext.ts

@@ -1,12 +1,10 @@
 import { TelegramEmoji } from 'telegraf/types';
-import { ChatInfo } from '../../dtos/chatInfo';
 import { ReplyInfo } from '../../dtos/replyInfo';
 import { ImageMessage } from '../../dtos/responses/imageMessage';
 import { Reaction } from '../../dtos/responses/reaction';
 import { TextMessage } from '../../dtos/responses/textMessage';
 import { VideoMessage } from '../../dtos/responses/videoMessage';
 import { IActionState } from '../../types/actionState';
-import { IScopedLogger } from '../../types/logger';
 import {
     TextMessageSendingOptions,
     MessageSendingOptions
@@ -15,32 +13,15 @@ import {
     MessageTypeValue,
     TelegrafContextMessage
 } from '../../types/messageTypes';
-import { BotResponse } from '../../types/response';
 import { IScheduler } from '../../types/scheduler';
 import { IStorageClient } from '../../types/storage';
-import { TraceId } from '../../types/trace';
 import { ReplyCaptureAction } from '../actions/replyCaptureAction';
 import { resolve } from 'path';
+import { BaseContext } from './baseContext';
 
-export class ReplyContext<TParentActionState extends IActionState> {
-    action!: ReplyCaptureAction<TParentActionState>;
-
-    /** Storage client instance for the bot executing this action. */
-    readonly storage: IStorageClient;
-    /** Scheduler instance for the bot executing this action */
-    readonly scheduler: IScheduler;
-
-    /** Trace id of a action execution. */
-    traceId!: TraceId;
-    /** Name of a bot that executes this action. */
-    botName!: string;
-    /** Logger instance for the bot executing this action */
-    logger!: IScopedLogger;
-
-    /** Ordered collection of responses to be processed  */
-    responses: BotResponse[] = [];
-    /** Chat information. */
-    chatInfo!: ChatInfo;
+export class ReplyContext<
+    TParentActionState extends IActionState
+> extends BaseContext<ReplyCaptureAction<TParentActionState>> {
     /** Collection of Regexp match results on a message that triggered this action. Will be empty if trigger is not a Regexp. */
     matchResults!: RegExpExecArray[];
     /** Id of a message that triggered this action. */
@@ -61,8 +42,7 @@ export class ReplyContext<TParentActionState extends IActionState> {
     isInitialized = false;
 
     constructor(storage: IStorageClient, scheduler: IScheduler) {
-        this.storage = storage;
-        this.scheduler = scheduler;
+        super(storage, scheduler);
     }
 
     private getQuotePart(quote: boolean | string) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "chz-telegram-bot",
-    "version": "0.3.7",
+    "version": "0.3.8",
     "type": "module",
     "dependencies": {
         "async-sema": "^3.1.1",

package/services/actionProcessors/baseProcessor.ts

@@ -0,0 +1,60 @@
+import { Telegraf } from 'telegraf';
+import { ILogger } from '../../types/logger';
+import { IScheduler } from '../../types/scheduler';
+import { IStorageClient } from '../../types/storage';
+import { TelegramApiService } from '../telegramApi';
+import { IAction } from '../../types/action';
+import { BaseContext } from '../../entities/context/baseContext';
+
+export abstract class BaseActionProcessor {
+    protected readonly storage: IStorageClient;
+    protected readonly scheduler: IScheduler;
+    protected readonly logger: ILogger;
+
+    protected readonly botName: string;
+
+    protected api!: TelegramApiService;
+    protected telegraf!: Telegraf;
+
+    constructor(
+        botName: string,
+        storage: IStorageClient,
+        scheduler: IScheduler,
+        logger: ILogger
+    ) {
+        this.storage = storage;
+        this.scheduler = scheduler;
+        this.logger = logger;
+
+        this.botName = botName;
+    }
+
+    private defaultErrorHandler<
+        TAction extends IAction,
+        TActionContext extends BaseContext<TAction>
+    >(error: Error, ctx: TActionContext) {
+        ctx.logger.errorWithTraceId(error, ctx);
+    }
+
+    initializeDependencies(api: TelegramApiService, telegraf: Telegraf) {
+        this.api = api;
+        this.telegraf = telegraf;
+    }
+
+    async executeAction<
+        TAction extends IAction,
+        TActionContext extends BaseContext<TAction>
+    >(
+        action: TAction,
+        ctx: TActionContext,
+        errorHandler?: (error: Error, ctx: TActionContext) => void
+    ) {
+        try {
+            const responses = await action.exec(ctx);
+            this.api.enqueueBatchedResponses(responses);
+            ctx.isInitialized = false;
+        } catch (error) {
+            (errorHandler ?? this.defaultErrorHandler)(error as Error, ctx);
+        }
+    }
+}

package/services/actionProcessors/commandActionProcessor.ts

@@ -4,7 +4,6 @@ import { CommandAction } from '../../entities/actions/commandAction';
 import { ReplyCaptureAction } from '../../entities/actions/replyCaptureAction';
 import { MessageContext } from '../../entities/context/messageContext';
 import { ReplyContext } from '../../entities/context/replyContext';
-import { IActionWithState } from '../../types/action';
 import { IActionState } from '../../types/actionState';
 import { ILogger } from '../../types/logger';
 import { IScheduler } from '../../types/scheduler';
@@ -18,17 +17,11 @@ import {
     MessageType
 } from '../../types/messageTypes';
 import { typeSafeObjectFromEntries } from '../../helpers/objectFromEntries';
+import { BaseActionProcessor } from './baseProcessor';
 
-export class CommandActionProcessor {
-    private readonly storage: IStorageClient;
-    private readonly scheduler: IScheduler;
-    private readonly logger: ILogger;
+export class CommandActionProcessor extends BaseActionProcessor {
+    private readonly replyCaptures: ReplyCaptureAction<IActionState>[] = [];
 
-    private readonly botName: string;
-    private readonly replyCaptures: ReplyCaptureAction<IActionState>[];
-
-    private api!: TelegramApiService;
-    private telegraf!: Telegraf;
     private commands = typeSafeObjectFromEntries(
         Object.values(MessageType).map((x) => [
             x,
@@ -42,12 +35,7 @@ export class CommandActionProcessor {
         scheduler: IScheduler,
         logger: ILogger
     ) {
-        this.storage = storage;
-        this.scheduler = scheduler;
-        this.logger = logger;
-
-        this.botName = botName;
-        this.replyCaptures = [];
+        super(botName, storage, scheduler, logger);
     }
 
     initialize(
@@ -56,8 +44,7 @@ export class CommandActionProcessor {
         commands: CommandAction<IActionState>[],
         verboseLoggingForIncomingMessage: boolean
     ) {
-        this.api = api;
-        this.telegraf = telegraf;
+        this.initializeDependencies(api, telegraf);
 
         for (const msgType of Object.values(MessageType)) {
             if (msgType == MessageType.Text) {
@@ -155,35 +142,25 @@ export class CommandActionProcessor {
 
         const commandsToCheck = new Set(this.commands[msg.type]);
         if (msg.type != MessageType.Text && msg.text != '') {
-            this.commands[MessageType.Text].map((x) => commandsToCheck.add(x));
+            this.commands[MessageType.Text].forEach((x) =>
+                commandsToCheck.add(x)
+            );
         }
 
         for (const commandAction of commandsToCheck) {
             this.initializeMessageContext(ctx, commandAction, msg);
-
-            try {
-                const responses = await commandAction.exec(ctx);
-                this.api.enqueueBatchedResponses(responses);
-                ctx.isInitialized = false;
-            } catch (error) {
-                ctx.logger.errorWithTraceId(error, ctx);
-            }
+            this.executeAction(commandAction, ctx);
         }
 
-        const replyCtx = new ReplyContext<IActionState>(
-            this.storage,
-            this.scheduler
-        );
-
-        for (const replyAction of this.replyCaptures) {
-            this.initializeReplyCaptureContext(replyCtx, replyAction, msg);
+        if (this.replyCaptures.length != 0) {
+            const replyCtx = new ReplyContext<IActionState>(
+                this.storage,
+                this.scheduler
+            );
 
-            try {
-                const responses = await replyAction.exec(replyCtx);
-                this.api.enqueueBatchedResponses(responses);
-                replyCtx.isInitialized = false;
-            } catch (error) {
-                replyCtx.logger.errorWithTraceId(error, replyCtx);
+            for (const replyAction of this.replyCaptures) {
+                this.initializeReplyCaptureContext(replyCtx, replyAction, msg);
+                this.executeAction(replyAction, replyCtx);
             }
         }
 
@@ -219,9 +196,9 @@ export class CommandActionProcessor {
         );
     }
 
-    private initializeMessageContext<TActionState extends IActionState>(
+    private initializeMessageContext(
         ctx: MessageContext<IActionState>,
-        action: IActionWithState<TActionState>,
+        action: CommandAction<IActionState>,
         message: IncomingMessage
     ) {
         ctx.messageId = message.messageId;

package/services/actionProcessors/inlineQueryActionProcessor.ts

@@ -9,16 +9,9 @@ import { IStorageClient } from '../../types/storage';
 import { Milliseconds } from '../../types/timeValues';
 import { TraceId } from '../../types/trace';
 import { TelegramApiService } from '../telegramApi';
+import { BaseActionProcessor } from './baseProcessor';
 
-export class InlineQueryActionProcessor {
-    private readonly storage: IStorageClient;
-    private readonly scheduler: IScheduler;
-    private readonly logger: ILogger;
-
-    private readonly botName: string;
-
-    private api!: TelegramApiService;
-    private telegraf!: Telegraf;
+export class InlineQueryActionProcessor extends BaseActionProcessor {
     private inlineQueries!: InlineQueryAction[];
 
     constructor(
@@ -27,11 +20,7 @@ export class InlineQueryActionProcessor {
         scheduler: IScheduler,
         logger: ILogger
     ) {
-        this.storage = storage;
-        this.scheduler = scheduler;
-        this.logger = logger;
-
-        this.botName = botName;
+        super(botName, storage, scheduler, logger);
     }
 
     initialize(
@@ -40,8 +29,7 @@ export class InlineQueryActionProcessor {
         inlineQueries: InlineQueryAction[],
         period: Milliseconds
     ) {
-        this.api = api;
-        this.telegraf = telegraf;
+        this.initializeDependencies(api, telegraf);
         this.inlineQueries = inlineQueries;
 
         let pendingInlineQueries: IncomingInlineQuery[] = [];
@@ -113,23 +101,19 @@ export class InlineQueryActionProcessor {
                                 inlineQuery.traceId
                             );
 
-                            try {
-                                const responses = await inlineQueryAction.exec(
-                                    ctx
-                                );
-                                this.api.enqueueBatchedResponses(responses);
-                                ctx.isInitialized = false;
-                            } catch (err) {
-                                const error = err as Error;
-
-                                if (error.name == 'AbortError') {
-                                    ctx.logger.logWithTraceId(
-                                        `Aborting query ${inlineQuery.queryId} (${inlineQuery.query}) successful.`
-                                    );
-                                } else {
-                                    ctx.logger.errorWithTraceId(error, ctx);
+                            this.executeAction(
+                                inlineQueryAction,
+                                ctx,
+                                (error, ctx) => {
+                                    if (error.name == 'AbortError') {
+                                        ctx.logger.logWithTraceId(
+                                            `Aborting query ${inlineQuery.queryId} (${inlineQuery.query}) successful.`
+                                        );
+                                    } else {
+                                        ctx.logger.errorWithTraceId(error, ctx);
+                                    }
                                 }
-                            }
+                            );
                         }
 
                         queriesInProcessing.delete(inlineQuery.userId);

package/services/actionProcessors/scheduledActionProcessor.ts

@@ -4,7 +4,6 @@ import { ScheduledAction } from '../../entities/actions/scheduledAction';
 import { ChatContext } from '../../entities/context/chatContext';
 import { secondsToMilliseconds } from '../../helpers/timeConvertions';
 import { createTrace } from '../../helpers/traceFactory';
-import { IActionWithState } from '../../types/action';
 import { IActionState } from '../../types/actionState';
 import { ILogger } from '../../types/logger';
 import { IScheduler } from '../../types/scheduler';
@@ -12,16 +11,11 @@ import { IStorageClient } from '../../types/storage';
 import { Seconds, Milliseconds } from '../../types/timeValues';
 import { TraceId } from '../../types/trace';
 import { TelegramApiService } from '../telegramApi';
+import { BaseActionProcessor } from './baseProcessor';
 
-export class ScheduledActionProcessor {
-    private readonly storage: IStorageClient;
-    private readonly scheduler: IScheduler;
-    private readonly logger: ILogger;
-
-    private readonly botName: string;
+export class ScheduledActionProcessor extends BaseActionProcessor {
     private readonly chats: Record<string, number>;
 
-    private api!: TelegramApiService;
     private scheduled!: ScheduledAction<IActionState>[];
 
     constructor(
@@ -31,11 +25,7 @@ export class ScheduledActionProcessor {
         scheduler: IScheduler,
         logger: ILogger
     ) {
-        this.storage = storage;
-        this.scheduler = scheduler;
-        this.logger = logger;
-
-        this.botName = botName;
+        super(botName, storage, scheduler, logger);
         this.chats = chats;
     }
 
@@ -44,7 +34,7 @@ export class ScheduledActionProcessor {
         scheduled: ScheduledAction<IActionState>[],
         period: Seconds
     ) {
-        this.api = api;
+        this.initializeDependencies(api, null!);
         this.scheduled = scheduled;
 
         if (this.scheduled.length > 0) {
@@ -106,22 +96,16 @@ export class ScheduledActionProcessor {
                     )
                 );
 
-                try {
-                    const responses = await scheduledAction.exec(ctx);
-                    this.api.enqueueBatchedResponses(responses);
-                    ctx.isInitialized = false;
-                } catch (error) {
-                    ctx.logger.errorWithTraceId(error, ctx);
-                }
+                this.executeAction(scheduledAction, ctx);
             }
         }
 
         this.api.flushResponses();
     }
 
-    private initializeChatContext<TActionState extends IActionState>(
+    private initializeChatContext(
         ctx: ChatContext<IActionState>,
-        action: IActionWithState<TActionState>,
+        action: ScheduledAction<IActionState>,
         chatInfo: ChatInfo,
         traceId: TraceId
     ) {

package/types/action.ts

@@ -1,4 +1,6 @@
+import { BaseContext } from '../entities/context/baseContext';
 import { IActionState } from './actionState';
+import { BotResponse } from './response';
 
 export type ActionKey = string & { __brand: 'actionKey' };
 
@@ -9,4 +11,5 @@ export interface IActionWithState<TActionState extends IActionState>
 
 export interface IAction {
     readonly key: ActionKey;
+    exec(ctx: BaseContext<IAction>): Promise<BotResponse[]>;
 }