Merge pull request #965 from arodu/feature/add-last_login

add last_login in users table
CakeDC · Oct 1, 2021 · 8913a7e · 8913a7e
2 parents ddfc836 + c053503
commit 8913a7e
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 1 deletion.
diff --git a/config/Migrations/20210929202041_AddLastLoginToUsers.php b/config/Migrations/20210929202041_AddLastLoginToUsers.php
@@ -0,0 +1,24 @@
+<?php
+declare(strict_types=1);
+
+use Migrations\AbstractMigration;
+
+class AddLastLoginToUsers extends AbstractMigration
+{
+    /**
+     * Change Method.
+     *
+     * More information on this method is available here:
+     * https://book.cakephp.org/phinx/0/en/migrations.html#the-change-method
+     * @return void
+     */
+    public function change()
+    {
+        $table = $this->table('users');
+        $table->addColumn('last_login', 'datetime', [
+            'default' => null,
+            'null' => true,
+        ]);
+        $table->update();
+    }
+}
diff --git a/config/Migrations/schema-dump-default.lock b/config/Migrations/schema-dump-default.lock
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -7,7 +7,7 @@ parameters:
 
 		-
 			message: "#^Call to an undefined method Cake\\\\Controller\\\\Controller\\:\\:getUsersTable\\(\\)\\.$#"
-			count: 1
+			count: 2
 			path: src\Controller\Component\LoginComponent.php
 
 		-

diff --git a/src/Controller/Component/LoginComponent.php b/src/Controller/Component/LoginComponent.php
@@ -70,6 +70,7 @@ public function handleLogin($errorOnlyPost, $redirectFailure)
         if ($result->isValid()) {
             $user = $request->getAttribute('identity')->getOriginalData();
             $this->handlePasswordRehash($service, $user, $request);
+            $this->updateLastLogin($user);
 
             return $this->afterIdentifyUser($user);
         }
@@ -218,4 +219,20 @@ protected function checkSafeHost(?string $queryRedirect = null): bool
 
         return in_array($host, Configure::read('Users.AllowedRedirectHosts'));
     }
+
+    /**
+     * Update last loging date
+     *
+     * @param \CakeDC\Users\Model\Entity\User $user User entity.
+     * @return void
+     */
+    protected function updateLastLogin($user)
+    {
+        $now = \Cake\I18n\FrozenTime::now();
+        $user->set('last_login', $now);
+        $this->getController()->getUsersTable()->updateAll(
+            ['last_login' => $now],
+            ['id' => $user->id]
+        );
+    }
 }
diff --git a/tests/Fixture/UsersFixture.php b/tests/Fixture/UsersFixture.php
@@ -45,6 +45,7 @@ class UsersFixture extends TestFixture
         'created' => ['type' => 'datetime', 'length' => null, 'null' => false, 'default' => null, 'comment' => '', 'precision' => null],
         'modified' => ['type' => 'datetime', 'length' => null, 'null' => false, 'default' => null, 'comment' => '', 'precision' => null],
         'additional_data' => ['type' => 'text', 'length' => null, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
+        'last_login' => ['type' => 'datetime', 'length' => null, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
         '_constraints' => [
             'primary' => ['type' => 'primary', 'columns' => ['id'], 'length' => []],
         ],
@@ -90,6 +91,7 @@ public function init(): void
                         'counter' => 1,
                     ],
                 ]),
+                'last_login' => '2015-06-24 17:33:54',
             ],
             [
                 'id' => '00000000-0000-0000-0000-000000000002',
@@ -111,6 +113,7 @@ public function init(): void
                 'role' => 'admin',
                 'created' => '2015-06-24 17:33:54',
                 'modified' => '2015-06-24 17:33:54',
+                'last_login' => '2015-06-24 17:33:54',
             ],
             [
                 'id' => '00000000-0000-0000-0000-000000000003',

diff --git a/tests/TestCase/Controller/Traits/LoginTraitTest.php b/tests/TestCase/Controller/Traits/LoginTraitTest.php
@@ -92,6 +92,8 @@ public function testLoginHappy()
         $user = $this->Trait->getUsersTable()->get('00000000-0000-0000-0000-000000000002');
         $passwordBefore = $user['password'];
         $this->assertNotEmpty($passwordBefore);
+        $lastLoginBefore = $user['last_login'];
+        $this->assertNotEmpty($lastLoginBefore);
         $this->_mockAuthentication($user->toArray(), $failures);
         $this->Trait->Flash->expects($this->never())
             ->method('error');
@@ -130,6 +132,10 @@ public function testLoginHappy()
         $userAfter = $this->Trait->getUsersTable()->get('00000000-0000-0000-0000-000000000002');
         $passwordAfter = $userAfter['password'];
         $this->assertSame($passwordBefore, $passwordAfter);
+        $lastLoginAfter = $userAfter['last_login'];
+        $this->assertNotEmpty($lastLoginAfter);
+        $now = \Cake\I18n\FrozenTime::now();
+        $this->assertEqualsWithDelta($lastLoginAfter->timestamp, $now->timestamp, 2);
     }
 
     /**