Add head request x-mm-project-version header to GET v2/projects

Author: MarcelGeo

server/mergin/sync/public_api_v2_controller.py

@@ -203,6 +203,10 @@ def download_diff_file(id: str, file: str):
 def get_project(id, files_at_version=None):
     """Get project info. Include list of files at specific version if requested."""
     project = require_project_by_uuid(id, ProjectPermissions.Read, expose=False)
+    if request.method == "HEAD":
+        headers = {"X-Mm-Project-Version": project.latest_version}
+        return ProjectSchemaV2().dump(project), 200, headers
+
     data = ProjectSchemaV2().dump(project)
     if files_at_version:
         pv = ProjectVersion.query.filter_by(

server/mergin/tests/test_public_api_v2.py

@@ -852,6 +852,38 @@ def test_get_project(client):
     assert response.status_code == 400
 
 
+def test_head_project(client):
+    """Test head project endpoint returns version header."""
+    admin = User.query.filter_by(username=DEFAULT_USER[0]).first()
+    test_workspace = create_workspace()
+    project = create_project("head_project", test_workspace, admin)
+
+    logout(client)
+    response = client.head(f"v2/projects/{project.id}")
+    assert response.status_code == 404
+
+    user = add_user("head_test", "tests")
+    login(client, user.username, "tests")
+    response = client.head(f"v2/projects/{project.id}")
+    assert response.status_code == 403
+
+    project.public = True
+    db.session.commit()
+    response = client.head(f"v2/projects/{project.id}")
+    assert response.status_code == 200
+    assert response.headers["X-Mm-Project-Version"] == ProjectVersion.to_v_name(
+        project.latest_version
+    )
+    assert response.data == b""
+
+    login_as_admin(client)
+    project.public = False
+    project.removed_at = datetime.utcnow()
+    db.session.commit()
+    response = client.head(f"v2/projects/{project.id}")
+    assert response.status_code == 404
+
+
 push_data = [
     # success
     (

web-app/packages/lib/src/modules/project/projectApi.ts

@@ -344,5 +344,9 @@ export const ProjectApi = {
     return ProjectModule.httpService.get(
       `/v2/projects/${projectId}/collaborators`
     )
+  },
+
+  async headProject(projectId: string): Promise<AxiosResponse<void>> {
+    return ProjectModule.httpService.head(`/v2/projects/${projectId}`)
   }
 }