NoK: Response codes associated with the correct stack layer

wesrowe commented 5 months ago

Description

User story

As a Cartographers team member, I want api.va.gov/v0/profile/contacts to handle service HTTP 4xx/5xx responses and raise vets-api Exceptions, so that vets-api errors and back-end (VA Profile) errors are categorized and monitored at the appropriate layer of the stack and can be scored to the appropriate SLO.

Notes

/v0/profile/contacts should have a defined pattern for translating 4xx/5xx service responses to api responses 404 -> { data: [] } 500 -> { errors: ... } malformed service response body -> { errors: ... }
VA Profile Service class in vets-api should handle Common::Client::Errors and raise Common::Exceptions when necessary.
Check if contact information impacted by Profile migration (v3)
SLO targets for vets-api errors

Possible tasks:

Acceptance criteria

Datadog dashboard for vets-api accurately tracks response codes that originate with vets-api
4xx/5xx errors at the VA Profile layer are visible to Cartography team members in Datadog as originating in the back-end
Test suite output describes this mapping.
QA review

LynneJohnson224 commented 1 month ago

8/7/2024 Refinement Notes: Would like to complete this before working on NoK/EC edit. Will need to check if the contact information is impacted by the profile v3 migration.

radavis commented 1 month ago

Files of interest in vets-api:

app/controllers/concerns/exception_handling.rb, specifically render_errors method
config/locales/exceptions.en.yml

wesrowe commented 1 month ago

Will need to check if the contact information is impacted by the profile v3 migration.

Did anyone take the action item to find out whether contacts are impacted by the v3 implementation?

// cc @radavis @LynneJohnson224 @dcloud

wesrowe commented 1 month ago

Reiterating my comment above:

Did anyone take the action item to find out whether contacts are impacted by the v3 implementation?

Relatedly, this ticket needs points. I'm adding the "needs refinement" label back on.

radavis commented 1 month ago

Reiterating my comment above:

Did anyone take the action item to find out whether contacts are impacted by the v3 implementation?

Relatedly, this ticket needs points. I'm adding the "needs refinement" label back on.

v3 implementation of...?

radavis commented 1 month ago

The vets-api client/service code for reading Personal health care contacts through VA Profile API is in the V3 Profile client

dcloud commented 1 month ago

@radavis The maybe related work is under this ticket: https://github.com/department-of-veterans-affairs/va.gov-team/issues/83181+ : "Upgrade V2::ContactInformation::Service to V3::ProfileInformation::Service"

You can see this in-progress PR: https://github.com/department-of-veterans-affairs/vets-api/pull/17397

Perhaps the key is that those are talking about "V2::ContactInformation::Service to V3::ProfileInformation::Service"?

It could also be that the code you're referring to might be get merged with or replaced by that work.

radavis commented 1 month ago

Perhaps the key is that those are talking about "V2::ContactInformation::Service to V3::ProfileInformation::Service"?

Yeah, our client is namspaced under VAProfile::Profile::V3:Service, so I don't believe this will be a concern.

department-of-veterans-affairs / va.gov-team