fix: paginated list limit hard to change

flarum · Nov 3, 2023 · ec27363 · ec27363
1 parent 2950290
commit ec27363
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 12 deletions.
diff --git a/framework/core/js/src/common/Store.ts b/framework/core/js/src/common/Store.ts
@@ -49,7 +49,11 @@ export interface ApiPayloadPlural {
     next?: string;
     prev?: string;
   };
-  meta?: MetaInformation;
+  meta?: MetaInformation & {
+    total?: number;
+    page?: number;
+    perPage?: number;
+  };
 }
 
 export type ApiPayload = ApiPayloadSingle | ApiPayloadPlural;

diff --git a/framework/core/js/src/common/states/PaginatedListState.ts b/framework/core/js/src/common/states/PaginatedListState.ts
@@ -25,8 +25,15 @@ export interface PaginatedListRequestParams extends Omit<ApiQueryParamsPlural, '
 }
 
 export default abstract class PaginatedListState<T extends Model, P extends PaginatedListParams = PaginatedListParams> {
+  /**
+   * This value should not be relied upon when preloading an API document.
+   * In those cases the pageSize should be taken from the meta information of the preloaded
+   * document. Checkout `DiscussionListState.loadPage` for an example.
+   */
+  public static DEFAULT_PAGE_SIZE = 20;
+
   protected location!: PaginationLocation;
-  protected pageSize: number;
+  protected pageSize: number | null;
 
   protected pages: Page<T>[] = [];
   protected params: P = {} as P;
@@ -35,7 +42,7 @@ export default abstract class PaginatedListState<T extends Model, P extends Pagi
   protected loadingPrev: boolean = false;
   protected loadingNext: boolean = false;
 
-  protected constructor(params: P = {} as P, page: number = 1, pageSize: number = 20) {
+  protected constructor(params: P = {} as P, page: number = 1, pageSize: number | null = null) {
     this.params = params;
 
     this.location = { page };
@@ -108,12 +115,23 @@ export default abstract class PaginatedListState<T extends Model, P extends Pagi
       ...reqParams,
       page: {
         ...reqParams.page,
-        offset: this.pageSize * (page - 1),
+        offset: (this.pageSize && this.pageSize * (page - 1)) || 0,
+        limit: this.pageSize || undefined,
       },
       include,
     };
 
-    return app.store.find<T[]>(this.type, params);
+    return app.store.find<T[]>(this.type, params).then((results) => {
+      /*
+       * If this state does not rely on a preloaded API document to know the page size,
+       * then there is no initial list, and therefore the page size can be taken from subsequent requests.
+       */
+      if (!this.pageSize) {
+        this.pageSize = results.payload?.meta?.perPage || PaginatedListState.DEFAULT_PAGE_SIZE;
+      }
+
+      return results;
+    });
   }
 
   /**

diff --git a/framework/core/js/src/forum/states/DiscussionListState.ts b/framework/core/js/src/forum/states/DiscussionListState.ts
@@ -15,7 +15,7 @@ export default class DiscussionListState<P extends DiscussionListParams = Discus
   protected eventEmitter: EventEmitter;
 
   constructor(params: P, page: number = 1) {
-    super(params, page, 20);
+    super(params, page, null);
 
     this.eventEmitter = globalEventEmitter.on('discussion.deleted', this.deleteDiscussion.bind(this));
   }
@@ -44,6 +44,7 @@ export default class DiscussionListState<P extends DiscussionListParams = Discus
 
     if (preloadedDiscussions) {
       this.initialLoading = false;
+      this.pageSize = preloadedDiscussions.payload.meta?.perPage || 20;
 
       return Promise.resolve(preloadedDiscussions);
     }

diff --git a/framework/core/src/Api/Controller/AbstractListController.php b/framework/core/src/Api/Controller/AbstractListController.php
@@ -23,4 +23,24 @@ protected function createElement(mixed $data, SerializerInterface $serializer):
     }
 
     abstract protected function data(ServerRequestInterface $request, Document $document): iterable;
+
+    protected function addPaginationData(Document $document, ServerRequestInterface $request, string $url, ?int $total): void
+    {
+        $limit = $this->extractLimit($request);
+        $offset = $this->extractOffset($request);
+
+        $document->addPaginationLinks(
+            $url,
+            $request->getQueryParams(),
+            $offset,
+            $limit,
+            $total,
+        );
+
+        $document->setMeta([
+            'total' => $total,
+            'perPage' => $limit,
+            'page' => $offset / $limit + 1,
+        ]);
+    }
 }
diff --git a/framework/core/src/Api/Controller/ListDiscussionsController.php b/framework/core/src/Api/Controller/ListDiscussionsController.php
@@ -64,11 +64,10 @@ protected function data(ServerRequestInterface $request, Document $document): it
             $results = $this->filterer->filter($criteria, $limit, $offset);
         }
 
-        $document->addPaginationLinks(
+        $this->addPaginationData(
+            $document,
+            $request,
             $this->url->to('api')->route('discussions.index'),
-            $request->getQueryParams(),
-            $offset,
-            $limit,
             $results->areMoreResults() ? null : 0
         );
 

diff --git a/framework/core/src/Forum/Content/Index.php b/framework/core/src/Forum/Content/Index.php
@@ -10,6 +10,7 @@
 namespace Flarum\Forum\Content;
 
 use Flarum\Api\Client;
+use Flarum\Api\Controller\ListDiscussionsController;
 use Flarum\Frontend\Document;
 use Flarum\Http\UrlGenerator;
 use Flarum\Locale\TranslatorInterface;
@@ -25,7 +26,8 @@ public function __construct(
         protected Factory $view,
         protected SettingsRepositoryInterface $settings,
         protected UrlGenerator $url,
-        protected TranslatorInterface $translator
+        protected TranslatorInterface $translator,
+        protected ListDiscussionsController $controller
     ) {
     }
 
@@ -39,11 +41,15 @@ public function __invoke(Document $document, Request $request): Document
         $filters = Arr::pull($queryParams, 'filter', []);
 
         $sortMap = resolve('flarum.forum.discussions.sortmap');
+        $limit = $this->controller->limit;
 
         $params = [
             'sort' => $sort && isset($sortMap[$sort]) ? $sortMap[$sort] : '',
             'filter' => $filters,
-            'page' => ['offset' => ($page - 1) * 20, 'limit' => 20]
+            'page' => [
+                'offset' => ($page - 1) * $limit,
+                'limit' => $limit
+            ],
         ];
 
         if ($q) {