[Federation] Add an Endpoint for Conversation Member Removal based on Qualified User ID

CHANGELOG-draft.md

@@ -31,6 +31,9 @@ THIS FILE ACCUMULATES THE RELEASE NOTES FOR THE UPCOMING RELEASE.
 
 ## API Changes
 
+* Deprecate `DELETE /conversations/:cnv/members/:usr` (#1697)
+* Add `DELETE /conversations/:cnv/members/:domain/:usr` (#1697)
+
 ## Features
 
 ## Bug fixes and other updates
@@ -40,14 +43,18 @@ THIS FILE ACCUMULATES THE RELEASE NOTES FOR THE UPCOMING RELEASE.
 
 ## Documentation
 
+* Improve Swagger for `DELETE /conversations/:cnv/members/:usr` (#1697)
+
 ## Internal changes
 
 * Integration test script now displays output interactively (#1700)
 * Fixed a few issues with error response documentation in Swagger (#1707)
 * Make mapping between (team) permissions and roles more lenient (#1711)
+* The `DELETE /conversations/:cnv/members/:usr` endpoint rewritten to Servant (#1697)
 * Remove leftover auto-connect internal endpoint and code (#1716)
 
 ## Federation changes
 
 * Added client certificate support for server to server authentication (#1682)
 * Implemented full server-to-server authentication (#1687)
+* Add an endpoint for removing a qualified user from a local conversation (#1697)

libs/api-client/src/Network/Wire/Client/API/Push.hs

@@ -79,7 +79,7 @@ import qualified System.Logger as Log
 import Wire.API.Connection (UserConnection (..))
 import Wire.API.Conversation.Member (MemberUpdate (..))
 import Wire.API.Event.Conversation hiding (Event, EventType)
-import Wire.API.User (Name (..), User (..), userEmail)
+import Wire.API.User (Name (..), User (..), UserIdList (..), userEmail)
 
 -------------------------------------------------------------------------------
 

libs/galley-types/src/Galley/Types.hs

@@ -41,6 +41,7 @@ module Galley.Types
     EventType (..),
     EventData (..),
     UserIdList (..),
+    QualifiedUserIdList (..),
     SimpleMember (..),
     SimpleMembers (..),
     MemberUpdateData (..),
@@ -85,6 +86,7 @@ import Wire.API.Conversation.Typing
 import Wire.API.CustomBackend
 import Wire.API.Event.Conversation
 import Wire.API.Message
+import Wire.API.User (UserIdList (..))
 import Wire.API.User.Client
 
 --------------------------------------------------------------------------------

libs/types-common/src/Data/Qualified.hs

@@ -97,8 +97,8 @@ partitionRemote remotes = Map.assocs $ partitionQualified (unTagged <$> remotes)
 renderQualifiedId :: Qualified (Id a) -> Text
 renderQualifiedId = renderQualified (cs . UUID.toString . toUUID)
 
-deprecatedSchema :: Text -> ValueSchema NamedSwaggerDoc a -> ValueSchema SwaggerDoc a
-deprecatedSchema new = (doc . description ?~ ("Deprecated, use " <> new)) . unnamed
+deprecatedSchema :: S.HasDescription doc (Maybe Text) => Text -> ValueSchema doc a -> ValueSchema doc a
+deprecatedSchema new = doc . description ?~ ("Deprecated, use " <> new)
 
 qualifiedSchema ::
   Text ->

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

@@ -29,13 +29,13 @@ import Test.QuickCheck (Arbitrary)
 import Wire.API.Arbitrary (GenericUniform (..))
 import Wire.API.Federation.Client (FederationClientFailure, FederatorClient)
 import qualified Wire.API.Federation.GRPC.Types as Proto
-import Wire.API.Federation.Util.Aeson (CustomEncoded (..))
 import Wire.API.Message (UserClients)
 import Wire.API.User (UserProfile)
 import Wire.API.User.Client (PubClient, UserClientPrekeyMap)
 import Wire.API.User.Client.Prekey (ClientPrekey, PrekeyBundle)
 import Wire.API.User.Search
 import Wire.API.UserMap (UserMap)
+import Wire.API.Util.Aeson (CustomEncoded (..))
 
 newtype SearchRequest = SearchRequest {term :: Text}
   deriving (Show, Eq, Generic, Typeable)

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

@@ -1,5 +1,3 @@
-{-# LANGUAGE GeneralizedNewtypeDeriving #-}
-
 -- This file is part of the Wire Server implementation.
 --
 -- Copyright (C) 2020 Wire Swiss GmbH <opensource@wire.com>
@@ -23,6 +21,7 @@ import Control.Monad.Except (MonadError (..))
 import Data.Aeson (FromJSON, ToJSON)
 import Data.Id (ClientId, ConvId, UserId)
 import Data.Json.Util (Base64ByteString)
+import Data.List.NonEmpty (NonEmpty)
 import Data.Misc (Milliseconds)
 import Data.Qualified (Qualified)
 import Data.Time.Clock (UTCTime)
@@ -37,9 +36,10 @@ import Wire.API.Conversation.Role (RoleName)
 import Wire.API.Federation.Client (FederationClientFailure, FederatorClient)
 import Wire.API.Federation.Domain (OriginDomainHeader)
 import qualified Wire.API.Federation.GRPC.Types as Proto
-import Wire.API.Federation.Util.Aeson (CustomEncoded (..))
 import Wire.API.Message (MessageNotSent, MessageSendingStatus, PostOtrResponse, Priority)
+import Wire.API.Routes.Public.Galley.Responses (RemoveFromConversationError)
 import Wire.API.User.Client (UserClientMap)
+import Wire.API.Util.Aeson (CustomEncoded (..))
 
 -- FUTUREWORK: data types, json instances, more endpoints. See
 -- https://wearezeta.atlassian.net/wiki/spaces/CORE/pages/356090113/Federation+Galley+Conversation+API
@@ -68,6 +68,13 @@ data Api routes = Api
         :> "update-conversation-memberships"
         :> ReqBody '[JSON] ConversationMemberUpdate
         :> Post '[JSON] (),
+    leaveConversation ::
+      routes
+        :- "federation"
+        :> "leave-conversation"
+        :> OriginDomainHeader
+        :> ReqBody '[JSON] LeaveConversationRequest
+        :> Post '[JSON] LeaveConversationResponse,
     -- used to notify this backend that a new message has been posted to a
     -- remote conversation
     receiveMessage ::
@@ -129,6 +136,15 @@ data RegisterConversation = MkRegisterConversation
   deriving stock (Eq, Show, Generic)
   deriving (ToJSON, FromJSON) via (CustomEncoded RegisterConversation)
 
+-- | A conversation membership update, as given by ' ConversationMemberUpdate',
+-- can be either a member addition or removal.
+data ConversationMembersAction
+  = ConversationMembersActionAdd (NonEmpty (Qualified UserId, RoleName))
+  | ConversationMembersActionRemove (NonEmpty (Qualified UserId))
+  deriving stock (Eq, Show, Generic)
+  deriving (Arbitrary) via (GenericUniform ConversationMembersAction)
+  deriving (ToJSON, FromJSON) via (CustomEncoded ConversationMembersAction)
+
 data ConversationMemberUpdate = ConversationMemberUpdate
   { cmuTime :: UTCTime,
     cmuOrigUserId :: Qualified UserId,
@@ -138,19 +154,24 @@ data ConversationMemberUpdate = ConversationMemberUpdate
     -- non-conversation owning backend to have an indexed mapping of
     -- conversation to users.
     cmuAlreadyPresentUsers :: [UserId],
-    -- | Users that got added to the conversation.
-    cmuUsersAdd :: [(Qualified UserId, RoleName)],
-    -- | Users that got removed from the conversation. This should probably be
-    -- Qualified, but as of now this is a stub.
-    --
-    -- FUTUREWORK: Implement this when supporting removal of remote conversation
-    -- members.
-    cmuUsersRemove :: [UserId]
+    -- | Users that got either added to or removed from the conversation.
+    cmuAction :: ConversationMembersAction
   }
   deriving stock (Eq, Show, Generic)
   deriving (Arbitrary) via (GenericUniform ConversationMemberUpdate)
   deriving (ToJSON, FromJSON) via (CustomEncoded ConversationMemberUpdate)
 
+data LeaveConversationRequest = LeaveConversationRequest
+  { -- | The conversation is assumed to be owned by the target domain, which
+    -- allows us to protect against relay attacks
+    lcConvId :: ConvId,
+    -- | The leaver is assumed to be owned by the origin domain, which allows us
+    -- to protect against spoofing attacks
+    lcLeaver :: UserId
+  }
+  deriving stock (Generic, Eq, Show)
+  deriving (ToJSON, FromJSON) via (CustomEncoded LeaveConversationRequest)
+
 -- Note: this is parametric in the conversation type to allow it to be used
 -- both for conversations with a fixed known domain (e.g. as the argument of the
 -- federation RPC), and for conversations with an arbitrary Qualified or Remote id
@@ -193,5 +214,12 @@ newtype MessageSendResponse = MessageSendResponse
             MessageSendingStatus
         )
 
+newtype LeaveConversationResponse = LeaveConversationResponse
+  {leaveResponse :: Either RemoveFromConversationError ()}
+  deriving stock (Eq, Show)
+  deriving
+    (ToJSON, FromJSON)
+    via (Either (CustomEncoded RemoveFromConversationError) ())
+
 clientRoutes :: (MonadError FederationClientFailure m, MonadIO m) => Api (AsClientT (FederatorClient 'Proto.Galley m))
 clientRoutes = genericClient

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

@@ -38,7 +38,7 @@ import Data.Time
 import Imports
 import Test.QuickCheck (Arbitrary (arbitrary))
 import qualified Test.QuickCheck as QC
-import Wire.API.Federation.Util.Aeson (CustomEncoded (CustomEncoded))
+import Wire.API.Util.Aeson (CustomEncoded (CustomEncoded))
 
 data AnyEvent
   = EventMemberJoin (ConversationEvent MemberJoin)

libs/wire-api-federation/test/Test/Wire/API/Federation/Golden/ConversationMemberUpdate.hs

@@ -0,0 +1,73 @@
+-- This file is part of the Wire Server implementation.
+--
+-- Copyright (C) 2021 Wire Swiss GmbH <opensource@wire.com>
+--
+-- This program is free software: you can redistribute it and/or modify it under
+-- the terms of the GNU Affero General Public License as published by the Free
+-- Software Foundation, either version 3 of the License, or (at your option) any
+-- later version.
+--
+-- This program is distributed in the hope that it will be useful, but WITHOUT
+-- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+-- FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+-- details.
+--
+-- You should have received a copy of the GNU Affero General Public License along
+-- with this program. If not, see <https://www.gnu.org/licenses/>.
+
+module Test.Wire.API.Federation.Golden.ConversationMemberUpdate where
+
+import Data.Domain (Domain (Domain))
+import Data.Id (Id (Id), UserId)
+import Data.List.NonEmpty (NonEmpty (..))
+import Data.Qualified (Qualified (Qualified))
+import qualified Data.UUID as UUID
+import Imports
+import Wire.API.Conversation.Role (roleNameWireAdmin, roleNameWireMember)
+import Wire.API.Federation.API.Galley (ConversationMemberUpdate (..), ConversationMembersAction (..))
+
+qAlice, qBob :: Qualified UserId
+qAlice =
+  Qualified
+    (Id (fromJust (UUID.fromString "00000000-0000-0000-0000-000100004007")))
+    (Domain "golden.example.com")
+qBob =
+  Qualified
+    (Id (fromJust (UUID.fromString "00000000-0000-0000-0000-000100005007")))
+    (Domain "golden2.example.com")
+
+chad, dee :: UserId
+chad = Id (fromJust (UUID.fromString "00000fff-0000-0000-0000-000100005007"))
+dee = Id (fromJust (UUID.fromString "00000fff-0000-aaaa-0000-000100005007"))
+
+testObject_ConversationMemberUpdate1 :: ConversationMemberUpdate
+testObject_ConversationMemberUpdate1 =
+  ConversationMemberUpdate
+    { cmuTime = read "1864-04-12 12:22:43.673 UTC",
+      cmuOrigUserId =
+        Qualified
+          (Id (fromJust (UUID.fromString "00000000-0000-0000-0000-000100000007")))
+          (Domain "golden.example.com"),
+      cmuConvId =
+        Qualified
+          (Id (fromJust (UUID.fromString "00000000-0000-0000-0000-000100000006")))
+          (Domain "golden2.example.com"),
+      cmuAlreadyPresentUsers = [],
+      cmuAction = ConversationMembersActionAdd ((qAlice, roleNameWireMember) :| [(qBob, roleNameWireAdmin)])
+    }
+
+testObject_ConversationMemberUpdate2 :: ConversationMemberUpdate
+testObject_ConversationMemberUpdate2 =
+  ConversationMemberUpdate
+    { cmuTime = read "1864-04-12 12:22:43.673 UTC",
+      cmuOrigUserId =
+        Qualified
+          (Id (fromJust (UUID.fromString "00000000-0000-0000-0000-000100000007")))
+          (Domain "golden.example.com"),
+      cmuConvId =
+        Qualified
+          (Id (fromJust (UUID.fromString "00000000-0000-0000-0000-000100000006")))
+          (Domain "golden2.example.com"),
+      cmuAlreadyPresentUsers = [chad, dee],
+      cmuAction = ConversationMembersActionRemove (qAlice :| [qBob])
+    }

libs/wire-api-federation/test/Test/Wire/API/Federation/Golden/GoldenSpec.hs

@@ -19,16 +19,35 @@ module Test.Wire.API.Federation.Golden.GoldenSpec where
 
 import Imports
 import Test.Hspec
+import qualified Test.Wire.API.Federation.Golden.ConversationMemberUpdate as ConversationMemberUpdate
+import qualified Test.Wire.API.Federation.Golden.LeaveConversationRequest as LeaveConversationRequest
+import qualified Test.Wire.API.Federation.Golden.LeaveConversationResponse as LeaveConversationResponse
 import qualified Test.Wire.API.Federation.Golden.MessageSendResponse as MessageSendResponse
 import Test.Wire.API.Federation.Golden.Runner (testObjects)
 
 spec :: Spec
 spec =
-  describe "Golden tests" $
+  describe "Golden tests" $ do
     testObjects
       [ (MessageSendResponse.testObject_MessageSendReponse1, "testObject_MessageSendReponse1.json"),
         (MessageSendResponse.testObject_MessageSendReponse2, "testObject_MessageSendReponse2.json"),
         (MessageSendResponse.testObject_MessageSendReponse3, "testObject_MessageSendReponse3.json"),
         (MessageSendResponse.testObject_MessageSendReponse4, "testObject_MessageSendReponse4.json"),
         (MessageSendResponse.testObject_MessageSendReponse5, "testObject_MessageSendReponse5.json")
       ]
+    testObjects [(LeaveConversationRequest.testObject_LeaveConversationRequest1, "testObject_LeaveConversationRequest1.json")]
+    testObjects
+      [ (ConversationMemberUpdate.testObject_ConversationMemberUpdate1, "testObject_ConversationMemberUpdate1.json"),
+        (ConversationMemberUpdate.testObject_ConversationMemberUpdate2, "testObject_ConversationMemberUpdate2.json")
+      ]
+    testObjects
+      [ (LeaveConversationResponse.testObject_LeaveConversationResponse1, "testObject_LeaveConversationResponse1.json"),
+        (LeaveConversationResponse.testObject_LeaveConversationResponse2, "testObject_LeaveConversationResponse2.json"),
+        (LeaveConversationResponse.testObject_LeaveConversationResponse3, "testObject_LeaveConversationResponse3.json"),
+        (LeaveConversationResponse.testObject_LeaveConversationResponse4, "testObject_LeaveConversationResponse4.json"),
+        (LeaveConversationResponse.testObject_LeaveConversationResponse5, "testObject_LeaveConversationResponse5.json"),
+        (LeaveConversationResponse.testObject_LeaveConversationResponse6, "testObject_LeaveConversationResponse6.json"),
+        (LeaveConversationResponse.testObject_LeaveConversationResponse7, "testObject_LeaveConversationResponse7.json"),
+        (LeaveConversationResponse.testObject_LeaveConversationResponse8, "testObject_LeaveConversationResponse8.json"),
+        (LeaveConversationResponse.testObject_LeaveConversationResponse9, "testObject_LeaveConversationResponse9.json")
+      ]

libs/wire-api-federation/test/Test/Wire/API/Federation/Golden/LeaveConversationRequest.hs

@@ -0,0 +1,29 @@
+-- This file is part of the Wire Server implementation.
+--
+-- Copyright (C) 2021 Wire Swiss GmbH <opensource@wire.com>
+--
+-- This program is free software: you can redistribute it and/or modify it under
+-- the terms of the GNU Affero General Public License as published by the Free
+-- Software Foundation, either version 3 of the License, or (at your option) any
+-- later version.
+--
+-- This program is distributed in the hope that it will be useful, but WITHOUT
+-- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+-- FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+-- details.
+--
+-- You should have received a copy of the GNU Affero General Public License along
+-- with this program. If not, see <https://www.gnu.org/licenses/>.
+
+module Test.Wire.API.Federation.Golden.LeaveConversationRequest where
+
+import Data.Id (Id (Id))
+import Data.Maybe (fromJust)
+import qualified Data.UUID as UUID
+import Wire.API.Federation.API.Galley (LeaveConversationRequest (LeaveConversationRequest))
+
+testObject_LeaveConversationRequest1 :: LeaveConversationRequest
+testObject_LeaveConversationRequest1 =
+  LeaveConversationRequest
+    (Id (fromJust (UUID.fromString "00000000-0000-0000-0000-000100000002")))
+    (Id (fromJust (UUID.fromString "00000000-0000-0000-0000-000100000001")))

libs/wire-api-federation/test/Test/Wire/API/Federation/Golden/LeaveConversationResponse.hs

@@ -0,0 +1,32 @@
+module Test.Wire.API.Federation.Golden.LeaveConversationResponse where
+
+import Imports
+import Wire.API.Federation.API.Galley (LeaveConversationResponse (LeaveConversationResponse))
+import Wire.API.Routes.Public.Galley.Responses (RemoveFromConversationError (..))
+
+testObject_LeaveConversationResponse1 :: LeaveConversationResponse
+testObject_LeaveConversationResponse1 = LeaveConversationResponse $ Right ()
+
+testObject_LeaveConversationResponse2 :: LeaveConversationResponse
+testObject_LeaveConversationResponse2 = LeaveConversationResponse $ Left RemoveFromConversationErrorRemovalNotAllowed
+
+testObject_LeaveConversationResponse3 :: LeaveConversationResponse
+testObject_LeaveConversationResponse3 = LeaveConversationResponse $ Left RemoveFromConversationErrorManagedConvNotAllowed
+
+testObject_LeaveConversationResponse4 :: LeaveConversationResponse
+testObject_LeaveConversationResponse4 = LeaveConversationResponse $ Left RemoveFromConversationErrorNotFound
+
+testObject_LeaveConversationResponse5 :: LeaveConversationResponse
+testObject_LeaveConversationResponse5 = LeaveConversationResponse $ Left RemoveFromConversationErrorCustomRolesNotSupported
+
+testObject_LeaveConversationResponse6 :: LeaveConversationResponse
+testObject_LeaveConversationResponse6 = LeaveConversationResponse $ Left RemoveFromConversationErrorSelfConv
+
+testObject_LeaveConversationResponse7 :: LeaveConversationResponse
+testObject_LeaveConversationResponse7 = LeaveConversationResponse $ Left RemoveFromConversationErrorOne2OneConv
+
+testObject_LeaveConversationResponse8 :: LeaveConversationResponse
+testObject_LeaveConversationResponse8 = LeaveConversationResponse $ Left RemoveFromConversationErrorConnectConv
+
+testObject_LeaveConversationResponse9 :: LeaveConversationResponse
+testObject_LeaveConversationResponse9 = LeaveConversationResponse $ Left RemoveFromConversationErrorUnchanged

libs/wire-api-federation/test/golden/testObject_ConversationMemberUpdate1.json

@@ -0,0 +1,31 @@
+{
+    "orig_user_id": {
+        "domain": "golden.example.com",
+        "id": "00000000-0000-0000-0000-000100000007"
+    },
+    "already_present_users": [],
+    "time": "1864-04-12T12:22:43.673Z",
+    "action": {
+        "tag": "ConversationMembersActionAdd",
+        "contents": [
+            [
+                {
+                    "domain": "golden.example.com",
+                    "id": "00000000-0000-0000-0000-000100004007"
+                },
+                "wire_member"
+            ],
+            [
+                {
+                    "domain": "golden2.example.com",
+                    "id": "00000000-0000-0000-0000-000100005007"
+                },
+                "wire_admin"
+            ]
+        ]
+    },
+    "conv_id": {
+        "domain": "golden2.example.com",
+        "id": "00000000-0000-0000-0000-000100000006"
+    }
+}