Migrate applications away from deprecated ILogger

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
nextcloud · Sep 21, 2023 · 0a9371f · 0a9371f
1 parent b6761fb
commit 0a9371f
Show file tree

Hide file tree

Showing 22 changed files with 109 additions and 303 deletions.
diff --git a/apps/federation/tests/Controller/OCSAuthAPIControllerTest.php b/apps/federation/tests/Controller/OCSAuthAPIControllerTest.php
@@ -38,7 +38,6 @@
 use Test\TestCase;
 
 class OCSAuthAPIControllerTest extends TestCase {
-
 	/** @var \PHPUnit\Framework\MockObject\MockObject|IRequest */
 	private $request;
 
@@ -54,7 +53,7 @@ class OCSAuthAPIControllerTest extends TestCase {
 	/** @var \PHPUnit\Framework\MockObject\MockObject|DbHandler */
 	private $dbHandler;
 
-	/** @var \PHPUnit\Framework\MockObject\MockObject|ILogger */
+	/** @var \PHPUnit\Framework\MockObject\MockObject|LoggerInterface */
 	private $logger;
 
 	/** @var \PHPUnit\Framework\MockObject\MockObject|ITimeFactory */

diff --git a/apps/federation/tests/TrustedServersTest.php b/apps/federation/tests/TrustedServersTest.php
@@ -41,7 +41,6 @@
 use Psr\Log\LoggerInterface;
 
 class TrustedServersTest extends TestCase {
-
 	/** @var \PHPUnit\Framework\MockObject\MockObject | TrustedServers */
 	private $trustedServers;
 
@@ -57,7 +56,7 @@ class TrustedServersTest extends TestCase {
 	/** @var  \PHPUnit\Framework\MockObject\MockObject | IResponse */
 	private $response;
 
-	/** @var  \PHPUnit\Framework\MockObject\MockObject | ILogger */
+	/** @var  \PHPUnit\Framework\MockObject\MockObject | LoggerInterface */
 	private $logger;
 
 	/** @var  \PHPUnit\Framework\MockObject\MockObject | IJobList */
@@ -132,7 +131,7 @@ public function testAddServer(): void {
 		$this->dbHandler->expects($this->once())->method('addToken')->with('https://url', 'token');
 		$this->jobList->expects($this->once())->method('add')
 			->with('OCA\Federation\BackgroundJob\RequestSharedSecret',
-					['url' => 'https://url', 'token' => 'token', 'created' => 1234567]);
+				['url' => 'https://url', 'token' => 'token', 'created' => 1234567]);
 
 		$this->assertSame(
 			$trustedServers->addServer('url'),

diff --git a/apps/files/lib/Controller/DirectEditingViewController.php b/apps/files/lib/Controller/DirectEditingViewController.php
@@ -30,27 +30,19 @@
 use OCP\DirectEditing\IManager;
 use OCP\DirectEditing\RegisterDirectEditorEvent;
 use OCP\EventDispatcher\IEventDispatcher;
-use OCP\ILogger;
 use OCP\IRequest;
+use Psr\Log\LoggerInterface;
 
 #[IgnoreOpenAPI]
 class DirectEditingViewController extends Controller {
-
-	/** @var IEventDispatcher */
-	private $eventDispatcher;
-
-	/** @var IManager */
-	private $directEditingManager;
-
-	/** @var ILogger */
-	private $logger;
-
-	public function __construct($appName, IRequest $request, IEventDispatcher $eventDispatcher, IManager $manager, ILogger $logger) {
+	public function __construct(
+		$appName,
+		IRequest $request,
+		private IEventDispatcher $eventDispatcher,
+		private IManager $directEditingManager,
+		private LoggerInterface $logger,
+	) {
 		parent::__construct($appName, $request);
-
-		$this->eventDispatcher = $eventDispatcher;
-		$this->directEditingManager = $manager;
-		$this->logger = $logger;
 	}
 
 	/**
@@ -66,7 +58,7 @@ public function edit(string $token): Response {
 		try {
 			return $this->directEditingManager->edit($token);
 		} catch (Exception $e) {
-			$this->logger->logException($e);
+			$this->logger->error($e->getMessage(), ['exception' => $e]);
 			return new NotFoundResponse();
 		}
 	}

diff --git a/apps/files_trashbin/lib/Storage.php b/apps/files_trashbin/lib/Storage.php
@@ -35,16 +35,14 @@
 use OCP\Encryption\Exceptions\GenericEncryptionException;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\IRootFolder;
-use OCP\Files\Mount\IMountPoint;
 use OCP\Files\Node;
 use OCP\Files\Storage\IStorage;
-use OCP\ILogger;
 use OCP\IUserManager;
 use Psr\Log\LoggerInterface;
 
 class Storage extends Wrapper {
 	private string $mountPoint;
-	private  IUserManager$userManager;
+	private IUserManager$userManager;
 	private LoggerInterface $logger;
 	private IEventDispatcher $eventDispatcher;
 	private IRootFolder $rootFolder;
@@ -218,7 +216,7 @@ function (string $mountPoint, IStorage $storage) use ($trashManager, $userManage
 					$rootFolder,
 				);
 			},
-		1);
+			1);
 	}
 
 	public function getMountPoint() {

diff --git a/apps/files_trashbin/tests/StorageTest.php b/apps/files_trashbin/tests/StorageTest.php
@@ -47,7 +47,6 @@
 use OCP\Files\IRootFolder;
 use OCP\Files\Node;
 use OCP\Files\Storage\IStorage;
-use OCP\ILogger;
 use OCP\IUserManager;
 use OCP\Lock\ILockingProvider;
 use OCP\Share\IShare;

diff --git a/apps/lookup_server_connector/lib/BackgroundJobs/RetryJob.php b/apps/lookup_server_connector/lib/BackgroundJobs/RetryJob.php
@@ -39,7 +39,6 @@
 use OCP\BackgroundJob\Job;
 use OCP\Http\Client\IClientService;
 use OCP\IConfig;
-use OCP\ILogger;
 use OCP\IUser;
 use OCP\IUserManager;
 

diff --git a/apps/settings/lib/Controller/WebAuthnController.php b/apps/settings/lib/Controller/WebAuthnController.php
@@ -33,37 +33,24 @@
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI;
 use OCP\AppFramework\Http\JSONResponse;
-use OCP\ILogger;
 use OCP\IRequest;
 use OCP\ISession;
 use OCP\IUserSession;
+use Psr\Log\LoggerInterface;
 use Webauthn\PublicKeyCredentialCreationOptions;
 
 #[IgnoreOpenAPI]
 class WebAuthnController extends Controller {
 	private const WEBAUTHN_REGISTRATION = 'webauthn_registration';
 
-	/** @var Manager */
-	private $manager;
-
-	/** @var IUserSession */
-	private $userSession;
-	/**
-	 * @var ISession
-	 */
-	private $session;
-	/**
-	 * @var ILogger
-	 */
-	private $logger;
-
-	public function __construct(IRequest $request, ILogger $logger, Manager $webAuthnManager, IUserSession $userSession, ISession $session) {
+	public function __construct(
+		IRequest $request,
+		private LoggerInterface $logger,
+		private Manager $manager,
+		private IUserSession $userSession,
+		private ISession $session,
+	) {
 		parent::__construct(Application::APP_ID, $request);
-
-		$this->manager = $webAuthnManager;
-		$this->userSession = $userSession;
-		$this->session = $session;
-		$this->logger = $logger;
 	}
 
 	/**

diff --git a/apps/settings/tests/Controller/UsersControllerTest.php b/apps/settings/tests/Controller/UsersControllerTest.php
@@ -50,7 +50,6 @@
 use OCP\IConfig;
 use OCP\IGroupManager;
 use OCP\IL10N;
-use OCP\ILogger;
 use OCP\IRequest;
 use OCP\IUser;
 use OCP\IUserManager;
@@ -74,8 +73,6 @@ class UsersControllerTest extends \Test\TestCase {
 	private $userSession;
 	/** @var IConfig|\PHPUnit\Framework\MockObject\MockObject */
 	private $config;
-	/** @var ILogger|\PHPUnit\Framework\MockObject\MockObject */
-	private $logger;
 	/** @var IMailer|\PHPUnit\Framework\MockObject\MockObject */
 	private $mailer;
 	/** @var IFactory|\PHPUnit\Framework\MockObject\MockObject */

diff --git a/apps/theming/lib/ImageManager.php b/apps/theming/lib/ImageManager.php
@@ -42,38 +42,21 @@
 use OCP\Files\SimpleFS\ISimpleFolder;
 use OCP\ICacheFactory;
 use OCP\IConfig;
-use OCP\ILogger;
 use OCP\ITempManager;
 use OCP\IURLGenerator;
+use Psr\Log\LoggerInterface;
 
 class ImageManager {
 	public const SUPPORTED_IMAGE_KEYS = ['background', 'logo', 'logoheader', 'favicon'];
 
-	/** @var IConfig */
-	private $config;
-	/** @var IAppData */
-	private $appData;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var ICacheFactory */
-	private $cacheFactory;
-	/** @var ILogger */
-	private $logger;
-	/** @var ITempManager */
-	private $tempManager;
-
-	public function __construct(IConfig $config,
-								IAppData $appData,
-								IURLGenerator $urlGenerator,
-								ICacheFactory $cacheFactory,
-								ILogger $logger,
-								ITempManager $tempManager) {
-		$this->config = $config;
-		$this->urlGenerator = $urlGenerator;
-		$this->cacheFactory = $cacheFactory;
-		$this->logger = $logger;
-		$this->tempManager = $tempManager;
-		$this->appData = $appData;
+	public function __construct(
+		private IConfig $config,
+		private IAppData $appData,
+		private IURLGenerator $urlGenerator,
+		private ICacheFactory $cacheFactory,
+		private LoggerInterface $logger,
+		private ITempManager $tempManager,
+	) {
 	}
 
 	/**

diff --git a/apps/theming/tests/ImageManagerTest.php b/apps/theming/tests/ImageManagerTest.php
@@ -34,14 +34,13 @@
 use OCP\Files\SimpleFS\ISimpleFolder;
 use OCP\ICacheFactory;
 use OCP\IConfig;
-use OCP\ILogger;
 use OCP\ITempManager;
 use OCP\IURLGenerator;
 use PHPUnit\Framework\MockObject\MockObject;
+use Psr\Log\LoggerInterface;
 use Test\TestCase;
 
 class ImageManagerTest extends TestCase {
-
 	/** @var IConfig|MockObject */
 	protected $config;
 	/** @var IAppData|MockObject */
@@ -52,7 +51,7 @@ class ImageManagerTest extends TestCase {
 	private $urlGenerator;
 	/** @var ICacheFactory|MockObject */
 	private $cacheFactory;
-	/** @var ILogger|MockObject */
+	/** @var LoggerInterface|MockObject */
 	private $logger;
 	/** @var ITempManager|MockObject */
 	private $tempManager;
@@ -65,7 +64,7 @@ protected function setUp(): void {
 		$this->appData = $this->createMock(IAppData::class);
 		$this->urlGenerator = $this->createMock(IURLGenerator::class);
 		$this->cacheFactory = $this->createMock(ICacheFactory::class);
-		$this->logger = $this->createMock(ILogger::class);
+		$this->logger = $this->createMock(LoggerInterface::class);
 		$this->tempManager = $this->createMock(ITempManager::class);
 		$this->rootFolder = $this->createMock(ISimpleFolder::class);
 		$this->imageManager = new ImageManager(
@@ -143,7 +142,7 @@ public function testGetImageUrl() {
 			->withConsecutive(
 				['theming', 'cachebuster', '0'],
 				['theming', 'logoMime', '']
-				)
+			)
 			->willReturn(0);
 		$this->urlGenerator->expects($this->once())
 			->method('linkToRoute')
@@ -322,7 +321,7 @@ public function testCleanup() {
 		$folders[2]->expects($this->never())->method('delete');
 		$this->config->expects($this->once())
 			->method('getAppValue')
-			->with('theming','cachebuster','0')
+			->with('theming', 'cachebuster', '0')
 			->willReturn('2');
 		$this->rootFolder->expects($this->once())
 			->method('getDirectoryListing')

diff --git a/apps/twofactor_backupcodes/lib/Listener/ActivityPublisher.php b/apps/twofactor_backupcodes/lib/Listener/ActivityPublisher.php
@@ -30,20 +30,13 @@
 use OCP\Activity\IManager;
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
-use OCP\ILogger;
+use Psr\Log\LoggerInterface;
 
 class ActivityPublisher implements IEventListener {
-
-	/** @var IManager */
-	private $activityManager;
-
-	/** @var ILogger */
-	private $logger;
-
-	public function __construct(IManager $activityManager,
-								ILogger $logger) {
-		$this->activityManager = $activityManager;
-		$this->logger = $logger;
+	public function __construct(
+		private IManager $activityManager,
+		private LoggerInterface $logger,
+	) {
 	}
 
 	/**
@@ -60,8 +53,7 @@ public function handle(Event $event): void {
 			try {
 				$this->activityManager->publish($activity);
 			} catch (BadMethodCallException $e) {
-				$this->logger->warning('could not publish backup code creation activity', ['app' => 'twofactor_backupcodes']);
-				$this->logger->logException($e, ['app' => 'twofactor_backupcodes']);
+				$this->logger->error('Could not publish backup code creation activity', ['exception' => $e]);
 			}
 		}
 	}

diff --git a/apps/twofactor_backupcodes/tests/Unit/Listener/ActivityPublisherTest.php b/apps/twofactor_backupcodes/tests/Unit/Listener/ActivityPublisherTest.php
@@ -32,18 +32,16 @@
 use OCP\Activity\IEvent;
 use OCP\Activity\IManager;
 use OCP\EventDispatcher\Event;
-use OCP\ILogger;
 use OCP\IUser;
 use PHPUnit\Framework\MockObject\MockObject;
+use Psr\Log\LoggerInterface;
 use Test\TestCase;
 
 class ActivityPublisherTest extends TestCase {
-
 	/** @var IManager|MockObject */
 	private $activityManager;
 
-	/** @var ILogger */
-
+	/** @var LoggerInterface */
 	private $logger;
 
 	/** @var ActivityPublisher */
@@ -53,7 +51,7 @@ protected function setUp(): void {
 		parent::setUp();
 
 		$this->activityManager = $this->createMock(IManager::class);
-		$this->logger = $this->createMock(ILogger::class);
+		$this->logger = $this->createMock(LoggerInterface::class);
 
 		$this->listener = new ActivityPublisher($this->activityManager, $this->logger);
 	}

diff --git a/apps/updatenotification/lib/AppInfo/Application.php b/apps/updatenotification/lib/AppInfo/Application.php
@@ -40,10 +40,10 @@
 use OCP\AppFramework\QueryException;
 use OCP\IConfig;
 use OCP\IGroupManager;
-use OCP\ILogger;
 use OCP\IUser;
 use OCP\IUserSession;
 use OCP\Util;
+use Psr\Log\LoggerInterface;
 
 class Application extends App implements IBootstrap {
 	public function __construct() {
@@ -56,11 +56,11 @@ public function register(IRegistrationContext $context): void {
 
 	public function boot(IBootContext $context): void {
 		$context->injectFn(function (IConfig $config,
-									 IUserSession $userSession,
-									 IAppManager $appManager,
-									 IGroupManager $groupManager,
-									 IAppContainer $appContainer,
-									 ILogger $logger) {
+			IUserSession $userSession,
+			IAppManager $appManager,
+			IGroupManager $groupManager,
+			IAppContainer $appContainer,
+			LoggerInterface $logger) {
 			if ($config->getSystemValue('updatechecker', true) !== true) {
 				// Updater check is disabled
 				return;
@@ -77,7 +77,7 @@ public function boot(IBootContext $context): void {
 				try {
 					$updateChecker = $appContainer->get(UpdateChecker::class);
 				} catch (QueryException $e) {
-					$logger->logException($e);
+					$logger->error($e->getMessage(), ['exception' => $e]);
 					return;
 				}