fix: rename email to identifier in table auth_logins

Author: kenjis

src/Database/Migrations/2020-12-28-223112_create_auth_tables.php

@@ -54,7 +54,7 @@ public function up(): void
             'id'         => ['type' => 'int', 'constraint' => 11, 'unsigned' => true, 'auto_increment' => true],
             'ip_address' => ['type' => 'varchar', 'constraint' => 255, 'null' => true],
             'user_agent' => ['type' => 'varchar', 'constraint' => 255, 'null' => true],
-            'email'      => ['type' => 'varchar', 'constraint' => 255, 'null' => true],
+            'identifier' => ['type' => 'varchar', 'constraint' => 255, 'null' => true],
             'user_id'    => ['type' => 'int', 'constraint' => 11, 'unsigned' => true, 'null' => true], // Only for successful logins
             'date'       => ['type' => 'datetime'],
             'success'    => ['type' => 'tinyint', 'constraint' => 1],

src/Entities/User.php

@@ -194,7 +194,7 @@ public function lastLogin(bool $allowFailed = false): ?Login
         }
 
         return $logins
-            ->where('email', $this->getAuthEmail())
+            ->where('identifier', $this->getAuthEmail())
             ->orderBy('date', 'desc')
             ->first();
     }

src/Models/LoginModel.php

@@ -18,15 +18,15 @@ class LoginModel extends Model
     protected $allowedFields  = [
         'ip_address',
         'user_agent',
-        'email',
+        'identifier',
         'user_id',
         'date',
         'success',
     ];
     protected $useTimestamps   = false;
     protected $validationRules = [
         'ip_address' => 'required',
-        'email'      => 'required',
+        'identifier' => 'required',
         'user_agent' => 'permit_empty|string',
         'user_id'    => 'permit_empty|integer',
         'date'       => 'required|valid_date',
@@ -39,12 +39,12 @@ class LoginModel extends Model
      *
      * @return BaseResult|false|int|object|string
      */
-    public function recordLoginAttempt(string $email, bool $success, ?string $ipAddress = null, ?string $userAgent = null, $userId = null)
+    public function recordLoginAttempt(string $identifier, bool $success, ?string $ipAddress = null, ?string $userAgent = null, $userId = null)
     {
         return $this->insert([
             'ip_address' => $ipAddress,
             'user_agent' => $userAgent,
-            'email'      => $email,
+            'identifier' => $identifier,
             'user_id'    => $userId,
             'date'       => date('Y-m-d H:i:s'),
             'success'    => (int) $success,
@@ -60,7 +60,7 @@ public function fake(Generator &$faker): Login
     {
         return new Login([
             'ip_address' => $faker->ipv4,
-            'email'      => $faker->email,
+            'identifier' => $faker->email,
             'user_id'    => null,
             'date'       => Time::parse('-1 day')->toDateTimeString(),
             'success'    => true,

tests/Authentication/AccessTokenAuthenticatorTest.php

@@ -168,8 +168,8 @@ public function testAttemptCannotFindUser()
 
         // A login attempt should have always been recorded
         $this->seeInDatabase('auth_logins', [
-            'email'   => 'token: abc123',
-            'success' => 0,
+            'identifier' => 'token: abc123',
+            'success'    => 0,
         ]);
     }
 
@@ -195,8 +195,8 @@ public function testAttemptSuccess()
 
         // A login attempt should have been recorded
         $this->seeInDatabase('auth_logins', [
-            'email'   => 'token: ' . $token->raw_token,
-            'success' => 1,
+            'identifier' => 'token: ' . $token->raw_token,
+            'success'    => 1,
         ]);
     }
 

tests/Authentication/SessionAuthenticatorTest.php

@@ -254,8 +254,8 @@ public function testAttemptCannotFindUser()
 
         // A login attempt should have always been recorded
         $this->seeInDatabase('auth_logins', [
-            'email'   => '[email protected]',
-            'success' => 0,
+            'identifier' => '[email protected]',
+            'success'    => 0,
         ]);
     }
 
@@ -284,8 +284,8 @@ public function testAttemptSuccess()
 
         // A login attempt should have been recorded
         $this->seeInDatabase('auth_logins', [
-            'email'   => $this->user->email,
-            'success' => 1,
+            'identifier' => $this->user->email,
+            'success'    => 1,
         ]);
     }
 
@@ -314,8 +314,8 @@ public function testAttemptCaseInsensitive()
 
         // A login attempt should have been recorded
         $this->seeInDatabase('auth_logins', [
-            'email'   => '[email protected]',
-            'success' => 1,
+            'identifier' => '[email protected]',
+            'success'    => 1,
         ]);
     }
 
@@ -346,8 +346,8 @@ public function testAttemptUsernameOnly()
 
         // A login attempt should have been recorded
         $this->seeInDatabase('auth_logins', [
-            'email'   => 'fooROG',
-            'success' => 1,
+            'identifier' => 'fooROG',
+            'success'    => 1,
         ]);
     }
 }

tests/Controllers/LoginTest.php

@@ -52,9 +52,9 @@ public function testLoginBadEmail()
 
         // Login should have been recorded successfully
         $this->seeInDatabase('auth_logins', [
-            'email'   => '[email protected]',
-            'user_id' => null,
-            'success' => 0,
+            'identifier' => '[email protected]',
+            'user_id'    => null,
+            'success'    => 0,
         ]);
 
         $this->assertNotEmpty(session('error'));
@@ -79,9 +79,9 @@ public function testLoginActionEmailSuccess()
 
         // Login should have been recorded successfully
         $this->seeInDatabase('auth_logins', [
-            'email'   => '[email protected]',
-            'user_id' => $this->user->id,
-            'success' => true,
+            'identifier' => '[email protected]',
+            'user_id'    => $this->user->id,
+            'success'    => true,
         ]);
         // Last Used date should have been set
         $identity = $this->user->getEmailIdentity();
@@ -109,9 +109,9 @@ public function testLoginActionUsernameSuccess()
 
         // Login should have been recorded successfully
         $this->seeInDatabase('auth_logins', [
-            'email'   => $this->user->username,
-            'user_id' => $this->user->id,
-            'success' => true,
+            'identifier' => $this->user->username,
+            'user_id'    => $this->user->id,
+            'success'    => true,
         ]);
         // Last Used date should have been set
         $identity = $this->user->getEmailIdentity();

tests/Unit/UserTest.php

@@ -78,11 +78,11 @@ public function testLastLogin()
 
         $login = fake(
             LoginModel::class,
-            ['email' => $this->user->email, 'user_id' => $this->user->id]
+            ['identifier' => $this->user->email, 'user_id' => $this->user->id]
         );
         fake(
             LoginModel::class,
-            ['email' => $this->user->email, 'user_id' => $this->user->id, 'success' => false]
+            ['identifier' => $this->user->email, 'user_id' => $this->user->id, 'success' => false]
         );
 
         $last = $this->user->lastLogin();