Move cannon's internal API type to wire-api

Author: akshaymankar

libs/gundeck-types/gundeck-types.cabal

@@ -4,7 +4,7 @@ cabal-version: 1.12
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: 5ecbff5b5248085ccaf245621fb9388ff13a1cdace8dff356ea98ccd1cb72a03
+-- hash: 738b7369cd6cbbf07382a5645aa9c475292f016888ee76c40569aa56d24d9cae
 
 name:           gundeck-types
 version:        1.45.0
@@ -20,10 +20,8 @@ build-type:     Simple
 library
   exposed-modules:
       Gundeck.Types
-      Gundeck.Types.BulkPush
       Gundeck.Types.Common
       Gundeck.Types.Event
-      Gundeck.Types.Notification
       Gundeck.Types.Presence
       Gundeck.Types.Push
       Gundeck.Types.Push.V2

libs/gundeck-types/src/Gundeck/Types.hs

@@ -21,6 +21,5 @@ module Gundeck.Types
 where
 
 import Gundeck.Types.Event as G
-import Gundeck.Types.Notification as G
 import Gundeck.Types.Presence as G
 import Gundeck.Types.Push as G

libs/tasty-cannon/package.yaml

@@ -16,7 +16,6 @@ dependencies:
 - bytestring
 - bytestring-conversion
 - data-timeout
-- gundeck-types
 - exceptions
 - http-client >=0.5
 - http-types
@@ -25,5 +24,6 @@ dependencies:
 - tasty-hunit >=0.9
 - types-common >=0.16
 - websockets >=0.8
+- wire-api
 library:
   source-dirs: src

libs/tasty-cannon/src/Test/Tasty/Cannon.hs

@@ -83,14 +83,14 @@ import Data.ByteString.Conversion
 import Data.Id
 import Data.List1
 import Data.Timeout (Timeout, TimeoutUnit (..), (#))
-import Gundeck.Types
 import Imports
 import Network.HTTP.Client
 import qualified Network.HTTP.Client as Http
 import Network.HTTP.Types.Status
 import qualified Network.WebSockets as WS
 import System.Random (randomIO)
 import Test.Tasty.HUnit
+import Wire.API.Internal.Notification
 
 type Cannon = Http.Request -> Http.Request
 

libs/tasty-cannon/tasty-cannon.cabal

@@ -4,7 +4,7 @@ cabal-version: 1.12
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: 33f3a557e5296946dc5929fd741dfa0bb68e83484e1760cd425204e7defec8af
+-- hash: be26c1ad508de205143282797883e24b2b8ba5dad64b576df52e8c2665bb3c32
 
 name:           tasty-cannon
 version:        0.4.0
@@ -73,12 +73,12 @@ library
     , bytestring-conversion
     , data-timeout
     , exceptions
-    , gundeck-types
     , http-client >=0.5
     , http-types
     , imports
     , random
     , tasty-hunit >=0.9
     , types-common >=0.16
     , websockets >=0.8
+    , wire-api
   default-language: Haskell2010

libs/gundeck-types/src/Gundeck/Types/BulkPush.hs renamed to libs/wire-api/src/Wire/API/Internal/BulkPush.hs

@@ -1,6 +1,3 @@
-{-# LANGUAGE DeriveGeneric #-}
-{-# LANGUAGE GeneralizedNewtypeDeriving #-}
-{-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE TemplateHaskell #-}
 
 -- This file is part of the Wire Server implementation.
@@ -20,17 +17,13 @@
 -- You should have received a copy of the GNU Affero General Public License along
 -- with this program. If not, see <https://www.gnu.org/licenses/>.
 
--- | This module defines the types used by the Cannon API.  It is contained in package gundeck-types
--- for the pragmatic reason that it allows us to re-use types from the gundeck API.  (This move can
--- be justified by picturing Cannon as a local service that makes only sense in the context of a
--- Gundeck.)
-module Gundeck.Types.BulkPush where
+module Wire.API.Internal.BulkPush where
 
 import Data.Aeson
 import Data.Aeson.TH (deriveJSON)
 import Data.Id
-import Gundeck.Types.Notification
 import Imports
+import Wire.API.Internal.Notification
 
 data PushTarget = PushTarget
   { ptUserId :: !UserId,

libs/gundeck-types/src/Gundeck/Types/Notification.hs renamed to libs/wire-api/src/Wire/API/Internal/Notification.hs

@@ -1,4 +1,3 @@
-{-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE TemplateHaskell #-}
 
 -- This file is part of the Wire Server implementation.
@@ -18,7 +17,7 @@
 -- You should have received a copy of the GNU Affero General Public License along
 -- with this program. If not, see <https://www.gnu.org/licenses/>.
 
-module Gundeck.Types.Notification
+module Wire.API.Internal.Notification
   ( -- * Notification
     Notification (..),
     NotificationId,

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

@@ -0,0 +1,57 @@
+module Wire.API.Routes.Internal.Cannon where
+
+import Data.Id
+import Imports
+import Servant
+import Wire.API.Error
+import Wire.API.Error.Cannon
+import Wire.API.Internal.BulkPush
+import Wire.API.RawJson
+import Wire.API.Routes.MultiVerb
+import Wire.API.Routes.Named
+
+type API =
+  "i"
+    :> ( Named
+           "get-status"
+           ( "status"
+               :> MultiVerb
+                    'GET
+                    '[PlainText]
+                    '[RespondEmpty 200 "Service is alive."]
+                    ()
+           )
+           :<|> Named
+                  "push-notification"
+                  ( "push"
+                      :> Capture "user" UserId
+                      :> Capture "conn" ConnId
+                      :> ReqBody '[JSON] RawJson
+                      :> MultiVerb
+                           'POST
+                           '[JSON]
+                           '[ ErrorResponse 'ClientGone,
+                              RespondEmpty 200 "Successfully pushed."
+                            ]
+                           (Maybe ())
+                  )
+           :<|> Named
+                  "bulk-push-notifications"
+                  ( "bulkpush"
+                      :> ReqBody '[JSON] BulkPushRequest
+                      :> Post '[JSON] BulkPushResponse
+                  )
+           :<|> Named
+                  "check-presence"
+                  ( "presences"
+                      :> Capture "uid" UserId
+                      :> Capture "conn" ConnId
+                      :> MultiVerb
+                           'HEAD
+                           '[JSON]
+                           '[ ErrorResponse 'PresenceNotRegistered,
+                              RespondEmpty 200 "Presence checked successfully."
+                            ]
+                           (Maybe ())
+                  )
+       )

libs/wire-api/wire-api.cabal

@@ -41,6 +41,8 @@ library
       Wire.API.Event.Conversation
       Wire.API.Event.FeatureConfig
       Wire.API.Event.Team
+      Wire.API.Internal.BulkPush
+      Wire.API.Internal.Notification
       Wire.API.Message
       Wire.API.Message.Proto
       Wire.API.MLS.CipherSuite
@@ -69,6 +71,7 @@ library
       Wire.API.Routes.Internal.Brig
       Wire.API.Routes.Internal.Brig.Connection
       Wire.API.Routes.Internal.Brig.EJPD
+      Wire.API.Routes.Internal.Cannon
       Wire.API.Routes.Internal.Cargohold
       Wire.API.Routes.Internal.Galley.TeamFeatureNoConfigMulti
       Wire.API.Routes.Internal.LegalHold

services/brig/test/integration/API/Provider.hs

@@ -70,7 +70,6 @@ import Galley.Types
 import Galley.Types.Bot (ServiceRef, newServiceRef, serviceRefId, serviceRefProvider)
 import Galley.Types.Conversations.Roles (roleNameWireAdmin)
 import qualified Galley.Types.Teams as Team
-import Gundeck.Types.Notification
 import Imports hiding (threadDelay)
 import Network.HTTP.Types.Status (status200, status201, status400)
 import Network.Wai (Application, responseLBS, strictRequestBody)
@@ -89,6 +88,7 @@ import Util
 import Web.Cookie (SetCookie (..), parseSetCookie)
 import Wire.API.Asset hiding (Asset)
 import Wire.API.Event.Conversation
+import Wire.API.Internal.Notification
 import qualified Wire.API.Team.Feature as Public
 
 tests :: Domain -> Config -> Manager -> DB.ClientState -> Brig -> Cannon -> Galley -> IO TestTree