MaskErrors

This extension hides error messages from the client to prevent exposing sensitive details. By default it masks all errors raised in any field resolver.

Usage example:

import strawberry
from strawberry.extensions import MaskErrors
 
schema = strawberry.Schema(
    Query,
    extensions=[
        MaskErrors(),
    ]
)

API reference:

class MaskErrors(should_mask_error=default_should_mask_error, error_message="Unexpected error.")`

should_mask_error: Callable[[GraphQLError], bool] = default_should_mask_error

Predicate function to check if a GraphQLError should be masked or not. Use the original_error attribute to access the original error that was raised in the resolver.

📝 Note

The default_should_mask_error function always returns True.

error_message: str = "Unexpected error."

The error message to display to the client when there is an error.

More examples:

Hide some exceptions
import strawberry
from strawberry.extensions import MaskErrors
from graphql.error import GraphQLError


class VisibleError(Exception):
    pass


def should_mask_error(error: GraphQLError) -> bool:
    original_error = error.original_error
    if original_error and isinstance(original_error, VisibleError):
        return False


    return True


schema = strawberry.Schema(
    Query,
    extensions=[
        MaskErrors(should_mask_error=should_mask_error),
    ]
)
Change error message
import strawberry
from strawberry.extensions import MaskErrors
 
schema = strawberry.Schema(
    Query,
    extensions=[
        MaskErrors(error_message="Oh no! An error occured. Very sorry about that."),
    ]
)

Was this helpful? What can we improve?

Edit on Github

Newsletter 💌

Do you want to receive the latest updates on Strawberry? Subscribe to our newsletter!