[5.x] Provide search index name callback (#10435)

Co-authored-by: Jason Varga <[email protected]>

Author: ajnsn

src/Search/Index.php

@@ -2,6 +2,7 @@
 
 namespace Statamic\Search;
 
+use Closure;
 use Statamic\Contracts\Search\Searchable;
 use Statamic\Support\Arr;
 use Statamic\Support\Str;
@@ -11,6 +12,7 @@ abstract class Index
     protected $name;
     protected $locale;
     protected $config;
+    protected static ?Closure $nameCallback = null;
 
     abstract public function search($query);
 
@@ -24,7 +26,10 @@ abstract protected function deleteIndex();
 
     public function __construct($name, array $config, ?string $locale = null)
     {
-        $this->name = $locale ? $name.'_'.$locale : $name;
+        $this->name = static::$nameCallback
+            ? call_user_func(static::$nameCallback, $name, $locale)
+            : ($locale ? $name.'_'.$locale : $name);
+
         $this->config = $config;
         $this->locale = $locale;
     }
@@ -34,6 +39,11 @@ public function name()
         return $this->name;
     }
 
+    public static function resolveNameUsing(?Closure $callback)
+    {
+        static::$nameCallback = $callback;
+    }
+
     public function title()
     {
         return $this->config['title'] ?? Str::title($this->name);

tests/Search/AlgoliaIndexTest.php

@@ -3,25 +3,22 @@
 namespace Tests\Search;
 
 use Mockery;
-use Statamic\Search\Algolia\Index;
-use Statamic\Search\ItemResolver;
+use Statamic\Search\Algolia\Index as AlgoliaIndex;
 use Tests\TestCase;
 
 class AlgoliaIndexTest extends TestCase
 {
     use IndexTests;
 
-    public function getIndex()
+    public function getIndexClass()
     {
-        $resolver = Mockery::mock(ItemResolver::class);
-        $resolver->shouldReceive('setIndex');
-
-        $client = Mockery::mock(\AlgoliaSearch\Client::class);
-        $index = Mockery::mock(\AlgoliaSearch\Index::class);
+        return AlgoliaIndex::class;
+    }
 
-        $client->shouldReceive('initIndex')->andReturn($index);
-        $index->shouldReceive('search')->andReturn(['hits' => []]);
+    public function getIndex($name, $config, $locale)
+    {
+        $client = Mockery::mock(\Algolia\AlgoliaSearch\SearchClient::class);
 
-        return new Index($resolver, $client);
+        return new AlgoliaIndex($client, $name, $config, $locale);
     }
 }

tests/Search/CombIndexTest.php

@@ -35,8 +35,8 @@ protected function beforeSearched()
             ->andReturn('[[]]');
     }
 
-    public function getIndex()
+    public function getIndexClass()
     {
-        return app(Index::class);
+        return Index::class;
     }
 }

tests/Search/IndexTests.php

@@ -2,29 +2,48 @@
 
 namespace Tests\Search;
 
-use Illuminate\Support\Facades\Event;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
-use Statamic\Events\SearchQueryPerformed;
+use Statamic\Search\Index;
 
 trait IndexTests
 {
-    #[Test]
-    public function search_event_gets_emitted()
+    public function tearDown(): void
     {
-        $this->markTestSkipped();
+        // Reset the static state of the Index class
+        Index::resolveNameUsing(null);
 
-        Event::fake();
+        parent::tearDown();
+    }
+
+    abstract public function getIndexClass();
+
+    public function getIndex($name, $config, $locale)
+    {
+        $class = $this->getIndexClass();
 
-        $this->beforeSearched();
+        return new $class($name, $config, $locale);
+    }
+
+    #[Test, DataProvider('nameProvider')]
+    public function it_can_get_the_name($name, $config, $locale, $resolver, $expected)
+    {
+        if ($resolver) {
+            $this->getIndexClass()::resolveNameUsing($resolver);
+        }
 
-        $this->getIndex()->setName('test')->search('foo');
+        $index = $this->getIndex($name, $config, $locale);
 
-        Event::assertDispatched(SearchQueryPerformed::class, function ($event) {
-            return $event->query === 'foo';
-        });
+        $this->assertEquals($expected, $index->name());
     }
 
-    protected function beforeSearched()
+    public static function nameProvider()
     {
+        return [
+            'basic' => ['test', [], null, null, 'test'],
+            'with locale' => ['test', [], 'en', null, 'test_en'],
+            'resolver' => ['test', [], null, fn ($name, $locale) => 'prefix_'.$name.'_'.$locale, 'prefix_test_'],
+            'resolver with locale' => ['test', [], 'en', fn ($name, $locale) => 'prefix_'.$name.'_'.$locale, 'prefix_test_en'],
+        ];
     }
 }