Refactor user_scores endpoint to add marshmallow schema validation

[sentry-io]

Modules and functions to refactor

• app/scoring/routes.py::user_scores

Refactor reason

The refactoring is needed to filter issues like Sentry Issue: BACKEND-G caused by an invalid request body. (the problem is what frontend sent us SetOne object with questionId > 10)

Details:

ValueError: 15 is not a valid PersonalValue
(10 additional frame(s) were not displayed)


...
  File "app/scoring/process_scores.py", line 43, in calculate_scores
    value_type = PersonalValue(question_id)
  File "enum.py", line 309, in __call__
    return cls.__new__(cls, value)
  File "enum.py", line 600, in __new__
    raise exc
  File "enum.py", line 584, in __new__
    result = cls._missing_(value)
  File "enum.py", line 613, in _missing_
    raise ValueError("%r is not a valid %s" % (value, cls.__name__))

request body

{
questionResponses: {
SetOne: [
{"answerId":"2","questionId":"15"}, 
{"answerId":"4","questionId":"9"}, 
{"answerId":"2","questionId":"4"}, 
{"answerId":"2","questionId":"8"}, 
{"answerId":"4","questionId":"10"}, 
{"answerId":"3","questionId":"6"}, 
{"answerId":"3","questionId":"1"}, 
{"answerId":"4","questionId":"3"}, 
{"answerId":"3","questionId":"2"}, 
{"answerId":"2","questionId":"7"}
], 
SetTwo: [
{"answerId":"4","questionId":"15"}, 
{"answerId":"3","questionId":"19"}, 
{"answerId":"5","questionId":"14"}, 
{"answerId":"4","questionId":"18"}, 
{"answerId":"3","questionId":"20"}, 
{"answerId":"4","questionId":"16"}, 
{"answerId":"5","questionId":"11"}, 
{"answerId":"3","questionId":"13"}, 
{"answerId":"2","questionId":"12"}, 
{"answerId":"3","questionId":"17"}
]
}
}

Suggested solution

• new marshmallow schema created to validate the request body
• documentation (Climate-Mind_bundled.yml) updated to show 422 HTTP error

Tests

• integration test for the endpoint OR/AND unit test for a schema