CacheWarmerAggregate handle deprecations logs #27421
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,12 +21,16 @@ | |
| class CacheWarmerAggregate implements CacheWarmerInterface | ||
| { | ||
| private $warmers; | ||
| private $debug; | ||
| private $deprecationLogsFilepath; | ||
| private $optionalsEnabled = false; | ||
| private $onlyOptionalsEnabled = false; | ||
|
|
||
| public function __construct(iterable $warmers = array(), bool $debug = false, string $deprecationLogsFilepath = null) | ||
| { | ||
| $this->warmers = $warmers; | ||
| $this->debug = $debug; | ||
| $this->deprecationLogsFilepath = $deprecationLogsFilepath; | ||
| } | ||
|
|
||
| public function enableOptionalWarmers() | ||
|
|
@@ -46,15 +50,62 @@ public function enableOnlyOptionalWarmers() | |
| */ | ||
| public function warmUp($cacheDir) | ||
| { | ||
| if ($this->debug) { | ||
| $collectedLogs = array(); | ||
| $previousHandler = defined('PHPUNIT_COMPOSER_INSTALL'); | ||
|
There was a problem hiding this comment. If you're talking about the definition of |
||
| $previousHandler = $previousHandler ?: set_error_handler(function ($type, $message, $file, $line) use (&$collectedLogs, &$previousHandler) { | ||
| if (E_USER_DEPRECATED !== $type && E_DEPRECATED !== $type) { | ||
| return $previousHandler ? $previousHandler($type, $message, $file, $line) : false; | ||
| } | ||
|
|
||
| if (isset($collectedLogs[$message])) { | ||
| ++$collectedLogs[$message]['count']; | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 3); | ||
| // Clean the trace by removing first frames added by the error handler itself. | ||
| for ($i = 0; isset($backtrace[$i]); ++$i) { | ||
| if (isset($backtrace[$i]['file'], $backtrace[$i]['line']) && $backtrace[$i]['line'] === $line && $backtrace[$i]['file'] === $file) { | ||
| $backtrace = array_slice($backtrace, 1 + $i); | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| $collectedLogs[$message] = array( | ||
| 'type' => $type, | ||
| 'message' => $message, | ||
| 'file' => $file, | ||
| 'line' => $line, | ||
| 'trace' => $backtrace, | ||
| 'count' => 1, | ||
| ); | ||
| }); | ||
| } | ||
|
|
||
| try { | ||
| foreach ($this->warmers as $warmer) { | ||
| if (!$this->optionalsEnabled && $warmer->isOptional()) { | ||
| continue; | ||
| } | ||
| if ($this->onlyOptionalsEnabled && !$warmer->isOptional()) { | ||
| continue; | ||
| } | ||
|
|
||
| $warmer->warmUp($cacheDir); | ||
| } | ||
| } finally { | ||
| if ($this->debug && true !== $previousHandler) { | ||
|
There was a problem hiding this comment. I've also prepare a test scenario with a cacheWarmer who throw deprecations but here I'm directly in conflict with #25413 (fixing #24767). It can't pass in this condition during the test and it's right. Here was my test code (CacheWarmerAggregateTest): public function testWarmupWithDeprecationLogs()
{
$cacheDir = self::$cacheDir;
$warmer = $this->getCacheWarmerMock();
$warmer
->expects($this->once())
->method('warmUp')
->with($cacheDir)
->will($this->returnValue($this->throwDeprecation()));
;
$deprecationLogsFilepath = self::$cacheDir.'/Deprecations.log';
$aggregate = new CacheWarmerAggregate(array($warmer), true, $deprecationLogsFilepath);
$aggregate->warmUp($cacheDir);
$this->assertTrue(file_exists($deprecationLogsFilepath));
$this->assertCount(1, unserialize(file_get_contents($deprecationLogsFilepath)));
}
protected function throwDeprecation()
{
@trigger_error('Deprecation Message', E_USER_DEPRECATED);
}There was a problem hiding this comment. Unsetting the env var temporarily should be doable? There was a problem hiding this comment. I've try many solution, and even temporarily removing the defined constant (runkit_constant_remove), deprecations have a different behavior during phpunit test. Still looking to find a solution and test it. There was a problem hiding this comment. ok, let's forget about it :): |
||
| restore_error_handler(); | ||
|
|
||
| if (file_exists($this->deprecationLogsFilepath)) { | ||
| $previousLogs = unserialize(file_get_contents($this->deprecationLogsFilepath)); | ||
| $collectedLogs = array_merge($previousLogs, $collectedLogs); | ||
| } | ||
|
|
||
| file_put_contents($this->deprecationLogsFilepath, serialize(array_values($collectedLogs))); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CacheWarmerAggregateis annoted as final, so it shouldn't be BCBreak