chz-telegram-bot 0.3.9 → 0.3.11

package/services/actionProcessors/inlineQueryActionProcessor.ts

@@ -3,9 +3,6 @@ import { IncomingInlineQuery } from '../../dtos/incomingQuery';
 import { InlineQueryAction } from '../../entities/actions/inlineQueryAction';
 import { InlineQueryContext } from '../../entities/context/inlineQueryContext';
 import { createTrace } from '../../helpers/traceFactory';
-import { ILogger } from '../../types/logger';
-import { IScheduler } from '../../types/scheduler';
-import { IStorageClient } from '../../types/storage';
 import { Milliseconds } from '../../types/timeValues';
 import { TraceId } from '../../types/trace';
 import { TelegramApiService } from '../telegramApi';
@@ -14,22 +11,13 @@ import { BaseActionProcessor } from './baseProcessor';
 export class InlineQueryActionProcessor extends BaseActionProcessor {
     private inlineQueries!: InlineQueryAction[];
 
-    constructor(
-        botName: string,
-        storage: IStorageClient,
-        scheduler: IScheduler,
-        logger: ILogger
-    ) {
-        super(botName, storage, scheduler, logger);
-    }
-
     initialize(
         api: TelegramApiService,
         telegraf: Telegraf,
         inlineQueries: InlineQueryAction[],
         period: Milliseconds
     ) {
-        this.initializeDependencies(api, telegraf);
+        this.initializeDependencies(api);
         this.inlineQueries = inlineQueries;
 
         let pendingInlineQueries: IncomingInlineQuery[] = [];
@@ -37,7 +25,7 @@ export class InlineQueryActionProcessor extends BaseActionProcessor {
         const queriesInProcessing = new Map<number, IncomingInlineQuery>();
 
         if (this.inlineQueries.length > 0) {
-            this.telegraf.on('inline_query', async (ctx) => {
+            telegraf.on('inline_query', (ctx) => {
                 const query = new IncomingInlineQuery(
                     ctx.inlineQuery.id,
                     ctx.inlineQuery.query,
@@ -52,7 +40,9 @@ export class InlineQueryActionProcessor extends BaseActionProcessor {
                 );
 
                 logger.logWithTraceId(
-                    `${ctx.inlineQuery.from.username} (${ctx.inlineQuery.from.id}): Query for ${ctx.inlineQuery.query}`
+                    `${ctx.inlineQuery.from.username ?? 'Unknown'} (${
+                        ctx.inlineQuery.from.id
+                    }): Query for ${ctx.inlineQuery.query}`
                 );
 
                 const queryBeingProcessed = queriesInProcessing.get(
@@ -101,7 +91,7 @@ export class InlineQueryActionProcessor extends BaseActionProcessor {
                                 inlineQuery.traceId
                             );
 
-                            this.executeAction(
+                            await this.executeAction(
                                 inlineQueryAction,
                                 ctx,
                                 (error, ctx) => {

package/services/actionProcessors/scheduledActionProcessor.ts

@@ -34,7 +34,7 @@ export class ScheduledActionProcessor extends BaseActionProcessor {
         scheduled: ScheduledAction<IActionState>[],
         period: Seconds
     ) {
-        this.initializeDependencies(api, null!);
+        this.initializeDependencies(api);
         this.scheduled = scheduled;
 
         if (this.scheduled.length > 0) {
@@ -63,11 +63,11 @@ export class ScheduledActionProcessor extends BaseActionProcessor {
 
             this.scheduler.createOnetimeTask(
                 'ScheduledProcessing_OneTime',
-                async () => {
+                () => {
                     this.scheduler.createTask(
                         'ScheduledProcessing',
-                        async () => {
-                            await this.runScheduled();
+                        () => {
+                            void this.runScheduled();
                         },
                         secondsToMilliseconds(period),
                         true,
@@ -96,7 +96,7 @@ export class ScheduledActionProcessor extends BaseActionProcessor {
                     )
                 );
 
-                this.executeAction(scheduledAction, ctx);
+                await this.executeAction(scheduledAction, ctx);
             }
         }
 

package/services/jsonFileStorage.ts

@@ -4,6 +4,7 @@ import { Sema as Semaphore } from 'async-sema';
 import { IStorageClient } from '../types/storage';
 import { IActionState } from '../types/actionState';
 import { IActionWithState, ActionKey } from '../types/action';
+import { getOrSetIfNotExists } from '../helpers/mapUtils';
 
 function buildPath(storagePath: string, botName: string, actionKey: string) {
     return `${storagePath}/${botName}/${actionKey.replaceAll(':', '/')}.json`;
@@ -40,10 +41,21 @@ export class JsonFileStorage implements IStorageClient {
         }
     }
 
-    private async lock<TType>(key: ActionKey, action: () => Promise<TType>) {
-        if (!this.locks.has(key)) this.locks.set(key, new Semaphore(1));
+    private backfillEmptyActionStates<TActionState extends IActionState>(
+        action: IActionWithState<TActionState>,
+        data: Record<number, TActionState | undefined>
+    ): data is Record<number, TActionState> {
+        for (const [stringKey, value] of Object.entries(data)) {
+            if (value) continue;
+
+            data[parseInt(stringKey)] = action.stateConstructor();
+        }
 
-        const lock = this.locks.get(key)!;
+        return true;
+    }
+
+    private async lock<TType>(key: ActionKey, action: () => Promise<TType>) {
+        const lock = getOrSetIfNotExists(this.locks, key, new Semaphore(1));
 
         await lock.acquire();
 
@@ -61,12 +73,11 @@ export class JsonFileStorage implements IStorageClient {
     private async loadFromFile<TActionState extends IActionState>(
         key: ActionKey
     ) {
-        if (!this.filePaths.has(key))
-            this.filePaths.set(
-                key,
-                buildPath(this.storagePath, this.botName, key)
-            );
-        const targetPath = this.filePaths.get(key)!;
+        const targetPath = getOrSetIfNotExists(
+            this.filePaths,
+            key,
+            buildPath(this.storagePath, this.botName, key)
+        );
 
         const fileContent = await readFile(targetPath, {
             encoding: 'utf-8',
@@ -74,12 +85,18 @@ export class JsonFileStorage implements IStorageClient {
         });
 
         if (fileContent) {
-            const data = JSON.parse(fileContent);
+            const data = JSON.parse(fileContent) as Record<
+                number,
+                TActionState
+            >;
 
             this.cache.set(key, data);
         }
 
-        return (this.cache.get(key) ?? {}) as Record<number, TActionState>;
+        return (this.cache.get(key) ?? {}) as Record<
+            number,
+            TActionState | undefined
+        >;
     }
 
     private async updateCacheAndSaveToFile<TActionState extends IActionState>(
@@ -88,12 +105,11 @@ export class JsonFileStorage implements IStorageClient {
     ) {
         this.cache.set(key, data);
 
-        if (!this.filePaths.has(key))
-            this.filePaths.set(
-                key,
-                buildPath(this.storagePath, this.botName, key)
-            );
-        const targetPath = this.filePaths.get(key)!;
+        const targetPath = getOrSetIfNotExists(
+            this.filePaths,
+            key,
+            buildPath(this.storagePath, this.botName, key)
+        );
 
         await writeFile(targetPath, JSON.stringify(data), { flag: 'w+' });
     }
@@ -133,14 +149,15 @@ export class JsonFileStorage implements IStorageClient {
         chatId: number,
         state: TActionState
     ) {
-        return await this.lock(action.key, async () => {
+        await this.lock(action.key, async () => {
             const data =
                 this.tryGetFromCache<TActionState>(action.key) ??
                 (await this.loadFromFile<TActionState>(action.key));
 
             data[chatId] = state;
 
-            await this.updateCacheAndSaveToFile(data, action.key);
+            if (this.backfillEmptyActionStates(action, data))
+                await this.updateCacheAndSaveToFile(data, action.key);
         });
     }
 
@@ -153,7 +170,7 @@ export class JsonFileStorage implements IStorageClient {
     async updateStateFor<TActionState extends IActionState>(
         action: IActionWithState<TActionState>,
         chatId: number,
-        update: (state: TActionState) => Promise<void>
+        update: (state: TActionState) => Promise<void> | void
     ) {
         await this.lock(action.key, async () => {
             const data =
@@ -167,7 +184,8 @@ export class JsonFileStorage implements IStorageClient {
 
             await update(state);
 
-            await this.updateCacheAndSaveToFile(data, action.key);
+            if (this.backfillEmptyActionStates(action, data))
+                await this.updateCacheAndSaveToFile(data, action.key);
         });
     }
 }

package/services/jsonLogger.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { ILogger, IScopedLogger } from '../types/logger';
 import { TraceId } from '../types/trace';
@@ -13,18 +14,21 @@ export class JsonLogger implements ILogger {
 
     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) =>
+            logObjectWithTraceId: (data: any) => {
+                this.logObjectWithTraceId(botName, traceId, chatName, data);
+            },
+            logWithTraceId: (text: string) => {
+                this.logWithTraceId(botName, traceId, chatName, text);
+            },
+            errorWithTraceId: (errorObj: unknown, extraData?: unknown) => {
                 this.errorWithTraceId(
                     botName,
                     traceId,
                     chatName,
                     errorObj,
                     extraData
-                )
+                );
+            }
         } as IScopedLogger;
     }
 
@@ -51,12 +55,12 @@ export class JsonLogger implements ILogger {
         );
     }
 
-    errorWithTraceId<TData>(
+    errorWithTraceId(
         botName: string,
         traceId: TraceId,
         chatName: string,
         errorObj: unknown,
-        extraData?: TData
+        extraData?: unknown
     ) {
         console.error(
             `{"botName":"${botName}","traceId":"${traceId}","chatName":"${chatName}","error":${this.serializeError(

package/services/nodeTimeoutScheduler.ts

@@ -20,7 +20,7 @@ export class NodeTimeoutScheduler implements IScheduler {
 
     createTask(
         name: string,
-        action: () => void,
+        action: () => unknown,
         interval: Milliseconds,
         executeRightAway: boolean,
         ownerName: string
@@ -36,7 +36,7 @@ export class NodeTimeoutScheduler implements IScheduler {
             ownerName,
             createTrace(this, ownerName, name),
             'System',
-            `Created task [${taskId}]${name}, that will run every ${interval}ms.`
+            `Created task ${name}, that will run every ${interval}ms.`
         );
 
         this.activeTasks.push(task);
@@ -44,7 +44,7 @@ export class NodeTimeoutScheduler implements IScheduler {
 
     createOnetimeTask(
         name: string,
-        action: () => void,
+        action: () => unknown,
         delay: Milliseconds,
         ownerName: string
     ) {
@@ -53,17 +53,17 @@ export class NodeTimeoutScheduler implements IScheduler {
                 ownerName,
                 createTrace(this, ownerName, name),
                 'System',
-                `Executing delayed oneshot [${taskId}]${name}`
+                `Executing delayed oneshot ${name}`
             );
             action();
         };
-        const taskId = setTimeout(actionWrapper, delay);
+        setTimeout(actionWrapper, delay);
 
         this.logger.logWithTraceId(
             ownerName,
             createTrace(this, ownerName, name),
             'System',
-            `Created oneshot task [${taskId}]${name}, that will run in ${delay}ms.`
+            `Created oneshot task ${name}, that will run in ${delay}ms.`
         );
     }
 }

package/services/responseProcessingQueue.ts

@@ -1,21 +1,26 @@
-import { setTimeout } from 'timers/promises';
 import { Milliseconds } from '../types/timeValues';
+import { RateLimit } from 'async-sema';
 
 export type QueueItem = {
     priority: number;
     callback: () => Promise<void>;
 };
 
+function notEmpty<T>(arr: T[]): arr is [T, ...T[]] {
+    return arr.length > 0;
+}
+
 const TELEGRAM_RATELIMIT_DELAY = 35 as Milliseconds;
 
 export class ResponseProcessingQueue {
+    rateLimiter = RateLimit(1, { timeUnit: TELEGRAM_RATELIMIT_DELAY });
     items: QueueItem[] = [];
     isFlushing = false;
 
     enqueue(item: QueueItem) {
         if (
             this.items.length === 0 ||
-            item.priority >= this.items[this.items.length - 1]!.priority
+            item.priority >= this.items[this.items.length - 1].priority
         ) {
             this.items.push(item);
             return;
@@ -24,7 +29,7 @@ export class ResponseProcessingQueue {
         let insertIndex = this.items.length;
         while (
             insertIndex > 0 &&
-            this.items[insertIndex - 1]!.priority > item.priority
+            this.items[insertIndex - 1].priority > item.priority
         ) {
             insertIndex--;
         }
@@ -36,13 +41,14 @@ export class ResponseProcessingQueue {
 
         this.isFlushing = true;
 
-        while (this.items.length) {
+        while (notEmpty(this.items)) {
             if (Date.now() >= this.items[0].priority) {
-                const item = this.items.shift()!;
+                await this.rateLimiter();
+
+                const [item] = this.items;
+                this.items.shift();
 
                 await item.callback();
-            } else {
-                await setTimeout(TELEGRAM_RATELIMIT_DELAY);
             }
         }
 

package/services/telegramApi.ts

@@ -101,7 +101,7 @@ export class TelegramApiService {
     }
 
     flushResponses() {
-        this.queue.flushReadyItems();
+        void this.queue.flushReadyItems();
     }
 
     private async pinIfShould(response: IReplyResponse, sentMessage: Message) {
@@ -115,7 +115,7 @@ export class TelegramApiService {
             await this.storage.updateStateFor(
                 response.action as IActionWithState<IActionState>,
                 response.chatInfo.id,
-                async (state) => {
+                (state) => {
                     state.pinnedMessages.push(sentMessage.message_id);
                 }
             );
@@ -150,9 +150,10 @@ export class TelegramApiService {
                 sentMessage = await this.telegram.sendPhoto(
                     response.chatInfo.id,
                     response.content,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                     response.replyInfo?.id
                         ? ({
-                              reply_to_message_id: response.replyInfo?.id // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                              reply_to_message_id: response.replyInfo.id // eslint-disable-next-line @typescript-eslint/no-explicit-any
                           } as any)
                         : undefined
                 );
@@ -161,9 +162,10 @@ export class TelegramApiService {
                 sentMessage = await this.telegram.sendVideo(
                     response.chatInfo.id,
                     response.content,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                     response.replyInfo?.id
                         ? ({
-                              reply_to_message_id: response.replyInfo?.id // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                              reply_to_message_id: response.replyInfo.id // eslint-disable-next-line @typescript-eslint/no-explicit-any
                           } as any)
                         : undefined
                 );
@@ -191,7 +193,7 @@ export class TelegramApiService {
                 await this.storage.updateStateFor(
                     response.action,
                     response.chatInfo.id,
-                    async (state) => {
+                    (state) => {
                         state.pinnedMessages = state.pinnedMessages.filter(
                             (x) => x != response.messageId
                         );

package/tsconfig.json

@@ -11,7 +11,7 @@
         // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 
         /* Language and Environment */
-        "target": "es2020" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+        "target": "es2024" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
         "lib": [
             "es2021",
             "DOM",

package/types/commandTrigger.ts

@@ -1,3 +1 @@
-import { MessageTypeValue } from './messageTypes';
-
-export type CommandTrigger = MessageTypeValue | string | RegExp;
+export type CommandTrigger = string | RegExp;

package/types/handlers.ts

@@ -14,7 +14,7 @@ export type CommandHandler<TActionState extends IActionState> = (
     ctx: MessageContext<TActionState>,
     /** State of an action being executed. */
     state: TActionState
-) => Promise<void>;
+) => Promise<void> | void;
 
 export type ScheduledHandler<TActionState extends IActionState> = (
     /** Context of action executed in chat. */

package/types/logger.ts

@@ -8,10 +8,7 @@ export interface IScopedLogger {
 
     logWithTraceId(text: string): void;
 
-    errorWithTraceId<TData>(
-        errorObj: unknown,
-        extraData?: TData | undefined
-    ): void;
+    errorWithTraceId(errorObj: unknown, extraData?: unknown): void;
 }
 
 export interface ILogger {
@@ -36,11 +33,11 @@ export interface ILogger {
         text: string
     ): void;
 
-    errorWithTraceId<TData>(
+    errorWithTraceId(
         botName: string,
         traceId: TraceId,
         chatName: string,
         errorObj: unknown,
-        extraData?: TData | undefined
+        extraData?: unknown
     ): void;
 }

package/types/scheduler.ts

@@ -5,7 +5,7 @@ export interface IScheduler {
 
     createTask(
         name: string,
-        action: () => void,
+        action: () => unknown,
         interval: Milliseconds,
         executeRightAway: boolean,
         ownerName: string
@@ -13,7 +13,7 @@ export interface IScheduler {
 
     createOnetimeTask(
         name: string,
-        action: () => void,
+        action: () => unknown,
         delay: Milliseconds,
         ownerName: string
     ): void;

package/types/storage.ts

@@ -5,12 +5,12 @@ export interface IStorageClient {
     updateStateFor<TActionState extends IActionState>(
         action: IActionWithState<TActionState>,
         chatId: number,
-        update: (state: TActionState) => Promise<void>
+        update: (state: TActionState) => Promise<void> | void
     ): Promise<void>;
     close(): Promise<void>;
     load<TActionState extends IActionState>(
         key: ActionKey
-    ): Promise<Record<number, TActionState>>;
+    ): Promise<Record<number, TActionState | undefined>>;
     saveMetadata<TActionState extends IActionState>(
         actions: IActionWithState<TActionState>[]
     ): Promise<void>;

package/types/timeValues.ts

@@ -2,9 +2,9 @@ declare const millisecondsSymbol: unique symbol;
 declare const secondsSymbol: unique symbol;
 declare const hoursSymbol: unique symbol;
 
-export type Milliseconds = number & { [millisecondsSymbol]: void };
-export type Seconds = number & { [secondsSymbol]: void };
-export type Hours = number & { [hoursSymbol]: void };
+export type Milliseconds = number & { [millisecondsSymbol]: never };
+export type Seconds = number & { [secondsSymbol]: never };
+export type Hours = number & { [hoursSymbol]: never };
 
 export type HoursOfDay =
     | 0

package/types/trace.ts

@@ -1,3 +1,5 @@
 declare const traceSymbol: unique symbol;
 
-export type TraceId = `${string}:${string}-${string}` & { [traceSymbol]: void };
+export type TraceId = `${string}:${string}-${string}` & {
+    [traceSymbol]: never;
+};