graphene-django: Raising exceptions without logging them

Whenever exceptions are raised they’re logged in the console (and in Sentry if it’s used).

Many of these exceptions are only intended to be shown to the user. For example, django-graphql-jwt raises the PermissionDenied exception for the login_required decorator.

The problem is this pollutes the console output during testing/development and logs unnecessary errors to Sentry. For exceptions such as the example above, that’s only intended to be shown to the user.

As a workaround I’ve tried writing middleware that catches any exceptions thrown:

class ExceptionFilterMiddleware:
    IGNORED_EXCEPTIONS = (
        # Local exceptions
        ValidationException,
        # Third-party exceptions
        JSONWebTokenExpired,
        PermissionDenied,
    )

    def on_error(self, error):
        if not isinstance(error, self.IGNORED_EXCEPTIONS):
            return error

    def resolve(self, next, *args, **kwargs):
        return next(*args, **kwargs).catch(self.on_error)

But if an exception is caught, it no longer populates the errors field in query/mutation output. Therefore all errors are logged, there’s no way to conditionally log exceptions.

This means the only solution is to create a logging filter like the following:

def skip_valid_exceptions(record):
    """
    Skip exceptions for errors only intended to be displayed to the API user.
    """
    skip: bool = False

    if record.exc_info:
        exc_type, exc_value = record.exc_info[:2]
        skip = isinstance(exc_value, valid_exceptions)

    return not skip

But this doesn’t work either because record.exc_info is None whenever an error is thrown with Graphene, therefore it’s not possible to conditionally filter out exceptions based on their type.

Is there a solution for this? Seems like it’d be a common issue but I’ve had trouble finding one. Something like this would be nice to be able to implement. Thanks in advance.

About this issue

Original URL
State: open
Created 5 years ago
Reactions: 23
Comments: 15

Most upvoted comments

Responding to remove the bot’s label. I still have this issue and it’s important.

demeralde on Jan 3, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] on Dec 29, 2019

The problem is that report_error method from ExecutionContext class in graphql.execution.utilsis doing logger.error("".join(exception)) I have managed to fix this by monkey patch this class method.

from traceback import format_exception
from graphql.execution.utils import ExecutionContext, logger


def new_report_error(self, error, traceback=None):
    if not (
        hasattr(error, "original_error")
        and isinstance(error.original_error, IGNORED_EXCEPTIONS)
    ):
        exception = format_exception(
            type(error), error, getattr(error, "stack", None) or traceback
        )
        logger.error("".join(exception))

    self.errors.append(error)


# Monkey patch report_error method from ExecutionContext class
ExecutionContext.report_error = new_report_error

marcelombc on Oct 6, 2020

I’m currently using the following logging filter to filter out GraphQLLocatedErrors, which get raised by the @login_required decorator of graphql_jwt when users are not authenticated:

class GraphQLLogFilter(logging.Filter):
    def filter(self, record):
        if record.msg and 'GraphQLLocatedError' in record.msg:
            return None
        return True

# settings.py
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'handlers': {
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
        },
    },
    'filters': {
        'graphql_log_filter': {
            '()': GraphQLLogFilter,
        }
    },
    'loggers': {
        'graphql.execution.utils': {
            'level': 'WARNING',
            'handlers': ['console'],
            'filters': ['graphql_log_filter'],
        },
    },
}

Nevertheless this exceptions should not end up in logging at all. I hope for a solution.

philipptrenz on Oct 11, 2021

No idea what’s going on here. I think this issue should be prioritised, it’s been over 2 years.

demeralde on Oct 11, 2021

@dspacejs I don’t think the update has anything to address this issue, but if the issue still exist after the update, fixes on the core package will be more likely to get merged.

ulgens on May 19, 2020