Add event MagicLink Delete (#129)

Author: cesargb

README.md

@@ -314,10 +314,35 @@ $urlToSend = $magiclink->url;
 
 ## Events
 
-MagicLink fires two events:
+MagicLink can fires three events:
 
-- `MagicLink\Events\MagicLinkWasCreated`
-- `MagicLink\Events\MagicLinkWasVisited`
+### MagicLinkWasCreated
+
+Event `MagicLink\Events\MagicLinkWasCreated`
+
+This event is fired when a magic link is created.
+
+### MagicLinkWasVisited
+
+Event `MagicLink\Events\MagicLinkWasVisited`
+
+This event is fired when a magic link is visited.
+
+### MagicLinkWasDeleted
+
+Event `MagicLink\Events\MagicLinkWasDeleted`
+
+This event is fired when you disable mass deletion. Add this line in your
+`.env` file to disable mass deletion:
+
+```.env
+# Disable mass deletion for enable event MagicLinkWasDeleted
+MAGICLINK_DELETE_MASSIVE=false
+```
+
+> [!WARNING]
+> If you disable mass deletion, the cleanup will be performed one by one.
+> If you have many records, this can be an issue.
 
 ## Customization
 

config/magiclink.php

@@ -15,6 +15,20 @@
         'view' => 'magiclink::ask-for-access-code-form',
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Delete Magic Link Expired massive
+    |--------------------------------------------------------------------------
+    |
+    | Expired MagicLinks are automatically and massively deleted from the database.
+    | If you want to disable this option, change the value to false.
+    |
+    | If you disable this option, expired MagicLinks will be deleted one by one
+    | triggering the event MagicLink\Events\MagicLinkWasDeleted.
+    |
+    */
+    'delete_massive' => env('MAGICLINK_DELETE_MASSIVE', true),
+
     /*
     |--------------------------------------------------------------------------
     | Disable default route

src/Events/MagicLinkWasDeleted.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace MagicLink\Events;
+
+class MagicLinkWasDeleted
+{
+    public $magiclink;
+
+    public function __construct($magiclink)
+    {
+        $this->magiclink = $magiclink;
+    }
+}

src/MagicLink.php

@@ -10,6 +10,7 @@
 use Illuminate\Support\Str;
 use MagicLink\Actions\ActionAbstract;
 use MagicLink\Events\MagicLinkWasCreated;
+use MagicLink\Events\MagicLinkWasDeleted;
 use MagicLink\Events\MagicLinkWasVisited;
 
 /**
@@ -214,16 +215,28 @@ public static function getMagicLinkByToken($token)
      */
     public static function deleteMagicLinkExpired()
     {
-        static::where(function ($query) {
+        $query = MagicLink::where(function ($query) {
             $query
                 ->where('available_at', '<', Carbon::now())
                 ->orWhere(function ($query) {
                     $query
                         ->whereNotNull('max_visits')
                         ->whereRaw('max_visits <= num_visits');
                 });
-        })
-        ->delete();
+        });
+
+        if (config('magiclink.delete_massive', true)) {
+            $query->delete();
+
+            return;
+        }
+
+
+        $query->get()->each(function (MagicLink $magiclink) {
+            $magiclink->delete();
+
+            event(new MagicLinkWasDeleted($magiclink));
+        });
     }
 
     /**

tests/MagicLinkDeleteTest.php

@@ -2,7 +2,11 @@
 
 namespace MagicLink\Test;
 
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Event;
 use MagicLink\Actions\LoginAction;
+use MagicLink\Actions\ResponseAction;
+use MagicLink\Events\MagicLinkWasDeleted;
 use MagicLink\MagicLink;
 use MagicLink\Test\TestSupport\User;
 
@@ -80,4 +84,51 @@ public function test_delete_all_magiclink()
 
         $this->assertEquals(0, MagicLink::count());
     }
+
+    public function test_delete_all_magiclink_expired_one_and_one_dispatch_event_deleted()
+    {
+        Event::fake([MagicLinkWasDeleted::class]);
+
+        config(['magiclink.delete_massive' => false]);
+
+        $this->createMagicLinkExpired(3);
+
+        MagicLink::deleteMagicLinkExpired();
+
+        Event::assertDispatched(MagicLinkWasDeleted::class, 3);
+
+        Event::assertDispatched(MagicLinkWasDeleted::class,function (MagicLinkWasDeleted $event) {
+            return $event->magiclink->action->run()['message'] === 'Hello World 1';
+        });
+
+        $this->assertEquals(0, MagicLink::count());
+    }
+
+    public function test_delete_all_magiclink_expired_all_not_dispatch_event_deleted()
+    {
+        Event::fake([MagicLinkWasDeleted::class]);
+
+        config(['magiclink.delete_massive' => true]);
+
+        $this->createMagicLinkExpired(3);
+
+        MagicLink::deleteMagicLinkExpired();
+
+        Event::assertDispatched(MagicLinkWasDeleted::class, 0);
+
+        $this->assertEquals(0, MagicLink::count());
+    }
+
+    private function createMagicLinkExpired(int $count = 1): Collection
+    {
+        return collect(range(1, $count))
+            ->map(function ($index) {
+                $magiclink =  MagicLink::create(new ResponseAction(['message' => 'Hello World ' . $index]));
+
+                $magiclink->available_at = now()->subMinute();
+                $magiclink->save();
+
+                return $magiclink;
+            });
+    }
 }