Skip to content
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

Improve error reporting when custom error handler is used #35

Merged
merged 1 commit into from
May 17, 2022
Merged

Improve error reporting when custom error handler is used #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 18 additions & 2 deletions src/Compressor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,25 @@ final class Compressor extends TransformStream
*/
public function __construct($encoding, $level = -1)
{
$context = @deflate_init($encoding, ['level' => $level]);
$errstr = '';
set_error_handler(function ($_, $error) use (&$errstr) {
// Match errstr from PHP's warning message.
// inflate_init(): encoding mode must be ZLIB_ENCODING_RAW, ZLIB_ENCODING_GZIP or ZLIB_ENCODING_DEFLATE
$errstr = strstr($error, ':'); // @codeCoverageIgnore
});

try {
$context = deflate_init($encoding, ['level' => $level]);
} catch (\ValueError $e) { // @codeCoverageIgnoreStart
// Throws ValueError on PHP 8.0+
restore_error_handler();
throw $e;
} // @codeCoverageIgnoreEnd

restore_error_handler();

if ($context === false) {
throw new \InvalidArgumentException('Unable to initialize compressor' . strstr(error_get_last()['message'], ':'));
throw new \InvalidArgumentException('Unable to initialize compressor' . $errstr); // @codeCoverageIgnore
}

$this->context = $context;
Expand Down
47 changes: 41 additions & 6 deletions src/Decompressor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,45 @@ final class Decompressor extends TransformStream
*/
public function __construct($encoding)
{
$context = @inflate_init($encoding);
$errstr = '';
set_error_handler(function ($_, $error) use (&$errstr) {
// Match errstr from PHP's warning message.
// inflate_init(): encoding mode must be ZLIB_ENCODING_RAW, ZLIB_ENCODING_GZIP or ZLIB_ENCODING_DEFLATE
$errstr = strstr($error, ':'); // @codeCoverageIgnore
});

try {
$context = inflate_init($encoding);
} catch (\ValueError $e) { // @codeCoverageIgnoreStart
// Throws ValueError on PHP 8.0+
restore_error_handler();
throw $e;
} // @codeCoverageIgnoreEnd

restore_error_handler();

if ($context === false) {
throw new \InvalidArgumentException('Unable to initialize decompressor' . strstr(error_get_last()['message'], ':'));
throw new \InvalidArgumentException('Unable to initialize decompressor' . $errstr); // @codeCoverageIgnore
}

$this->context = $context;
}

protected function transformData($chunk)
{
$ret = @inflate_add($this->context, $chunk);
$errstr = '';
set_error_handler(function ($_, $error) use (&$errstr) {
// Match errstr from PHP's warning message.
// inflate_add(): data error
$errstr = strstr($error, ':');
});

$ret = inflate_add($this->context, $chunk);

restore_error_handler();

if ($ret === false) {
throw new \RuntimeException('Unable to decompress' . strstr(error_get_last()['message'], ':'));
throw new \RuntimeException('Unable to decompress' . $errstr);
}

if ($ret !== '') {
Expand All @@ -63,11 +89,20 @@ protected function transformData($chunk)

protected function transformEnd($chunk)
{
$ret = @inflate_add($this->context, $chunk, ZLIB_FINISH);
$errstr = '';
set_error_handler(function ($_, $error) use (&$errstr) {
// Match errstr from PHP's warning message.
// inflate_add(): data error
$errstr = strstr($error, ':');
});

$ret = inflate_add($this->context, $chunk, ZLIB_FINISH);
$this->context = null;

restore_error_handler();

if ($ret === false) {
throw new \RuntimeException('Unable to decompress' . strstr(error_get_last()['message'], ':'));
throw new \RuntimeException('Unable to decompress' . $errstr);
}

if ($ret !== '') {
Expand Down
19 changes: 19 additions & 0 deletions tests/CompressorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,23 @@ public function testCtorThrowsForInvalidEncoding()
$this->expectException(PHP_VERSION_ID >= 80000 ? \ValueError::class : \InvalidArgumentException::class);
new Compressor(0);
}

public function testCtorThrowsForInvalidEncodingAndUnsetsUsedErrorHandler()
{
$handler = set_error_handler(function(){});

restore_error_handler();

try {
new Compressor(0);
} catch (\ValueError $e) {
// handle Error to unset Error handler afterwards (PHP >= 8.0)
} catch (\InvalidArgumentException $e) {
// handle Error to unset Error handler afterwards (PHP < 8.0)
}
$checkHandler = set_error_handler(function(){});
restore_error_handler();

$this->assertEquals($handler, $checkHandler);
}
}
20 changes: 20 additions & 0 deletions tests/DecompressorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,24 @@ public function testCtorThrowsForInvalidEncoding()
$this->expectException(PHP_VERSION_ID >= 80000 ? \ValueError::class : \InvalidArgumentException::class);
new Decompressor(0);
}

public function testCtorThrowsForInvalidEncodingAndUnsetsUsedErrorHandler()
{
$handler = set_error_handler(function(){});

restore_error_handler();

try {
new Decompressor(0);
} catch (\ValueError $e) {
// handle Error to unset Error handler afterwards (PHP >= 8.0)
} catch (\InvalidArgumentException $e) {
// handle Error to unset Error handler afterwards (PHP < 8.0)
}

$checkHandler = set_error_handler(function(){});
restore_error_handler();

$this->assertEquals($handler, $checkHandler);
}
}
20 changes: 18 additions & 2 deletions tests/DeflateDecompressorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,35 @@ public function testInflateBig()
$this->assertEquals($data, $buffered);
}

public function testDecompressInvalidDataEmitsError()
public function testDecompressInvalidDataEmitsErrorWithoutCallingCustomErrorHandler()
{
$this->decompressor->on('data', $this->expectCallableNever());
$this->decompressor->on('error', $this->expectCallableOnce());

$error = null;
set_error_handler(function ($_, $errstr) use (&$error) {
$error = $errstr;
});

$this->decompressor->write('invalid');

restore_error_handler();
$this->assertNull($error);
}

public function testDecompressInvalidOnEndEmitsError()
public function testDecompressInvalidOnEndEmitsErrorWithoutCallingCustomErrorHandler()
{
$this->decompressor->on('data', $this->expectCallableNever());
$this->decompressor->on('error', $this->expectCallableOnce());

$error = null;
set_error_handler(function ($_, $errstr) use (&$error) {
$error = $errstr;
});

$this->decompressor->end('invalid');

restore_error_handler();
$this->assertNull($error);
}
}
20 changes: 18 additions & 2 deletions tests/GzipDecompressorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,35 @@ public function testDecompressBig()
$this->assertEquals($data, $buffered);
}

public function testDecompressInvalidDataEmitsError()
public function testDecompressInvalidDataEmitsErrorWithoutCallingCustomErrorHandler()
{
$this->decompressor->on('data', $this->expectCallableNever());
$this->decompressor->on('error', $this->expectCallableOnce());

$error = null;
set_error_handler(function ($_, $errstr) use (&$error) {
$error = $errstr;
});

$this->decompressor->write('invalid');

restore_error_handler();
$this->assertNull($error);
}

public function testDecompressInvalidOnEndEmitsError()
public function testDecompressInvalidOnEndEmitsErrorWithoutCallingCustomErrorHandler()
{
$this->decompressor->on('data', $this->expectCallableNever());
$this->decompressor->on('error', $this->expectCallableOnce());

$error = null;
set_error_handler(function ($_, $errstr) use (&$error) {
$error = $errstr;
});

$this->decompressor->end('invalid');

restore_error_handler();
$this->assertNull($error);
}
}
20 changes: 18 additions & 2 deletions tests/ZlibDecompressorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,35 @@ public function testDecompressBig()
$this->assertEquals($data, $buffered);
}

public function testDecompressInvalidDataEmitsError()
public function testDecompressInvalidDataEmitsErrorWithoutCallingCustomErrorHandler()
{
$this->decompressor->on('data', $this->expectCallableNever());
$this->decompressor->on('error', $this->expectCallableOnce());

$error = null;
set_error_handler(function ($_, $errstr) use (&$error) {
$error = $errstr;
});

$this->decompressor->write('invalid');

restore_error_handler();
$this->assertNull($error);
}

public function testDecompressInvalidOnEndEmitsError()
public function testDecompressInvalidOnEndEmitsErrorWithoutCallingCustomErrorHandler()
{
$this->decompressor->on('data', $this->expectCallableNever());
$this->decompressor->on('error', $this->expectCallableOnce());

$error = null;
set_error_handler(function ($_, $errstr) use (&$error) {
$error = $errstr;
});

$this->decompressor->end('invalid');

restore_error_handler();
$this->assertNull($error);
}
}