fix: update tests to use shared checks. Update checks

Author: makelicious

e2e/testcases/v2-birth/8-validate-declaration-review-page.spec.ts

@@ -10,7 +10,7 @@ import {
 } from '../../helpers'
 import { faker } from '@faker-js/faker'
 import { CREDENTIALS } from '../../constants'
-import { fillDate } from './helpers'
+import { assertRecordInWorkqueue, fillDate } from './helpers'
 import { ensureOutboxIsEmpty, selectAction } from '../../v2-utils'
 
 test.describe.serial('8. Validate declaration review page', () => {
@@ -1439,14 +1439,11 @@ test.describe.serial('8. Validate declaration review page', () => {
       await ensureOutboxIsEmpty(page)
       await page.getByText('Ready to print').click()
 
-      /*
-       * @TODO: When workflows are implemented on V2, this should navigate to correct workflow first.
-       */
-      await expect(
-        page.getByRole('button', {
-          name: `${declaration.child.name.firstNames} ${newFamilyNameForChild}`
-        })
-      ).toBeVisible()
+      await assertRecordInWorkqueue({
+        page,
+        name: `${declaration.child.name.firstNames} ${newFamilyNameForChild}`,
+        workqueues: [{ title: 'Ready to print', exists: true }]
+      })
     })
   })
 })

e2e/testcases/v2-birth/helpers.ts

@@ -4,7 +4,10 @@ import { formatName, joinValuesWith } from '../../helpers'
 import { faker } from '@faker-js/faker'
 import { ensureOutboxIsEmpty } from '../../v2-utils'
 import { getRowByTitle } from '../v2-print-certificate/birth/helpers'
-import { SAFE_OUTBOX_TIMEOUT_MS } from '../../constants'
+import {
+  SAFE_OUTBOX_TIMEOUT_MS,
+  SAFE_WORKQUEUE_TIMEOUT_MS
+} from '../../constants'
 
 export const REQUIRED_VALIDATION_ERROR = 'Required'
 export const NAME_VALIDATION_ERROR =
@@ -85,24 +88,32 @@ export const assertRecordInWorkqueue = async ({
   name: string
   workqueues: { title: string; exists: boolean }[]
 }) => {
-  await page.getByRole('button', { name: 'Outbox' }).click()
   await ensureOutboxIsEmpty(page)
 
   for (const { title, exists } of workqueues) {
+    // NOTE: These tests are quite flaky. See if waiting unnecessarily long between page changes
+    await page.waitForTimeout(SAFE_WORKQUEUE_TIMEOUT_MS)
     await page
       .getByRole('button', {
         name: title
       })
       .click()
 
-    await expect(page.getByTestId('search-result')).toContainText(title, {
+    const workqueue = page.getByTestId('search-result')
+
+    await expect(workqueue).toContainText(title, {
       timeout: SAFE_OUTBOX_TIMEOUT_MS
     })
 
+    const recordButton = workqueue.getByRole('button', { name })
+
     if (exists) {
-      await expect(page.getByRole('button', { name })).toBeVisible()
+      await recordButton.waitFor({ state: 'visible' })
+      await expect(recordButton).toBeVisible()
     } else {
-      await expect(page.getByRole('button', { name })).toBeHidden()
+      await expect(recordButton).toHaveCount(0, {
+        timeout: SAFE_OUTBOX_TIMEOUT_MS
+      })
     }
   }
 }

e2e/testcases/v2-correction-birth/birth-correction-flow.spec.ts

@@ -14,6 +14,7 @@ import {
   type
 } from '../../v2-utils'
 import {
+  assertRecordInWorkqueue,
   formatV2ChildName,
   REQUIRED_VALIDATION_ERROR
 } from '../v2-birth/helpers'
@@ -245,14 +246,17 @@ test.describe.serial('Birth correction flow', () => {
   })
 
   test("Event appears in 'Sent for approval' workqueue", async () => {
+    await ensureOutboxIsEmpty(page)
     await page.getByTestId('navigation_workqueue_sent-for-approval').click()
 
-    await expect(
-      page.getByRole('button', { name: formatV2ChildName(declaration) })
-    ).toBeVisible()
+    await assertRecordInWorkqueue({
+      page,
+      name: formatV2ChildName(declaration),
+      workqueues: [{ title: 'Sent for approval', exists: true }]
+    })
   })
 
-  test.describe('Approve correction request', () => {
+  test.describe.serial('Approve correction request', () => {
     test('Login as Local Registrar', async () => {
       await logout(page)
       await loginToV2(page, CREDENTIALS.LOCAL_REGISTRAR)
@@ -261,9 +265,11 @@ test.describe.serial('Birth correction flow', () => {
     test("Find the event in the 'Ready for review' workflow", async () => {
       await page.getByRole('button', { name: 'Ready for review' }).click()
 
-      await page
-        .getByRole('button', { name: formatV2ChildName(declaration) })
-        .click()
+      await assertRecordInWorkqueue({
+        page,
+        name: formatV2ChildName(declaration),
+        workqueues: [{ title: 'review', exists: true }]
+      })
     })
 
     test('Correction request action appears in audit history', async () => {

e2e/testcases/v2-correction-birth/correct-birth-record-1.spec.ts

@@ -15,14 +15,8 @@ import {
   createDeclaration,
   Declaration
 } from '../v2-test-data/birth-declaration-with-mother-father'
-import {
-  ensureAssigned,
-  ensureOutboxIsEmpty,
-  expectInUrl,
-  selectAction,
-  type
-} from '../../v2-utils'
-import { formatV2ChildName } from '../v2-birth/helpers'
+import { ensureAssigned, expectInUrl, selectAction, type } from '../../v2-utils'
+import { assertRecordInWorkqueue, formatV2ChildName } from '../v2-birth/helpers'
 
 test.describe('1. Correct record - 1', () => {
   let declaration: Declaration
@@ -659,11 +653,11 @@ test.describe('1. Correct record - 1', () => {
          * - be navigated to Sent for approval workqueue
          * - include the declaration in this tab
          */
-        await page.getByTestId('navigation_workqueue_sent-for-approval').click()
-        await ensureOutboxIsEmpty(page)
-        await expect(
-          page.getByRole('button', { name: formatV2ChildName(declaration) })
-        ).toBeVisible()
+        await assertRecordInWorkqueue({
+          page,
+          name: formatV2ChildName(declaration),
+          workqueues: [{ title: 'Sent for approval', exists: true }]
+        })
       })
     })
 

e2e/testcases/v2-correction-birth/correct-birth-record-3.spec.ts

@@ -1076,6 +1076,8 @@ test.describe.serial(' Correct record - 3', () => {
     })
 
     test('3.8.4 Validate history in record audit', async () => {
+      await ensureOutboxIsEmpty(page)
+      // @TODO: why the reload
       await page.reload()
       await ensureAssigned(page)
       await page.getByRole('button', { name: 'Next page' }).click()

e2e/testcases/v2-correction-birth/correct-birth-record-4.spec.ts

@@ -312,8 +312,6 @@ test.describe.serial(' Correct record - 4', () => {
         expect(page.url().includes('correction')).toBeTruthy()
         expect(page.url().includes('review')).toBeTruthy()
 
-        console.log(declaration)
-        console.log(updatedFatherDetails.birthDate)
         await expect(
           await page.getByTestId('row-value-father.dob').getByRole('deletion')
         ).toHaveText(formatDateTo_dMMMMyyyy(declaration['father.dob']!))

e2e/v2-utils.ts

@@ -104,18 +104,17 @@ export async function ensureAssigned(page: Page) {
 }
 
 export async function expectInUrl(page: Page, assertionString: string) {
-  await expect(page.url().includes(assertionString)).toBeTruthy()
+  await page.waitForURL((url) => url.pathname.includes(assertionString))
 }
 
 export async function ensureOutboxIsEmpty(page: Page) {
   await page.waitForTimeout(SAFE_INPUT_CHANGE_TIMEOUT_MS)
 
-  await expect(page.locator('#navigation_workqueue_outbox')).toHaveText(
-    'Outbox',
-    {
-      timeout: SAFE_OUTBOX_TIMEOUT_MS
-    }
-  )
+  const outbox = page.locator('#navigation_workqueue_outbox')
+
+  await expect(outbox).toHaveText('Outbox', {
+    timeout: SAFE_OUTBOX_TIMEOUT_MS
+  })
 }
 
 export async function type(page: Page, locator: string, text: string) {