fix: bump bluesky-social and serialize certain props as objects

socialweb-php · May 25, 2023 · 42dd878 · 42dd878
1 parent 0605233
commit 42dd878
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 4 deletions.
diff --git a/resources/bluesky-social b/resources/bluesky-social
diff --git a/src/Parser/Parser.php b/src/Parser/Parser.php
@@ -13,6 +13,8 @@ public function getParserFactory(): ParserFactory;
     /**
      * @param object | string $data A JSON object or string representation of
      *     the Lexicon entity to parse.
+     *
+     * @throws UnableToParse
      */
     public function parse(object | string $data): LexEntity;
 

diff --git a/src/Types/LexEntityJsonSerializer.php b/src/Types/LexEntityJsonSerializer.php
@@ -5,11 +5,29 @@
 namespace SocialWeb\Atproto\Lexicon\Types;
 
 use function array_filter;
+use function array_walk;
+use function in_array;
 
 trait LexEntityJsonSerializer
 {
+    /**
+     * These properties are key-value pair arrays that are converted to JSON
+     * objects when serialized as JSON. If they are empty, they must be
+     * converted to empty objects for proper serialization.
+     */
+    private const OBJECT_PROPS = ['defs', 'refs', 'properties'];
+
     public function jsonSerialize(): object
     {
-        return (object) array_filter((array) $this, fn (mixed $v): bool => $v !== null);
+        $objectifyProps = function (mixed &$value, string $key): void {
+            if (in_array($key, self::OBJECT_PROPS) && $value === []) {
+                $value = (object) [];
+            }
+        };
+
+        $properties = (array) $this;
+        array_walk($properties, $objectifyProps);
+
+        return (object) array_filter($properties, fn (mixed $v): bool => $v !== null);
     }
 }
diff --git a/tests/ParseCanonicalSchemasTest.php b/tests/ParseCanonicalSchemasTest.php
@@ -4,6 +4,7 @@
 
 namespace SocialWeb\Test\Atproto\Lexicon;
 
+use PHPUnit\Framework\AssertionFailedError;
 use SocialWeb\Atproto\Lexicon\LexiconException;
 use SocialWeb\Atproto\Lexicon\Parser\DefaultParserFactory;
 use SocialWeb\Atproto\Lexicon\Parser\DefaultSchemaRepository;
@@ -65,7 +66,7 @@ public function testParsingCanonicalSchemas(): void
 
                 // Make sure the structure we created matches the original document.
                 $this->assertJsonStringEqualsJsonString($file->getContents(), (string) json_encode($document));
-            } catch (LexiconException $exception) {
+            } catch (LexiconException | AssertionFailedError $exception) {
                 $failedSchemas[] = [
                     'file' => $file->getRealPath(),
                     'error' => $exception->getMessage(),

diff --git a/tests/Types/LexEntityJsonSerializerTest.php b/tests/Types/LexEntityJsonSerializerTest.php
@@ -23,6 +23,15 @@ public function testJsonSerializeDoesNotFilterOutFalsyValues(): void
 
             /** @var mixed[] | null */
             public ?array $qux = null;
+
+            /** @var array<string, mixed> */
+            public array $defs = [];
+
+            /** @var array<string, mixed> */
+            public array $refs = [];
+
+            /** @var array<string, mixed> */
+            public array $properties = [];
         };
 
         $sut->foo = '';
@@ -31,7 +40,7 @@ public function testJsonSerializeDoesNotFilterOutFalsyValues(): void
         $sut->qux = [];
 
         $this->assertJsonStringEqualsJsonString(
-            '{"foo":"","bar":0,"baz":false,"qux":[]}',
+            '{"foo":"","bar":0,"baz":false,"qux":[],"defs":{},"refs":{},"properties":{}}',
             (string) json_encode($sut),
         );
     }
@@ -69,6 +78,15 @@ public function testJsonSerializeReturnsEmptyObjectWhenAllValuesAreNull(): void
 
             /** @var mixed[] | null */
             public ?array $qux = null;
+
+            /** @var array<string, mixed> | null */
+            public ?array $defs = null;
+
+            /** @var array<string, mixed> | null */
+            public ?array $refs = null;
+
+            /** @var array<string, mixed> | null */
+            public ?array $properties = null;
         };
 
         $this->assertJsonStringEqualsJsonString(