Refresh user's project role in metadata on project status

Author: harminius

mergin/client.py

@@ -1157,6 +1157,10 @@ def project_status(self, directory):
         mp = MerginProject(directory)
         server_info = self.project_info(mp.project_full_name(), since=mp.version())
 
+        # the response carries the caller's current role, which is otherwise never refreshed
+        if server_info.get("role"):
+            mp.update_project_role(server_info["role"])
+
         pull_changes = mp.get_pull_changes(server_info.get("files", []), server_info.get("version"))
 
         push_changes = mp.get_push_changes()

mergin/merginproject.py

@@ -167,6 +167,16 @@ def project_role(self) -> str:
         self._read_metadata()
         return self._metadata.get("role")
 
+    def update_project_role(self, role: str) -> None:
+        """Stores the user's current role on the project.
+
+        Roles change without creating a new project version, so unlike the rest of the metadata
+        they cannot be kept up to date from the sync history alone.
+        """
+        self._read_metadata()
+        self._metadata["role"] = role
+        MerginProject.write_metadata(self.dir, self._metadata)
+
     def project_id(self) -> str:
         """Returns ID of the project (UUID using 8-4-4-4-12 formatting without braces)
 

mergin/test/test_mergin_project.py

@@ -471,3 +471,28 @@ def test_tables_to_skip_and_include_mutually_exclusive():
         mp.set_tables_to_skip(["table_a"])
         with pytest.raises(GeoDiffLibError):
             mp.set_tables_to_include(["table_b"])
+
+
+def test_update_project_role():
+    with tempfile.TemporaryDirectory() as tmp_dir:
+        project_dir = os.path.join(tmp_dir, "test_update_project_role")
+        shutil.copytree(TEST_DATA_DIR, project_dir)
+
+        os.makedirs(os.path.join(project_dir, ".mergin"), exist_ok=True)
+        with open(os.path.join(project_dir, "v2_metadata.json"), "r") as f:
+            metadata = json.load(f)
+        project_metadata_file = os.path.join(project_dir, ".mergin", "mergin.json")
+        with open(project_metadata_file, "w") as f:
+            json.dump(metadata, f, indent=2)
+
+        mp = MerginProject(project_dir)
+        assert mp.project_role() == "owner"
+
+        mp.update_project_role("reader")
+        assert mp.project_role() == "reader"
+        # the rest of the metadata has to survive, otherwise the local sync state would be lost
+        assert mp.version() == metadata.get("version")
+        assert mp.files() == metadata.get("files")
+
+        # the new role is on disk, not just in the in-memory cache
+        assert MerginProject(project_dir).project_role() == "reader"