Merge pull request #4229 from nationalarchives/TDRD-367-reload-file-c…

…hecks-page TDRD-367: reload file checks page
nationalarchives · Oct 22, 2024 · 2bdc936 · 2bdc936
2 parents 55cc2dc + f894438
commit 2bdc936
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 11 deletions.
diff --git a/npm/src/checks/index.ts b/npm/src/checks/index.ts
@@ -33,14 +33,24 @@ export class Checks {
 
   updateFileCheckProgress: (
     isJudgmentUser: boolean,
-    goToNextPage: (formId: string) => void
+    goToNextPage: (formId: string) => void,
+    checksPageRefreshInterval: number
   ) => void | Error = (
     isJudgmentUser: boolean,
-    goToNextPage: (formId: string) => void
+    goToNextPage: (formId: string) => void,
+    checksPageRefreshInterval: number
   ) => {
     if (isJudgmentUser) {
       this.checkJudgmentTransferProgress(goToNextPage)
     } else {
+      const refreshPageIntervalId: ReturnType<typeof setInterval> = setInterval(
+        async () => {
+          clearInterval(intervalId)
+          window.location.reload()
+        },
+        checksPageRefreshInterval
+      )
+
       const intervalId: ReturnType<typeof setInterval> = setInterval(
         async () => {
           const fileChecksProgress: IFileCheckProgress | Error =
@@ -49,9 +59,11 @@ export class Checks {
             const checksCompleted = haveFileChecksCompleted(fileChecksProgress)
             if (checksCompleted) {
               clearInterval(intervalId)
+              clearInterval(refreshPageIntervalId)
               displayChecksCompletedBanner("file-checks")
             }
           } else {
+            clearInterval(refreshPageIntervalId)
             return fileChecksProgress
           }
         },

diff --git a/npm/src/index.ts b/npm/src/index.ts
@@ -98,9 +98,13 @@ export const renderModules = async () => {
         const nextPageModule = await import(
           "./nextpageredirect/next-page-redirect"
         )
+        //interval for page reload set at 90% of token validity period
+        const checksPageRefreshInterval =
+          (keycloak.tokenParsed?.exp * 1000 - Date.now()) * 0.9
         const resultOrError = new checksModule.Checks().updateFileCheckProgress(
           isJudgmentUser,
-          nextPageModule.goToNextPage
+          nextPageModule.goToNextPage,
+          checksPageRefreshInterval
         )
         if (errorHandlingModule.isError(resultOrError)) {
           errorHandlingModule.handleUploadError(resultOrError)

diff --git a/npm/test/update-check-progress.test.ts b/npm/test/update-check-progress.test.ts
@@ -20,6 +20,20 @@ import { Checks } from "../src/checks"
 import {hasDraftMetadataValidationCompleted, haveFileChecksCompleted} from "../src/checks/verify-checks-have-completed"
 import { displayChecksCompletedBanner } from "../src/checks/display-checks-completed-banner"
 
+//stop console errors from window.location.reload in these tests that arise as described here: https://remarkablemark.org/blog/2018/11/17/mock-window-location/
+const original = window.location;
+
+beforeAll(() => {
+  Object.defineProperty(window, 'location', {
+    configurable: true,
+    value: { reload: jest.fn() },
+  });
+});
+
+afterAll(() => {
+  Object.defineProperty(window, 'location', { configurable: true, value: original });
+});
+
 jest.mock('uuid', () => 'eb7b7961-395d-4b4c-afc6-9ebcadaf0150')
 
 jest.mock(
@@ -125,9 +139,9 @@ const mockDisplayChecksHaveCompletedBanner: () => void = () =>
 
 test("'updateFileCheckProgress' calls setInterval correctly", async () => {
   jest.spyOn(global, "setInterval")
-  await checks.updateFileCheckProgress(false, mockGoToNextPage)
+  await checks.updateFileCheckProgress(false, mockGoToNextPage, 300000)
   jest.runOnlyPendingTimers()
-  expect(setInterval).toBeCalledTimes(1)
+  expect(setInterval).toBeCalledTimes(2)
 })
 
 test("'updateDraftMetadataValidationProgress' calls setInterval correctly", async () => {
@@ -153,7 +167,7 @@ test("'updateFileCheckProgress' shows a standard user, the notification banner a
 
   mockDisplayChecksHaveCompletedBanner()
 
-  checks.updateFileCheckProgress(false, mockGoToNextPage)
+  checks.updateFileCheckProgress(false, mockGoToNextPage, 300000)
   await jest.runOnlyPendingTimers()
 
   expect(haveFileChecksCompleted).toBeCalled()
@@ -220,7 +234,7 @@ test("'updateFileCheckProgress' shows a standard user, no banner and a disabled
   )
   mockDisplayChecksHaveCompletedBanner()
 
-  checks.updateFileCheckProgress(false, mockGoToNextPage)
+  checks.updateFileCheckProgress(false, mockGoToNextPage, 300000)
   await jest.runOnlyPendingTimers()
 
   expect(haveFileChecksCompleted).toBeCalled()
@@ -262,7 +276,7 @@ test("'updateFileCheckProgress' shows a standard user, no banner and a disabled
   )
   mockDisplayChecksHaveCompletedBanner()
 
-  checks.updateFileCheckProgress(false, mockGoToNextPage)
+  checks.updateFileCheckProgress(false, mockGoToNextPage, 300000)
   await jest.runOnlyPendingTimers()
 
   expect(haveFileChecksCompleted).toBeCalled()
@@ -298,7 +312,7 @@ test("'updateFileCheckProgress' calls goToNextPage for a judgment user, if all c
 
   mockTransferProgress("complete")
 
-  checks.updateFileCheckProgress(true, mockGoToNextPage)
+  checks.updateFileCheckProgress(true, mockGoToNextPage, 300000)
   await jest.runOnlyPendingTimers()
 
   expect(mockGoToNextPage).toHaveBeenCalled()
@@ -311,7 +325,7 @@ test("'updateFileCheckProgress' does not call goToNextPage for a judgment user i
   )
   mockTransferProgress("inProgress")
 
-  checks.updateFileCheckProgress(true, mockGoToNextPage)
+  checks.updateFileCheckProgress(true, mockGoToNextPage, 300000)
   await jest.runOnlyPendingTimers()
 
   expect(mockGoToNextPage).toHaveBeenCalled()
@@ -324,7 +338,7 @@ test("'updateFileCheckProgress' does not call goToNextPage for a judgment user i
   )
   mockTransferProgress("noData")
 
-  checks.updateFileCheckProgress(true, mockGoToNextPage)
+  checks.updateFileCheckProgress(true, mockGoToNextPage, 300000)
   await jest.runOnlyPendingTimers()
 
   expect(mockGoToNextPage).not.toHaveBeenCalled()