[6.0] feature: use laravel's forceIndex implementation (#114)

* [6.0] feature: use laravel's forceIndex implementation

* Update tests/Query/BuilderTest.php

Co-authored-by: Go Kudo <[email protected]>

* Update CHANGELOG.md

Co-authored-by: t-matsuno-777 <[email protected]>

---------

Co-authored-by: Go Kudo <[email protected]>
Co-authored-by: t-matsuno-777 <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -1,3 +1,8 @@
+# v6.0.0 [Not released Yet]
+
+Changed
+- [Breaking] Match `Query\Builder::forceIndex()` behavior with laravel's (`forceIndex` property no longer exists). (#114)
+
 # v5.3.0 (2023-11-17)
 
 Fixed

src/Query/Builder.php

@@ -24,8 +24,7 @@
 
 class Builder extends BaseBuilder
 {
-    use Concerns\AppliesForceIndex,
-        Concerns\UsesMutations,
+    use Concerns\UsesMutations,
         Concerns\UsesPartitionedDml,
         Concerns\UsesStaleReads;
 

src/Query/Concerns/AppliesForceIndex.php

@@ -19,25 +19,17 @@
 
 use Colopl\Spanner\Concerns\MarksAsNotSupported;
 use Colopl\Spanner\Concerns\SharedGrammarCalls;
-use Colopl\Spanner\Query\Builder as SpannerBuilder;
 use Illuminate\Database\Query\Builder;
 use Illuminate\Contracts\Database\Query\Expression;
 use Illuminate\Database\Query\Grammars\Grammar as BaseGrammar;
+use Illuminate\Database\Query\IndexHint;
 use RuntimeException;
 
 class Grammar extends BaseGrammar
 {
     use MarksAsNotSupported;
     use SharedGrammarCalls;
 
-    /**
-     * @inheritDoc
-     */
-    protected function compileFrom(Builder $query, $table)
-    {
-        return parent::compileFrom($query, $table).$this->compileForceIndex($query);
-    }
-
     /**
      * @inheritDoc
      */
@@ -64,15 +56,19 @@ public function compileTruncate(Builder $query)
 
     /**
      * @param Builder $query
+     * @param IndexHint $indexHint
      * @return string
      */
-    protected function compileForceIndex(Builder $query)
+    protected function compileIndexHint(Builder $query, $indexHint)
     {
-        if ($query instanceof SpannerBuilder) {
-            return $query->forceIndex ? "@{FORCE_INDEX=$query->forceIndex}" : '';
+        if ($indexHint->index === null) {
+            return '';
         }
 
-        throw new RuntimeException('Unexpected Builder: '.get_class($query).' Expected: '.SpannerBuilder::class);
+        return match ($indexHint->type) {
+            'force' => "@{FORCE_INDEX={$indexHint->index}}",
+            default => $this->markAsNotSupported('index type: ' . $indexHint->type),
+        };
     }
 
     /**

src/Query/Grammar.php

@@ -423,7 +423,7 @@ public function testPaginate(): void
         $this->assertEquals(100, $pagination->total());
     }
 
-    public function testForceIndex(): void
+    public function test_forceIndex(): void
     {
         $conn = $this->getDefaultConnection();
         $tableName = self::TABLE_NAME_USER;
@@ -432,17 +432,39 @@ public function testForceIndex(): void
         $this->assertEquals('select * from `User`', $qb->toSql());
 
         $qb->forceIndex('test_index_name');
-        $this->assertEquals('select * from `User`@{FORCE_INDEX=test_index_name}', $qb->toSql());
+        $this->assertEquals('select * from `User` @{FORCE_INDEX=test_index_name}', $qb->toSql());
 
         $qb->forceIndex('test_index_name2');
-        $this->assertEquals('select * from `User`@{FORCE_INDEX=test_index_name2}', $qb->toSql());
+        $this->assertEquals('select * from `User` @{FORCE_INDEX=test_index_name2}', $qb->toSql());
 
         $qb->forceIndex(null);
         $this->assertEquals('select * from `User`', $qb->toSql());
 
         $this->assertInstanceOf(Builder::class, $qb->forceIndex(null));
     }
 
+    public function test_useIndex(): void
+    {
+        $this->expectExceptionMessage('Cloud Spanner does not support index type: hint');
+        $this->expectException(BadMethodCallException::class);
+
+        $this->getDefaultConnection()
+            ->table(self::TABLE_NAME_USER)
+            ->useIndex('test_index_name2')
+            ->toSql();
+    }
+
+    public function test_ignoreIndex(): void
+    {
+        $this->expectExceptionMessage('Cloud Spanner does not support index type: ignore');
+        $this->expectException(BadMethodCallException::class);
+
+        $this->getDefaultConnection()
+            ->table(self::TABLE_NAME_USER)
+            ->ignoreIndex('test_index_name2')
+            ->toSql();
+    }
+
     public function testInterleaveTable(): void
     {
         $conn = $this->getDefaultConnection();