wireapp · akshaymankar · Sep 19, 2023 · Sep 13, 2023 · Sep 13, 2023 · Sep 13, 2023
diff --git a/changelog.d/1-api-changes/WPB-3611 b/changelog.d/1-api-changes/WPB-3611
diff --git a/changelog.d/1-api-changes/WPB-4668-disable-defederation b/changelog.d/1-api-changes/WPB-4668-disable-defederation
@@ -0,0 +1 @@
+Remove de-federation (to avoid a scalability issue).
diff --git a/changelog.d/3-bug-fixes/duplicate-member-notifications b/changelog.d/3-bug-fixes/duplicate-member-notifications
diff --git a/changelog.d/6-federation/WPB-3611 b/changelog.d/6-federation/WPB-3611
diff --git a/docs/src/understand/configure-federation.md b/docs/src/understand/configure-federation.md
@@ -457,13 +457,8 @@ the sysadmin:
 
 * [`PUT`](https://staging-nginz-https.zinfra.io/api-internal/swagger-ui/brig/#/brig/put_i_federation_remotes__domain_)
 
-* [`DELETE`](https://staging-nginz-https.zinfra.io/api-internal/swagger-ui/brig/#/brig/delete_i_federation_remotes__domain_)
-  - **WARNING:** If you delete a connection, all users from that
-   remote will be removed from local conversations, and all
-   conversations hosted by that remote will be removed from the local
-   backend.  Connections between local and remote users that are
-   removed will be archived, and can be re-established should you
-   decide to add the same backend later.
+* **NOTE:** De-federating (`DELETE`) has been removed from the API to
+   avoid a scalability issue.  Watch out for a fix in the changelog!
 
 The `remotes` list looks like this:
 

diff --git a/integration/integration.cabal b/integration/integration.cabal
@@ -105,7 +105,6 @@ library
     Test.Brig
     Test.Client
     Test.Conversation
-    Test.Defederation
     Test.Demo
     Test.Federation
     Test.Federator

diff --git a/integration/test/API/GalleyInternal.hs b/integration/test/API/GalleyInternal.hs
@@ -51,12 +51,3 @@ getFederationStatus user domains =
         submit
           "GET"
           $ req & addJSONObject ["domains" .= domainList]
-
-deleteFederationDomain ::
-  ( HasCallStack
-  ) =>
-  String ->
-  App Response
-deleteFederationDomain domain = do
-  req <- rawBaseRequest OwnDomain Galley Unversioned $ joinHttpPath ["i", "federation", domain]
-  submit "DELETE" req
diff --git a/integration/test/Test/Conversation.hs b/integration/test/Test/Conversation.hs
@@ -221,17 +221,7 @@ testDefederationGroupConversation = do
             r.status `shouldMatchInt` 404
 
         -- assert federation.delete event is sent twice
-        void $
-          awaitNMatches
-            2
-            3
-            ( \n -> do
-                correctType <- nPayload n %. "type" `isEqual` "federation.delete"
-                if correctType
-                  then nPayload n %. "domain" `isEqual` domainB
-                  else pure False
-            )
-            ws
+        void $ awaitNMatches 2 3 (\n -> nPayload n %. "type" `isEqual` "federation.delete") ws
 
       -- assert no conversation.delete event is sent to uA
       eventPayloads <-

diff --git a/integration/test/Test/Defederation.hs b/integration/test/Test/Defederation.hs
diff --git a/libs/schema-profunctor/src/Data/Schema.hs b/libs/schema-profunctor/src/Data/Schema.hs
@@ -62,7 +62,6 @@ module Data.Schema
     fieldOverF,
     fieldWithDocModifierF,
     array,
-    pair,
     set,
     nonEmptyArray,
     map_,
@@ -464,24 +463,6 @@ array sch = SchemaP (SchemaDoc s) (SchemaIn r) (SchemaOut w)
     s = mkArray (schemaDoc sch)
     w x = A.Array . V.fromList <$> mapM (schemaOut sch) x
 
--- | A schema for a JSON pair.
--- This is serialised as JSON array of exactly 2 elements
--- of the same type. Any more or less is an error.
-pair ::
-  (HasArray ndoc doc, HasName ndoc) =>
-  ValueSchema ndoc a ->
-  ValueSchema doc (a, a)
-pair sch = SchemaP (SchemaDoc s) (SchemaIn r) (SchemaOut w)
-  where
-    name = maybe "pair" ("pair of " <>) (getName (schemaDoc sch))
-    r = A.withArray (T.unpack name) $ \arr -> do
-      l <- mapM (schemaIn sch) $ V.toList arr
-      case l of
-        [a, b] -> pure (a, b)
-        _ -> fail $ "Expected exactly 2 elements, but got " <> show (length l)
-    s = mkArray (schemaDoc sch)
-    w (a, b) = A.Array . V.fromList <$> mapM (schemaOut sch) [a, b]
-
 set ::
   (HasArray ndoc doc, HasName ndoc, Ord a) =>
   ValueSchema ndoc a ->

diff --git a/libs/wire-api-federation/src/Wire/API/Federation/API/Galley.hs b/libs/wire-api-federation/src/Wire/API/Federation/API/Galley.hs
@@ -131,7 +131,6 @@ type GalleyApi =
            TypingDataUpdateRequest
            TypingDataUpdateResponse
     :<|> FedEndpoint "on-typing-indicator-updated" TypingDataUpdated EmptyResponse
-    :<|> FedEndpoint "on-connection-removed" Domain EmptyResponse
 
 data TypingDataUpdateRequest = TypingDataUpdateRequest
   { typingStatus :: TypingStatus,

diff --git a/libs/wire-api/src/Wire/API/Event/Federation.hs b/libs/wire-api/src/Wire/API/Event/Federation.hs
@@ -1,12 +1,9 @@
-{-# LANGUAGE TemplateHaskell #-}
-
 module Wire.API.Event.Federation
   ( Event (..),
+    EventType (..),
   )
 where
 
-import Control.Arrow ((&&&))
-import Control.Lens (makePrisms)
 import Data.Aeson (FromJSON, ToJSON)
 import Data.Aeson qualified as A
 import Data.Aeson.KeyMap qualified as KeyMap
@@ -15,71 +12,41 @@ import Data.Json.Util (ToJSONObject (toJSONObject))
 import Data.Schema
 import Data.Swagger qualified as S
 import Imports
-import Test.QuickCheck.Gen
 import Wire.Arbitrary
 
-data Event
-  = FederationDelete Domain
-  | FederationConnectionRemoved (Domain, Domain)
-  deriving stock (Eq, Show, Generic)
-
-$(makePrisms ''Event)
+data Event = Event
+  { _eventType :: EventType,
+    _eventDomain :: Domain
+  }
+  deriving (Eq, Show, Ord, Generic)
 
 instance Arbitrary Event where
   arbitrary =
-    oneof
-      [ FederationDelete <$> arbitrary,
-        FederationConnectionRemoved <$> arbitrary
-      ]
+    Event
+      <$> arbitrary
+      <*> arbitrary
 
 data EventType
-  = FederationTypeDelete
-  | FederationTypeConnectionRemoved
-  deriving (Eq, Show, Ord, Enum, Bounded, Generic)
+  = FederationDelete
+  deriving (Eq, Show, Ord, Generic)
   deriving (Arbitrary) via (GenericUniform EventType)
   deriving (A.FromJSON, A.ToJSON, S.ToSchema) via Schema EventType
 
 instance ToSchema EventType where
   schema =
-    enum @Text "FederationEventType" $
+    enum @Text "EventType" $
       mconcat
-        [ element "federation.delete" FederationTypeDelete,
-          element "federation.connectionRemoved" FederationTypeConnectionRemoved
+        [ element "federation.delete" FederationDelete
         ]
 
-eventType :: Event -> EventType
-eventType (FederationDelete _) = FederationTypeDelete
-eventType (FederationConnectionRemoved _) = FederationTypeConnectionRemoved
-
-taggedEventDataSchema :: ObjectSchema SwaggerDoc (EventType, Event)
-taggedEventDataSchema =
-  bind
-    (fst .= field "type" schema)
-    -- The fields we need to look at change based on the event
-    -- type, so we need to dispatch here to get monadic-ish behaviour.
-    --
-    -- federation.delete is expecting a "domain" field that contains a bare domain string.
-    -- federation.connectionRemoved is expecting a "domains" field that contains exactly a pair of domains in a list
-    ( snd .= dispatch dataSchema
-    )
-  where
-    dataSchema :: EventType -> ObjectSchema SwaggerDoc Event
-    dataSchema FederationTypeDelete = tag _FederationDelete deleteSchema
-    dataSchema FederationTypeConnectionRemoved = tag _FederationConnectionRemoved connectionRemovedSchema
-
--- These schemas have different fields they are targeting.
-deleteSchema :: ObjectSchema SwaggerDoc Domain
-deleteSchema = field "domain" schema
-
-connectionRemovedSchema :: ObjectSchema SwaggerDoc (Domain, Domain)
-connectionRemovedSchema = field "domains" (pair schema)
-
--- Schemas for the events, as they have different structures.
 eventObjectSchema :: ObjectSchema SwaggerDoc Event
-eventObjectSchema = snd <$> (eventType &&& id) .= taggedEventDataSchema
+eventObjectSchema =
+  Event
+    <$> _eventType .= field "type" schema
+    <*> _eventDomain .= field "domain" schema
 
 instance ToSchema Event where
-  schema = object "FederationEvent" eventObjectSchema
+  schema = object "Event" eventObjectSchema
 
 instance ToJSONObject Event where
   toJSONObject =

diff --git a/libs/wire-api/src/Wire/API/FederationUpdate.hs b/libs/wire-api/src/Wire/API/FederationUpdate.hs
@@ -2,21 +2,18 @@ module Wire.API.FederationUpdate
   ( syncFedDomainConfigs,
     SyncFedDomainConfigsCallback (..),
     emptySyncFedDomainConfigsCallback,
-    deleteFederationRemoteGalley,
-    fetch,
   )
 where
 
 import Control.Concurrent.Async
 import Control.Exception
 import Control.Retry qualified as R
-import Data.Domain
 import Data.Set qualified as Set
 import Data.Text
 import Data.Typeable (cast)
 import Imports
 import Network.HTTP.Client (defaultManagerSettings, newManager)
-import Servant.Client (BaseUrl (BaseUrl), ClientEnv (ClientEnv), ClientError, ClientM, Scheme (Http), runClientM)
+import Servant.Client (BaseUrl (BaseUrl), ClientEnv (ClientEnv), ClientError, Scheme (Http), runClientM)
 import Servant.Client.Internal.HttpClient (defaultMakeClientRequest)
 import System.Logger qualified as L
 import Util.Options
@@ -34,9 +31,6 @@ syncFedDomainConfigs (Endpoint h p) log' cb = do
   updateDomainsThread <- async $ loop log' clientEnv cb ioref
   pure (ioref, updateDomainsThread)
 
-deleteFedRemoteGalley :: Domain -> ClientM ()
-deleteFedRemoteGalley dom = namedClient @IAPI.API @"delete-federation-remote-from-galley" dom
-
 -- | Initial function for getting the set of domains from brig, and an update interval
 initialize :: L.Logger -> ClientEnv -> IO FederationDomainConfigs
 initialize logger clientEnv =
@@ -56,9 +50,6 @@ initialize logger clientEnv =
         Just c -> pure c
         Nothing -> throwIO $ ErrorCall "*** Failed to reach brig for federation setup, giving up!"
 
-deleteFederationRemoteGalley :: Domain -> ClientEnv -> IO (Either ClientError ())
-deleteFederationRemoteGalley dom = runClientM $ deleteFedRemoteGalley dom
-
 loop :: L.Logger -> ClientEnv -> SyncFedDomainConfigsCallback -> IORef FederationDomainConfigs -> IO ()
 loop logger clientEnv (SyncFedDomainConfigsCallback callback) env = forever $
   catch go $ \(e :: SomeException) -> do

diff --git a/libs/wire-api/src/Wire/API/Routes/Internal/Brig.hs b/libs/wire-api/src/Wire/API/Routes/Internal/Brig.hs
@@ -764,40 +764,10 @@ type FederationRemotesAPI =
                :> ReqBody '[JSON] FederationDomainConfig
                :> Put '[JSON] ()
            )
-    :<|> Named
-           "delete-federation-remotes"
-           ( Description FederationRemotesAPIDescription
-               :> Description FederationRemotesAPIDeleteDescription
-               :> "federation"
-               :> "remotes"
-               :> Capture "domain" Domain
-               :> Delete '[JSON] ()
-           )
-    -- This is nominally similar to delete-federation-remotes,
-    -- but is called from Galley to delete the one-on-one coversations.
-    -- This is needed as Galley doesn't have access to the tables
-    -- that hold these values. We don't want these deletes to happen
-    -- in delete-federation-remotes as brig might fall over and leave
-    -- some records hanging around. Galley uses a Rabbit queue to track
-    -- what is has done and can recover from a service falling over.
-    :<|> Named
-           "delete-federation-remote-from-galley"
-           ( Description FederationRemotesAPIDescription
-               :> Description FederationRemotesAPIDeleteDescription
-               :> "federation"
-               :> "remote"
-               :> Capture "domain" Domain
-               :> "galley"
-               :> Delete '[JSON] ()
-           )
 
 type FederationRemotesAPIDescription =
   "See https://docs.wire.com/understand/federation/backend-communication.html#configuring-remote-connections for background. "
 
-type FederationRemotesAPIDeleteDescription =
-  "**WARNING!** If you remove a remote connection, all users from that remote will be removed from local conversations, and all \
-  \group conversations hosted by that remote will be removed from the local backend. This cannot be reverted! "
-
 swaggerDoc :: Swagger
 swaggerDoc =
   toSwagger (Proxy @API)