Make conversation ID in on-conversation-created RPC unqualified (#1766)

* Make conv ID in register-conversation unqualified

The conversation being created has to be in the backend which originated
the RPC, therefore we can simply make its ID unqualified instead of
checking if the two domains match.

Author: pcapriotti

changelog.d/6-federation/new-remote-conversation-unqualify

@@ -0,0 +1 @@
+Make conversation ID of the on-conversation-created RPC unqualified

libs/wire-api-federation/src/Wire/API/Federation/API/Galley.hs

@@ -53,7 +53,8 @@ data Api routes = Api
         :- "federation"
         :> Summary "Register users to be in a new remote conversation"
         :> "on-conversation-created"
-        :> ReqBody '[JSON] NewRemoteConversation
+        :> OriginDomainHeader
+        :> ReqBody '[JSON] (NewRemoteConversation ConvId)
         :> Post '[JSON] (),
     getConversations ::
       routes
@@ -117,14 +118,13 @@ newtype GetConversationsResponse = GetConversationsResponse
 --
 -- FUTUREWORK: Think about extracting common conversation metadata into a
 -- separarate data type that can be reused in several data types in this module.
-data NewRemoteConversation = NewRemoteConversation
+data NewRemoteConversation conv = NewRemoteConversation
   { -- | The time when the conversation was created
     rcTime :: UTCTime,
     -- | The user that created the conversation
     rcOrigUserId :: Qualified UserId,
-    -- | The qualified conversation ID
-    -- FUTUREWORK: Make this unqualified, assume the conversation is being hosted by OriginDomain
-    rcCnvId :: Qualified ConvId,
+    -- | The conversation ID, local to the backend invoking the RPC
+    rcCnvId :: conv,
     -- | The conversation type
     rcCnvType :: ConvType,
     rcCnvAccess :: [Access],
@@ -136,8 +136,8 @@ data NewRemoteConversation = NewRemoteConversation
     rcMessageTimer :: Maybe Milliseconds,
     rcReceiptMode :: Maybe ReceiptMode
   }
-  deriving stock (Eq, Show, Generic)
-  deriving (ToJSON, FromJSON) via (CustomEncoded NewRemoteConversation)
+  deriving stock (Eq, Show, Generic, Functor)
+  deriving (ToJSON, FromJSON) via (CustomEncoded (NewRemoteConversation conv))
 
 -- | A conversation membership update, as given by ' ConversationMemberUpdate',
 -- can be either a member addition or removal.

services/galley/src/Galley/API/Federation.hs

@@ -75,21 +75,22 @@ federationSitemap =
         FederationAPIGalley.sendMessage = sendMessage
       }
 
-onConversationCreated :: NewRemoteConversation -> Galley ()
-onConversationCreated rc = do
+onConversationCreated :: Domain -> NewRemoteConversation ConvId -> Galley ()
+onConversationCreated domain rc = do
+  let qrc = fmap (`Qualified` domain) rc
   localDomain <- viewFederationDomain
   let localUsers =
         foldMap (\om -> guard (qDomain (omQualifiedId om) == localDomain) $> omQualifiedId om)
           . rcMembers
           $ rc
       localUserIds = fmap qUnqualified localUsers
   unless (null localUsers) $ do
-    Data.addLocalMembersToRemoteConv localUserIds (rcCnvId rc)
-  forM_ (fromNewRemoteConversation localDomain rc) $ \(mem, c) -> do
+    Data.addLocalMembersToRemoteConv localUserIds (rcCnvId qrc)
+  forM_ (fromNewRemoteConversation localDomain qrc) $ \(mem, c) -> do
     let event =
           Event
             ConvCreate
-            (rcCnvId rc)
+            (rcCnvId qrc)
             (rcOrigUserId rc)
             (rcTime rc)
             (EdConversation c)

services/galley/src/Galley/API/Util.hs

@@ -478,12 +478,12 @@ toNewRemoteConversation ::
   -- | The conversation to convert for sending to a remote Galley
   Data.Conversation ->
   -- | The resulting information to be sent to a remote Galley
-  NewRemoteConversation
+  NewRemoteConversation ConvId
 toNewRemoteConversation now localDomain Data.Conversation {..} =
   NewRemoteConversation
     { rcTime = now,
       rcOrigUserId = Qualified convCreator localDomain,
-      rcCnvId = Qualified convId localDomain,
+      rcCnvId = convId,
       rcCnvType = convType,
       rcCnvAccess = convAccess,
       rcCnvAccessRole = convAccessRole,
@@ -521,7 +521,7 @@ toNewRemoteConversation now localDomain Data.Conversation {..} =
 -- conversation.
 fromNewRemoteConversation ::
   Domain ->
-  NewRemoteConversation ->
+  NewRemoteConversation (Qualified ConvId) ->
   [(Public.Member, Public.Conversation)]
 fromNewRemoteConversation d NewRemoteConversation {..} =
   let membersView = fmap (second Set.toList) . setHoles $ rcMembers
@@ -589,11 +589,11 @@ registerRemoteConversationMemberships now localDomain c = do
     $ c
   where
     registerRemoteConversations ::
-      NewRemoteConversation ->
+      NewRemoteConversation ConvId ->
       Domain ->
       Galley ()
     registerRemoteConversations rc domain = do
-      let rpc = FederatedGalley.onConversationCreated FederatedGalley.clientRoutes rc
+      let rpc = FederatedGalley.onConversationCreated FederatedGalley.clientRoutes localDomain rc
       runFederated domain rpc
 
 -- | Notify remote backends about changes to the conversation memberships of the

services/galley/test/integration/API.hs

@@ -224,7 +224,7 @@ emptyFederatedGalley =
   let e :: Text -> Handler a
       e s = throwError err501 {errBody = cs ("mock not implemented: " <> s)}
    in FederatedGalley.Api
-        { FederatedGalley.onConversationCreated = \_ -> e "onConversationCreated",
+        { FederatedGalley.onConversationCreated = \_ _ -> e "onConversationCreated",
           FederatedGalley.getConversations = \_ -> e "getConversations",
           FederatedGalley.onConversationMembershipsChanged = \_ _ -> e "onConversationMembershipsChanged",
           FederatedGalley.leaveConversation = \_ _ -> e "leaveConversation",

services/galley/test/integration/API/Util.hs

@@ -1165,10 +1165,11 @@ registerRemoteConv convId originUser name othMembers = do
   now <- liftIO getCurrentTime
   FederatedGalley.onConversationCreated
     fedGalleyClient
+    (qDomain convId)
     ( FederatedGalley.NewRemoteConversation
         { rcTime = now,
           rcOrigUserId = originUser,
-          rcCnvId = convId,
+          rcCnvId = qUnqualified convId,
           rcCnvType = RegularConv,
           rcCnvAccess = [],
           rcCnvAccessRole = ActivatedAccessRole,