mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-22 23:11:41 +03:00
dc83352863
[GDC-487]: https://hasurahq.atlassian.net/browse/GDC-487?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ [GDC-488]: https://hasurahq.atlassian.net/browse/GDC-488?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8182 GitOrigin-RevId: 712953666e1a5ea07500f1e1aed669f27650f7a4
157 lines
8.1 KiB
Haskell
157 lines
8.1 KiB
Haskell
{-# OPTIONS_GHC -fno-warn-orphans #-}
|
|
|
|
module Hasura.Backends.DataConnector.Adapter.Execute
|
|
( DataConnectorPreparedQuery (..),
|
|
encodePreparedQueryToJsonText,
|
|
)
|
|
where
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
import Data.Aeson qualified as J
|
|
import Data.ByteString.Lazy qualified as BL
|
|
import Data.Environment qualified as Env
|
|
import Data.Text.Encoding qualified as TE
|
|
import Data.Text.Extended (toTxt)
|
|
import Hasura.Backends.DataConnector.API qualified as API
|
|
import Hasura.Backends.DataConnector.API.V0.ErrorResponse (ErrorResponse (..))
|
|
import Hasura.Backends.DataConnector.Adapter.ConfigTransform (transformSourceConfig)
|
|
import Hasura.Backends.DataConnector.Adapter.Types (SourceConfig (..))
|
|
import Hasura.Backends.DataConnector.Agent.Client (AgentClientT)
|
|
import Hasura.Backends.DataConnector.Plan.Common (Plan (..))
|
|
import Hasura.Backends.DataConnector.Plan.MutationPlan qualified as Plan
|
|
import Hasura.Backends.DataConnector.Plan.QueryPlan qualified as Plan
|
|
import Hasura.Backends.DataConnector.Plan.RemoteRelationshipPlan qualified as Plan
|
|
import Hasura.Base.Error (Code (..), QErr, throw400, throw400WithDetail)
|
|
import Hasura.EncJSON (EncJSON, encJFromBuilder, encJFromJValue)
|
|
import Hasura.GraphQL.Execute.Backend (BackendExecute (..), DBStepInfo (..), ExplainPlan (..), OnBaseMonad (..))
|
|
import Hasura.GraphQL.Namespace qualified as GQL
|
|
import Hasura.Prelude
|
|
import Hasura.RQL.Types.Common qualified as RQL
|
|
import Hasura.SQL.AnyBackend (mkAnyBackend)
|
|
import Hasura.SQL.Backend (BackendType (DataConnector))
|
|
import Hasura.Session
|
|
import Hasura.Tracing (MonadTrace)
|
|
import Servant.Client.Core.HasClient ((//))
|
|
import Servant.Client.Generic (genericClient)
|
|
|
|
data DataConnectorPreparedQuery
|
|
= QueryRequest API.QueryRequest
|
|
| MutationRequest API.MutationRequest
|
|
|
|
encodePreparedQueryToJsonText :: DataConnectorPreparedQuery -> Text
|
|
encodePreparedQueryToJsonText = \case
|
|
QueryRequest req -> encodeToJsonText req
|
|
MutationRequest req -> encodeToJsonText req
|
|
|
|
encodeToJsonText :: J.ToJSON a => a -> Text
|
|
encodeToJsonText =
|
|
TE.decodeUtf8 . BL.toStrict . J.encode
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
instance BackendExecute 'DataConnector where
|
|
type PreparedQuery 'DataConnector = DataConnectorPreparedQuery
|
|
type MultiplexedQuery 'DataConnector = Void
|
|
type ExecutionMonad 'DataConnector = AgentClientT
|
|
|
|
mkDBQueryPlan UserInfo {..} env sourceName sourceConfig ir _headers _gName = do
|
|
queryPlan@Plan {..} <- Plan.mkQueryPlan _uiSession sourceConfig ir
|
|
transformedSourceConfig <- transformSourceConfig sourceConfig [("$session", J.toJSON _uiSession), ("$env", J.toJSON env)] env
|
|
pure
|
|
DBStepInfo
|
|
{ dbsiSourceName = sourceName,
|
|
dbsiSourceConfig = transformedSourceConfig,
|
|
dbsiPreparedQuery = Just $ QueryRequest _pRequest,
|
|
dbsiAction = OnBaseMonad $ buildQueryAction sourceName transformedSourceConfig queryPlan,
|
|
dbsiResolvedConnectionTemplate = ()
|
|
}
|
|
|
|
mkDBQueryExplain fieldName UserInfo {..} sourceName sourceConfig ir _headers _gName = do
|
|
queryPlan@Plan {..} <- Plan.mkQueryPlan _uiSession sourceConfig ir
|
|
transformedSourceConfig <- transformSourceConfig sourceConfig [("$session", J.toJSON _uiSession), ("$env", J.object [])] Env.emptyEnvironment
|
|
pure $
|
|
mkAnyBackend @'DataConnector
|
|
DBStepInfo
|
|
{ dbsiSourceName = sourceName,
|
|
dbsiSourceConfig = transformedSourceConfig,
|
|
dbsiPreparedQuery = Just $ QueryRequest _pRequest,
|
|
dbsiAction = OnBaseMonad $ buildExplainAction fieldName sourceName transformedSourceConfig queryPlan,
|
|
dbsiResolvedConnectionTemplate = ()
|
|
}
|
|
|
|
mkDBMutationPlan UserInfo {..} env _stringifyNum sourceName sourceConfig mutationDB _headers _gName = do
|
|
mutationPlan@Plan {..} <- Plan.mkMutationPlan _uiSession mutationDB
|
|
transformedSourceConfig <- transformSourceConfig sourceConfig [("$session", J.toJSON _uiSession), ("$env", J.toJSON env)] env
|
|
pure
|
|
DBStepInfo
|
|
{ dbsiSourceName = sourceName,
|
|
dbsiSourceConfig = transformedSourceConfig,
|
|
dbsiPreparedQuery = Just $ MutationRequest _pRequest,
|
|
dbsiAction = OnBaseMonad $ buildMutationAction sourceName transformedSourceConfig mutationPlan,
|
|
dbsiResolvedConnectionTemplate = ()
|
|
}
|
|
|
|
mkLiveQuerySubscriptionPlan _ _ _ _ _ _ _ =
|
|
throw400 NotSupported "mkLiveQuerySubscriptionPlan: not implemented for the Data Connector backend."
|
|
|
|
mkDBStreamingSubscriptionPlan _ _ _ _ _ _ =
|
|
throw400 NotSupported "mkLiveQuerySubscriptionPlan: not implemented for the Data Connector backend."
|
|
|
|
mkDBRemoteRelationshipPlan env UserInfo {..} sourceName sourceConfig joinIds joinIdsSchema argumentIdFieldName (resultFieldName, ir) _ _ _ = do
|
|
remoteRelationshipPlan@Plan {..} <- Plan.mkRemoteRelationshipPlan _uiSession sourceConfig joinIds joinIdsSchema argumentIdFieldName resultFieldName ir
|
|
transformedSourceConfig <- transformSourceConfig sourceConfig [("$session", J.toJSON _uiSession), ("$env", J.toJSON env)] env
|
|
pure
|
|
DBStepInfo
|
|
{ dbsiSourceName = sourceName,
|
|
dbsiSourceConfig = transformedSourceConfig,
|
|
dbsiPreparedQuery = Just $ QueryRequest _pRequest,
|
|
dbsiAction = OnBaseMonad $ buildQueryAction sourceName transformedSourceConfig remoteRelationshipPlan,
|
|
dbsiResolvedConnectionTemplate = ()
|
|
}
|
|
|
|
mkSubscriptionExplain _ =
|
|
throw400 NotSupported "mkSubscriptionExplain: not implemented for the Data Connector backend."
|
|
|
|
buildQueryAction :: (MonadIO m, MonadTrace m, MonadError QErr m) => RQL.SourceName -> SourceConfig -> Plan API.QueryRequest API.QueryResponse -> AgentClientT m EncJSON
|
|
buildQueryAction sourceName SourceConfig {..} Plan {..} = do
|
|
-- NOTE: Should this check occur during query construction in 'mk*Plan'?
|
|
when (Plan.queryHasRelations _pRequest && isNothing (API._cRelationships _scCapabilities)) $
|
|
throw400 NotSupported "Agents must provide their own dataloader."
|
|
|
|
queryResponse <- queryGuard =<< (genericClient // API._query) (toTxt sourceName) _scConfig _pRequest
|
|
reshapedResponse <- _pResponseReshaper queryResponse
|
|
pure . encJFromBuilder $ J.fromEncoding reshapedResponse
|
|
where
|
|
errorAction e = throw400WithDetail DataConnectorError (API.errorResponseSummary e) (_crDetails e)
|
|
defaultAction = throw400 DataConnectorError "Unexpected data connector query response - Unexpected Type"
|
|
queryGuard = API.queryCase defaultAction pure errorAction
|
|
|
|
-- Delegates the generation to the Agent's /explain endpoint if it has that capability,
|
|
-- otherwise, returns the IR sent to the agent.
|
|
buildExplainAction :: (MonadIO m, MonadTrace m, MonadError QErr m) => GQL.RootFieldAlias -> RQL.SourceName -> SourceConfig -> Plan API.QueryRequest API.QueryResponse -> AgentClientT m EncJSON
|
|
buildExplainAction fieldName sourceName SourceConfig {..} Plan {..} =
|
|
case API._cExplain _scCapabilities of
|
|
Nothing -> pure . encJFromJValue . toExplainPlan fieldName $ _pRequest
|
|
Just API.ExplainCapabilities -> do
|
|
explainResponse <- (genericClient // API._explain) (toTxt sourceName) _scConfig _pRequest
|
|
pure . encJFromJValue $
|
|
ExplainPlan
|
|
fieldName
|
|
(Just (API._erQuery explainResponse))
|
|
(Just (API._erLines explainResponse))
|
|
|
|
toExplainPlan :: GQL.RootFieldAlias -> API.QueryRequest -> ExplainPlan
|
|
toExplainPlan fieldName queryRequest =
|
|
ExplainPlan fieldName (Just "") (Just [encodeToJsonText queryRequest])
|
|
|
|
buildMutationAction :: (MonadIO m, MonadTrace m, MonadError QErr m) => RQL.SourceName -> SourceConfig -> Plan API.MutationRequest API.MutationResponse -> AgentClientT m EncJSON
|
|
buildMutationAction sourceName SourceConfig {..} Plan {..} = do
|
|
queryResponse <- mutationGuard =<< (genericClient // API._mutation) (toTxt sourceName) _scConfig _pRequest
|
|
reshapedResponse <- _pResponseReshaper queryResponse
|
|
pure . encJFromBuilder $ J.fromEncoding reshapedResponse
|
|
where
|
|
errorAction e = throw400WithDetail DataConnectorError (API.errorResponseSummary e) (_crDetails e)
|
|
defaultAction = throw400 DataConnectorError "Unexpected data connector mutations response - Unexpected Type"
|
|
mutationGuard = API.mutationCase defaultAction pure errorAction
|