[2.x] feat: add setting to disable sticky pinning on All Discussions page (#4609)

* feat(sticky): add setting to disable sticky pinning on All Discussions

Adds an admin toggle (default: enabled) that gates sticky pinning on
the All Discussions page. When disabled, stickied discussions appear
at their natural last_posted_at position. Tag pages are unaffected.

Restructures PinStickiedDiscussionsToTop so the new toggle is the
master gate for /all and properly subordinates only_sticky_unread_-
discussions, which is shown disabled in the admin UI when the master
toggle is off.

Consolidates multiple Extend\Settings declarations into one block.

* test(sticky): pin no-sticky-pinning behaviour on a non-tag filter

With only_sticky_unread_discussions off, the reordered mutator no longer
pins stickied discussions on filtered listings other than a single tag page
(e.g. a by-author search) — pinning is scoped to /all and single-tag pages.
This locks that behaviour, which previously went untested.

---------

Co-authored-by: IanM <ian@morland.me>

Author: gianniguida

extensions/sticky/extend.php

@@ -33,8 +33,11 @@
     new Extend\Locales(__DIR__.'/locale'),
 
     (new Extend\Settings())
+        ->default('flarum-sticky.enable_display_excerpt', true)
+        ->default('flarum-sticky.only_sticky_unread_discussions', true)
+        ->default('flarum-sticky.pin_sticky_on_all_discussions', true)
         ->serializeToForum('excerptDisplayEnabled', 'flarum-sticky.enable_display_excerpt', 'boolval')
-        ->default('flarum-sticky.enable_display_excerpt', true),
+        ->serializeToForum('onlyStickyUnreadDiscussions', 'flarum-sticky.only_sticky_unread_discussions', 'boolval'),
 
     (new Extend\Model(Discussion::class))
         ->cast('is_sticky', 'bool'),
@@ -56,10 +59,6 @@
         ->addFilter(DiscussionSearcher::class, StickyFilter::class)
         ->addMutator(DiscussionSearcher::class, PinStickiedDiscussionsToTop::class),
 
-    (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())

extensions/sticky/js/src/admin/extend.tsx

@@ -15,13 +15,25 @@ export default [
       'moderate',
       95
     )
+    .setting(
+      () => ({
+        setting: 'flarum-sticky.pin_sticky_on_all_discussions',
+        name: 'pinStickyOnAllDiscussions',
+        type: 'boolean',
+        label: app.translator.trans('flarum-sticky.admin.settings.pin_sticky_on_all_discussions_label'),
+        help: app.translator.trans('flarum-sticky.admin.settings.pin_sticky_on_all_discussions_help'),
+      }),
+      95
+    )
     .setting(
       () => ({
         setting: 'flarum-sticky.only_sticky_unread_discussions',
         name: 'onlyStickyUnreadDiscussions',
         type: 'boolean',
         label: app.translator.trans('flarum-sticky.admin.settings.only_sticky_unread_discussions_label'),
         help: app.translator.trans('flarum-sticky.admin.settings.only_sticky_unread_discussions_help'),
+        // Only meaningful when sticky pinning is enabled on the All Discussions page.
+        disabled: app.data.settings['flarum-sticky.pin_sticky_on_all_discussions'] === '0',
       }),
       90
     )

extensions/sticky/locale/en.yml

@@ -10,6 +10,8 @@ flarum-sticky:
       enable_display_excerpt: Show an excerpt of the first post when a sticky discussion is unread
       only_sticky_unread_discussions_label: Only sticky unread discussions
       only_sticky_unread_discussions_help: On the All Discussions page, unread sticky discussions pin to the top, while read sticky discussions follow the regular order.
+      pin_sticky_on_all_discussions_label: Pin stickied discussions on the All Discussions page
+      pin_sticky_on_all_discussions_help: When enabled (default), stickied discussions are pinned at the top of the All Discussions page. When disabled, they appear at their natural position by latest activity. Tag pages always pin stickied discussions to the top regardless of this setting.
 
     # These translations are used in the Permissions page of the admin interface.
     permissions:

extensions/sticky/src/PinStickiedDiscussionsToTop.php

@@ -27,18 +27,8 @@ public function __invoke(DatabaseSearchState $state, SearchCriteria $criteria):
     {
         if ($criteria->sortIsDefault && ! $state->isFulltextSearch()) {
             $query = $state->getQuery()->getQuery();
-            $onlyStickyUnread = $this->settings->get('flarum-sticky.only_sticky_unread_discussions');
 
-            // If only sticky unread discussions is disabled, then pin all stickied
-            // discussions to the top whether they are read or not.
-            if (! $onlyStickyUnread) {
-                $this->pinStickiedToTop($query);
-
-                return;
-            }
-
-            // If we are viewing a specific tag, then pin all stickied
-            // discussions to the top no matter what.
+            // Tag pages always pin stickied discussions to the top.
             $filters = $state->getActiveFilters();
 
             if ($count = count($filters)) {
@@ -49,10 +39,27 @@ public function __invoke(DatabaseSearchState $state, SearchCriteria $criteria):
                 return;
             }
 
-            // Otherwise, if we are viewing "all discussions", only pin stickied
-            // discussions to the top if they are unread. To do this in a
-            // performant way we create another query which will select all
-            // stickied discussions, marry them into the main query, and then
+            // The remainder of this method handles the All Discussions page only.
+
+            // Admins can disable sticky pinning on this page entirely. When disabled,
+            // stickied discussions appear at their natural last_posted_at position
+            // and the only_sticky_unread_discussions setting becomes a no-op (the
+            // distinction between read and unread sticky no longer matters).
+            if (! $this->settings->get('flarum-sticky.pin_sticky_on_all_discussions', true)) {
+                return;
+            }
+
+            // If unread-only floating is disabled, pin all stickied discussions to
+            // the top regardless of read state.
+            if (! $this->settings->get('flarum-sticky.only_sticky_unread_discussions')) {
+                $this->pinStickiedToTop($query);
+
+                return;
+            }
+
+            // Otherwise, only pin stickied discussions to the top if they are unread.
+            // To do this in a performant way we create another query which will select
+            // all stickied discussions, marry them into the main query, and then
             // reorder the unread ones up to the top.
             $sticky = clone $query;
             $sticky->where('is_sticky', true);

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

@@ -193,4 +193,97 @@ public function list_discussions_shows_stick_first_on_a_tag()
 
         $this->assertEquals([3, 1, 2, 4], Arr::pluck($data['data'], 'id'));
     }
+
+    #[Test]
+    public function list_discussions_does_not_pin_sticky_on_all_when_pin_setting_disabled_as_guest()
+    {
+        $this->setting('flarum-sticky.pin_sticky_on_all_discussions', false);
+
+        $response = $this->send(
+            $this->request('GET', '/api/discussions')
+        );
+
+        $this->assertEquals(200, $response->getStatusCode(), $body = $response->getBody()->getContents());
+
+        $data = json_decode($body, true);
+
+        $this->assertEquals([2, 4, 3, 1], Arr::pluck($data['data'], 'id'));
+    }
+
+    #[Test]
+    public function list_discussions_pin_setting_disabled_overrides_only_unread_setting_on_all()
+    {
+        // pin_sticky_on_all_discussions is the master gate for /all and must
+        // override only_sticky_unread_discussions when both are flipped.
+        $this->setting('flarum-sticky.pin_sticky_on_all_discussions', false);
+        $this->setting('flarum-sticky.only_sticky_unread_discussions', false);
+
+        $response = $this->send(
+            $this->request('GET', '/api/discussions', [
+                'authenticatedAs' => 2
+            ])
+        );
+
+        $this->assertEquals(200, $response->getStatusCode(), $body = $response->getBody()->getContents());
+
+        $data = json_decode($body, true);
+
+        $this->assertEquals([2, 4, 3, 1], Arr::pluck($data['data'], 'id'));
+    }
+
+    #[Test]
+    public function list_discussions_pin_setting_disabled_does_not_affect_tag_pages()
+    {
+        $this->setting('flarum-sticky.pin_sticky_on_all_discussions', false);
+
+        $response = $this->send(
+            $this->request('GET', '/api/discussions', [
+                'authenticatedAs' => 3
+            ])->withQueryParams([
+                'filter' => [
+                    'tag' => 'general'
+                ]
+            ])
+        );
+
+        $this->assertEquals(200, $response->getStatusCode(), $body = $response->getBody()->getContents());
+
+        $data = json_decode($body, true);
+
+        $this->assertEquals([3, 1, 2, 4], Arr::pluck($data['data'], 'id'));
+    }
+
+    #[Test]
+    public function list_discussions_only_unread_off_does_not_pin_sticky_on_a_non_tag_filter()
+    {
+        // With only_sticky_unread_discussions off, pinning applies to the
+        // All Discussions page and to a single-tag page — but NOT to other
+        // filtered listings (e.g. a by-author search). Previously the
+        // "pin all when only_unread is off" branch ran ahead of the filter
+        // check, so it pinned sticky on any filtered listing; pinning is now
+        // scoped to /all and single-tag pages, which is the intended behaviour.
+        $this->setting('flarum-sticky.only_sticky_unread_discussions', false);
+
+        $response = $this->send(
+            $this->request('GET', '/api/discussions', [
+                'authenticatedAs' => 1,
+            ])->withQueryParams([
+                'filter' => [
+                    'author' => 'Muralf',
+                ],
+            ])
+        );
+
+        $this->assertEquals(200, $response->getStatusCode(), $body = $response->getBody()->getContents());
+
+        $data = json_decode($body, true);
+
+        // Natural last_posted_at order — no sticky pinning on a non-tag filter.
+        // The sticky discussions (1 and 3) sit last, in their natural position,
+        // rather than floating to the top. (5 is also sticky and appears here
+        // because the author filter isn't tag-scoped and the actor is an admin;
+        // it leads only because it is the most recently posted, not because it
+        // is stickied.)
+        $this->assertEquals([5, 2, 4, 3, 1], Arr::pluck($data['data'], 'id'));
+    }
 }