PHPLIB-1512: Remove IndexInfo::isGeoHaystack() method

Author: alcaeus

UPGRADE-2.0.md

@@ -6,6 +6,7 @@ UPGRADE FROM 1.x to 2.0
  * The `MongoDB\ChangeStream::CURSOR_NOT_FOUND` constant is now private.
  * The `MongoDB\Operation\Watch::FULL_DOCUMENT_DEFAULT` constant has been
    removed.
+ * The `MongoDB\Model\IndexInfo::isGeoHaystack` method has been removed.
 
 GridFS
 ------

src/Model/IndexInfo.php

@@ -110,18 +110,6 @@ public function is2dSphere(): bool
         return array_search('2dsphere', $this->getKey(), true) !== false;
     }
 
-    /**
-     * Return whether or not this index is of type geoHaystack.
-     *
-     * @deprecated Since 1.16: MongoDB 5.0 removes support for geoHaystack indexes.
-     */
-    public function isGeoHaystack(): bool
-    {
-        @trigger_error('MongoDB 5.0 removes support for "geoHaystack" indexes, the method "IndexInfo::isGeoHaystack()" will be removed in a future release', E_USER_DEPRECATED);
-
-        return array_search('geoHaystack', $this->getKey(), true) !== false;
-    }
-
     /**
      * Return whether this is a sparse index.
      *

tests/Model/IndexInfoFunctionalTest.php

@@ -32,29 +32,6 @@ public function testIs2dSphere(): void
         $this->assertEquals(3, $index['2dsphereIndexVersion']);
     }
 
-    /**
-     * @group matrix-testing-exclude-server-5.0-driver-4.0
-     * @group matrix-testing-exclude-server-5.0-driver-4.2
-     * @group matrix-testing-exclude-server-5.0-driver-4.4
-     */
-    public function testIsGeoHaystack(): void
-    {
-        $this->skipIfGeoHaystackIndexIsNotSupported();
-
-        $indexName = $this->collection->createIndex(['pos' => 'geoHaystack', 'x' => 1], ['bucketSize' => 5]);
-        $result = $this->collection->listIndexes();
-
-        $result->rewind();
-        $result->next();
-        $index = $result->current();
-
-        $this->assertEquals($indexName, $index->getName());
-        $this->assertDeprecated(function () use ($index): void {
-            $this->assertTrue($index->isGeoHaystack());
-        });
-        $this->assertEquals(5, $index['bucketSize']);
-    }
-
     public function testIsText(): void
     {
         $indexName = $this->collection->createIndex(['x' => 'text']);

tests/Model/IndexInfoTest.php

@@ -22,9 +22,6 @@ public function testBasicIndex(): void
         $this->assertSame('x_1', $info->getName());
         $this->assertSame('foo.bar', $info->getNamespace());
         $this->assertFalse($info->is2dSphere());
-        $this->assertDeprecated(function () use ($info): void {
-            $this->assertFalse($info->isGeoHaystack());
-        });
         $this->assertFalse($info->isSparse());
         $this->assertFalse($info->isText());
         $this->assertFalse($info->isTtl());
@@ -46,9 +43,6 @@ public function testSparseIndex(): void
         $this->assertSame('y_sparse', $info->getName());
         $this->assertSame('foo.bar', $info->getNamespace());
         $this->assertFalse($info->is2dSphere());
-        $this->assertDeprecated(function () use ($info): void {
-            $this->assertFalse($info->isGeoHaystack());
-        });
         $this->assertTrue($info->isSparse());
         $this->assertFalse($info->isText());
         $this->assertFalse($info->isTtl());
@@ -70,9 +64,6 @@ public function testUniqueIndex(): void
         $this->assertSame('z_unique', $info->getName());
         $this->assertSame('foo.bar', $info->getNamespace());
         $this->assertFalse($info->is2dSphere());
-        $this->assertDeprecated(function () use ($info): void {
-            $this->assertFalse($info->isGeoHaystack());
-        });
         $this->assertFalse($info->isSparse());
         $this->assertFalse($info->isText());
         $this->assertFalse($info->isTtl());
@@ -94,9 +85,6 @@ public function testTtlIndex(): void
         $this->assertSame('z_unique', $info->getName());
         $this->assertSame('foo.bar', $info->getNamespace());
         $this->assertFalse($info->is2dSphere());
-        $this->assertDeprecated(function () use ($info): void {
-            $this->assertFalse($info->isGeoHaystack());
-        });
         $this->assertFalse($info->isSparse());
         $this->assertFalse($info->isText());
         $this->assertTrue($info->isTtl());
@@ -174,32 +162,6 @@ public function testIs2dSphere(): void
         $this->assertSame('pos_2dsphere', $info->getName());
         $this->assertSame('foo.bar', $info->getNamespace());
         $this->assertTrue($info->is2dSphere());
-        $this->assertDeprecated(function () use ($info): void {
-            $this->assertFalse($info->isGeoHaystack());
-        });
-        $this->assertFalse($info->isSparse());
-        $this->assertFalse($info->isText());
-        $this->assertFalse($info->isTtl());
-        $this->assertFalse($info->isUnique());
-    }
-
-    public function testIsGeoHaystack(): void
-    {
-        $info = new IndexInfo([
-            'v' => 2,
-            'key' => ['pos2' => 'geoHaystack', 'x' => 1],
-            'name' => 'pos2_geoHaystack_x_1',
-            'ns' => 'foo.bar',
-        ]);
-
-        $this->assertSame(2, $info->getVersion());
-        $this->assertSame(['pos2' => 'geoHaystack', 'x' => 1], $info->getKey());
-        $this->assertSame('pos2_geoHaystack_x_1', $info->getName());
-        $this->assertSame('foo.bar', $info->getNamespace());
-        $this->assertFalse($info->is2dSphere());
-        $this->assertDeprecated(function () use ($info): void {
-            $this->assertTrue($info->isGeoHaystack());
-        });
         $this->assertFalse($info->isSparse());
         $this->assertFalse($info->isText());
         $this->assertFalse($info->isTtl());
@@ -220,9 +182,6 @@ public function testIsText(): void
         $this->assertSame('title_text_description_text', $info->getName());
         $this->assertSame('foo.bar', $info->getNamespace());
         $this->assertFalse($info->is2dSphere());
-        $this->assertDeprecated(function () use ($info): void {
-            $this->assertFalse($info->isGeoHaystack());
-        });
         $this->assertFalse($info->isSparse());
         $this->assertTrue($info->isText());
         $this->assertFalse($info->isTtl());