TASK: Introduce SerializedPropertyValues::withoutUnsets

To make the code more obvious
neos · Feb 2, 2024 · 4892292 · 4892292
1 parent 2e92b68
commit 4892292
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 17 deletions.
diff --git a/Neos.ContentGraph.DoctrineDbalAdapter/src/Domain/Projection/NodeRecord.php b/Neos.ContentGraph.DoctrineDbalAdapter/src/Domain/Projection/NodeRecord.php
@@ -58,7 +58,8 @@ public function updateToDatabase(Connection $databaseConnection, string $tableNa
                 'nodeaggregateid' => $this->nodeAggregateId->value,
                 'origindimensionspacepoint' => json_encode($this->originDimensionSpacePoint),
                 'origindimensionspacepointhash' => $this->originDimensionSpacePointHash,
-                'properties' => self::propertyValuesToJson($this->properties),
+                // we don't write null explicitly into the database
+                'properties' => json_encode($this->properties->withoutUnsets()),
                 'nodetypename' => $this->nodeTypeName->value,
                 'classification' => $this->classification->value,
                 'lastmodified' => $this->timestamps->lastModified,
@@ -143,7 +144,8 @@ public static function createNewInDatabase(
             'nodeaggregateid' => $nodeAggregateId->value,
             'origindimensionspacepoint' => json_encode($originDimensionSpacePoint),
             'origindimensionspacepointhash' => $originDimensionSpacePointHash,
-            'properties' => self::propertyValuesToJson($properties),
+            // we don't write null explicitly into the database
+            'properties' => json_encode($properties->withoutUnsets()),
             'nodetypename' => $nodeTypeName->value,
             'classification' => $classification->value,
             'created' => $timestamps->created,
@@ -200,19 +202,6 @@ public static function createCopyFromNodeRecord(
         );
     }
 
-    private static function propertyValuesToJson(SerializedPropertyValues $serializedPropertyValues): string
-    {
-        $values = [];
-        foreach ($serializedPropertyValues->values as $name => $serializedValue) {
-            if ($serializedValue instanceof UnsetPropertyValue) {
-                // we don't write null explicitly into the database
-                continue;
-            }
-            $values[$name] = $serializedValue;
-        }
-        return json_encode($values, JSON_THROW_ON_ERROR);
-    }
-
     private static function parseDateTimeString(string $string): \DateTimeImmutable
     {
         $result = \DateTimeImmutable::createFromFormat('Y-m-d H:i:s', $string);

diff --git a/....ContentRepository.Core/Classes/Feature/NodeModification/Dto/SerializedPropertyValues.php b/....ContentRepository.Core/Classes/Feature/NodeModification/Dto/SerializedPropertyValues.php
@@ -101,6 +101,18 @@ public function merge(self $other): self
         return new self(array_merge($this->values, $other->values));
     }
 
+    public function withoutUnsets(): self
+    {
+        $values = [];
+        foreach ($this->values as $name => $serializedValue) {
+            if ($serializedValue instanceof UnsetPropertyValue) {
+                continue;
+            }
+            $values[$name] = $serializedValue;
+        }
+        return new self($values);
+    }
+
     /**
      * @return array<string,self>
      */

diff --git a/...tRepository.Core/Tests/Unit/Feature/NodeModification/Dto/SerializedPropertyValuesTest.php b/...tRepository.Core/Tests/Unit/Feature/NodeModification/Dto/SerializedPropertyValuesTest.php
@@ -76,10 +76,24 @@ public function jsonSerializeReturnsNullForUnsetValues(): void
      */
     public function getPlainValuesReturnsNullForUnsetValues(): void
     {
-        $propertyValues = SerializedPropertyValues::fromArray(['someProperty' => UnsetPropertyValue::get(), 'otherProperty' => SerializedPropertyValue::create('mehehe', 'string')]);
+        $propertyValues = SerializedPropertyValues::fromArray(['someProperty' => UnsetPropertyValue::get(), 'otherProperty' => SerializedPropertyValue::create('me-he-he', 'string')]);
         self::assertSame(
-            ['someProperty' => null, 'otherProperty' => 'mehehe'],
+            ['someProperty' => null, 'otherProperty' => 'me-he-he'],
             $propertyValues->getPlainValues()
         );
     }
+
+    /**
+     * @test
+     */
+    public function withoutUnsets(): void
+    {
+        // the format which is implicitly used in the event log, due to json_serialize
+        $propertyValues = SerializedPropertyValues::fromArray(['someProperty' => UnsetPropertyValue::get(), 'otherProperty' => SerializedPropertyValue::create('text', 'string'), 'reputation' => UnsetPropertyValue::get()]);
+        self::assertEquals(
+            SerializedPropertyValues::fromArray(['otherProperty' => SerializedPropertyValue::create('text', 'string')]),
+            $propertyValues->withoutUnsets()
+        );
+    }
+
 }