Fix type error, add obx_sync_state call in SyncClient

Shubham · Shubham · commit bf4158134627 · 2025-12-23T21:25:02.000+05:30
diff --git a/objectbox/c.py b/objectbox/c.py
@@ -27,7 +27,7 @@
 
 # Version of the library used by the binding. This version is checked at runtime to ensure binary compatibility.
 # Don't forget to update download-c-lib.py when upgrading to a newer version.
-required_version = "4.0.0"
+required_version = "5.0.0"
 
 
 def shlib_name(library: str) -> str:
@@ -266,8 +266,12 @@ class OBX_sync_server(ctypes.Structure):
 
 OBX_sync_server_p = ctypes.POINTER(OBX_sync_server)
 
+OBXSyncCredentialsType = ctypes.c_int
+OBXRequestUpdatesMode = ctypes.c_int
+OBXSyncState = ctypes.c_int
+OBXSyncCode = ctypes.c_int
 
-class OBXSyncCredentialsType(IntEnum):
+class SyncCredentialsType(IntEnum):
     NONE = 1
     SHARED_SECRET = 2  # Deprecated, use SHARED_SECRET_SIPPED instead
     GOOGLE_AUTH = 3
@@ -280,13 +284,13 @@ class OBXSyncCredentialsType(IntEnum):
     JWT_CUSTOM = 10  # JSON Web Token (JWT): custom token type
 
 
-class OBXRequestUpdatesMode(IntEnum):
+class RequestUpdatesMode(IntEnum):
     MANUAL = 0  # No updates by default, must call obx_sync_updates_request() manually
     AUTO = 1  # Same as calling obx_sync_updates_request(sync, TRUE)
     AUTO_NO_PUSHES = 2  # Same as calling obx_sync_updates_request(sync, FALSE)
 
 
-class OBXSyncState(IntEnum):
+class SyncState(IntEnum):
     CREATED = 1
     STARTED = 2
     CONNECTED = 3
@@ -296,7 +300,7 @@ class OBXSyncState(IntEnum):
     DEAD = 7
 
 
-class OBXSyncCode(IntEnum):
+class SyncCode(IntEnum):
     OK = 20
     REQ_REJECTED = 40
     CREDENTIALS_REJECTED = 43
@@ -1191,21 +1195,23 @@ def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
 OBXBackupRestoreFlags_None = 0
 OBXBackupRestoreFlags_OverwriteExistingData = 1
 
-obx_sync = c_fn("obx_sync", obx_err, [OBX_store_p, ctypes.c_char_p])
-obx_sync_urls = c_fn("obx_sync_urls", obx_err, [OBX_store_p, ctypes.POINTER(ctypes.c_char_p), ctypes.c_size_t])
+obx_sync = c_fn("obx_sync", OBX_sync_p, [OBX_store_p, ctypes.c_char_p])
+obx_sync_urls = c_fn("obx_sync_urls", OBX_sync_p, [OBX_store_p, ctypes.POINTER(ctypes.c_char_p), ctypes.c_size_t])
 
 
 obx_sync_credentials = c_fn_rc('obx_sync_credentials',
-                                [OBX_sync_p, OBXSyncCredentialsType, ctypes.c_void_p, ctypes.c_size_t])
+                               [OBX_sync_p, OBXSyncCredentialsType, ctypes.c_void_p, ctypes.c_size_t])
 obx_sync_credentials_user_password = c_fn_rc('obx_sync_credentials_user_password',
                                                [OBX_sync_p, OBXSyncCredentialsType, ctypes.c_char_p,
                                                 ctypes.c_char_p])
 obx_sync_credentials_add = c_fn_rc('obx_sync_credentials_add',
-                                    [OBX_sync_p, OBXSyncCredentialsType, ctypes.c_void_p, ctypes.c_size_t, ctypes.c_bool])
+                                   [OBX_sync_p, OBXSyncCredentialsType, ctypes.c_void_p, ctypes.c_size_t, ctypes.c_bool])
 obx_sync_credentials_add_user_password = c_fn_rc('obx_sync_credentials_add_user_password',
                                                    [OBX_sync_p, OBXSyncCredentialsType, ctypes.c_char_p, ctypes.c_char_p,
                                                     ctypes.c_bool])
 
+obx_sync_state = c_fn('obx_sync_state', OBXSyncState, [OBX_sync_p])
+
 obx_sync_request_updates_mode = c_fn_rc('obx_sync_request_updates_mode', [OBX_sync_p, OBXRequestUpdatesMode])
 
 obx_sync_start = c_fn_rc('obx_sync_start', [OBX_sync_p])
diff --git a/objectbox/sync.py b/objectbox/sync.py
@@ -1,12 +1,11 @@
 import ctypes
-import c as c
+import objectbox.c as c
 from objectbox import Store
-from objectbox.c import c_array_pointer
-
+from enum import Enum, auto
 
 class SyncCredentials:
 
-    def __init__(self, credential_type: c.OBXSyncCredentialsType):
+    def __init__(self, credential_type: c.SyncCredentialsType):
         self.type = credential_type
 
     @staticmethod
@@ -15,60 +14,60 @@ def none() -> 'SyncCredentials':
 
     @staticmethod
     def shared_secret_string(secret: str) -> 'SyncCredentials':
-        return SyncCredentialsSecret(c.OBXSyncCredentialsType.SHARED_SECRET_SIPPED, secret.encode('utf-8'))
+        return SyncCredentialsSecret(c.SyncCredentialsType.SHARED_SECRET_SIPPED, secret.encode('utf-8'))
 
     @staticmethod
     def google_auth(secret: str) -> 'SyncCredentials':
-        return SyncCredentialsSecret(c.OBXSyncCredentialsType.GOOGLE_AUTH, secret.encode('utf-8'))
+        return SyncCredentialsSecret(c.SyncCredentialsType.GOOGLE_AUTH, secret.encode('utf-8'))
 
     @staticmethod
     def user_and_password(username: str, password: str) -> 'SyncCredentials':
-        return SyncCredentialsUserPassword(c.OBXSyncCredentialsType.USER_PASSWORD, username, password)
+        return SyncCredentialsUserPassword(c.SyncCredentialsType.USER_PASSWORD, username, password)
 
     @staticmethod
     def jwt_id_token(jwt_id_token: str) -> 'SyncCredentials':
-        return SyncCredentialsSecret(c.OBXSyncCredentialsType.JWT_ID, jwt_id_token.encode('utf-8'))
+        return SyncCredentialsSecret(c.SyncCredentialsType.JWT_ID, jwt_id_token.encode('utf-8'))
 
     @staticmethod
     def jwt_access_token(jwt_access_token: str) -> 'SyncCredentials':
-        return SyncCredentialsSecret(c.OBXSyncCredentialsType.JWT_ACCESS, jwt_access_token.encode('utf-8'))
+        return SyncCredentialsSecret(c.SyncCredentialsType.JWT_ACCESS, jwt_access_token.encode('utf-8'))
 
     @staticmethod
     def jwt_refresh_token(jwt_refresh_token: str) -> 'SyncCredentials':
-        return SyncCredentialsSecret(c.OBXSyncCredentialsType.JWT_REFRESH, jwt_refresh_token.encode('utf-8'))
+        return SyncCredentialsSecret(c.SyncCredentialsType.JWT_REFRESH, jwt_refresh_token.encode('utf-8'))
 
     @staticmethod
     def jwt_custom_token(jwt_custom_token: str) -> 'SyncCredentials':
-        return SyncCredentialsSecret(c.OBXSyncCredentialsType.JWT_CUSTOM, jwt_custom_token.encode('utf-8'))
+        return SyncCredentialsSecret(c.SyncCredentialsType.JWT_CUSTOM, jwt_custom_token.encode('utf-8'))
 
 
 class SyncCredentialsNone(SyncCredentials):
     def __init__(self):
-        super().__init__(c.OBXSyncCredentialsType.NONE)
+        super().__init__(c.SyncCredentialsType.NONE)
 
 
 class SyncCredentialsSecret(SyncCredentials):
-    def __init__(self, credential_type: c.OBXSyncCredentialsType, secret: bytes):
+    def __init__(self, credential_type: c.SyncCredentialsType, secret: bytes):
         super().__init__(credential_type)
         self.secret = secret
 
 
 class SyncCredentialsUserPassword(SyncCredentials):
-    def __init__(self, credential_type: c.OBXSyncCredentialsType, username: str, password: str):
+    def __init__(self, credential_type: c.SyncCredentialsType, username: str, password: str):
         super().__init__(credential_type)
         self.username = username
         self.password = password
 
 
-class SyncState:
-    UNKNOWN = 'unknown'
-    CREATED = 'created'
-    STARTED = 'started'
-    CONNECTED = 'connected'
-    LOGGED_IN = 'logged_in'
-    DISCONNECTED = 'disconnected'
-    STOPPED = 'stopped'
-    DEAD = 'dead'
+class SyncState(Enum):
+    UNKNOWN = auto()
+    CREATED = auto()
+    STARTED = auto()
+    CONNECTED = auto()
+    LOGGED_IN = auto()
+    DISCONNECTED = auto()
+    STOPPED = auto()
+    DEAD = auto()
 
 
 class SyncRequestUpdatesMode:
@@ -103,16 +102,18 @@ def __init__(self, store: Store, server_urls: list[str], credentials: list[SyncC
         if not server_urls:
             raise ValueError("Provide at least one server URL")
 
-        if not Sync.is_available():
-            raise RuntimeError(
-                'Sync is not available in the loaded ObjectBox runtime library. '
-                'Please visit https://objectbox.io/sync/ for options.')
+        # TODO: Implement sync availability check
+        # if not c.Sync.is_available():
+        #     raise RuntimeError(
+        #         'Sync is not available in the loaded ObjectBox runtime library. '
+        #         'Please visit https://objectbox.io/sync/ for options.')
 
         self.__store = store
         self.__server_urls = server_urls
         self.__credentials = credentials
 
-        self.__c_sync_client_ptr = c.obx_sync_urls(store.c_store(), c_array_pointer(server_urls, ctypes.c_char_p),
+        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(server_urls, ctypes.c_char_p),
                                                    len(server_urls))
 
     def set_credentials(self, credentials: SyncCredentials):
@@ -130,15 +131,34 @@ def set_credentials(self, credentials: SyncCredentials):
 
     def set_request_updates_mode(self, mode: SyncRequestUpdatesMode):
         if mode == SyncRequestUpdatesMode.MANUAL:
-            c_mode = c.OBXRequestUpdatesMode.MANUAL
+            c_mode = c.RequestUpdatesMode.MANUAL
         elif mode == SyncRequestUpdatesMode.AUTO:
-            c_mode = c.OBXRequestUpdatesMode.AUTO
+            c_mode = c.RequestUpdatesMode.AUTO
         elif mode == SyncRequestUpdatesMode.AUTO_NO_PUSHES:
-            c_mode = c.OBXRequestUpdatesMode.AUTO_NO_PUSHES
+            c_mode = c.RequestUpdatesMode.AUTO_NO_PUSHES
         else:
             raise ValueError(f"Invalid mode: {mode}")
         c.obx_sync_request_updates_mode(self.__c_sync_client_ptr, c_mode)
 
+    def get_sync_state(self) -> SyncState:
+        c_state = c.obx_sync_state(self.__c_sync_client_ptr)
+        if c_state == c.SyncState.CREATED:
+            return SyncState.CREATED
+        elif c_state == c.SyncState.STARTED:
+            return SyncState.STARTED
+        elif c_state == c.SyncState.CONNECTED:
+            return SyncState.CONNECTED
+        elif c_state == c.SyncState.LOGGED_IN:
+            return SyncState.LOGGED_IN
+        elif c_state == c.SyncState.DISCONNECTED:
+            return SyncState.DISCONNECTED
+        elif c_state == c.SyncState.STOPPED:
+            return SyncState.STOPPED
+        elif c_state == c.SyncState.DEAD:
+            return SyncState.DEAD
+        else:
+            return SyncState.UNKNOWN
+
     def start(self):
         c.obx_sync_start(self.__c_sync_client_ptr)
 
