fix(attachment): convoy separation (#7449)

CHANGELOG.md

@@ -4,13 +4,21 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v6.130.1](https://github.com/opengovsg/FormSG/compare/v6.130.0...v6.130.1)
+
+- fix(attachment): convoy separation [`#7449`](https://github.com/opengovsg/FormSG/pull/7449)
+- build: release v6.130.0 [`#7441`](https://github.com/opengovsg/FormSG/pull/7441)
+
 #### [v6.130.0](https://github.com/opengovsg/FormSG/compare/v6.129.0...v6.130.0)
 
+> 26 June 2024
+
 - feat: update to platform flag [`#7437`](https://github.com/opengovsg/FormSG/pull/7437)
 - feat(mrf): multiple static emails [`#7433`](https://github.com/opengovsg/FormSG/pull/7433)
 - build: merge release v6.129.0 to develop [`#7434`](https://github.com/opengovsg/FormSG/pull/7434)
 - chore(deps-dev): bump axios-mock-adapter from 1.21.4 to 1.22.0 [`#7435`](https://github.com/opengovsg/FormSG/pull/7435)
 - build: release v6.129.0 [`#7432`](https://github.com/opengovsg/FormSG/pull/7432)
+- chore: bump version to v6.130.0 [`295ed77`](https://github.com/opengovsg/FormSG/commit/295ed7717a904ef19b32531e0f2e7dfcc919fa87)
 
 #### [v6.129.0](https://github.com/opengovsg/FormSG/compare/v6.128.0...v6.129.0)
 

frontend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "form-frontend",
-  "version": "6.130.0",
+  "version": "6.130.1",
   "homepage": ".",
   "private": true,
   "dependencies": {

frontend/src/features/admin-form/responses/ResponsesPage/storage/useDecryptionWorkers.ts

@@ -2,6 +2,8 @@ import { useCallback, useEffect, useRef, useState } from 'react'
 import { useMutation, UseMutationOptions } from 'react-query'
 import { datadogLogs } from '@datadog/browser-logs'
 
+import { waitForMs } from '~utils/waitForMs'
+
 import { useAdminForm } from '~features/admin-form/common/queries'
 import {
   trackDownloadNetworkFailure,
@@ -27,6 +29,12 @@ import {
 
 const NUM_OF_METADATA_ROWS = 5
 
+// We will download attachments in convoys of 5
+// This is to prevent the script from downloading too many attachments at once
+// which could cause it to block downloads.
+const ATTACHMENT_DOWNLOAD_CONVOY_SIZE = 5
+const ATTACHMENT_DOWNLOAD_CONVOY_MINIMUM_SEPARATION_TIME = 1000
+
 const killWorkers = (workers: CleanableDecryptionWorkerApi[]): void => {
   return workers.forEach((worker) => worker.cleanup())
 }
@@ -141,6 +149,7 @@ const useDecryptionWorkers = ({
       const downloadStartTime = performance.now()
 
       let progress = 0
+      let timeSinceLastXAttachmentDownload = 0
 
       return new Promise<DownloadResult>((resolve, reject) => {
         reader
@@ -181,7 +190,24 @@ const useDecryptionWorkers = ({
                       errorCount++
                       console.error('Error in getResponseInstance', e)
                     }
+
                     if (downloadAttachments && decryptResult.downloadBlob) {
+                      // Ensure attachments downloads are spaced out to avoid browser blocking downloads
+                      if (progress % ATTACHMENT_DOWNLOAD_CONVOY_SIZE === 0) {
+                        const now = new Date().getTime()
+                        const elapsedSinceXDownloads =
+                          now - timeSinceLastXAttachmentDownload
+
+                        const waitTime = Math.max(
+                          0,
+                          ATTACHMENT_DOWNLOAD_CONVOY_MINIMUM_SEPARATION_TIME -
+                            elapsedSinceXDownloads,
+                        )
+                        if (waitTime > 0) {
+                          await waitForMs(waitTime)
+                        }
+                        timeSinceLastXAttachmentDownload = now
+                      }
                       await downloadResponseAttachment(
                         decryptResult.downloadBlob,
                         decryptResult.id,

frontend/src/utils/waitForMs.ts

@@ -0,0 +1,5 @@
+export const waitForMs = (ms: number): Promise<void> => {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms)
+  })
+}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "FormSG",
   "description": "Form Manager for Government",
-  "version": "6.130.0",
+  "version": "6.130.1",
   "homepage": "https://form.gov.sg",
   "authors": [
     "FormSG <[email protected]>"