Log a more readable message when trying to cache an unsupported type

Jérôme Deuchnord · Jérôme Deuchnord · commit ae099b78c9b3 · 2019-05-08T09:31:37.000+02:00
diff --git a/src/Symfony/Component/Cache/Adapter/AbstractAdapter.php b/src/Symfony/Component/Cache/Adapter/AbstractAdapter.php
@@ -164,7 +164,7 @@ public function commit()
                     $ok = false;
                     $v = $values[$id];
                     $type = \is_object($v) ? \get_class($v) : \gettype($v);
-                    CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', ['key' => substr($id, \strlen($this->namespace)), 'type' => $type, 'exception' => $e instanceof \Exception ? $e : null]);
+                    CacheItem::log($this->logger, \sprintf('Could not save key "%s" in cache: the %s type is not supported.', $id, $type), ['exception' => ($e instanceof \Exception) ? $e : null]);
                 }
             } else {
                 foreach ($values as $id => $v) {
@@ -186,7 +186,7 @@ public function commit()
                 }
                 $ok = false;
                 $type = \is_object($v) ? \get_class($v) : \gettype($v);
-                CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', ['key' => substr($id, \strlen($this->namespace)), 'type' => $type, 'exception' => $e instanceof \Exception ? $e : null]);
+                CacheItem::log($this->logger, \sprintf('Could not save key "%s" in cache: the %s type is not supported.', $id, $type), ['exception' => ($e instanceof \Exception) ? $e : null]);
             }
         }
 
diff --git a/src/Symfony/Component/Cache/Adapter/AbstractTagAwareAdapter.php b/src/Symfony/Component/Cache/Adapter/AbstractTagAwareAdapter.php
@@ -178,7 +178,7 @@ public function commit()
                     $ok = false;
                     $v = $values[$id];
                     $type = \is_object($v) ? \get_class($v) : \gettype($v);
-                    CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', ['key' => substr($id, \strlen($this->namespace)), 'type' => $type, 'exception' => $e instanceof \Exception ? $e : null]);
+                    CacheItem::log($this->logger, \sprintf('Could not save key "%s" in cache: the %s type is not supported.', $id, $type), ['exception' => ($e instanceof \Exception) ? $e : null]);
                 }
             } else {
                 foreach ($values as $id => $v) {
@@ -201,7 +201,7 @@ public function commit()
                 }
                 $ok = false;
                 $type = \is_object($v) ? \get_class($v) : \gettype($v);
-                CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', ['key' => substr($id, \strlen($this->namespace)), 'type' => $type, 'exception' => $e instanceof \Exception ? $e : null]);
+                CacheItem::log($this->logger, \sprintf('Could not save key "%s" in cache: the %s type is not supported.', $id, $type), ['exception' => ($e instanceof \Exception) ? $e : null]);
             }
         }
 
diff --git a/src/Symfony/Component/Cache/Traits/ArrayTrait.php b/src/Symfony/Component/Cache/Traits/ArrayTrait.php
@@ -128,7 +128,7 @@ private function freeze($value, $key)
                 $serialized = serialize($value);
             } catch (\Exception $e) {
                 $type = \is_object($value) ? \get_class($value) : \gettype($value);
-                CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', ['key' => $key, 'type' => $type, 'exception' => $e]);
+                CacheItem::log($this->logger, sprintf('Could not save key "%s" in cache: the type %s is neither a scalar value nor a serializable object.', $key, $type), ['exception' => $e]);
 
                 return;
             }

Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,7 @@ public function commit()`
`164`	`164`	`$ok = false;`
`165`	`165`	`$v = $values[$id];`
`166`	`166`	`$type = \is_object($v) ? \get_class($v) : \gettype($v);`
`167`		`- CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', ['key' => substr($id, \strlen($this->namespace)), 'type' => $type, 'exception' => $e instanceof \Exception ? $e : null]);`
	`167`	`+ CacheItem::log($this->logger, \sprintf('Could not save key "%s" in cache: the %s type is not supported.', $id, $type), ['exception' => ($e instanceof \Exception) ? $e : null]);`
`168`	`168`	`}`
`169`	`169`	`} else {`
`170`	`170`	`foreach ($values as $id => $v) {`
`@@ -186,7 +186,7 @@ public function commit()`
`186`	`186`	`}`
`187`	`187`	`$ok = false;`
`188`	`188`	`$type = \is_object($v) ? \get_class($v) : \gettype($v);`
`189`		`- CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', ['key' => substr($id, \strlen($this->namespace)), 'type' => $type, 'exception' => $e instanceof \Exception ? $e : null]);`
	`189`	`+ CacheItem::log($this->logger, \sprintf('Could not save key "%s" in cache: the %s type is not supported.', $id, $type), ['exception' => ($e instanceof \Exception) ? $e : null]);`
`190`	`190`	`}`
`191`	`191`	`}`
`192`	`192`
Original file line number	Diff line number	Diff line change
`@@ -178,7 +178,7 @@ public function commit()`
`178`	`178`	`$ok = false;`
`179`	`179`	`$v = $values[$id];`
`180`	`180`	`$type = \is_object($v) ? \get_class($v) : \gettype($v);`
`181`		`- CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', ['key' => substr($id, \strlen($this->namespace)), 'type' => $type, 'exception' => $e instanceof \Exception ? $e : null]);`
	`181`	`+ CacheItem::log($this->logger, \sprintf('Could not save key "%s" in cache: the %s type is not supported.', $id, $type), ['exception' => ($e instanceof \Exception) ? $e : null]);`
`182`	`182`	`}`
`183`	`183`	`} else {`
`184`	`184`	`foreach ($values as $id => $v) {`
`@@ -201,7 +201,7 @@ public function commit()`
`201`	`201`	`}`
`202`	`202`	`$ok = false;`
`203`	`203`	`$type = \is_object($v) ? \get_class($v) : \gettype($v);`
`204`		`- CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', ['key' => substr($id, \strlen($this->namespace)), 'type' => $type, 'exception' => $e instanceof \Exception ? $e : null]);`
	`204`	`+ CacheItem::log($this->logger, \sprintf('Could not save key "%s" in cache: the %s type is not supported.', $id, $type), ['exception' => ($e instanceof \Exception) ? $e : null]);`
`205`	`205`	`}`
`206`	`206`	`}`
`207`	`207`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ private function freeze($value, $key)`
`128`	`128`	`$serialized = serialize($value);`
`129`	`129`	`} catch (\Exception $e) {`
`130`	`130`	`$type = \is_object($value) ? \get_class($value) : \gettype($value);`
`131`		`- CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', ['key' => $key, 'type' => $type, 'exception' => $e]);`
	`131`	`+ CacheItem::log($this->logger, sprintf('Could not save key "%s" in cache: the type %s is neither a scalar value nor a serializable object.', $key, $type), ['exception' => $e]);`
`132`	`132`
`133`	`133`	`return;`
`134`	`134`	`}`