Merge pull request #1335 from opengisch/QF-6692-fix-empty-project-package

edit(packaging): avoid "empty project package"

Author: suricactus

docker-app/qfieldcloud/core/models.py

@@ -1305,39 +1305,65 @@ def shared_datasets_project(self) -> Project | None:
         except Project.DoesNotExist:
             return None
 
-    def latest_package_job_for_user(self, user: User) -> PackageJob | None:
-        """Returns the last package job for the user.
+    def package_jobs_for_user(self, user: User) -> PackageJobQuerySet:
+        """Returns all package jobs for the user.
 
         Args:
             user: The user to check for.
 
         Returns:
-            The last package job for the user.
+            QuerySet of all package jobs for the user.
         """
+        secret_filters = Q(project=self, organization=None, assigned_to=user)
+
         if self.owner.is_organization:
-            secret_qs = Secret.objects.filter(
-                Q(organization=self.owner, assigned_to=user)
-                | Q(project=self, assigned_to=user)
-            )
-        else:
-            secret_qs = Secret.objects.filter(project=self, assigned_to=user)
+            secret_filters |= Q(project=None, organization=self.owner, assigned_to=user)
 
-        jobs_qs = (
-            self.jobs.annotate(has_user_secret=Exists(secret_qs))
-            .filter(Q(has_user_secret=False) | Q(triggered_by=user))
-            .order_by("-created_at")
+        secret_qs = Secret.objects.filter(secret_filters)
+
+        jobs_qs = self.jobs.filter(
+            type=Job.Type.PACKAGE,
+        )
+
+        jobs_qs = jobs_qs.annotate(has_user_secret=Exists(secret_qs)).filter(
+            Q(has_user_secret=False) | Q(triggered_by=user)
         )
 
-        jobs_qs = jobs_qs.order_by("-created_at")
+        return jobs_qs
 
+    def latest_finished_package_job_for_user(self, user: User) -> PackageJob | None:
+        """Returns the last finished package job for the user.
+
+        Args:
+            user: The user to check for.
+
+        Returns:
+            The last finished package job for the user.
+        """
         return (
-            jobs_qs.filter(
-                type=Job.Type.PACKAGE,
+            self.package_jobs_for_user(user)
+            .exclude(
+                status__in=[
+                    Job.Status.PENDING,
+                    Job.Status.QUEUED,
+                    Job.Status.STARTED,
+                ]
             )
             .order_by("-created_at")
             .first()
         )
 
+    def latest_package_job_for_user(self, user: User) -> PackageJob | None:
+        """Returns the last package job for the user.
+
+        Args:
+            user: The user to check for.
+
+        Returns:
+            The last package job for the user.
+        """
+        return self.package_jobs_for_user(user).order_by("-created_at").first()
+
     def latest_package_jobs(self) -> PackageJobQuerySet:
         """Returns all the last package jobs for the users of the project.
 

docker-app/qfieldcloud/core/views/package_views.py

@@ -88,10 +88,12 @@ class LegacyLatestPackageView(views.APIView):
     def get(self, request, project_id):
         """Get last project package status and file list."""
         project = Project.objects.get(id=project_id)
-        latest_package_job = project.latest_package_job_for_user(request.user)
+        latest_finished_package_job = project.latest_finished_package_job_for_user(
+            request.user
+        )
 
         # Check if the project was packaged at least once
-        if not latest_package_job:
+        if not latest_finished_package_job:
             raise exceptions.InvalidJobError(
                 "Packaging has never been triggered or successful for this project."
             )
@@ -107,7 +109,9 @@ def get(self, request, project_id):
         else:
             skip_metadata = bool(skip_metadata_param)
 
-        for f in get_project_package_files(project_id, str(latest_package_job.id)):
+        for f in get_project_package_files(
+            project_id, str(latest_finished_package_job.id)
+        ):
             file_data = {
                 "name": f.name,
                 "size": f.size,
@@ -146,18 +150,18 @@ def get(self, request, project_id):
         if not files:
             raise exceptions.InvalidJobError("Empty project package.")
 
-        assert latest_package_job.feedback
+        assert latest_finished_package_job.feedback
 
-        feedback_version = latest_package_job.feedback.get("feedback_version")
+        feedback_version = latest_finished_package_job.feedback.get("feedback_version")
 
         # version 2 and 3 have the same format
         if feedback_version in ["2.0", "3.0"]:
-            layers = latest_package_job.feedback["outputs"]["qgis_layers_data"][
-                "layers_by_id"
-            ]
+            layers = latest_finished_package_job.feedback["outputs"][
+                "qgis_layers_data"
+            ]["layers_by_id"]
         # support some ancient QFieldCloud job data
         elif feedback_version is None:
-            steps = latest_package_job.feedback.get("steps", [])
+            steps = latest_finished_package_job.feedback.get("steps", [])
             layers = (
                 steps[1]["outputs"]["layer_checks"]
                 if len(steps) > 2 and steps[1].get("stage", 1) == 2
@@ -171,10 +175,10 @@ def get(self, request, project_id):
             {
                 "files": files,
                 "layers": layers,
-                "status": latest_package_job.status,
-                "package_id": latest_package_job.pk,
-                "packaged_at": latest_package_job.project.data_last_packaged_at,
-                "data_last_updated_at": latest_package_job.project.data_last_updated_at,
+                "status": latest_finished_package_job.status,
+                "package_id": latest_finished_package_job.pk,
+                "packaged_at": latest_finished_package_job.project.data_last_packaged_at,
+                "data_last_updated_at": latest_finished_package_job.project.data_last_updated_at,
             }
         )
 
@@ -197,15 +201,17 @@ def get(self, request, project_id, filename):
             exceptions.InvalidJobError: [description]
         """
         project = Project.objects.get(id=project_id)
-        latest_package_job = project.latest_package_job_for_user(request.user)
+        latest_finished_package_job = project.latest_finished_package_job_for_user(
+            request.user
+        )
 
         # Check if the project was packaged at least once
-        if not latest_package_job:
+        if not latest_finished_package_job:
             raise exceptions.InvalidJobError(
                 "Packaging has never been triggered or successful for this project."
             )
 
-        key = f"projects/{project_id}/packages/{latest_package_job.id}/{filename}"
+        key = f"projects/{project_id}/packages/{latest_finished_package_job.id}/{filename}"
 
         # files within attachment dirs that do not exist is the packaged files should be served
         # directly from the original data storage
@@ -269,17 +275,19 @@ class LatestPackageView(views.APIView):
     def get(self, request, project_id):
         """Get last project package status and file list."""
         project = get_object_or_404(Project, id=project_id)
-        latest_package_job = project.latest_package_job_for_user(request.user)
+        latest_finished_package_job = project.latest_finished_package_job_for_user(
+            request.user
+        )
 
         # Check if the project was packaged at least once
-        if not latest_package_job:
+        if not latest_finished_package_job:
             raise exceptions.InvalidJobError(
                 "Packaging has never been triggered or successful for this project."
             )
 
         files_qs = File.objects.filter(
             project_id=project_id,
-            package_job=latest_package_job,
+            package_job=latest_finished_package_job,
             file_type=File.FileType.PACKAGE_FILE,
         )
 
@@ -298,17 +306,17 @@ def get(self, request, project_id):
         if not file_serializer.data:
             raise exceptions.InvalidJobError("Empty project package.")
 
-        assert latest_package_job.feedback
+        assert latest_finished_package_job.feedback
 
-        feedback_version = latest_package_job.feedback.get("feedback_version")
+        feedback_version = latest_finished_package_job.feedback.get("feedback_version")
         # version 2 and 3 have the same format
         if feedback_version in ["2.0", "3.0"]:
-            layers = latest_package_job.feedback["outputs"]["qgis_layers_data"][
-                "layers_by_id"
-            ]
+            layers = latest_finished_package_job.feedback["outputs"][
+                "qgis_layers_data"
+            ]["layers_by_id"]
         # support some ancient QFieldCloud job data
         elif feedback_version is None:
-            steps = latest_package_job.feedback.get("steps", [])
+            steps = latest_finished_package_job.feedback.get("steps", [])
             layers = (
                 steps[1]["outputs"]["layer_checks"]
                 if len(steps) > 2 and steps[1].get("stage", 1) == 2
@@ -322,10 +330,10 @@ def get(self, request, project_id):
             {
                 "files": file_serializer.data,
                 "layers": layers,
-                "status": latest_package_job.status,
-                "package_id": latest_package_job.pk,
-                "packaged_at": latest_package_job.project.data_last_packaged_at,
-                "data_last_updated_at": latest_package_job.project.data_last_updated_at,
+                "status": latest_finished_package_job.status,
+                "package_id": latest_finished_package_job.pk,
+                "packaged_at": latest_finished_package_job.project.data_last_packaged_at,
+                "data_last_updated_at": latest_finished_package_job.project.data_last_updated_at,
             }
         )
 
@@ -348,10 +356,12 @@ def get(self, request, project_id, filename):
             exceptions.InvalidJobError: raised when packaging has never been triggered or successful for this project
         """
         project = get_object_or_404(Project, id=project_id)
-        latest_package_job = project.latest_package_job_for_user(request.user)
+        latest_finished_package_job = project.latest_finished_package_job_for_user(
+            request.user
+        )
 
         # Check if the project was packaged at least once
-        if not latest_package_job:
+        if not latest_finished_package_job:
             raise exceptions.InvalidJobError(
                 "Packaging has never been triggered or successful for this project."
             )
@@ -369,7 +379,7 @@ def get(self, request, project_id, filename):
             project_id,
             filename,
             file_type=file_type,
-            package_job_id=latest_package_job.id,
+            package_job_id=latest_finished_package_job.id,
         )