Comments and better names

wireapp · Jan 31, 2024 · 92d8977 · 92d8977
1 parent 92a9e1f
commit 92d8977
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/libs/wire-subsystems/src/Wire/NotificationSubsystem/Internal.hs b/libs/wire-subsystems/src/Wire/NotificationSubsystem/Internal.hs
@@ -35,10 +35,14 @@ data Push = Push
 
 makeLenses ''Push
 
+-- | This subsystem governs mechanisms to send notifications to users.
 data NotificationSubsystem m a where
+  -- | Bulk push notifications
   PushNotifications :: [Push] -> NotificationSubsystem m ()
+  -- | Bulk push notifications, but slowly. This should be used when there are
+  -- many notifications to be sent which could cause too much resource usage.
   PushNotificationsSlowly :: [Push] -> NotificationSubsystem m ()
-  UserDeleted :: UserId -> NotificationSubsystem m ()
+  CleanupUser :: UserId -> NotificationSubsystem m ()
   UnregisterPushClient :: UserId -> ClientId -> NotificationSubsystem m ()
   GetPushTokens :: UserId -> NotificationSubsystem m [PushToken]
 

diff --git a/libs/wire-subsystems/src/Wire/NotificationSubsystem/Interpreter.hs b/libs/wire-subsystems/src/Wire/NotificationSubsystem/Interpreter.hs
@@ -34,7 +34,7 @@ runNotificationSubsystemGundeck ::
 runNotificationSubsystemGundeck cfg = interpret $ \case
   PushNotifications ps -> runInputConst cfg $ pushImpl ps
   PushNotificationsSlowly ps -> runInputConst cfg $ pushSlowlyImpl ps
-  UserDeleted uid -> GundeckAPIAccess.userDeleted uid
+  CleanupUser uid -> GundeckAPIAccess.userDeleted uid
   UnregisterPushClient uid cid -> GundeckAPIAccess.unregisterPushClient uid cid
   GetPushTokens uid -> GundeckAPIAccess.getPushTokens uid
 

diff --git a/services/brig/src/Brig/IO/Intra.hs b/services/brig/src/Brig/IO/Intra.hs
@@ -701,7 +701,7 @@ rmUser usr asts = do
     remote "gundeck"
       . field "user" (toByteString usr)
       . msg (val "remove user")
-  NotificationSubsystem.userDeleted usr
+  NotificationSubsystem.cleanupUser usr
   Log.debug $
     remote "galley"
       . field "user" (toByteString usr)