[9.x] Fixes pagination count when Laravel\Scout\Builder contains cu…

…stom query callback (#469)

* Fixes pagination count when `Laravel\Scout\Builder` contains custom query callback.

Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>

* update namespace.

Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>

* Update phpunit.xml

Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>

* move tests.

Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>

* CS

Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>

* Update Builder.php

Co-authored-by: Taylor Otwell <taylor@laravel.com>

composer.json

@@ -26,6 +26,7 @@
     "require-dev": {
         "meilisearch/meilisearch-php": "^0.17",
         "mockery/mockery": "^1.0",
+        "orchestra/testbench": "^6.17",
         "phpunit/phpunit": "^9.3"
     },
     "autoload": {

phpunit.xml.dist

@@ -11,8 +11,17 @@
          stopOnFailure="false"
 >
     <testsuites>
-        <testsuite name="Package Test Suite">
-            <directory suffix=".php">./tests/</directory>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit</directory>
+        </testsuite>
+        <testsuite name="Feature">
+            <directory suffix="Test.php">./tests/Feature</directory>
         </testsuite>
     </testsuites>
+
+    <php>
+        <env name="APP_ENV" value="testing"/>
+        <env name="APP_KEY" value="AckfSECXIvnK5r28GVIWUAxmbBSjTsmF"/>
+        <env name="DB_CONNECTION" value="testing"/>
+    </php>
 </phpunit>

src/Builder.php

@@ -320,7 +320,7 @@ public function paginate($perPage = null, $pageName = 'page', $page = null)
 
         $paginator = Container::getInstance()->makeWith(LengthAwarePaginator::class, [
             'items' => $results,
-            'total' => $engine->getTotalCount($rawResults),
+            'total' => $this->getTotalCount($rawResults),
             'perPage' => $perPage,
             'currentPage' => $page,
             'options' => [
@@ -352,7 +352,7 @@ public function paginateRaw($perPage = null, $pageName = 'page', $page = null)
 
         $paginator = Container::getInstance()->makeWith(LengthAwarePaginator::class, [
             'items' => $results,
-            'total' => $engine->getTotalCount($results),
+            'total' => $this->getTotalCount($results),
             'perPage' => $perPage,
             'currentPage' => $page,
             'options' => [
@@ -364,6 +364,25 @@ public function paginateRaw($perPage = null, $pageName = 'page', $page = null)
         return $paginator->appends('query', $this->query);
     }
 
+    /**
+     * Get the total number of results from the Scout engine, or fallback to query builder.
+     *
+     * @param  mixed  $results
+     * @return int
+     */
+    protected function getTotalCount($results)
+    {
+        $engine = $this->engine();
+
+        if (is_null($this->queryCallback)) {
+            return $engine->getTotalCount($results);
+        }
+
+        return $this->model->queryScoutModelsByIds(
+            $this, $engine->mapIds($results)->all()
+        )->toBase()->getCountForPagination();
+    }
+
     /**
      * Get the engine that should handle the query.
      *

tests/Feature/BuilderTest.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace Laravel\Scout\Tests\Feature;
+
+use Illuminate\Database\Eloquent\Factories\Sequence;
+use Illuminate\Foundation\Auth\User;
+use Illuminate\Foundation\Testing\WithFaker;
+use Laravel\Scout\EngineManager;
+use Laravel\Scout\Engines\MeiliSearchEngine;
+use Laravel\Scout\ScoutServiceProvider;
+use Laravel\Scout\Tests\Fixtures\SearchableUserModel;
+use Mockery as m;
+use Orchestra\Testbench\Factories\UserFactory;
+use Orchestra\Testbench\TestCase;
+
+class BuilderTest extends TestCase
+{
+    use WithFaker;
+
+    protected function getPackageProviders($app)
+    {
+        return [ScoutServiceProvider::class];
+    }
+
+    protected function defineEnvironment($app)
+    {
+        $app->make('config')->set('scout.driver', 'fake');
+    }
+
+    protected function defineDatabaseMigrations()
+    {
+        $this->setUpFaker();
+        $this->loadLaravelMigrations();
+
+        UserFactory::new()->count(50)->state(new Sequence(function () {
+            return ['name' => 'Laravel '.$this->faker()->name()];
+        }))->create();
+
+        UserFactory::new()->times(50)->create();
+    }
+
+    public function test_it_can_paginate_without_custom_query_callback()
+    {
+        $this->prepareScoutSearchMockUsing('Laravel');
+
+        $paginator = SearchableUserModel::search('Laravel')->paginate();
+
+        $this->assertSame(50, $paginator->total());
+        $this->assertSame(4, $paginator->lastPage());
+        $this->assertSame(15, $paginator->perPage());
+    }
+
+    public function test_it_can_paginate_with_custom_query_callback()
+    {
+        $this->prepareScoutSearchMockUsing('Laravel');
+
+        $paginator = SearchableUserModel::search('Laravel')->query(function ($builder) {
+            return $builder->where('id', '<', 11);
+        })->paginate();
+
+        $this->assertSame(10, $paginator->total());
+        $this->assertSame(1, $paginator->lastPage());
+        $this->assertSame(15, $paginator->perPage());
+    }
+
+    protected function prepareScoutSearchMockUsing($searchQuery)
+    {
+        $engine = m::mock('MeiliSearch\Client');
+        $indexes = m::mock('MeiliSearch\Endpoints\Indexes');
+
+        $manager = $this->app->make(EngineManager::class);
+        $manager->extend('fake', function () use ($engine) {
+            return new MeiliSearchEngine($engine);
+        });
+
+        $query = User::where('name', 'like', $searchQuery.'%');
+
+        $engine->shouldReceive('index')->with('users')->andReturn($indexes);
+        $indexes->shouldReceive('rawSearch')->with($searchQuery, ['limit' => 15])->andReturn([
+            'hits' => $query->get()->transform(function ($result) {
+                return [
+                    'id' => $result->getKey(),
+                    'name' => $result->name,
+                ];
+            }),
+            'nbHits' => $query->count(),
+        ]);
+    }
+}

tests/SearchableTest.php → tests/Feature/SearchableTest.php

@@ -1,19 +1,14 @@
 <?php
 
-namespace Laravel\Scout\Tests;
+namespace Laravel\Scout\Tests\Feature;
 
 use Illuminate\Database\Eloquent\Builder;
 use Laravel\Scout\Tests\Fixtures\SearchableModel;
 use Mockery as m;
-use PHPUnit\Framework\TestCase;
+use Orchestra\Testbench\TestCase;
 
 class SearchableTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
-
     public function test_searchable_using_update_is_called_on_collection()
     {
         $collection = m::mock();
@@ -84,10 +79,3 @@ public function newQuery()
         return $mock;
     }
 }
-
-namespace Laravel\Scout;
-
-function config($arg)
-{
-    return false;
-}

tests/Fixtures/SearchableUserModel.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Laravel\Scout\Tests\Fixtures;
+
+use Illuminate\Foundation\Auth\User as Model;
+use Laravel\Scout\Searchable;
+
+class SearchableUserModel extends Model
+{
+    use Searchable;
+
+    protected $table = 'users';
+}

tests/AlgoliaEngineTest.php → tests/Unit/AlgoliaEngineTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Laravel\Scout\Tests;
+namespace Laravel\Scout\Tests\Unit;
 
 use Algolia\AlgoliaSearch\SearchClient;
 use Illuminate\Database\Eloquent\Collection;

tests/BuilderTest.php → tests/Unit/BuilderTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Laravel\Scout\Tests;
+namespace Laravel\Scout\Tests\Unit;
 
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Pagination\Paginator;

tests/MakeSearchableTest.php → tests/Unit/MakeSearchableTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Laravel\Scout\Tests;
+namespace Laravel\Scout\Tests\Unit;
 
 use Illuminate\Database\Eloquent\Collection;
 use Laravel\Scout\Jobs\MakeSearchable;

tests/MeiliSearchEngineTest.php → tests/Unit/MeiliSearchEngineTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Laravel\Scout\Tests;
+namespace Laravel\Scout\Tests\Unit;
 
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Support\LazyCollection;

tests/ModelObserverTest.php → tests/Unit/ModelObserverTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Laravel\Scout\Tests;
+namespace Laravel\Scout\Tests\Unit;
 
 use Illuminate\Support\Facades\Config;
 use Laravel\Scout\ModelObserver;

tests/SearchableScopeTest.php → tests/Unit/SearchableScopeTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Laravel\Scout\Tests;
+namespace Laravel\Scout\Tests\Unit;
 
 use Illuminate\Database\Eloquent\Builder;
 use Laravel\Scout\SearchableScope;