"""Sentry Client.

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

https://docs.getsentry.com/hosted/clients/python/usage/
"""

import sentry_sdk
from owsresponse import response


def send_response_to_sentry(response: response.Response, sentry_message: str) -> None:
    """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.

    """
    with sentry_sdk.new_scope() as scope:
        scope.set_extra('message', response.message)
        scope.set_extra('errors', response.errors)
        scope.set_extra('status', response.status)

        sentry_sdk.capture_message(message=sentry_message)