Merge branch 'master' into release

Author: lukasgraf

.env.example

@@ -331,16 +331,6 @@ QFIELDCLOUD_DEFAULT_TIME_ZONE="Europe/Zurich"
 # DEFAULT: ""
 # QFIELDCLOUD_QGIS_IMAGE_NAME=""
 
-# QFieldCloud `libqfieldsync` volume path to be mounted by the `worker_wrapper` into `worker` containers.
-# If empty value or invalid value, the pip installed version defined in `requirements_libqfieldsync.txt` will be used.
-# DEFAULT: ""
-QFIELDCLOUD_LIBQFIELDSYNC_VOLUME_PATH=""
-
-# QFieldCloud SDK volume path to be mounted by the `worker_wrapper` into `worker` containers.
-# If empty value or invalid value, the pip installed version defined in `requirements_libqfieldsync.txt` will be used.
-# DEFAULT: ""
-QFIELDCLOUD_QFIELDCLOUD_SDK_VOLUME_PATH=""
-
 # The Django development port. Not used in production.
 # DEFAULT: 8011
 DJANGO_DEV_PORT=8011
@@ -374,10 +364,34 @@ COMPOSE_FILE=docker-compose.yml:docker-compose.override.local.yml:docker-compose
 # DEFAULT: :
 COMPOSE_PATH_SEPARATOR=:
 
+##################
+# Debug settings
+##################
+
 # Debugpy port used for the `app` service
+# NOTE modifying this value requires modification of `.vscode/launch.json` file too
 # DEFAULT: 5678
-DEBUG_DEBUGPY_APP_PORT=5678
+DEBUG_APP_DEBUGPY_PORT=5678
 
 # Debugpy port used for the `worker_wrapper` service
+# NOTE modifying this value requires modification of `.vscode/launch.json` file too
 # DEFAULT: 5679
-DEBUG_DEBUGPY_WORKER_WRAPPER_PORT=5679
+DEBUG_WORKER_WRAPPER_DEBUGPY_PORT=5679
+
+# Debugpy port used for the `qgis` service
+# NOTE modifying this value requires modification of `.vscode/launch.json` file too
+# NOTE setting a value to this variable (e.g. 5680) will make the `qgis` container wait until a debugger is attached
+# DEFAULT: ""
+DEBUG_QGIS_DEBUGPY_PORT=""
+
+# Host path to `libqfieldsync` which will be mounted by the `worker_wrapper` into the `worker` containers to facilitate development and debugging of `libqfieldsync`.
+# If empty value or invalid value, the pip installed version defined in `requirements_libqfieldsync.txt` will be used.
+# The provided path must be the root of the https://github.com/opengisch/libqfieldsync repository.
+# DEFAULT: ""
+DEBUG_QGIS_LIBQFIELDSYNC_HOST_PATH=""
+
+# Host path to `qfieldcloud-sdk-python` which will be mounted by the `worker_wrapper` into the `worker` containers to facilitate development and debugging of `qfieldcloud-sdk`.
+# If empty value or invalid value, the pip installed version defined in `requirements.txt` will be used.
+# The provided path must be the root of the https://github.com/opengisch/qfieldcloud-sdk-python repository.
+# DEFAULT: ""
+DEBUG_QGIS_QFIELDCLOUD_SDK_HOST_PATH=""

.vscode/launch.json

@@ -49,6 +49,26 @@
       ],
       // enable only if you want to debug vendor modules installed via `pip` or `apt`
       // "justMyCode": false,
-    }
+    },
+    {
+      "name": "QFieldCloud Debug (Attach) - qgis",
+      "type": "debugpy",
+      "request": "attach",
+      "connect": {
+        "host": "localhost",
+        // must match the value of `DEBUG_DEBUGPY_QGIS_PORT` from `.env` file, by default 5680
+        "port": 5680
+      },
+      "pathMappings": [
+        {
+          "localRoot": "${workspaceFolder}/docker-qgis",
+          "remoteRoot": "/usr/src/app"
+        },
+        {
+          "localRoot": "${workspaceFolder}/docker-qgis/libqfieldsync",
+          "remoteRoot": "/libqfieldsync"
+        },
+      ],
+    },
   ]
 }

README.md

@@ -201,8 +201,8 @@ Create an <code>.env.test</code> file with the following variables that override
     SMTP4DEV_IMAP_PORT=8143
     COMPOSE_PROJECT_NAME=qfieldcloud_test
     COMPOSE_FILE=docker-compose.yml:docker-compose.override.standalone.yml:docker-compose.override.test.yml
-    DEBUG_DEBUGPY_APP_PORT=5781
-    DEBUG_DEBUGPY_WORKER_WRAPPER_PORT=5780
+    DEBUG_APP_DEBUGPY_PORT=5781
+    DEBUG_WORKER_WRAPPER_DEBUGPY_PORT=5780
     DEMGEN_PORT=8201
 
 Build the test docker compose stack:

docker-app/qfieldcloud/core/admin.py

@@ -866,7 +866,6 @@ class ProjectAdmin(QFieldCloudModelAdmin):
         "description",
         "created_at",
         "updated_at",
-        "is_locked",
     )
     list_filter = (
         "is_public",
@@ -893,7 +892,7 @@ class ProjectAdmin(QFieldCloudModelAdmin):
         "data_last_updated_at",
         "data_last_packaged_at",
         "project_details__pre",
-        "is_locked",
+        "locked_at",
         "is_featured",
         "file_storage",
         "file_storage_migrated_at",
@@ -911,7 +910,7 @@ class ProjectAdmin(QFieldCloudModelAdmin):
         "data_last_updated_at",
         "data_last_packaged_at",
         "project_details__pre",
-        "is_locked",
+        "locked_at",
         "file_storage_migrated_at",
     )
     inlines = (
@@ -1629,7 +1628,7 @@ class FaultyDeltaFilesAdmin(QFieldCloudModelAdmin):
         "user_agent",
     )
 
-    list_filter = ("project", "project__owner__username", "created_at")
+    list_filter = ("created_at",)
 
     list_select_related = ("project", "project__owner")
 

docker-app/qfieldcloud/core/management/commands/dequeue.py

@@ -1,15 +1,17 @@
 import logging
 import signal
 from time import sleep
+from typing import Any
 
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
-from django.core.management.base import BaseCommand
+from django.core.management.base import BaseCommand, CommandParser
 from django.db import connection, transaction
 from django.db.models import Q
 from qfieldcloud.core.models import Job
 from worker_wrapper.wrapper import (
     DeltaApplyJobRun,
+    JobRun,
     PackageJobRun,
     ProcessProjectfileJobRun,
     cancel_orphaned_workers,
@@ -21,23 +23,28 @@
 class GracefulKiller:
     alive = True
 
-    def __init__(self):
+    def __init__(self) -> None:
         signal.signal(signal.SIGINT, self._kill)
         signal.signal(signal.SIGTERM, self._kill)
 
-    def _kill(self, *args):
+    def _kill(self, *_args: Any) -> None:
         self.alive = False
 
 
 class Command(BaseCommand):
     help = "Dequeue QFieldCloud Jobs from the DB"
 
-    def add_arguments(self, parser):
+    def add_arguments(self, parser: CommandParser) -> None:
         parser.add_argument(
             "--single-shot", action="store_true", help="Don't run infinite loop."
         )
 
-    def handle(self, *args, **options):
+    def handle(
+        self,
+        *args: Any,
+        single_shot: bool | None = None,
+        **kwargs: Any,
+    ) -> None:
         logging.info("Dequeue QFieldCloud Jobs from the DB")
         killer = GracefulKiller()
 
@@ -71,14 +78,14 @@ def handle(self, *args, **options):
                     ]
                 ).values("project_id")
 
-                # select all the pending jobs, that their project has no other active job or `is_locked` flag is `True`
+                # select all the pending jobs, that their project has no other active job or `locked_at` is not null
                 jobs_qs = (
                     Job.objects.select_for_update(skip_locked=True)
                     .filter(status=Job.Status.PENDING)
                     .exclude(
                         Q(project_id__in=busy_projects_ids_qs)
                         # skip all projects that are currently locked, most probably because of file transfer
-                        | Q(project__is_locked=True),
+                        | Q(project__locked_at__isnull=False),
                     )
                     .order_by("created_at")
                 )
@@ -96,19 +103,19 @@ def handle(self, *args, **options):
                 self._run(queued_job)
                 queued_job = None
             else:
-                if options["single_shot"]:
+                if single_shot:
                     break
 
                 for _i in range(SECONDS):
                     if killer.alive:
                         cancel_orphaned_workers()
                         sleep(1)
 
-            if options["single_shot"]:
+            if single_shot:
                 break
 
-    def _run(self, job: Job):
-        job_run_classes = {
+    def _run(self, job: Job) -> None:
+        job_run_classes: dict[Job.Type, type[JobRun]] = {
             Job.Type.PACKAGE: PackageJobRun,
             Job.Type.DELTA_APPLY: DeltaApplyJobRun,
             Job.Type.PROCESS_PROJECTFILE: ProcessProjectfileJobRun,

docker-app/qfieldcloud/core/migrations/0089_remove_project_is_locked_project_locked_at.py

@@ -0,0 +1,27 @@
+# Generated by Django 4.2.24 on 2025-09-17 13:34
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0088_alter_project_file_storage"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="project",
+            name="is_locked",
+        ),
+        migrations.AddField(
+            model_name="project",
+            name="locked_at",
+            field=models.DateTimeField(
+                blank=True,
+                editable=False,
+                help_text="If not null, it means that the project is being migrated, and the datetime represents when the project was temporarily locked. Locking is internal QFieldCloud mechanism related to file storage migration or other file operations.",
+                null=True,
+                verbose_name="Locked at",
+            ),
+        ),
+    ]

docker-app/qfieldcloud/core/models.py

@@ -8,6 +8,7 @@
 from enum import Enum
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, cast
+from uuid import uuid4
 
 import django_cryptography.fields
 from deprecated import deprecated
@@ -1061,7 +1062,17 @@ def get_project_file_storage_default() -> str:
 
 
 def get_project_thumbnail_upload_to(instance: "Project", _filename: str) -> str:
-    return f"projects/{instance.id}/meta/thumbnail.png"
+    """Variable storage key for thumbnails.
+
+    We use a variable storage key to avoid creating object storage level versions for
+    thumbnails that we then would need to manage (purge old versions, make sure we don't
+    exceed version limit).
+    """
+    ts = datetime.now().strftime("v%Y%m%d%H%M%S")
+    # Random suffix because the second precision of the timestamp alone might
+    # not be enough to avoid collisions
+    suffix = str(uuid4())[:8]
+    return f"projects/{instance.id}/meta/thumbnail_{ts}_{suffix}.png"
 
 
 class Project(models.Model):
@@ -1269,12 +1280,14 @@ class Meta:
         editable=False,
     )
 
-    is_locked = models.BooleanField(
-        _("Is locked"),
+    locked_at = models.DateTimeField(
+        _("Locked at"),
         help_text=_(
-            "If set to true, the project is temporarily locked. Locking is internal QFieldCloud mechanism related to file storage migration or other file operations."
+            "If not null, it means that the project is being migrated, and the datetime represents when the project was temporarily locked. Locking is internal QFieldCloud mechanism related to file storage migration or other file operations."
         ),
-        default=False,
+        blank=True,
+        null=True,
+        editable=False,
     )
 
     is_featured = models.BooleanField(
@@ -1842,7 +1855,7 @@ def delete(self, *args, **kwargs):
         Todo:
             * Delete with QF-4963 Drop support for legacy storage
         """
-        if self.legacy_thumbnail_uri:
+        if self.uses_legacy_storage:
             storage.delete_project_thumbnail(self)
 
         return super().delete(*args, **kwargs)

docker-app/qfieldcloud/core/templates/admin/project_files_widget.html

@@ -17,7 +17,7 @@
                 <tr>
                     <th>{% trans 'Filename' %}</th>
                     <th>{% trans 'Last modified' %}</th>
-                    <th class="qfc-admin-project-files-text-right">{% trans 'Last size' %}</th>
+                    <th class="qfc-admin-project-files-text-right">{% trans 'Size' %}</th>
                     <th>{% trans 'Details' %}</th>
                     <th>{% trans 'File version' %}</th>
                     <th>{% trans 'Actions' %}</th>
@@ -191,7 +191,7 @@
 
                         $trow.querySelector('td:nth-child(1)').innerHTML = file.name;
                         $trow.querySelector('td:nth-child(2)').innerHTML = file.last_modified;
-                        $trow.querySelector('td:nth-child(3)').innerHTML = `<span title="${file.size} bytes">${filesize10(file.size)} KB</span>`;
+                        $trow.querySelector('td:nth-child(3)').innerHTML = `<span title="${file.size} bytes">${filesize10(file.size)}</span>`;
 
                         for (const version of file.versions) {
                             const $option = document.createElement('option');

docker-app/qfieldcloud/filestorage/management/commands/migratefilestorage.py

@@ -1,7 +1,6 @@
 import logging
 import traceback
 import uuid
-from collections.abc import Collection
 from datetime import datetime
 
 from django.core.management.base import BaseCommand
@@ -55,8 +54,6 @@ def add_arguments(self, parser):
         )
 
     def handle(self, *args, **options) -> None:
-        projects: Collection = []
-
         force: bool = options.get("force", False)
         accept: bool = options.get("accept", False)
         no_raise: bool = options.get("no_raise", False)
@@ -169,7 +166,7 @@ def handle(self, *args, **options) -> None:
 
             exit(1)
 
-        logger.info(f"The storage migration will affect {len(projects)} project(s):")
+        logger.info(f"The storage migration will affect {projects_count} project(s):")
 
         for project in project_qs:
             logger.info(f"{project.id};{project.owner.username};{project.name}")