refactor overall status enum to be a more clear indication of processing status

david-navapbc commented 1 month ago

User Story

AS a RS stakeholder WEHN reports are submitted to RS THEN I want overall status PARTIALLY_DELIVERED to indicate an error state that some receivers that SHOULD have received a report didn't.

Description/Use Case

Currently status "PARTIALLY_DELIVERED" indicates some receivers have received reports and some have not. This is confusing to some stakeholders as it is not clear from the status why those receivers did not receive a message. The goal is to refactor the status enum such that it is clear to folks the difference between

nothing has been delivered yet - WAITING_TO_DELIVER
all things were delivered - DELIVERED
some things have been delivered and some have not YET been delivered - NEW STATUS DELIVERY_IN_PROGRESS
some things have been delivered and some have not DUE TO ERROR - PARTIALLY_DELIVERED

Risks/Impacts/Considerations

This work entails changing the API contract. As such the developer that works this ticket needs to take care that all relevant documentation has been updated and whatever change management process we have (release notes, talking to stakeholders, etc) has been done prior to merge.

Dev Notes

This work replaces a previous BUG ticket the team concluded was erroneously filed as a bug.

Acceptance Criteria

status PARTIALLY_DELIVERED is refactored to indicate an error state wherein some receivers that SHOULD have received a report did not receive the report due to error.
a new status is added called DELIVERY_IN_PROGRESS to indicate delivery to receivers is in progress.
code comments, developer documentation, API documentation have been updated to reflect the change. This includes but is not limited to the UP markdown doc and code comment in SubmissionHistory.kt
any other change-management process we have for handling API changes have been enumerated and checked off as appropriate.
where appropriate, the test suite is updated to ensure the new business logic has test coverage

arnejduranovic commented 3 weeks ago

@brandonnava @chris-kuryak we need product feedback here on if this is a new status we want to add or not or if there are existing requirements we should reference somewhere.

brandonnava commented 3 weeks ago

FYI in response to this ticket which references the current versions of these statuses: https://app.zenhub.com/workspaces/platform-6182b02547c1130010f459db/issues/gh/cdcgov/prime-reportstream/16054

brandonnava commented 3 weeks ago

This ticket will be covered as part of the Engagement teams works on Submission History API requirements: https://app.zenhub.com/workspaces/engagement-6166edbd409257001e09f1b2/issues/gh/cdcgov/prime-reportstream/16256

CDCgov / prime-reportstream