feat: LAR 10 Send a Telegram notification for articles that are submitted but neither approved nor declined.

Author: StevyMarlino

.phpunit.cache/test-results

@@ -0,0 +1 @@
+{"version":"pest_2.35.0","defects":[],"times":{"P\\Tests\\Feature\\NotifyPendingArticlesTest::__pest_evaluable_it_will_send_a_notification_when_there_are_pending_articles":0.207,"P\\Tests\\Feature\\NotifyPendingArticlesTest::__pest_evaluable_it_will_not_send_a_notification_when_there_are_no_pending_articles":0.061,"P\\Tests\\Integration\\ChannelTest::__pest_evaluable_channel_can_have_children":0.137,"P\\Tests\\Integration\\ChannelTest::__pest_evaluable_child_channel_can_be_a_parent":0.015,"P\\Tests\\Integration\\DiscussionTest::__pest_evaluable_it_can_find_by_slug":0.046,"P\\Tests\\Integration\\DiscussionTest::__pest_evaluable_it_can_give_an_excerpt_of_its_body":0.057,"P\\Tests\\Integration\\DiscussionTest::__pest_evaluable_html_in_excerpts_is_markdown_converted":0.016,"P\\Tests\\Integration\\DiscussionTest::__pest_evaluable_it_can_have_many_tags":0.024,"P\\Tests\\Integration\\DiscussionTest::__pest_evaluable_it_records_activity_when_a_discussion_is_created":0.025,"P\\Tests\\Integration\\DiscussionTest::__pest_evaluable_it_generates_a_slug_when_valid_url_characters_provided":0.007,"P\\Tests\\Integration\\DiscussionTest::__pest_evaluable_it_generates_a_unique_slug_when_valid_url_characters_provided":0.017,"P\\Tests\\Integration\\DiscussionTest::__pest_evaluable_it_generates_a_slug_when_invalid_url_characters_provided":0.011,"P\\Tests\\Integration\\ReplyTest::__pest_evaluable_it_records_activity_when_a_reply_is_send":0.004,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_it_can_find_by_slug":0.013,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_it_can_give_an_excerpt_of_its_body":0.006,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_html_in_excerpts_is_markdown_converted":0.017,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_it_can_have_many_channels":0.003,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_it_records_activity_when_a_thread_is_created":0.003,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_its_conversation_is_old_when_the_oldest_reply_was_six_months_ago":0.049,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_its_conversation_is_old_when_there_are_no_replies_but_the_creation_date_was_six_months_ago":0.021,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_we_can_mark_and_unmark_a_reply_as_the_solution":0.065,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_it_can_retrieve_the_latest_threads_in_a_correct_order":0.053,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_it_can_retrieve_only_resolved_threads":0.056,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_it_can_retrieve_only_active_threads":0.052,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_it_generates_a_slug_when_valid_url_characters_provided":0.008,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_it_generates_a_unique_slug_when_valid_url_characters_provided":0.019,"P\\Tests\\Integration\\ThreadTest::__pest_evaluable_it_generates_a_slug_when_invalid_url_characters_provided":0.012,"P\\Tests\\Feature\\Cleanup\\DeleteOldUnverifiedUsersTest::__pest_evaluable_it_will_delete_unverified_users_after_some_days":0.387,"P\\Tests\\Feature\\Cleanup\\DeleteOldUnverifiedUsersTest::__pest_evaluable_it_will_not_delete_verified_users":0.014,"P\\Tests\\Feature\\UserActivitiesTest::__pest_evaluable_it_records_activity_when_an_article_is_created":0.002,"P\\Tests\\Feature\\UserActivitiesTest::__pest_evaluable_it_get_feed_from_any_user":0.002}}

app/Console/Commands/NotifyPendingArticles.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Console\Commands;
+
+use App\Models\Article;
+use Illuminate\Console\Command;
+use Illuminate\Notifications\AnonymousNotifiable;
+use App\Notifications\PendingArticlesNotification;
+
+final class NotifyPendingArticles extends Command
+{
+    protected $signature = 'lcm:notify-pending-articles';
+
+    protected $description = 'Send a Telegram notification for articles that are submitted but neither approved nor declined';
+
+    public function handle(AnonymousNotifiable $notifiable): void
+    {
+        $pendingArticles = Article::awaitingApproval()->get();
+
+        if ($pendingArticles->isNotEmpty()) {
+            $notifiable->notify(new PendingArticlesNotification($pendingArticles));
+        }
+    }
+}

app/Console/Kernel.php

@@ -23,11 +23,12 @@ protected function schedule(Schedule $schedule): void
             $schedule->command('lcm:post-article-to-telegram')->everyFourHours();
             $schedule->command('lcm:send-unverified-mails')->weeklyOn(1, '8:00');
             $schedule->command('sitemap:generate')->daily();
+            $schedule->command('lcm:notify-pending-articles')->everyTwoDays();
         }
     }
 
     protected function commands(): void
     {
         $this->load(__DIR__.'/Commands');
     }
-}
+}

app/Notifications/PendingArticlesNotification.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Notifications;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Notifications\Notification;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Notifications\Messages\MailMessage;
+use NotificationChannels\Telegram\TelegramChannel;
+use NotificationChannels\Telegram\TelegramMessage;
+
+final class PendingArticlesNotification extends Notification
+{
+    use Queueable;
+
+    public function __construct(public Collection $pendingArticles) {}
+
+    public function via(mixed $notifiable): array
+    {
+        return [TelegramChannel::class];
+    }
+
+    public function toTelegram(): TelegramMessage
+    {
+        $message = $this->content();
+
+        return TelegramMessage::create()
+            ->to(config('services.telegram-bot-api.channel'))
+            ->content($message);
+    }
+
+    private function content(): string
+    {
+        $message = __("Pending approval articles:\n");
+        foreach ($this->pendingArticles as $article) {
+            $url = route('articles.show', $article->slug);
+            
+            $message .= __("• Title: [:title](:url)\n", [
+                'title' => $article->title,
+                'url' => $url,
+            ]);
+
+            $message .= __("• By: [@:username](:profile_url)\n", [
+                'username' => $article->user?->username,
+                'profile_url' => route('profile', $article->user?->username),
+            ]);
+
+            $message .= __("• Submitted on: :date\n\n", [
+                'date' => $article->submitted_at->translatedFormat('d/m/Y'),
+            ]);
+        }
+
+        return $message;
+    }
+}

lang/en.json

@@ -3,5 +3,9 @@
   "The given :attribute has appeared in a data leak. Please choose a different :attribute.": "The given :attribute has appeared in a data leak. Please choose a different :attribute.",
   "Verify Email Address": "Verify Email Address",
   "Please click the button below to verify your email address.": "Please click the button below to verify your email address.",
-  "If you did not create an account, no further action is required.": "If you did not create an account, no further action is required."
+  "If you did not create an account, no further action is required.": "If you did not create an account, no further action is required.",
+  "Pending approval articles:" : "Pending approval articles:",
+  "• Title: [:title](:url)" : "• Title: [:title](:url)",
+  "• By: [@:username](:profile_url)" : "• By: [@:username](:profile_url)",
+  "• Submitted on: :date" : "• Submitted on: :date"
 }

lang/fr.json

@@ -3,5 +3,9 @@
   "The given :attribute has appeared in a data leak. Please choose a different :attribute.": "Le champ :attribute donné est apparu dans une fuite de données. Veuillez choisir un autre :attribute.",
   "Verify Email Address": "Vérifier l'adresse e-mail",
   "Please click the button below to verify your email address.": "Veuillez cliquer sur le bouton ci-dessous pour vérifier votre adresse email.",
-  "If you did not create an account, no further action is required.": "Si vous n'avez pas créé de compte, aucune autre action n'est requise."
+  "If you did not create an account, no further action is required.": "Si vous n'avez pas créé de compte, aucune autre action n'est requise.",
+  "Pending approval articles:" : "Articles soumis en attente d'approbation:",
+  "• Title: [:title](:url)" : "• Titre: [:title](:url)",
+  "• By: [@:username](:profile_url)" : "• Par: [@:username](:profile_url)",
+  "• Submitted on: :date" : "• Soumis le: :date"
 }

tests/Feature/NotifyPendingArticlesTest.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+use App\Console\Commands\NotifyPendingArticles;
+use App\Models\Article;
+use App\Notifications\PendingArticlesNotification;
+use Illuminate\Notifications\AnonymousNotifiable;
+use Illuminate\Support\Facades\Notification;
+
+beforeEach(fn() => Notification::fake());
+
+it('will send a notification when there are pending articles', function (): void {
+    Article::factory()->createMany([
+        [
+            'submitted_at' => now(),
+        ],
+        [
+            'submitted_at' => now()->subDay(),
+            'approved_at' => now(),
+        ],
+        [
+            'submitted_at' => now()->subDay(),
+            'declined_at' => now(),
+        ],
+    ]);
+
+    $this->assertDatabaseCount('articles', 3);
+
+    $this->artisan(NotifyPendingArticles::class)->assertExitCode(0);
+
+    Notification::assertSentTo(
+        new AnonymousNotifiable(),
+        PendingArticlesNotification::class,
+        fn($notification) => $notification->pendingArticles->count() === 1
+    );
+
+    Notification::assertCount(1);
+});
+
+it('will not send a notification when there are no pending articles', function (): void {
+    Article::factory()->createMany([
+        [
+            'submitted_at' => now()->subDay(),
+            'approved_at' => now(),
+        ],
+        [
+            'submitted_at' => now()->subDay(),
+            'declined_at' => now(),
+        ],
+    ]);
+
+    $this->assertDatabaseCount('articles', 2);
+    $this->artisan(NotifyPendingArticles::class)->assertExitCode(0);
+
+    Notification::assertNothingSent();
+    Notification::assertCount(0);
+});

tests/Integration/DiscussionTest.php

@@ -5,11 +5,6 @@
 use App\Models\Activity;
 use App\Models\Discussion;
 use App\Models\Tag;
-use Illuminate\Foundation\Testing\DatabaseMigrations;
-use Illuminate\Foundation\Testing\RefreshDatabase;
-
-uses(RefreshDatabase::class);
-uses(DatabaseMigrations::class);
 
 it('can find by slug', function (): void {
     Discussion::factory()->create(['slug' => 'foo']);
@@ -74,4 +69,4 @@
 
     // When providing a slug with invalid url characters, a random 5 character string is returned.
     expect($discussion->slug())->toMatch('/\w{5}/');
-});
+});

tests/Integration/ThreadTest.php

@@ -8,11 +8,6 @@
 use App\Models\Thread;
 use App\Models\User;
 use Carbon\Carbon;
-use Illuminate\Foundation\Testing\DatabaseMigrations;
-use Illuminate\Foundation\Testing\RefreshDatabase;
-
-uses(RefreshDatabase::class);
-uses(DatabaseMigrations::class);
 
 it('can find by slug', function (): void {
     Thread::factory()->create(['slug' => 'foo']);
@@ -192,4 +187,4 @@ function createActiveThread(): Thread
     $reply->save();
 
     return $thread;
-}
+}