Merge branch 'hotfix/41'

Close #41
Fixes #40

Author: weierophinney

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file, in reverse
 
 Versions 0.3.0 and prior were released as "weierophinney/problem-details".
 
-## 1.0.1 - TBD
+## 1.0.1 - 2018-07-25
 
 ### Added
 
@@ -24,8 +24,11 @@ Versions 0.3.0 and prior were released as "weierophinney/problem-details".
 
 ### Fixed
 
-- [#39](https://github.com/zendframework/zend-problem-details/pull/39)
-  adds the `public` visibility modifier to all constants.
+- [#39](https://github.com/zendframework/zend-problem-details/pull/39) adds the `public` visibility modifier to all constants.
+
+- [#41](https://github.com/zendframework/zend-problem-details/pull/41) prevents crashes when the `ProblemDetailsResponseFactory` attempts to
+  encode malformed UTF-8 sequences to JSON by ensuring the
+  `JSON_PARTIAL_OUTPUT_ON_ERROR` flag is enabled.
 
 ## 1.0.0 - 2018-03-15
 

src/ProblemDetailsResponseFactory.php

@@ -31,6 +31,7 @@
 use function sprintf;
 use function strpos;
 
+use const JSON_PARTIAL_OUTPUT_ON_ERROR;
 use const JSON_PRESERVE_ZERO_FRACTION;
 use const JSON_PRETTY_PRINT;
 use const JSON_UNESCAPED_SLASHES;
@@ -166,8 +167,11 @@ class ProblemDetailsResponseFactory
      *
      * On non-debug mode:
      * defaults to JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION
+     * | JSON_PARTIAL_OUTPUT_ON_ERROR
+     *
      * On debug mode:
      * defaults to JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION
+     * | JSON_PARTIAL_OUTPUT_ON_ERROR
      *
      * @var int
      */
@@ -213,7 +217,10 @@ public function __construct(
         };
         $this->isDebug = $isDebug;
         if (! $jsonFlags) {
-            $jsonFlags = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION;
+            $jsonFlags = JSON_UNESCAPED_SLASHES
+                | JSON_UNESCAPED_UNICODE
+                | JSON_PRESERVE_ZERO_FRACTION
+                | JSON_PARTIAL_OUTPUT_ON_ERROR;
             if ($isDebug) {
                 $jsonFlags = JSON_PRETTY_PRINT | $jsonFlags;
             }

test/ProblemDetailsResponseFactoryFactoryTest.php

@@ -82,7 +82,10 @@ public function testLackOfConfigServiceResultsInFactoryUsingDefaults() : void
         $this->assertInstanceOf(ProblemDetailsResponseFactory::class, $factory);
         $this->assertAttributeSame(ProblemDetailsResponseFactory::EXCLUDE_THROWABLE_DETAILS, 'isDebug', $factory);
         $this->assertAttributeSame(
-            JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION,
+            JSON_UNESCAPED_SLASHES
+            | JSON_UNESCAPED_UNICODE
+            | JSON_PRESERVE_ZERO_FRACTION
+            | JSON_PARTIAL_OUTPUT_ON_ERROR,
             'jsonFlags',
             $factory
         );
@@ -103,11 +106,7 @@ public function testUsesPrettyPrintFlagOnEnabledDebugMode() : void
         $factoryFactory = new ProblemDetailsResponseFactoryFactory();
         $factory = $factoryFactory($this->container->reveal());
 
-        $this->assertAttributeSame(
-            JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION,
-            'jsonFlags',
-            $factory
-        );
+        $this->assertSame(JSON_PRETTY_PRINT, Assert::readAttribute($factory, 'jsonFlags') & JSON_PRETTY_PRINT);
     }
 
     public function testUsesDebugSettingFromConfigWhenPresent() : void

test/ProblemDetailsResponseFactoryTest.php

@@ -39,6 +39,8 @@ class ProblemDetailsResponseFactoryTest extends TestCase
     /** @var ProblemDetailsResponseFactory */
     private $factory;
 
+    private const UTF_8_INVALID_2_OCTET_SEQUENCE = "\xc3\x28";
+
     protected function setUp() : void
     {
         $this->request = $this->prophesize(ServerRequestInterface::class);
@@ -432,4 +434,41 @@ function () {
 
         $this->assertSame($this->response->reveal(), $response);
     }
+
+    public function testRenderWithMalformedUtf8Sequences(): void
+    {
+        $e = $this->prophesize(RuntimeException::class)->willImplement(ProblemDetailsExceptionInterface::class);
+        $e->getStatus()->willReturn(400);
+        $e->getDetail()->willReturn('Exception details');
+        $e->getTitle()->willReturn('Invalid client request');
+        $e->getType()->willReturn('https://example.com/api/doc/invalid-client-request');
+        $e->getAdditionalData()->willReturn([
+            'malformed-utf8' => self::UTF_8_INVALID_2_OCTET_SEQUENCE,
+        ]);
+
+        $this->request->getHeaderLine('Accept')->willReturn('application/json');
+
+        $stream = $this->prophesize(StreamInterface::class);
+        $this->preparePayloadForJsonResponse(
+            $stream,
+            function (array $payload) {
+                Assert::arrayHasKey('malformed-utf8', $payload);
+            }
+        );
+
+        $this->response->getBody()->will([$stream, 'reveal']);
+        $this->response->withStatus(400)->will([$this->response, 'reveal']);
+        $this->response->withHeader('Content-Type', 'application/problem+json')->will([$this->response, 'reveal']);
+
+        $factory = new ProblemDetailsResponseFactory(function () {
+            return $this->response->reveal();
+        });
+
+        $response = $factory->createResponseFromThrowable(
+            $this->request->reveal(),
+            $e->reveal()
+        );
+
+        $this->assertSame($this->response->reveal(), $response);
+    }
 }