Specify IndexOptions keys

doctrine · Nov 5, 2022 · fee2938 · fee2938
1 parent 5295286
commit fee2938
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 24 deletions.
diff --git a/lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php b/lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php
@@ -198,7 +198,15 @@
  *      alsoLoadFields?: list<string>,
  * }
  * @psalm-type IndexKeys = array<string, mixed>
- * @psalm-type IndexOptions = array<string, mixed>
+ * @psalm-type IndexOptions = array{
+ *      background?: bool,
+ *      unique?: bool,
+ *      name?: string,
+ *      partialFilterExpression?: mixed[],
+ *      sparse?: bool,
+ *      expireAfterSeconds?: int,
+ *      storageEngine?: mixed[],
+ * }
  * @psalm-type IndexMapping = array{
  *      keys: IndexKeys,
  *      options: IndexOptions

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -36,9 +36,10 @@
     </LessSpecificImplementedReturnType>
   </file>
   <file src="lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php">
-    <InvalidArgument occurrences="2">
+    <InvalidArgument occurrences="3">
       <code>$mapping</code>
       <code>$mapping</code>
+      <code>$options</code>
     </InvalidArgument>
     <RedundantCondition occurrences="15">
       <code>assert($attributes instanceof SimpleXMLElement)</code>

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/SchemaManagerTest.php b/tests/Doctrine/ODM/MongoDB/Tests/SchemaManagerTest.php
@@ -46,6 +46,7 @@
 
 /**
  * @psalm-import-type IndexMapping from ClassMetadata
+ * @psalm-import-type IndexOptions from ClassMetadata
  */
 class SchemaManagerTest extends BaseTest
 {
@@ -161,7 +162,7 @@ public static function getIndexCreationWriteOptions(): array
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getIndexCreationWriteOptions
      */
@@ -210,7 +211,7 @@ public function testEnsureIndexes(array $expectedWriteOptions, ?int $maxTimeMs,
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getIndexCreationWriteOptions
      */
@@ -232,7 +233,7 @@ public function testEnsureDocumentIndexes(array $expectedWriteOptions, ?int $max
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getIndexCreationWriteOptions
      */
@@ -276,7 +277,7 @@ public function testEnsureDocumentIndexesForGridFSFile(array $expectedWriteOptio
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getIndexCreationWriteOptions
      */
@@ -293,7 +294,7 @@ public function testEnsureDocumentIndexesWithTwoLevelInheritance(array $expected
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -318,7 +319,7 @@ public function testUpdateDocumentIndexesShouldCreateMappedIndexes(array $expect
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -351,7 +352,7 @@ public function testUpdateDocumentIndexesShouldDeleteUnmappedIndexesBeforeCreati
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -377,7 +378,7 @@ public function testDeleteIndexes(array $expectedWriteOptions, ?int $maxTimeMs,
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -421,7 +422,7 @@ public function testUpdateValidators(): void
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -472,7 +473,7 @@ public function testUpdateDocumentValidatorShouldThrowExceptionForMappedSupercla
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -496,7 +497,7 @@ public function testUpdateDocumentValidatorReset(array $expectedWriteOptions, ?i
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -525,7 +526,7 @@ public function testCreateDocumentCollection(array $expectedWriteOptions, ?int $
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -544,7 +545,7 @@ public function testCreateDocumentCollectionForFile(array $expectedWriteOptions,
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -589,7 +590,7 @@ public function testCreateDocumentCollectionWithValidator(array $expectedWriteOp
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -628,7 +629,7 @@ public function testCreateView(array $expectedWriteOptions, ?int $maxTimeMs, ?Wr
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -658,7 +659,7 @@ public function testCreateCollections(array $expectedWriteOptions, ?int $maxTime
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -674,7 +675,7 @@ public function testDropCollections(array $expectedWriteOptions, ?int $maxTimeMs
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -695,7 +696,7 @@ public function testDropDocumentCollection(array $expectedWriteOptions, ?int $ma
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -732,7 +733,7 @@ public function testDropDocumentCollectionForGridFSFile(array $expectedWriteOpti
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -753,7 +754,7 @@ public function testDropView(array $expectedWriteOptions, ?int $maxTimeMs, ?Writ
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -775,7 +776,7 @@ public function testDropDocumentDatabase(array $expectedWriteOptions, ?int $maxT
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      *
      * @dataProvider getWriteOptions
      */
@@ -1203,7 +1204,7 @@ private function getMockDatabase()
     }
 
     /**
-     * @param array<string, mixed> $expectedWriteOptions
+     * @psalm-param IndexOptions $expectedWriteOptions
      */
     private function writeOptions(array $expectedWriteOptions): Constraint
     {