fix: ResolveLinks looses anchor (#94)

Author: silasjoisten

src/Domain/Value/Link.php

@@ -34,6 +34,7 @@
     public bool $isFolder;
     public bool $isStartPage;
     public bool $isPublished;
+    public ?string $anchor;
 
     /**
      * @var list<LinkAlternate>
@@ -103,6 +104,16 @@ public function __construct(array $values)
         Assert::keyExists($values, 'published');
         $this->isPublished = true === $values['published'];
 
+        // This field is only set when using the stories api with resolve_links flag
+        // and the original multilink field contains an anchor.
+        $anchor = null;
+
+        if (\array_key_exists('anchor', $values) && null !== $values['anchor'] && '' !== $values['anchor']) {
+            $anchor = TrimmedNonEmptyString::fromString($values['anchor'], 'The value of the "anchor" key must be a non-empty, trimmed string. Got: %s')->toString();
+        }
+
+        $this->anchor = $anchor;
+
         $alternates = [];
 
         if (\array_key_exists('alternates', $values) && null !== $values['alternates'] && [] !== $values['alternates']) {

src/Resolver/StoryResolver.php

@@ -50,7 +50,15 @@ private function doResolve(array &$target, array &$relationMap): void
             if (\is_string($value) && isset($relationMap[$value])) {
                 $value = $relationMap[$value];
             } elseif (\is_array($value) && isset($value['id'], $relationMap[$value['id']])) {
-                $value = $relationMap[$value['id']];
+                $resolved = $relationMap[$value['id']];
+
+                // Preserve the anchor from the original multilink field, as it is not part
+                // of the resolved link payload but user-defined on the multilink itself.
+                if (\array_key_exists('anchor', $value) && null !== $value['anchor'] && '' !== $value['anchor']) {
+                    $resolved['anchor'] = $value['anchor'];
+                }
+
+                $value = $resolved;
             } elseif (\is_array($value)) {
                 $this->doResolve($value, $relationMap);
             }

tests/Unit/Domain/Value/LinkTest.php

@@ -480,6 +480,47 @@ public function fullSlugMustBeValidString(string $value): void
         new Link($values);
     }
 
+    #[Test]
+    public function anchor(): void
+    {
+        $faker = self::faker();
+
+        $values = $faker->linkResponse(['anchor' => $anchor = $faker->word()]);
+
+        self::assertSame($anchor, (new Link($values))->anchor);
+    }
+
+    #[Test]
+    public function anchorIsOptional(): void
+    {
+        $faker = self::faker();
+
+        $values = $faker->linkResponse();
+        unset($values['anchor']);
+
+        self::assertNull((new Link($values))->anchor);
+    }
+
+    #[Test]
+    public function anchorIsOptionalWithNull(): void
+    {
+        $faker = self::faker();
+
+        $values = $faker->linkResponse(['anchor' => null]);
+
+        self::assertNull((new Link($values))->anchor);
+    }
+
+    #[Test]
+    public function anchorIsOptionalWithEmptyString(): void
+    {
+        $faker = self::faker();
+
+        $values = $faker->linkResponse(['anchor' => '']);
+
+        self::assertNull((new Link($values))->anchor);
+    }
+
     #[Test]
     public function getSlugWithNullReturnsFullSlugWhenAvailable(): void
     {

tests/Unit/Resolver/StoryResolverTest.php

@@ -159,6 +159,77 @@ public function resolveWithComplexStructure(): void
         self::assertSame($expected, $resolver->resolve($story, $references));
     }
 
+    #[Test]
+    public function resolveReplacesMultiLinkWithLinkPayloadAndPreservesAnchor(): void
+    {
+        $resolver = new StoryResolver();
+
+        $faker = self::faker();
+
+        $story = [
+            'name' => $faker->word(),
+            'content' => [
+                'link' => [
+                    'id' => $referenceUuid = $faker->uuid(),
+                    'url' => '',
+                    'anchor' => $anchor = $faker->word(),
+                    'linktype' => 'story',
+                    'fieldtype' => 'multilink',
+                    'cached_url' => 'contact',
+                ],
+            ],
+        ];
+
+        $references = [
+            $reference = [
+                'uuid' => $referenceUuid,
+                'name' => $faker->word(),
+                'another_field' => $faker->sentence(),
+            ],
+        ];
+
+        $expected = $story;
+        $expected['content']['link'] = $reference;
+        $expected['content']['link']['anchor'] = $anchor;
+
+        self::assertSame($expected, $resolver->resolve($story, $references));
+    }
+
+    #[Test]
+    public function resolveReplacesMultiLinkWithLinkPayloadAndDoesNotPreserveEmptyAnchor(): void
+    {
+        $resolver = new StoryResolver();
+
+        $faker = self::faker();
+
+        $story = [
+            'name' => $faker->word(),
+            'content' => [
+                'link' => [
+                    'id' => $referenceUuid = $faker->uuid(),
+                    'url' => '',
+                    'anchor' => '',
+                    'linktype' => 'story',
+                    'fieldtype' => 'multilink',
+                    'cached_url' => 'contact',
+                ],
+            ],
+        ];
+
+        $references = [
+            $reference = [
+                'uuid' => $referenceUuid,
+                'name' => $faker->word(),
+                'another_field' => $faker->sentence(),
+            ],
+        ];
+
+        $expected = $story;
+        $expected['content']['link'] = $reference;
+
+        self::assertSame($expected, $resolver->resolve($story, $references));
+    }
+
     #[Test]
     public function resolveReplacesMultiLinkWithLinkPayload(): void
     {