delete /push/tokens/:pid

Author: battermann

libs/wire-api/src/Wire/API/Error/Gundeck.hs

@@ -25,6 +25,7 @@ data GundeckError
   | AddTokenErrorInvalid
   | AddTokenErrorTooLong
   | AddTokenErrorMetadataTooLong
+  | TokenNotFound
 
 instance KnownError (MapError e) => IsSwaggerError (e :: GundeckError) where
   addToSwagger = addStaticErrorToSwagger @(MapError e)
@@ -38,3 +39,5 @@ type instance MapError 'AddTokenErrorInvalid = 'StaticError 404 "invalid-token"
 type instance MapError 'AddTokenErrorTooLong = 'StaticError 413 "token-too-long" "Push token length must be < 8192 for GCM or 400 for APNS"
 
 type instance MapError 'AddTokenErrorMetadataTooLong = 'StaticError 413 "metadata-too-long" "Tried to add token to endpoint resulting in metadata length > 2048"
+
+type instance MapError 'TokenNotFound = 'StaticError 404 "not-found" "Push token not found"

libs/wire-api/src/Wire/API/Push/V2/Token.hs

@@ -38,6 +38,8 @@ module Wire.API.Push.V2.Token
     AddTokenError (..),
     AddTokenSuccess (..),
     AddTokenResponses,
+    DeleteTokenError (..),
+    DeleteTokenResponses,
 
     -- * Swagger
     modelPushToken,
@@ -205,7 +207,7 @@ instance ToSchema AppName where
 makeLenses ''PushToken
 
 --------------------------------------------------------------------------------
--- API types
+-- Add token types
 
 type AddTokenErrorResponses =
   '[ ErrorResponse 'E.AddTokenErrorNoBudget,
@@ -244,3 +246,21 @@ instance AsHeaders '[Token] PushToken AddTokenSuccess where
 instance (res ~ AddTokenResponses) => AsUnion res (Either AddTokenError AddTokenSuccess) where
   toUnion = eitherToUnion (toUnion @AddTokenErrorResponses) (Z . I)
   fromUnion = eitherFromUnion (fromUnion @AddTokenErrorResponses) (unI . unZ)
+
+--------------------------------------------------------------------------------
+-- Delete token types
+
+data DeleteTokenError = DeleteTokenErrorNotFound
+  deriving (Generic)
+
+-- deriving (AsUnion DeleteTokenErrorResponses) via GenericAsUnion DeleteTokenErrorResponses DeleteTokenError
+
+-- instance GSOP.Generic DeleteTokenError
+
+type DeleteTokenErrorResponses = '[ErrorResponse 'E.TokenNotFound]
+
+type DeleteTokenResponses = DeleteTokenErrorResponses .++ '[RespondEmpty 204 "Push token unregistered"]
+
+-- instance (res ~ DeleteTokenResponses) => AsUnion res (Maybe DeleteTokenError) where
+--   toUnion = maybeToUnion (toUnion @DeleteTokenErrorResponses)
+--   fromUnion = maybeFromUnion (fromUnion @DeleteTokenErrorResponses)

libs/wire-api/src/Wire/API/Routes/Public/Gundeck.hs

@@ -38,6 +38,15 @@ type GundeckAPI =
         :> ReqBody '[JSON] PushToken
         :> MultiVerb 'POST '[JSON] AddTokenResponses (Either AddTokenError AddTokenSuccess)
     )
+    :<|> Named
+           "delete-push-token"
+           ( Summary "Unregister a native push token"
+               :> ZUser
+               :> "push"
+               :> "tokens"
+               :> Capture' '[Description "The push token to delete"] "pid" Token
+               :> MultiVerb 'DELETE '[JSON] DeleteTokenResponses (Maybe DeleteTokenError)
+           )
 
 swaggerDoc :: Swagger.Swagger
 swaggerDoc = toSwagger (Proxy @GundeckAPI)

services/gundeck/src/Gundeck/API/Public.hs

@@ -40,7 +40,7 @@ import Network.Wai.Predicate hiding (setStatus)
 import Network.Wai.Routing hiding (route)
 import Network.Wai.Utilities as Wai
 import Network.Wai.Utilities.Swagger
-import Servant (HasServer (..))
+import Servant (HasServer (..), (:<|>) (..))
 import Wire.API.Notification (NotificationId)
 import qualified Wire.API.Notification as Public
 import qualified Wire.API.Push.Token as Public
@@ -52,7 +52,9 @@ import qualified Wire.API.Swagger as Public.Swagger
 -- Servant API
 
 servantSitemap :: ServerT GundeckAPI Gundeck
-servantSitemap = Named @"register-push-token" addToken
+servantSitemap =
+  Named @"register-push-token" addToken
+    :<|> Named @"delete-push-token" deleteToken
 
 --------------------------------------------------------------------------------
 -- Wai Routes API
@@ -158,6 +160,10 @@ deleteTokenH :: UserId ::: Public.Token ::: JSON -> Gundeck Response
 deleteTokenH (uid ::: tok ::: _) =
   setStatus status204 empty <$ Push.deleteToken uid tok
 
+deleteToken :: UserId -> Public.Token -> Gundeck (Maybe Public.DeleteTokenError)
+deleteToken _uid _tok =
+  pure Nothing
+
 listTokensH :: UserId ::: JSON -> Gundeck Response
 listTokensH (uid ::: _) =
   setStatus status200 . json @Public.PushTokenList <$> Push.listTokens uid

services/gundeck/src/Gundeck/Push.hs

@@ -542,12 +542,11 @@ updateEndpoint uid t arn e = do
         ~~ "arn" .= toText r
         ~~ msg (val m)
 
-deleteToken :: UserId -> Token -> Gundeck ()
+deleteToken :: UserId -> Token -> Gundeck (Maybe Public.DeleteTokenError)
 deleteToken uid tok = do
-  as <- filter (\x -> x ^. addrToken == tok) <$> Data.lookup uid Data.LocalQuorum
-  when (null as) $
-    throwM (mkError status404 "not-found" "Push token not found")
-  Native.deleteTokens as Nothing
+  filter (\x -> x ^. addrToken == tok) <$> Data.lookup uid Data.LocalQuorum >>= \case
+    [] -> pure (Just Public.DeleteTokenErrorNotFound)
+    as -> Native.deleteTokens as Nothing >> pure Nothing
 
 listTokens :: UserId -> Gundeck PushTokenList
 listTokens uid = PushTokenList . map (^. addrPushToken) <$> Data.lookup uid Data.LocalQuorum