Implemented the console command for sending messages to all users.

itorgov · itorgov · commit 13b7d70714a8 · 2020-04-26T22:40:16.000+03:00
diff --git a/app/Console/Commands/Telegram/BroadcastMessageCommand.php b/app/Console/Commands/Telegram/BroadcastMessageCommand.php
@@ -0,0 +1,49 @@
+<?php
+
+namespace App\Console\Commands\Telegram;
+
+use App\Jobs\SendMessageJob;
+use App\User;
+use Illuminate\Console\Command;
+use Illuminate\Database\Eloquent\Builder;
+
+class BroadcastMessageCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'telegram:broadcast-message
+                           {--only-private : Send message to private chats only}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Send a message to all users';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle(): int
+    {
+        $message = $this->ask('Enter your message');
+
+        User::query()
+            ->when(
+                $this->option('only-private'),
+                function (Builder $query) {
+                    $query->where('telegram_chat_id', 'not like', '-%');
+                }
+            )
+            ->each(function (User $user) use ($message) {
+                SendMessageJob::dispatch($user, $message);
+            });
+
+        return 0;
+    }
+}
diff --git a/app/Events/BotWasBlocked.php b/app/Events/BotWasBlocked.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class BotWasBlocked
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * @var string
+     */
+    public string $chatId;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param string $chatId
+     * @return void
+     */
+    public function __construct(string $chatId)
+    {
+        $this->chatId = $chatId;
+    }
+}
diff --git a/app/Integrations/Telegram/Entities/OutboundMessage.php b/app/Integrations/Telegram/Entities/OutboundMessage.php
@@ -2,7 +2,9 @@
 
 namespace App\Integrations\Telegram\Entities;
 
+use App\Events\BotWasBlocked;
 use App\Facades\TelegramBot;
+use App\Integrations\Telegram\Exceptions\TelegramBotException;
 use App\User;
 use Illuminate\Contracts\Support\Arrayable;
 
@@ -132,7 +134,15 @@ public function withInlineKeyboard(InlineKeyboard $keyboard): self
      */
     public function send(): void
     {
-        TelegramBot::sendMessage($this);
+        try {
+            TelegramBot::sendMessage($this);
+        } catch (TelegramBotException $exception) {
+            if ($exception->getMessage() === 'Forbidden: bot was blocked by the user') {
+                event(new BotWasBlocked($this->params['chat_id']));
+            } else {
+                throw $exception;
+            }
+        }
     }
 
     /**
diff --git a/app/Jobs/SendDeploymentNotificationJob.php b/app/Jobs/SendDeploymentNotificationJob.php
@@ -6,10 +6,13 @@
 use App\User;
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Contracts\Redis\LimiterTimeoutException;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Arr;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\Redis;
 use Illuminate\Support\Fluent;
 
 class SendDeploymentNotificationJob implements ShouldQueue
@@ -38,35 +41,60 @@ public function __construct(User $user, array $deploymentInfo)
         $this->deploymentInfo = $deploymentInfo;
     }
 
+    /**
+     * Get the tags that should be assigned to the job.
+     *
+     * @return array
+     */
+    public function tags(): array
+    {
+        return [
+            'deployment-notification',
+            'user:'.$this->user->id,
+        ];
+    }
+
     /**
      * Execute the job.
      *
      * @return void
+     *
+     * @throws LimiterTimeoutException
      */
     public function handle(): void
     {
-        $server = new Fluent(Arr::get($this->deploymentInfo, 'server'));
-        $site = new Fluent(Arr::get($this->deploymentInfo, 'site'));
-        $commit = new Fluent([
-            'hash' => Arr::get($this->deploymentInfo, 'commit_hash'),
-            'url' => Arr::get($this->deploymentInfo, 'commit_url'),
-            'author' => Arr::get($this->deploymentInfo, 'commit_author'),
-            'message' => Arr::get($this->deploymentInfo, 'commit_message'),
-        ]);
+        // From official documentation (https://core.telegram.org/bots/faq):
+        // The API will not allow bulk notifications to more than ~30 users per second.
+        // Also note that your bot will not be able to send more than 20 messages per minute to the same group.
+        Redis::throttle('telegram-api')
+            ->allow(25)
+            ->every(1)
+            ->then(function () {
+                $server = new Fluent(Arr::get($this->deploymentInfo, 'server'));
+                $site = new Fluent(Arr::get($this->deploymentInfo, 'site'));
+                $commit = new Fluent([
+                    'hash' => Arr::get($this->deploymentInfo, 'commit_hash'),
+                    'url' => Arr::get($this->deploymentInfo, 'commit_url'),
+                    'author' => Arr::get($this->deploymentInfo, 'commit_author'),
+                    'message' => Arr::get($this->deploymentInfo, 'commit_message'),
+                ]);
 
-        $message = [
-            '*Deployment complete!*',
-            "*Server:* [{$server->name}](https://forge.laravel.com/servers/{$server->id})",
-            "*Site:* [{$site->name}](https://forge.laravel.com/servers/{$server->id}/sites/{$site->id})",
-            "*Status:* {$this->getStatus()}",
-            "*Commit author:* {$commit->author}",
-            "*Commit hash:* [$commit->hash]($commit->url)",
-            "*Commit message:* {$commit->message}",
-        ];
+                $message = [
+                    '*Deployment complete!*',
+                    "*Server:* [{$server->name}](https://forge.laravel.com/servers/{$server->id})",
+                    "*Site:* [{$site->name}](https://forge.laravel.com/servers/{$server->id}/sites/{$site->id})",
+                    "*Status:* {$this->getStatus()}",
+                    "*Commit author:* {$commit->author}",
+                    "*Commit hash:* [$commit->hash]($commit->url)",
+                    "*Commit message:* {$commit->message}",
+                ];
 
-        OutboundMessage::make($this->user, implode("\n", $message))
-            ->parseMode(OutboundMessage::PARSE_MODE_MARKDOWN)
-            ->send();
+                OutboundMessage::make($this->user, implode("\n", $message))
+                    ->parseMode(OutboundMessage::PARSE_MODE_MARKDOWN)
+                    ->send();
+            }, function () {
+                $this->release(10);
+            });
     }
 
     /**
@@ -89,4 +117,14 @@ protected function getStatus(): string
                 return $status;
         }
     }
+
+    /**
+     * Determine the time at which the job should timeout.
+     *
+     * @return Carbon
+     */
+    public function retryUntil(): Carbon
+    {
+        return now()->addMinutes(10);
+    }
 }
diff --git a/app/Jobs/SendMessageJob.php b/app/Jobs/SendMessageJob.php
@@ -0,0 +1,89 @@
+<?php
+
+namespace App\Jobs;
+
+use App\Integrations\Telegram\Entities\OutboundMessage;
+use App\User;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Contracts\Redis\LimiterTimeoutException;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\Redis;
+
+class SendMessageJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    /**
+     * @var User
+     */
+    public User $user;
+
+    /**
+     * @var string
+     */
+    public string $text;
+
+    /**
+     * Create a new job instance.
+     *
+     * @param User $user
+     * @param string $text
+     * @return void
+     */
+    public function __construct(User $user, string $text)
+    {
+        $this->user = $user;
+        $this->text = $text;
+    }
+
+    /**
+     * Get the tags that should be assigned to the job.
+     *
+     * @return array
+     */
+    public function tags(): array
+    {
+        return [
+            'message',
+            'user:'.$this->user->id,
+        ];
+    }
+
+    /**
+     * Execute the job.
+     *
+     * @return void
+     *
+     * @throws LimiterTimeoutException
+     */
+    public function handle(): void
+    {
+        // From official documentation (https://core.telegram.org/bots/faq):
+        // The API will not allow bulk notifications to more than ~30 users per second.
+        // Also note that your bot will not be able to send more than 20 messages per minute to the same group.
+        Redis::throttle('telegram-api')
+            ->allow(25)
+            ->every(1)
+            ->then(function () {
+                OutboundMessage::make($this->user, $this->text)
+                    ->parseMode(OutboundMessage::PARSE_MODE_MARKDOWN)
+                    ->send();
+            }, function () {
+                $this->release(10);
+            });
+    }
+
+    /**
+     * Determine the time at which the job should timeout.
+     *
+     * @return Carbon
+     */
+    public function retryUntil(): Carbon
+    {
+        return now()->addMinutes(10);
+    }
+}
diff --git a/app/Listeners/DeleteUser.php b/app/Listeners/DeleteUser.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Listeners;
+
+use App\Events\BotWasBlocked;
+use App\User;
+use Exception;
+
+class DeleteUser
+{
+    /**
+     * Handle the event.
+     *
+     * @param BotWasBlocked $event
+     * @return void
+     *
+     * @throws Exception
+     */
+    public function handle(BotWasBlocked $event)
+    {
+        $user = User::findByTelegramChatId($event->chatId);
+
+        if ($user) {
+            $user->delete();
+        }
+    }
+}
diff --git a/app/Providers/EventServiceProvider.php b/app/Providers/EventServiceProvider.php
@@ -2,23 +2,19 @@
 
 namespace App\Providers;
 
-use Illuminate\Auth\Events\Registered;
-use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
 use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
-use Illuminate\Support\Facades\Event;
 
 class EventServiceProvider extends ServiceProvider
 {
     /**
-     * The event listener mappings for the application.
+     * Determine if events and listeners should be automatically discovered.
      *
-     * @var array
+     * @return bool
      */
-    protected $listen = [
-        Registered::class => [
-            SendEmailVerificationNotification::class,
-        ],
-    ];
+    public function shouldDiscoverEvents()
+    {
+        return true;
+    }
 
     /**
      * Register any events for your application.
