Safe Haskell	None
Language	Haskell2010

Hasura.GraphQL.Transport.HTTP.Protocol

Synopsis

newtype GQLExecDoc = GQLExecDoc {
- unGQLExecDoc :: [ExecutableDefinition Name]
}
newtype OperationName = OperationName {
- _unOperationName :: Name
}
type VariableValues = HashMap Name Value
data GQLReq a = GQLReq {
- _grOperationName :: !(Maybe OperationName)
- _grQuery :: !a
- _grVariables :: !(Maybe VariableValues)
}
data GQLBatchedReqs a
- = GQLSingleRequest a
- | GQLBatchedReqs [a]
newtype GQLQueryText = GQLQueryText {
- _unGQLQueryText :: Text
}
type GQLReqUnparsed = GQLReq GQLQueryText
type GQLReqParsed = GQLReq GQLExecDoc
type ReqsText = GQLBatchedReqs (GQLReq GQLQueryText)
type GQLReqOutgoing = GQLReq SingleOperation
type SingleOperation = TypedOperationDefinition NoFragments Name
renderGQLReqOutgoing :: GQLReqOutgoing -> GQLReqUnparsed
getSingleOperation :: MonadError QErr m => GQLReqParsed -> m SingleOperation
toParsed :: MonadError QErr m => GQLReqUnparsed -> m GQLReqParsed
encodeGQErr :: Bool -> QErr -> Value
type GQResult a = Either GQExecError a
newtype GQExecError = GQExecError [Value]
type GQResponse = GQResult ByteString
isExecError :: GQResult a -> Bool
encodeGQResp :: GQResponse -> EncJSON
decodeGQResp :: EncJSON -> (Maybe GQResponse, EncJSON)
encodeHTTPResp :: GQResponse -> EncJSON

Documentation

newtype GQLExecDoc Source #

Constructors

GQLExecDoc
Fields unGQLExecDoc :: [ExecutableDefinition Name]

Instances

Instances details

Eq GQLExecDoc Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods (==) :: GQLExecDoc -> GQLExecDoc -> Bool # (/=) :: GQLExecDoc -> GQLExecDoc -> Bool #
Ord GQLExecDoc Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods compare :: GQLExecDoc -> GQLExecDoc -> Ordering # (<) :: GQLExecDoc -> GQLExecDoc -> Bool # (<=) :: GQLExecDoc -> GQLExecDoc -> Bool # (>) :: GQLExecDoc -> GQLExecDoc -> Bool # (>=) :: GQLExecDoc -> GQLExecDoc -> Bool # max :: GQLExecDoc -> GQLExecDoc -> GQLExecDoc # min :: GQLExecDoc -> GQLExecDoc -> GQLExecDoc #
Show GQLExecDoc Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods showsPrec :: Int -> GQLExecDoc -> ShowS # show :: GQLExecDoc -> String # showList :: [GQLExecDoc] -> ShowS #
Hashable GQLExecDoc Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods hashWithSalt :: Int -> GQLExecDoc -> Int hash :: GQLExecDoc -> Int
FromJSON GQLExecDoc Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods parseJSON :: Value -> Parser GQLExecDoc parseJSONList :: Value -> Parser [GQLExecDoc]
ToJSON GQLExecDoc Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods toJSON :: GQLExecDoc -> Value toEncoding :: GQLExecDoc -> Encoding toJSONList :: [GQLExecDoc] -> Value toEncodingList :: [GQLExecDoc] -> Encoding
Lift GQLExecDoc Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods lift :: GQLExecDoc -> Q Exp # liftTyped :: GQLExecDoc -> Q (TExp GQLExecDoc) #

newtype OperationName Source #

Constructors

OperationName
Fields _unOperationName :: Name

Instances

Instances details

Eq OperationName Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods (==) :: OperationName -> OperationName -> Bool # (/=) :: OperationName -> OperationName -> Bool #
Ord OperationName Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods compare :: OperationName -> OperationName -> Ordering # (<) :: OperationName -> OperationName -> Bool # (<=) :: OperationName -> OperationName -> Bool # (>) :: OperationName -> OperationName -> Bool # (>=) :: OperationName -> OperationName -> Bool # max :: OperationName -> OperationName -> OperationName # min :: OperationName -> OperationName -> OperationName #
Show OperationName Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods showsPrec :: Int -> OperationName -> ShowS # show :: OperationName -> String # showList :: [OperationName] -> ShowS #
Hashable OperationName Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods hashWithSalt :: Int -> OperationName -> Int hash :: OperationName -> Int
FromJSON OperationName Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods parseJSON :: Value -> Parser OperationName parseJSONList :: Value -> Parser [OperationName]
ToJSON OperationName Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods toJSON :: OperationName -> Value toEncoding :: OperationName -> Encoding toJSONList :: [OperationName] -> Value toEncodingList :: [OperationName] -> Encoding
Lift OperationName Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods lift :: OperationName -> Q Exp # liftTyped :: OperationName -> Q (TExp OperationName) #

type VariableValues = HashMap Name Value Source #

data GQLReq a Source #

https://graphql.org/learn/serving-over-http/#post-request

See GQLReqParsed for invariants.

Constructors

GQLReq
Fields _grOperationName :: !(Maybe OperationName) _grQuery :: !a _grVariables :: !(Maybe VariableValues)

Instances

Instances details

Functor GQLReq Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods fmap :: (a -> b) -> GQLReq a -> GQLReq b # (<$) :: a -> GQLReq b -> GQLReq a #
Lift a => Lift (GQLReq a :: Type) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods lift :: GQLReq a -> Q Exp # liftTyped :: GQLReq a -> Q (TExp (GQLReq a)) #
Eq a => Eq (GQLReq a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods (==) :: GQLReq a -> GQLReq a -> Bool # (/=) :: GQLReq a -> GQLReq a -> Bool #
Show a => Show (GQLReq a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods showsPrec :: Int -> GQLReq a -> ShowS # show :: GQLReq a -> String # showList :: [GQLReq a] -> ShowS #
Generic (GQLReq a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Associated Types type Rep (GQLReq a) :: Type -> Type # Methods from :: GQLReq a -> Rep (GQLReq a) x # to :: Rep (GQLReq a) x -> GQLReq a #
Hashable a => Hashable (GQLReq a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods hashWithSalt :: Int -> GQLReq a -> Int hash :: GQLReq a -> Int
FromJSON a => FromJSON (GQLReq a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods parseJSON :: Value -> Parser (GQLReq a) parseJSONList :: Value -> Parser [GQLReq a]
ToJSON a => ToJSON (GQLReq a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods toJSON :: GQLReq a -> Value toEncoding :: GQLReq a -> Encoding toJSONList :: [GQLReq a] -> Value toEncodingList :: [GQLReq a] -> Encoding
type Rep (GQLReq a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol type Rep (GQLReq a) = D1 ('MetaData "GQLReq" "Hasura.GraphQL.Transport.HTTP.Protocol" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "GQLReq" 'PrefixI 'True) (S1 ('MetaSel ('Just "_grOperationName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe OperationName)) :: (S1 ('MetaSel ('Just "_grQuery") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :: S1 ('MetaSel ('Just "_grVariables") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe VariableValues)))))

data GQLBatchedReqs a Source #

Batched queries are sent as a JSON array of GQLReq records. This newtype exists to support the unusual JSON encoding.

See https://github.com/hasura/graphql-engine/issues/1812.

Constructors

GQLSingleRequest a
GQLBatchedReqs [a]

Instances

Instances details

Functor GQLBatchedReqs Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods fmap :: (a -> b) -> GQLBatchedReqs a -> GQLBatchedReqs b # (<$) :: a -> GQLBatchedReqs b -> GQLBatchedReqs a #
Eq a => Eq (GQLBatchedReqs a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods (==) :: GQLBatchedReqs a -> GQLBatchedReqs a -> Bool # (/=) :: GQLBatchedReqs a -> GQLBatchedReqs a -> Bool #
Show a => Show (GQLBatchedReqs a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods showsPrec :: Int -> GQLBatchedReqs a -> ShowS # show :: GQLBatchedReqs a -> String # showList :: [GQLBatchedReqs a] -> ShowS #
Generic (GQLBatchedReqs a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Associated Types type Rep (GQLBatchedReqs a) :: Type -> Type # Methods from :: GQLBatchedReqs a -> Rep (GQLBatchedReqs a) x # to :: Rep (GQLBatchedReqs a) x -> GQLBatchedReqs a #
FromJSON a => FromJSON (GQLBatchedReqs a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods parseJSON :: Value -> Parser (GQLBatchedReqs a) parseJSONList :: Value -> Parser [GQLBatchedReqs a]
ToJSON a => ToJSON (GQLBatchedReqs a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods toJSON :: GQLBatchedReqs a -> Value toEncoding :: GQLBatchedReqs a -> Encoding toJSONList :: [GQLBatchedReqs a] -> Value toEncodingList :: [GQLBatchedReqs a] -> Encoding
type Rep (GQLBatchedReqs a) Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol type Rep (GQLBatchedReqs a) = D1 ('MetaData "GQLBatchedReqs" "Hasura.GraphQL.Transport.HTTP.Protocol" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "GQLSingleRequest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a)) :+: C1 ('MetaCons "GQLBatchedReqs" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [a])))

newtype GQLQueryText Source #

Constructors

GQLQueryText
Fields _unGQLQueryText :: Text

Instances

Instances details

Eq GQLQueryText Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods (==) :: GQLQueryText -> GQLQueryText -> Bool # (/=) :: GQLQueryText -> GQLQueryText -> Bool #
Ord GQLQueryText Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods compare :: GQLQueryText -> GQLQueryText -> Ordering # (<) :: GQLQueryText -> GQLQueryText -> Bool # (<=) :: GQLQueryText -> GQLQueryText -> Bool # (>) :: GQLQueryText -> GQLQueryText -> Bool # (>=) :: GQLQueryText -> GQLQueryText -> Bool # max :: GQLQueryText -> GQLQueryText -> GQLQueryText # min :: GQLQueryText -> GQLQueryText -> GQLQueryText #
Show GQLQueryText Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods showsPrec :: Int -> GQLQueryText -> ShowS # show :: GQLQueryText -> String # showList :: [GQLQueryText] -> ShowS #
IsString GQLQueryText Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods fromString :: String -> GQLQueryText #
Hashable GQLQueryText Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods hashWithSalt :: Int -> GQLQueryText -> Int hash :: GQLQueryText -> Int
FromJSON GQLQueryText Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods parseJSON :: Value -> Parser GQLQueryText parseJSONList :: Value -> Parser [GQLQueryText]
ToJSON GQLQueryText Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods toJSON :: GQLQueryText -> Value toEncoding :: GQLQueryText -> Encoding toJSONList :: [GQLQueryText] -> Value toEncodingList :: [GQLQueryText] -> Encoding

type GQLReqUnparsed = GQLReq GQLQueryText Source #

We've not yet parsed the graphql query string parameter of the POST.

type GQLReqParsed = GQLReq GQLExecDoc Source #

Invariants:

when _grOperationName is Nothing, _grQuery contains exactly one ExecutableDefinitionOperation (and zero or more ExecutableDefinitionFragment)
when _grOperationName is present, there is a corresponding ExecutableDefinitionOperation in _grQuery

type ReqsText = GQLBatchedReqs (GQLReq GQLQueryText) Source #

type GQLReqOutgoing = GQLReq SingleOperation Source #

A simplified form of GQLReqParsed which is more ergonomic in particular for APIs that act as graphql clients (e.g. in remote relationship execution). This is a "desugared" request in which fragments have been inlined (see inlineSelectionSet), and the operation (_grOperationName) to be executed is the only payload (in contrast to a ExecutableDocument with possibly many named operations).

_grOperationName is essentially ignored here, but should correspond with _todName if present.

These could maybe benefit from an HKD refactoring.

type SingleOperation = TypedOperationDefinition NoFragments Name Source #

A single graphql operation to be executed, with fragment definitions inlined. This is the simplified form of GQLExecDoc or ExecutableDocument:

renderGQLReqOutgoing :: GQLReqOutgoing -> GQLReqUnparsed Source #

getSingleOperation :: MonadError QErr m => GQLReqParsed -> m SingleOperation Source #

Obtain the actual single operation to be executed, from the possibly- multi-operation document, validating per the spec and inlining any fragment definitions (pre-defined parts of a graphql query) at fragment spreads (locations where fragments are "spliced"). See:

https://spec.graphql.org/June2018/#sec-Executable-Definitions and... https://graphql.org/learn/serving-over-http/

toParsed :: MonadError QErr m => GQLReqUnparsed -> m GQLReqParsed Source #

encodeGQErr :: Bool -> QErr -> Value Source #

type GQResult a = Either GQExecError a Source #

newtype GQExecError Source #

Constructors

GQExecError [Value]

Instances

Instances details

Eq GQExecError Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods (==) :: GQExecError -> GQExecError -> Bool # (/=) :: GQExecError -> GQExecError -> Bool #
Show GQExecError Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods showsPrec :: Int -> GQExecError -> ShowS # show :: GQExecError -> String # showList :: [GQExecError] -> ShowS #
ToJSON GQExecError Source #
Instance details Defined in Hasura.GraphQL.Transport.HTTP.Protocol Methods toJSON :: GQExecError -> Value toEncoding :: GQExecError -> Encoding toJSONList :: [GQExecError] -> Value toEncodingList :: [GQExecError] -> Encoding

type GQResponse = GQResult ByteString Source #

isExecError :: GQResult a -> Bool Source #

encodeGQResp :: GQResponse -> EncJSON Source #

decodeGQResp :: EncJSON -> (Maybe GQResponse, EncJSON) Source #

encodeHTTPResp :: GQResponse -> EncJSON Source #