Fix scout paginate total count by reordering query callback applyiance (#200)

---------

Co-authored-by: Corentin COUSSE <c.cousse@xefi.fr>
Co-authored-by: Gautier DELEGLISE <gautier.deleglise@gmail.com>

Author: 3 people

src/Concerns/Resource/Paginable.php

@@ -4,6 +4,7 @@
 
 use Laravel\Scout\Builder;
 use Lomkit\Rest\Http\Requests\RestRequest;
+use Lomkit\Rest\Query\ScoutBuilder;
 
 trait Paginable
 {
@@ -21,7 +22,19 @@ public function paginate($query, RestRequest $request)
 
         // In case we have a scout builder
         if ($query instanceof Builder) {
-            return $query->paginate($request->input('search.limit', $defaultLimit), 'page', $request->input('search.page', 1));
+            $paginator = $query->paginate($request->input('search.limit', $defaultLimit), 'page', $request->input('search.page', 1));
+
+            if ($paginator->isEmpty()) {
+                return $paginator;
+            }
+
+            $paginatedQuery = $paginator->getCollection()->toQuery();
+            // Apply query callback after pagination to prevent Scout from mapping all IDs during total count calculation,
+            // which can cause "allowed memory size" errors with large result sets
+            $scoutBuilder = (new ScoutBuilder($this))->applyQueryCallback($paginatedQuery, $request->input('search', []));
+            $results = $scoutBuilder->get();
+
+            return $paginator->setCollection($results);
         }
 
         return $query->paginate($request->input('search.limit', $defaultLimit), ['*'], 'page', $request->input('search.page', 1));

src/Query/ScoutBuilder.php

@@ -18,9 +18,7 @@ class ScoutBuilder implements QueryBuilder
      * This method configures the underlying search builder by setting the query text,
      * and conditionally applying filters, sort orders, and additional instructions based
      * on the provided parameters. It also enforces a limit on the number of results,
-     * defaulting to 50 if no limit is specified. Any extra parameters, after excluding
-     * reserved keys (filters, instructions, sorts, text, and limit), are forwarded to the
-     * underlying search operation.
+     * defaulting to 50 if no limit is specified.
      *
      * @param array $parameters An associative array of search criteria, which may include:
      *                          - 'text': An array containing 'value' (search string) and optionally 'trashed' ('with'|'only').
@@ -53,27 +51,36 @@ public function search(array $parameters = [])
             $this->applyInstructions($parameters['instructions']);
         });
 
-        $this->queryBuilder
-            ->query(function (Builder $query) use ($parameters) {
-                app()->make(QueryBuilder::class, ['query' => $query, 'resource' => $this->resource])
-                    ->disableSecurity()
-                    ->search(
-                        collect($parameters)
-                            ->except([
-                                'filters',
-                                'instructions',
-                                'sorts',
-                                'text',
-                                'limit',
-                                'page',
-                            ])
-                            ->all()
-                    );
-            });
-
         return $this->queryBuilder;
     }
 
+    /**
+     *  Forwards the extra parameters after excluding reserved keys (filters, instructions, sorts, text, and limit)
+     *  to the underlying search operation.
+     *
+     * @param \Laravel\Scout\Builder $query
+     * @param array                  $parameters
+     *
+     * @return \Laravel\Scout\Builder The new query builder.
+     */
+    public function applyQueryCallback($query, $parameters)
+    {
+        return app()->make(QueryBuilder::class, ['query' => $query, 'resource' => $this->resource])
+            ->disableSecurity()
+            ->search(
+                collect($parameters)
+                    ->except([
+                        'filters',
+                        'instructions',
+                        'sorts',
+                        'text',
+                        'limit',
+                        'page',
+                    ])
+                    ->all()
+            );
+    }
+
     /**
      * Apply multiple filters to the query builder.
      *

tests/Unit/LaravelScoutTest.php

@@ -93,7 +93,7 @@ public function test_building_scout_with_instructions()
                 ],
             ]);
 
-        ($scoutQueryBuilderMock->toBase()->queryCallback)(Model::query());
+        $this->assertNull($scoutQueryBuilderMock->toBase()->queryCallback);
     }
 
     public function test_building_scout_with_trashed()
@@ -116,7 +116,7 @@ public function test_building_scout_with_trashed()
                 ],
             ]);
 
-        ($scoutQueryBuilderMock->toBase()->queryCallback)(Model::query());
+        $this->assertNull($scoutQueryBuilderMock->toBase()->queryCallback);
     }
 
     public function test_building_scout_only_trashed()
@@ -139,6 +139,6 @@ public function test_building_scout_only_trashed()
                 ],
             ]);
 
-        ($scoutQueryBuilderMock->toBase()->queryCallback)(Model::query());
+        $this->assertNull($scoutQueryBuilderMock->toBase()->queryCallback);
     }
 }