Merge branch 'hotfix/exception-handling'

Better exception handling

- Any exception captured by the `dispatch.error` listener is pushed into the
  created `ApiProblem`, thus ensuring that we will get a stack trace if
  `display_exceptions` is enabled.
- Traces are now captured to a `trace` member of the problem, using `getTrace()`
  instead of `getTraceAsString()`
- Previous exceptions are now captured to an `exception_stack` member, as an
  array of objects with `code`, `message`, and `trace` members.

Author: weierophinney

src/ZF/ApiProblem/ApiProblem.php

@@ -296,14 +296,24 @@ protected function createDetailFromException()
             return $e->getMessage();
         }
 
-        $message = '';
-        do {
-            $message .= $e->getMessage() . "\n";
-            $message .= $e->getTraceAsString() . "\n";
+        $message = trim($e->getMessage());
+        $this->additionalDetails['trace'] = $e->getTrace();
+
+        $previous = array();
+        $e = $e->getPrevious();
+        while ($e) {
+            $previous[] = array(
+                'code'    => (int) $e->getCode(),
+                'message' => trim($e->getMessage()),
+                'trace'   => $e->getTrace(),
+            );
             $e = $e->getPrevious();
-        } while ($e instanceof \Exception);
+        }
+        if (count($previous)) {
+            $this->additionalDetails['exception_stack'] = $previous;
+        }
 
-        return trim($message);
+        return $message;
     }
 
     /**

src/ZF/ApiProblem/Listener/ApiProblemListener.php

@@ -164,8 +164,7 @@ public function onDispatchError(MvcEvent $e)
             if (0 === $status) {
                 $status = 500;
             }
-            $detail  = $exception->getMessage();
-            $problem = new ApiProblem($status, $detail);
+            $problem = new ApiProblem($status, $exception);
         } else {
             // If it's not an exception, do not know what to do.
             return;
@@ -179,8 +178,8 @@ public function onDispatchError(MvcEvent $e)
 
     /**
      * Determine if we have a valid error event
-     * 
-     * @param  MvcEvent $e 
+     *
+     * @param  MvcEvent $e
      * @return bool
      */
     protected function validateErrorEvent(MvcEvent $e)

test/ZFTest/ApiProblem/ApiProblemTest.php

@@ -65,30 +65,35 @@ public function testExceptionMessageIsUsedForDetail()
         $this->assertEquals($exception->getMessage(), $payload['detail']);
     }
 
-    public function testDetailCanIncludeStackTrace()
+    public function testExceptionsCanTriggerInclusionOfStackTraceInDetails()
     {
         $exception  = new \Exception('exception message');
         $apiProblem = new ApiProblem('500', $exception);
         $apiProblem->setDetailIncludesStackTrace(true);
         $payload    = $apiProblem->toArray();
-        $this->assertArrayHasKey('detail', $payload);
-        $this->assertEquals($exception->getMessage() . "\n" . $exception->getTraceAsString(), $payload['detail']);
+        $this->assertArrayHasKey('trace', $payload);
+        $this->assertInternalType('array', $payload['trace']);
+        $this->assertEquals($exception->getTrace(), $payload['trace']);
     }
 
-    public function testDetailCanIncludeNestedExceptions()
+    public function testExceptionsCanTriggerInclusionOfNestedExceptions()
     {
         $exceptionChild  = new \Exception('child exception');
         $exceptionParent = new \Exception('parent exception', null, $exceptionChild);
 
         $apiProblem = new ApiProblem('500', $exceptionParent);
         $apiProblem->setDetailIncludesStackTrace(true);
         $payload    = $apiProblem->toArray();
-        $this->assertArrayHasKey('detail', $payload);
-        $expected = $exceptionParent->getMessage() . "\n"
-            . $exceptionParent->getTraceAsString() . "\n"
-            . $exceptionChild->getMessage() . "\n"
-            . $exceptionChild->getTraceAsString();
-        $this->assertEquals($expected, $payload['detail']);
+        $this->assertArrayHasKey('exception_stack', $payload);
+        $this->assertInternalType('array', $payload['exception_stack']);
+        $expected = array(
+            array(
+                'code' => $exceptionChild->getCode(),
+                'message' => $exceptionChild->getMessage(),
+                'trace' => $exceptionChild->getTrace(),
+            ),
+        );
+        $this->assertEquals($expected, $payload['exception_stack']);
     }
 
     public function testProblemTypeUrlIsUsedVerbatim()

test/ZFTest/ApiProblem/Listener/SendApiProblemResponseListenerTest.php

@@ -67,8 +67,9 @@ public function testEnablingDisplayExceptionFlagRendersExceptionStackTrace()
         $contents = ob_get_clean();
         $this->assertInternalType('string', $contents);
         $data = json_decode($contents, true);
-        $this->assertContains("\n", $data['detail']);
-        $this->assertContains($this->exception->getTraceAsString(), $data['detail']);
+        $this->assertArrayHasKey('trace', $data);
+        $this->assertInternalType('array', $data['trace']);
+        $this->assertGreaterThanOrEqual(1, count($data['trace']));
     }
 
     public function testSendContentDoesNothingIfEventDoesNotContainApiProblemResponse()

test/ZFTest/ApiProblem/View/ApiProblemRendererTest.php

@@ -45,6 +45,8 @@ public function testCanHintToApiProblemToRenderStackTrace()
         $this->renderer->setDisplayExceptions(true);
         $test = $this->renderer->render($model);
         $test = json_decode($test, true);
-        $this->assertContains($exception->getMessage() . "\n" . $exception->getTraceAsString(), $test['detail']);
+        $this->assertArrayHasKey('trace', $test);
+        $this->assertInternalType('array', $test['trace']);
+        $this->assertGreaterThanOrEqual(1, count($test['trace']));
     }
 }