Added event logging in database (#8)

* Added event logging in database

* feedback

* fixed table for magento webhooks

* code review feedback

* bumped phpunit version

README.md

@@ -34,13 +34,35 @@ Publish the configuration of the package.
 php artisan vendor:publish --provider="JustBetter\MagentoWebhooks\ServiceProvider" --tag=config
 ```
 
+Run the migration for the event logs.
+
+```shell
+php artisan migrate
+```
+
 ## Configuration
 
 The `events` array located in your configuration can be used to add events.
 
 By default, **no middleware** is present on the webhook url. This can be changed by adding your own middleware to
 the `middleware` array, like authentication.
 
+### Schedule clean up command
+
+In order to keep the database from filling up, schedule the `CleanLogsCommand` in your Kernel.
+
+```php
+use JustBetter\MagentoWebhooks\Commands\CleanLogsCommand;
+
+$schedule->command(CleanLogsCommand::class)->daily();
+```
+
+This command supports usage of a custom date. You can pass a date as a parameter which will clean logs from before this date. This date defaults to one month prior.
+
+```shell
+php artisan magento:webhooks:clean-logs --date="yesterday"
+```
+
 ## Magento Webhook Configuration
 
 The following configuration can be used in order to successfully work with webhooks.

UPGRADE.md

@@ -0,0 +1,14 @@
+# Upgrade guide
+
+## 1.x to 2.x
+
+2.x introduces the use of a database to log files
+
+### Database usage
+
+A migration has been added to this package to keep historical data of all the event webhooks. This means that using a database has become mandatory.
+
+### Scheduling clean up
+
+In order to keep the logs from bloating up disk usage, we've added a `CleanLogsCommand` which defaults to a month if no parameters have been passed.
+Add this to your scheduler.

composer.json

@@ -20,7 +20,7 @@
         "nunomaduro/larastan": "^2.5",
         "orchestra/testbench": "^8.11",
         "phpstan/phpstan-mockery": "^1.1",
-        "phpunit/phpunit": "^10.0"
+        "phpunit/phpunit": "^10.5"
     },
     "autoload": {
         "psr-4": {

database/migrations/2024_01_24_153000_create_event_log_table.php

@@ -0,0 +1,23 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('magento_webhooks_event_logs', function (Blueprint $table): void {
+            $table->id();
+            $table->string('event')->index();
+            $table->json('data')->nullable();
+            $table->timestamps();
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists('magento_webhooks_event_logs');
+    }
+};

phpunit.xml

@@ -1,17 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         colors="true"
->
-    <testsuites>
-        <testsuite name="Tests">
-            <directory>./tests/*</directory>
-        </testsuite>
-    </testsuites>
-    <coverage>
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
-    </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
+  <testsuites>
+    <testsuite name="Tests">
+      <directory>./tests/*</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </source>
 </phpunit>

src/Actions/CleanLogs.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace JustBetter\MagentoWebhooks\Actions;
+
+use Illuminate\Support\Carbon;
+use JustBetter\MagentoWebhooks\Contracts\CleansLogs;
+use JustBetter\MagentoWebhooks\Models\EventLog;
+
+class CleanLogs implements CleansLogs
+{
+    public function clean(Carbon $date): void
+    {
+        EventLog::query()
+            ->where('created_at', '<', $date)
+            ->delete();
+    }
+
+    public static function bind(): void
+    {
+        app()->singleton(CleansLogs::class, static::class);
+    }
+}

src/Actions/DispatchEvents.php

@@ -5,11 +5,17 @@
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Event;
 use JustBetter\MagentoWebhooks\Contracts\DispatchesEvents;
+use JustBetter\MagentoWebhooks\Models\EventLog;
 
 class DispatchEvents implements DispatchesEvents
 {
     public function dispatch(string $event, array $data): void
     {
+        EventLog::query()->create([
+            'event' => $event,
+            'data' => $data,
+        ]);
+
         $events = config('magento-webhooks.events');
 
         if (! isset($events[$event])) {

src/Commands/CleanLogsCommand.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace JustBetter\MagentoWebhooks\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Carbon;
+use JustBetter\MagentoWebhooks\Jobs\CleanLogsJob;
+
+class CleanLogsCommand extends Command
+{
+    protected $signature = 'magento:webhooks:clean-logs {--date=}';
+
+    protected $description = 'Cleans event logs based on date';
+
+    public function handle(): int
+    {
+        /** @var ?string $date */
+        $date = $this->option('date');
+
+        $date = $date !== null
+            ? Carbon::parse($date)
+            : now()->subMonth();
+
+        CleanLogsJob::dispatch($date);
+
+        return static::SUCCESS;
+    }
+}

src/Contracts/CleansLogs.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace JustBetter\MagentoWebhooks\Contracts;
+
+use Illuminate\Support\Carbon;
+
+interface CleansLogs
+{
+    public function clean(Carbon $date): void;
+}

src/Jobs/CleanLogsJob.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace JustBetter\MagentoWebhooks\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldBeUnique;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Support\Carbon;
+use JustBetter\MagentoWebhooks\Contracts\CleansLogs;
+
+class CleanLogsJob implements ShouldBeUnique, ShouldQueue
+{
+    use Dispatchable;
+    use InteractsWithQueue;
+    use Queueable;
+
+    public function __construct(
+        protected Carbon $date,
+    ) {
+        $this->onQueue(config('magento-webhooks.queue'));
+    }
+
+    public function handle(CleansLogs $contract): void
+    {
+        $contract->clean($this->date);
+    }
+}

src/Models/EventLog.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace JustBetter\MagentoWebhooks\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Carbon;
+
+/**
+ * @property int $id
+ * @property string $event
+ * @property ?array $data
+ * @property ?Carbon $created_at
+ * @property ?Carbon $updated_at
+ */
+class EventLog extends Model
+{
+    protected $table = 'magento_webhooks_event_logs';
+
+    protected $guarded = [];
+
+    protected $casts = [
+        'data' => 'array',
+    ];
+}

src/ServiceProvider.php

@@ -4,7 +4,9 @@
 
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
+use JustBetter\MagentoWebhooks\Actions\CleanLogs;
 use JustBetter\MagentoWebhooks\Actions\DispatchEvents;
+use JustBetter\MagentoWebhooks\Commands\CleanLogsCommand;
 
 class ServiceProvider extends BaseServiceProvider
 {
@@ -25,6 +27,7 @@ protected function registerConfig(): static
     protected function registerActions(): static
     {
         DispatchEvents::bind();
+        CleanLogs::bind();
 
         return $this;
     }
@@ -33,6 +36,8 @@ public function boot(): void
     {
         $this
             ->bootConfig()
+            ->bootCommands()
+            ->bootMigrations()
             ->bootRoutes();
     }
 
@@ -55,4 +60,22 @@ protected function bootRoutes(): static
 
         return $this;
     }
+
+    protected function bootMigrations(): static
+    {
+        $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
+
+        return $this;
+    }
+
+    protected function bootCommands(): static
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                CleanLogsCommand::class,
+            ]);
+        }
+
+        return $this;
+    }
 }

tests/Actions/CleanLogsTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace JustBetter\MagentoWebhooks\Tests\Actions;
+
+use JustBetter\MagentoWebhooks\Actions\CleanLogs;
+use JustBetter\MagentoWebhooks\Models\EventLog;
+use JustBetter\MagentoWebhooks\Tests\TestCase;
+
+class CleanLogsTest extends TestCase
+{
+    /** @test */
+    public function it_cleans_logs(): void
+    {
+        EventLog::query()->create([
+            'event' => 'some-event',
+            'data' => ['some' => 'value'],
+            'created_at' => now()->subMonths(2),
+        ]);
+
+        EventLog::query()->create([
+            'event' => 'some-event',
+            'data' => ['some' => 'value'],
+            'created_at' => now(),
+        ]);
+
+        /** @var CleanLogs $action */
+        $action = app(CleanLogs::class);
+        $action->clean(now()->subMonth());
+
+        $this->assertEquals(1, EventLog::query()->count());
+    }
+}

tests/Actions/DispatchEventsTest.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Support\Facades\Event;
 use JustBetter\MagentoWebhooks\Actions\DispatchEvents;
+use JustBetter\MagentoWebhooks\Models\EventLog;
 use JustBetter\MagentoWebhooks\Tests\Fakes\Events\FakeEvent;
 use JustBetter\MagentoWebhooks\Tests\TestCase;
 
@@ -85,4 +86,28 @@ public function it_can_skip_dispatching_events(): void
 
         Event::assertNotDispatched(FakeEvent::class);
     }
+
+    /** @test */
+    public function it_logs_events_in_database(): void
+    {
+        Event::fake();
+
+        config()->set('magento-webhooks.events', [
+            'test-event' => [
+                FakeEvent::class,
+            ],
+        ]);
+
+        /** @var DispatchEvents $dispatchEvents */
+        $dispatchEvents = app(DispatchEvents::class);
+        $dispatchEvents->dispatch('test-event', ['some' => 'value']);
+
+        $log = EventLog::query()
+            ->where('event', '=', 'test-event')
+            ->firstOrFail();
+
+        $this->assertEquals([
+            'some' => 'value',
+        ], $log->data);
+    }
 }