Add schema migration for new tables

libs/api-bot/src/Network/Wire/Bot/Assert.hs

@@ -21,6 +21,7 @@
 module Network.Wire.Bot.Assert where
 
 import Data.Id (ConvId, UserId)
+import Data.Qualified (qUnqualified)
 import qualified Data.Set as Set
 import Imports
 import Network.Wire.Bot.Monad
@@ -46,7 +47,7 @@ assertConvCreated c b bs = do
       EConvCreate e ->
         let cnv = convEvtData e
             mems = cnvMembers cnv
-            omems = Set.fromList (map omId (cmOthers mems))
+            omems = Set.fromList (map (qUnqualified . omQualifiedId) (cmOthers mems))
          in cnvId cnv == c
               && convEvtFrom e == botId b
               && cnvType cnv == RegularConv

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

@@ -25,6 +25,7 @@ module Galley.Types
     -- * re-exports
     Conversation (..),
     LocalMember,
+    RemoteMember,
     InternalMember (..),
     ConvMembers (..),
     OtherMember (..),
@@ -76,7 +77,7 @@ import Data.Id (ClientId, ConvId, TeamId, UserId)
 import Data.Json.Util ((#))
 import qualified Data.Map.Strict as Map
 import Data.Misc (Milliseconds)
-import Galley.Types.Conversations.Members (InternalMember (..), LocalMember)
+import Galley.Types.Conversations.Members (InternalMember (..), LocalMember, RemoteMember)
 import Imports
 import Wire.API.Conversation hiding (Member (..))
 import Wire.API.Conversation.Code

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

@@ -19,20 +19,28 @@
 
 module Galley.Types.Conversations.Members
   ( LocalMember,
+    RemoteMember (..),
     InternalMember (..),
   )
 where
 
 import Data.Id as Id
+import Data.Qualified (Remote)
 import Imports
 import Wire.API.Conversation.Member (MutedStatus)
 import Wire.API.Conversation.Role (RoleName)
 import Wire.API.Provider.Service (ServiceRef)
 
 type LocalMember = InternalMember Id.UserId
 
--- | Internal representation of a conversation member.
-data InternalMember id = Member
+data RemoteMember = RemoteMember
+  { rmId :: Remote UserId,
+    rmConvRoleName :: RoleName
+  }
+  deriving stock (Show)
+
+-- | Internal (cassandra) representation of a conversation member.
+data InternalMember id = InternalMember
   { memId :: id,
     memService :: Maybe ServiceRef,
     -- | DEPRECATED, remove it once enough clients use `memOtrMutedStatus`

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

@@ -72,8 +72,6 @@ data T
 
 data STo
 
-data Remote a
-
 type AssetId = Id A
 
 type InvitationId = Id I

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

@@ -28,8 +28,11 @@ module Data.Qualified
 
     -- * Qualified
     Qualified (..),
+    Remote,
+    toRemote,
     renderQualifiedId,
     partitionRemoteOrLocalIds,
+    partitionRemoteOrLocalIds',
     partitionQualified,
     deprecatedSchema,
   )
@@ -39,6 +42,7 @@ import Control.Applicative (optional)
 import Control.Lens ((?~))
 import Data.Aeson (FromJSON (..), ToJSON (..))
 import qualified Data.Attoparsec.ByteString.Char8 as Atto
+import Data.Bifunctor (first)
 import Data.ByteString.Conversion (FromByteString (parser))
 import Data.Domain (Domain, domainText)
 import Data.Handle (Handle (..))
@@ -47,12 +51,13 @@ import qualified Data.Map as Map
 import Data.Schema
 import Data.String.Conversions (cs)
 import qualified Data.Swagger as S
+import Data.Tagged
 import qualified Data.UUID as UUID
 import Imports hiding (local)
 import Test.QuickCheck (Arbitrary (arbitrary))
 
 ----------------------------------------------------------------------
--- OPTIONALLY QUALIFIED
+-- OPTIONALLY QUALIFIED -- FUTUREWORK: remove optionally qualified, not used
 
 data OptionallyQualified a = OptionallyQualified
   { oqUnqualified :: a,
@@ -96,6 +101,16 @@ data Qualified a = Qualified
   }
   deriving stock (Eq, Ord, Show, Generic, Functor)
 
+-- | A type to differentiate between generally Qualified values, and values
+-- where it is known if they are coming from a Remote backend or not.
+-- Use 'toRemote' or 'partitionRemoteOrLocalIds\'' to get Remote values and use
+-- 'unTagged' to convert from a Remote value back to a plain Qualified one.
+type Remote a = Tagged "remote" (Qualified a)
+
+-- | Convert a Qualified something to a Remote something.
+toRemote :: Qualified a -> Remote a
+toRemote = Tagged
+
 -- | FUTUREWORK: Maybe delete this, it is only used in printing federation not
 -- implemented errors
 renderQualified :: (a -> Text) -> Qualified a -> Text
@@ -108,6 +123,9 @@ partitionRemoteOrLocalIds localDomain = foldMap $ \qualifiedId ->
     then (mempty, [qUnqualified qualifiedId])
     else ([qualifiedId], mempty)
 
+partitionRemoteOrLocalIds' :: Foldable f => Domain -> f (Qualified a) -> ([Remote a], [a])
+partitionRemoteOrLocalIds' localDomain xs = first (fmap toRemote) $ partitionRemoteOrLocalIds localDomain xs
+
 -- | Index a list of qualified values by domain
 partitionQualified :: [Qualified a] -> Map Domain [a]
 partitionQualified = foldr add mempty

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

@@ -40,6 +40,7 @@ module Wire.API.Conversation
 
     -- * invite
     Invite (..),
+    InviteQualified (..),
     newInvite,
 
     -- * update
@@ -74,9 +75,11 @@ import qualified Data.Aeson as A
 import qualified Data.Aeson.Types as A
 import Data.Id
 import Data.Json.Util
+import Data.List.NonEmpty (NonEmpty)
 import Data.List1
 import Data.Misc
 import Data.Proxy (Proxy (Proxy))
+import Data.Qualified (Qualified)
 import Data.Schema
 import Data.String.Conversions (cs)
 import qualified Data.Swagger as S
@@ -541,14 +544,30 @@ instance FromJSON ConvTeamInfo where
 --------------------------------------------------------------------------------
 -- invite
 
-data Invite = Invite
+data Invite = Invite -- Deprecated, use InviteQualified (and maybe rename?)
   { invUsers :: List1 UserId,
     -- | This role name is to be applied to all users
     invRoleName :: RoleName
   }
   deriving stock (Eq, Show, Generic)
   deriving (Arbitrary) via (GenericUniform Invite)
 
+data InviteQualified = InviteQualified
+  { invQUsers :: NonEmpty (Qualified UserId),
+    -- | This role name is to be applied to all users
+    invQRoleName :: RoleName
+  }
+  deriving stock (Eq, Show, Generic)
+  deriving (Arbitrary) via (GenericUniform InviteQualified)
+  deriving (ToJSON, FromJSON, S.ToSchema) via (Schema InviteQualified)
+
+instance ToSchema InviteQualified where
+  schema =
+    object "InviteQualified" $
+      InviteQualified
+        <$> invQUsers .= field "qualified_users" (nonEmptyArray schema)
+        <*> invQRoleName .= (field "conversation_role" schema <|> pure roleNameWireAdmin)
+
 newInvite :: List1 UserId -> Invite
 newInvite us = Invite us roleNameWireAdmin
 

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

@@ -47,6 +47,7 @@ import Data.Aeson (FromJSON (..), ToJSON (..))
 import qualified Data.Aeson as A
 import Data.Id
 import Data.Json.Util
+import Data.Qualified
 import Data.Schema
 import qualified Data.Swagger as S
 import qualified Data.Swagger.Build.Api as Doc
@@ -169,26 +170,31 @@ newtype MutedStatus = MutedStatus {fromMutedStatus :: Int32}
   deriving (FromJSON, ToJSON, S.ToSchema) via Schema MutedStatus
 
 data OtherMember = OtherMember
-  { omId :: UserId,
+  { omQualifiedId :: Qualified UserId,
     omService :: Maybe ServiceRef,
     omConvRoleName :: RoleName
   }
   deriving stock (Eq, Show, Generic)
   deriving (Arbitrary) via (GenericUniform OtherMember)
+  deriving (FromJSON, ToJSON, S.ToSchema) via Schema OtherMember
+
+omId :: OtherMember -> UserId
+omId = qUnqualified . omQualifiedId
 
 instance ToSchema OtherMember where
   schema =
     object "OtherMember" $
       OtherMember
-        <$> omId .= field "id" schema
+        <$> omQualifiedId .= field "qualified_id" schema
+        <* omId .= optional (field "id" schema)
         <*> omService .= opt (fieldWithDocModifier "service" (description ?~ desc) schema)
         <*> omConvRoleName .= (field "conversation_role" schema <|> pure roleNameWireAdmin)
         <* const (0 :: Int) .= optional (fieldWithDocModifier "status" (description ?~ "deprecated") schema) -- TODO: remove
     where
       desc = "The reference to the owning service, if the member is a 'bot'."
 
 instance Ord OtherMember where
-  compare a b = compare (omId a) (omId b)
+  compare a b = compare (omQualifiedId a) (omQualifiedId b)
 
 modelOtherMember :: Doc.Model
 modelOtherMember = Doc.defineModel "OtherMember" $ do
@@ -198,22 +204,6 @@ modelOtherMember = Doc.defineModel "OtherMember" $ do
     Doc.description "The reference to the owning service, if the member is a 'bot'."
     Doc.optional
 
-instance ToJSON OtherMember where
-  toJSON m =
-    A.object $
-      "id" A..= omId m
-        # "status" A..= (0 :: Int) -- TODO: Remove
-        # "service" A..= omService m
-        # "conversation_role" A..= omConvRoleName m
-        # []
-
-instance FromJSON OtherMember where
-  parseJSON = A.withObject "other-member" $ \o ->
-    OtherMember
-      <$> o A..: "id"
-      <*> o A..:? "service"
-      <*> o A..:? "conversation_role" A..!= roleNameWireAdmin
-
 --------------------------------------------------------------------------------
 -- Member Updates
 

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

@@ -68,6 +68,7 @@ import Data.Aeson.Types (Parser)
 import qualified Data.HashMap.Strict as HashMap
 import Data.Id
 import Data.Json.Util (ToJSONObject (toJSONObject), UTCTimeMillis (fromUTCTimeMillis), toUTCTimeMillis, (#))
+import qualified Data.Swagger as S
 import qualified Data.Swagger.Build.Api as Doc
 import Data.Time
 import Imports
@@ -92,6 +93,10 @@ data Event = Event
   }
   deriving stock (Eq, Show, Generic)
 
+-- TODO: Merge work from https://github.com/wireapp/wire-server/pull/1482
+instance S.ToSchema Event where
+  declareNamedSchema _ = pure $ S.NamedSchema Nothing mempty
+
 modelEvent :: Doc.Model
 modelEvent = Doc.defineModel "Event" $ do
   Doc.description "Event data"

libs/wire-api/test/golden/testObject_BotConvView_provider_1.json

@@ -1 +1 @@
-{"members":[{"status":0,"service":{"id":"00000001-0000-0000-0000-000100000000","provider":"00000000-0000-0000-0000-000000000001"},"conversation_role":"t4vroye869mch4","id":"00000001-0000-0000-0000-000000000000"},{"status":0,"conversation_role":"bi8z5mc78lg3bqqk29yd36x2_haz6b05t6ybil8p7zbkj","id":"00000000-0000-0000-0000-000000000001"},{"status":0,"service":{"id":"00000000-0000-0000-0000-000000000001","provider":"00000001-0000-0000-0000-000100000000"},"conversation_role":"ncz23zan6fw786izkcx","id":"00000000-0000-0000-0000-000100000001"},{"status":0,"service":{"id":"00000001-0000-0001-0000-000100000000","provider":"00000001-0000-0000-0000-000100000001"},"conversation_role":"_brjrjrldhybr251gl72y3_nqqwhdh8k2c0oznqgiwrhzf0szdd15laruwrrm640pa_z8eg5d2mvm_nppm51rszf20dwpshy7ushykyavtq5dq2mwdqqcpv_nb7lkl","id":"00000000-0000-0000-0000-000100000000"},{"status":0,"service":{"id":"00000001-0000-0000-0000-000100000000","provider":"00000000-0000-0000-0000-000000000001"},"conversation_role":"jpy159h7vqij1p08dgsehcpyxg6_ovkcpjruqg6xp8b4lpegp7qrfr_qsyoo3qnngi7btjxrt6bbjcfmit2p6g_j5abxj4o5xliz","id":"00000001-0000-0001-0000-000100000001"}],"id":"00000006-0000-0012-0000-001900000009"}
+{"members":[{"status":0,"service":{"id":"00000001-0000-0000-0000-000100000000","provider":"00000000-0000-0000-0000-000000000001"},"conversation_role":"t4vroye869mch4","qualified_id":{"domain":"golden.example.com","id":"00000001-0000-0000-0000-000000000000"},"id":"00000001-0000-0000-0000-000000000000"},{"status":0,"conversation_role":"bi8z5mc78lg3bqqk29yd36x2_haz6b05t6ybil8p7zbkj","qualified_id":{"domain":"golden.example.com","id":"00000000-0000-0000-0000-000000000001"},"id":"00000000-0000-0000-0000-000000000001"},{"status":0,"service":{"id":"00000000-0000-0000-0000-000000000001","provider":"00000001-0000-0000-0000-000100000000"},"conversation_role":"ncz23zan6fw786izkcx","qualified_id":{"domain":"golden.example.com","id":"00000000-0000-0000-0000-000100000001"},"id":"00000000-0000-0000-0000-000100000001"},{"status":0,"service":{"id":"00000001-0000-0001-0000-000100000000","provider":"00000001-0000-0000-0000-000100000001"},"conversation_role":"_brjrjrldhybr251gl72y3_nqqwhdh8k2c0oznqgiwrhzf0szdd15laruwrrm640pa_z8eg5d2mvm_nppm51rszf20dwpshy7ushykyavtq5dq2mwdqqcpv_nb7lkl","qualified_id":{"domain":"golden.example.com","id":"00000000-0000-0000-0000-000100000000"},"id":"00000000-0000-0000-0000-000100000000"},{"status":0,"service":{"id":"00000001-0000-0000-0000-000100000000","provider":"00000000-0000-0000-0000-000000000001"},"conversation_role":"jpy159h7vqij1p08dgsehcpyxg6_ovkcpjruqg6xp8b4lpegp7qrfr_qsyoo3qnngi7btjxrt6bbjcfmit2p6g_j5abxj4o5xliz","qualified_id":{"domain":"golden.example.com","id":"00000001-0000-0001-0000-000100000001"},"id":"00000001-0000-0001-0000-000100000001"}],"id":"00000006-0000-0012-0000-001900000009"}

libs/wire-api/test/golden/testObject_BotConvView_provider_10.json

@@ -1 +1 @@
-{"members":[{"status":0,"conversation_role":"mofz","id":"00000002-0000-0000-0000-000000000001"}],"name":"􃙓#𫸜𨖜","id":"00000001-0000-000b-0000-001300000020"}
+{"members":[{"status":0,"conversation_role":"mofz","qualified_id":{"domain":"golden.example.com","id":"00000002-0000-0000-0000-000000000001"},"id":"00000002-0000-0000-0000-000000000001"}],"name":"􃙓#𫸜𨖜","id":"00000001-0000-000b-0000-001300000020"}

libs/wire-api/test/golden/testObject_BotConvView_provider_13.json

@@ -1 +1 @@
-{"members":[{"status":0,"service":{"id":"00000000-0000-0001-0000-000000000000","provider":"00000001-0000-0001-0000-000100000000"},"conversation_role":"7argokhlu22zw7um1_4anu2_q13ldqtz2mgeszjizp9qrr8m1wn1yy0lv1bta1cjhxjp_du_5vaatnt94upydlr0v2xqx12ivlbva5eza4c","id":"00000001-0000-0000-0000-000100000001"},{"status":0,"service":{"id":"00000001-0000-0000-0000-000000000001","provider":"00000001-0000-0001-0000-000000000000"},"conversation_role":"_tzj3fgev1_6jgm5uuhbqnskv04r7k0bkk6si04ylakfznc1qttv6pv98l07_afzg_r_hw2xszllzu49u7x9eeu2hamh4ew2g","id":"00000000-0000-0000-0000-000000000001"},{"status":0,"conversation_role":"x8k0vqtenaqv3tj5elrnuwxuhgjl0iugwd3v0uk_8sejey5lgyq4fr746msrtk4eqxl7r3rvaljdyrmjtqvfisx0ml512oneq3bbh7mwr_k3f36od70t3ttj_dc","id":"00000001-0000-0000-0000-000100000001"},{"status":0,"service":{"id":"00000001-0000-0000-0000-000000000000","provider":"00000001-0000-0001-0000-000100000001"},"conversation_role":"89hefsk","id":"00000001-0000-0001-0000-000000000000"},{"status":0,"service":{"id":"00000000-0000-0000-0000-000000000001","provider":"00000001-0000-0000-0000-000100000000"},"conversation_role":"65gk5l2gvypqgykq35etz1df_7","id":"00000000-0000-0001-0000-000100000000"}],"name":"O$:","id":"0000000c-0000-0014-0000-001a00000017"}
+{"members":[{"status":0,"service":{"id":"00000000-0000-0001-0000-000000000000","provider":"00000001-0000-0001-0000-000100000000"},"conversation_role":"7argokhlu22zw7um1_4anu2_q13ldqtz2mgeszjizp9qrr8m1wn1yy0lv1bta1cjhxjp_du_5vaatnt94upydlr0v2xqx12ivlbva5eza4c","qualified_id":{"domain":"golden.example.com","id":"00000001-0000-0000-0000-000100000001"},"id":"00000001-0000-0000-0000-000100000001"},{"status":0,"service":{"id":"00000001-0000-0000-0000-000000000001","provider":"00000001-0000-0001-0000-000000000000"},"conversation_role":"_tzj3fgev1_6jgm5uuhbqnskv04r7k0bkk6si04ylakfznc1qttv6pv98l07_afzg_r_hw2xszllzu49u7x9eeu2hamh4ew2g","qualified_id":{"domain":"golden.example.com","id":"00000000-0000-0000-0000-000000000001"},"id":"00000000-0000-0000-0000-000000000001"},{"status":0,"conversation_role":"x8k0vqtenaqv3tj5elrnuwxuhgjl0iugwd3v0uk_8sejey5lgyq4fr746msrtk4eqxl7r3rvaljdyrmjtqvfisx0ml512oneq3bbh7mwr_k3f36od70t3ttj_dc","qualified_id":{"domain":"golden.example.com","id":"00000001-0000-0000-0000-000100000001"},"id":"00000001-0000-0000-0000-000100000001"},{"status":0,"service":{"id":"00000001-0000-0000-0000-000000000000","provider":"00000001-0000-0001-0000-000100000001"},"conversation_role":"89hefsk","qualified_id":{"domain":"golden.example.com","id":"00000001-0000-0001-0000-000000000000"},"id":"00000001-0000-0001-0000-000000000000"},{"status":0,"service":{"id":"00000000-0000-0000-0000-000000000001","provider":"00000001-0000-0000-0000-000100000000"},"conversation_role":"65gk5l2gvypqgykq35etz1df_7","qualified_id":{"domain":"golden.example.com","id":"00000000-0000-0001-0000-000100000000"},"id":"00000000-0000-0001-0000-000100000000"}],"name":"O$:","id":"0000000c-0000-0014-0000-001a00000017"}

libs/wire-api/test/golden/testObject_BotConvView_provider_14.json

@@ -1 +1 @@
-{"members":[{"status":0,"service":{"id":"00000000-0000-0001-0000-000000000001","provider":"00000001-0000-0001-0000-000100000000"},"conversation_role":"0oabkv381mgh54t8zcgvwg19ru1qbjub_0i8gidad9j7","id":"00000000-0000-0001-0000-000000000000"},{"status":0,"service":{"id":"00000000-0000-0000-0000-000100000001","provider":"00000000-0000-0001-0000-000100000001"},"conversation_role":"ns3h9jzrfx8_o","id":"00000001-0000-0000-0000-000000000000"},{"status":0,"service":{"id":"00000000-0000-0000-0000-000100000001","provider":"00000001-0000-0000-0000-000000000000"},"conversation_role":"_5kwpvh_ud02gj31kh4wz0ev55qmfoiknvib6auu8nkufhe1t63871_0k52ptbydxbwiw8z0fsht6oigc1geezhsw7uosy88xhvxf4iorzc9_ji2v5760f434aem0ti","id":"00000001-0000-0000-0000-000100000001"}],"name":"T","id":"0000001f-0000-0012-0000-000100000010"}
+{"members":[{"status":0,"service":{"id":"00000000-0000-0001-0000-000000000001","provider":"00000001-0000-0001-0000-000100000000"},"conversation_role":"0oabkv381mgh54t8zcgvwg19ru1qbjub_0i8gidad9j7","qualified_id":{"domain":"golden.example.com","id":"00000000-0000-0001-0000-000000000000"},"id":"00000000-0000-0001-0000-000000000000"},{"status":0,"service":{"id":"00000000-0000-0000-0000-000100000001","provider":"00000000-0000-0001-0000-000100000001"},"conversation_role":"ns3h9jzrfx8_o","qualified_id":{"domain":"golden.example.com","id":"00000001-0000-0000-0000-000000000000"},"id":"00000001-0000-0000-0000-000000000000"},{"status":0,"service":{"id":"00000000-0000-0000-0000-000100000001","provider":"00000001-0000-0000-0000-000000000000"},"conversation_role":"_5kwpvh_ud02gj31kh4wz0ev55qmfoiknvib6auu8nkufhe1t63871_0k52ptbydxbwiw8z0fsht6oigc1geezhsw7uosy88xhvxf4iorzc9_ji2v5760f434aem0ti","qualified_id":{"domain":"golden.example.com","id":"00000001-0000-0000-0000-000100000001"},"id":"00000001-0000-0000-0000-000100000001"}],"name":"T","id":"0000001f-0000-0012-0000-000100000010"}

libs/wire-api/test/golden/testObject_BotConvView_provider_15.json

@@ -1 +1 @@
-{"members":[{"status":0,"service":{"id":"00000000-0000-0001-0000-000000000000","provider":"00000000-0000-0001-0000-000000000000"},"conversation_role":"614zvjitytbb_zu","id":"00000000-0000-0000-0000-000100000000"}],"name":"","id":"00000009-0000-000a-0000-00010000000b"}
+{"members":[{"status":0,"service":{"id":"00000000-0000-0001-0000-000000000000","provider":"00000000-0000-0001-0000-000000000000"},"conversation_role":"614zvjitytbb_zu","qualified_id":{"domain":"golden.example.com","id":"00000000-0000-0000-0000-000100000000"},"id":"00000000-0000-0000-0000-000100000000"}],"name":"","id":"00000009-0000-000a-0000-00010000000b"}