🐛(frontend) fix flaky e2e test

A test on e2e was flaky, this commit fixes it.
numerique-gouv · Oct 16, 2024 · eb0fdb1 · eb0fdb1
1 parent d31d7c8
commit eb0fdb1
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 19 deletions.
diff --git a/src/frontend/apps/e2e/__tests__/app-impress/doc-grid.spec.ts b/src/frontend/apps/e2e/__tests__/app-impress/doc-grid.spec.ts
@@ -52,6 +52,7 @@ test.describe('Documents Grid', () => {
       orderDefault: '',
       orderDesc: '&ordering=-title',
       orderAsc: '&ordering=title',
+      defaultColumn: false,
     },
     {
       nameColumn: 'Created at',
@@ -60,6 +61,7 @@ test.describe('Documents Grid', () => {
       orderDefault: '',
       orderDesc: '&ordering=-created_at',
       orderAsc: '&ordering=created_at',
+      defaultColumn: false,
     },
     {
       nameColumn: 'Updated at',
@@ -68,6 +70,7 @@ test.describe('Documents Grid', () => {
       orderDefault: '&ordering=-updated_at',
       orderDesc: '&ordering=updated_at',
       orderAsc: '',
+      defaultColumn: true,
     },
   ].forEach(
     ({
@@ -77,6 +80,7 @@ test.describe('Documents Grid', () => {
       orderDefault,
       orderDesc,
       orderAsc,
+      defaultColumn,
     }) => {
       test(`checks datagrid ordering ${ordering}`, async ({ page }) => {
         const responsePromise = page.waitForResponse(
@@ -98,20 +102,19 @@ test.describe('Documents Grid', () => {
         );
 
         // Checks the initial state
-        const datagrid = page
-          .getByLabel('Datagrid of the documents page 1')
-          .getByRole('table');
-        const thead = datagrid.locator('thead');
+        const datagrid = page.getByLabel('Datagrid of the documents page 1');
+        const datagridTable = datagrid.getByRole('table');
+        const thead = datagridTable.locator('thead');
 
         const response = await responsePromise;
         expect(response.ok()).toBeTruthy();
 
-        const docNameRow1 = datagrid
+        const docNameRow1 = datagridTable
           .getByRole('row')
           .nth(1)
           .getByRole('cell')
           .nth(cellNumber);
-        const docNameRow2 = datagrid
+        const docNameRow2 = datagridTable
           .getByRole('row')
           .nth(2)
           .getByRole('cell')
@@ -144,13 +147,21 @@ test.describe('Documents Grid', () => {
         await expect(docNameRow2).toHaveText(/.*/);
         const textDocNameRow1Asc = await docNameRow1.textContent();
         const textDocNameRow2Asc = await docNameRow2.textContent();
+
+        const compare = (comp1: string, comp2: string) => {
+          const comparisonResult = comp1.localeCompare(comp2, 'en', {
+            caseFirst: 'false',
+            ignorePunctuation: true,
+          });
+
+          // eslint-disable-next-line playwright/no-conditional-in-test
+          return defaultColumn ? comparisonResult >= 0 : comparisonResult <= 0;
+        };
+
         expect(
           textDocNameRow1Asc &&
             textDocNameRow2Asc &&
-            textDocNameRow1Asc.localeCompare(textDocNameRow2Asc, 'en', {
-              caseFirst: 'false',
-              ignorePunctuation: true,
-            }) <= 0,
+            compare(textDocNameRow1Asc, textDocNameRow2Asc),
         ).toBeTruthy();
 
         // Ordering Desc
@@ -171,10 +182,7 @@ test.describe('Documents Grid', () => {
         expect(
           textDocNameRow1Desc &&
             textDocNameRow2Desc &&
-            textDocNameRow1Desc.localeCompare(textDocNameRow2Desc, 'en', {
-              caseFirst: 'false',
-              ignorePunctuation: true,
-            }) >= 0,
+            compare(textDocNameRow2Desc, textDocNameRow1Desc),
         ).toBeTruthy();
       });
     },

diff --git a/src/frontend/apps/e2e/__tests__/app-impress/doc-visibility.spec.ts b/src/frontend/apps/e2e/__tests__/app-impress/doc-visibility.spec.ts
@@ -19,17 +19,16 @@ test.describe('Doc Visibility', () => {
     const header = page.locator('header').first();
     await header.locator('h2').getByText('Docs').click();
 
-    const datagrid = page
-      .getByLabel('Datagrid of the documents page 1')
-      .getByRole('table');
+    const datagrid = page.getByLabel('Datagrid of the documents page 1');
+    const datagridTable = datagrid.getByRole('table');
 
     await expect(datagrid.getByLabel('Loading data')).toBeHidden({
       timeout: 10000,
     });
 
-    await expect(datagrid.getByText(docTitle)).toBeVisible();
+    await expect(datagridTable.getByText(docTitle)).toBeVisible();
 
-    const row = datagrid.getByRole('row').filter({
+    const row = datagridTable.getByRole('row').filter({
       hasText: docTitle,
     });