First version for sync progress bar

Author: MarcelGeo

mergin/cli.py

@@ -477,17 +477,36 @@ def sync(ctx):
     if mc is None:
         return
     directory = os.getcwd()
-    upload_job = None
+    current_job = None
+    current_bar = None
     try:
-
-        def on_progress(increment, push_job):
-            nonlocal upload_job
-            upload_job = push_job
-
-        # run pull & push cycles until there are no local changes
-        mc.sync_project(directory, progress_callback=on_progress)
-
-        click.secho("Sync complete.", fg="green")
+        # Iterate over the generator to get updates
+        for size_change, job in mc.sync_project(directory, upload_progress=True):
+            # Check if this is a new job (a new push operation)
+            if job and job != current_job:
+                # If a previous bar exists, close it
+                if current_bar:
+                    current_bar.finish()
+
+                # A new push job has started. Initialize a new progress bar.
+                click.echo(f"Starting upload")
+                current_job = job
+
+                # The length of the progress bar should be the total size of the job
+                # You'll need to get this from your job object (e.g., job.total_size)
+                total_size = job.total_size
+                current_bar = click.progressbar(
+                    length=total_size,
+                    label=f"Uploading project",
+                )
+
+            # Update the current progress bar with the size increment
+            current_bar.update(size_change)
+
+        # After the loop finishes, make sure to close the final progress bar
+        if current_bar:
+            current_bar.finish()
+        click.secho("\nProject synced successfully", fg="green")
 
     except InvalidProject as e:
         click.secho("Invalid project directory ({})".format(str(e)), fg="red")
@@ -496,8 +515,8 @@ def on_progress(increment, push_job):
         return
     except KeyboardInterrupt:
         click.secho("Cancelling...")
-        if upload_job:
-            push_project_cancel(upload_job)
+        if current_job:
+            push_project_cancel(current_job)
     except Exception as e:
         _print_unhandled_exception()
 

mergin/client.py

@@ -1512,7 +1512,7 @@ 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(self, project_directory, progress_callback=None):
+    def sync_project(self, project_directory, upload_progress=False):
         """
         Syncs project by loop with these steps:
         1. Pull server version
@@ -1521,7 +1521,7 @@ def sync_project(self, project_directory, progress_callback=None):
         Repeat if there are more local changes.
 
         :param project_directory: Project's directory
-        :param progress_callback: Optional callback function to report progress during push.
+        :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
@@ -1536,16 +1536,14 @@ def sync_project(self, project_directory, progress_callback=None):
                 job = push_project_async(self, project_directory)
                 if not job:
                     break
-                if not progress_callback:
+                if not upload_progress:
                     push_project_wait(job)
                 else:
                     last_size = 0
                     while push_project_is_running(job):
                         sleep(SYNC_CALLBACK_WAIT)
                         current_size = job.transferred_size
-                        progress_callback(
-                            current_size - last_size, job
-                        )  # call callback with transferred size increment
+                        yield (current_size - last_size, job)  # Yields the size change and the job object
                         last_size = current_size
                 push_project_finalize(job)
                 _, has_changes = get_push_changes_batch(self, mp)