Develop

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Reformat code with black
+107452539ec5a0e1d6e31f0697d215cc3cf3be11

.github/workflows/code_style.yml

@@ -0,0 +1,27 @@
+name: Code Layout
+
+on: push
+
+jobs:
+  code_style_python:
+    name: Python code convention check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: psf/black@stable
+        with:
+          options: "--check --verbose --diff"
+          src: "./server"
+
+  code_style_js:
+    name: JavaScript code convention check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+      - name: Check JS
+        run: |
+            cd web-app
+            yarn install
+            yarn run lint:all

README.md

@@ -14,7 +14,8 @@
 </p>
 
 <p align="center">
-<img src="https://img.shields.io/badge/License-Dual AGPL3 and MM Commercial licence-blue">
+<img src="https://img.shields.io/badge/License-Dual AGPL3 and MM Commercial licence-blue"> <br />
+[![Code Layout](https://github.com/MerginMaps/mergin/actions/workflows/code_style.yml/badge.svg)](https://github.com/MerginMaps/mergin/actions/workflows/code_style.yml)
 </p>
 
 ## About

server/mergin/app.py

@@ -18,6 +18,7 @@
 from flask_mail import Mail
 from connexion.apps.flask_app import FlaskJSONEncoder
 from flask_wtf import FlaskForm
+from wtforms import StringField
 from pathlib import Path
 import sys
 import time
@@ -433,3 +434,19 @@ class ResponseError:
 
     def to_dict(self) -> Dict:
         return dict(code=self.code, detail=self.detail + f" ({self.code})")
+
+
+def whitespace_filter(obj):
+    return obj.strip() if isinstance(obj, str) else obj
+
+
+class CustomStringField(StringField):
+    """Custom class for string form fields"""
+
+    def __init__(self, *args, **kwargs):
+        filters = kwargs.get("filters")
+        # add whitespace filter
+        kwargs["filters"] = (
+            (*filters, whitespace_filter) if filters else (whitespace_filter,)
+        )
+        super().__init__(*args, **kwargs)

server/mergin/auth/forms.py

@@ -16,11 +16,7 @@
 )
 
 from .models import User
-from ..app import UpdateForm
-
-
-def whitespace_filter(obj):
-    return obj.strip() if isinstance(obj, str) else obj
+from ..app import UpdateForm, CustomStringField
 
 
 def username_validation(form, field):
@@ -51,20 +47,18 @@ def __call__(self, form, field):
 class LoginForm(FlaskForm):
     """Form with username and password fields for user to sign in."""
 
-    login = StringField(validators=[DataRequired(), Length(max=80)])
+    login = CustomStringField(validators=[DataRequired(), Length(max=80)])
     password = PasswordField(validators=[DataRequired()])
 
 
 class RegisterUserForm(FlaskForm):
-    username = StringField(
+    username = CustomStringField(
         "Username",
         validators=[validators.Length(min=4, max=25), username_validation],
-        filters=(whitespace_filter,),
     )
-    email = StringField(
+    email = CustomStringField(
         "Email Address",
         validators=[DataRequired(), Email()],
-        filters=(whitespace_filter,),
     )
 
     def validate(self):
@@ -85,8 +79,9 @@ def validate(self):
 
 
 class ResetPasswordForm(FlaskForm):
-    email = StringField(
-        "Email Address", [DataRequired(), Email()], filters=(whitespace_filter,)
+    email = CustomStringField(
+        "Email Address",
+        [DataRequired(), Email()],
     )
 
 
@@ -119,9 +114,9 @@ class UserProfileDataForm(UpdateForm):
     """This form is for user profile update"""
 
     receive_notifications = BooleanField("Receive notifications", [Optional()])
-    first_name = StringField("First Name", [Optional()], filters=(whitespace_filter,))
-    last_name = StringField("Last Name", [Optional()], filters=(whitespace_filter,))
-    email = StringField("Email", [Optional(), Email()], filters=(whitespace_filter,))
+    first_name = CustomStringField("First Name", [Optional()])
+    last_name = CustomStringField("Last Name", [Optional()])
+    email = CustomStringField("Email", [Optional(), Email()])
 
 
 class ApiLoginForm(LoginForm):

server/mergin/sync/models.py

@@ -212,8 +212,11 @@ def file_diffs_chain(self, file, version):
                 meta = history[history_end]
                 # we have either full history of changes or v_x = v_x+n => no basefile in way, it is 'diffable' from the end
                 if "diff" in meta:
+                    # omit diff for target version as it would lead to previous version if reconstructed backward
                     diffs = [
-                        value["diff"] for value in list(reversed(history.values()))[1:]
+                        value["diff"]
+                        for key, value in reversed(history.items())
+                        if key != v_x
                     ]
                     base_meta = history[next(iter(history))]
                     base_meta["version"] = next(iter(history))
@@ -249,7 +252,9 @@ def file_diffs_chain(self, file, version):
                     else:
                         diffs = [
                             value["diff"]
-                            for value in list(reversed(history.values()))[1:]
+                            for value in list(reversed(history.values()))[
+                                1:
+                            ]  # basefile has no diff
                         ]
                 # file was removed (or renamed for backward compatibility)
                 else:
@@ -417,6 +422,11 @@ def __init__(self, project, name, author, changes, files, ip, user_agent=None):
             if "diff" in change:
                 change["diff"].pop("chunks", None)
 
+    @property
+    def int_name(self) -> int:
+        """Parsed version name as integer (v5 -> 5)"""
+        return int(self.name.replace("v", ""))
+
     def diff_summary(self):
         """Calculate diff summary for versioned files updated with geodiff
 

server/mergin/sync/permissions.py

@@ -8,6 +8,7 @@
 from flask import abort, current_app
 from flask_login import current_user
 
+from .utils import is_valid_uuid
 from ..auth.models import User
 from .models import ProjectAccess, Project, Upload
 
@@ -138,6 +139,9 @@ def require_project(ws, project_name, permission):
 
 
 def require_project_by_uuid(uuid, permission):
+    if not is_valid_uuid(uuid):
+        abort(404)
+
     project = (
         Project.query.filter_by(id=uuid)
         .filter(Project.removed_at.is_(None))

server/mergin/sync/private_api_controller.py

@@ -276,7 +276,9 @@ def update_project_access(id: str):
     :rtype: None
     """
     project = require_project_by_uuid(id, ProjectPermissions.Update)
-    user = User.query.filter_by(id=request.json["user_id"], active=True).first_or_404("User does not exist")
+    user = User.query.filter_by(id=request.json["user_id"], active=True).first_or_404(
+        "User does not exist"
+    )
     # prevent to remove ownership of project creator
     if user.id == project.creator_id:
         abort(400, "Ownership of project creator cannot be removed")

server/mergin/sync/public_api.yaml

@@ -460,6 +460,41 @@ paths:
         '404':
           $ref: '#/components/responses/NotFoundResp'
       x-openapi-router-controller: mergin.sync.public_api_controller
+  '/project/version/{project_id}/{version}':
+    get:
+      tags:
+        - project
+      summary: Get project version by its name (e.g. v3)
+      operationId: get_project_version
+      parameters:
+        - name: project_id
+          in: path
+          required: true
+          schema:
+            type: string
+            example: ac70181b5-7143-491b-91a6-4f533021c9a2
+        - name: version
+          in: path
+          required: true
+          schema:
+            type: string
+            example: v3
+      responses:
+        '200':
+          description: Project version detail
+          content:
+            application/json:
+              schema:
+                  $ref: "#/components/schemas/ProjectVersion"
+        '400':
+          $ref: '#/components/responses/BadStatusResp'
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFoundResp'
+      x-openapi-router-controller: mergin.sync.public_api_controller
   /project/download/{namespace}/{project_name}:
     get:
       tags:

server/mergin/sync/public_api_controller.py

@@ -1335,3 +1335,14 @@ def get_workspace_by_id(id):
     ctx = {"user": current_user}
     data = UserWorkspaceSchema(context=ctx).dump(ws)
     return data, 200
+
+
+@auth_required
+def get_project_version(project_id: str, version: str):
+    """Get project version by its name (e.g. v3)"""
+    project = require_project_by_uuid(project_id, ProjectPermissions.Read)
+    pv = ProjectVersion.query.filter_by(
+        project_id=project.id, name=version
+    ).first_or_404()
+    data = ProjectVersionSchema(exclude=["files"]).dump(pv)
+    return data, 200

server/mergin/sync/workspace.py

@@ -58,7 +58,11 @@ def disk_usage(self):
         # get only what is necessary from db to calculate final usage
         from .models import Project
 
-        projects_usage_list = db.session.query(Project.disk_usage).filter(Project.removed_at.is_(None)).all()
+        projects_usage_list = (
+            db.session.query(Project.disk_usage)
+            .filter(Project.removed_at.is_(None))
+            .all()
+        )
         return sum(p.disk_usage for p in projects_usage_list)
 
     def user_has_permissions(self, user, permissions):

server/mergin/tests/test_auth.py

@@ -24,9 +24,10 @@ def client(app):
     return client
 
 
-# login tests: success, success with email login, invalid password, missing password, wrong headers
+# login tests: success, success with trailing space, success with email login, invalid password, missing password, wrong headers
 test_login_data = [
     ({"login": "mergin", "password": "ilovemergin"}, json_headers, 200),
+    ({"login": "mergin  ", "password": "ilovemergin"}, json_headers, 200),
     ({"login": "mergin@mergin.com", "password": "ilovemergin"}, json_headers, 200),
     ({"login": "mergin", "password": "ilovemergi"}, json_headers, 401),
     ({"login": "mergin"}, json_headers, 401),
@@ -37,7 +38,9 @@ def client(app):
 @pytest.mark.parametrize("data,headers,expected", test_login_data)
 def test_login(client, data, headers, expected):
     resp = client.post(
-        url_for("/.mergin_auth_controller_login"), data=json.dumps(data), headers=headers
+        url_for("/.mergin_auth_controller_login"),
+        data=json.dumps(data),
+        headers=headers,
     )
     assert resp.status_code == expected
     if expected == 200:

server/mergin/tests/test_config.py

@@ -18,7 +18,7 @@ def test_config(client):
         "server_configured",
         "fix",
         "major",
-        "minor"
+        "minor",
     }
     resp = client.get("/config")
     assert resp.status_code == 200