move interface into Api/Data, make it extensible (#22833: Short-term admin accounts)

Author: lfolco

app/code/Magento/Security/Model/UserExpirationInterface.php renamed to app/code/Magento/Security/Api/Data/UserExpirationInterface.php

@@ -6,12 +6,12 @@
 
 declare(strict_types=1);
 
-namespace Magento\Security\Model;
+namespace Magento\Security\Api\Data;
 
 /**
  * Interface UserExpirationInterface to be used as a DTO for expires_at property on User model.
  */
-interface UserExpirationInterface
+interface UserExpirationInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {
 
     public const EXPIRES_AT = 'expires_at';
@@ -47,4 +47,19 @@ public function getUserId();
      * @return $this
      */
     public function setUserId($userId);
+
+    /**
+     * Retrieve existing extension attributes object or create a new one.
+     *
+     * @return \Magento\Security\Api\Data\UserExpirationExtensionInterface|null
+     */
+    public function getExtensionAttributes();
+
+    /**
+     * Set an extension attributes object.
+     *
+     * @param \Magento\Security\Api\Data\UserExpirationExtensionInterface $extensionAttributes
+     * @return $this
+     */
+    public function setExtensionAttributes(\Magento\Security\Api\Data\UserExpirationExtensionInterface $extensionAttributes);
 }

app/code/Magento/Security/Model/Plugin/AdminUserForm.php

@@ -24,7 +24,7 @@ class AdminUserForm
     private $userExpirationResource;
 
     /**
-     * @var \Magento\Security\Model\UserExpirationInterfaceFactory
+     * @var \Magento\Security\Api\Data\UserExpirationInterfaceFactory
      */
     private $userExpirationFactory;
 

app/code/Magento/Security/Model/UserExpiration.php

@@ -7,10 +7,12 @@
 
 namespace Magento\Security\Model;
 
+use Magento\Security\Api\Data\UserExpirationInterface;
+
 /**
  * Admin User Expiration model.
  */
-class UserExpiration extends \Magento\Framework\Model\AbstractModel implements UserExpirationInterface
+class UserExpiration extends \Magento\Framework\Model\AbstractExtensibleModel implements UserExpirationInterface
 {
 
     /**
@@ -64,4 +66,20 @@ public function setUserId($userId)
     {
         return $this->setData(self::USER_ID, $userId);
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getExtensionAttributes()
+    {
+        return $this->_getExtensionAttributes();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function setExtensionAttributes(\Magento\Security\Api\Data\UserExpirationExtensionInterface $extensionAttributes)
+    {
+        return $this->_setExtensionAttributes($extensionAttributes);
+    }
 }

app/code/Magento/Security/Model/UserExpirationManager.php

@@ -134,7 +134,7 @@ private function processExpiredUsers(ExpiredUsersCollection $expiredRecords): vo
     public function isUserExpired(string $userId): bool
     {
         $isExpired = false;
-        /** @var \Magento\Security\Model\UserExpirationInterface $expiredRecord */
+        /** @var \Magento\Security\Api\Data\UserExpirationInterface $expiredRecord */
         $expiredRecord = $this->userExpirationCollectionFactory->create()
             ->addExpiredRecordsForUserFilter($userId)
             ->getFirstItem();

app/code/Magento/Security/Test/Unit/Observer/AdminUserAuthenticateBeforeTest.php

@@ -48,7 +48,7 @@ class AdminUserAuthenticateBeforeTest extends \PHPUnit\Framework\TestCase
     private $eventMock;
 
     /**
-     * @var \PHPUnit\Framework\MockObject\MockObject|\Magento\Security\Model\UserExpirationInterface
+     * @var \PHPUnit\Framework\MockObject\MockObject|\Magento\Security\Api\Data\UserExpirationInterface
      */
     private $userExpirationMock;
 
@@ -77,8 +77,15 @@ protected function setUp()
         $this->eventObserverMock = $this->createPartialMock(\Magento\Framework\Event\Observer::class, ['getEvent']);
         $this->eventMock = $this->createPartialMock(\Magento\Framework\Event::class, ['getUsername']);
         $this->userExpirationMock = $this->createPartialMock(
-            \Magento\Security\Model\UserExpirationInterface::class,
-            ['getUserId', 'getExpiresAt', 'setUserId', 'setExpiresAt']
+            \Magento\Security\Api\Data\UserExpirationInterface::class,
+            [
+                'getUserId',
+                'getExpiresAt',
+                'setUserId',
+                'setExpiresAt',
+                'getExtensionAttributes',
+                'setExtensionAttributes'
+            ]
         );
     }
 

app/code/Magento/Security/etc/di.xml

@@ -18,5 +18,5 @@
             </argument>
         </arguments>
     </type>
-    <preference for="Magento\Security\Model\UserExpirationInterface" type="Magento\Security\Model\UserExpiration"/>
+    <preference for="Magento\Security\Api\Data\UserExpirationInterface" type="Magento\Security\Model\UserExpiration"/>
 </config>

dev/tests/integration/testsuite/Magento/Security/Model/Plugin/AuthSessionTest.php

@@ -160,8 +160,8 @@ public function testProcessProlongWithExpiredUser()
         $user = $this->objectManager->create(\Magento\User\Model\User::class);
         $user->loadByUsername(\Magento\TestFramework\Bootstrap::ADMIN_NAME);
         $userExpirationFactory =
-            $this->objectManager->create(\Magento\Security\Model\UserExpirationInterfaceFactory::class);
-        /** @var \Magento\Security\Model\UserExpirationInterface $userExpiration */
+            $this->objectManager->create(\Magento\Security\Api\Data\UserExpirationInterfaceFactory::class);
+        /** @var \Magento\Security\Api\Data\UserExpirationInterface $userExpiration */
         $userExpiration = $userExpirationFactory->create();
         $userExpiration->setId($user->getId())
             ->setExpiresAt($expireDate->format('Y-m-d H:i:s'))

dev/tests/integration/testsuite/Magento/Security/Model/UserExpirationManagerTest.php

@@ -156,8 +156,8 @@ private function expireUser(\Magento\User\Model\User $user)
     {
         $expireDate = new \DateTime();
         $expireDate->modify('-10 days');
-        /** @var \Magento\Security\Model\UserExpirationInterface $userExpiration */
-        $userExpiration = $this->objectManager->create(\Magento\Security\Model\UserExpirationInterface::class);
+        /** @var \Magento\Security\Api\Data\UserExpirationInterface $userExpiration */
+        $userExpiration = $this->objectManager->create(\Magento\Security\Api\Data\UserExpirationInterface::class);
         $userExpiration->setId($user->getId())
             ->setExpiresAt($expireDate->format('Y-m-d H:i:s'))
             ->save();