mirror of
https://github.com/GSA/notifications-api.git
synced 2025-12-23 08:51:30 -05:00
93ce1d2503
The admin app validation did not catch this problem. But the API did. This PR is a small fix to catch the erorr thrown by the notifications-utils/recipient validation methods and return a 400 status rather than a 500. This only solves the issue of the user seeing "We are experiencing technical difficulties" rather than "invalid email address" The bug can be replicated if you enter use quotes when entering the email address. More work needs to be done so that the admin app does the same validation as the api so the user sees a nice form validtion error rather than a 400 after clicking send. See: https://www.pivotaltracker.com/story/show/154472625
118 lines
4.2 KiB
Python
118 lines
4.2 KiB
Python
from flask import (
|
|
jsonify,
|
|
current_app,
|
|
json)
|
|
from notifications_utils.recipients import InvalidEmailError
|
|
from sqlalchemy.exc import SQLAlchemyError, DataError
|
|
from sqlalchemy.orm.exc import NoResultFound
|
|
from marshmallow import ValidationError
|
|
from jsonschema import ValidationError as JsonSchemaValidationError
|
|
from app.authentication.auth import AuthError
|
|
|
|
|
|
class InvalidRequest(Exception):
|
|
code = None
|
|
fields = []
|
|
|
|
def __init__(self, message, status_code):
|
|
super().__init__()
|
|
self.message = message
|
|
self.status_code = status_code
|
|
|
|
def to_dict(self):
|
|
return {'result': 'error', 'message': self.message}
|
|
|
|
def to_dict_v2(self):
|
|
'''
|
|
Version 2 of the public api error response.
|
|
'''
|
|
return {
|
|
"status_code": self.status_code,
|
|
"errors": [
|
|
{
|
|
"error": self.__class__.__name__,
|
|
"message": self.message
|
|
}
|
|
]
|
|
}
|
|
|
|
def __str__(self):
|
|
return str(self.to_dict())
|
|
|
|
|
|
def register_errors(blueprint):
|
|
@blueprint.errorhandler(InvalidEmailError)
|
|
def invalid_format(error):
|
|
# Please not that InvalidEmailError is re-raised for InvalidEmail or InvalidPhone,
|
|
# work should be done in the utils app to tidy up these errors.
|
|
return jsonify(result='error', message=str(error)), 400
|
|
|
|
@blueprint.errorhandler(AuthError)
|
|
def authentication_error(error):
|
|
return jsonify(result='error', message=error.message), error.code
|
|
|
|
@blueprint.errorhandler(ValidationError)
|
|
def marshmallow_validation_error(error):
|
|
current_app.logger.error(error)
|
|
return jsonify(result='error', message=error.messages), 400
|
|
|
|
@blueprint.errorhandler(JsonSchemaValidationError)
|
|
def jsonschema_validation_error(error):
|
|
current_app.logger.exception(error)
|
|
return jsonify(json.loads(error.message)), 400
|
|
|
|
@blueprint.errorhandler(InvalidRequest)
|
|
def invalid_data(error):
|
|
response = jsonify(error.to_dict())
|
|
response.status_code = error.status_code
|
|
current_app.logger.error(error)
|
|
return response
|
|
|
|
@blueprint.errorhandler(400)
|
|
def bad_request(e):
|
|
msg = e.description or "Invalid request parameters"
|
|
current_app.logger.exception(msg)
|
|
return jsonify(result='error', message=str(msg)), 400
|
|
|
|
@blueprint.errorhandler(401)
|
|
def unauthorized(e):
|
|
error_message = "Unauthorized, authentication token must be provided"
|
|
return jsonify(result='error', message=error_message), 401, [('WWW-Authenticate', 'Bearer')]
|
|
|
|
@blueprint.errorhandler(403)
|
|
def forbidden(e):
|
|
error_message = "Forbidden, invalid authentication token provided"
|
|
return jsonify(result='error', message=error_message), 403
|
|
|
|
@blueprint.errorhandler(429)
|
|
def limit_exceeded(e):
|
|
current_app.logger.exception(e)
|
|
return jsonify(result='error', message=str(e.description)), 429
|
|
|
|
@blueprint.errorhandler(NoResultFound)
|
|
@blueprint.errorhandler(DataError)
|
|
def no_result_found(e):
|
|
current_app.logger.exception(e)
|
|
return jsonify(result='error', message="No result found"), 404
|
|
|
|
@blueprint.errorhandler(SQLAlchemyError)
|
|
def db_error(e):
|
|
current_app.logger.exception(e)
|
|
if hasattr(e, 'orig') and hasattr(e.orig, 'pgerror') and e.orig.pgerror and \
|
|
('duplicate key value violates unique constraint "services_name_key"' in e.orig.pgerror or
|
|
'duplicate key value violates unique constraint "services_email_from_key"' in e.orig.pgerror):
|
|
return jsonify(
|
|
result='error',
|
|
message={'name': ["Duplicate service name '{}'".format(
|
|
e.params.get('name', e.params.get('email_from', ''))
|
|
)]}
|
|
), 400
|
|
return jsonify(result='error', message="Internal server error"), 500
|
|
|
|
# this must be defined after all other error handlers since it catches the generic Exception object
|
|
@blueprint.app_errorhandler(500)
|
|
@blueprint.errorhandler(Exception)
|
|
def internal_server_error(e):
|
|
current_app.logger.exception(e)
|
|
return jsonify(result='error', message="Internal server error"), 500
|