graphql-python / graphql-python/graphene-django

Raising exceptions without logging them

Open
#780 16 comments 24 reactions 0 assignees View on GitHub
✨enhancement
Dominant language
Python
Stars
4.4k
Forks
760
PR merge metrics
No merged PRs in 30d

Description

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](https://github.com/flavors/django-graphql-jwt/blob/master/graphql_jwt/exceptions.py#L14) for the [`login_required` decorator](https://github.com/flavors/django-graphql-jwt/blob/master/graphql_jwt/decorators.py#L48).

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:

```python
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:

```python
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](https://medium.com/@tarkus/validation-and-user-errors-in-graphql-mutations-39ca79cd00bf) would be nice to be able to implement. Thanks in advance.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.