Merge pull request #651 from CakeDC/feature/ensure-serializable

Feature/ensure serializable

Author: markstory

src/Panel/VariablesPanel.php

@@ -126,17 +126,13 @@ public function shutdown(Event $event)
                     // Convert objects into using __debugInfo.
                     $item = $this->_walkDebugInfo($walker, $item);
                 } else {
-                    try {
-                        serialize($item);
-                    } catch (\Exception $e) {
-                        $item = __d('debug_kit', 'Unserializable object - {0}. Error: {1} in {2}, line {3}', get_class($item), $e->getMessage(), $e->getFile(), $e->getLine());
-                    }
+                    $item = $this->trySerialize($item);
                 }
             } elseif (is_resource($item)) {
                 $item = sprintf('[%s] %s', get_resource_type($item), $item);
             }
 
-            return $item;
+            return $this->trySerialize($item);
         };
         // Copy so viewVars is not mutated.
         $vars = $controller->viewVars;
@@ -160,6 +156,27 @@ public function shutdown(Event $event)
         ];
     }
 
+    /**
+     * Try to serialize an item, provide an error message if not possible
+     *
+     * @param mixed $item Item to check
+     * @return mixed The $item if it is serializable, error message if not
+     */
+    protected function trySerialize($item)
+    {
+        try {
+            serialize($item);
+
+            return $item;
+        } catch (\Exception $e) {
+            if (is_object($item)) {
+                return __d('debug_kit', 'Unserializable object - {0}. Error: {1} in {2}, line {3}', get_class($item), $e->getMessage(), $e->getFile(), $e->getLine());
+            }
+
+            return __d('debug_kit', 'Unserializable Error: {1} in {2}, line {3}', $e->getMessage(), $e->getFile(), $e->getLine());
+        }
+    }
+
     /**
      * Get summary data for the variables panel.
      *

tests/TestCase/Panel/VariablesPanelTest.php

@@ -16,6 +16,7 @@
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 use DebugKit\Panel\VariablesPanel;
+use DebugKit\TestApp\Form\TestForm;
 
 /**
  * Class VariablesPanelTest
@@ -90,12 +91,20 @@ public function testShutdown()
             'unbufferedQuery' => $unbufferedQuery,
             'result set' => $result,
             'string' => 'yes',
-            'array' => ['some' => 'key']
+            'array' => ['some' => 'key'],
+            'notSerializableForm' => new TestForm(),
         ];
         $event = new Event('Controller.shutdown', $controller);
         $this->panel->shutdown($event);
         $output = $this->panel->data();
 
+        array_walk_recursive($output, function ($item) {
+            try {
+                serialize($item);
+            } catch (\Exception $e) {
+                $this->fail('Panel Output content is not serializable');
+            }
+        });
         $this->assertRegExp('/^\[stream\] Resource id #\d+$/', $output['content']['resource']);
         $this->assertInternalType('array', $output['content']['unserializableDebugInfo']);
         $this->assertStringStartsWith(

tests/test_app/Form/TestForm.php

@@ -0,0 +1,52 @@
+<?php
+namespace DebugKit\TestApp\Form;
+
+use Cake\Form\Form;
+use Cake\Form\Schema;
+use Cake\Validation\Validator;
+
+/**
+ * Class TestForm
+ * @package DebugKit\TestApp\Form
+ */
+class TestForm extends Form
+{
+    /**
+     * Builds the schema for the modelless form
+     *
+     * @param \Cake\Form\Schema $schema From schema
+     * @return \Cake\Form\Schema
+     */
+    protected function _buildSchema(Schema $schema)
+    {
+        return $schema->addField('accept', 'boolean');
+    }
+
+    /**
+     * Form validation builder
+     *
+     * @param \Cake\Validation\Validator $validator to use against the form
+     * @return \Cake\Validation\Validator
+     */
+    protected function _buildValidator(Validator $validator)
+    {
+        return $validator
+            ->requirePresence('accept')
+            ->add('accept', 'accept', [
+                'rule' => function ($value) {
+                    return 'always fail validation';
+                },
+            ]);
+    }
+
+    /**
+     * Defines what to execute once the From is being processed
+     *
+     * @param array $data Form data.
+     * @return bool
+     */
+    protected function _execute(array $data)
+    {
+        return true;
+    }
+}