Merge pull request #2552 from BinarCode/garbage

Optimize garbage and serialize actions.

Author: binaryk

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to `laravel-mailator` will be documented in this file
 
+## 3.0.0 - 2021-06-08
+
+- `actionClass` from MailatorScheduler now accept an instance of `Binarcode\LaravelMailator\Actions\Action`  
+- `toDays()` helper added to MailatorScheduler
+- `tags()` added to MailatorScheduler
+
 ## 2.0.0 - 2021-08-03
 
 - The `before` and `after` methods now accept only an instance of Carbon 

config/mailator.php

@@ -26,6 +26,11 @@
         > The email sender class. It will be executed from the sender job.
          */
         'send_mail_action' => Binarcode\LaravelMailator\Actions\SendMailAction::class,
+
+        /**
+         * Class that will mark the scheduled action as being completed so the action will do not be counted into the next iteration.
+         */
+        'garbage_resolver' => Binarcode\LaravelMailator\Actions\ResolveGarbageAction::class,
     ],
 
     'log_model' => Binarcode\LaravelMailator\Models\MailatorLog::class,

database/migrations/create_mailator_tables.php.stub

@@ -31,6 +31,7 @@ class CreateMailatorTables extends Migration
 
             $table->timestamp('last_sent_at')->nullable();
             $table->timestamp('last_failed_at')->nullable();
+            $table->timestamp('completed_at')->nullable();
             $table->text('failure_reason')->nullable();
             $table->timestamps();
         });

src/Actions/ResolveGarbageAction.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Actions;
+
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+
+class ResolveGarbageAction implements Action
+{
+    public function handle(MailatorSchedule $schedule)
+    {
+        if ($this->shouldMarkComplete($schedule)) {
+            $schedule->markComplete();
+        }
+    }
+
+    public function shouldMarkComplete(MailatorSchedule $schedule): bool
+    {
+        if ($schedule->isOnce() && $schedule->fresh()->last_sent_at) {
+            return true;
+        }
+
+        if ($schedule->isManual()) {
+            return true;
+        }
+
+        if ($schedule->isNever()) {
+            return true;
+        }
+
+        if ($schedule->isMany()) {
+            return false;
+        }
+
+        if (! $schedule->nextTrigger()) {
+            return true;
+        }
+
+        return false;
+    }
+}

src/Actions/SendMailAction.php

@@ -4,15 +4,20 @@
 
 use Binarcode\LaravelMailator\Events\ScheduleMailSentEvent;
 use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Binarcode\LaravelMailator\Support\ClassResolver;
 use Exception;
 use Illuminate\Support\Facades\Mail;
 
 class SendMailAction implements Action
 {
+    use ClassResolver;
+
     public function handle(MailatorSchedule $schedule)
     {
         try {
             $this->sendMail($schedule);
+
+            static::garbageResolver()->handle($schedule);
         } catch (Exception $exception) {
             $schedule->markAsFailed($exception->getMessage());
 

src/Console/Commands/GarbageCollectorCommand.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Console\Commands;
+
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Binarcode\LaravelMailator\Support\ClassResolver;
+use Illuminate\Console\Command;
+
+class GarbageCollectorCommand extends Command
+{
+    use ClassResolver;
+
+    protected $signature = 'mailator:garbage
+            {--dry : Update items completed_at column}
+    ';
+
+    protected $description = 'Will mark as complete all executed mails.';
+
+    public function handle()
+    {
+        $this->info('----- Starting garbage cleaning -----');
+        $ids = collect();
+
+        MailatorSchedule::query()
+            ->ready()
+            ->cursor()
+            ->each(function (MailatorSchedule $mailatorSchedule) use ($ids) {
+                if ($this->option('dry')) {
+                    static::garbageResolver()->handle($mailatorSchedule);
+                } elseif (static::garbageResolver()->shouldMarkComplete($mailatorSchedule)) {
+                    $ids->push($mailatorSchedule->id);
+                }
+            });
+
+        if (! $dry = $this->option('dry')) {
+            $ids->each(fn ($i) => $this->info('Scheduler id to complete: '.$i));
+        }
+
+        $this->info("[".$ids->count()."] items matched.");
+        $this->info('All done.');
+    }
+}

src/Console/Commands/MailatorSchedulerCommand.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Console\Commands;
+
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Binarcode\LaravelMailator\Support\ClassResolver;
+use Illuminate\Console\Command;
+
+class MailatorSchedulerCommand extends Command
+{
+    use ClassResolver;
+
+    protected $signature = 'mailator:run';
+
+    protected $description = 'Run the mailator scheduler in Kernel.';
+
+    public function handle(): int
+    {
+        MailatorSchedule::run();
+
+        return 0;
+    }
+}

src/Constraints/AfterConstraint.php

@@ -17,14 +17,34 @@ public function canSend(MailatorSchedule $schedule, Collection $logs): bool
             return true;
         }
 
-        // it's in the future
-        if (now()->lt($schedule->timestamp_target)) {
+        if ($schedule->toDays() > 0) {
+            if (now()->lt($schedule->timestamp_target->clone()->addDays($schedule->toDays()))) {
+                return false;
+            }
+
+            return $schedule->isOnce()
+                ? $schedule->timestamp_target->diffInDays(now()) === $schedule->toDays()
+                : $schedule->timestamp_target->diffInDays(now()) > $schedule->toDays();
+        }
+
+        if ($schedule->toHours() > 0) {
+            if (now()->lt($schedule->timestamp_target->clone()->addHours($schedule->toHours()))) {
+                return false;
+            }
+
+            //till ends we should have at least toDays days
+            return $schedule->isOnce()
+                ? $schedule->timestamp_target->diffInHours(now()) === $schedule->toHours()
+                : $schedule->timestamp_target->diffInHours(now()) > $schedule->toHours();
+        }
+
+        if (now()->lt($schedule->timestamp_target->clone()->addMinutes($schedule->delay_minutes))) {
             return false;
         }
 
         //till ends we should have at least toDays days
         return $schedule->isOnce()
-            ? $schedule->timestamp_target->diffInDays(now()) === $schedule->toDays()
-            : $schedule->timestamp_target->diffInDays(now()) > $schedule->toDays();
+            ? $schedule->timestamp_target->diffInHours(now()) === $schedule->delay_minutes
+            : $schedule->timestamp_target->diffInHours(now()) > $schedule->delay_minutes;
     }
 }

src/Constraints/Descriptionable.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Constraints;
+
+interface Descriptionable
+{
+    public static function conditions(): array;
+}

src/LaravelMailatorServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace Binarcode\LaravelMailator;
 
+use Binarcode\LaravelMailator\Console\Commands\GarbageCollectorCommand;
+use Binarcode\LaravelMailator\Console\Commands\MailatorSchedulerCommand;
 use Binarcode\LaravelMailator\Models\MailatorLog;
 use Binarcode\LaravelMailator\Models\MailatorSchedule;
 use Binarcode\LaravelMailator\Models\MailTemplate;
@@ -65,7 +67,10 @@ public function boot()
             ], 'lang');*/
 
             // Registering package commands.
-            // $this->commands([]);
+            $this->commands([
+                 GarbageCollectorCommand::class,
+                 MailatorSchedulerCommand::class,
+             ]);
         }
     }