symfony/archived-cache
1
0
Fork 0
mirror of https://github.com/symfony/cache.git synced 2026-03-23 23:22:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

[Cache] Stop defaulting to igbinary in DefaultMarshaller

Browse Source 
igbinary used to be a drop in replacement for PHP's `serialize` but recent changes (in PHP 7.4) to the handling of uninitialized properties in `serialize` have not made it into igbinary, so it no longer is a simple drop in replacement.

This only removes igbinary as the default serializer, code can still opt-in through the first constructor argument.

This may result in a performance regression on systems with igbinary as it would no longer be used by default.
This commit is contained in:
Martijn Croonen
2024-07-10 22:22:53 +02:00
parent fd6121840d
commit 726d5c486d
2 changed files with 24 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Marshaller/DefaultMarshaller.php
View File

@@ -20,17 +20,15 @@ use Symfony\Component\Cache\Exception\CacheException;
*/
class DefaultMarshaller implements MarshallerInterface
{
private bool $useIgbinarySerialize = true;
private bool $useIgbinarySerialize = false;
private bool $throwOnSerializationFailure = false;
public function __construct(?bool $useIgbinarySerialize = null, bool $throwOnSerializationFailure = false)
{
if (null === $useIgbinarySerialize) {
$useIgbinarySerialize = \extension_loaded('igbinary') && version_compare('3.1.6', phpversion('igbinary'), '<=');
} elseif ($useIgbinarySerialize && (!\extension_loaded('igbinary') || version_compare('3.1.6', phpversion('igbinary'), '>'))) {
if ($useIgbinarySerialize && (!\extension_loaded('igbinary') || version_compare('3.1.6', phpversion('igbinary'), '>'))) {
throw new CacheException(\extension_loaded('igbinary') ? 'Please upgrade the "igbinary" PHP extension to v3.1.6 or higher.' : 'The "igbinary" PHP extension is not loaded.');
}
$this->useIgbinarySerialize = $useIgbinarySerialize;
$this->useIgbinarySerialize = true === $useIgbinarySerialize;
$this->throwOnSerializationFailure = $throwOnSerializationFailure;
}

22
Tests/Marshaller/DefaultMarshallerTest.php
View File

@@ -24,7 +24,27 @@ class DefaultMarshallerTest extends TestCase
'b' => function () {},
];
$expected = ['a' => \extension_loaded('igbinary') && (version_compare('3.1.6', phpversion('igbinary'), '<=')) ? igbinary_serialize(123) : serialize(123)];
$expected = ['a' => serialize(123)];
$this->assertSame($expected, $marshaller->marshall($values, $failed));
$this->assertSame(['b'], $failed);
}
/**
* @requires extension igbinary
*/
public function testIgbinarySerialize()
{
if (version_compare('3.1.6', phpversion('igbinary'), '>')) {
$this->markTestSkipped('igbinary needs to be v3.1.6 or higher.');
}
$marshaller = new DefaultMarshaller(true);
$values = [
'a' => 123,
'b' => function () {},
];
$expected = ['a' => igbinary_serialize(123)];
$this->assertSame($expected, $marshaller->marshall($values, $failed));
$this->assertSame(['b'], $failed);
}