refactor: require InvertedIndexType on the new reindex methods (#2098)

Tightens index_name to InvertedIndexType only on update_property_index,
rebuild_property_index and cancel_property_index_task (all overloads
and impls); delete_property_index keeps accepting the IndexName
literals as released v1.36 API. Runtime leniency is preserved — the
value is still normalized and validated as a str, so raw strings keep
working and keep hitting the same routes (pinned by the literal legs of
the route-equality mock tests, which sit outside the pyright scope).

Author: g-despot

integration/test_collection_config.py

@@ -43,6 +43,7 @@
     IndexName,
     InvertedIndexState,
     InvertedIndexTaskStatus,
+    InvertedIndexType,
 )
 from weaviate.collections.classes.tenants import Tenant
 from weaviate.exceptions import (
@@ -2703,15 +2704,18 @@ def test_property_reindex_searchable_lifecycle(collection_factory: CollectionFac
 
     # create the searchable index declaratively and wait for it to become ready
     status = collection.config.update_property_index(
-        "name", "searchable", tokenization=Tokenization.WORD, wait_for_completion=True
+        "name",
+        InvertedIndexType.SEARCHABLE,
+        tokenization=Tokenization.WORD,
+        wait_for_completion=True,
     )
     assert status.type == "searchable"
     assert status.status == InvertedIndexState.READY
     assert status.tokenization == Tokenization.WORD
 
     # re-putting the matching configuration is a no-op
     task = collection.config.update_property_index(
-        "name", "searchable", tokenization=Tokenization.WORD
+        "name", InvertedIndexType.SEARCHABLE, tokenization=Tokenization.WORD
     )
     assert task.status == InvertedIndexTaskStatus.NO_OP
     assert task.task_id is None
@@ -2730,13 +2734,13 @@ def test_property_reindex_searchable_lifecycle(collection_factory: CollectionFac
 
     # rebuild the index from scratch
     status = collection.config.rebuild_property_index(
-        "name", "searchable", wait_for_completion=True
+        "name", InvertedIndexType.SEARCHABLE, wait_for_completion=True
     )
     assert status.type == "searchable"
     assert status.status == InvertedIndexState.READY
 
     # cancelling when no task is live is an idempotent no-op
-    task = collection.config.cancel_property_index_task("name", "searchable")
+    task = collection.config.cancel_property_index_task("name", InvertedIndexType.SEARCHABLE)
     assert task.status == InvertedIndexTaskStatus.NO_OP
 
     # the pre-existing delete API removes the index again
@@ -2762,7 +2766,7 @@ def test_property_reindex_range_filters(collection_factory: CollectionFactory) -
     collection.data.insert_many([{"age": i} for i in range(10)])
 
     status = collection.config.update_property_index(
-        "age", "rangeFilters", wait_for_completion=True
+        "age", InvertedIndexType.RANGE_FILTERS, wait_for_completion=True
     )
     assert status.type == "rangeFilters"
     assert status.status == InvertedIndexState.READY
@@ -2799,7 +2803,7 @@ def test_property_reindex_coupled_tokenization_change(
     collection.data.insert_many([{"name": f"object {i}"} for i in range(100)])
 
     task = collection.config.update_property_index(
-        "name", "searchable", tokenization=Tokenization.FIELD
+        "name", InvertedIndexType.SEARCHABLE, tokenization=Tokenization.FIELD
     )
     assert task.status == InvertedIndexTaskStatus.STARTED
     assert task.task_id is not None
@@ -2819,7 +2823,10 @@ def test_property_reindex_coupled_tokenization_change(
 
     # poll the status endpoint (via the wait path of a NO_OP upsert) until the migration is done
     status = collection.config.update_property_index(
-        "name", "searchable", tokenization=Tokenization.FIELD, wait_for_completion=True
+        "name",
+        InvertedIndexType.SEARCHABLE,
+        tokenization=Tokenization.FIELD,
+        wait_for_completion=True,
     )
     assert status.status == InvertedIndexState.READY
     assert status.tokenization == Tokenization.FIELD
@@ -2851,13 +2858,16 @@ def test_property_reindex_multi_tenant(collection_factory: CollectionFactory) ->
     collection.with_tenant("tenant1").data.insert_many([{"age": i} for i in range(5)])
 
     status = collection.config.update_property_index(
-        "age", "rangeFilters", tenants=["tenant1", "tenant2"], wait_for_completion=True
+        "age",
+        InvertedIndexType.RANGE_FILTERS,
+        tenants=["tenant1", "tenant2"],
+        wait_for_completion=True,
     )
     assert status.type == "rangeFilters"
     assert status.status == InvertedIndexState.READY
 
     status = collection.config.rebuild_property_index(
-        "age", "rangeFilters", tenants=["tenant1"], wait_for_completion=True
+        "age", InvertedIndexType.RANGE_FILTERS, tenants=["tenant1"], wait_for_completion=True
     )
     assert status.type == "rangeFilters"
     assert status.status == InvertedIndexState.READY
@@ -2882,23 +2892,26 @@ async def test_property_reindex_async(async_collection_factory: AsyncCollectionF
     await collection.data.insert_many([{"name": f"object {i}"} for i in range(10)])
 
     status = await collection.config.update_property_index(
-        "name", "searchable", tokenization=Tokenization.WORD, wait_for_completion=True
+        "name",
+        InvertedIndexType.SEARCHABLE,
+        tokenization=Tokenization.WORD,
+        wait_for_completion=True,
     )
     assert status.type == "searchable"
     assert status.status == InvertedIndexState.READY
 
     task = await collection.config.update_property_index(
-        "name", "searchable", tokenization=Tokenization.WORD
+        "name", InvertedIndexType.SEARCHABLE, tokenization=Tokenization.WORD
     )
     assert task.status == InvertedIndexTaskStatus.NO_OP
 
     indexes = await collection.config.get_property_indexes()
     assert indexes.collection == collection.name
 
     status = await collection.config.rebuild_property_index(
-        "name", "searchable", wait_for_completion=True
+        "name", InvertedIndexType.SEARCHABLE, wait_for_completion=True
     )
     assert status.status == InvertedIndexState.READY
 
-    task = await collection.config.cancel_property_index_task("name", "searchable")
+    task = await collection.config.cancel_property_index_task("name", InvertedIndexType.SEARCHABLE)
     assert task.status == InvertedIndexTaskStatus.NO_OP

mock_tests/test_property_reindex.py

@@ -421,6 +421,7 @@ def test_update_property_index_enum_and_literal_hit_same_route(
 
     task = client_139.collections.use(COLLECTION).config.update_property_index(
         "name",
+        # runtime leniency pin: raw strings must keep hitting the same route
         index_name,  # type: ignore
     )
     assert task.status == InvertedIndexTaskStatus.STARTED
@@ -453,6 +454,7 @@ def test_delete_property_index_enum_and_literal_hit_same_route(
     assert (
         client_139.collections.use(COLLECTION).config.delete_property_index(
             "name",
+            # runtime leniency pin: raw strings must keep hitting the same route
             index_name,  # type: ignore
         )
         is True
@@ -478,6 +480,7 @@ def test_rebuild_property_index_enum_and_literal_hit_same_route(
 
     task = client_139.collections.use(COLLECTION).config.rebuild_property_index(
         "age",
+        # runtime leniency pin: raw strings must keep hitting the same route
         index_name,  # type: ignore
     )
     assert task.status == InvertedIndexTaskStatus.STARTED
@@ -502,6 +505,7 @@ def test_cancel_property_index_task_enum_and_literal_hit_same_route(
 
     task = client_139.collections.use(COLLECTION).config.cancel_property_index_task(
         "age",
+        # runtime leniency pin: raw strings must keep hitting the same route
         index_name,  # type: ignore
     )
     assert task.status == InvertedIndexTaskStatus.CANCELLED

weaviate/collections/config/async_.pyi

@@ -101,7 +101,7 @@ class _ConfigCollectionAsync(_ConfigCollectionExecutor[ConnectionAsync]):
     async def update_property_index(
         self,
         property_name: str,
-        index_name: Union[InvertedIndexType, IndexName],
+        index_name: InvertedIndexType,
         *,
         tokenization: Optional[Tokenization] = None,
         algorithm: Optional[Literal["blockmax"]] = None,
@@ -112,7 +112,7 @@ class _ConfigCollectionAsync(_ConfigCollectionExecutor[ConnectionAsync]):
     async def update_property_index(
         self,
         property_name: str,
-        index_name: Union[InvertedIndexType, IndexName],
+        index_name: InvertedIndexType,
         *,
         tokenization: Optional[Tokenization] = None,
         algorithm: Optional[Literal["blockmax"]] = None,
@@ -123,7 +123,7 @@ class _ConfigCollectionAsync(_ConfigCollectionExecutor[ConnectionAsync]):
     async def rebuild_property_index(
         self,
         property_name: str,
-        index_name: Union[InvertedIndexType, IndexName],
+        index_name: InvertedIndexType,
         *,
         tenants: Union[List[str], str, None] = None,
         wait_for_completion: Literal[True],
@@ -132,12 +132,12 @@ class _ConfigCollectionAsync(_ConfigCollectionExecutor[ConnectionAsync]):
     async def rebuild_property_index(
         self,
         property_name: str,
-        index_name: Union[InvertedIndexType, IndexName],
+        index_name: InvertedIndexType,
         *,
         tenants: Union[List[str], str, None] = None,
         wait_for_completion: Literal[False] = False,
     ) -> InvertedIndexTask: ...
     async def cancel_property_index_task(
-        self, property_name: str, index_name: Union[InvertedIndexType, IndexName]
+        self, property_name: str, index_name: InvertedIndexType
     ) -> InvertedIndexTask: ...
     async def get_property_indexes(self) -> CollectionInvertedIndexes: ...