Merge pull request #56934 from nextcloud/backport/56862/stable31

[stable31] fix(settings): Improve mail test error handling and logging

Author: szaimen

apps/settings/css/settings.css

@@ -890,3 +890,12 @@ doesnotexist:-o-prefocus, .strengthify-wrapper {
     opacity: 1;
   }
 }
+
+#sendtestmail_msg {
+	&.error {
+		display: inline-block;
+		margin-top: 5px;
+		border-radius: var(--border-radius);
+		padding: 5px 10px;
+	}
+}

apps/settings/css/settings.css.map

@@ -18,6 +18,7 @@
 use OCP\IURLGenerator;
 use OCP\IUserSession;
 use OCP\Mail\IMailer;
+use Psr\Log\LoggerInterface;
 
 class MailSettingsController extends Controller {
 
@@ -38,6 +39,7 @@ public function __construct(
 		private IUserSession $userSession,
 		private IURLGenerator $urlGenerator,
 		private IMailer $mailer,
+		private LoggerInterface $logger,
 	) {
 		parent::__construct($appName, $request);
 	}
@@ -144,11 +146,13 @@ public function sendTestMail() {
 				return new DataResponse();
 			} catch (\Exception $e) {
 				$this->config->setAppValue('core', 'emailTestSuccessful', '0');
+				$this->logger->error('Failed sending test email: ' . $e->getMessage(), ['exception' => $e]);
 				return new DataResponse($this->l10n->t('A problem occurred while sending the email. Please revise your settings. (Error: %s)', [$e->getMessage()]), Http::STATUS_BAD_REQUEST);
 			}
 		}
 
 		$this->config->setAppValue('core', 'emailTestSuccessful', '0');
+		$this->logger->error('Failed sending test email: User ' . $this->userSession->getUser()->getUID() . ' has no email address configured in their account settings');
 		return new DataResponse($this->l10n->t('You need to set your account email before being able to send test emails. Go to %s for that.', [$this->urlGenerator->linkToRouteAbsolute('settings.PersonalSettings.index')]), Http::STATUS_BAD_REQUEST);
 	}
 }

apps/settings/css/settings.scss

@@ -89,7 +89,7 @@ window.addEventListener('DOMContentLoaded', () => {
 			.then(() => {
 				OC.msg.finishedSuccess('#sendtestmail_msg', t('settings', 'Email sent'))
 			}).catch((error) => {
-				OC.msg.finishedError('#sendtestmail_msg', error)
+				OC.msg.finishedError('#sendtestmail_msg', error.response.data)
 			})
 	})
 

apps/settings/lib/Controller/MailSettingsController.php

@@ -16,6 +16,7 @@
 use OCP\IUserSession;
 use OCP\Mail\IEMailTemplate;
 use OCP\Mail\IMailer;
+use Psr\Log\LoggerInterface;
 
 /**
  * @package Tests\Settings\Controller
@@ -32,6 +33,8 @@ class MailSettingsControllerTest extends \Test\TestCase {
 	private $l;
 	/** @var IURLGenerator */
 	private $urlGenerator;
+	/** @var LoggerInterface|\PHPUnit\Framework\MockObject\MockObject */
+	private $logger;
 
 	/** @var MailSettingsController */
 	private $mailController;
@@ -44,6 +47,7 @@ protected function setUp(): void {
 		$this->userSession = $this->createMock(IUserSession::class);
 		$this->mailer = $this->createMock(IMailer::class);
 		$this->urlGenerator = $this->createMock(IURLGenerator::class);
+		$this->logger = $this->createMock(LoggerInterface::class);
 		/** @var IRequest|\PHPUnit\Framework\MockObject\MockObject $request */
 		$request = $this->createMock(IRequest::class);
 		$this->mailController = new MailSettingsController(
@@ -54,6 +58,7 @@ protected function setUp(): void {
 			$this->userSession,
 			$this->urlGenerator,
 			$this->mailer,
+			$this->logger,
 			'[email protected]'
 		);
 	}