Fix Migration Command for Legacy Actions in PostgreSQL (#145)

Author: cesargb

src/Commands/MigrateLegacyActionsCommand.php

@@ -91,6 +91,10 @@ private function getLegacyBuilder(): Builder
     {
         $tableName = config('magiclink.magiclink_table', 'magic_links');
 
+        if ((new MagicLink())->getConnection()->getDriverName() === 'pgsql') {
+            return DB::table($tableName)->where('action', 'not like', '{');
+        }
+
         return DB::table($tableName)->where('action', 'like', 'O:%');
     }
 
@@ -114,7 +118,10 @@ private function migrateRecord(int|string $id, string $action): array
             ];
         }
 
-        $magicLink->action = unserialize($action);
+        $magicLink->action = (new MagicLink())->getConnection()->getDriverName() === 'pgsql'
+            ? unserialize(base64_decode($action))
+            : unserialize($action);
+
         $magicLink->saveQuietly();
 
         return [
@@ -125,6 +132,10 @@ private function migrateRecord(int|string $id, string $action): array
 
     private function isAllowedAction(string $data): bool
     {
+        if ((new MagicLink())->getConnection()->getDriverName() === 'pgsql') {
+            $data = base64_decode($data);
+        }
+
         if (preg_match('/^O:\d+:"([^"]+)"/', $data, $matches)) {
             $className = $matches[1];
 

tests/Actions/LegacyTest.php

@@ -8,6 +8,7 @@
 use MagicLink\Actions\LoginAction;
 use MagicLink\Actions\ResponseAction;
 use MagicLink\Actions\ViewAction;
+use MagicLink\MagicLink;
 use MagicLink\Test\TestCase;
 use MagicLink\Test\TestSupport\MyController;
 use MagicLink\Test\TestSupport\User;
@@ -74,7 +75,9 @@ private function generateMagicLink($action): string
     {
         $id = (string) \Illuminate\Support\Str::uuid();
         $token = 'toktok';
-        $payload = serialize($action);
+        $payload = (new MagicLink())->getConnection()->getDriverName() === 'pgsql'
+            ? base64_encode(serialize($action))
+            : serialize($action);
 
         DB::table('magic_links')->insert([
             'id' => $id,

tests/Commands/MigrateLegacyActionsCommandTest.php

@@ -8,6 +8,7 @@
 use MagicLink\Actions\LoginAction;
 use MagicLink\Actions\ResponseAction;
 use MagicLink\Actions\ViewAction;
+use MagicLink\MagicLink;
 use MagicLink\Test\TestCase;
 use MagicLink\Test\TestSupport\MyController;
 use MagicLink\Test\TestSupport\User;
@@ -128,7 +129,9 @@ private function generateMagicLink($action): array
     {
         $id = (string) \Illuminate\Support\Str::uuid();
         $token = 'toktok';
-        $payload = serialize($action);
+        $payload = (new MagicLink())->getConnection()->getDriverName() === 'pgsql'
+            ? base64_encode(serialize($action))
+            : serialize($action);
 
         DB::table('magic_links')->insert([
             'id' => $id,

tests/TestCase.php

@@ -3,12 +3,15 @@
 namespace MagicLink\Test;
 
 use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Foundation\Testing\RefreshDatabase;
 use MagicLink\MagicLinkServiceProvider;
 use MagicLink\Test\TestSupport\User;
 use Orchestra\Testbench\TestCase as Orchestra;
 
 abstract class TestCase extends Orchestra
 {
+    use RefreshDatabase;
+
     public function setUp(): void
     {
         parent::setUp();
@@ -77,7 +80,7 @@ protected function defineEnvironment($app)
 
         $driver = getenv('DB_DRIVER');
 
-        if ($driver !== 'mysql') {
+        if ($driver !== 'pgsql') {
             $app['config']->set('database.default', 'testbench');
         } else {
             $app['config']->set('database.default', $driver);
@@ -87,31 +90,29 @@ protected function defineEnvironment($app)
     protected function defineDatabaseMigrations()
     {
         $this->loadMigrationsFrom(__DIR__ . '/../databases/migrations');
-        $this->setUpDatabase($this->app);
     }
 
-    /**
-     * Set up the database.
-     *
-     * @param  \Illuminate\Foundation\Application  $app
-     */
-    protected function setUpDatabase($app)
+    protected function refreshTestDatabase()
     {
-        if ($app['config']->get('database.default') !== 'testbench') {
-            $app['db']->connection()->getSchemaBuilder()->dropIfExists('users');
-            $app['db']->connection()->getSchemaBuilder()->dropIfExists('migrations');
-            $app['db']->connection()->getSchemaBuilder()->dropIfExists('magic_links');
+        if (getenv('DB_DRIVER') === 'pgsql') {
+            $this->app['db']->connection()->getSchemaBuilder()->dropIfExists('users');
+            $this->app['db']->connection()->getSchemaBuilder()->dropIfExists('migrations');
+            $this->app['db']->connection()->getSchemaBuilder()->dropIfExists('magic_links');
+            $this->artisan('migrate', ['--database' => getenv('DB_DRIVER') === 'pgsql' ? 'pgsql' : 'testbench']);
         }
+    }
 
-        $this->artisan('migrate');
-
-        $app['db']->connection()->getSchemaBuilder()->create('users', function (Blueprint $table) {
+    protected function afterRefreshingDatabase()
+    {
+        $this->app['db']->connection()->getSchemaBuilder()->create('users', function (Blueprint $table) {
             $table->increments('id');
             $table->string('email');
             $table->string('remember_token')->nullable();
         });
 
         User::create(['email' => 'test@user.com']);
+
+        $this->artisan('migrate', ['--database' => getenv('DB_DRIVER') === 'pgsql' ? 'pgsql' : 'testbench']);
     }
 
     protected function loadRoutes()