[2.x] fix(api): surface event posts in discussion PATCH responses and route title via rename() (#4658)

* [2.x] fix(api): surface event posts in discussion PATCH responses and route title via rename()

Fixes two related 2.x regressions where discussion changes silently
fail to surface in the UI:

1. Event posts created via `mergePost()` (sticky/tags/lock) were absent
   from PATCH responses. The 1.x `UpdateDiscussionController` refreshed
   the `posts` linkage and inlined modified posts on every update; the
   2.x `DiscussionResource` rewrite dropped that.

2. Renaming a discussion no longer raised `Renamed`. The 2.x
   `DiscussionResource` title field delegated to the default attribute
   setter, bypassing `Discussion::rename()`. The
   `DiscussionRenamedLogger` listener never ran, so neither the
   `discussionRenamed` event post nor the notification fired.

Together these broke the "rename -> event post appears -> author gets
notified" flow that worked end-to-end in 1.x.

Core fixes:
- `DiscussionResource::posts` field now exposes linkage on update
- `DiscussionResource::title` field now routes through `rename()`
- `RenameDiscussionModal` chains redraw onto the `update()` promise

Sticky/Tags/Lock JS:
- Chain redraw onto the `stream.update()` promise (was firing
  synchronously, before the new post was in-store)

Sticky/Tags realtime:
- Register broadcasts via the Realtime extender so other users see
  the event posts as they happen, mirroring the existing `lock`
  template. Recipient permission is enforced per-user by the Realtime
  Generator (internal API request runs as the recipient).

Closes #4620

* [2.x] chore(ts): map ext:flarum/realtime/* path in sticky and tags tsconfig

build-typings was failing because the new `extendRealtime.ts` files
import from `ext:flarum/realtime/forum/extenders/Realtime`, but
neither extension's tsconfig.json mapped that module specifier to
realtime's dist-typings. Mirror the mapping that flarum-lock already
has.

Author: imorland

extensions/lock/js/src/forum/addLockControl.js

@@ -19,10 +19,13 @@ export default function addLockControl() {
   DiscussionControls.lockAction = function () {
     this.save({ isLocked: !this.isLocked() }).then(() => {
       if (app.current.matches(DiscussionPage)) {
-        app.current.get('stream').update();
+        app.current
+          .get('stream')
+          .update()
+          .then(() => m.redraw());
+      } else {
+        m.redraw();
       }
-
-      m.redraw();
     });
   };
 }

extensions/sticky/extend.php

@@ -12,6 +12,7 @@
 use Flarum\Discussion\Discussion;
 use Flarum\Discussion\Search\DiscussionSearcher;
 use Flarum\Extend;
+use Flarum\Realtime\Extend\Realtime as RealtimeExtend;
 use Flarum\Search\Database\DatabaseSearchDriver;
 use Flarum\Sticky\Api\DiscussionResourceFields;
 use Flarum\Sticky\Event\DiscussionWasStickied;
@@ -58,4 +59,15 @@
     (new Extend\Settings())
         ->default('flarum-sticky.only_sticky_unread_discussions', true)
         ->serializeToForum('onlyStickyUnreadDiscussions', 'flarum-sticky.only_sticky_unread_discussions', 'boolval'),
+
+    (new Extend\Conditional())
+        ->whenExtensionEnabled('flarum-realtime', fn () => [
+            (new RealtimeExtend())
+                ->broadcastModelEvent(
+                    [DiscussionWasStickied::class, DiscussionWasUnstickied::class],
+                    fn ($event) => $event->discussion,
+                    fn ($event) => $event->user,
+                    'stickiedEvent'
+                ),
+        ]),
 ];

extensions/sticky/js/src/forum/addStickyControl.js

@@ -19,10 +19,13 @@ export default function addStickyControl() {
   DiscussionControls.stickyAction = function () {
     this.save({ isSticky: !this.isSticky() }).then(() => {
       if (app.current.matches(DiscussionPage)) {
-        app.current.get('stream').update();
+        app.current
+          .get('stream')
+          .update()
+          .then(() => m.redraw());
+      } else {
+        m.redraw();
       }
-
-      m.redraw();
     });
   };
 }

extensions/sticky/js/src/forum/extendRealtime.ts

@@ -0,0 +1,6 @@
+import app from 'flarum/forum/app';
+import RealtimeExtend from 'ext:flarum/realtime/forum/extenders/Realtime';
+
+export default function extendRealtime() {
+  new RealtimeExtend().onDiscussionStreamEvent('stickiedEvent').extend(app, { name: 'flarum-sticky', exports: {} });
+}

extensions/sticky/js/src/forum/index.js

@@ -4,6 +4,7 @@ import addStickyBadge from './addStickyBadge';
 import addStickyControl from './addStickyControl';
 import addStickyExcerpt from './addStickyExcerpt';
 import addStickyClass from './addStickyClass';
+import extendRealtime from './extendRealtime';
 
 export { default as extend } from './extend';
 
@@ -12,4 +13,10 @@ app.initializers.add('flarum-sticky', () => {
   addStickyControl();
   addStickyExcerpt();
   addStickyClass();
+
+  // Register a discussion stream update event with flarum/realtime when enabled.
+  // Stickying or unstickying a discussion will trigger a DiscussionPage stream reload for other users.
+  if ('flarum-realtime' in flarum.extensions) {
+    extendRealtime();
+  }
 });

extensions/sticky/js/tsconfig.json

@@ -4,12 +4,13 @@
   // This will match all .ts, .tsx, .d.ts, .js, .jsx files in your `src` folder
   // and also tells your Typescript server to read core's global typings for
   // access to `dayjs` and `$` in the global namespace.
-  "include": ["src/**/*", "../../../framework/core/js/dist-typings/@types/**/*", "@types/**/*"],
+  "include": ["src/**/*", "../../../framework/core/js/dist-typings/@types/**/*", "@types/**/*", "../../realtime/js/dist-typings/@types/**/*"],
   "compilerOptions": {
     // This will output typings to `dist-typings`
     "declarationDir": "./dist-typings",
     "paths": {
-      "flarum/*": ["../../../framework/core/js/dist-typings/*"]
+      "flarum/*": ["../../../framework/core/js/dist-typings/*"],
+      "ext:flarum/realtime/*": ["../../realtime/js/dist-typings/*"]
     }
   }
 }

extensions/sticky/tests/integration/api/StickyDiscussionsTest.php

@@ -98,4 +98,54 @@ public static function stickyDataProvider(): array
             [3, false, false],
         ];
     }
+
+    #[Test]
+    public function sticky_response_exposes_new_event_post_in_linkage()
+    {
+        // Discussion 2 starts un-stickied with one comment post (id 2). Stickying
+        // creates a `discussionStickied` event post via mergePost(). The PATCH
+        // response must surface that new post in the discussion's `posts`
+        // relationship linkage so the client can refresh its post stream without
+        // a full reload. See flarum/framework#TBD.
+        $response = $this->send(
+            $this->request('PATCH', '/api/discussions/2', [
+                'authenticatedAs' => 1,
+                'json' => [
+                    'data' => [
+                        'attributes' => [
+                            'isSticky' => true,
+                        ],
+                    ],
+                ],
+            ])
+        );
+
+        $body = $response->getBody()->getContents();
+        $json = json_decode($body, true);
+
+        $this->assertEquals(200, $response->getStatusCode(), $body);
+
+        $linkage = $json['data']['relationships']['posts']['data'] ?? null;
+        $this->assertIsArray($linkage, 'PATCH response must include the discussion posts relationship linkage');
+
+        $linkageIds = array_map(fn (array $entry) => $entry['id'], $linkage);
+
+        // The original comment post is still there.
+        $this->assertContains('2', $linkageIds, 'Linkage should still contain the original comment post id');
+
+        // And the newly-created event post is too — its id is whatever the next
+        // available id is after the fixture posts (1–4). The discussion gained
+        // exactly one post; assert the linkage grew by one.
+        $this->assertCount(2, $linkageIds, 'Linkage should contain the comment post and the new event post');
+
+        // Identify the new post id (the one that isn't '2') and assert it
+        // corresponds to a `discussionStickied` post in the included array.
+        $newPostId = array_values(array_diff($linkageIds, ['2']))[0] ?? null;
+        $this->assertNotNull($newPostId);
+
+        $stickiedRow = Post::query()->find($newPostId);
+        $this->assertNotNull($stickiedRow, 'New post in linkage should exist');
+        $this->assertEquals('discussionStickied', $stickiedRow->type);
+        $this->assertEquals(2, $stickiedRow->discussion_id);
+    }
 }

extensions/tags/extend.php

@@ -17,6 +17,7 @@
 use Flarum\Flags\Api\Resource\FlagResource;
 use Flarum\Post\Filter\PostSearcher;
 use Flarum\Post\Post;
+use Flarum\Realtime\Extend\Realtime as RealtimeExtend;
 use Flarum\Search\Database\DatabaseSearchDriver;
 use Flarum\Tags\Access;
 use Flarum\Tags\Api;
@@ -178,4 +179,15 @@ function (Endpoint\Index|Endpoint\Show|Endpoint\Create $endpoint) {
             return $endpoint
                 ->addDefaultInclude(['eventPostMentionsTags']);
         }),
+
+    (new Extend\Conditional())
+        ->whenExtensionEnabled('flarum-realtime', fn () => [
+            (new RealtimeExtend())
+                ->broadcastModelEvent(
+                    [DiscussionWasTagged::class],
+                    fn ($event) => $event->discussion,
+                    fn ($event) => $event->actor,
+                    'taggedEvent'
+                ),
+        ]),
 ];

extensions/tags/js/src/forum/components/TagDiscussionModal.tsx

@@ -49,10 +49,13 @@ export default class TagDiscussionModal extends TagSelectionModal<TagDiscussionM
       if (discussion) {
         discussion.save({ relationships: { tags } }).then(() => {
           if (app.current.matches(DiscussionPage)) {
-            app.current.get('stream').update();
+            app.current
+              .get('stream')
+              .update()
+              .then(() => m.redraw());
+          } else {
+            m.redraw();
           }
-
-          m.redraw();
         });
       }
 

extensions/tags/js/src/forum/extendRealtime.ts

@@ -0,0 +1,6 @@
+import app from 'flarum/forum/app';
+import RealtimeExtend from 'ext:flarum/realtime/forum/extenders/Realtime';
+
+export default function extendRealtime() {
+  new RealtimeExtend().onDiscussionStreamEvent('taggedEvent').extend(app, { name: 'flarum-tags', exports: {} });
+}