mirror of
https://github.com/Seldaek/monolog.git
synced 2025-08-01 02:40:24 +02:00
Close and reopen file handles if a write fails (#1882)
* Close file handle after each write, refs #1862, refs #1860, refs #1634 * Modify patch to retry writes once if they fail, then throw if not * Fix php7.2 build
This commit is contained in:
@@ -45,6 +45,8 @@ class StreamHandler extends AbstractProcessingHandler
|
||||
protected $fileOpenMode;
|
||||
/** @var true|null */
|
||||
private $dirCreated = null;
|
||||
/** @var bool */
|
||||
private $retrying = false;
|
||||
|
||||
/**
|
||||
* @param resource|string $stream If a missing path can't be created, an UnexpectedValueException will be thrown on first write
|
||||
@@ -168,8 +170,30 @@ class StreamHandler extends AbstractProcessingHandler
|
||||
flock($stream, LOCK_EX);
|
||||
}
|
||||
|
||||
$this->streamWrite($stream, $record);
|
||||
$this->errorMessage = null;
|
||||
set_error_handler(function (...$args) {
|
||||
return $this->customErrorHandler(...$args);
|
||||
});
|
||||
try {
|
||||
$this->streamWrite($stream, $record);
|
||||
} finally {
|
||||
restore_error_handler();
|
||||
}
|
||||
if ($this->errorMessage !== null) {
|
||||
$error = $this->errorMessage;
|
||||
// close the resource if possible to reopen it, and retry the failed write
|
||||
if (!$this->retrying && $this->url !== null && $this->url !== 'php://memory') {
|
||||
$this->retrying = true;
|
||||
$this->close();
|
||||
$this->write($record);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
throw new \UnexpectedValueException('Writing to the log file failed: '.$error . Utils::getRecordMessageForException($record));
|
||||
}
|
||||
|
||||
$this->retrying = false;
|
||||
if ($this->useLocking) {
|
||||
flock($stream, LOCK_UN);
|
||||
}
|
||||
@@ -189,7 +213,7 @@ class StreamHandler extends AbstractProcessingHandler
|
||||
|
||||
private function customErrorHandler(int $code, string $msg): bool
|
||||
{
|
||||
$this->errorMessage = preg_replace('{^(fopen|mkdir)\(.*?\): }', '', $msg);
|
||||
$this->errorMessage = preg_replace('{^(fopen|mkdir|fwrite)\(.*?\): }', '', $msg);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
@@ -17,6 +17,13 @@ use Monolog\Logger;
|
||||
|
||||
class StreamHandlerTest extends TestCase
|
||||
{
|
||||
public function tearDown(): void
|
||||
{
|
||||
parent::tearDown();
|
||||
|
||||
@unlink(__DIR__.'/test.log');
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers Monolog\Handler\StreamHandler::__construct
|
||||
* @covers Monolog\Handler\StreamHandler::write
|
||||
@@ -54,9 +61,9 @@ class StreamHandlerTest extends TestCase
|
||||
$handler->handle($this->getRecord(Logger::WARNING, 'test'));
|
||||
$stream = $handler->getStream();
|
||||
|
||||
$this->assertTrue(is_resource($stream));
|
||||
$this->assertTrue(\is_resource($stream));
|
||||
$handler->close();
|
||||
$this->assertFalse(is_resource($stream));
|
||||
$this->assertFalse(\is_resource($stream));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -204,6 +211,63 @@ STRING;
|
||||
$handler->handle($this->getRecord());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers Monolog\Handler\StreamHandler::write
|
||||
*/
|
||||
public function testWriteErrorDuringWriteRetriesWithClose()
|
||||
{
|
||||
$handler = $this->getMockBuilder(StreamHandler::class)
|
||||
->onlyMethods(['streamWrite'])
|
||||
->setConstructorArgs(['file://'.sys_get_temp_dir().'/bar/'.rand(0, 10000).DIRECTORY_SEPARATOR.rand(0, 10000)])
|
||||
->getMock();
|
||||
|
||||
$refs = [];
|
||||
$handler->expects($this->exactly(2))
|
||||
->method('streamWrite')
|
||||
->willReturnCallback(function ($stream) use (&$refs) {
|
||||
$refs[] = $stream;
|
||||
if (\count($refs) === 2) {
|
||||
self::assertNotSame($stream, $refs[0]);
|
||||
}
|
||||
if (\count($refs) === 1) {
|
||||
trigger_error('fwrite(): Write of 378 bytes failed with errno=32 Broken pipe', E_USER_ERROR);
|
||||
}
|
||||
});
|
||||
|
||||
$handler->handle($this->getRecord());
|
||||
if (method_exists($this, 'assertIsClosedResource')) {
|
||||
self::assertIsClosedResource($refs[0]);
|
||||
self::assertIsResource($refs[1]);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers Monolog\Handler\StreamHandler::write
|
||||
*/
|
||||
public function testWriteErrorDuringWriteRetriesButThrowsIfStillFails()
|
||||
{
|
||||
$handler = $this->getMockBuilder(StreamHandler::class)
|
||||
->onlyMethods(['streamWrite'])
|
||||
->setConstructorArgs(['file://'.sys_get_temp_dir().'/bar/'.rand(0, 10000).DIRECTORY_SEPARATOR.rand(0, 10000)])
|
||||
->getMock();
|
||||
|
||||
$refs = [];
|
||||
$handler->expects($this->exactly(2))
|
||||
->method('streamWrite')
|
||||
->willReturnCallback(function ($stream) use (&$refs) {
|
||||
$refs[] = $stream;
|
||||
if (\count($refs) === 2) {
|
||||
self::assertNotSame($stream, $refs[0]);
|
||||
}
|
||||
trigger_error('fwrite(): Write of 378 bytes failed with errno=32 Broken pipe', E_USER_ERROR);
|
||||
});
|
||||
|
||||
self::expectException(\UnexpectedValueException::class);
|
||||
self::expectExceptionMessage('Writing to the log file failed: Write of 378 bytes failed with errno=32 Broken pipe
|
||||
The exception occurred while attempting to log: test');
|
||||
$handler->handle($this->getRecord());
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers Monolog\Handler\StreamHandler::__construct
|
||||
* @covers Monolog\Handler\StreamHandler::write
|
||||
|
Reference in New Issue
Block a user