Address review

- fix docstrings - add workspace_id parameter, fix example of order params
- equality for comparing WorkspaceRole.GUEST
- mock config GLOBAL roles change in tests
- add test for order params
- make the tests more deterministic

Author: harminius

server/mergin/sync/public_api_v2.yaml

@@ -393,11 +393,11 @@ paths:
             example: 50
         - name: order_params
           in: query
-          description: Sorting fields e.g. "name ASC,udpdated DESC"
+          description: Sorting fields
           required: false
           schema:
             type: string
-            example: name_asc,updated_desc
+            example: name ASC, expire DESC
         - name: q
           in: query
           description: Filter by name with ilike pattern

server/mergin/sync/public_api_v2_controller.py

@@ -403,6 +403,8 @@ def upload_chunk(id: str):
 def list_workspace_projects(workspace_id, page, per_page, order_params=None, q=None):
     """Paginate over workspace projects with optional filtering.
 
+    :param workspace_id: ID of the workspace to list projects from
+    :param workspace_id: int
     :param page: page number
     :type page: int
     :param per_page: Number of results per page
@@ -412,7 +414,7 @@ def list_workspace_projects(workspace_id, page, per_page, order_params=None, q=N
     :param q: Filter by name with ilike pattern
     :type q: str
 
-    :rtype: Dict[str: List[Project], str: Integer]
+    :rtype: Dict[str: List[Project], str: Integer, str: String, str: String]
     """
     ws = current_app.ws_handler.get(workspace_id)
     if not (ws and ws.is_active):

server/mergin/sync/workspace.py

@@ -78,7 +78,7 @@ def user_has_permissions(self, user, permissions):
             return True
 
         if permissions == "guest":
-            return role >= WorkspaceRole.GUEST
+            return role == WorkspaceRole.GUEST
         elif permissions == "read":
             return role >= WorkspaceRole.READER
         elif permissions == "edit":

server/mergin/tests/test_public_api_v2.py

@@ -628,24 +628,41 @@ def test_list_workspace_projects(client):
     # name search - more results
     page = 1
     per_page = 3
-    response = client.get(url + f"?page={page}&per_page={per_page}&q=1")
+    response = client.get(
+        url + f"?page={page}&per_page={per_page}&q=1&order_params=updated ASC"
+    )
     assert response.json["count"] == 2
     assert len(response.json["projects"]) == 2
     assert response.json["projects"][1]["name"] == "project_10"
     # name search - specific result
     project_name = "project_4"
     response = client.get(url + f"?page={page}&per_page={per_page}&q={project_name}")
     assert response.json["projects"][0]["name"] == project_name
+    # sorting
+    response = client.get(
+        url + f"?page={page}&per_page={per_page}&q=1&order_params=created DESC"
+    )
+    assert response.json["projects"][0]["name"] == "project_10"
 
     # no permissions to workspace
     user2 = add_user("user", "password")
     login(client, user2.username, "password")
-    Configuration.GLOBAL_READ = 0
-    Configuration.GLOBAL_WRITE = 0
-    Configuration.GLOBAL_ADMIN = 0
-    resp = client.get(url + "?page=1&per_page=10")
-    assert resp.status_code == 200
-    assert resp.json["count"] == 0
+    with patch.object(
+        Configuration,
+        "GLOBAL_READ",
+        0,
+    ), patch.object(
+        Configuration,
+        "GLOBAL_WRITE",
+        0,
+    ), patch.object(
+        Configuration,
+        "GLOBAL_ADMIN",
+        0,
+    ):
+        resp = client.get(url + "?page=1&per_page=10")
+        assert resp.status_code == 200
+        assert resp.json["count"] == 0
 
     # no existing workspace
     assert (
@@ -668,11 +685,10 @@ def test_list_workspace_projects(client):
     assert resp.json["count"] == 0
 
     # add user as a reader
-    Configuration.GLOBAL_READ = 1
-    db.session.commit()
-    resp = client.get(url + "?page=1&per_page=10")
-    assert p.name not in [proj["name"] for proj in resp.json["projects"]]
-    assert resp.json["count"] == 10
+    with patch.object(Configuration, "GLOBAL_READ", 1):
+        resp = client.get(url + "?page=1&per_page=10")
+        assert p.name not in [proj["name"] for proj in resp.json["projects"]]
+        assert resp.json["count"] == 10
 
     # logout
     logout(client)