Prospero.Wrapper

data Wrapper :: Type -> Row Type -> Typedata Wrapper ctx errs

A collection of wrappers that can be applied to a schema

Constructors

• WrapOverall (OverallWrapper ctx errs)
• WrapParsing ParsingWrapper
• WrapValidation ValidationWrapper
• WrapExecution (ExecutionWrapper ctx errs)
• WrapField (FieldWrapper ctx errs)
• WrapIntrospection (IntrospectionWrapper ctx errs)

type OverallWrapper :: Type -> Row Type -> Typetype OverallWrapper ctx errs = (String -> Om ctx errs GraphQLResponse) -> String -> Om ctx errs GraphQLResponse

Overall wrapper: wraps the entire query processing pipeline

type ParsingWrapper = (String -> Either String (Array Selection)) -> String -> Either String (Array Selection)

Parsing wrapper: wraps query parsing

type ValidationWrapper = (Array Selection -> Array GraphQLError) -> Array Selection -> Array GraphQLError

Validation wrapper: wraps query validation

type ExecutionWrapper :: Type -> Row Type -> Typetype ExecutionWrapper ctx errs = (Array Selection -> Om ctx errs ResponseValue) -> Array Selection -> Om ctx errs ResponseValue

Execution wrapper: wraps query execution

data FieldWrapper :: Type -> Row Type -> Typedata FieldWrapper ctx errs

Field wrapper: wraps individual field resolution

Constructors

• FieldWrapper (String -> String -> Om ctx errs ResponseValue -> Om ctx errs ResponseValue)

type IntrospectionWrapper :: Type -> Row Type -> Typetype IntrospectionWrapper ctx errs = (Array Selection -> Om ctx errs ResponseValue) -> Array Selection -> Om ctx errs ResponseValue

Introspection wrapper: wraps introspection queries

wrapOverall :: forall ctx errs. OverallWrapper ctx errs -> Wrapper ctx errs

wrapParsing :: forall ctx errs. ParsingWrapper -> Wrapper ctx errs

wrapValidation :: forall ctx errs. ValidationWrapper -> Wrapper ctx errs

wrapExecution :: forall ctx errs. ExecutionWrapper ctx errs -> Wrapper ctx errs

wrapField :: forall ctx errs. FieldWrapper ctx errs -> Wrapper ctx errs

wrapIntrospection :: forall ctx errs. IntrospectionWrapper ctx errs -> Wrapper ctx errs

maxDepth :: forall ctx errs. Int -> Wrapper ctx errs

Pre-built wrapper: reject queries deeper than maxDepth

maxFields :: forall ctx errs. Int -> Wrapper ctx errs

Pre-built wrapper: reject queries with more than maxFields total fields

maxCost :: forall ctx errs. GqlType -> Int -> Wrapper ctx errs

Pre-built wrapper: reject queries exceeding a cost budget

maxCostFor :: forall ctx errs gql. { query :: GqlType | gql } -> Int -> Wrapper ctx errs

validateLimits :: forall ctx errs. GqlType -> { maxCost :: Maybe Int, maxDepth :: Maybe Int, maxFields :: Maybe Int } -> Wrapper ctx errs

Pre-built wrapper: check depth, field count, and cost in a single pass

validateLimitsFor :: forall ctx errs gql. { query :: GqlType | gql } -> { maxCost :: Maybe Int, maxDepth :: Maybe Int, maxFields :: Maybe Int } -> Wrapper ctx errs

timeout :: forall ctx errs. Int -> Wrapper ctx errs

Pre-built wrapper: apply a timeout to execution (in milliseconds)

logSlowFields :: forall ctx errs. Int -> Wrapper ctx errs

Pre-built wrapper: log fields that take longer than a threshold (in milliseconds)