chz-telegram-bot 0.0.50 → 0.0.52

package/entities/botInstance.ts

@@ -10,21 +10,27 @@ import { TelegramApiService } from '../services/telegramApi';
 import { IActionState } from '../types/actionState';
 import { CommandAction } from './actions/commandAction';
 import { ScheduledAction } from './actions/scheduledAction';
-import { Logger } from '../services/logger';
-import { Scheduler } from '../services/taskScheduler';
-import { IncomingMessage } from './incomingMessage';
+import { JsonLogger } from '../services/jsonLogger';
+import { IncomingMessage } from '../dtos/incomingMessage';
 import moment from 'moment';
 import { ChatContext } from './context/chatContext';
 import { MessageContext } from './context/messageContext';
+import { ChatInfo } from '../dtos/chatInfo';
+import { ILogger } from '../types/logger';
+import { IScheduler } from '../types/scheduler';
+import { NodeTimeoutScheduler } from '../services/nodeTimeoutScheduler';
 
 export class BotInstance {
-    name: string;
-    private api: TelegramApiService;
-    private telegraf: Telegraf;
-    private commands: CommandAction<IActionState>[];
-    private scheduled: ScheduledAction<IActionState>[];
-    private chats: Record<string, number>;
-    storage: IStorageClient;
+    private readonly api: TelegramApiService;
+    private readonly storage: IStorageClient;
+    private readonly scheduler: IScheduler;
+    private readonly logger: ILogger;
+
+    readonly name: string;
+    private readonly telegraf: Telegraf;
+    private readonly commands: CommandAction<IActionState>[];
+    private readonly scheduled: ScheduledAction<IActionState>[];
+    private readonly chats: Record<string, number>;
 
     constructor(options: {
         name: string;
@@ -32,10 +38,14 @@ export class BotInstance {
         commands: CommandAction<IActionState>[];
         scheduled: ScheduledAction<IActionState>[];
         chats: Record<string, number>;
-        storageClient?: IStorageClient;
         storagePath?: string;
         scheduledPeriod?: Seconds;
         verboseLoggingForIncomingMessage?: boolean;
+        services?: {
+            storageClient?: IStorageClient;
+            logger?: ILogger;
+            scheduler?: IScheduler;
+        };
     }) {
         this.name = options.name;
         this.commands = options.commands;
@@ -43,22 +53,19 @@ export class BotInstance {
         this.chats = options.chats;
 
         const actions = [...this.commands, ...this.scheduled];
-
-        Logger.logWithTraceId(
-            this.name,
-            `System:Bot-${this.name}-Start`,
-            'System',
-            'Starting bot...'
-        );
         this.telegraf = new Telegraf(options.token);
+        this.logger = options.services?.logger ?? new JsonLogger();
+        this.scheduler =
+            options.services?.scheduler ??
+            new NodeTimeoutScheduler(this.logger);
         this.storage =
-            options.storageClient ??
+            options.services?.storageClient ??
             new JsonFileStorage(options.name, actions, options.storagePath);
         this.api = new TelegramApiService(
             this.name,
             this.telegraf.telegram,
             this.storage,
-            this.chats
+            this.logger
         );
 
         this.initializeMessageProcessing(
@@ -70,6 +77,12 @@ export class BotInstance {
 
         this.storage.saveMetadata(actions, this.name);
 
+        this.logger.logWithTraceId(
+            this.name,
+            `System:Bot-${this.name}-Start`,
+            'System',
+            'Starting bot...'
+        );
         this.telegraf.launch();
     }
 
@@ -78,7 +91,7 @@ export class BotInstance {
             const now = moment();
 
             if (now.minute() == 0 && now.second() == 0) {
-                Scheduler.createTask(
+                this.scheduler.createTask(
                     'ScheduledProcessing',
                     async () => {
                         await this.runScheduled();
@@ -98,10 +111,10 @@ export class BotInstance {
 
             const delay = nextExecutionTime.diff(now);
 
-            Scheduler.createOnetimeTask(
+            this.scheduler.createOnetimeTask(
                 'ScheduledProcessing_OneTime',
                 async () => {
-                    Scheduler.createTask(
+                    this.scheduler.createTask(
                         'ScheduledProcessing',
                         async () => {
                             await this.runScheduled();
@@ -129,17 +142,17 @@ export class BotInstance {
                 const messageFromId = msg.from?.id ?? 'Unknown';
 
                 if (verboseLoggingForIncomingMessage) {
-                    Logger.logObjectWithTraceId(
+                    this.logger.logObjectWithTraceId(
                         this.name,
                         msg.traceId,
-                        msg.chatName,
+                        msg.chatInfo.name,
                         ctx.update.message
                     );
                 } else {
-                    Logger.logWithTraceId(
+                    this.logger.logWithTraceId(
                         this.name,
                         msg.traceId,
-                        msg.chatName,
+                        msg.chatInfo.name,
                         `${messageFromName} (${messageFromId}): ${messageContent}`
                     );
                 }
@@ -150,29 +163,40 @@ export class BotInstance {
     }
 
     async stop(code: string) {
-        Logger.logWithTraceId(
+        this.logger.logWithTraceId(
             this.name,
             `System:Bot-${this.name}-Stop`,
             'System',
             'Stopping bot...'
         );
 
+        this.scheduler.stopAll();
         await this.storage.close();
         this.telegraf.stop(code);
     }
 
     private async runScheduled() {
-        const ctx = new ChatContext<IActionState>();
+        const ctx = new ChatContext<IActionState>(
+            this.storage,
+            this.logger,
+            this.scheduler
+        );
 
         for (const [chatName, chatId] of Object.entries(this.chats)) {
             for (const scheduledAction of this.scheduled) {
-                this.api.initializeContextForChat(ctx, chatId, scheduledAction);
+                ctx.initializeChatContext(
+                    this.name,
+                    scheduledAction,
+                    new ChatInfo(chatId, chatName),
+                    `Scheduled:${scheduledAction.key}:${chatId}`
+                );
 
                 try {
                     const responses = await scheduledAction.exec(ctx);
                     this.api.enqueueBatchedResponses(responses);
+                    ctx.isInitialized = false;
                 } catch (error) {
-                    Logger.errorWithTraceId(
+                    this.logger.errorWithTraceId(
                         ctx.botName,
                         ctx.traceId,
                         chatName,
@@ -187,19 +211,24 @@ export class BotInstance {
     }
 
     private async processMessage(msg: IncomingMessage) {
-        const ctx = new MessageContext<IActionState>();
+        const ctx = new MessageContext<IActionState>(
+            this.storage,
+            this.logger,
+            this.scheduler
+        );
 
         for (const commandAction of this.commands) {
-            this.api.initializeContextForMessage(ctx, msg, commandAction);
+            ctx.initializeMessageContext(this.name, commandAction, msg);
 
             try {
                 const responses = await commandAction.exec(ctx);
                 this.api.enqueueBatchedResponses(responses);
+                ctx.isInitialized = false;
             } catch (error) {
-                Logger.errorWithTraceId(
+                this.logger.errorWithTraceId(
                     ctx.botName,
                     ctx.traceId,
-                    ctx.chatName,
+                    ctx.chatInfo.name,
                     error,
                     ctx
                 );

package/entities/cachedStateFactory.ts

@@ -1,8 +1,8 @@
 import { Hours } from '../types/timeValues';
 
 export class CachedStateFactory {
-    getValue: () => Promise<unknown>;
-    invalidationTimeoutInHours: Hours;
+    readonly getValue: () => Promise<unknown>;
+    readonly invalidationTimeoutInHours: Hours;
 
     constructor(
         itemFactory: () => Promise<unknown>,

package/entities/context/chatContext.ts

@@ -1,9 +1,9 @@
 import { resolve } from 'path';
 import { IStorageClient } from '../../types/storage';
-import { ImageMessage } from '../responses/imageMessage';
-import { TextMessage } from '../responses/textMessage';
-import { VideoMessage } from '../responses/videoMessage';
-import { UnpinResponse } from '../responses/unpin';
+import { ImageMessage } from '../../dtos/responses/imageMessage';
+import { TextMessage } from '../../dtos/responses/textMessage';
+import { VideoMessage } from '../../dtos/responses/videoMessage';
+import { UnpinResponse } from '../../dtos/responses/unpin';
 import {
     MessageSendingOptions,
     TextMessageSendingOptions
@@ -12,61 +12,62 @@ import { IActionWithState } from '../../types/actionWithState';
 import { IActionState } from '../../types/actionState';
 import { BotResponse } from '../../types/response';
 import { Milliseconds } from '../../types/timeValues';
-import { DelayResponse } from '../responses/delay';
+import { DelayResponse } from '../../dtos/responses/delay';
+import { ChatInfo } from '../../dtos/chatInfo';
+import { ILogger } from '../../types/logger';
+import { IScheduler } from '../../types/scheduler';
 
 /**
  * Context of action executed in chat.
  */
 export class ChatContext<TActionState extends IActionState> {
     protected action!: IActionWithState<TActionState>;
-    updateActions: Array<(state: TActionState) => void> = [];
+
+    /** Storage client instance for the bot executing this action. */
+    readonly storage!: IStorageClient;
+    /** Logger instance for the bot executing this action */
+    readonly logger!: ILogger;
+    /** Scheduler instance for the bot executing this action */
+    readonly scheduler!: IScheduler;
+
     /** Trace id of a action execution. */
     traceId!: number | string;
     /** Name of a bot that executes this action. */
     botName!: string;
-    /** Id of a chat that action is executed in. */
-    chatId!: number;
-    /** Name of a chat that action is executed in. */
-    chatName!: string;
-    /** Storage client instance for this bot. */
-    storage!: IStorageClient;
+    /** Chat information. */
+    chatInfo!: ChatInfo;
     /** Ordered collection of responses to be processed  */
     responses: BotResponse[] = [];
 
     isInitialized = false;
 
-    constructor() {}
+    constructor(
+        storage: IStorageClient,
+        logger: ILogger,
+        scheduler: IScheduler
+    ) {
+        this.storage = storage;
+        this.logger = logger;
+        this.scheduler = scheduler;
+    }
 
     initializeChatContext(
         botName: string,
         action: IActionWithState<TActionState>,
-        chatId: number,
-        chatName: string,
-        traceId: number | string,
-        storage: IStorageClient
+        chatInfo: ChatInfo,
+        traceId: number | string
     ) {
         this.botName = botName;
         this.action = action;
-        this.chatId = chatId;
-        this.chatName = chatName;
+        this.chatInfo = chatInfo;
         this.traceId = traceId;
-        this.storage = storage;
 
-        this.updateActions = [];
         this.isInitialized = true;
         this.responses = [];
 
         return this;
     }
 
-    /**
-     * Manually update the state of an action.
-     * @param stateUpdateAction Function that will modify state.
-     */
-    updateState(stateUpdateAction: (state: TActionState) => void) {
-        this.updateActions.push(stateUpdateAction);
-    }
-
     /**
      * Sends text message to chat after action execution is finished.
      * If multiple responses are sent, they will be sent in the order they were added, with delay of at least 35ms as per Telegram rate-limit.
@@ -77,7 +78,7 @@ export class ChatContext<TActionState extends IActionState> {
         this.responses.push(
             new TextMessage(
                 text,
-                this.chatId,
+                this.chatInfo,
                 undefined,
                 this.traceId,
                 this.action,
@@ -97,7 +98,7 @@ export class ChatContext<TActionState extends IActionState> {
         this.responses.push(
             new ImageMessage(
                 { source: resolve(filePath) },
-                this.chatId,
+                this.chatInfo,
                 undefined,
                 this.traceId,
                 this.action,
@@ -117,7 +118,7 @@ export class ChatContext<TActionState extends IActionState> {
         this.responses.push(
             new VideoMessage(
                 { source: resolve(filePath) },
-                this.chatId,
+                this.chatInfo,
                 undefined,
                 this.traceId,
                 this.action,
@@ -133,7 +134,12 @@ export class ChatContext<TActionState extends IActionState> {
      */
     unpinMessage(messageId: number) {
         this.responses.push(
-            new UnpinResponse(messageId, this.chatId, this.traceId, this.action)
+            new UnpinResponse(
+                messageId,
+                this.chatInfo,
+                this.traceId,
+                this.action
+            )
         );
     }
 
@@ -143,7 +149,7 @@ export class ChatContext<TActionState extends IActionState> {
      */
     delayNextResponse(delay: Milliseconds) {
         this.responses.push(
-            new DelayResponse(delay, this.chatId, this.traceId, this.action)
+            new DelayResponse(delay, this.chatInfo, this.traceId, this.action)
         );
     }
 }

package/entities/context/messageContext.ts

@@ -2,19 +2,21 @@ import { resolve } from 'path';
 import { TelegramEmoji } from 'telegraf/types';
 import { IStorageClient } from '../../types/storage';
 import { IActionState } from '../../types/actionState';
-import { ImageMessage } from '../responses/imageMessage';
-import { Reaction } from '../responses/reaction';
-import { TextMessage } from '../responses/textMessage';
-import { VideoMessage } from '../responses/videoMessage';
+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 { ActionStateBase } from '../states/actionStateBase';
 import { ChatContext } from './chatContext';
-import { IncomingMessage } from '../incomingMessage';
+import { IncomingMessage } from '../../dtos/incomingMessage';
 import {
     MessageSendingOptions,
     TextMessageSendingOptions
 } from '../../types/messageSendingOptions';
 import { IActionWithState, ActionKey } from '../../types/actionWithState';
 import { MessageTypeValue } from '../../types/messageTypes';
+import { ILogger } from '../../types/logger';
+import { IScheduler } from '../../types/scheduler';
 /**
  * Context of action executed in chat, in response to a message
  */
@@ -36,15 +38,18 @@ export class MessageContext<
     /** Type of message being received */
     messageType!: MessageTypeValue;
 
-    constructor() {
-        super();
+    constructor(
+        storage: IStorageClient,
+        logger: ILogger,
+        scheduler: IScheduler
+    ) {
+        super(storage, logger, scheduler);
     }
 
     initializeMessageContext(
         botName: string,
         action: IActionWithState<TActionState>,
-        message: IncomingMessage,
-        storage: IStorageClient
+        message: IncomingMessage
     ) {
         this.messageId = message.message_id;
         this.messageText = message.text ?? '';
@@ -60,10 +65,8 @@ export class MessageContext<
         return this.initializeChatContext(
             botName,
             action,
-            message.chat.id,
-            message.chatName,
-            message.traceId,
-            storage
+            message.chatInfo,
+            message.traceId
         );
     }
 
@@ -80,7 +83,7 @@ export class MessageContext<
             '-'
         )}` as ActionKey;
         const allStates = await this.storage.load(storageKey);
-        const stateForChat = allStates[this.chatId];
+        const stateForChat = allStates[this.chatInfo.id];
 
         if (!stateForChat) {
             return new ActionStateBase() as TAnotherActionState;
@@ -99,7 +102,7 @@ export class MessageContext<
         this.responses.push(
             new TextMessage(
                 text,
-                this.chatId,
+                this.chatInfo,
                 this.messageId,
                 this.traceId,
                 this.action,
@@ -119,7 +122,7 @@ export class MessageContext<
         this.responses.push(
             new ImageMessage(
                 { source: resolve(filePath) },
-                this.chatId,
+                this.chatInfo,
                 this.messageId,
                 this.traceId,
                 this.action,
@@ -139,7 +142,7 @@ export class MessageContext<
         this.responses.push(
             new VideoMessage(
                 { source: resolve(filePath) },
-                this.chatId,
+                this.chatInfo,
                 this.messageId,
                 this.traceId,
                 this.action,
@@ -157,7 +160,7 @@ export class MessageContext<
         this.responses.push(
             new Reaction(
                 this.traceId,
-                this.chatId,
+                this.chatInfo,
                 this.messageId,
                 emoji,
                 this.action

package/entities/taskRecord.ts

@@ -1,9 +1,9 @@
 import { Milliseconds } from '../types/timeValues';
 
 export class TaskRecord {
-    name: string;
-    taskId: NodeJS.Timeout;
-    interval: Milliseconds;
+    readonly name: string;
+    readonly taskId: NodeJS.Timeout;
+    readonly interval: Milliseconds;
 
     constructor(name: string, taskId: NodeJS.Timeout, interval: Milliseconds) {
         this.name = name;

package/helpers/noop.ts

@@ -1,9 +1,12 @@
+import { BotResponse } from '../types/response';
+
 /* eslint-disable @typescript-eslint/no-unused-vars */
 export class Noop {
-    static async true<T1>(arg1: T1) {
+    static NoResponse: BotResponse[] = [];
+    static true<T1>(arg1: T1) {
         return true;
     }
-    static async false<T1>(arg1: T1) {
+    static false<T1>(arg1: T1) {
         return false;
     }
     static async call<T1, T2>(arg1: T1, arg2: T2): Promise<void>;

package/index.ts

@@ -1,8 +1,10 @@
 export { startBot, stopBots } from './main';
 export { CommandActionBuilder } from './helpers/builders/commandActionBuilder';
 export { CommandActionBuilderWithState } from './helpers/builders/commandActionBuilder';
-export * from './helpers/builders/scheduledActionBuilder';
 export { IStorageClient } from './types/storage';
+export { ILogger } from './types/logger';
+export { IScheduler } from './types/scheduler';
+export * from './helpers/builders/scheduledActionBuilder';
 export * from './types/actionState';
 export * from './entities/states/actionStateBase';
 export { Hours, Milliseconds, Seconds } from './types/timeValues';

package/main.ts

@@ -1,19 +1,15 @@
 import { readFile } from 'fs/promises';
 import { IStorageClient } from './types/storage';
-import { Logger } from './services/logger';
 import { CommandAction } from './entities/actions/commandAction';
 import { ScheduledAction } from './entities/actions/scheduledAction';
 import { IActionState } from './types/actionState';
-import { Scheduler } from './services/taskScheduler';
 import { BotInstance } from './entities/botInstance';
 import { Seconds } from './types/timeValues';
+import { IScheduler } from './types/scheduler';
+import { ILogger } from './types/logger';
 
 const bots: BotInstance[] = [];
 
-function log(text: string) {
-    Logger.logWithTraceId('ALL BOTS', 'System:Bot', 'System', text);
-}
-
 /**
  * Starts bot
  */
@@ -28,14 +24,20 @@ async function startBot(options: {
     scheduled: ScheduledAction<IActionState>[];
     /** Object containing chat name and chat id pairs. Used for logging and execution of scheduled action. */
     chats: Record<string, number>;
-    /** Storage client for bot state storage. If not provided, default `JsonFileStorage` will be used. */
-    storageClient?: IStorageClient;
     /** Storage path for default `JsonFileStorage` client. Will be used only if `storageClient` is not provided. If not provided, default value of `./storage/` will be used.*/
     storagePath?: string;
     /** Period of time between execution of scheduled actions. */
     scheduledPeriod?: Seconds;
     /** If true, telegram API objects will be logged instead of message content. */
     verboseLoggingForIncomingMessage?: boolean;
+    services?: {
+        /** Storage client for bot state storage. If not provided, default `JsonFileStorage` will be used. */
+        storageClient?: IStorageClient;
+        /** Logger client for bot logging. If not provided, default `JsonFileStorage` will be used. */
+        logger?: ILogger;
+        /** Scheduler client for bot scheduling. If not provided, default `NodeTimeoutScheduler` will be used. */
+        scheduler?: IScheduler;
+    };
 }) {
     const token = await readFile(options.tokenFilePath, 'utf8');
     const bot = new BotInstance({
@@ -44,11 +46,15 @@ async function startBot(options: {
         commands: options.commands,
         scheduled: options.scheduled,
         chats: options.chats,
-        storageClient: options.storageClient,
         storagePath: options.storagePath,
         scheduledPeriod: options.scheduledPeriod,
         verboseLoggingForIncomingMessage:
-            options.verboseLoggingForIncomingMessage
+            options.verboseLoggingForIncomingMessage,
+        services: {
+            storageClient: options.services?.storageClient,
+            logger: options.services?.logger,
+            scheduler: options.services?.scheduler
+        }
     });
     bots.push(bot);
 
@@ -59,11 +65,6 @@ async function startBot(options: {
  * Terminates all scheduled tasks, closes storage connections and stops all bots.
  */
 async function stopBots(reason: string) {
-    log(`Recieved termination code: ${reason}`);
-    Scheduler.stopAll();
-    log('Acquiring storage semaphore...');
-
-    log('Stopping bots...');
     for (const bot of bots) {
         await bot.stop(reason);
     }

package/package.json

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

package/services/jsonFileStorage.ts

@@ -3,15 +3,14 @@ import { dirname } from 'path';
 import { mkdir, readFile, writeFile } from 'fs/promises';
 import { Sema as Semaphore } from 'async-sema';
 import { IStorageClient } from '../types/storage';
-import { ActionExecutionResult } from '../entities/actionExecutionResult';
 import { IActionState } from '../types/actionState';
 import { IActionWithState, ActionKey } from '../types/actionWithState';
 
 export class JsonFileStorage implements IStorageClient {
-    private locks = new Map<ActionKey, Semaphore>();
-    private cache: Map<string, Record<number, IActionState>>;
-    private storagePath: string;
-    private botName: string;
+    private readonly locks = new Map<ActionKey, Semaphore>();
+    private readonly cache: Map<string, Record<number, IActionState>>;
+    private readonly storagePath: string;
+    private readonly botName: string;
 
     constructor(
         botName: string,
@@ -129,15 +128,14 @@ export class JsonFileStorage implements IStorageClient {
     async saveActionExecutionResult<TActionState extends IActionState>(
         action: IActionWithState<TActionState>,
         chatId: number,
-        transactionResult: ActionExecutionResult<TActionState>
+        state: TActionState
     ) {
         await this.lock(action.key, async () => {
             const data = await this.loadInternal<TActionState>(action.key);
 
-            if (transactionResult.shouldUpdate) {
-                data[chatId] = transactionResult.data;
-                await this.save(data, action.key);
-            }
+            data[chatId] = state;
+
+            await this.save(data, action.key);
         });
     }
 

package/services/{logger.ts → jsonLogger.ts}

@@ -1,4 +1,6 @@
-class JsonLogger {
+import { ILogger } from '../types/logger';
+
+export class JsonLogger implements ILogger {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     private serializeError(error: any) {
         const plainObject: Record<string, unknown> = {};
@@ -46,5 +48,3 @@ class JsonLogger {
         );
     }
 }
-
-export const Logger = new JsonLogger();