mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-17 20:41:49 +03:00
e99f9a2f57
## Description This PR removes `MetadataStorageT`, and cleans up all top-level error handling. In short: this PR changes `MonadMetadataStorage` to explicitly return a bunch of `Either QErr a`, instead of relying on the stack providing a `MonadError QErr`. Since we implement that class on the base monad *below any ExceptT*, this removes a lot of very complicated instances that make assumptions about the shape of the stack. On the back of this, we can remove several layers of ExceptT from the core of the code, including the one in `RunT`, which allows us to remove several instances of `liftEitherM . runExceptT`. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7689 GitOrigin-RevId: 97d600154d690f58c0b93fb4cc2d30fd383fd8b8
92 lines
2.9 KiB
Haskell
92 lines
2.9 KiB
Haskell
-- |
|
|
-- This module holds functions and data types used for logging at the GraphQL
|
|
-- layer. In contrast with, logging at the HTTP server layer.
|
|
module Hasura.GraphQL.Logging
|
|
( QueryLog (..),
|
|
GeneratedQuery (..),
|
|
MonadQueryLog (..),
|
|
QueryLogKind (..),
|
|
)
|
|
where
|
|
|
|
import Data.Aeson qualified as J
|
|
import Data.HashMap.Strict qualified as Map
|
|
import Data.Text.Extended
|
|
import Hasura.GraphQL.Namespace (RootFieldAlias)
|
|
import Hasura.GraphQL.Transport.HTTP.Protocol (GQLReqUnparsed)
|
|
import Hasura.Logging qualified as L
|
|
import Hasura.Prelude
|
|
import Hasura.RQL.DDL.ConnectionTemplate (BackendResolvedConnectionTemplate (..))
|
|
import Hasura.Server.Types (RequestId)
|
|
import Hasura.Tracing (TraceT)
|
|
|
|
-- | A GraphQL query, optionally generated SQL, and the request id makes up the
|
|
-- | 'QueryLog'
|
|
data QueryLog = QueryLog
|
|
{ _qlQuery :: !GQLReqUnparsed,
|
|
_qlGeneratedSql :: !(Maybe (RootFieldAlias, GeneratedQuery)),
|
|
_qlRequestId :: !RequestId,
|
|
_qlKind :: !QueryLogKind
|
|
}
|
|
|
|
data QueryLogKind
|
|
= QueryLogKindDatabase (Maybe (BackendResolvedConnectionTemplate))
|
|
| QueryLogKindAction
|
|
| QueryLogKindRemoteSchema
|
|
| QueryLogKindCached
|
|
| QueryLogKindIntrospection
|
|
|
|
instance J.ToJSON QueryLogKind where
|
|
toJSON = \case
|
|
QueryLogKindDatabase _ -> "database"
|
|
QueryLogKindAction -> "action"
|
|
QueryLogKindRemoteSchema -> "remote-schema"
|
|
QueryLogKindCached -> "cached"
|
|
QueryLogKindIntrospection -> "introspection"
|
|
|
|
data GeneratedQuery = GeneratedQuery
|
|
{ _gqQueryString :: Text,
|
|
_gqPreparedArgs :: J.Value
|
|
}
|
|
|
|
instance J.ToJSON QueryLog where
|
|
toJSON (QueryLog gqlQuery generatedQuery reqId kind) =
|
|
J.object $
|
|
[ "query" J..= gqlQuery,
|
|
-- NOTE: this customizes the default JSON instance of a pair
|
|
"generated_sql" J..= fmap fromPair generatedQuery,
|
|
"request_id" J..= reqId,
|
|
"kind" J..= kind
|
|
]
|
|
<> maybe [] (\val -> ["connection_template" J..= val]) (getResolvedConnectionTemplate kind)
|
|
where
|
|
fromPair p = Map.fromList [first toTxt p]
|
|
getResolvedConnectionTemplate :: QueryLogKind -> Maybe (BackendResolvedConnectionTemplate)
|
|
getResolvedConnectionTemplate (QueryLogKindDatabase x) = x
|
|
getResolvedConnectionTemplate _ = Nothing
|
|
|
|
instance J.ToJSON GeneratedQuery where
|
|
toJSON (GeneratedQuery queryString preparedArgs) =
|
|
J.object
|
|
[ "query" J..= queryString,
|
|
"prepared_arguments" J..= preparedArgs
|
|
]
|
|
|
|
instance L.ToEngineLog QueryLog L.Hasura where
|
|
toEngineLog ql = (L.LevelInfo, L.ELTQueryLog, J.toJSON ql)
|
|
|
|
class Monad m => MonadQueryLog m where
|
|
logQueryLog ::
|
|
L.Logger L.Hasura ->
|
|
QueryLog ->
|
|
m ()
|
|
|
|
instance MonadQueryLog m => MonadQueryLog (ExceptT e m) where
|
|
logQueryLog logger l = lift $ logQueryLog logger l
|
|
|
|
instance MonadQueryLog m => MonadQueryLog (ReaderT r m) where
|
|
logQueryLog logger l = lift $ logQueryLog logger l
|
|
|
|
instance MonadQueryLog m => MonadQueryLog (TraceT m) where
|
|
logQueryLog logger l = lift $ logQueryLog logger l
|