[Cache] Throw ValueError in debug mode when serialization fails

nicolas-grekas · nicolas-grekas · commit c68fce5712be · 2021-09-23T14:57:45.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/cache.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/cache.php
@@ -217,6 +217,7 @@
         ->set('cache.default_marshaller', DefaultMarshaller::class)
             ->args([
                 null, // use igbinary_serialize() when available
+                '%kernel.debug%',
             ])
 
         ->set('cache.early_expiration_handler', EarlyExpirationHandler::class)
diff --git a/src/Symfony/Component/Cache/Marshaller/DefaultMarshaller.php b/src/Symfony/Component/Cache/Marshaller/DefaultMarshaller.php
@@ -21,15 +21,17 @@
 class DefaultMarshaller implements MarshallerInterface
 {
     private $useIgbinarySerialize = true;
+    private $debug;
 
-    public function __construct(bool $useIgbinarySerialize = null)
+    public function __construct(bool $useIgbinarySerialize = null, bool $debug = false)
     {
         if (null === $useIgbinarySerialize) {
             $useIgbinarySerialize = \extension_loaded('igbinary') && (\PHP_VERSION_ID < 70400 || version_compare('3.1.6', phpversion('igbinary'), '<='));
         } elseif ($useIgbinarySerialize && (!\extension_loaded('igbinary') || (\PHP_VERSION_ID >= 70400 && version_compare('3.1.6', phpversion('igbinary'), '>')))) {
             throw new CacheException(\extension_loaded('igbinary') && \PHP_VERSION_ID >= 70400 ? 'Please upgrade the "igbinary" PHP extension to v3.1.6 or higher.' : 'The "igbinary" PHP extension is not loaded.');
         }
         $this->useIgbinarySerialize = $useIgbinarySerialize;
+        $this->debug = $debug;
     }
 
     /**
@@ -47,6 +49,9 @@ public function marshall(array $values, ?array &$failed): array
                     $serialized[$id] = serialize($value);
                 }
             } catch (\Exception $e) {
+                if ($this->debug) {
+                    throw new \ValueError($e->getMessage(), 0, $e);
+                }
                 $failed[] = $id;
             }
         }
diff --git a/src/Symfony/Component/Cache/Tests/Marshaller/DefaultMarshallerTest.php b/src/Symfony/Component/Cache/Tests/Marshaller/DefaultMarshallerTest.php
@@ -109,4 +109,16 @@ public function testIgbinaryUnserializeInvalid()
             restore_error_handler();
         }
     }
+
+    public function testSerializeDebug()
+    {
+        $marshaller = new DefaultMarshaller(false, true);
+        $values = [
+            'a' => function () {},
+        ];
+
+        $this->expectException(\ValueError::class);
+        $marshaller->marshall($values, $failed);
+    }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -21,15 +21,17 @@`
`21`	`21`	`class DefaultMarshaller implements MarshallerInterface`
`22`	`22`	`{`
`23`	`23`	`private $useIgbinarySerialize = true;`
	`24`	`+ private $debug;`
`24`	`25`
`25`		`- public function __construct(bool $useIgbinarySerialize = null)`
	`26`	`+ public function __construct(bool $useIgbinarySerialize = null, bool $debug = false)`
`26`	`27`	`{`
`27`	`28`	`if (null === $useIgbinarySerialize) {`
`28`	`29`	`$useIgbinarySerialize = \extension_loaded('igbinary') && (\PHP_VERSION_ID < 70400 \|\| version_compare('3.1.6', phpversion('igbinary'), '<='));`
`29`	`30`	`} elseif ($useIgbinarySerialize && (!\extension_loaded('igbinary') \|\| (\PHP_VERSION_ID >= 70400 && version_compare('3.1.6', phpversion('igbinary'), '>')))) {`
`30`	`31`	`throw new CacheException(\extension_loaded('igbinary') && \PHP_VERSION_ID >= 70400 ? 'Please upgrade the "igbinary" PHP extension to v3.1.6 or higher.' : 'The "igbinary" PHP extension is not loaded.');`
`31`	`32`	`}`
`32`	`33`	`$this->useIgbinarySerialize = $useIgbinarySerialize;`
	`34`	`+ $this->debug = $debug;`
`33`	`35`	`}`
`34`	`36`
`35`	`37`	`/**`
`@@ -47,6 +49,9 @@ public function marshall(array $values, ?array &$failed): array`
`47`	`49`	`$serialized[$id] = serialize($value);`
`48`	`50`	`}`
`49`	`51`	`} catch (\Exception $e) {`
	`52`	`+ if ($this->debug) {`
	`53`	`+ throw new \ValueError($e->getMessage(), 0, $e);`
	`54`	`+ }`
`50`	`55`	`$failed[] = $id;`
`51`	`56`	`}`
`52`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -109,4 +109,16 @@ public function testIgbinaryUnserializeInvalid()`
`109`	`109`	`restore_error_handler();`
`110`	`110`	`}`
`111`	`111`	`}`
	`112`	`+`
	`113`	`+ public function testSerializeDebug()`
	`114`	`+ {`
	`115`	`+ $marshaller = new DefaultMarshaller(false, true);`
	`116`	`+ $values = [`
	`117`	`+ 'a' => function () {},`
	`118`	`+ ];`
	`119`	`+`
	`120`	`+ $this->expectException(\ValueError::class);`
	`121`	`+ $marshaller->marshall($values, $failed);`
	`122`	`+ }`
	`123`	`+`
`112`	`124`	`}`