[6.x] Database Orders: Store status log in its own table (#983)

* Store status log events in their own database table

* Fix querying orders by date

* Refactor order date accessor

* Fix styling

* Re-work the "run update scripts" command

* Publish status log migration upon upgrade

* swap around the steps

* Migrate status log events to new table

* Ensure gateway data is copied across properly when migrating orders to a database

* Move status log logic until after the order model has been created

---------

Co-authored-by: duncanmcclean <duncanmcclean@users.noreply.github.com>

Author: duncanmcclean

docs/upgrade-guides/v5-x-to-v6-0.md

@@ -22,7 +22,14 @@ To get started with the upgrade process, follow the below steps:
 composer update doublethreedigital/simple-commerce --with-dependencies
 ```
 
-**3.** Next, manually run the update scripts. This step will make changes to your config files & order data.
+**3.** If you're storing your orders in the database, you should uninstall & re-install Runway. It has moved to the Rad Pack:
+
+```
+composer remove doublethreedigital/runway
+composer require statamic-rad-pack/runway
+```
+
+**4.** Next, manually run the update scripts. This step will make changes to your config files & order data.
 
 ```
 php please sc:run-update-scripts
@@ -32,13 +39,6 @@ php please sc:run-update-scripts
 If you have excluded your orders from Git or you're storing your orders in a database, you will need to re-run this command after deploying Simple Commerce v6.
 :::
 
-**4.** If you're storing your orders in the database, you should uninstall & re-install Runway. It has moved to the Rad Pack:
-
-```
-composer remove doublethreedigital/runway
-composer require statamic-rad-pack/runway
-```
-
 **5.** You may also want to clear your route & view caches:
 
 ```
@@ -56,6 +56,14 @@ php artisan view:clear
 
 If you're storing orders & customers in the database, you should also follow the [Runway v6 Upgrade Guide](https://runway.duncanmcclean.com/upgrade-guides/v5-x-to-v6-0).
 
+### High: Database Migrations
+
+If you're storing orders in the database, you will need to run the migrations, both locally & when deploying to any other environments:
+
+```
+php artisan migrate
+```
+
 ## High: References to gateways & shipping methods in orders have changed
 
 Previously, when referencing a Payment Gateway or Shipping Method in an order, Simple Commerce would use its fully-qualified class name, like so:

src/Console/Commands/MigrateOrdersToDatabase.php

@@ -158,7 +158,11 @@ protected function migrateOrders(string $collectionHandle): self
                 }
 
                 if ($gateway = $entry->get('gateway')) {
-                    $order->gatewayData(gateway: $gateway);
+                    $order->gatewayData(
+                        gateway: $gateway['use'],
+                        data: $gateway['data'],
+                        refund: $gateway['refund'] ?? []
+                    );
                 }
 
                 $order->data($data);

src/Console/Commands/RunUpdateScripts.php

@@ -2,7 +2,6 @@
 
 namespace DoubleThreeDigital\SimpleCommerce\Console\Commands;
 
-use Facades\Statamic\UpdateScripts\Manager as UpdateScriptManager;
 use Illuminate\Console\Command;
 use Statamic\Console\RunsInPlease;
 
@@ -18,10 +17,16 @@ public function handle()
     {
         $this->info('Running update scripts...');
 
-        UpdateScriptManager::runUpdatesForSpecificPackageVersion(
-            package: 'doublethreedigital/simple-commerce',
-            oldVersion: '5.0.0',
-            console: $this
-        );
+        // For some reason, the "proper" way of doing this didn't work so we're
+        // doing it manually here.
+        app('statamic.update-scripts')
+            ->filter(function (array $script) {
+                return $script['package'] === 'doublethreedigital/simple-commerce';
+            })
+            ->each(function (array $script) {
+                $updateScript = new $script['class']($script['package'], $this);
+
+                $updateScript->update();
+            });
     }
 }

src/Console/Commands/SwitchToDatabase.php

@@ -67,6 +67,10 @@ protected function copyMigrationStubs(): self
             File::copy($this->stubsPath.'/create_orders_table.php', database_path('migrations/'.date('Y_m_d_His').'_create_orders_table.php'));
         }
 
+        if (count(File::glob(database_path('migrations').'/*_create_status_log_table.php')) < 1) {
+            File::copy($this->stubsPath.'/create_status_log_table.php', database_path('migrations/'.date('Y_m_d_His').'_create_status_log_table.php'));
+        }
+
         return $this;
     }
 

src/Console/Commands/stubs/create_status_log_table.php

@@ -0,0 +1,56 @@
+<?php
+
+use DoubleThreeDigital\SimpleCommerce\Orders\OrderModel;
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\Schema;
+
+class CreateStatusLogTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('status_log', function (Blueprint $table) {
+            $table->id();
+            $table->string('order_id')->index();
+            $table->string('status')->index();
+            $table->timestamp('timestamp')->index();
+            $table->json('data')->nullable();
+        });
+
+        OrderModel::query()->chunkById(100, function ($orders) {
+            $orders->each(function (OrderModel $order) {
+                $statusLog = Arr::get($order->data, 'status_log', []);
+
+                foreach ($statusLog as $statusLogEvent) {
+                    $order->statusLog()->createOrFirst([
+                        'status' => $statusLogEvent['status'],
+                        'timestamp' => $statusLogEvent['timestamp'],
+                        'data' => $statusLogEvent['data'],
+                    ]);
+                }
+
+                $order->updateQuietly([
+                    'data' => collect($order->data)
+                        ->reject(fn ($value, $key) => $key === 'status_log')
+                        ->all(),
+                ]);
+            });
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('status_log');
+    }
+}

src/Orders/EloquentOrderRepository.php

@@ -95,6 +95,13 @@ public function fromModel(OrderModel $model)
                             })
                             ->toArray()
                     )
+                    ->merge([
+                        'status_log' => $model->statusLog()->get()->map(fn ($statusLog) => [
+                            'status' => $statusLog->status,
+                            'timestamp' => $statusLog->timestamp->timestamp,
+                            'data' => $statusLog->data ?? [],
+                        ]),
+                    ])
             );
 
         if ($model->gateway) {
@@ -170,6 +177,14 @@ public function save($order): void
 
         $model->save();
 
+        // Loop through status log events & create/update them in the database.
+        $order->statusLog()->map(function (StatusLogEvent $statusLogEvent) use ($model) {
+            StatusLogModel::updateOrCreate(
+                ['order_id' => $model->id, 'status' => $statusLogEvent->status, 'timestamp' => $statusLogEvent->date()],
+                ['data' => $statusLogEvent->data ?? []]
+            );
+        });
+
         $order->id = $model->id;
         $order->orderNumber = $model->order_number;
         $order->status = OrderStatus::from($model->order_status);
@@ -208,7 +223,14 @@ public function save($order): void
                         return [$columnName => $model->{$columnName}];
                     })
                     ->toArray()
-            );
+            )
+            ->merge([
+                'status_log' => $model->statusLog()->get()->map(fn ($statusLog) => [
+                    'status' => $statusLog->status,
+                    'timestamp' => $statusLog->timestamp->timestamp,
+                    'data' => $statusLog->data ?? [],
+                ]),
+            ]);
 
         $order->resource = $model;
     }

src/Orders/EloquentQueryBuilder.php

@@ -38,10 +38,10 @@ public function wherePaymentStatus(PaymentStatus $paymentStatus)
 
     public function whereStatusLogDate(OrderStatus|PaymentStatus $status, Carbon $date)
     {
-        return $this->whereJsonContains('data->status_log', function ($query) use ($status, $date) {
+        return $this->whereHas('statusLog', function ($query) use ($status, $date) {
             return $query
                 ->where('status', $status->value)
-                ->whereRaw('DATE(FROM_UNIXTIME(timestamp)) = ?', [$date->format('Y-m-d')]);
+                ->whereDate('timestamp', $date->format('Y-m-d'));
         });
     }
 }

src/Orders/OrderModel.php

@@ -3,13 +3,11 @@
 namespace DoubleThreeDigital\SimpleCommerce\Orders;
 
 use DoubleThreeDigital\SimpleCommerce\Customers\CustomerModel;
-use DoubleThreeDigital\SimpleCommerce\Exceptions\OrderNotFound;
-use DoubleThreeDigital\SimpleCommerce\Facades\Order as OrderFacade;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
-use Illuminate\Support\Carbon;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use StatamicRadPack\Runway\Traits\HasRunwayResource;
 
 class OrderModel extends Model
@@ -38,17 +36,19 @@ public function customer(): BelongsTo
         return $this->belongsTo(CustomerModel::class);
     }
 
+    public function statusLog(): HasMany
+    {
+        return $this->hasMany(StatusLogModel::class, 'order_id');
+    }
+
     public function orderDate(): Attribute
     {
         return Attribute::make(
             get: function () {
-                try {
-                    $order = OrderFacade::find($this->id);
-
-                    return $order->statusLog()->where('status', OrderStatus::Placed)->map->date()->last();
-                } catch (OrderNotFound $e) {
-                    return Carbon::now();
-                }
+                return $this->statusLog()
+                    ->where('status', OrderStatus::Placed)
+                    ->map->date()
+                    ->last();
             },
         );
     }

src/Orders/StatusLogModel.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace DoubleThreeDigital\SimpleCommerce\Orders;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+
+class StatusLogModel extends Model
+{
+    use HasFactory;
+
+    protected $table = 'status_log';
+
+    public $timestamps = false;
+
+    protected $guarded = [];
+
+    protected $casts = [
+        'order_id' => 'integer',
+        'timestamp' => 'datetime',
+        'data' => 'json',
+    ];
+
+    public function order(): BelongsTo
+    {
+        return $this->belongsTo(OrderModel::class, 'order_id');
+    }
+}

src/ServiceProvider.php

@@ -113,6 +113,7 @@ class ServiceProvider extends AddonServiceProvider
     ];
 
     protected $updateScripts = [
+        UpdateScripts\v6_0\PublishMigrations::class,
         UpdateScripts\v6_0\UpdateClassReferences::class,
     ];
 

src/UpdateScripts/v6_0/PublishMigrations.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace DoubleThreeDigital\SimpleCommerce\UpdateScripts\v6_0;
+
+use Illuminate\Support\Facades\File;
+use Statamic\UpdateScripts\UpdateScript;
+
+class PublishMigrations extends UpdateScript
+{
+    protected $stubsPath;
+
+    public function __construct()
+    {
+        $this->stubsPath = __DIR__.'/../../Console/Commands/stubs';
+    }
+
+    public function shouldUpdate($newVersion, $oldVersion)
+    {
+        return $this->isUpdatingTo('6.0.0');
+    }
+
+    public function update()
+    {
+        if ($this->isOrExtendsClass(SimpleCommerce::orderDriver()['repository'], EloquentOrderRepository::class)) {
+            if (count(File::glob(database_path('migrations').'/*_create_status_log_table.php')) < 1) {
+                File::copy($this->stubsPath.'/create_status_log_table.php', database_path('migrations/'.date('Y_m_d_His').'_create_status_log_table.php'));
+            }
+        }
+    }
+
+    protected function isOrExtendsClass(string $class, string $classToCheckAgainst): bool
+    {
+        return is_subclass_of($class, $classToCheckAgainst)
+            || $class === $classToCheckAgainst;
+    }
+}

tests/Helpers/UseDatabaseContentDrivers.php

@@ -18,6 +18,10 @@ public function setUpDatabaseContentDrivers()
             File::copy($this->stubsPath.'/create_orders_table.php', database_path('migrations/'.date('Y_m_d_His').'_create_orders_table.php'));
         }
 
+        if (count(File::glob(database_path('migrations').'/*_create_status_log_table.php')) < 1) {
+            File::copy($this->stubsPath.'/create_status_log_table.php', database_path('migrations/'.date('Y_m_d_His').'_create_status_log_table.php'));
+        }
+
         $this->runLaravelMigrations();
 
         $this->app['config']->set('simple-commerce.content.customers', [