From 102a2748d79d604d25cf91233054cefc1e1639bf Mon Sep 17 00:00:00 2001
From: Akshay Mankar <akshay@wire.com>
Date: Wed, 18 Dec 2024 09:51:21 +0100
Subject: [PATCH] integration/testConsumeTempEvents: Remove race causing flaky
 test (#4372)

The creation of temp queue races with client creation event. This is removed by
first expecting the event to be served to the real client and then listening to
events temporarily
---
 integration/test/Test/Events.hs | 45 +++++++++++++++++++++------------
 1 file changed, 29 insertions(+), 16 deletions(-)

diff --git a/integration/test/Test/Events.hs b/integration/test/Test/Events.hs
index 97aeb660fb6..6edfc70d0db 100644
--- a/integration/test/Test/Events.hs
+++ b/integration/test/Test/Events.hs
@@ -67,28 +67,41 @@ testConsumeTempEvents = do
   alice <- randomUser OwnDomain def
 
   client0 <- addClient alice def {acapabilities = Just ["consumable-notifications"]} >>= getJSON 201
-  runCodensity (createEventsWebSocket alice Nothing) $ \ws -> do
-    clientId <- objId client0
+  clientId0 <- objId client0
 
-    void $ assertEvent ws $ \e -> do
-      e %. "type" `shouldMatch` "event"
-      e %. "data.event.payload.0.type" `shouldMatch` "user.client-add"
-      e %. "data.event.payload.0.client.id" `shouldMatch` clientId
+  lowerCodensity $ do
+    ws0 <- createEventsWebSocket alice (Just clientId0)
 
-      ackEvent ws e
+    -- Ensure there is no race between event for this client being pushed and temp
+    -- consumer being created
+    lift $ do
+      expectAndAckNewClientEvent ws0 clientId0
+      assertNoEvent_ ws0
 
-  runCodensity (createEventsWebSocket alice Nothing) $ \ws -> do
-    client <- addClient alice def {acapabilities = Just ["consumable-notifications"]} >>= getJSON 201
-    clientId <- objId client
+    wsTemp <- createEventsWebSocket alice Nothing
 
-    void $ assertEvent ws $ \e -> do
-      e %. "type" `shouldMatch` "event"
-      e %. "data.event.payload.0.type" `shouldMatch` "user.client-add"
-      e %. "data.event.payload.0.client.id" `shouldMatch` clientId
+    lift $ do
+      client1 <- addClient alice def {acapabilities = Just ["consumable-notifications"]} >>= getJSON 201
+      clientId1 <- objId client1
 
-      ackEvent ws e
+      -- Temp client gets this event as it happens after temp client has started
+      -- listening
+      void $ expectAndAckNewClientEvent wsTemp clientId1
 
-    assertNoEvent_ ws
+      -- Client0 should also be notified even if there is a temp client
+      void $ expectAndAckNewClientEvent ws0 clientId1
+
+      assertNoEvent_ wsTemp
+      assertNoEvent_ ws0
+  where
+    expectAndAckNewClientEvent :: EventWebSocket -> String -> App ()
+    expectAndAckNewClientEvent ws cid =
+      assertEvent ws $ \e -> do
+        e %. "type" `shouldMatch` "event"
+        e %. "data.event.payload.0.type" `shouldMatch` "user.client-add"
+        e %. "data.event.payload.0.client.id" `shouldMatch` cid
+
+        ackEvent ws e
 
 testMLSTempEvents :: (HasCallStack) => App ()
 testMLSTempEvents = do