From 7739cab6534e0211df495e96b7d4ec34a8582fb4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julius=20H=C3=A4rtl?= Date: Thu, 14 Jul 2022 23:38:09 +0200 Subject: Move to LoggerInterface MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Julius Härtl --- lib/Cron/Cleanup.php | 20 ++++++++------------ lib/Service/ApiService.php | 32 ++++++++++++++++---------------- lib/Service/DocumentService.php | 12 ++++++------ 3 files changed, 30 insertions(+), 34 deletions(-) (limited to 'lib') diff --git a/lib/Cron/Cleanup.php b/lib/Cron/Cleanup.php index 62193a3cd..7faf38888 100644 --- a/lib/Cron/Cleanup.php +++ b/lib/Cron/Cleanup.php @@ -35,25 +35,19 @@ use OCA\Text\Service\ImageService; use OCA\Text\Service\SessionService; use OCP\AppFramework\Utility\ITimeFactory; use OCP\BackgroundJob\TimedJob; -use OCP\ILogger; +use Psr\Log\LoggerInterface; -/** - * Class Cache - * - * @package OCA\Social\Cron - */ class Cleanup extends TimedJob { - private $sessionService; - private $documentService; - private $logger; - private $imageService; - + private SessionService $sessionService; + private DocumentService $documentService; + private LoggerInterface $logger; + private ImageService $imageService; public function __construct(ITimeFactory $time, SessionService $sessionService, DocumentService $documentService, ImageService $imageService, - ILogger $logger) { + LoggerInterface $logger) { parent::__construct($time); $this->sessionService = $sessionService; $this->documentService = $documentService; @@ -81,6 +75,8 @@ class Cleanup extends TimedJob { $this->logger->debug('Resetting document ' . $session->getDocumentId() . ''); } catch (DocumentHasUnsavedChangesException $e) { $this->logger->info('Document ' . $session->getDocumentId() . ' has not been reset, as it has unsaved changes'); + } catch (\Throwable $e) { + $this->logger->error('Document ' . $session->getDocumentId() . ' has not been reset, as an error occured', ['exception' => $e]); } } $removedSessions = $this->sessionService->removeInactiveSessions(null); diff --git a/lib/Service/ApiService.php b/lib/Service/ApiService.php index 4b6b57891..51a824a95 100644 --- a/lib/Service/ApiService.php +++ b/lib/Service/ApiService.php @@ -41,24 +41,24 @@ use OCP\AppFramework\Http\NotFoundResponse; use OCP\Constants; use OCP\Files\Lock\ILock; use OCP\Files\NotFoundException; -use OCP\ILogger; use OCP\IRequest; use OCP\Lock\LockedException; +use Psr\Log\LoggerInterface; class ApiService { - protected $request; - protected $sessionService; - protected $documentService; - protected $logger; - private $imageService; - private $encodingService; + private IRequest $request; + private SessionService $sessionService; + private DocumentService $documentService; + private LoggerInterface $logger; + private ImageService $imageService; + private EncodingService $encodingService; public function __construct(IRequest $request, SessionService $sessionService, DocumentService $documentService, ImageService $imageService, EncodingService $encodingService, - ILogger $logger) { + LoggerInterface $logger) { $this->request = $request; $this->sessionService = $sessionService; $this->documentService = $documentService; @@ -101,7 +101,7 @@ class ApiService { $document = $this->documentService->createDocument($file); } catch (Exception $e) { - $this->logger->logException($e); + $this->logger->error($e->getMessage(), ['exception' => $e]); return new DataResponse('Failed to create the document session', 500); } @@ -112,10 +112,10 @@ class ApiService { $content = $this->encodingService->encodeToUtf8($content); if ($content === null) { - $this->logger->log(ILogger::WARN, 'Failed to encode file to UTF8. File ID: ' . $file->getId()); + $this->logger->warning('Failed to encode file to UTF8. File ID: ' . $file->getId()); } } catch (NotFoundException $e) { - $this->logger->logException($e, ['level' => ILogger::INFO]); + $this->logger->info($e->getMessage(), ['exception' => $e]); $content = null; } @@ -167,7 +167,7 @@ class ApiService { /** * @throws NotFoundException - * @throws \OCP\AppFramework\Db\DoesNotExistException + * @throws DoesNotExistException */ public function push($documentId, $sessionId, $sessionToken, $version, $steps, $token = null): DataResponse { $session = $this->sessionService->getSession($documentId, $sessionId, $sessionToken); @@ -198,12 +198,12 @@ class ApiService { $session = $this->sessionService->getSession($documentId, $sessionId, $sessionToken); $file = $this->documentService->getFileForSession($session, $token); } catch (NotFoundException $e) { - $this->logger->logException($e, ['level' => ILogger::INFO]); + $this->logger->info($e->getMessage(), ['exception' => $e]); return new DataResponse([ 'message' => 'File not found' ], 404); } catch (DoesNotExistException $e) { - $this->logger->logException($e, ['level' => ILogger::INFO]); + $this->logger->info($e->getMessage(), ['exception' => $e]); return new DataResponse([ 'message' => 'Document no longer exists' ], 404); @@ -220,7 +220,7 @@ class ApiService { } catch (NotFoundException $e) { return new DataResponse([], 404); } catch (Exception $e) { - $this->logger->logException($e); + $this->logger->error($e->getMessage(), ['exception' => $e]); return new DataResponse([ 'message' => 'Failed to autosave document' ], 500); @@ -230,7 +230,7 @@ class ApiService { } /** - * @throws \OCP\AppFramework\Db\DoesNotExistException + * @throws DoesNotExistException */ public function updateSession(int $documentId, int $sessionId, string $sessionToken, string $guestName): DataResponse { if (!$this->sessionService->isValidSession($documentId, $sessionId, $sessionToken)) { diff --git a/lib/Service/DocumentService.php b/lib/Service/DocumentService.php index 31ba17629..84f3b1a0b 100644 --- a/lib/Service/DocumentService.php +++ b/lib/Service/DocumentService.php @@ -40,6 +40,7 @@ use OCP\Files\Lock\OwnerLockedException; use OCP\IRequest; use OCP\Lock\ILockingProvider; use OCP\PreConditionNotMetException; +use Psr\Log\LoggerInterface; use function json_encode; use OCA\Text\Db\Document; use OCA\Text\Db\DocumentMapper; @@ -62,7 +63,6 @@ use OCP\Files\NotPermittedException; use OCP\Files\SimpleFS\ISimpleFile; use OCP\ICache; use OCP\ICacheFactory; -use OCP\ILogger; use OCP\Lock\LockedException; use OCP\Share\Exceptions\ShareNotFound; use OCP\Share\IManager as ShareManager; @@ -77,7 +77,7 @@ class DocumentService { private ?string $userId; private DocumentMapper $documentMapper; private SessionMapper $sessionMapper; - private ILogger $logger; + private LoggerInterface $logger; private ShareManager $shareManager; private StepMapper $stepMapper; private IRootFolder $rootFolder; @@ -85,9 +85,9 @@ class DocumentService { private IAppData $appData; private ILockingProvider $lockingProvider; private ILockManager $lockManager; - private $userMountCache; + private IUserMountCache $userMountCache; - public function __construct(DocumentMapper $documentMapper, StepMapper $stepMapper, SessionMapper $sessionMapper, IAppData $appData, $userId, IRootFolder $rootFolder, ICacheFactory $cacheFactory, ILogger $logger, ShareManager $shareManager, IRequest $request, IManager $directManager, ILockingProvider $lockingProvider, ILockManager $lockManager, IUserMountCache $userMountCache) { + public function __construct(DocumentMapper $documentMapper, StepMapper $stepMapper, SessionMapper $sessionMapper, IAppData $appData, $userId, IRootFolder $rootFolder, ICacheFactory $cacheFactory, LoggerInterface $logger, ShareManager $shareManager, IRequest $request, IManager $directManager, ILockingProvider $lockingProvider, ILockManager $lockManager, IUserMountCache $userMountCache) { $this->documentMapper = $documentMapper; $this->stepMapper = $stepMapper; $this->sessionMapper = $sessionMapper; @@ -228,7 +228,7 @@ class DocumentService { throw $e; } catch (\Throwable $e) { if ($document !== null && $oldVersion !== null) { - $this->logger->logException($e, ['message' => 'This should never happen. An error occured when storing the version, trying to recover the last stable one']); + $this->logger->error('This should never happen. An error occurred when storing the version, trying to recover the last stable one', ['exception' => $e]); $document->setCurrentVersion($oldVersion); $this->documentMapper->update($document); $this->cache->set('document-version-' . $document->getId(), $oldVersion); @@ -507,7 +507,7 @@ class DocumentService { $this->appData->newFolder('documents'); } catch (\RuntimeException $e) { // Do not fail hard - $this->logger->logException($e); + $this->logger->error($e->getMessage(), ['exception' => $e]); return false; } -- cgit v1.2.3