Add post request to explicitely prepare download archive

harminius · harminius · commit fb9cbaa9b965 · 2025-08-18T17:29:38.000+02:00
diff --git a/server/mergin/sync/private_api.yaml b/server/mergin/sync/private_api.yaml
@@ -384,20 +384,20 @@ paths:
           $ref: "#/components/responses/NotFoundResp"
       x-openapi-router-controller: mergin.sync.private_api_controller
   /projects/{id}/download:
+    parameters:
+      - $ref: "#/components/parameters/ProjectId"
+      - name: version
+        in: query
+        description: Particular version to download
+        required: false
+        schema:
+          $ref: "#/components/schemas/VersionName"
     get:
       tags:
         - project
       summary: Download full project
       description: Download whole project folder as zip file
       operationId: download_project
-      parameters:
-        - $ref: "#/components/parameters/ProjectId"
-        - name: version
-          in: query
-          description: Particular version to download
-          required: false
-          schema:
-            $ref: "#/components/schemas/VersionName"
       responses:
         "200":
           description: Zip file
@@ -417,6 +417,26 @@ paths:
         "404":
           $ref: "#/components/responses/NotFoundResp"
       x-openapi-router-controller: mergin.sync.private_api_controller
+    post:
+      tags:
+        - project
+      summary: Prepare project archive
+      description: Prepare project zip archive to download
+      operationId: prepare_archive
+      responses:
+        "200":
+          description: Archive is already prepared
+        "202":
+          description: Accepted
+        "400":
+          $ref: "#/components/responses/BadStatusResp"
+        "422":
+          $ref: "#/components/responses/UnprocessableEntity"
+        "403":
+          $ref: "#/components/responses/Forbidden"
+        "404":
+          $ref: "#/components/responses/NotFoundResp"
+      x-openapi-router-controller: mergin.sync.private_api_controller
 components:
   responses:
     UnauthorizedError:
diff --git a/server/mergin/sync/private_api_controller.py b/server/mergin/sync/private_api_controller.py
@@ -322,7 +322,7 @@ def get_project_access(id: str):
 
 def download_project(id: str, version=None):  # noqa: E501 # pylint: disable=W0622
     """Download whole project folder as zip file in any version
-    Return zip file if it exists, otherwise trigger background job to create it"""
+    Return zip file if it exists, otherwise return 202"""
     project = require_project_by_uuid(id, ProjectPermissions.Read)
     lookup_version = (
         ProjectVersion.from_v_name(version) if version else project.latest_version
@@ -352,17 +352,35 @@ def download_project(id: str, version=None):  # noqa: E501 # pylint: disable=W06
             f"attachment; filename*=UTF-8''{file_name}"
         )
         return resp
-    # GET request triggers background job if no partial zip or expired one
-    if request.method == "GET":
-        temp_zip_path = project_version.zip_path + ".partial"
-        # create zip if it does not exist yet or has expired
-        partial_exists = os.path.exists(temp_zip_path)
-        is_expired = partial_exists and datetime.fromtimestamp(
-            os.path.getmtime(temp_zip_path), tz=timezone.utc
-        ) < datetime.now(timezone.utc) - timedelta(
-            seconds=current_app.config["PARTIAL_ZIP_EXPIRATION"]
-        )
-        if not partial_exists or is_expired:
-            create_project_version_zip.delay(project_version.id)
 
-    return "Project zip being prepared, please try again later", 202
+    return "Project zip being prepared", 202
+
+
+def prepare_archive(id: str, version=None):
+    """Triggers background job to create project archive"""
+    project = require_project_by_uuid(id, ProjectPermissions.Read)
+    lookup_version = (
+        ProjectVersion.from_v_name(version) if version else project.latest_version
+    )
+    pv = ProjectVersion.query.filter_by(
+        project_id=project.id, name=lookup_version
+    ).first_or_404()
+
+    if pv.project_size > current_app.config["MAX_DOWNLOAD_ARCHIVE_SIZE"]:
+        abort(400)
+
+    if os.path.exists(pv.zip_path):
+        return "Project archive already ready", 200
+
+    # trigger job if no recent partial
+    temp_zip_path = pv.zip_path + ".partial"
+    partial_exists = os.path.exists(temp_zip_path)
+    is_expired = partial_exists and datetime.fromtimestamp(
+        os.path.getmtime(temp_zip_path), tz=timezone.utc
+    ) < datetime.now(timezone.utc) - timedelta(
+        seconds=current_app.config["PARTIAL_ZIP_EXPIRATION"]
+    )
+    if not partial_exists or is_expired:
+        create_project_version_zip.delay(pv.id)
+
+    return "Project zip being prepared", 202
diff --git a/server/mergin/sync/tasks.py b/server/mergin/sync/tasks.py
@@ -123,7 +123,7 @@ def create_project_version_zip(version_id: int):
             # partial zip is recent -> another job is likely running
             return
         else:
-            # partial zip is too old -> remove and creating new one
+            # partial zip is too old -> remove and create new one
             os.remove(zip_path)
 
     os.makedirs(os.path.dirname(zip_path), exist_ok=True)
diff --git a/web-app/packages/lib/src/modules/project/projectApi.ts b/web-app/packages/lib/src/modules/project/projectApi.ts
@@ -311,6 +311,10 @@ export const ProjectApi = {
     return ProjectModule.httpService.get(url, { responseType: 'blob' })
   },
 
+  async prepareArchive(url: string): Promise<AxiosResponse<void>> {
+    return ProjectModule.httpService.post(url)
+  },
+
   /** Request head of file download */
   async getHeadDownloadFile(url: string): Promise<AxiosResponse<void>> {
     return ProjectModule.httpService.head(url)
diff --git a/web-app/packages/lib/src/modules/project/store.ts b/web-app/packages/lib/src/modules/project/store.ts
@@ -707,6 +707,7 @@ export const useProjectStore = defineStore('projectModule', {
     },
 
     async downloadArchive(payload: DownloadPayload) {
+      console.log("You are here")
       const notificationStore = useNotificationStore()
       await this.cancelDownloadArchive()
       this.projectDownloadingVersion = payload.versionId
@@ -719,8 +720,12 @@ export const useProjectStore = defineStore('projectModule', {
 
       const delays = [...Array(3).fill(1000), ...Array(3).fill(3000), 5000]
       let retryCount = 0
-      const pollDownloadArchive = async () => {
-        try {
+      try {
+        // STEP 1: request archive creation
+        await ProjectApi.prepareArchive(payload.url)
+
+        // STEP 2: start polling HEAD for readiness
+        const pollDownloadArchive = async () => {
           if (retryCount > 125) {
             notificationStore.warn({
               text: exceedMessage,
@@ -729,38 +734,42 @@ export const useProjectStore = defineStore('projectModule', {
             await this.cancelDownloadArchive()
             return
           }
-
-          const head = await ProjectApi.getHeadDownloadFile(payload.url)
-          const polling = head.status == 202
-          if (polling) {
-            const delay = delays[Math.min(retryCount, delays.length - 1)] // Select delay based on retry count
-            retryCount++ // Increment retry count
-            downloadArchiveTimeout = setTimeout(async () => {
-              await pollDownloadArchive()
-            }, delay)
-            return
-          }
-
-          // Use browser download instead of playing around with the blob
-          FileSaver.saveAs(payload.url)
-          notificationStore.closeNotification()
-          this.cancelDownloadArchive()
-        } catch (e) {
-          if (axios.isAxiosError(e) && e.response?.status === 400) {
-            notificationStore.error({
-              group: 'download-large-error',
-              text: '',
-              life: 6000
-            })
-          } else {
-            notificationStore.error({
-              text: errorMessage
-            })
+          try {
+            const head = await ProjectApi.getHeadDownloadFile(payload.url)
+            const polling = head.status === 202
+            if (polling) {
+              const delay = delays[Math.min(retryCount, delays.length - 1)] // Select delay based on retry count
+              retryCount++ // Increment retry count
+              downloadArchiveTimeout = setTimeout(async () => {
+                await pollDownloadArchive()
+              }, delay)
+              return
+            }
+
+            // Use browser download instead of playing around with the blob
+            FileSaver.saveAs(payload.url)
+            notificationStore.closeNotification()
+            this.cancelDownloadArchive()
+          } catch (e) {
+            if (axios.isAxiosError(e) && e.response?.status === 400) {
+              notificationStore.error({
+                group: 'download-large-error',
+                text: '',
+                life: 6000
+              })
+            } else {
+              notificationStore.error({
+                text: errorMessage
+              })
+            }
+            this.cancelDownloadArchive()
           }
-          this.cancelDownloadArchive()
         }
+        pollDownloadArchive()
+      } catch (e) {
+        notificationStore.error({ text: errorMessage })
+        this.cancelDownloadArchive()
       }
-      pollDownloadArchive()
     },
 
     async cancelDownloadArchive() {
