Fixed flakey test for unread notifications

features/notifications.feature

@@ -7,22 +7,18 @@ Feature: Notifications
     When an authenticated request is made to "/.ghost/activitypub/v1/notifications?limit=200"
     Then the request is rejected with a 400
 
-  Scenario: Requests for unread notifications count
+  Scenario: New notifications are marked as unread
     Given we are following "Alice"
     And we are not following "Bob"
     When we get a like notification from "Alice"
-    And we get a like notification from "Bob"
-    And we get a reply notification from "Alice"
     And we get a reply notification from "Bob"
-    Then the unread notifications count is 4
+    Then we have unread notifications
 
-  Scenario: Reset unread notifications count
+  Scenario: Visiting the notifications page marks notifications as read
     Given we are following "Alice"
     And we are not following "Bob"
     And we get a like notification from "Alice"
-    And we get a like notification from "Bob"
-    And we get a reply notification from "Alice"
     And we get a reply notification from "Bob"
-    And the unread notifications count is 4
-    When we reset unread notifications count
-    Then the unread notifications count is 0
+    And we have unread notifications
+    When we visit the notifications page
+    Then all notifications are marked as read

features/step_definitions/notifications_steps.js

@@ -7,14 +7,10 @@ import { createActivity, createObject } from '../support/fixtures.js';
 import {
     waitForItemInNotifications,
     waitForUnreadNotifications,
+    waitForZeroUnreadNotifications,
 } from '../support/notifications.js';
 import { fetchActivityPub } from '../support/request.js';
 
-Then('the unread notifications count is {int}', async (count) => {
-    const found = await waitForUnreadNotifications(count);
-    assert(found);
-});
-
 When('we get a like notification from {string}', async function (actorName) {
     if (!this.articleId) {
         const article = await publishArticle();
@@ -76,11 +72,21 @@ When('we get a reply notification from {string}', async function (actorName) {
     await waitForItemInNotifications(object.id);
 });
 
-When('we reset unread notifications count', async () => {
+When('we visit the notifications page', async () => {
     await fetchActivityPub(
         'https://self.test/.ghost/activitypub/v1/notifications/unread/reset',
         {
             method: 'PUT',
         },
     );
 });
+
+Then('we have unread notifications', async () => {
+    const unreadNotifications = await waitForUnreadNotifications();
+    assert(unreadNotifications);
+});
+
+Then('all notifications are marked as read', async () => {
+    const zeroUnreadNotifications = await waitForZeroUnreadNotifications();
+    assert(zeroUnreadNotifications);
+});

features/support/notifications.js

@@ -54,7 +54,6 @@ export async function waitForItemInNotifications(
 }
 
 export async function waitForUnreadNotifications(
-    unreadNotificationCount,
     options = {
         retryCount: 0,
         delay: 0,
@@ -68,23 +67,59 @@ export async function waitForUnreadNotifications(
 
     const responseJson = await response.clone().json();
 
-    const found = responseJson.count === unreadNotificationCount;
+    const unreadNotifications = responseJson.count > 0;
 
-    if (found) {
-        return found;
+    if (unreadNotifications) {
+        return true;
+    }
+
+    if (options.retryCount === MAX_RETRIES) {
+        throw new Error(
+            `Max retries reached (${MAX_RETRIES}) when waiting for unread notifications. No unread notifications found.`,
+        );
+    }
+
+    if (options.delay > 0) {
+        await new Promise((resolve) => setTimeout(resolve, options.delay));
+    }
+
+    return await waitForUnreadNotifications({
+        retryCount: options.retryCount + 1,
+        delay: options.delay + 500,
+    });
+}
+
+export async function waitForZeroUnreadNotifications(
+    options = {
+        retryCount: 0,
+        delay: 0,
+    },
+) {
+    const MAX_RETRIES = 5;
+
+    const response = await fetchActivityPub(
+        'https://self.test/.ghost/activitypub/v1/notifications/unread/count',
+    );
+
+    const responseJson = await response.clone().json();
+
+    const zeroUnreadNotifications = responseJson.count === 0;
+
+    if (zeroUnreadNotifications) {
+        return true;
     }
 
     if (options.retryCount === MAX_RETRIES) {
         throw new Error(
-            `Max retries reached (${MAX_RETRIES}) when waiting for notifications count ${unreadNotificationCount}. Notification count found ${responseJson.count}`,
+            `Max retries reached (${MAX_RETRIES}) when waiting for zero unread notifications. Unread notifications found: ${responseJson.count}.`,
         );
     }
 
     if (options.delay > 0) {
         await new Promise((resolve) => setTimeout(resolve, options.delay));
     }
 
-    return await waitForUnreadNotifications(unreadNotificationCount, {
+    return await waitForZeroUnreadNotifications({
         retryCount: options.retryCount + 1,
         delay: options.delay + 500,
     });