Add support for backup count in Vector Collection configuration [AI-145] (#702)

Backup count configuration for vector collection was added in
hazelcast/hazelcast-client-protocol#533

New parameters need #699 but the tests work with both 5.5 (skipped) and
6.0.

Co-authored-by: Yüce Tekol <yuce.tekol@hazelcast.com>

Author: k-jamroz

hazelcast/client.py

@@ -378,14 +378,22 @@ def get_topic(self, name: str) -> Topic[MessageType]:
         """
         return self._proxy_manager.get_or_create(TOPIC_SERVICE, name)
 
-    def create_vector_collection_config(self, name: str, indexes: typing.List[IndexConfig]) -> None:
+    def create_vector_collection_config(
+        self,
+        name: str,
+        indexes: typing.List[IndexConfig],
+        backup_count: int = 1,
+        async_backup_count: int = 0,
+    ) -> None:
         # check that indexes have different names
         if indexes:
             index_names = set(index.name for index in indexes)
             if len(index_names) != len(indexes):
                 raise AssertionError("index names must be unique")
 
-        request = dynamic_config_add_vector_collection_config_codec.encode_request(name, indexes)
+        request = dynamic_config_add_vector_collection_config_codec.encode_request(
+            name, indexes, backup_count, async_backup_count
+        )
         invocation = Invocation(request, response_handler=lambda m: m)
         self._invocation_service.invoke(invocation)
         invocation.future.result()

hazelcast/protocol/codec/dynamic_config_add_vector_collection_config_codec.py

@@ -1,3 +1,5 @@
+from hazelcast.serialization.bits import *
+from hazelcast.protocol.builtin import FixSizedTypesCodec
 from hazelcast.protocol.client_message import OutboundMessage, REQUEST_HEADER_SIZE, create_initial_buffer
 from hazelcast.protocol.builtin import StringCodec
 from hazelcast.protocol.builtin import ListMultiFrameCodec
@@ -8,11 +10,15 @@
 # hex: 0x1B1401
 _RESPONSE_MESSAGE_TYPE = 1774593
 
-_REQUEST_INITIAL_FRAME_SIZE = REQUEST_HEADER_SIZE
+_REQUEST_BACKUP_COUNT_OFFSET = REQUEST_HEADER_SIZE
+_REQUEST_ASYNC_BACKUP_COUNT_OFFSET = _REQUEST_BACKUP_COUNT_OFFSET + INT_SIZE_IN_BYTES
+_REQUEST_INITIAL_FRAME_SIZE = _REQUEST_ASYNC_BACKUP_COUNT_OFFSET + INT_SIZE_IN_BYTES
 
 
-def encode_request(name, index_configs):
+def encode_request(name, index_configs, backup_count, async_backup_count):
     buf = create_initial_buffer(_REQUEST_INITIAL_FRAME_SIZE, _REQUEST_MESSAGE_TYPE)
+    FixSizedTypesCodec.encode_int(buf, _REQUEST_BACKUP_COUNT_OFFSET, backup_count)
+    FixSizedTypesCodec.encode_int(buf, _REQUEST_ASYNC_BACKUP_COUNT_OFFSET, async_backup_count)
     StringCodec.encode(buf, name)
     ListMultiFrameCodec.encode(buf, index_configs, VectorIndexConfigCodec.encode, True)
     return OutboundMessage(buf, False)

tests/integration/backward_compatible/proxy/vector_collection_test.py

@@ -169,6 +169,38 @@ def test_size(self):
         self.vector_collection.clear()
         self.assertEqual(self.vector_collection.size(), 0)
 
+    def test_backupCount_valid_values_pass(self):
+        name = random_string()
+        self.client.create_vector_collection_config(
+            name, [IndexConfig("vector", Metric.COSINE, 3)], backup_count=2, async_backup_count=2
+        )
+
+    def test_backupCount(self):
+        skip_if_server_version_older_than(self, self.client, "6.0")
+        name = random_string()
+        # check that the parameter is used by ensuring that it is validated on server side
+        # there is no simple way to check number of backups
+        with self.assertRaises(hazelcast.errors.IllegalArgumentError):
+            self.client.create_vector_collection_config(
+                name,
+                [IndexConfig("vector", Metric.COSINE, 3)],
+                backup_count=7,
+                async_backup_count=0,
+            )
+
+    def test_asyncBackupCount(self):
+        skip_if_server_version_older_than(self, self.client, "6.0")
+        name = random_string()
+        # check that the parameter is used by ensuring that it is validated on server side
+        # there is no simple way to check number of backups
+        with self.assertRaises(hazelcast.errors.IllegalArgumentError):
+            self.client.create_vector_collection_config(
+                name,
+                [IndexConfig("vector", Metric.COSINE, 3)],
+                backup_count=0,
+                async_backup_count=7,
+            )
+
     def assert_document_equal(self, doc1, doc2) -> None:
         self.assertEqual(doc1.value, doc2.value)
         self.assertEqual(len(doc1.vectors), len(doc2.vectors))