Struct OnGraphQLValidationStartHookPayload 

pub struct OnGraphQLValidationStartHookPayload<'exec> {
    pub router_http_request: &'exec RouterHttpRequest<'exec>,
    pub context: &'exec PluginContext,
    pub schema: Arc<ConsumerSchema>,
    pub document: Arc<Document>,
    pub validation_plan: Arc<ValidationPlan>,
    pub errors: Option<Arc<Vec<ValidationError>>>,
}

Fields

router_http_request: &'exec RouterHttpRequest<'exec>

The incoming HTTP request to the router for which the GraphQL execution is happening. It includes all the details of the request such as headers, body, etc.

Example:

 let my_header = payload.router_http_request.headers.get("my-header");
 // do something with the header...
 payload.proceed()

context: &'exec PluginContext

The context object that can be used to share data across different plugin hooks for the same request. It is unique per request and is dropped after the response is sent.

Learn more about the context data sharing in the docs

schema: Arc<ConsumerSchema>

The GraphQL Schema that the document will be validated against. This is not the same with the supergraph. This is the public schema exposed by the router to the clients, which is generated from the supergraph and can be modified by the plugins. The plugins can replace the input schema to be used for validation and the new schema will be used in the validation process instead of the original one.

See an example to see when to override the schema

document: Arc<Document>

Parsed GraphQL document from the query string in the GraphQL parameters. It contains the Abstract Syntax Tree (AST) representation of the GraphQL query, mutation, or subscription sent by the client in the request body.

But the plugins can replace the input document AST to be used for validation and the new document will be used in the validation process instead of the original one.

validation_plan: Arc<ValidationPlan>

The set of rules to be used in the validation process. The plugins can modify the validation rules to be used in the validation process by adding new rules or removing existing ones.

See an example

errors: Option<Arc<Vec<ValidationError>>>

Overriding the validation errors to be used in the execution instead of the ones generated from the validation process. This is useful for plugins that want to generate custom validation errors in a custom way, or want to override the validation errors for testing or other purposes.

Learn more about overriding the default behavior

Implementations

impl OnGraphQLValidationStartHookPayload<'_>

pub fn with_validation_plan<TValidationPlan: Into<ValidationPlan>>( self, validation_plan: TValidationPlan, ) -> Self

Override validation rules to be used in the validation process by adding a new rule. See an example

pub fn with_schema<TSchema: Into<Arc<SchemaDocument>>>( self, schema: TSchema, ) -> Self

Override the GraphQL Schema that the document will be validated against. See an example to see when to override the schema

impl<'exec> OnGraphQLValidationStartHookPayload<'exec>

pub fn with_validation_rule<TValidationRule: ValidationRule + 'static>( self, rule: TValidationRule, ) -> Self

Adds a new validation rule to the existing set of rules to be used in the validation process. See an example

pub fn filter_validation_rules<F>(self, f: F) -> Self

where F: FnMut(&Box<dyn ValidationRule>) -> bool,

Filters the existing validation rules to be used in the validation process by removing the rules that don’t satisfy the given predicate function.

Trait Implementations

impl<'exec> StartHookPayload<OnGraphQLValidationEndHookPayload, Response> for OnGraphQLValidationStartHookPayload<'exec>

fn proceed<'exec>(self) -> StartHookResult<'exec, Self, TEndPayload, TResponse>

Continue with the regular flow of the hook This is called in most cases when you don’t short-circuit the hook with a response or an error.

fn end_with_response<'exec>( self, output: TResponse, ) -> StartHookResult<'exec, Self, TEndPayload, TResponse>

End the hook execution and return a response to the client immediately, skipping the rest of the execution flow.

fn end_with_graphql_error<'exec>( self, error: GraphQLError, status_code: StatusCode, ) -> StartHookResult<'exec, Self, TEndPayload, TResponse>

where TResponse: FromGraphQLErrorToResponse,

End the hook execution with a GraphQL error, returning a response with the appropriate error format to the client immediately, skipping the rest of the execution flow.

fn on_end<'exec, F>( self, f: F, ) -> StartHookResult<'exec, Self, TEndPayload, TResponse>

where F: FnOnce(TEndPayload) -> EndHookResult<TEndPayload, TResponse> + Send + 'exec,

Attach a callback to be executed at the end of the hook, allowing you to manipulate the end payload or response. This is useful when you want to execute some logic after the main execution of the hook