From 0a9371f99f05786068d6f6a72b9a717ec24690a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=B4me=20Chilliet?= Date: Tue, 19 Sep 2023 16:06:40 +0200 Subject: [PATCH] Migrate applications away from deprecated ILogger MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Côme Chilliet --- .../Controller/OCSAuthAPIControllerTest.php | 3 +- apps/federation/tests/TrustedServersTest.php | 5 +- .../DirectEditingViewController.php | 26 ++---- apps/files_trashbin/lib/Storage.php | 6 +- apps/files_trashbin/tests/StorageTest.php | 1 - .../lib/BackgroundJobs/RetryJob.php | 1 - .../lib/Controller/WebAuthnController.php | 29 ++----- .../tests/Controller/UsersControllerTest.php | 3 - apps/theming/lib/ImageManager.php | 35 ++------ apps/theming/tests/ImageManagerTest.php | 11 ++- .../lib/Listener/ActivityPublisher.php | 20 ++--- .../Unit/Listener/ActivityPublisherTest.php | 8 +- .../lib/AppInfo/Application.php | 14 ++-- .../lib/Controller/UserStatusController.php | 36 ++------ .../Controller/UserStatusControllerTest.php | 7 +- .../Controller/WeatherStatusController.php | 25 ++---- .../lib/Service/WeatherStatusService.php | 83 ++++--------------- apps/workflowengine/lib/Entity/File.php | 5 -- apps/workflowengine/lib/Manager.php | 64 +++----------- apps/workflowengine/lib/Service/Logger.php | 21 ++--- apps/workflowengine/tests/ManagerTest.php | 7 +- lib/private/Server.php | 2 +- 22 files changed, 109 insertions(+), 303 deletions(-) diff --git a/apps/federation/tests/Controller/OCSAuthAPIControllerTest.php b/apps/federation/tests/Controller/OCSAuthAPIControllerTest.php index 02e82880f9b98..74d09c6d3630b 100644 --- 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 index 49ee021c02829..5b4e303b26653 100644 --- 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 index 0741b58cfe9d4..b2a9b780b34a1 100644 --- 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 index 31304935c26d8..e1470e7634a5c 100644 --- 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 index 1b9c23f778d91..59bd7e0f5ef53 100644 --- 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 index 39d8118abe71d..d0ad110cf5b9d 100644 --- 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 index 468685816f5b4..59c4d2146b155 100644 --- 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 index 6f0bf01288948..6243b85fb2f52 100644 --- 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 index c987e7f4a9b64..c577e099a961d 100644 --- 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 index e0e00615edbe4..8d42e8924486d 100644 --- 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 index 764787b54008d..dd1fd391b6868 100644 --- 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 index a001a9694ded8..68fb89907f89d 100644 --- 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 index 3290b88dcf9ca..adc16bcb54bde 100644 --- 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; } diff --git a/apps/user_status/lib/Controller/UserStatusController.php b/apps/user_status/lib/Controller/UserStatusController.php index f3757f3835735..321555a45f298 100644 --- a/apps/user_status/lib/Controller/UserStatusController.php +++ b/apps/user_status/lib/Controller/UserStatusController.php @@ -42,41 +42,21 @@ use OCP\AppFramework\OCS\OCSBadRequestException; use OCP\AppFramework\OCS\OCSNotFoundException; use OCP\AppFramework\OCSController; -use OCP\ILogger; use OCP\IRequest; +use Psr\Log\LoggerInterface; /** * @psalm-import-type UserStatusPrivate from ResponseDefinitions */ class UserStatusController extends OCSController { - - /** @var string */ - private $userId; - - /** @var ILogger */ - private $logger; - - /** @var StatusService */ - private $service; - - /** - * StatusesController constructor. - * - * @param string $appName - * @param IRequest $request - * @param string $userId - * @param ILogger $logger; - * @param StatusService $service - */ - public function __construct(string $appName, - IRequest $request, - string $userId, - ILogger $logger, - StatusService $service) { + public function __construct( + string $appName, + IRequest $request, + private string $userId, + private LoggerInterface $logger, + private StatusService $service, + ) { parent::__construct($appName, $request); - $this->userId = $userId; - $this->logger = $logger; - $this->service = $service; } /** diff --git a/apps/user_status/tests/Unit/Controller/UserStatusControllerTest.php b/apps/user_status/tests/Unit/Controller/UserStatusControllerTest.php index ed0919eb9a519..b0cd9ef501e19 100644 --- a/apps/user_status/tests/Unit/Controller/UserStatusControllerTest.php +++ b/apps/user_status/tests/Unit/Controller/UserStatusControllerTest.php @@ -37,14 +37,13 @@ use OCP\AppFramework\Db\DoesNotExistException; use OCP\AppFramework\OCS\OCSBadRequestException; use OCP\AppFramework\OCS\OCSNotFoundException; -use OCP\ILogger; use OCP\IRequest; +use Psr\Log\LoggerInterface; use Test\TestCase; use Throwable; class UserStatusControllerTest extends TestCase { - - /** @var ILogger|\PHPUnit\Framework\MockObject\MockObject */ + /** @var LoggerInterface|\PHPUnit\Framework\MockObject\MockObject */ private $logger; /** @var StatusService|\PHPUnit\Framework\MockObject\MockObject */ @@ -58,7 +57,7 @@ protected function setUp(): void { $request = $this->createMock(IRequest::class); $userId = 'john.doe'; - $this->logger = $this->createMock(ILogger::class); + $this->logger = $this->createMock(LoggerInterface::class); $this->service = $this->createMock(StatusService::class); $this->controller = new UserStatusController('user_status', $request, $userId, $this->logger, $this->service); diff --git a/apps/weather_status/lib/Controller/WeatherStatusController.php b/apps/weather_status/lib/Controller/WeatherStatusController.php index 1a5524967b598..330f1b44e642d 100644 --- a/apps/weather_status/lib/Controller/WeatherStatusController.php +++ b/apps/weather_status/lib/Controller/WeatherStatusController.php @@ -30,32 +30,19 @@ use OCP\AppFramework\Http; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\OCSController; -use OCP\ILogger; use OCP\IRequest; /** * @psalm-import-type WeatherStatusForecast from ResponseDefinitions */ class WeatherStatusController extends OCSController { - - /** @var string */ - private $userId; - - /** @var ILogger */ - private $logger; - - /** @var WeatherStatusService */ - private $service; - - public function __construct(string $appName, - IRequest $request, - ILogger $logger, - WeatherStatusService $service, - ?string $userId) { + public function __construct( + string $appName, + IRequest $request, + private WeatherStatusService $service, + private ?string $userId, + ) { parent::__construct($appName, $request); - $this->userId = $userId; - $this->logger = $logger; - $this->service = $service; } /** diff --git a/apps/weather_status/lib/Service/WeatherStatusService.php b/apps/weather_status/lib/Service/WeatherStatusService.php index d54c7baeb1f08..7358f386151a9 100644 --- a/apps/weather_status/lib/Service/WeatherStatusService.php +++ b/apps/weather_status/lib/Service/WeatherStatusService.php @@ -36,9 +36,8 @@ use OCP\ICacheFactory; use OCP\IConfig; use OCP\IL10N; -use OCP\ILogger; - use OCP\IUserManager; +use Psr\Log\LoggerInterface; /** * Class WeatherStatusService @@ -49,70 +48,22 @@ class WeatherStatusService { public const MODE_BROWSER_LOCATION = 1; public const MODE_MANUAL_LOCATION = 2; - /** @var IClientService */ - private $clientService; - - /** @var IClient */ - private $client; - - /** @var IConfig */ - private $config; - - /** @var IL10N */ - private $l10n; - - /** @var ILogger */ - private $logger; - - /** @var IAccountManager */ - private $accountManager; - - /** @var IUserManager */ - private $userManager; - - /** @var IAppManager */ - private $appManager; - - /** @var ICache */ - private $cache; - - /** @var string */ - private $userId; - - /** @var string */ - private $version; - - /** - * WeatherStatusService constructor - * - * @param IClientService $clientService - * @param IConfig $config - * @param IL10N $l10n - * @param ILogger $logger - * @param IAccountManager $accountManager - * @param IUserManager $userManager - * @param IAppManager $appManager - * @param ICacheFactory $cacheFactory - * @param string $userId - */ - public function __construct(IClientService $clientService, - IConfig $config, - IL10N $l10n, - ILogger $logger, - IAccountManager $accountManager, - IUserManager $userManager, - IAppManager $appManager, - ICacheFactory $cacheFactory, - ?string $userId) { - $this->config = $config; - $this->userId = $userId; - $this->l10n = $l10n; - $this->logger = $logger; - $this->accountManager = $accountManager; - $this->userManager = $userManager; - $this->appManager = $appManager; + private IClient $client; + private ICache $cache; + private string $version; + + public function __construct( + private IClientService $clientService, + private IConfig $config, + private IL10N $l10n, + private LoggerInterface $logger, + private IAccountManager $accountManager, + private IUserManager $userManager, + private IAppManager $appManager, + private ICacheFactory $cacheFactory, + private ?string $userId + ) { $this->version = $appManager->getAppVersion(Application::APP_ID); - $this->clientService = $clientService; $this->client = $clientService->newClient(); $this->cache = $cacheFactory->createDistributed('weatherstatus'); } @@ -438,7 +389,7 @@ private function requestJSON(string $url, array $params = []): array { return $json; } } catch (\Exception $e) { - $this->logger->warning($url . 'API error : ' . $e, ['app' => Application::APP_ID]); + $this->logger->warning($url . ' API error : ' . $e->getMessage(), ['exception' => $e]); return ['error' => $e->getMessage()]; } } diff --git a/apps/workflowengine/lib/Entity/File.php b/apps/workflowengine/lib/Entity/File.php index 3f09fcd24a146..5a2549b1f6591 100644 --- a/apps/workflowengine/lib/Entity/File.php +++ b/apps/workflowengine/lib/Entity/File.php @@ -33,7 +33,6 @@ use OCP\Files\Node; use OCP\Files\NotFoundException; use OCP\IL10N; -use OCP\ILogger; use OCP\IURLGenerator; use OCP\IUser; use OCP\IUserManager; @@ -59,8 +58,6 @@ class File implements IEntity, IDisplayText, IUrl, IIcon, IContextPortation { protected $urlGenerator; /** @var IRootFolder */ protected $root; - /** @var ILogger */ - protected $logger; /** @var string */ protected $eventName; /** @var Event */ @@ -82,7 +79,6 @@ public function __construct( IL10N $l10n, IURLGenerator $urlGenerator, IRootFolder $root, - ILogger $logger, ShareManager $shareManager, IUserSession $userSession, ISystemTagManager $tagManager, @@ -91,7 +87,6 @@ public function __construct( $this->l10n = $l10n; $this->urlGenerator = $urlGenerator; $this->root = $root; - $this->logger = $logger; $this->shareManager = $shareManager; $this->userSession = $userSession; $this->tagManager = $tagManager; diff --git a/apps/workflowengine/lib/Manager.php b/apps/workflowengine/lib/Manager.php index 7d55cff446ee6..28bc4417bb92a 100644 --- a/apps/workflowengine/lib/Manager.php +++ b/apps/workflowengine/lib/Manager.php @@ -48,12 +48,10 @@ use OCP\AppFramework\QueryException; use OCP\DB\QueryBuilder\IQueryBuilder; use OCP\EventDispatcher\IEventDispatcher; -use OCP\Files\Storage\IStorage; use OCP\ICacheFactory; use OCP\IConfig; use OCP\IDBConnection; use OCP\IL10N; -use OCP\ILogger; use OCP\IServerContainer; use OCP\IUserSession; use OCP\WorkflowEngine\Events\RegisterChecksEvent; @@ -66,32 +64,15 @@ use OCP\WorkflowEngine\IManager; use OCP\WorkflowEngine\IOperation; use OCP\WorkflowEngine\IRuleMatcher; +use Psr\Log\LoggerInterface; class Manager implements IManager { - /** @var IStorage */ - protected $storage; - - /** @var string */ - protected $path; - - /** @var object */ - protected $entity; - /** @var array[] */ protected $operations = []; /** @var array[] */ protected $checks = []; - /** @var IDBConnection */ - protected $connection; - - /** @var IServerContainer|\OC\Server */ - protected $container; - - /** @var IL10N */ - protected $l; - /** @var IEntity[] */ protected $registeredEntities = []; @@ -101,41 +82,20 @@ class Manager implements IManager { /** @var ICheck[] */ protected $registeredChecks = []; - /** @var ILogger */ - protected $logger; - /** @var CappedMemoryCache */ protected CappedMemoryCache $operationsByScope; - /** @var IUserSession */ - protected $session; - - /** @var IEventDispatcher */ - private $dispatcher; - - /** @var IConfig */ - private $config; - private ICacheFactory $cacheFactory; - public function __construct( - IDBConnection $connection, - IServerContainer $container, - IL10N $l, - ILogger $logger, - IUserSession $session, - IEventDispatcher $dispatcher, - IConfig $config, - ICacheFactory $cacheFactory, + protected IDBConnection $connection, + protected IServerContainer $container, + protected IL10N $l, + protected LoggerInterface $logger, + protected IUserSession $session, + private IEventDispatcher $dispatcher, + private IConfig $config, + private ICacheFactory $cacheFactory, ) { - $this->connection = $connection; - $this->container = $container; - $this->l = $l; - $this->logger = $logger; $this->operationsByScope = new CappedMemoryCache(64); - $this->session = $session; - $this->dispatcher = $dispatcher; - $this->config = $config; - $this->cacheFactory = $cacheFactory; } public function getRuleMatcher(): IRuleMatcher { @@ -730,7 +690,7 @@ protected function getBuildInEntities(): array { File::class => $this->container->query(File::class), ]; } catch (QueryException $e) { - $this->logger->logException($e); + $this->logger->error($e->getMessage(), ['exception' => $e]); return []; } } @@ -744,7 +704,7 @@ protected function getBuildInOperators(): array { // None yet ]; } catch (QueryException $e) { - $this->logger->logException($e); + $this->logger->error($e->getMessage(), ['exception' => $e]); return []; } } @@ -766,7 +726,7 @@ protected function getBuildInChecks(): array { $this->container->query(UserGroupMembership::class), ]; } catch (QueryException $e) { - $this->logger->logException($e); + $this->logger->error($e->getMessage(), ['exception' => $e]); return []; } } diff --git a/apps/workflowengine/lib/Service/Logger.php b/apps/workflowengine/lib/Service/Logger.php index 6ad7f8c48473d..642b597326416 100644 --- a/apps/workflowengine/lib/Service/Logger.php +++ b/apps/workflowengine/lib/Service/Logger.php @@ -36,24 +36,17 @@ use Psr\Log\LoggerInterface; class Logger { - /** @var ILogger */ - protected $generalLogger; - /** @var LoggerInterface */ - protected $flowLogger; - /** @var IConfig */ - private $config; - /** @var ILogFactory */ - private $logFactory; - - public function __construct(ILogger $generalLogger, IConfig $config, ILogFactory $logFactory) { - $this->generalLogger = $generalLogger; - $this->config = $config; - $this->logFactory = $logFactory; + protected ?LoggerInterface $flowLogger = null; + public function __construct( + protected LoggerInterface $generalLogger, + private IConfig $config, + private ILogFactory $logFactory, + ) { $this->initLogger(); } - protected function initLogger() { + protected function initLogger(): void { $default = $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/flow.log'; $logFile = trim((string)$this->config->getAppValue(Application::APP_ID, 'logfile', $default)); if ($logFile !== '') { diff --git a/apps/workflowengine/tests/ManagerTest.php b/apps/workflowengine/tests/ManagerTest.php index 213daf49415f2..fd95f024acddc 100644 --- a/apps/workflowengine/tests/ManagerTest.php +++ b/apps/workflowengine/tests/ManagerTest.php @@ -39,7 +39,6 @@ use OCP\IConfig; use OCP\IDBConnection; use OCP\IL10N; -use OCP\ILogger; use OCP\IServerContainer; use OCP\IURLGenerator; use OCP\IUserManager; @@ -52,6 +51,7 @@ use OCP\WorkflowEngine\IManager; use OCP\WorkflowEngine\IOperation; use PHPUnit\Framework\MockObject\MockObject; +use Psr\Log\LoggerInterface; use Test\TestCase; /** @@ -65,7 +65,7 @@ class ManagerTest extends TestCase { protected $manager; /** @var MockObject|IDBConnection */ protected $db; - /** @var \PHPUnit\Framework\MockObject\MockObject|ILogger */ + /** @var \PHPUnit\Framework\MockObject\MockObject|LoggerInterface */ protected $logger; /** @var MockObject|IServerContainer */ protected $container; @@ -92,7 +92,7 @@ protected function setUp(): void { return vsprintf($text, $parameters); }); - $this->logger = $this->createMock(ILogger::class); + $this->logger = $this->createMock(LoggerInterface::class); $this->session = $this->createMock(IUserSession::class); $this->dispatcher = $this->createMock(IEventDispatcher::class); $this->config = $this->createMock(IConfig::class); @@ -403,7 +403,6 @@ public function testUpdateOperation() { $this->l, $this->createMock(IURLGenerator::class), $this->createMock(IRootFolder::class), - $this->createMock(ILogger::class), $this->createMock(\OCP\Share\IManager::class), $this->createMock(IUserSession::class), $this->createMock(ISystemTagManager::class), diff --git a/lib/private/Server.php b/lib/private/Server.php index ba8b18f9a05bd..4da92b1db576b 100644 --- a/lib/private/Server.php +++ b/lib/private/Server.php @@ -1168,7 +1168,7 @@ public function __construct($webRoot, \OC\Config $config) { $c->getAppDataDir('theming'), $c->get(IURLGenerator::class), $this->get(ICacheFactory::class), - $this->get(ILogger::class), + $this->get(LoggerInterface::class), $this->get(ITempManager::class) ); return new ThemingDefaults(