Create endpoint for getting handle info by qualified handle

Federation is not implemented yet, so remote handles will always return 404.

Author: akshaymankar

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

@@ -28,13 +28,15 @@ where
 
 import Data.Aeson hiding ((<?>))
 import qualified Data.Attoparsec.ByteString.Char8 as Atto
+import Data.Bifunctor (Bifunctor (first))
 import qualified Data.ByteString as BS
 import Data.ByteString.Conversion (FromByteString (parser), ToByteString)
 import Data.Hashable (Hashable)
-import Data.Swagger (ToSchema (..))
+import Data.Swagger (ToParamSchema, ToSchema (..))
 import qualified Data.Text as Text
 import qualified Data.Text.Encoding as Text.E
 import Imports
+import Servant (FromHttpApiData (..))
 import Test.QuickCheck (Arbitrary (arbitrary), choose, elements, oneof)
 import Util.Attoparsec (takeUpToWhile)
 
@@ -45,7 +47,11 @@ import Util.Attoparsec (takeUpToWhile)
 newtype Handle = Handle
   {fromHandle :: Text}
   deriving stock (Eq, Show, Generic)
-  deriving newtype (ToJSON, ToByteString, Hashable, ToSchema)
+  deriving newtype (ToJSON, ToByteString, Hashable, ToSchema, ToParamSchema)
+
+instance FromHttpApiData Handle where
+  parseUrlPiece =
+    first Text.pack . parseHandleEither
 
 instance FromByteString Handle where
   parser = handleParser

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

@@ -32,7 +32,9 @@ where
 import Data.Aeson
 import Data.Id (UserId)
 import Data.Range
+import Data.Swagger (ToSchema)
 import qualified Data.Swagger.Build.Api as Doc
+import Deriving.Swagger (CustomSwagger, FieldLabelModifier, LabelMapping ((:->)), LabelMappings)
 import Imports
 import Wire.API.Arbitrary (Arbitrary, GenericUniform (..))
 
@@ -42,6 +44,7 @@ import Wire.API.Arbitrary (Arbitrary, GenericUniform (..))
 newtype UserHandleInfo = UserHandleInfo {userHandleId :: UserId}
   deriving stock (Eq, Show, Generic)
   deriving newtype (Arbitrary)
+  deriving (ToSchema) via (CustomSwagger '[FieldLabelModifier (LabelMappings '["userHandleId" ':-> "user"])] UserHandleInfo)
 
 modelUserHandleInfo :: Doc.Model
 modelUserHandleInfo = Doc.defineModel "UserHandleInfo" $ do

services/brig/src/Brig/API/Public.hs

@@ -224,12 +224,41 @@ type GetSelf =
     :> "self"
     :> Get '[Servant.JSON] Public.SelfProfile
 
+-- See Note [document responses]
+-- The responses looked like this:
+--   Doc.returns (Doc.ref Public.modelUserHandleInfo)
+--   Doc.response 200 "Handle info" Doc.end
+--   Doc.errorResponse handleNotFound
+type GetHandleInfoUnqualified =
+  Summary "Get information on a user handle"
+    :> ZAuthServant
+    :> "users"
+    :> "handles"
+    :> Capture' '[Description "The user handle"] "handle" Handle
+    :> Get '[Servant.JSON] Public.UserHandleInfo
+
+-- See Note [document responses]
+-- The responses looked like this:
+--   Doc.returns (Doc.ref Public.modelUserHandleInfo)
+--   Doc.response 200 "Handle info" Doc.end
+--   Doc.errorResponse handleNotFound
+type GetHandleInfoQualified =
+  Summary "Get information on a user handle"
+    :> ZAuthServant
+    :> "users"
+    :> "handles"
+    :> Capture "domain" Domain
+    :> Capture' '[Description "The user handle"] "handle" Handle
+    :> Get '[Servant.JSON] Public.UserHandleInfo
+
 type OutsideWorldAPI =
   CheckUserExistsUnqualified
     :<|> CheckUserExistsQualified
     :<|> GetUserUnqualified
     :<|> GetUserQualified
     :<|> GetSelf
+    :<|> GetHandleInfoUnqualified
+    :<|> GetHandleInfoQualified
 
 type SwaggerDocsAPI = "api" :> SwaggerSchemaUI "swagger-ui" "swagger.json"
 
@@ -253,6 +282,8 @@ servantSitemap =
     :<|> getUserUnqualifiedH
     :<|> getUserH
     :<|> getSelf
+    :<|> getHandleInfoUnqualifiedH
+    :<|> getHandleInfoH
 
 -- Note [ephemeral user sideeffect]
 -- If the user is ephemeral and expired, it will be removed upon calling
@@ -287,18 +318,7 @@ sitemap o = do
     Doc.errorResponse invalidHandle
     Doc.errorResponse handleNotFound
 
-  get "/users/handles/:handle" (continue getHandleInfoH) $
-    accept "application" "json"
-      .&. zauthUserId
-      .&. capture "handle"
-  document "GET" "getUserHandleInfo" $ do
-    Doc.summary "Get information on a user handle"
-    Doc.parameter Doc.Path "handle" Doc.bytes' $
-      Doc.description "The user handle"
-    Doc.returns (Doc.ref Public.modelUserHandleInfo)
-    Doc.response 200 "Handle info" Doc.end
-    Doc.errorResponse handleNotFound
-
+  -- some APIs moved to servant
   -- end User Handle API
 
   -- If the user is ephemeral and expired, it will be removed, see 'Brig.API.User.userGC'.
@@ -1297,23 +1317,34 @@ checkHandlesH (_ ::: _ ::: req) = do
   free <- lift $ API.checkHandles handles (fromRange num)
   return $ json (free :: [Handle])
 
-getHandleInfoH :: JSON ::: UserId ::: Handle -> Handler Response
-getHandleInfoH (_ ::: self ::: handle) =
-  maybe (setStatus status404 empty) json
-    <$> getHandleInfo self handle
+getHandleInfoUnqualifiedH :: UserId -> Handle -> Handler Public.UserHandleInfo
+getHandleInfoUnqualifiedH self handle = do
+  domain <- API.viewFederationDomain
+  getHandleInfoH self domain handle
+
+getHandleInfoH :: UserId -> Domain -> Handle -> Handler Public.UserHandleInfo
+getHandleInfoH self domain handle =
+  ifNothing (notFound "handle not found")
+    =<< getHandleInfo self (Qualified handle domain)
 
 -- FUTUREWORK: use 'runMaybeT' to simplify this.
-getHandleInfo :: UserId -> Handle -> Handler (Maybe Public.UserHandleInfo)
+getHandleInfo :: UserId -> Qualified Handle -> Handler (Maybe Public.UserHandleInfo)
 getHandleInfo self handle = do
-  ownerProfile <- do
-    -- FUTUREWORK(federation, #1268): resolve qualified handles, too
-    domain <- viewFederationDomain
-    maybeOwnerId <- fmap (flip Qualified domain) <$> (lift $ API.lookupHandle handle)
-    case maybeOwnerId of
-      Just ownerId -> lift $ API.lookupProfile self ownerId
-      Nothing -> return Nothing
-  owner <- filterHandleResults self (maybeToList ownerProfile)
-  return $ Public.UserHandleInfo . Public.profileId <$> listToMaybe owner
+  domain <- API.viewFederationDomain
+  if _qDomain handle == domain
+    then getLocalHandleInfo domain
+    else getRemoteHandleInfo
+  where
+    getLocalHandleInfo domain = do
+      maybeOwnerId <- lift $ API.lookupHandle (_qLocalPart handle)
+      case maybeOwnerId of
+        Nothing -> return Nothing
+        Just ownerId -> do
+          ownerProfile <- lift $ API.lookupProfile self (Qualified ownerId domain)
+          owner <- filterHandleResults self (maybeToList ownerProfile)
+          return $ Public.UserHandleInfo . Public.profileId <$> listToMaybe owner
+    -- FUTUREWORK: Federate with remote backends
+    getRemoteHandleInfo = return Nothing
 
 changeHandleH :: UserId ::: ConnId ::: JsonRequest Public.HandleUpdate -> Handler Response
 changeHandleH (u ::: conn ::: req) = do