CDCgov / prime-reportstream

ReportStream is a public intermediary tool for delivery of data between different parts of the healthcare ecosystem.
https://reportstream.cdc.gov
Creative Commons Zero v1.0 Universal
73 stars 40 forks source link

[BUG] Submission History API doesn't show Filtered reports #15645

Closed victor-chaparro closed 1 month ago

victor-chaparro commented 2 months ago

Describe the bug

When filters are triggered for receivers they do not show up when calling Submission History API {{url}}/waters/report/{reportId}/history. The submission status says Waiting to Deliver and should say Failed to Deliver and under destinations filteredReports should be populated.

Impact on ReportStream

Senders, if using the history endpoint, may not get accurate information as to the real status of their submitted report and may lead to confusion.

Engagement team uses API to troubleshoot submission and ensure filters are working as expected.

Steps to reproduce

Send a report locally and make sure the submission triggers a qualityFilter. You can do this by updating a receiver's quality filter to false:qualityFilter: ["false"] Call the Submission History API {{url}}/waters/report/2558/history

It seems like the new steps added to the Universal Pipeline are breaking this API. The API was probably looking at the Action Log Route step records to return this information.

Expected behavior

arnejduranovic commented 2 months ago

@victor-chaparro when a report fails quality filters (or any routing filter) should we use status "not delivering / partially delivered" instead of "failed to deliver". I don't think failed to deliver is a status?