"""Sentry Client.

Provides sentry_client attribute for ad hoc capturing of messages and errors.

https://docs.sentry.io/platforms/python/
"""

import sentry_sdk

from notifications import config


def get_client():
    """Return initialized Sentry client.

    If config.SENTRY is set, Sentry SDK is initialized, if
    it is not set, Sentry SDK is not initialized but calls will be no-ops.

    Returns:
        bool: True if Sentry is configured, False otherwise.
    """
    if config.SENTRY:
        sentry_sdk.init(dsn=config.SENTRY)
        return True
    return False


def send_response_to_sentry(response, sentry_message):
    """Send a Response object to Sentry.

    This method should be used to send a Response object & message
    to Sentry when an error occurs that we should be alerted about.

    ex.
        error_response = response.create_fatal_response('Something bad')
        sentry.send_response_to_sentry(error_response, response.errors['code'])

    Args:
        response (Response): Response object to send to Sentry.
        sentry_message (str): Message to be displayed in Sentry. Best practice
            for errors is for the sentry_message to be the error code so that
            all errors of the same type are grouped together.
    """
    sentry_sdk.capture_message(
        message=sentry_message,
        level='error',
        extra={
            'message': response.message,
            'errors': response.errors,
            'status': response.status})


sentry_client = get_client()