Optimize email sending on password reset

Improve performance of sending emails when a user resets a password.

Bug: T247017
Change-Id: I9edb0e4c8845f7a9082035de66f5965c3f9b762d

diff --git a/autoload.php b/autoload.php
index b2147a5..0a95e7f 100644 (file)
--- a/autoload.php
+++ b/autoload.php
@@ -1309,6 +1309,7 @@ $wgAutoloadLocalClasses = [
        'SearchUpdate' => __DIR__ . '/includes/deferred/SearchUpdate.php',
        'SectionProfileCallback' => __DIR__ . '/includes/profiler/SectionProfileCallback.php',
        'SectionProfiler' => __DIR__ . '/includes/profiler/SectionProfiler.php',
+       'SendPasswordResetEmailUpdate' => __DIR__ . '/includes/deferred/SendPasswordResetEmailUpdate.php',
        'SerializedValueContainer' => __DIR__ . '/includes/libs/objectcache/serialized/SerializedValueContainer.php',
        'SevenZipStream' => __DIR__ . '/maintenance/includes/SevenZipStream.php',
        'ShiConverter' => __DIR__ . '/languages/classes/LanguageShi.php',

diff --git a/includes/deferred/SendPasswordResetEmailUpdate.php b/includes/deferred/SendPasswordResetEmailUpdate.php
new file mode 100644 (file)
index 0000000..710f303
--- /dev/null
+++ b/includes/deferred/SendPasswordResetEmailUpdate.php
@@ -0,0 +1,64 @@
+<?php
+/**
+ * Send an email to reset the password
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+use MediaWiki\Auth\AuthManager;
+use MediaWiki\Logger\LoggerFactory;
+
+/**
+ * Sends emails to all accounts associated with that email to reset the password
+ * @since 1.35
+ */
+class SendPasswordResetEmailUpdate implements DeferrableUpdate {
+       /** @var AuthManager */
+       private $authManager;
+
+       /** @var array */
+       private $reqs;
+
+       /** @var array */
+       private $logContext;
+
+       /**
+        * @param AuthManager $authManager
+        * @param array $reqs
+        * @param array $logContext
+        */
+       public function __construct( AuthManager $authManager, array $reqs, array $logContext ) {
+               $this->authManager = $authManager;
+               $this->reqs = $reqs;
+               $this->logContext = $logContext;
+       }
+
+       public function doUpdate() {
+               $logger = LoggerFactory::getInstance( 'authentication' );
+               foreach ( $this->reqs as $req ) {
+                       // This is adding a new temporary password, not intentionally changing anything
+                       // (even though it might technically invalidate an old temporary password).
+                       $this->authManager->changeAuthenticationData( $req, /* $isAddition */ true );
+                       $logger->info(
+                               "{requestingUser} did password reset of {targetUser} and an email was sent",
+                               $this->logContext + [ 'targetUser' => $req->username ]
+                       );
+               }
+       }
+
+}

diff --git a/includes/user/PasswordReset.php b/includes/user/PasswordReset.php
index 25543a6..5491b6c 100644 (file)
--- a/includes/user/PasswordReset.php
+++ b/includes/user/PasswordReset.php
@@ -277,7 +277,6 @@ class PasswordReset implements LoggerAwareInterface {
                        'requestingUser' => $performingUser->getName(),
                        'targetUsername' => $username,
                        'targetEmail' => $email,
-                       'actualUser' => $firstUser->getName(),
                ];
 
                if ( !$result->isGood() ) {
@@ -288,15 +287,9 @@ class PasswordReset implements LoggerAwareInterface {
                        return $result;
                }
 
-               foreach ( $reqs as $req ) {
-                       // This is adding a new temporary password, not intentionally changing anything
-                       // (even though it might technically invalidate an old temporary password).
-                       $this->authManager->changeAuthenticationData( $req, /* $isAddition */ true );
-               }
-
-               $this->logger->info(
-                       "{requestingUser} did password reset of {actualUser}",
-                       $logContext
+               DeferredUpdates::addUpdate(
+                       new SendPasswordResetEmailUpdate( $this->authManager, $reqs, $logContext ),
+                       DeferredUpdates::POSTSEND
                );
 
                return StatusValue::newGood();

diff --git a/tests/phpunit/includes/user/PasswordResetTest.php b/tests/phpunit/includes/user/PasswordResetTest.php
index 7acaa06..351ef54 100644 (file)
--- a/tests/phpunit/includes/user/PasswordResetTest.php
+++ b/tests/phpunit/includes/user/PasswordResetTest.php
@@ -224,6 +224,7 @@ class PasswordResetTest extends MediaWikiTestCase {
         * @param string|null $username
         * @param string|null $email
         * @param User[] $usersWithEmail
+        * @covers SendPasswordResetEmailUpdate
         */
        public function testExecute(
                $expectedError,
@@ -584,6 +585,8 @@ class PasswordResetTest extends MediaWikiTestCase {
                                                ? Status::newGood( $value )
                                                : Status::newFatal( 'rejected by test mock' );
                                } );
+               // changeAuthenticationData is executed in the deferred update class
+               // SendPasswordResetEmailUpdate
                $authManager->expects( $this->exactly( $numUsersToAuth ) )
                        ->method( 'changeAuthenticationData' );