From b5b322bf91d13ed3205639a4fa8f78668871612e Mon Sep 17 00:00:00 2001
From: KnorpelSenf <shtrog@gmail.com>
Date: Wed, 16 Oct 2024 14:46:43 +0200
Subject: [PATCH] feat: `bot.isRunning()` (#644)

* style: add override keyword

* feat: bot.isRunning

* docs: clarify order of state transitions
---
 src/bot.ts | 53 +++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 39 insertions(+), 14 deletions(-)

diff --git a/src/bot.ts b/src/bot.ts
index 52e36663..0e94c381 100644
--- a/src/bot.ts
+++ b/src/bot.ts
@@ -85,6 +85,9 @@ export interface PollingOptions {
      * fetched. The bot information `bot.botInfo` will be available when the
      * function is run. For convenience, the callback function receives the
      * value of `bot.botInfo` as an argument.
+     *
+     * When this function is invoked, the bot already signals that it is
+     * running. In other words, `bot.isRunning()` already returns true.
      */
     onStart?: (botInfo: UserFromGetMe) => void | Promise<void>;
 }
@@ -255,7 +258,7 @@ export class Bot<
     /**
      * @inheritdoc
      */
-    on<Q extends FilterQuery>(
+    override on<Q extends FilterQuery>(
         filter: Q | Q[],
         ...middleware: Array<Middleware<Filter<C, Q>>>
     ): Composer<Filter<C, Q>> {
@@ -267,7 +270,7 @@ export class Bot<
     /**
      * @inheritdoc
      */
-    reaction(
+    override reaction(
         reaction: MaybeArray<ReactionTypeEmoji["emoji"] | ReactionType>,
         ...middleware: Array<ReactionMiddleware<C>>
     ): Composer<ReactionContext<C>> {
@@ -495,6 +498,24 @@ a known bot info object.",
         }
     }
 
+    /**
+     * Returns true if the bot is currently running via built-in long polling,
+     * and false otherwise.
+     *
+     * If this method returns true, it means that `bot.start()` has been called,
+     * and that the bot has neither crashed nor was it stopped via a call to
+     * `bot.stop()`. This also means that you cannot use this method to check if
+     * a webhook server is running, or if grammY runner was started.
+     *
+     * Note that this method will already begin to return true even before the
+     * call to `bot.start()` has completed its initialization phase (and hence
+     * before `bot.isInited()` returns true). By extension, this method
+     * returns true before `onStart` callback of `bot.start()` is invoked.
+     */
+    isRunning() {
+        return this.pollingRunning;
+    }
+
     /**
      * Sets the bots error handler that is used during long polling.
      *
@@ -521,18 +542,22 @@ a known bot info object.",
         let allowed_updates: PollingOptions["allowed_updates"] =
             options?.allowed_updates ?? []; // reset to default if unspecified
 
-        while (this.pollingRunning) {
-            // fetch updates
-            const updates = await this.fetchUpdates(
-                { limit, timeout, allowed_updates },
-            );
-            // check if polling stopped
-            if (updates === undefined) break;
-            // handle updates
-            await this.handleUpdates(updates);
-            // Telegram uses the last setting if `allowed_updates` is omitted so
-            // we can save some traffic by only sending it in the first request
-            allowed_updates = undefined;
+        try {
+            while (this.pollingRunning) {
+                // fetch updates
+                const updates = await this.fetchUpdates(
+                    { limit, timeout, allowed_updates },
+                );
+                // check if polling stopped
+                if (updates === undefined) break;
+                // handle updates
+                await this.handleUpdates(updates);
+                // Telegram uses the last setting if `allowed_updates` is omitted so
+                // we can save some traffic by only sending it in the first request
+                allowed_updates = undefined;
+            }
+        } finally {
+            this.pollingRunning = false;
         }
     }