Introduce generator for getting progress

- final commit probably

Author: MarcelGeo

mergin/cli.py

@@ -481,7 +481,7 @@ def sync(ctx):
     current_bar = None
     try:
         # Iterate over the generator to get updates
-        for size_change, job in mc._sync_project_generator(directory):
+        for size_change, job in mc.sync_project_generator(directory):
             # Check if this is a new job (a new push operation)
             if job and job != current_job:
                 # If a previous bar exists, close it

mergin/client.py

@@ -1512,9 +1512,13 @@ def create_invitation(self, workspace_id: int, email: str, workspace_role: Works
         ws_inv = self.post(f"v2/workspaces/{workspace_id}/invitations", params, json_headers)
         return json.load(ws_inv)
 
-    def _sync_project_generator(self, project_directory):
+    def sync_project_generator(self, project_directory):
         """
-        See `sync_project` for details. This method is a generator yielding upload progress as (size_change, job) tuples.
+        Syncs project by loop with these steps:
+        1. Pull server version
+        2. Get local changes
+        3. Push first change batch
+        Repeat if there are more local changes.
 
         :param project_directory: Project's directory
         """
@@ -1527,6 +1531,7 @@ def _sync_project_generator(self, project_directory):
                 job = push_project_async(self, project_directory)
                 if not job:
                     break
+                # waiting for progress
                 last_size = 0
                 while push_project_is_running(job):
                     sleep(SYNC_CALLBACK_WAIT)
@@ -1549,35 +1554,11 @@ def _sync_project_generator(self, project_directory):
 
     def sync_project(self, project_directory):
         """
-        Syncs project by loop with these steps:
-        1. Pull server version
-        2. Get local changes
-        3. Push first change batch
-        Repeat if there are more local changes.
+        See description of _sync_project_generator().
 
         :param project_directory: Project's directory
-        :param upload_progress: If True, the method will be a generator yielding upload progress as (size_change, job) tuples.
         """
-        mp = MerginProject(project_directory)
-        has_changes = True
-        server_conflict_attempts = 0
-        while has_changes:
-            self.pull_project(project_directory)
-            try:
-                job = push_project_async(self, project_directory)
-                if not job:
-                    break
-                push_project_wait(job)
-                push_project_finalize(job)
-                _, has_changes = get_push_changes_batch(self, mp)
-                server_conflict_attempts = 0
-            except ClientError as e:
-                if e.is_retryable_sync() and server_conflict_attempts < PUSH_ATTEMPTS - 1:
-                    # retry on conflict, e.g. when server has changes that we do not have yet
-                    mp.log.info(
-                        f"Restarting sync process (conflict on server) - {server_conflict_attempts + 1}/{PUSH_ATTEMPTS}"
-                    )
-                    server_conflict_attempts += 1
-                    sleep(PUSH_ATTEMPT_WAIT)
-                    continue
-                raise e
+        # walk through the generator to perform the sync
+        # in this method we do not yield anything to the caller
+        for _ in self.sync_project_generator(project_directory):
+            pass

mergin/common.py

@@ -39,7 +39,9 @@ class ErrorCode(Enum):
 
 
 class ClientError(Exception):
-    def __init__(self, detail: str, url=None, server_code=None, server_response=None, http_error=None, http_method=None):
+    def __init__(
+        self, detail: str, url=None, server_code=None, server_response=None, http_error=None, http_method=None
+    ):
         self.detail = detail
         self.url = url
         self.http_error = http_error

mergin/test/test_common.py

@@ -1,5 +1,6 @@
 from ..common import ClientError, ErrorCode
 
+
 def test_client_error_is_blocked_sync():
     """Test the is_blocked_sync method of ClientError."""
     error = ClientError(detail="", server_code=None)
@@ -12,6 +13,7 @@ def test_client_error_is_blocked_sync():
     error.server_code = ErrorCode.ProjectVersionExists.value
     assert error.is_blocking_sync() is True
 
+
 def test_client_error_is_rate_limit():
     """Test the is_rate_limit method of ClientError."""
     error = ClientError(detail="", http_error=None)
@@ -21,6 +23,7 @@ def test_client_error_is_rate_limit():
     error.http_error = 429
     assert error.is_rate_limit() is True
 
+
 def test_client_error_is_retryable_sync():
     """Test the is_retryable_sync method of ClientError."""
     error = ClientError(detail="", server_code=None, http_error=None)
@@ -43,4 +46,4 @@ def test_client_error_is_retryable_sync():
     error.http_error = 500
     assert error.is_retryable_sync() is False
     error.http_error = 429
-    assert error.is_retryable_sync() is True
+    assert error.is_retryable_sync() is True