TASK: Document NodeAggregateWasMovedTest Test

Followup to neos#5070
mhsdesign · Jun 19, 2024 · a9e8fa6 · a9e8fa6
1 parent 1ede8e5
commit a9e8fa6
Showing 1 changed file with 10 additions and 3 deletions.
diff --git a/Neos.ContentRepository.Core/Tests/Unit/Feature/NodeMove/Event/NodeAggregateWasMovedTest.php b/Neos.ContentRepository.Core/Tests/Unit/Feature/NodeMove/Event/NodeAggregateWasMovedTest.php
@@ -28,17 +28,24 @@ class NodeAggregateWasMovedTest extends TestCase
 {
     /**
      * @param array<string,mixed> $payload
-     * @dataProvider eventPayloadProvider
+     * @dataProvider eventPayloadProviderWithLegacyNodeMoveMappingsFormat
      */
     public function testFromArray(array $payload, NodeAggregateWasMoved $expectedEvent): void
     {
         self::assertEquals($expectedEvent, NodeAggregateWasMoved::fromArray($payload));
     }
 
     /**
-     * @return \Traversable<string,array<string,mixed>>
+     * The `MoveNodeMappings` were replaced with `InterdimensionalSiblings`.
+     * A runtime migration was added to {@see NodeAggregateWasMoved::fromArray()} to handle the legacy format.
+     *
+     * Via #4993: https://github.com/neos/neos-development-collection/pull/4993
+     *
+     * Included in April 2024
+     *
+     * @return iterable<mixed>
      */
-    public static function eventPayloadProvider(): \Traversable
+    public static function eventPayloadProviderWithLegacyNodeMoveMappingsFormat(): iterable
     {
         yield 'singleNodeMoveMappingWithSibling' => [
             'payload' => [