Refactor CSV export

changelog.d/1-api-changes/add-columns-to-export

@@ -0,0 +1 @@
+The team CSV export endpoint has gained two extra columns: `last_active` and `status`. The streaming behaviour has also been improved.

integration/integration.cabal

@@ -100,6 +100,7 @@ library
     API.GundeckInternal
     API.Nginz
     API.Spar
+    API.Stern
     MLS.Util
     Notifications
     RunAllTests

integration/test/API/BrigInternal.hs

@@ -303,3 +303,29 @@ getPasswordResetCode :: (HasCallStack, MakesValue domain) => domain -> String ->
 getPasswordResetCode domain email = do
   req <- baseRequest domain Brig Unversioned "i/users/password-reset-code"
   submit "GET" $ req & addQueryParams [("email", email)]
+
+data PutSSOId = PutSSOId
+  { scimExternalId :: Maybe String,
+    subject :: Maybe String,
+    tenant :: Maybe String
+  }
+
+instance Default PutSSOId where
+  def =
+    PutSSOId
+      { scimExternalId = Nothing,
+        subject = Nothing,
+        tenant = Nothing
+      }
+
+putSSOId :: (HasCallStack, MakesValue user) => user -> PutSSOId -> App Response
+putSSOId user args = do
+  uid <- objId user
+  req <- baseRequest user Brig Unversioned (joinHttpPath ["i", "users", uid, "sso-id"])
+  submit "PUT" $
+    req
+      & addJSONObject
+        [ "scim_external_id" .= args.scimExternalId,
+          "subject" .= args.subject,
+          "tenant" .= args.tenant
+        ]

integration/test/API/Galley.hs

@@ -727,3 +727,9 @@ getTeamNotifications user mSince =
   baseRequest user Galley Versioned "teams/notifications" >>= \req ->
     submit "GET"
       $ addQueryParams [("since", since) | since <- maybeToList mSince] req
+
+-- | https://staging-nginz-https.zinfra.io/v6/api/swagger-ui/#/default/get_teams__tid__members_csv
+getTeamMembersCsv :: (HasCallStack, MakesValue user) => user -> String -> App Response
+getTeamMembersCsv user tid = do
+  req <- baseRequest user Galley Versioned (joinHttpPath ["teams", tid, "members", "csv"])
+  submit "GET" req

integration/test/API/Stern.hs

@@ -0,0 +1,8 @@
+module API.Stern where
+
+import Testlib.Prelude
+
+getTeamActivity :: (HasCallStack, MakesValue domain) => domain -> String -> App Response
+getTeamActivity domain tid =
+  baseRequest domain Stern Unversioned (joinHttpPath ["team-activity-info", tid])
+    >>= submit "GET"

integration/test/SetupHelpers.hs

@@ -43,26 +43,35 @@ createTeam :: (HasCallStack, MakesValue domain) => domain -> Int -> App (Value,
 createTeam domain memberCount = do
   owner <- createUser domain def {team = True} >>= getJSON 201
   tid <- owner %. "team" & asString
-  members <- for [2 .. memberCount] $ \_ -> createTeamMember owner tid
+  members <- for [2 .. memberCount] $ \_ -> createTeamMember owner def
   pure (owner, tid, members)
 
-createTeamMember ::
-  (HasCallStack, MakesValue inviter) =>
-  inviter ->
-  String ->
-  App Value
-createTeamMember inviter tid = createTeamMemberWithRole inviter tid "member"
+data CreateTeamMember = CreateTeamMember
+  { role :: String
+  }
 
-createTeamMemberWithRole ::
+instance Default CreateTeamMember where
+  def = CreateTeamMember {role = "member"}
+
+createTeamMember ::
   (HasCallStack, MakesValue inviter) =>
   inviter ->
-  String ->
-  String ->
+  CreateTeamMember ->
   App Value
-createTeamMemberWithRole inviter _ role = do
+createTeamMember inviter args = do
   newUserEmail <- randomEmail
-  invitation <- postInvitation inviter (PostInvitation (Just newUserEmail) (Just role)) >>= getJSON 201
-  invitationCode <- getInvitationCode inviter invitation >>= getJSON 200 >>= (%. "code") & asString
+  invitation <-
+    postInvitation
+      inviter
+      def
+        { email = Just newUserEmail,
+          role = Just args.role
+        }
+      >>= getJSON 201
+  invitationCode <-
+    (getInvitationCode inviter invitation >>= getJSON 200)
+      %. "code"
+      & asString
   let body =
         AddUser
           { name = Just newUserEmail,

integration/test/Test/Client.hs

@@ -6,10 +6,12 @@ import API.Brig
 import qualified API.Brig as API
 import API.BrigCommon
 import API.Gundeck
+import API.Stern
 import Control.Lens hiding ((.=))
 import Control.Monad.Codensity
 import Control.Monad.Reader
 import Data.Aeson hiding ((.=))
+import qualified Data.ByteString.Char8 as B8
 import Data.ProtoLens.Labels ()
 import Data.Time.Clock.POSIX
 import Data.Time.Clock.System
@@ -42,6 +44,30 @@ testClientLastActive = do
       <$> parseTimeM False defaultTimeLocale "%Y-%m-%dT%H:%M:%SZ" tm1
   assertBool "last_active is earlier than expected" $ ts1 >= now
 
+testTeamActivity :: (HasCallStack) => App ()
+testTeamActivity = do
+  (alice, tid, [bob, charlie]) <- createTeam OwnDomain 3
+  [alice1, _alice2] <- replicateM 2 $ addClient alice def >>= getJSON 201
+  [_bob1, _bob2] <- replicateM 2 $ addClient bob def >>= getJSON 201
+  charlie1 <- addClient charlie def >>= getJSON 201
+
+  for_ [(alice, alice1), (charlie, charlie1)] $ \(u, cl) -> do
+    clientId <- cl %. "id" & asString
+    void $ getNotifications u def {client = Just clientId}
+
+  let row (u, t) = do
+        uid <- u %. "id" & asString
+        pure (uid, t)
+
+  expectedRows <- sort <$> traverse row [(alice, True), (bob, False), (charlie, True)]
+
+  bindResponse (getTeamActivity alice tid) $ \resp -> do
+    resp.status `shouldMatchInt` 200
+    for_ (zip (sort (B8.lines resp.body)) expectedRows) $ \(r, (uid, active)) -> do
+      let [actualUser, timestamp] = B8.split ',' r
+      B8.unpack actualUser `shouldMatch` uid
+      B8.null timestamp `shouldMatch` not active
+
 testListClientsIfBackendIsOffline :: (HasCallStack) => App ()
 testListClientsIfBackendIsOffline = do
   resourcePool <- asks (.resourcePool)

integration/test/Test/Conversation.hs

@@ -667,7 +667,7 @@ testDeleteTeamMemberLimitedEventFanout :: (HasCallStack) => App ()
 testDeleteTeamMemberLimitedEventFanout = do
   -- Alex will get removed from the team
   (alice, team, [alex, alison]) <- createTeam OwnDomain 3
-  ana <- createTeamMemberWithRole alice team "admin"
+  ana <- createTeamMember alice def {role = "admin"}
   [amy, bob] <- for [OwnDomain, OtherDomain] $ flip randomUser def
   forM_ [amy, bob] $ connectTwoUsers alice
   [aliceId, alexId, amyId, alisonId, anaId, bobId] <- do

integration/test/Test/ExternalPartner.hs

@@ -29,7 +29,7 @@ testExternalPartnerPermissions :: (HasCallStack) => App ()
 testExternalPartnerPermissions = do
   (owner, tid, u1 : u2 : u3 : _) <- createTeam OwnDomain 4
 
-  partner <- createTeamMemberWithRole owner tid "partner"
+  partner <- createTeamMember owner def {role = "partner"}
 
   -- a partner should not be able to create conversation with 2 additional users or more
   void $ postConversation partner (defProteus {team = Just tid, qualifiedUsers = [u1, u2]}) >>= getJSON 403
@@ -58,23 +58,23 @@ testExternalPartnerPermissions = do
 testExternalPartnerPermissionsMls :: (HasCallStack) => App ()
 testExternalPartnerPermissionsMls = do
   -- external partners should not be able to create (MLS) conversations
-  (owner, tid, _) <- createTeam OwnDomain 2
-  bobExt <- createTeamMemberWithRole owner tid "partner"
+  (owner, _, _) <- createTeam OwnDomain 2
+  bobExt <- createTeamMember owner def {role = "partner"}
   bobExtClient <- createMLSClient def bobExt
   bindResponse (postConversation bobExtClient defMLS) $ \resp -> do
     resp.status `shouldMatchInt` 403
 
 testExternalPartnerPermissionMlsOne2One :: (HasCallStack) => App ()
 testExternalPartnerPermissionMlsOne2One = do
-  (owner, tid, alice : _) <- createTeam OwnDomain 2
-  bobExternal <- createTeamMemberWithRole owner tid "partner"
+  (owner, _, alice : _) <- createTeam OwnDomain 2
+  bobExternal <- createTeamMember owner def {role = "partner"}
   void $ getMLSOne2OneConversation alice bobExternal >>= getJSON 200
 
 testExternalPartnerPermissionsConvName :: (HasCallStack) => App ()
 testExternalPartnerPermissionsConvName = do
   (owner, tid, u1 : _) <- createTeam OwnDomain 2
 
-  partner <- createTeamMemberWithRole owner tid "partner"
+  partner <- createTeamMember owner def {role = "partner"}
 
   conv <- postConversation partner (defProteus {team = Just tid, qualifiedUsers = [u1]}) >>= getJSON 201
 

integration/test/Test/MLS/Services.hs

@@ -1,3 +1,4 @@
+{-# OPTIONS -Wno-ambiguous-fields #-}
 module Test.MLS.Services where
 
 import API.Brig
@@ -13,7 +14,7 @@ testWhitelistUpdatePermissions = do
   (owner, tid, []) <- createTeam OwnDomain 1
 
   -- Create a team admin
-  admin <- createTeamMemberWithRole owner tid "admin"
+  admin <- createTeamMember owner def {role = "admin"}
 
   -- Create a service
   email <- randomEmail

integration/test/Test/Search.hs

@@ -1,3 +1,4 @@
+{-# OPTIONS -Wno-ambiguous-fields #-}
 module Test.Search where
 
 import qualified API.Brig as BrigP
@@ -19,9 +20,9 @@ testSearchContactForExternalUsers = do
   owner <- randomUser OwnDomain def {BrigI.team = True}
   tid <- owner %. "team" & asString
 
-  partner <- createTeamMemberWithRole owner tid "partner"
-  tm1 <- createTeamMember owner tid
-  tm2 <- createTeamMember owner tid
+  partner <- createTeamMember owner def {role = "partner"}
+  tm1 <- createTeamMember owner def
+  tm2 <- createTeamMember owner def
 
   -- a team member can search for contacts
   bindResponse (BrigP.searchContacts tm1 (owner %. "name") OwnDomain) $ \resp ->

integration/test/Test/TeamSettings.hs

@@ -26,7 +26,7 @@ import Testlib.Prelude
 testTeamSettingsUpdate :: (HasCallStack) => App ()
 testTeamSettingsUpdate = do
   (ownerA, tidA, [mem]) <- createTeam OwnDomain 2
-  partner <- createTeamMemberWithRole ownerA tidA "partner"
+  partner <- createTeamMember ownerA def {role = "partner"}
 
   bindResponse (putAppLockSettings tidA ownerA def) $ \resp -> do
     resp.status `shouldMatchInt` 200
@@ -45,7 +45,7 @@ testTeamSettingsUpdate = do
 testTeamPropertiesUpdate :: (HasCallStack) => App ()
 testTeamPropertiesUpdate = do
   (ownerA, tidA, [mem]) <- createTeam OwnDomain 2
-  partner <- createTeamMemberWithRole ownerA tidA "partner"
+  partner <- createTeamMember ownerA def {role = "partner"}
 
   bindResponse (putTeamProperties tidA ownerA def) $ \resp -> do
     resp.status `shouldMatchInt` 200