Add methods for filter variables

Author: Shubham

objectbox/c.py

@@ -16,10 +16,12 @@
 import ctypes.util
 import os
 import platform
-from objectbox.version import Version
+from ctypes import c_char_p
 from typing import *
+
 import numpy as np
-from enum import IntEnum
+
+from objectbox.version import Version
 
 # This file contains C-API bindings based on lib/objectbox.h, linking to the 'objectbox' shared library.
 # The bindings are implementing using ctypes, see https://docs.python.org/dev/library/ctypes.html for introduction.
@@ -1218,4 +1220,11 @@ def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
 obx_sync_listener_login_failure = c_fn('obx_sync_listener_login_failure', None, [OBX_sync_p, OBX_sync_listener_login_failure, ctypes.c_void_p])
 obx_sync_listener_error = c_fn('obx_sync_listener_error', None, [OBX_sync_p, OBX_sync_listener_error, ctypes.c_void_p])
 
-obx_sync_wait_for_logged_in_state = c_fn_rc('obx_sync_wait_for_logged_in_state', [OBX_sync_p, ctypes.c_uint64])
+obx_sync_wait_for_logged_in_state = c_fn_rc('obx_sync_wait_for_logged_in_state', [OBX_sync_p, ctypes.c_uint64])
+
+obx_sync_filter_variables_put = c_fn_rc('obx_sync_filter_variables_put',
+                                        [OBX_sync_p, c_char_p, c_char_p])
+obx_sync_filter_variables_remove = c_fn_rc('obx_sync_filter_variables_remove',
+                                           [OBX_sync_p, c_char_p])
+obx_sync_filter_variables_remove_all = c_fn_rc('obx_sync_filter_variables_remove_all',
+                                               [OBX_sync_p])

objectbox/sync.py

@@ -1,12 +1,8 @@
 import ctypes
-from collections.abc import Callable
-from ctypes import c_void_p
+from enum import Enum, auto, IntEnum
 
 import objectbox.c as c
 from objectbox import Store
-from enum import Enum, auto, IntEnum
-
-from objectbox.c import OBX_sync_listener_login
 
 
 class SyncCredentials:
@@ -92,6 +88,7 @@ class SyncLoginEvent:
     CREDENTIALS_REJECTED = 'credentials_rejected'
     UNKNOWN_ERROR = 'unknown_error'
 
+
 class SyncCode(IntEnum):
     OK = 20
     REQ_REJECTED = 40
@@ -102,13 +99,15 @@ class SyncCode(IntEnum):
     CLIENT_ID_TAKEN = 61
     TX_VIOLATED_UNIQUE = 71
 
+
 class SyncChange:
     def __init__(self, entity_id: int, entity: type, puts: list[int], removals: list[int]):
         self.entity_id = entity_id
         self.entity = entity
         self.puts = puts
         self.removals = removals
 
+
 class SyncLoginListener:
 
     def on_logged_in(self):
@@ -117,6 +116,7 @@ def on_logged_in(self):
     def on_login_failed(self, sync_login_code: SyncCode):
         pass
 
+
 class SyncConnectionListener:
 
     def on_connected(self):
@@ -125,11 +125,13 @@ def on_connected(self):
     def on_disconnected(self):
         pass
 
+
 class SyncErrorListener:
 
     def on_error(self, sync_error_code: int):
         pass
 
+
 class SyncClient:
 
     def __init__(self, store: Store, server_urls: list[str],
@@ -151,7 +153,8 @@ def __init__(self, store: Store, server_urls: list[str],
         self.__store = store
         self.__server_urls = [url.encode('utf-8') for url in server_urls]
 
-        self.__c_sync_client_ptr = c.obx_sync_urls(store.c_store(), c.c_array_pointer(self.__server_urls, ctypes.c_char_p),
+        self.__c_sync_client_ptr = c.obx_sync_urls(store.c_store(),
+                                                   c.c_array_pointer(self.__server_urls, ctypes.c_char_p),
                                                    len(self.__server_urls))
 
     def set_credentials(self, credentials: SyncCredentials):
@@ -223,7 +226,8 @@ def is_closed(self) -> bool:
 
     def set_login_listener(self, login_listener: SyncLoginListener):
         self.__c_login_listener = c.OBX_sync_listener_login(lambda arg: login_listener.on_logged_in())
-        self.__c_login_failure_listener = c.OBX_sync_listener_login_failure(lambda arg, sync_login_code: login_listener.on_login_failed(sync_login_code))
+        self.__c_login_failure_listener = c.OBX_sync_listener_login_failure(
+            lambda arg, sync_login_code: login_listener.on_login_failed(sync_login_code))
         c.obx_sync_listener_login(
             self.__c_sync_client_ptr,
             self.__c_login_listener,
@@ -250,12 +254,22 @@ def set_connection_listener(self, connection_listener: SyncConnectionListener):
         )
 
     def set_error_listener(self, error_listener: SyncErrorListener):
-        self.__c_error_listener = c.OBX_sync_listener_error(lambda arg, sync_error_code: error_listener.on_error(sync_error_code))
+        self.__c_error_listener = c.OBX_sync_listener_error(
+            lambda arg, sync_error_code: error_listener.on_error(sync_error_code))
         c.obx_sync_listener_error(
             self.__c_sync_client_ptr,
             self.__c_error_listener,
             None
         )
 
     def wait_for_logged_in_state(self, timeout_millis: int):
-        c.obx_sync_wait_for_logged_in_state(self.__c_sync_client_ptr, timeout_millis)
+        c.obx_sync_wait_for_logged_in_state(self.__c_sync_client_ptr, timeout_millis)
+
+    def add_filter_variable(self, name: str, value: str):
+        c.obx_sync_filter_variables_put(self.__c_sync_client_ptr, name.encode('utf-8'), value.encode('utf-8'))
+
+    def remove_filter_variable(self, name: str):
+        c.obx_sync_filter_variables_remove(self.__c_sync_client_ptr, name.encode('utf-8'))
+
+    def remove_all_filter_variables(self):
+        c.obx_sync_filter_variables_remove_all(self.__c_sync_client_ptr)

tests/test_sync.py

@@ -1,6 +1,11 @@
 from time import sleep
+
+import pytest
+
+from objectbox.exceptions import IllegalArgumentError
 from objectbox.sync import *
 
+
 def test_sync_protocol_version():
     version = SyncClient.protocol_version()
     assert version >= 1
@@ -32,3 +37,21 @@ def test_sync_listener(test_store, login_listener, connection_listener):
     assert login_listener.login_failure_code == SyncCode.CREDENTIALS_REJECTED
     assert connection_listener.connected_called
     assert connection_listener.disconnected_called
+
+
+def test_filter_variables(test_store):
+    server_urls = ["ws://localhost:9999"]
+
+    filter_vars = {
+        "name1": "val1",
+        "name2": "val2"
+    }
+    client = SyncClient(test_store, server_urls, filter_vars)
+
+    client.add_filter_variable("name3", "val3")
+    client.remove_filter_variable("name1")
+    client.add_filter_variable("name4", "val4")
+    client.remove_all_filter_variables()
+
+    with pytest.raises(IllegalArgumentError, match="Filter variables must have a name"):
+        client.add_filter_variable("", "val5")