Add last_active field to clients

cassandra-schema.cql

@@ -798,6 +798,7 @@ CREATE TABLE brig_test.clients (
     cookie text,
     ip inet,
     label text,
+    last_active timestamp,
     lat double,
     lon double,
     model text,

changelog.d/1-api-changes/last-active

@@ -0,0 +1 @@
+Client objects have gained an optional `last_active` field. Whenever a client fetches notifications via `GET /notifications`, as long as it provides a client parameter, the `last_active` field of that client is updated, and set to the current timestamp, rounded to the next multiple of a week.

charts/gundeck/templates/configmap.yaml

@@ -13,6 +13,10 @@ data:
       host: 0.0.0.0
       port: {{ $.Values.service.internalPort }}
 
+    brig:
+      host: brig
+      port: 8080
+
     cassandra:
       endpoint:
         host: {{ .cassandra.host }}

integration/integration.cabal

@@ -101,6 +101,7 @@ library
     Test.AssetDownload
     Test.B2B
     Test.Brig
+    Test.Client
     Test.Conversation
     Test.Demo
     Test.Notifications

integration/test/API/Brig.hs

@@ -20,6 +20,18 @@ getUser user target = do
       joinHttpPath ["users", domain, uid]
   submit "GET" req
 
+getClient ::
+  (HasCallStack, MakesValue user, MakesValue client) =>
+  user ->
+  client ->
+  App Response
+getClient u cli = do
+  c <- make cli & asString
+  req <-
+    baseRequest u Brig Versioned $
+      joinHttpPath ["clients", c]
+  submit "GET" req
+
 data AddClient = AddClient
   { ctype :: String,
     internal :: Bool,

integration/test/Test/Client.hs

@@ -0,0 +1,34 @@
+module Test.Client where
+
+import API.Brig
+import API.Gundeck
+import Data.Aeson
+import Data.Time.Clock.POSIX
+import Data.Time.Clock.System
+import Data.Time.Format
+import SetupHelpers
+import Testlib.Prelude
+
+testClientLastActive :: HasCallStack => App ()
+testClientLastActive = do
+  alice <- randomUser OwnDomain def
+  c0 <- addClient alice def >>= getJSON 201
+  cid <- c0 %. "id"
+
+  -- newly created clients should not have a last_active value
+  tm0 <- fromMaybe Null <$> lookupField c0 "last_active"
+  tm0 `shouldMatch` Null
+
+  now <- systemSeconds <$> liftIO getSystemTime
+
+  -- fetching notifications updates last_active
+  void $ getNotifications alice cid def
+
+  c1 <- getClient alice cid >>= getJSON 200
+  tm1 <- c1 %. "last_active" & asString
+  ts1 <-
+    round @Double
+      . realToFrac
+      . utcTimeToPOSIXSeconds
+      <$> parseTimeM False defaultTimeLocale "%Y-%m-%dT%H:%M:%SZ" tm1
+  assertBool "last_active is earlier than expected" $ ts1 >= now

integration/test/Testlib/RunServices.hs

@@ -2,6 +2,7 @@
 
 module Testlib.RunServices where
 
+import Control.Concurrent
 import Control.Monad.Codensity (lowerCodensity)
 import qualified Data.Map as Map
 import System.Directory
@@ -114,18 +115,23 @@ main = do
   cwd <- getWorkingDirectory
   mbProjectRoot <- findProjectRoot cwd
   cfg <- case mbProjectRoot of
-    Nothing -> error "Could not find project root. Please make sure you call run-services from the somewhere in wire-server."
+    Nothing -> error "Could not find project root. Please make sure you call run-services from somewhere in wire-server."
     Just projectRoot ->
       pure $ joinPath [projectRoot, "services/integration.yaml"]
 
   genv <- createGlobalEnv cfg
   env <- lowerCodensity $ mkEnv genv
 
   args <- getArgs
-  let args' = case args of
-        (x : xs) -> x : xs
-        _ -> ["sleep", "10000d"]
-  let cp = proc "sh" (["-c", "exec \"$@\"", "--"] <> args')
+
+  let run = case args of
+        [] -> do
+          putStrLn "services started"
+          forever (threadDelay 1000000000)
+        _ -> do
+          let cp = proc "sh" (["-c", "exec \"$@\"", "--"] <> args)
+          (_, _, _, ph) <- createProcess cp
+          exitWith =<< waitForProcess ph
 
   runAppWithEnv env $ do
     lowerCodensity $ do
@@ -138,6 +144,4 @@ main = do
         traverseConcurrentlyCodensity
           (\(res, staticPorts, overrides) -> startDynamicBackend res staticPorts overrides)
           [(backendA, staticPortsA, fedConfig backendB.berDomain), (backendB, staticPortsB, fedConfig backendA.berDomain)]
-      liftIO $ do
-        (_, _, _, ph) <- createProcess cp
-        exitWith =<< waitForProcess ph
+      liftIO run

libs/wire-api/src/Wire/API/Routes/Internal/Brig.hs

@@ -23,6 +23,7 @@ module Wire.API.Routes.Internal.Brig
     MLSAPI,
     TeamsAPI,
     UserAPI,
+    ClientAPI,
     AuthAPI,
     FederationRemotesAPI,
     EJPDRequest,
@@ -386,6 +387,7 @@ type API =
            :<|> GetVerificationCode
            :<|> TeamsAPI
            :<|> UserAPI
+           :<|> ClientAPI
            :<|> AuthAPI
            :<|> OAuthAPI
            :<|> ISearchIndexAPI
@@ -436,6 +438,14 @@ type GetDefaultLocale =
     :> "locale"
     :> Get '[Servant.JSON] LocaleUpdate
 
+type ClientAPI =
+  Summary "Update last_active field of a client"
+    :> "clients"
+    :> Capture "uid" UserId
+    :> Capture "client" ClientId
+    :> "activity"
+    :> MultiVerb1 'POST '[Servant.JSON] (RespondEmpty 200 "OK")
+
 type AuthAPI =
   Named
     "legalhold-login"

libs/wire-api/src/Wire/API/User/Client.hs

@@ -89,6 +89,7 @@ import qualified Data.Set as Set
 import Data.Swagger hiding (Schema, ToSchema, schema)
 import qualified Data.Swagger as Swagger
 import qualified Data.Text.Encoding as Text.E
+import Data.Time.Clock
 import Data.UUID (toASCIIBytes)
 import Deriving.Swagger
   ( CustomSwagger,
@@ -460,7 +461,8 @@ data Client = Client
     clientLocation :: Maybe Location,
     clientModel :: Maybe Text,
     clientCapabilities :: ClientCapabilityList,
-    clientMLSPublicKeys :: MLSPublicKeys
+    clientMLSPublicKeys :: MLSPublicKeys,
+    clientLastActive :: Maybe UTCTime
   }
   deriving stock (Eq, Show, Generic, Ord)
   deriving (Arbitrary) via (GenericUniform Client)
@@ -500,6 +502,7 @@ instance ToSchema Client where
         <*> clientModel .= maybe_ (optField "model" schema)
         <*> clientCapabilities .= (fromMaybe mempty <$> optField "capabilities" schema)
         <*> clientMLSPublicKeys .= mlsPublicKeysFieldSchema
+        <*> clientLastActive .= maybe_ (optField "last_active" utcTimeSchema)
 
 mlsPublicKeysFieldSchema :: ObjectSchema SwaggerDoc MLSPublicKeys
 mlsPublicKeysFieldSchema = fromMaybe mempty <$> optField "mls_public_keys" mlsPublicKeysSchema

libs/wire-api/test/golden/Test/Wire/API/Golden/Generated/Client_user.hs

@@ -20,7 +20,7 @@
 module Test.Wire.API.Golden.Generated.Client_user where
 
 import Data.Id (ClientId (ClientId, client))
-import Data.Json.Util (readUTCTimeMillis)
+import Data.Json.Util
 import qualified Data.Map as Map
 import Data.Misc
 import Data.Set as Set
@@ -41,7 +41,8 @@ testObject_Client_user_1 =
       clientLocation = Nothing,
       clientModel = Just "\995802;\1081067",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_2 :: Client
@@ -56,7 +57,8 @@ testObject_Client_user_2 =
       clientLocation = Just (location (Latitude 0.6919026326441752) (Longitude 1.18215529547942)),
       clientModel = Nothing,
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_3 :: Client
@@ -71,7 +73,8 @@ testObject_Client_user_3 =
       clientLocation = Just (location (Latitude (-0.31865405026910076)) (Longitude 6.859482454480745e-2)),
       clientModel = Nothing,
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = fmap fromUTCTimeMillis (readUTCTimeMillis "2023-07-04T09:35:32.000Z")
     }
 
 testObject_Client_user_4 :: Client
@@ -86,7 +89,8 @@ testObject_Client_user_4 =
       clientLocation = Just (location (Latitude 0.43019316470477537) (Longitude (-2.1994844230432533))),
       clientModel = Just "",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_5 :: Client
@@ -101,7 +105,8 @@ testObject_Client_user_5 =
       clientLocation = Just (location (Latitude (-1.505966289957799)) (Longitude (-2.516893825541776))),
       clientModel = Just "\9015o",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_6 :: Client
@@ -116,7 +121,8 @@ testObject_Client_user_6 =
       clientLocation = Just (location (Latitude 0.3764380360505919) (Longitude 1.3619562593325738)),
       clientModel = Just "",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = fmap fromUTCTimeMillis (readUTCTimeMillis "2021-09-15T22:00:21.000Z")
     }
 
 testObject_Client_user_7 :: Client
@@ -131,7 +137,8 @@ testObject_Client_user_7 =
       clientLocation = Nothing,
       clientModel = Just "",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_8 :: Client
@@ -146,7 +153,8 @@ testObject_Client_user_8 =
       clientLocation = Just (location (Latitude 0.8626148594727595) (Longitude (-1.971023301844283))),
       clientModel = Just "\1113929",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_9 :: Client
@@ -161,7 +169,8 @@ testObject_Client_user_9 =
       clientLocation = Just (location (Latitude (-0.3086524641730466)) (Longitude 1.72690152811777)),
       clientModel = Just "\13056m",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_10 :: Client
@@ -176,7 +185,8 @@ testObject_Client_user_10 =
       clientLocation = Just (location (Latitude (-2.6734377548386075)) (Longitude (-1.40544074714727))),
       clientModel = Just "\CAN",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = Map.fromList [(Ed25519, "ZmFrZSBwdWJsaWMga2V5")]
+      clientMLSPublicKeys = Map.fromList [(Ed25519, "ZmFrZSBwdWJsaWMga2V5")],
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_11 :: Client
@@ -191,7 +201,8 @@ testObject_Client_user_11 =
       clientLocation = Just (location (Latitude 0.44311730892815937) (Longitude 0.6936233843789369)),
       clientModel = Just "ML",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_12 :: Client
@@ -206,7 +217,8 @@ testObject_Client_user_12 =
       clientLocation = Just (location (Latitude (-2.502416826395783)) (Longitude 1.4712334862249388)),
       clientModel = Just "",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_13 :: Client
@@ -221,7 +233,8 @@ testObject_Client_user_13 =
       clientLocation = Just (location (Latitude (-2.3798205243177692)) (Longitude (-2.619240132398651))),
       clientModel = Just "\ETB\68772",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_14 :: Client
@@ -236,7 +249,8 @@ testObject_Client_user_14 =
       clientLocation = Just (location (Latitude 2.459582010332432) (Longitude (-1.2286910026214775))),
       clientModel = Just "\1052175\r\917608",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_15 :: Client
@@ -251,7 +265,8 @@ testObject_Client_user_15 =
       clientLocation = Nothing,
       clientModel = Just "zAI",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_16 :: Client
@@ -266,7 +281,8 @@ testObject_Client_user_16 =
       clientLocation = Nothing,
       clientModel = Just "",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_17 :: Client
@@ -281,7 +297,8 @@ testObject_Client_user_17 =
       clientLocation = Just (location (Latitude (-1.6915872714820337)) (Longitude 2.1128949838723656)),
       clientModel = Just "",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_18 :: Client
@@ -296,7 +313,8 @@ testObject_Client_user_18 =
       clientLocation = Just (location (Latitude (-1.2949675488134762)) (Longitude 0.43717421775412324)),
       clientModel = Just "\DEL\1071737",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_19 :: Client
@@ -311,7 +329,8 @@ testObject_Client_user_19 =
       clientLocation = Just (location (Latitude (-1.4630309786758076)) (Longitude (-0.5295690632216867))),
       clientModel = Just "",
       clientCapabilities = ClientCapabilityList Set.empty,
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }
 
 testObject_Client_user_20 :: Client
@@ -326,5 +345,6 @@ testObject_Client_user_20 =
       clientLocation = Just (location (Latitude 2.8672347564452996) (Longitude (-0.9990390825956594))),
       clientModel = Nothing,
       clientCapabilities = ClientCapabilityList (Set.fromList [ClientSupportsLegalholdImplicitConsent]),
-      clientMLSPublicKeys = mempty
+      clientMLSPublicKeys = mempty,
+      clientLastActive = Nothing
     }

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

@@ -6,6 +6,7 @@
     "cookie": "",
     "id": "1",
     "label": "pi",
+    "last_active": "2023-07-04T09:35:32Z",
     "location": {
         "lat": -0.31865405026910076,
         "lon": 6.859482454480745e-2