What are the Slack Archives?

It’s a history of our time together in the Slack Community! There’s a ton of knowledge in here, so feel free to search through the archives for a possible answer to your question.

Because this space is not active, you won’t be able to create a new post or comment here. If you have a question or want to start a discussion about something, head over to our categories and pick one to post in! You can always refer back to a post from Slack Archives if needed; just copy the link to use it as a reference..

I am wondering why the `LoggerTrait::getLogguer()` says that it can return a null 🤔

Chemaclass
Chemaclass Tech Lead Spryker Solution Partner Posts: 213 🧑🏻‍🚀 - Cadet
edited April 2021 in Slack General

I am wondering why the LoggerTrait::getLogguer() says that it can return a null 🤔
https://github.com/spryker/log/blob/master/src/Spryker/Shared/Log/LoggerTrait.php#L17

/**
 * @return \Psr\Log\LoggerInterface|null 👈👈👈👈👈👈👈👈👈👈
 */
protected function getLogger(?LoggerConfigInterface $loggerConfig = null)
{
    return LoggerFactory::getInstance($loggerConfig);
}

when inside the LoggerFactory you are actually creating a logger in case it doesn’t exist (see: createInstanceIfNotExists)
https://github.com/spryker/log/blob/ad13572ac0b671bebfd64a41216719e52e7cf703/src/Spryker/Shared/Log/LoggerFactory.php#L33

/**
 * @return \Psr\Log\LoggerInterface|null 👈👈👈👈👈👈👈👈👈👈
 */
public static function getInstance(?LoggerConfigInterface $loggerConfig = null)
{
    if ($loggerConfig === null) {
        if (!static::$loggerConfig) {
            static::$loggerConfig = static::createLoggerConfig();
        }

        $loggerConfig = static::$loggerConfig;
    }

    return static::createInstanceIfNotExists($loggerConfig); 👈👈👈👈👈👈👈👈👈👈
}

And that function explicitly says (in its PHPDoc) that it wont return a null:
https://github.com/spryker/log/blob/ad13572ac0b671bebfd64a41216719e52e7cf703/src/Spryker/Shared/Log/LoggerFactory.php#L51

/**
 * @return \Psr\Log\LoggerInterface 👈👈👈👈👈👈👈👈👈👈
 */
protected static function createInstanceIfNotExists(LoggerConfigInterface $loggerConfig)
{
    $channelName = $loggerConfig->getChannelName();

    if (!isset(static::$loggers[$channelName])) {
        $logger = new MonologLogger($channelName, $loggerConfig->getHandlers(), $loggerConfig->getProcessors());

        static::$loggers[$channelName] = $logger;
    }

    return static::$loggers[$channelName];
}

========================

Why I am saying this is because PHPStan level 8 is actually complaining about this, and it does makes sense that it complains about it, because the types signature are not correct. Am I missing something here or is it just wrong?

I wanted to create a PR to fix this but the repo is [READ ONLY] Subtree split of the Log module.… so I guess I can’t.

Comments

Categories