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 (!$this->option('dry')) {
+            $ids->each(fn($i) => $this->info('Scheduler id to complete: '.$i));
+        }
+
+        $this->info("Marked as completed [".$ids->count()."] items.");
+        $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/Descriptionable.php

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

src/Models/Builders/MailatorSchedulerBuilder.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Models\Builders;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class MailatorSchedulerBuilder extends Builder
+{
+    public function ready(): self
+    {
+        return $this->whereNull('completed_at');
+    }
+}

src/Models/Concerns/ConstraintsResolver.php

@@ -6,6 +6,7 @@
 use Binarcode\LaravelMailator\Constraints\AfterConstraint;
 use Binarcode\LaravelMailator\Constraints\BeforeConstraint;
 use Binarcode\LaravelMailator\Constraints\DailyConstraint;
+use Binarcode\LaravelMailator\Constraints\Descriptionable;
 use Binarcode\LaravelMailator\Constraints\ManualConstraint;
 use Binarcode\LaravelMailator\Constraints\ManyConstraint;
 use Binarcode\LaravelMailator\Constraints\NeverConstraint;
@@ -49,4 +50,14 @@ public function eventsPasses(): bool
             ->filter(fn ($event) => is_subclass_of($event, SendScheduleConstraint::class))
             ->every(fn (SendScheduleConstraint $event) => $event->canSend($this, $this->logs));
     }
+
+    public function constraintsDescriptions(): array
+    {
+        return collect($this->constraints)
+            ->map(fn(string $event) => unserialize($event))
+            ->filter(fn($event) => is_subclass_of($event, Descriptionable::class))
+            ->reduce(function ($base, Descriable $descriable) {
+                return array_merge($base, $descriable::conditions());
+            }, []);
+    }
 }

src/Models/Concerns/HasFuture.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Models\Concerns;
+
+
+use Binarcode\LaravelMailator\Constraints\AfterConstraint;
+use Binarcode\LaravelMailator\Constraints\BeforeConstraint;
+use Binarcode\LaravelMailator\Constraints\Descriptionable;
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Carbon\CarbonInterface;
+
+/**
+ * Trait HasFuture
+ * @mixin MailatorSchedule
+ * @package Binarcode\LaravelMailator\Models\Concerns
+ */
+trait HasFuture
+{
+    public function nextTrigger(): ?CarbonInterface
+    {
+        if (!$this->isFutureAction()) {
+            return null;
+        }
+
+        if ($this->isOnce() && $this->last_sent_at) {
+            return null;
+        }
+
+        return $this->timestamp_target->clone()->addDays(
+            $this->toDays()
+        );
+    }
+
+    public function isFutureAction(): bool
+    {
+        if ($this->isManual()) {
+            return false;
+        }
+
+        if (is_null($this->timestamp_target)) {
+            return false;
+        }
+
+        if (is_null($this->time_frame_origin)) {
+            return false;
+        }
+
+        if ($this->time_frame_origin === static::TIME_FRAME_ORIGIN_AFTER) {
+            return app(AfterConstraint::class)->canSend(
+                $this,
+                $this->logs
+            );
+        }
+
+        if ($this->time_frame_origin === static::TIME_FRAME_ORIGIN_BEFORE) {
+            return app(BeforeConstraint::class)->canSend(
+                $this,
+                $this->logs
+            );
+        }
+
+        return false;
+    }
+}