VED-747 Refactor update immunisation endpoint

[dlzhry2nhs]

Summary

• Routine Change

Refactoring - no functional change with the exception of the following which I will flag to testers and mention as a comment:

• 404 scenario validation error message subtly changed for consistency with other endpoints
• header validation tightened. No longer accepts 0 and negative numbers (more details in comment)

General refactoring changes:

Controller:

• Vastly simplified. Previously it was executing a lot of logic. It is now simply responsible for parsing of the data and light touch validation of the path params and so on.
• Business logic has been moved down to the service layer.
• Decorator added to controller method to handle known and unexpected exceptions.

Service:

• removed get_immunization_by_id_all this was called previously by the update controller, and confusingly masked a lot of business logic.
• replicated business logic which was in the controller into the service layer. Attempted to abstract any of the checks into validation_utils. Hopefully you agree it's much more readable now

Repository:

• Refactored get_immunization_and_resource_meta_by_id and removed get_immunization_by_id_all. They were basically doing the same thing albeit a switch can now be passed in to specify whether we include logically deleted resources in our request. Abstracted the horrendous inconsistent dict we were returning with ImmunizationRecordMetadata
• Simplified update immunization operation and removed superfluous methods for the different flavours of update i.e. plain update, reinstate and update reinstated. The latter is just an update tbh.

Reviews Required

• Dev

Review Checklist

ℹ️ This section is to be filled in by the reviewer.

• I have reviewed the changes in this PR and they fill all or part of the acceptance criteria of the ticket, and the code is in a mergeable state.
• If there were infrastructure, operational, or build changes, I have made sure there is sufficient evidence that the changes will work.
• I have ensured the changelog has been updated by the submitter, if necessary.

[github-actions]

This branch is working on a ticket in the NHS England VED JIRA Project. Here's a handy link to the ticket:

VED-747

[dlzhry2nhs]

We were previously not using this error. I adjusted the error message to avoid any regression, now that we use it when validating the IDs.

[dlzhry2nhs]

Obsolete after removing PDS checks.

[dlzhry2nhs]

Testers: new validation error message will look like this which is consistent for 404 errors in our other endpoints.

Previously we were returning: Validation errors: The requested immunization resource with id:{imms_id} was not found. Please check if you have assertions which check this particular message in the Update endpoint, as they will need changing after this gets merged and deployed.

[dlzhry2nhs]

Testers - minor change. Previously we permitted 0 and negative numbers. We will now catch such an error earlier on in the flow and get an error stating the the resource version is invalid.

Previously, this would have been accepted but then the update would fail on the old resource vs. new resource version check, as a resource in the database would only have a positive int as the resource version due to the constraints during both create and update operations.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
99.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud