src/Gargantext/API/GraphQL.hs

   1 {-# OPTIONS_GHC -fprint-potential-instances #-}
   2
   3 {-# LANGUAGE DeriveAnyClass #-}
   4 {-# LANGUAGE DuplicateRecordFields #-}  -- permit duplications for field names in multiple constructors
   5 {-# LANGUAGE KindSignatures #-}  -- for use of Endpoint (name :: Symbol)
   6 {-# LANGUAGE PartialTypeSignatures #-}  -- to automatically use suggested type hole signatures during compilation
   7 {-# LANGUAGE TypeOperators #-}
   8
   9 module Gargantext.API.GraphQL where
  10
  11 import Data.ByteString.Lazy.Char8
  12   ( ByteString
  13   )
  14 import Data.Map (Map)
  15 import Data.Morpheus
  16   ( App
  17   , deriveApp )
  18 import Data.Morpheus.Server
  19   ( httpPlayground
  20   )
  21 import Data.Morpheus.Subscriptions
  22   ( Event (..)
  23   , Hashable
  24   , httpPubApp
  25   )
  26 import Data.Morpheus.Types
  27   ( GQLRequest
  28   , GQLResponse
  29   , GQLType
  30   , RootResolver(..)
  31   , Undefined(..)
  32   )
  33 import Data.Proxy
  34 import Gargantext.API.Admin.Auth.Types (AuthenticatedUser)
  35 import Gargantext.API.Admin.Orchestrator.Types (JobLog)
  36 import Gargantext.API.Prelude (HasJobEnv')
  37 import qualified Gargantext.API.GraphQL.Annuaire as GQLA
  38 import qualified Gargantext.API.GraphQL.AsyncTask as GQLAT
  39 import qualified Gargantext.API.GraphQL.Context as GQLCTX
  40 import qualified Gargantext.API.GraphQL.IMT as GQLIMT
  41 import qualified Gargantext.API.GraphQL.Node as GQLNode
  42 import qualified Gargantext.API.GraphQL.User as GQLUser
  43 import qualified Gargantext.API.GraphQL.UserInfo as GQLUserInfo
  44 import qualified Gargantext.API.GraphQL.TreeFirstLevel as GQLTree
  45 import qualified Gargantext.API.GraphQL.Team as GQLTeam
  46 import Gargantext.API.Prelude (GargM, GargError)
  47 import Gargantext.API.Types
  48 import Gargantext.Core.Mail.Types (HasMail)
  49 import Gargantext.Database.Prelude (HasConnectionPool, HasConfig)
  50 import Gargantext.Prelude
  51 import GHC.Generics (Generic)
  52 import Servant
  53   ( (:<|>) (..)
  54   , (:>)
  55   , Get
  56   , JSON
  57   , Post
  58   , ReqBody
  59   ,  ServerT
  60   )
  61 import qualified Servant.Auth as SA
  62 import qualified Servant.Auth.Server as SAS
  63 import Gargantext.API.Admin.Types (HasSettings)
  64
  65
  66 -- | Represents possible GraphQL queries.
  67 data Query m
  68   = Query
  69     { annuaire_contacts :: GQLA.AnnuaireContactArgs -> m [GQLA.AnnuaireContact]
  70     , contexts    :: GQLCTX.NodeContextArgs -> m [GQLCTX.NodeContextGQL]
  71     , imt_schools :: GQLIMT.SchoolsArgs -> m [GQLIMT.School]
  72     , job_logs    :: GQLAT.JobLogArgs -> m (Map Int JobLog)
  73     , nodes       :: GQLNode.NodeArgs -> m [GQLNode.Node]
  74     , node_parent :: GQLNode.NodeParentArgs -> m [GQLNode.Node]
  75     , user_infos  :: GQLUserInfo.UserInfoArgs -> m [GQLUserInfo.UserInfo]
  76     , users       :: GQLUser.UserArgs -> m [GQLUser.User m]
  77     , tree        :: GQLTree.TreeArgs -> m (GQLTree.TreeFirstLevel m)
  78     , team        :: GQLTeam.TeamArgs -> m GQLTeam.Team
  79     } deriving (Generic, GQLType)
  80
  81 data Mutation m
  82   = Mutation
  83     { update_user_info       :: GQLUserInfo.UserInfoMArgs -> m Int
  84     , delete_team_membership :: GQLTeam.TeamDeleteMArgs -> m [Int]
  85     , update_node_context_category :: GQLCTX.NodeContextCategoryMArgs -> m [Int]
  86     } deriving (Generic, GQLType)
  87
  88 -- | Possible GraphQL Events, i.e. here we describe how we will
  89 -- manipulate the data.
  90 type EVENT m = Event Channel (Contet m)
  91
  92 -- | Channels are possible actions to call when manipulating the data.
  93 data Channel
  94   = Update
  95   | New
  96   deriving (Eq, Show, Generic, Hashable)
  97
  98 -- | This type describes what data we will operate on.
  99 data Contet m
 100   = UserContet [GQLUser.User m]
 101   | UserInfoContet [GQLUserInfo.UserInfo]
 102
 103 -- | The main GraphQL resolver: how queries, mutations and
 104 -- subscriptions are handled.
 105 rootResolver
 106   :: (HasConnectionPool env, HasConfig env, HasMail env, HasJobEnv' env, HasSettings env)
 107   => RootResolver (GargM env GargError) e Query Mutation Undefined
 108 rootResolver =
 109   RootResolver
 110     { queryResolver = Query { annuaire_contacts = GQLA.resolveAnnuaireContacts
 111                             , contexts          = GQLCTX.resolveNodeContext
 112                             , imt_schools       = GQLIMT.resolveSchools
 113                             , job_logs          = GQLAT.resolveJobLogs
 114                             , nodes             = GQLNode.resolveNodes
 115                             , node_parent       = GQLNode.resolveNodeParent
 116                             , user_infos        = GQLUserInfo.resolveUserInfos
 117                             , users             = GQLUser.resolveUsers
 118                             , tree              = GQLTree.resolveTree
 119                             , team              = GQLTeam.resolveTeam }
 120     , mutationResolver = Mutation { update_user_info       = GQLUserInfo.updateUserInfo
 121                                   , delete_team_membership = GQLTeam.deleteTeamMembership
 122                                   , update_node_context_category = GQLCTX.updateNodeContextCategory }
 123     , subscriptionResolver = Undefined }
 124
 125 -- | Main GraphQL "app".
 126 app
 127   :: (Typeable env, HasConnectionPool env, HasConfig env, HasMail env, HasJobEnv' env, HasSettings env)
 128   => App (EVENT (GargM env GargError)) (GargM env GargError)
 129 app = deriveApp rootResolver
 130
 131 ----------------------------------------------
 132
 133 -- Now for some boilerplate to integrate the above GraphQL app with
 134 -- servant.
 135
 136 -- | Servant route for the app we defined above.
 137 type GQAPI = ReqBody '[JSON] GQLRequest :> Post '[JSON] GQLResponse
 138 -- type Schema = "schema" :> Get '[PlainText] Text
 139 -- | Servant route for the playground.
 140 type Playground = Get '[HTML] ByteString
 141 -- type API' (name :: Symbol) = name :> (GQAPI :<|> Schema :<|> Playground)
 142 -- | Our API consists of `GQAPI` and `Playground`.
 143 type API = SA.Auth '[SA.JWT, SA.Cookie] AuthenticatedUser
 144             :> "gql" :> (GQAPI :<|> Playground)
 145
 146 gqapi :: Proxy API
 147 gqapi = Proxy
 148
 149 -- serveEndpoint ::
 150 --   ( SubApp ServerApp e
 151 --   , PubApp e
 152 --   ) =>
 153 --   [e -> IO ()] ->
 154 --   App e IO ->
 155 --   Server (API name)
 156 -- serveEndpoint publish app' = (liftIO . httpPubApp publish app') :<|> withSchema app' :<|> pure httpPlayground
 157 --
 158 -- withSchema :: (Applicative f) => App e m -> f Text
 159 -- withSchema = pure . LT.toStrict . decodeUtf8 . render
 160
 161 -- | Implementation of our API.
 162 --api :: Server API
 163 api
 164   :: (Typeable env, HasConnectionPool env, HasConfig env, HasMail env, HasJobEnv' env, HasSettings env)
 165   => ServerT API (GargM env GargError)
 166 api (SAS.Authenticated _auser) = httpPubApp [] app :<|> pure httpPlayground
 167 api _                          = panic "401 in graphql" -- SAS.throwAll (_ServerError # err401)