Skip to content

Commit 50d9108

Browse files
shiftedrealityshiftedreality
authored
ACMP-1263: Update Monolog (#66)
1 parent 927a565 commit 50d9108

17 files changed

+223
-298
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@
88
/auth.json
99
/codeception.yml
1010
/_workdir
11+
/*.code-workspace

‎composer.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "magento/ece-tools",
33
"description": "Provides tools to build and deploy Magento 2 Enterprise Edition",
44
"type": "magento2-component",
5-
"version": "2002.1.7",
5+
"version": "2002.1.8",
66
"license": "OSL-3.0",
77
"repositories": {
88
"repo.magento.com": {
@@ -16,7 +16,7 @@
1616
"ext-json": "*",
1717
"ext-sockets": "*",
1818
"colinmollenhour/credis": "^1.6.0",
19-
"composer/composer": "^1.4||^2.0",
19+
"composer/composer": "^1.4 || ^2.0",
2020
"composer/semver": "@stable",
2121
"graylog2/gelf-php": "^1.4.2",
2222
"guzzlehttp/guzzle": "^6.2",
@@ -25,16 +25,16 @@
2525
"magento/magento-cloud-docker": "^1.0.0",
2626
"magento/magento-cloud-patches": "^1.0.11",
2727
"magento/quality-patches": "^1.1.0",
28-
"monolog/monolog": "^1.16",
29-
"nesbot/carbon": "^1.0||^2.0",
28+
"monolog/monolog": "^1.25 || ^2.3",
29+
"nesbot/carbon": "^1.0 || ^2.0",
3030
"psr/container": "^1.0",
3131
"psr/log": "^1.0",
3232
"symfony/config": "^4.4",
33-
"symfony/console": "^2.8||^4.0",
34-
"symfony/dependency-injection": "^3.3||^4.3",
35-
"symfony/process": "^2.1||^4.1",
36-
"symfony/serializer": "^2.8||^3.3||^4.0",
37-
"symfony/yaml": "^3.3||^4.0"
33+
"symfony/console": "^2.8 || ^4.0",
34+
"symfony/dependency-injection": "^3.3 || ^4.3",
35+
"symfony/process": "^2.1 || ^4.1",
36+
"symfony/serializer": "^2.8 || ^3.3 || ^4.0",
37+
"symfony/yaml": "^3.3 || ^4.0"
3838
},
3939
"require-dev": {
4040
"codeception/codeception": "^2.5.3",

‎src/App/Logger/Formatter/JsonErrorFormatter.php

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class JsonErrorFormatter extends JsonFormatter
3030
/**
3131
* @param ErrorInfo $errorInfo
3232
* @param ReaderInterface $reader
33-
* @param int $batchMode
33+
* @param 1|2 $batchMode
3434
* @param bool $appendNewline
3535
*/
3636
public function __construct(
@@ -50,22 +50,22 @@ public function __construct(
5050
*
5151
* {@inheritDoc}
5252
*/
53-
public function format(array $record)
53+
public function format(array $record): string
5454
{
5555
try {
5656
if (!isset($record['context']['errorCode'])) {
57-
return false;
57+
return '';
5858
}
5959

6060
$loggedErrors = $this->reader->read();
6161

6262
if (isset($loggedErrors[$record['context']['errorCode']])) {
63-
return false;
63+
return '';
6464
}
6565

6666
return parent::format($this->formatLog($record));
67-
} catch (\Exception $e) {
68-
return false;
67+
} catch (\Exception $exception) {
68+
return '';
6969
}
7070
}
7171

@@ -98,6 +98,7 @@ private function formatLog(array $record): array
9898
}
9999

100100
ksort($errorInfo);
101+
101102
return $errorInfo;
102103
}
103104
}

‎src/App/Logger/Formatter/LineFormatter.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class LineFormatter extends \Monolog\Formatter\LineFormatter
2020
/**
2121
* @inheritDoc
2222
*/
23-
public function format(array $record)
23+
public function format(array $record): string
2424
{
2525
$errorLevels = [
2626
Logger::getLevelName(Logger::WARNING),

‎src/App/Logger/Gelf/Handler.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class Handler extends GelfHandler
2121
* @param array $record
2222
* @codeCoverageIgnore
2323
*/
24-
protected function write(array $record)
24+
protected function write(array $record): void
2525
{
2626
try {
2727
parent::write($record);

‎src/App/Logger/Gelf/HandlerFactory.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ public function __construct(TransportFactory $transportFactory)
3333
* Creates instance of Gelf handler.
3434
*
3535
* @param Repository $configuration
36-
* @param int $minLevel
36+
* @param mixed $minLevel
3737
* @return Handler
3838
* @throws LoggerException
3939
*/
40-
public function create(Repository $configuration, int $minLevel): Handler
40+
public function create(Repository $configuration, $minLevel): Handler
4141
{
4242
$this->increaseSocketTimeout();
4343

‎src/App/Logger/Gelf/MessageFormatter.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
namespace Magento\MagentoCloud\App\Logger\Gelf;
99

1010
use Monolog\Formatter\GelfMessageFormatter;
11+
use Gelf\Message;
1112

1213
/**
1314
* Extends functionality of GelfMessageFormatter.
@@ -33,7 +34,7 @@ public function setAdditional(array $additional)
3334
/**
3435
* @inheritdoc
3536
*/
36-
public function format(array $record)
37+
public function format(array $record): Message
3738
{
3839
$message = parent::format($record);
3940

‎src/App/Logger/HandlerFactory.php

Lines changed: 117 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,36 @@
77

88
namespace Magento\MagentoCloud\App\Logger;
99

10-
use Illuminate\Contracts\Config\Repository;
1110
use Magento\MagentoCloud\App\Logger\Gelf\HandlerFactory as GelfHandlerFactory;
11+
use Magento\MagentoCloud\App\LoggerException;
12+
use Magento\MagentoCloud\Config\ConfigException;
1213
use Magento\MagentoCloud\Config\GlobalSection;
1314
use Magento\MagentoCloud\Config\Log as LogConfig;
14-
use Monolog\Handler\HandlerInterface;
15+
use Monolog\Handler\AbstractProcessingHandler;
1516
use Monolog\Handler\NativeMailerHandler;
1617
use Monolog\Handler\SlackHandler;
1718
use Monolog\Handler\StreamHandler;
1819
use Monolog\Handler\SyslogHandler;
1920
use Monolog\Handler\SyslogUdpHandler;
21+
use Monolog\Logger;
2022

2123
/**
2224
* The handler factory.
25+
*
26+
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
2327
*/
2428
class HandlerFactory
2529
{
26-
const HANDLER_STREAM = 'stream';
27-
const HANDLER_FILE = 'file';
28-
const HANDLER_FILE_ERROR = 'file_errors';
29-
const HANDLER_EMAIL = 'email';
30-
const HANDLER_SLACK = 'slack';
31-
const HANDLER_GELF = 'gelf';
32-
const HANDLER_SYSLOG = 'syslog';
33-
const HANDLER_SYSLOG_UDP = 'syslog_udp';
30+
private const UNDEFINED_LEVEL = 0;
3431

35-
/**
36-
* @var LevelResolver
37-
*/
38-
private $levelResolver;
32+
public const HANDLER_STREAM = 'stream';
33+
public const HANDLER_FILE = 'file';
34+
public const HANDLER_FILE_ERROR = 'file_errors';
35+
public const HANDLER_EMAIL = 'email';
36+
public const HANDLER_SLACK = 'slack';
37+
public const HANDLER_GELF = 'gelf';
38+
public const HANDLER_SYSLOG = 'syslog';
39+
public const HANDLER_SYSLOG_UDP = 'syslog_udp';
3940

4041
/**
4142
* @var LogConfig
@@ -53,99 +54,129 @@ class HandlerFactory
5354
private $globalConfig;
5455

5556
/**
56-
* @param LevelResolver $levelResolver
5757
* @param LogConfig $logConfig
5858
* @param GelfHandlerFactory $gelfHandlerFactory
5959
* @param GlobalSection $globalConfig
6060
*/
6161
public function __construct(
62-
LevelResolver $levelResolver,
6362
LogConfig $logConfig,
6463
GelfHandlerFactory $gelfHandlerFactory,
6564
GlobalSection $globalConfig
6665
) {
67-
$this->levelResolver = $levelResolver;
6866
$this->logConfig = $logConfig;
6967
$this->gelfHandlerFactory = $gelfHandlerFactory;
7068
$this->globalConfig = $globalConfig;
7169
}
7270

7371
/**
7472
* @param string $handler
75-
* @return HandlerInterface
73+
* @return AbstractProcessingHandler
74+
* @throws LoggerException
75+
*
7676
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
7777
*/
78-
public function create(string $handler): HandlerInterface
78+
public function create(string $handler): AbstractProcessingHandler
7979
{
80-
$configuration = $this->logConfig->get($handler);
81-
$levelOverride = $this->globalConfig->get(GlobalSection::VAR_MIN_LOGGING_LEVEL);
82-
$defaultLevel = $levelOverride ?: LogConfig::LEVEL_NOTICE;
83-
$minLevel = $this->levelResolver->resolve($configuration->get('min_level', $defaultLevel));
84-
85-
switch ($handler) {
86-
case static::HANDLER_FILE:
87-
$handlerInstance = new StreamHandler(
88-
$configuration->get('file'),
89-
$this->levelResolver->resolve($configuration->get('min_level', LogConfig::LEVEL_DEBUG))
90-
);
91-
break;
92-
case static::HANDLER_FILE_ERROR:
93-
$handlerInstance = new StreamHandler(
94-
$configuration->get('file'),
95-
$this->levelResolver->resolve($configuration->get('min_level', LogConfig::LEVEL_WARNING))
96-
);
97-
break;
98-
case static::HANDLER_STREAM:
99-
$defaultLevelStream = $levelOverride ?: LogConfig::LEVEL_INFO;
100-
$handlerInstance = new StreamHandler(
101-
$configuration->get('stream'),
102-
$this->levelResolver->resolve($configuration->get('min_level', $defaultLevelStream))
103-
);
104-
break;
105-
case static::HANDLER_EMAIL:
106-
$handlerInstance = new NativeMailerHandler(
107-
$configuration->get('to'),
108-
$configuration->get('subject', 'Log from Magento Cloud'),
109-
$configuration->get('from'),
110-
$minLevel
111-
);
112-
break;
113-
case static::HANDLER_SLACK:
114-
$handlerInstance = new SlackHandler(
115-
$configuration->get('token'),
116-
$configuration->get('channel', 'general'),
117-
$configuration->get('username', 'Slack Log Notifier'),
118-
true,
119-
null,
120-
$minLevel
121-
);
122-
break;
123-
case static::HANDLER_SYSLOG:
124-
$handlerInstance = new SyslogHandler(
125-
$configuration->get('ident'),
126-
$configuration->get('facility', LOG_USER),
127-
$minLevel,
128-
true,
129-
$configuration->get('logopts', LOG_PID)
130-
);
131-
break;
132-
case static::HANDLER_SYSLOG_UDP:
133-
$handlerInstance = new SyslogUdpHandler(
134-
$configuration->get('host'),
135-
$configuration->get('port'),
136-
$configuration->get('facility', LOG_USER),
137-
$minLevel,
138-
true,
139-
$configuration->get('ident', 'php')
140-
);
141-
break;
142-
case static::HANDLER_GELF:
143-
$handlerInstance = $this->gelfHandlerFactory->create($configuration, $minLevel);
144-
break;
145-
default:
146-
throw new \Exception('Unknown type of log handler: ' . $handler);
80+
try {
81+
$levelOverride = $this->globalConfig->get(GlobalSection::VAR_MIN_LOGGING_LEVEL);
82+
$minLevel = !empty($levelOverride) ? $this->normalizeLevel($levelOverride) : self::UNDEFINED_LEVEL;
83+
84+
$configuration = $this->logConfig->get($handler);
85+
} catch (ConfigException $exception) {
86+
throw new LoggerException($exception->getMessage(), $exception->getCode(), $exception);
87+
}
88+
89+
if ($customMinLevel = $configuration->get('min_level')) {
90+
$minLevel = $this->normalizeLevel((string)$customMinLevel);
91+
}
92+
93+
try {
94+
switch ($handler) {
95+
case static::HANDLER_FILE:
96+
$handlerInstance = new StreamHandler(
97+
$configuration->get('file'),
98+
$minLevel ?: Logger::DEBUG
99+
);
100+
break;
101+
case static::HANDLER_FILE_ERROR:
102+
$handlerInstance = new StreamHandler(
103+
$configuration->get('file'),
104+
$minLevel ?: Logger::WARNING
105+
);
106+
break;
107+
case static::HANDLER_STREAM:
108+
$defaultLevelStream = !empty($levelOverride) ?
109+
$this->normalizeLevel($levelOverride)
110+
: Logger::INFO;
111+
$handlerInstance = new StreamHandler(
112+
$configuration->get('stream'),
113+
$minLevel ?: $defaultLevelStream
114+
);
115+
break;
116+
case static::HANDLER_EMAIL:
117+
$handlerInstance = new NativeMailerHandler(
118+
$configuration->get('to'),
119+
$configuration->get('subject', 'Log from Magento Cloud'),
120+
$configuration->get('from'),
121+
$minLevel ?: Logger::NOTICE
122+
);
123+
break;
124+
case static::HANDLER_SLACK:
125+
$handlerInstance = new SlackHandler(
126+
$configuration->get('token'),
127+
$configuration->get('channel', 'general'),
128+
$configuration->get('username', 'Slack Log Notifier'),
129+
true,
130+
null,
131+
$minLevel ?: Logger::NOTICE
132+
);
133+
break;
134+
case static::HANDLER_SYSLOG:
135+
$handlerInstance = new SyslogHandler(
136+
$configuration->get('ident'),
137+
$configuration->get('facility', LOG_USER),
138+
$minLevel ?: Logger::NOTICE,
139+
true,
140+
$configuration->get('logopts', LOG_PID)
141+
);
142+
break;
143+
case static::HANDLER_SYSLOG_UDP:
144+
$handlerInstance = new SyslogUdpHandler(
145+
$configuration->get('host'),
146+
$configuration->get('port'),
147+
$configuration->get('facility', LOG_USER),
148+
$minLevel ?: Logger::NOTICE,
149+
true,
150+
$configuration->get('ident', 'php')
151+
);
152+
break;
153+
case static::HANDLER_GELF:
154+
$handlerInstance = $this->gelfHandlerFactory->create($configuration, $minLevel);
155+
break;
156+
default:
157+
throw new LoggerException('Unknown type of log handler: ' . $handler);
158+
}
159+
} catch (\Exception $exception) {
160+
throw new LoggerException($exception->getMessage(), $exception->getCode(), $exception);
147161
}
148162

149163
return $handlerInstance;
150164
}
165+
166+
/**
167+
* @param string $level
168+
* @return int
169+
* @throws LoggerException
170+
*/
171+
private function normalizeLevel(string $level): int
172+
{
173+
/** @phpstan-ignore-next-line */
174+
$normalizedLevel = Logger::toMonologLevel($level);
175+
176+
if (!is_int($normalizedLevel)) {
177+
throw new LoggerException('Logger lever is incorrect');
178+
}
179+
180+
return $normalizedLevel;
181+
}
151182
}

0 commit comments

Comments
 (0)