[2.x] fix(Mentions): allow renderer to be used without context (#3954)

* fix(Mentions): allow renderer to be used without context * test(Mentions): implement test for rendering post without context * Update UnparsePostMentions.php * Update PostMentionsTest.php --------- Co-authored-by: IanM <[email protected]>
flarum · Jan 10, 2024 · 430709b · 430709b
1 parent f784f48
commit 430709b
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 7 deletions.
diff --git a/extensions/mentions/src/Formatter/FormatPostMentions.php b/extensions/mentions/src/Formatter/FormatPostMentions.php
@@ -12,6 +12,7 @@
 use Flarum\Discussion\Discussion;
 use Flarum\Http\SlugManager;
 use Flarum\Locale\TranslatorInterface;
+use Flarum\Post\Post;
 use Psr\Http\Message\ServerRequestInterface as Request;
 use s9e\TextFormatter\Renderer;
 use s9e\TextFormatter\Utils;
@@ -24,12 +25,22 @@ public function __construct(
     ) {
     }
 
-    public function __invoke(Renderer $renderer, mixed $context, ?string $xml, Request $request = null): string
+    /**
+     * Configure rendering for post mentions.
+     *
+     * @param \s9e\TextFormatter\Renderer $renderer
+     * @param mixed $context
+     * @param string $xml
+     * @param \Psr\Http\Message\ServerRequestInterface|null $request
+     * @return string $xml to be rendered
+     */
+    public function __invoke(Renderer $renderer, $context, $xml, Request $request = null)
     {
-        $post = $context;
+        return Utils::replaceAttributes($xml, 'POSTMENTION', function ($attributes) use ($context) {
+            $post = (($context && isset($context->getRelations()['mentionsPosts'])) || $context instanceof Post)
+                ? $context->mentionsPosts->find($attributes['id'])
+                : Post::find($attributes['id']);
 
-        return Utils::replaceAttributes($xml, 'POSTMENTION', function ($attributes) use ($post) {
-            $post = $post->mentionsPosts->find($attributes['id']);
             if ($post && $post->user) {
                 $attributes['displayname'] = $post->user->display_name;
             }

diff --git a/extensions/mentions/src/Formatter/UnparsePostMentions.php b/extensions/mentions/src/Formatter/UnparsePostMentions.php
@@ -10,6 +10,7 @@
 namespace Flarum\Mentions\Formatter;
 
 use Flarum\Locale\TranslatorInterface;
+use Flarum\Post\Post;
 use s9e\TextFormatter\Utils;
 
 class UnparsePostMentions
@@ -31,10 +32,11 @@ public function __invoke(mixed $context, string $xml): string
      */
     protected function updatePostMentionTags(mixed $context, string $xml): string
     {
-        $post = $context;
+        return Utils::replaceAttributes($xml, 'POSTMENTION', function ($attributes) use ($context) {
+            $post = (($context && isset($context->getRelations()['mentionsPosts'])) || $context instanceof Post)
+                ? $context->mentionsPosts->find($attributes['id'])
+                : Post::find($attributes['id']);
 
-        return Utils::replaceAttributes($xml, 'POSTMENTION', function ($attributes) use ($post) {
-            $post = $post->mentionsPosts->find($attributes['id']);
             if ($post && $post->user) {
                 $attributes['displayname'] = $post->user->display_name;
             }

diff --git a/extensions/mentions/tests/integration/api/PostMentionsTest.php b/extensions/mentions/tests/integration/api/PostMentionsTest.php
@@ -11,7 +11,9 @@
 
 use Carbon\Carbon;
 use Flarum\Extend;
+use Flarum\Formatter\Formatter;
 use Flarum\Post\CommentPost;
+use Flarum\Post\Post;
 use Flarum\Testing\integration\RetrievesAuthorizedUsers;
 use Flarum\Testing\integration\TestCase;
 use Flarum\User\DisplayName\DriverInterface;
@@ -538,6 +540,40 @@ public function editing_a_post_with_a_mention_of_a_post_with_deleted_author_work
         $this->assertStringContainsString('PostMention', $response['data']['attributes']['contentHtml']);
         $this->assertNotNull(CommentPost::find($response['data']['id'])->mentionsPosts->find(11));
     }
+
+    /**
+     * @test
+     */
+    public function rendering_post_mention_with_a_post_context_works()
+    {
+        /** @var Formatter $formatter */
+        $formatter = $this->app()->getContainer()->make(Formatter::class);
+
+        $post = Post::find(4);
+        $user = User::find(1);
+
+        $xml = $formatter->parse($post->content, $post, $user);
+        $renderedHtml = $formatter->render($xml, $post);
+
+        $this->assertStringContainsString('TOBY$', $renderedHtml);
+    }
+
+    /**
+     * @test
+     */
+    public function rendering_post_mention_without_a_context_works()
+    {
+        /** @var Formatter $formatter */
+        $formatter = $this->app()->getContainer()->make(Formatter::class);
+
+        $post = Post::find(4);
+        $user = User::find(1);
+
+        $xml = $formatter->parse($post->content, null, $user);
+        $renderedHtml = $formatter->render($xml);
+
+        $this->assertStringContainsString('TOBY$', $renderedHtml);
+    }
 }
 
 class CustomOtherDisplayNameDriver implements DriverInterface