bugfix: document type json body

Author: Sean O'Brien

.changes/nextrelease/fix-json-body-doc-types.json

@@ -0,0 +1,7 @@
+[
+  {
+    "type": "bugfix",
+    "category": "Api",
+    "description": "Fixes bug in serializing Document type JSON bodies"
+  }
+]

src/Api/Serializer/JsonBody.php

@@ -49,8 +49,13 @@ public static function getContentType(Service $service)
      *
      * @return string
      */
-    public function build(Shape $shape, array $args)
+    public function build(Shape $shape, array|string $args)
     {
+        // For Document shapes, args might be any JSON value, not just arrays
+        if ($shape['document'] ?? false) {
+            return json_encode($args, JSON_THROW_ON_ERROR);
+        }
+
         $result = json_encode($this->format($shape, $args));
         return $result == '[]' ? '{}' : $result;
     }

src/Api/Serializer/RestJsonSerializer.php

@@ -31,7 +31,7 @@ public function __construct(
         $this->jsonFormatter = $jsonFormatter ?: new JsonBody($api);
     }
 
-    protected function payload(StructureShape $member, array $value, array &$opts)
+    protected function payload(StructureShape $member, array|string $value, array &$opts)
     {
         $body = isset($value) ?
             ((string) $this->jsonFormatter->build($member, $value))

tests/Api/Serializer/JsonBodyTest.php

@@ -226,4 +226,35 @@ public function testFormatsJsonDoesNotCreateReferences($def, $args, $result)
         $builtShape = $j->build($shape, $args);
         $this->assertEquals($result, $builtShape);
     }
+
+    /**
+     * @param $args
+     * @param $expected
+     *
+     * @return void
+     * @throws \JsonException
+     * @dataProvider buildsDocTypesProvider
+     */
+    public function testBuildsDocTypes($args, $expected): void
+    {
+        $j = new JsonBody(new Service([], function() { return []; }));
+        $shape = Shape::create(
+            [
+                'type' => 'structure',
+                'members' => [],
+                'document' => true,
+            ]
+            , new ShapeMap([])
+        );
+        $builtShape = $j->build($shape, $args);
+        $this->assertEquals($expected, $builtShape);
+    }
+
+    public function buildsDocTypesProvider(): iterable
+    {
+        return [
+            ['hello', '"hello"'],
+            [['foo' => 'bar'], '{"foo":"bar"}']
+        ];
+    }
 }

tests/Api/Serializer/RestJsonSerializerTest.php

@@ -66,6 +66,21 @@ private function getTestService()
                             'requestUri' => 'foo/{PathSegment}'
                         ],
                         'input' => ['shape' => 'RequestUriOperationInput'],
+                    ],
+                    'DocumentTypeAsPayload' => [
+                        'name' => 'DocumentTypeAsPayload',
+                        'http' => [
+                            'method' => 'PUT',
+                            'requestUri' => '/DocumentTypeAsPayload',
+                            'responseCode' => 200
+                        ],
+                        'input' => [
+                            'shape' => 'DocumentTypeAsPayloadInputOutput'
+                        ],
+                        'output' => [
+                            'shape' => 'DocumentTypeAsPayloadInputOutput'
+                        ],
+                        'idempotent' => true
                     ]
                 ],
                 'shapes' => [
@@ -83,6 +98,15 @@ private function getTestService()
                             ]
                         ]
                     ],
+                    'DocumentTypeAsPayloadInputOutput' => [
+                        'type' => 'structure',
+                        'members' => [
+                            'documentValue' => [
+                                'shape' => 'DocumentType'
+                            ]
+                        ],
+                        'payload' => 'documentValue'
+                    ],
                     'RequestUriOperationInput' => [
                         'required' => ['PathSegment'],
                         'type' => 'structure',
@@ -94,9 +118,10 @@ private function getTestService()
                             'baz' => ['shape' => 'BazShape']
                         ]
                     ],
-                    "DocumentType" => [
-                        "type" => "structure",
-                        "document" => true
+                    'DocumentType' => [
+                        'type' => 'structure',
+                        'members' => [],
+                        'document' => true,
                     ],
                     'BarInput' => [
                         'type' => 'structure',
@@ -328,10 +353,36 @@ public function doctypeTestProvider() {
                     ]
                 ],
                 '{"DocumentValue":{"DocumentType":2}}'
-            ],
+            ]
         ];
     }
 
+    /**
+     * @param $input
+     * @param $expectedOutput
+     *
+     * @return void
+     * @dataProvider handlesDocTypeAsPayloadProvider
+     */
+    public function testHandlesDocTypeAsPayload($input, $expectedOutput): void
+    {
+        $request = $this->getRequest('DocumentTypeAsPayload', ['documentValue' => $input]);
+        $this->assertSame('PUT', $request->getMethod());
+        $this->assertSame('http://foo.com/DocumentTypeAsPayload', (string) $request->getUri());
+        $this->assertSame($expectedOutput, $request->getBody()->getContents());
+        $this->assertSame(
+            'application/json',
+            $request->getHeaderLine('Content-Type')
+        );
+    }
+
+    public function handlesDocTypeAsPayloadProvider(): iterable
+    {
+        return [
+            ['hello', '"hello"'],
+            [['foo' => 'bar'], '{"foo":"bar"}']
+        ];
+    }
 
     /**
      * @dataProvider restJsonContentTypeProvider