[5.x] Provide search index name callback

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);
 
@@ -31,9 +33,18 @@ public function __construct($name, array $config, ?string $locale = null)
 
     public function name()
     {
+        if (static::$nameCallback) {
+            return call_user_func(static::$nameCallback, $this->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,8 +3,7 @@
 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
@@ -13,15 +12,14 @@ class AlgoliaIndexTest extends TestCase
 
     public function getIndex()
     {
-        $resolver = Mockery::mock(ItemResolver::class);
-        $resolver->shouldReceive('setIndex');
+        $name = 'algolia';
 
-        $client = Mockery::mock(\AlgoliaSearch\Client::class);
-        $index = Mockery::mock(\AlgoliaSearch\Index::class);
+        $locale = 'en';
 
-        $client->shouldReceive('initIndex')->andReturn($index);
-        $index->shouldReceive('search')->andReturn(['hits' => []]);
+        $config = [];
 
-        return new Index($resolver, $client);
+        $client = Mockery::mock(\Algolia\AlgoliaSearch\SearchClient::class);
+
+        return new AlgoliaIndex($client, $name, $config, $locale);
     }
 }

tests/Search/CombIndexTest.php

@@ -37,6 +37,10 @@ protected function beforeSearched()
 
     public function getIndex()
     {
-        return app(Index::class);
+        $name = 'local';
+
+        $config = [];
+
+        return new Index($name, $config);
     }
 }

tests/Search/IndexTests.php

@@ -5,6 +5,7 @@
 use Illuminate\Support\Facades\Event;
 use PHPUnit\Framework\Attributes\Test;
 use Statamic\Events\SearchQueryPerformed;
+use Statamic\Search\Index;
 
 trait IndexTests
 {
@@ -24,6 +25,28 @@ public function search_event_gets_emitted()
         });
     }
 
+    #[Test]
+    public function it_respects_an_index_prefix()
+    {
+        $index = $this->getIndex();
+
+        $originalName = $index->name();
+
+        $prefix = 'foo';
+
+        $index::resolveNameUsing(function ($name) use ($prefix) {
+            return $prefix.'_'.$name;
+        });
+
+        $this->assertEquals($prefix.'_'.$originalName, $index->name());
+    }
+
+    public function tearDown(): void
+    {
+        // Reset the static state of the Index class
+        Index::resolveNameUsing(null);
+    }
+
     protected function beforeSearched()
     {
     }