Skip to content

Deprecate ILogger in favor of the PSR-3 logger #21875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 20, 2020
Merged

Deprecate ILogger in favor of the PSR-3 logger #21875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a433a7
Deprecate ILogger
ChristophWurst Jul 16, 2020
b3b856c
Migrate contacts interaction to the PSR-3 logger
ChristophWurst Jul 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions apps/contactsinteraction/lib/Listeners/ContactInteractionListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventListener;
use OCP\IL10N;
use OCP\ILogger;
use OCP\IUserManager;
use Psr\Log\LoggerInterface;
use Sabre\VObject\Component\VCard;
use Sabre\VObject\Reader;
use Sabre\VObject\UUIDUtil;
Expand All @@ -57,15 +57,15 @@ class ContactInteractionListener implements IEventListener {
/** @var IL10N */
private $l10n;

/** @var ILogger */
/** @var LoggerInterface */
private $logger;

public function __construct(RecentContactMapper $mapper,
CardSearchDao $cardSearchDao,
IUserManager $userManager,
ITimeFactory $timeFactory,
IL10N $l10nFactory,
ILogger $logger) {
LoggerInterface $logger) {
$this->mapper = $mapper;
$this->cardSearchDao = $cardSearchDao;
$this->userManager = $userManager;
Expand Down Expand Up @@ -125,10 +125,11 @@ public function handle(Event $event): void {
$parsed->CATEGORIES = $this->l10n->t('Recently contacted');
$contact->setCard($parsed->serialize());
} catch (Throwable $e) {
$this->logger->logException($e, [
'message' => 'Could not parse card to add recent category: ' . $e->getMessage(),
'level' => ILogger::WARN,
]);
$this->logger->warning(
'Could not parse card to add recent category: ' . $e->getMessage(),
[
'exception' => $e,
]);
$contact->setCard($copy);
}
} else {
Expand Down
36 changes: 36 additions & 0 deletions lib/private/AppFramework/Logger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@

use OCP\ILogger;

/**
* @deprecated
*/
class Logger implements ILogger {

/** @var ILogger */
Expand All @@ -36,6 +39,9 @@ class Logger implements ILogger {
/** @var string */
private $appName;

/**
* @deprecated
*/
public function __construct(ILogger $logger, string $appName) {
$this->logger = $logger;
$this->appName = $appName;
Expand All @@ -49,42 +55,72 @@ private function extendContext(array $context): array {
return $context;
}

/**
* @deprecated
*/
public function emergency(string $message, array $context = []) {
$this->logger->emergency($message, $this->extendContext($context));
}

/**
* @deprecated
*/
public function alert(string $message, array $context = []) {
$this->logger->alert($message, $this->extendContext($context));
}

/**
* @deprecated
*/
public function critical(string $message, array $context = []) {
$this->logger->critical($message, $this->extendContext($context));
}

/**
* @deprecated
*/
public function error(string $message, array $context = []) {
$this->logger->emergency($message, $this->extendContext($context));
}

/**
* @deprecated
*/
public function warning(string $message, array $context = []) {
$this->logger->warning($message, $this->extendContext($context));
}

/**
* @deprecated
*/
public function notice(string $message, array $context = []) {
$this->logger->notice($message, $this->extendContext($context));
}

/**
* @deprecated
*/
public function info(string $message, array $context = []) {
$this->logger->info($message, $this->extendContext($context));
}

/**
* @deprecated
*/
public function debug(string $message, array $context = []) {
$this->logger->debug($message, $this->extendContext($context));
}

/**
* @deprecated
*/
public function log(int $level, string $message, array $context = []) {
$this->logger->log($level, $message, $this->extendContext($context));
}

/**
* @deprecated
*/
public function logException(\Throwable $exception, array $context = []) {
$this->logger->logException($exception, $this->extendContext($context));
}
Expand Down
16 changes: 16 additions & 0 deletions lib/public/ILogger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,26 +39,32 @@
*
* This logger interface follows the design guidelines of PSR-3
* https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#3-psrlogloggerinterface
* @deprecated 20.0.0 use the PSR-3 logger \Psr\Log\LoggerInterface
*/
interface ILogger {
/**
* @since 14.0.0
* @deprecated 20.0.0
*/
public const DEBUG=0;
/**
* @since 14.0.0
* @deprecated 20.0.0
*/
public const INFO=1;
/**
* @since 14.0.0
* @deprecated 20.0.0
*/
public const WARN=2;
/**
* @since 14.0.0
* @deprecated 20.0.0
*/
public const ERROR=3;
/**
* @since 14.0.0
* @deprecated 20.0.0
*/
public const FATAL=4;

Expand All @@ -69,6 +75,7 @@ interface ILogger {
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::emergency
*/
public function emergency(string $message, array $context = []);

Expand All @@ -79,6 +86,7 @@ public function emergency(string $message, array $context = []);
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::alert
*/
public function alert(string $message, array $context = []);

Expand All @@ -89,6 +97,7 @@ public function alert(string $message, array $context = []);
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::critical
*/
public function critical(string $message, array $context = []);

Expand All @@ -100,6 +109,7 @@ public function critical(string $message, array $context = []);
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::error
*/
public function error(string $message, array $context = []);

Expand All @@ -110,6 +120,7 @@ public function error(string $message, array $context = []);
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::warning
*/
public function warning(string $message, array $context = []);

Expand All @@ -120,6 +131,7 @@ public function warning(string $message, array $context = []);
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::notice
*/
public function notice(string $message, array $context = []);

Expand All @@ -130,6 +142,7 @@ public function notice(string $message, array $context = []);
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::info
*/
public function info(string $message, array $context = []);

Expand All @@ -140,6 +153,7 @@ public function info(string $message, array $context = []);
* @param array $context
* @return null
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::debug
*/
public function debug(string $message, array $context = []);

Expand All @@ -151,6 +165,7 @@ public function debug(string $message, array $context = []);
* @param array $context
* @return mixed
* @since 7.0.0
* @deprecated 20.0.0 use \Psr\Log\LoggerInterface::log
*/
public function log(int $level, string $message, array $context = []);

Expand All @@ -169,6 +184,7 @@ public function log(int $level, string $message, array $context = []);
* @param array $context
* @return void
* @since 8.2.0
* @deprecated 20.0.0 use the `exception` entry in the context of any method in \Psr\Log\LoggerInterface
*/
public function logException(\Throwable $exception, array $context = []);
}