Global search doesn't work with Algolia when using the algolia/scout-extended package

[bakerkretzmar]

• Laravel Version: 8.81.0
• Nova Version: 3.30.0
• PHP Version: 8.1.2
• Database Driver & Version: MySQL 8.0.27
• Operating System and Version: macOS 11
• Browser type and version: Firefox 96

Description:

Algolia maintains the algolia/scout-extended package which adds additional functionality to Laravel Scout, and it overrides a bunch of Scout's methods to handle things like aggregates, differently formatted object IDs, etc. It overrides Scout's AlgoliaEngine's map() method, but not the lazyMap() method, which is what Nova's usage of Scout ends up calling (from inside the cursor method in Laravel\Nova\Query\Builder). lazyMap does not play nicely with Scout Extended and just always returns an empty set of results.

I think this is more of a Scout Extended problem than a Nova problem, but I wanted to mention it as the package is quite popular. I think it would be quite straightforward for Nova to work around this issue by checking if the query builder is from Scout Extended, perhaps like this:

// In `Laravel\Nova\Query\Builder`

use Algolia\ScoutExtended\Builder;

// ...

public function cursor()
{
    $queryBuilder = $this->applyQueryCallbacks($this->queryBuilder);

                                               // ↓ add this check
    if (method_exists($queryBuilder, 'cursor') && get_class($queryBuilder) !== Builder::class) {
        return $queryBuilder->cursor();
    }

    // ...
}

I worked around this in my app by binding my own extension of the query builder and overriding that method to just remove the cursor method check.

See algolia/scout-extended#298.