Refactor reminders

app/Jobs/Util/ReminderJob.php

@@ -68,7 +68,7 @@ class ReminderJob implements ShouldQueue
                     event(new InvoiceWasEmailed($invoice->invitations->first(), $invoice->company, Ninja::eventVars(), $reminder_template));
                 }
 
-                $invoice->setReminder();
+                $invoice->service()->setReminder()->save();
                 
             } else {
                 $invoice->next_send_date = null;

app/Observers/InvoiceObserver.php

@@ -52,6 +52,9 @@ class InvoiceObserver
             WebhookHandler::dispatch(Webhook::EVENT_UPDATE_INVOICE, $invoice, $invoice->company);
         }
     
+        if($invoice->isDirty('date') || $invoice->isDirty('due_date'))
+            $invoice->service()->setReminder()->save();
+
         // UnlinkFile::dispatchNow(config('filesystems.default'), $invoice->client->invoice_filepath() . $invoice->numberFormatter().'.pdf');
 
     }

app/Services/Invoice/InvoiceService.php

@@ -21,6 +21,7 @@ use App\Models\Invoice;
 use App\Models\Payment;
 use App\Models\Task;
 use App\Services\Client\ClientService;
+use App\Services\Invoice\UpdateReminder;
 use App\Utils\Ninja;
 use App\Utils\Traits\MakesHash;
 use Illuminate\Support\Carbon;
@@ -425,6 +426,13 @@ class InvoiceService
         return $this;
     }
     
+    public function setReminder($settings = null)
+    {
+        $this->invoice = (new UpdateReminder($this->invoice, $settings))->run();
+
+        return $this;
+    }
+
     /**
      * Saves the invoice.
      * @return Invoice object

app/Services/Invoice/MarkSent.php

@@ -46,10 +46,9 @@ class MarkSent extends AbstractService
              ->setDueDate()
              ->updateBalance($this->invoice->amount)
              ->deletePdf()
+             ->setReminder()
              ->save();
 
-        $this->invoice->setReminder();
-
         $this->client->service()->updateBalance($this->invoice->balance)->save();
 
         $this->invoice->ledger()->updateInvoiceBalance($this->invoice->balance, "Invoice {$this->invoice->number} marked as sent.");

app/Services/Invoice/UpdateReminder.php

@@ -0,0 +1,131 @@
+<?php
+/**
+ * Invoice Ninja (https://invoiceninja.com).
+ *
+ * @link https://github.com/invoiceninja/invoiceninja source repository
+ *
+ * @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
+ *
+ * @license https://opensource.org/licenses/AAL
+ */
+
+namespace App\Services\Invoice;
+
+use App\Models\Invoice;
+use App\Services\AbstractService;
+use Carbon\Carbon;
+
+class UpdateReminder extends AbstractService
+{
+	public $invoice;
+
+	public $settings;
+
+    public function __construct($invoice, $settings = null)
+    {
+        $this->invoice = $invoice;
+        $this->settings = $settings;
+    }
+
+    public function run()
+    {
+
+        if (! $this->settings) {
+            $this->settings = $this->invoice->client->getMergedSettings();
+        }
+
+        if (! $this->invoice->isPayable()) {
+            $this->invoice->next_send_date = null;
+            $this->invoice->save();
+
+            return; //exit early
+        }
+
+        $date_collection = collect();
+
+        if (is_null($this->invoice->reminder1_sent) &&
+            $this->settings->schedule_reminder1 == 'after_invoice_date' &&
+            $this->settings->num_days_reminder1 > 0) {
+            $reminder_date = Carbon::parse($this->invoice->date)->addDays($this->settings->num_days_reminder1);
+
+            if ($reminder_date->gt(Carbon::parse($this->invoice->next_send_date)));
+                $date_collection->push($reminder_date->format('Y-m-d'));
+        }
+
+        if (is_null($this->invoice->reminder1_sent) &&
+            $this->settings->schedule_reminder1 == 'before_due_date' &&
+            $this->settings->num_days_reminder1 > 0) {
+            $reminder_date = Carbon::parse($this->invoice->due_date)->subDays($this->settings->num_days_reminder1);
+
+            if ($reminder_date->gt(Carbon::parse($this->invoice->next_send_date)));
+                $date_collection->push($reminder_date->format('Y-m-d')); 
+        }
+
+        if (is_null($this->invoice->reminder1_sent) &&
+            $this->settings->schedule_reminder1 == 'after_due_date' &&
+            $this->settings->num_days_reminder1 > 0) {
+            $reminder_date = Carbon::parse($this->invoice->due_date)->addDays($this->settings->num_days_reminder1);
+
+            if ($reminder_date->gt(Carbon::parse($this->invoice->next_send_date)));
+                $date_collection->push($reminder_date->format('Y-m-d'));  
+        }
+
+        if (is_null($this->invoice->reminder2_sent) &&
+            $this->settings->schedule_reminder2 == 'after_invoice_date' &&
+            $this->settings->num_days_reminder2 > 0) {
+            $reminder_date = Carbon::parse($this->invoice->date)->addDays($this->settings->num_days_reminder2);
+
+            if ($reminder_date->gt(Carbon::parse($this->invoice->next_send_date)));
+                $date_collection->push($reminder_date->format('Y-m-d')); 
+        }
+
+        if (is_null($this->invoice->reminder2_sent) &&
+            $this->settings->schedule_reminder2 == 'before_due_date' &&
+            $this->settings->num_days_reminder2 > 0) {
+            $reminder_date = Carbon::parse($this->invoice->due_date)->subDays($this->settings->num_days_reminder2);
+
+            if ($reminder_date->gt(Carbon::parse($this->invoice->next_send_date)));
+                $date_collection->push($reminder_date->format('Y-m-d')); 
+        }
+
+        if (is_null($this->invoice->reminder2_sent) &&
+            $this->settings->schedule_reminder2 == 'after_due_date' &&
+            $this->settings->num_days_reminder2 > 0) {
+            $reminder_date = Carbon::parse($this->invoice->due_date)->addDays($this->settings->num_days_reminder2);
+
+            if ($reminder_date->gt(Carbon::parse($this->invoice->next_send_date)));
+                $date_collection->push($reminder_date->format('Y-m-d')); 
+        }
+
+        if (is_null($this->invoice->reminder3_sent) &&
+            $this->settings->schedule_reminder3 == 'after_invoice_date' &&
+            $this->settings->num_days_reminder3 > 0) {
+            $reminder_date = Carbon::parse($this->invoice->date)->addDays($this->settings->num_days_reminder3);
+
+            if ($reminder_date->gt(Carbon::parse($this->invoice->next_send_date)));
+                $date_collection->push($reminder_date->format('Y-m-d')); 
+        }
+
+        if (is_null($this->invoice->reminder3_sent) &&
+            $this->settings->schedule_reminder3 == 'before_due_date' &&
+            $this->settings->num_days_reminder3 > 0) {
+            $reminder_date = Carbon::parse($this->invoice->due_date)->subDays($this->settings->num_days_reminder3);
+
+            if ($reminder_date->gt(Carbon::parse($this->invoice->next_send_date)));
+                $date_collection->push($reminder_date->format('Y-m-d')); 
+        }
+
+        if (is_null($this->invoice->reminder3_sent) &&
+            $this->settings->schedule_reminder3 == 'after_due_date' &&
+            $this->settings->num_days_reminder3 > 0) {
+            $reminder_date = Carbon::parse($this->invoice->due_date)->addDays($this->settings->num_days_reminder3);
+
+            if ($reminder_date->gt(Carbon::parse($this->invoice->next_send_date)));
+                $date_collection->push($reminder_date->format('Y-m-d')); 
+        }
+
+        $this->invoice->next_send_date = $date_collection->sort()->first();
+
+        return $this->invoice;
+    }
+}

app/Utils/Traits/MakesReminders.php

@@ -19,115 +19,6 @@ use Illuminate\Support\Carbon;
  */
 trait MakesReminders
 {
-    public function setReminder($settings = null)
-    {
-        if (! $settings) {
-            $settings = $this->client->getMergedSettings();
-        }
-
-        if (! $this->isPayable()) {
-            $this->next_send_date = null;
-            $this->save();
-
-            return; //exit early
-        }
-
-        $date_collection = collect();
-
-        if (is_null($this->reminder1_sent) &&
-            $settings->schedule_reminder1 == 'after_invoice_date' &&
-            $settings->num_days_reminder1 > 0) {
-            $reminder_date = Carbon::parse($this->date)->addDays($settings->num_days_reminder1);
-            nlog("reminder 1 = after invoice date = {$reminder_date}");
-
-            if ($reminder_date->gt(Carbon::parse($this->next_send_date)));
-                $date_collection->push($reminder_date->format('Y-m-d')); nlog('after_invoice_date pushed to collection');
-        }
-
-        if (is_null($this->reminder1_sent) &&
-            $settings->schedule_reminder1 == 'before_due_date' &&
-            $settings->num_days_reminder1 > 0) {
-            $reminder_date = Carbon::parse($this->due_date)->subDays($settings->num_days_reminder1);
-            nlog("reminder 1 = before_due_date = {$reminder_date}");
-
-            if ($reminder_date->gt(Carbon::parse($this->next_send_date)));
-                $date_collection->push($reminder_date->format('Y-m-d')); nlog('before_due_date pushed to collection');
-        }
-
-        if (is_null($this->reminder1_sent) &&
-            $settings->schedule_reminder1 == 'after_due_date' &&
-            $settings->num_days_reminder1 > 0) {
-            $reminder_date = Carbon::parse($this->due_date)->addDays($settings->num_days_reminder1);
-            nlog("reminder 1 = after_due_date = {$reminder_date}");
-
-            if ($reminder_date->gt(Carbon::parse($this->next_send_date)));
-                $date_collection->push($reminder_date->format('Y-m-d'));  nlog('after_due_date pushed to collection');
-        }
-
-        if (is_null($this->reminder2_sent) &&
-            $settings->schedule_reminder2 == 'after_invoice_date' &&
-            $settings->num_days_reminder2 > 0) {
-            $reminder_date = Carbon::parse($this->date)->addDays($settings->num_days_reminder2);
-            nlog("reminder 2 = after_invoice_date = {$reminder_date}");
-
-            if ($reminder_date->gt(Carbon::parse($this->next_send_date)));
-                $date_collection->push($reminder_date->format('Y-m-d')); nlog('after_invoice_date pushed to collection');
-        }
-
-        if (is_null($this->reminder2_sent) &&
-            $settings->schedule_reminder2 == 'before_due_date' &&
-            $settings->num_days_reminder2 > 0) {
-            $reminder_date = Carbon::parse($this->due_date)->subDays($settings->num_days_reminder2);
-            nlog("reminder 2 = before_due_date = {$reminder_date}");
-
-            if ($reminder_date->gt(Carbon::parse($this->next_send_date)));
-                $date_collection->push($reminder_date->format('Y-m-d')); nlog('before_due_date pushed to collection');
-        }
-
-        if (is_null($this->reminder2_sent) &&
-            $settings->schedule_reminder2 == 'after_due_date' &&
-            $settings->num_days_reminder2 > 0) {
-            $reminder_date = Carbon::parse($this->due_date)->addDays($settings->num_days_reminder2);
-            nlog("reminder 2 = after_due_date = {$reminder_date}");
-
-            if ($reminder_date->gt(Carbon::parse($this->next_send_date)));
-                $date_collection->push($reminder_date->format('Y-m-d')); nlog('after_due_date pushed to collection');
-        }
-
-        if (is_null($this->reminder3_sent) &&
-            $settings->schedule_reminder3 == 'after_invoice_date' &&
-            $settings->num_days_reminder3 > 0) {
-            $reminder_date = Carbon::parse($this->date)->addDays($settings->num_days_reminder3);
-            nlog("reminder 3 = after_invoice_date = {$reminder_date}");
-
-            if ($reminder_date->gt(Carbon::parse($this->next_send_date)));
-                $date_collection->push($reminder_date->format('Y-m-d')); nlog('after_invoice_date pushed to collection');
-        }
-
-        if (is_null($this->reminder3_sent) &&
-            $settings->schedule_reminder3 == 'before_due_date' &&
-            $settings->num_days_reminder3 > 0) {
-            $reminder_date = Carbon::parse($this->due_date)->subDays($settings->num_days_reminder3);
-                nlog("reminder 3 = before_due_date = {$reminder_date}");
-
-            if ($reminder_date->gt(Carbon::parse($this->next_send_date)));
-                $date_collection->push($reminder_date->format('Y-m-d')); nlog('before_due_date pushed to collection');
-        }
-
-        if (is_null($this->reminder3_sent) &&
-            $settings->schedule_reminder3 == 'after_due_date' &&
-            $settings->num_days_reminder3 > 0) {
-            $reminder_date = Carbon::parse($this->due_date)->addDays($settings->num_days_reminder3);
-                nlog("reminder 3 = after_due_date = {$reminder_date}");
-
-            if ($reminder_date->gt(Carbon::parse($this->next_send_date)));
-                $date_collection->push($reminder_date->format('Y-m-d')); nlog('after_due_date pushed to collection');
-        }
-
-        $this->next_send_date = $date_collection->sort()->first();
-
-        $this->save();
-    }
     
     public function inReminderWindow($schedule_reminder, $num_days_reminder)
     {
@@ -195,10 +86,8 @@ trait MakesReminders
 
     private function addTimeInterval($date, $endless_reminder_frequency_id) :?Carbon
     {
-        if (!$date) {
+        if (!$date) 
             return null;
-        }
-        
         
         switch ($endless_reminder_frequency_id) {
             case RecurringInvoice::FREQUENCY_WEEKLY:

tests/Feature/ReminderTest.php

@@ -75,7 +75,7 @@ class ReminderTest extends TestCase
 
         $this->company->settings = $settings;
         $this->invoice->service()->markSent();
-        $this->invoice->setReminder($settings);
+        $this->invoice->service()->setReminder($settings)->save();
 
         $this->assertEquals($this->invoice->next_send_date, Carbon::now()->addDays(7)->format('Y-m-d'));
 
@@ -102,7 +102,7 @@ class ReminderTest extends TestCase
 
         $this->company->settings = $settings;
         $this->invoice->service()->markSent();
-        $this->invoice->setReminder($settings);
+        $this->invoice->service()->setReminder($settings)->save();
 
         $this->invoice->fresh();
 
@@ -132,7 +132,7 @@ class ReminderTest extends TestCase
 
         $this->company->settings = $settings;
         $this->invoice->service()->markSent();
-        $this->invoice->setReminder($settings);
+        $this->invoice->service()->setReminder($settings)->save();
 
         $this->invoice->fresh();
         

tests/Integration/CheckRemindersTest.php

@@ -52,7 +52,7 @@ class CheckRemindersTest extends TestCase
 
         $this->company->settings = $settings;
         $this->invoice->service()->markSent();
-        $this->invoice->setReminder($settings);
+        $this->invoice->service()->setReminder($settings)->save();
 
         $this->assertEquals(0, Carbon::now()->addDays(7)->diffInDays($this->invoice->next_send_date));
     }
@@ -75,7 +75,7 @@ class CheckRemindersTest extends TestCase
 
         $this->company->settings = $settings;
         $this->invoice->service()->markSent()->setStatus(Invoice::STATUS_PAID);
-        $this->invoice->setReminder($settings);
+        $this->invoice->service()->setReminder($settings)->save();
 
         $this->assertEquals($this->invoice->next_send_date, null);
     }
@@ -98,7 +98,7 @@ class CheckRemindersTest extends TestCase
 
         $this->company->settings = $settings;
         $this->invoice->service()->markSent();
-        $this->invoice->setReminder($settings);
+        $this->invoice->service()->setReminder($settings)->save();
 
         $this->assertEquals(0, Carbon::parse($this->invoice->due_date)->subDays(29)->diffInDays($this->invoice->next_send_date));
     }
@@ -118,7 +118,7 @@ class CheckRemindersTest extends TestCase
 
         $this->company->settings = $settings;
         $this->invoice->service()->markSent();
-        $this->invoice->setReminder($settings);
+        $this->invoice->service()->setReminder($settings)->save();
 
         $this->assertEquals(0, Carbon::parse($this->invoice->due_date)->addDays(1)->diffInDays($this->invoice->next_send_date));
     }
@@ -141,7 +141,7 @@ class CheckRemindersTest extends TestCase
 
         $this->company->settings = $settings;
         $this->invoice->service()->markSent();
-        $this->invoice->setReminder($settings);
+        $this->invoice->service()->setReminder($settings)->save();
 
         $this->assertEquals($this->invoice->next_send_date, null);
     }
@@ -164,7 +164,7 @@ class CheckRemindersTest extends TestCase
 
         $this->company->settings = $settings;
         $this->invoice->service()->markSent();
-        $this->invoice->setReminder($settings);
+        $this->invoice->service()->setReminder($settings)->save();
 
         $this->assertEquals($this->invoice->next_send_date, null);
     }