Add TeamId to conversation.delete event (#4618)

The field name is `team`.

---------

Co-authored-by: Leif Battermann <[email protected]>

Author: supersven

changelog.d/1-api-changes/add-teamid-conversation.delete

@@ -0,0 +1,2 @@
+Add the `TeamId` to the payload of `conversation.delete` events. The field's
+path is `team`.

integration/test/Test/Cells.hs

@@ -77,6 +77,26 @@ testCellsCreationEvent = do
 
   assertNoMessage q
 
+testCellsDeletionEvent :: (HasCallStack) => App ()
+testCellsDeletionEvent = do
+  -- start watcher before creating conversation
+  q0 <- watchCellsEvents def
+  (alice, tid, _) <- createTeam OwnDomain 1
+  conv <- postConversation alice defProteus {team = Just tid, cells = True} >>= getJSON 201
+  void $ deleteTeamConversation tid conv alice >>= assertSuccess
+
+  let q = q0 {filter = isConvDeleteNotif} :: QueueConsumer
+
+  event <- getMessage q %. "payload.0"
+  event %. "type" `shouldMatch` "conversation.delete"
+  event %. "conversation" `shouldMatch` (conv %. "qualified_id.id")
+  event %. "qualified_conversation" `shouldMatch` (conv %. "qualified_id")
+  event %. "qualified_from" `shouldMatch` (alice %. "qualified_id")
+  event %. "from" `shouldMatch` (alice %. "qualified_id.id")
+  event %. "team" `shouldMatch` tid
+
+  assertNoMessage q
+
 testCellsCreationEventIsSentOnlyOnce :: (HasCallStack) => App ()
 testCellsCreationEventIsSentOnlyOnce = do
   -- start watcher before creating conversation

libs/wire-api/src/Wire/API/Conversation.hs

@@ -910,7 +910,7 @@ instance ToSchema NewOne2OneConv where
                  <|> pure []
              )
         <*> name .= maybe_ (optField "name" schema)
-        <*> team
+        <*> (.team)
           .= maybe_
             ( optFieldWithDocModifier
                 "team"

libs/wire-api/src/Wire/API/Conversation/Action.hs

@@ -192,9 +192,10 @@ conversationActionToEvent ::
   Qualified UserId ->
   Qualified ConvId ->
   Maybe SubConvId ->
+  Maybe TeamId ->
   ConversationAction tag ->
   Event
-conversationActionToEvent tag now quid qcnv subconv action =
+conversationActionToEvent tag now quid qcnv subconv tid action =
   let edata = case tag of
         SConversationJoinTag ->
           let ConversationJoin newMembers role joinType = action
@@ -215,7 +216,7 @@ conversationActionToEvent tag now quid qcnv subconv action =
         SConversationUpdateProtocolTag -> EdProtocolUpdate action
         SConversationUpdateAddPermissionTag -> EdAddPermissionUpdate action
         SConversationResetTag -> EdConvReset action.groupId
-   in Event qcnv subconv quid now edata
+   in Event qcnv subconv quid now tid edata
 
 -- | Certain actions need to be performed at the level of the underlying
 -- protocol (MLS, mostly) before being applied to conversations. This function

libs/wire-api/src/Wire/API/Event/Conversation.hs

@@ -111,6 +111,7 @@ data Event = Event
     evtSubConv :: Maybe SubConvId,
     evtFrom :: Qualified UserId,
     evtTime :: UTCTime,
+    evtTeam :: Maybe TeamId,
     evtData :: EventData
   }
   deriving stock (Eq, Show, Generic)
@@ -126,6 +127,7 @@ instance Arbitrary Event where
       <*> arbitrary
       <*> arbitrary
       <*> (milli <$> arbitrary)
+      <*> arbitrary
       <*> genEventData typ
     where
       milli = fromUTCTimeMillis . toUTCTimeMillis
@@ -472,8 +474,9 @@ eventObjectSchema =
     <* (qUnqualified . evtFrom) .= optional (field "from" schema)
     <*> evtFrom .= field "qualified_from" schema
     <*> (toUTCTimeMillis . evtTime) .= field "time" (fromUTCTimeMillis <$> schema)
+    <*> evtTeam .= maybe_ (optField "team" schema)
   where
-    mk (_, d) cid sconvid uid tm = Event cid sconvid uid tm d
+    mk (_, d) cid sconvid uid tm tid = Event cid sconvid uid tm tid d
 
 instance ToJSONObject Event where
   toJSONObject =

libs/wire-api/test/golden/Test/Wire/API/Golden/Generated/AddBotResponse_user.hs

@@ -56,6 +56,7 @@ testObject_AddBotResponse_user_1 =
           Nothing
           (Qualified (Id (fromJust (UUID.fromString "00000004-0000-0004-0000-000400000004"))) (Domain "faraway.example.com"))
           (read "1864-05-12 19:20:22.286 UTC")
+          Nothing
           (EdConvRename (ConversationRename {cupName = "6"}))
     }
 
@@ -77,5 +78,6 @@ testObject_AddBotResponse_user_2 =
           Nothing
           (Qualified (Id (fromJust (UUID.fromString "00000004-0000-0000-0000-000300000001"))) (Domain "faraway.example.com"))
           (read "1864-05-08 19:02:58.6 UTC")
+          Nothing
           (EdTyping StartedTyping)
     }

libs/wire-api/test/golden/Test/Wire/API/Golden/Generated/Event_conversation.hs

@@ -44,7 +44,8 @@ testObject_Event_conversation_1 =
       evtSubConv = Nothing,
       evtFrom = Qualified {qUnqualified = Id (fromJust (UUID.fromString "2126ea99-ca79-43ea-ad99-a59616468e8e")), qDomain = Domain {_domainText = "n8nl6tp.h5"}},
       evtTime = UTCTime {utctDay = ModifiedJulianDay 58119, utctDayTime = 0},
-      evtData = EdConvCodeDelete
+      evtData = EdConvCodeDelete,
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_2 :: Event
@@ -66,7 +67,8 @@ testObject_Event_conversation_2 =
                 misHiddenRef = Nothing,
                 misConvRoleName = Just roleNameWireAdmin
               }
-          )
+          ),
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_3 :: Event
@@ -86,7 +88,8 @@ testObject_Event_conversation_3 =
                   }
               )
               False
-          )
+          ),
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_4 :: Event
@@ -96,7 +99,8 @@ testObject_Event_conversation_4 =
       evtSubConv = Nothing,
       evtFrom = Qualified {qUnqualified = Id (fromJust (UUID.fromString "2126ea99-ca79-43ea-ad99-a59616468e8e")), qDomain = Domain {_domainText = "97k-u0.b-5c"}},
       evtTime = UTCTime {utctDay = ModifiedJulianDay 58119, utctDayTime = 0},
-      evtData = EdConvAccessUpdate (ConversationAccessData {cupAccess = fromList [PrivateAccess, CodeAccess], cupAccessRoles = fromList []})
+      evtData = EdConvAccessUpdate (ConversationAccessData {cupAccess = fromList [PrivateAccess, CodeAccess], cupAccessRoles = fromList []}),
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_5 :: Event
@@ -106,7 +110,8 @@ testObject_Event_conversation_5 =
       evtSubConv = Nothing,
       evtFrom = Qualified {qUnqualified = Id (fromJust (UUID.fromString "2126ea99-ca79-43ea-ad99-a59616468e8e")), qDomain = Domain {_domainText = "7.m4f7p.ez4zs61"}},
       evtTime = UTCTime {utctDay = ModifiedJulianDay 58119, utctDayTime = 0},
-      evtData = EdMLSWelcome ""
+      evtData = EdMLSWelcome "",
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_6 :: Event
@@ -116,7 +121,8 @@ testObject_Event_conversation_6 =
       evtSubConv = Nothing,
       evtFrom = Qualified {qUnqualified = Id (fromJust (UUID.fromString "2126ea99-ca79-43ea-ad99-a59616468e8e")), qDomain = Domain {_domainText = "8.0-6.t7pxv"}},
       evtTime = UTCTime {utctDay = ModifiedJulianDay 58119, utctDayTime = 0},
-      evtData = EdOtrMessage (OtrMessage {otrSender = ClientId 1, otrRecipient = ClientId 1, otrCiphertext = "", otrData = Just "I\68655"})
+      evtData = EdOtrMessage (OtrMessage {otrSender = ClientId 1, otrRecipient = ClientId 1, otrCiphertext = "", otrData = Just "I\68655"}),
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_7 :: Event
@@ -126,7 +132,8 @@ testObject_Event_conversation_7 =
       evtSubConv = Nothing,
       evtFrom = Qualified {qUnqualified = Id (fromJust (UUID.fromString "2126ea99-ca79-43ea-ad99-a59616468e8e")), qDomain = Domain {_domainText = "64b3--h.u"}},
       evtTime = UTCTime {utctDay = ModifiedJulianDay 58119, utctDayTime = 0},
-      evtData = EdOtrMessage (OtrMessage {otrSender = ClientId 3, otrRecipient = ClientId 3, otrCiphertext = "%\SI", otrData = Nothing})
+      evtData = EdOtrMessage (OtrMessage {otrSender = ClientId 3, otrRecipient = ClientId 3, otrCiphertext = "%\SI", otrData = Nothing}),
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_8 :: Event
@@ -136,7 +143,8 @@ testObject_Event_conversation_8 =
       evtSubConv = Nothing,
       evtFrom = Qualified {qUnqualified = Id (fromJust (UUID.fromString "2126ea99-ca79-43ea-ad99-a59616468e8e")), qDomain = Domain {_domainText = "0--gy.705nsa8.j4m"}},
       evtTime = UTCTime {utctDay = ModifiedJulianDay 58119, utctDayTime = 0},
-      evtData = EdTyping StartedTyping
+      evtData = EdTyping StartedTyping,
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_9 :: Event
@@ -171,7 +179,8 @@ testObject_Event_conversation_9 =
                     Qualified {qUnqualified = Id (fromJust (UUID.fromString "2126ea99-ca79-43ea-ad99-a59616468e8e")), qDomain = Domain {_domainText = "ns.v2p"}}
                   ]
               }
-          )
+          ),
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_10 :: Event
@@ -181,7 +190,8 @@ testObject_Event_conversation_10 =
       evtSubConv = Nothing,
       evtFrom = Qualified {qUnqualified = Id (fromJust (UUID.fromString "2126ea99-ca79-43ea-ad99-a59616468e8e")), qDomain = Domain {_domainText = "4-p.d7b8d3.6.c8--jds3-1acy"}},
       evtTime = UTCTime {utctDay = ModifiedJulianDay 58119, utctDayTime = 0},
-      evtData = EdMLSMessage "s\b\138w\236\231P(\ESC\216\205"
+      evtData = EdMLSMessage "s\b\138w\236\231P(\ESC\216\205",
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_11 :: Event
@@ -191,5 +201,6 @@ testObject_Event_conversation_11 =
       evtSubConv = Nothing,
       evtFrom = Qualified {qUnqualified = Id (fromJust (UUID.fromString "2126ea99-ca79-43ea-ad99-a59616468e8e")), qDomain = Domain {_domainText = "70-o.ncd"}},
       evtTime = UTCTime {utctDay = ModifiedJulianDay 58119, utctDayTime = 0},
-      evtData = EdTyping StoppedTyping
+      evtData = EdTyping StoppedTyping,
+      evtTeam = Nothing
     }

libs/wire-api/test/golden/Test/Wire/API/Golden/Generated/Event_user.hs

@@ -48,6 +48,7 @@ testObject_Event_user_1 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "00003b8b-0000-3395-0000-076a00007830"))) (Domain "faraway.example.com"))
     (read "1864-05-22 09:51:07.104 UTC")
+    (Just (Id (fromJust (UUID.fromString "90eda181-bb05-4525-a5cc-d0038deda9b7"))))
     EdConvDelete
 
 testObject_Event_user_2 :: Event
@@ -57,6 +58,7 @@ testObject_Event_user_2 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "00006a88-0000-2acb-0000-6aa0000061b2"))) (Domain "faraway.example.com"))
     (read "1864-06-05 23:01:18.769 UTC")
+    Nothing
     ( EdConvAccessUpdate
         ( ConversationAccessData
             { cupAccess = [InviteAccess, LinkAccess, PrivateAccess, InviteAccess, InviteAccess],
@@ -72,6 +74,7 @@ testObject_Event_user_3 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "00004b11-0000-5504-0000-55d800002188"))) (Domain "faraway.example.com"))
     (read "1864-04-27 15:44:23.844 UTC")
+    Nothing
     ( EdOtrMessage
         ( OtrMessage
             { otrSender = ClientId 0xc,
@@ -89,6 +92,7 @@ testObject_Event_user_4 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "00007c90-0000-766a-0000-01b700002ab7"))) (Domain "faraway.example.com"))
     (read "1864-05-12 00:59:09.2 UTC")
+    Nothing
     EdConvCodeDelete
 
 testObject_Event_user_5 :: Event
@@ -98,6 +102,7 @@ testObject_Event_user_5 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "00002a12-0000-73e1-0000-71f700002ec9"))) (Domain "faraway.example.com"))
     (read "1864-04-12 03:04:00.298 UTC")
+    Nothing
     ( EdMemberUpdate
         ( MemberUpdateData
             { misTarget =
@@ -126,6 +131,7 @@ testObject_Event_user_6 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "0000705a-0000-0b62-0000-425c000049c8"))) (Domain "faraway.example.com"))
     (read "1864-05-09 05:44:41.382 UTC")
+    Nothing
     (EdConvMessageTimerUpdate (ConversationMessageTimerUpdate {cupMessageTimer = Just (Ms {ms = 5029817038083912})}))
 
 testObject_Event_user_7 :: Event
@@ -135,6 +141,7 @@ testObject_Event_user_7 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "0000355a-0000-2979-0000-083000002d5e"))) (Domain "faraway.example.com"))
     (read "1864-04-18 05:01:13.761 UTC")
+    Nothing
     (EdTyping StoppedTyping)
 
 testObject_Event_user_8 :: Event
@@ -144,6 +151,7 @@ testObject_Event_user_8 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "00000457-0000-0689-0000-77a00000021c"))) (Domain "faraway.example.com"))
     (read "1864-05-29 19:31:31.226 UTC")
+    Nothing
     ( EdConversation
         ( ConversationV8
             { cnvQualifiedId = Qualified (Id (fromJust (UUID.fromString "00000000-0000-0000-0000-000100000001"))) (Domain "golden.example.com"),
@@ -211,6 +219,7 @@ testObject_Event_user_9 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "00004bee-0000-45a0-0000-2c0300005726"))) (Domain "faraway.example.com"))
     (read "1864-05-01 11:57:35.123 UTC")
+    Nothing
     (EdConvReceiptModeUpdate (ConversationReceiptModeUpdate {cruReceiptMode = ReceiptMode {unReceiptMode = -10505}}))
 
 testObject_Event_user_10 :: Event
@@ -220,6 +229,7 @@ testObject_Event_user_10 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "00007f28-0000-40b1-0000-56ab0000748d"))) (Domain "faraway.example.com"))
     (read "1864-05-25 01:31:49.802 UTC")
+    Nothing
     ( EdConnect
         ( Connect
             { cRecipient =
@@ -240,6 +250,7 @@ testObject_Event_user_11 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "000043a6-0000-1627-0000-490300002017"))) (Domain "faraway.example.com"))
     (read "1864-04-12 01:28:25.705 UTC")
+    Nothing
     ( EdMembersLeave
         EdReasonLeft
         ( QualifiedUserIdList
@@ -258,6 +269,7 @@ testObject_Event_user_12 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "0000114a-0000-7da8-0000-40cb00007fcf"))) (Domain "faraway.example.com"))
     (read "1864-05-12 20:29:47.483 UTC")
+    Nothing
     ( EdMembersJoin
         ( MembersJoin
             { mMembers =
@@ -282,6 +294,7 @@ testObject_Event_user_13 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "0000114a-0000-7da8-0000-40cb00007fcf"))) (Domain "faraway.example.com"))
     (read "1864-05-12 20:29:47.483 UTC")
+    Nothing
     (EdConvRename (ConversationRename "New conversation name"))
 
 testObject_Event_user_14 :: Event
@@ -291,6 +304,7 @@ testObject_Event_user_14 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "0000114a-0000-7da8-0000-40cb00007fcf"))) (Domain "faraway.example.com"))
     (read "1864-05-12 20:29:47.483 UTC")
+    Nothing
     (EdConvCodeUpdate cc)
   where
     cc =
@@ -310,6 +324,7 @@ testObject_Event_user_15 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "04e68c50-027e-4e84-a33a-e2e28a7b8ea3"))) (Domain "faraway.example.com"))
     (read "2021-11-10 05:39:44.297 UTC")
+    Nothing
     (EdMLSMessage "hello world")
 
 testObject_Event_user_16 :: Event
@@ -319,4 +334,5 @@ testObject_Event_user_16 =
     Nothing
     (Qualified (Id (fromJust (UUID.fromString "e8f48b8f-fad3-4f60-98e3-a6df082c328d"))) (Domain "faraway.example.com"))
     (read "2021-05-12 13:12:01.005 UTC")
+    Nothing
     (EdMLSWelcome "welcome message content")

libs/wire-api/test/golden/Test/Wire/API/Golden/Generated/RemoveBotResponse_user.hs

@@ -38,6 +38,7 @@ testObject_RemoveBotResponse_user_1 =
           Nothing
           (Qualified (Id (fromJust (UUID.fromString "00004166-0000-1e32-0000-52cb0000428d"))) (Domain "faraway.example.com"))
           (read "1864-05-07 01:13:35.741 UTC")
+          Nothing
           ( EdMembersLeave
               EdReasonRemoved
               ( QualifiedUserIdList

libs/wire-api/test/golden/Test/Wire/API/Golden/Manual/ConversationEvent.hs

@@ -34,7 +34,8 @@ testObject_Event_conversation_manual_1 =
       evtSubConv = Just (SubConvId "call"),
       evtFrom = Qualified {qUnqualified = Id (fromJust (UUID.fromString "2126ea99-ca79-43ea-ad99-a59616468e8e")), qDomain = Domain {_domainText = "n8nl6tp.h5"}},
       evtTime = UTCTime {utctDay = ModifiedJulianDay 58119, utctDayTime = 0},
-      evtData = EdConvCodeDelete
+      evtData = EdConvCodeDelete,
+      evtTeam = Nothing
     }
 
 testObject_Event_conversation_manual_2 :: Event
@@ -44,5 +45,6 @@ testObject_Event_conversation_manual_2 =
       evtSubConv = Nothing,
       evtFrom = Qualified {qUnqualified = Id (fromJust (UUID.fromString "a471447c-aa30-4592-81b0-dec6c1c02bca")), qDomain = Domain {_domainText = "example.com"}},
       evtTime = UTCTime {utctDay = ModifiedJulianDay 58119, utctDayTime = 0},
-      evtData = EdProtocolUpdate P.ProtocolMixedTag
+      evtData = EdProtocolUpdate P.ProtocolMixedTag,
+      evtTeam = Nothing
     }