Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

As a user, I want my API request to execute successfully even when the registry contains corrupted documents #361

Closed
tloubrieu-jpl opened this issue Jul 20, 2023 · 3 comments Β· Fixed by #368
Assignees
Labels
B14.0 Epic p.could-have requirement the current issue is a requirement

Comments

@tloubrieu-jpl
Copy link
Member

tloubrieu-jpl commented Jul 20, 2023

Checked for duplicates

Yes - I've already checked

πŸ§‘β€πŸ”¬ User Persona(s)

  • user does not want to be polluted by improperly loaded products (we want to consider them as not loaded from a user perspective)
  • operator want to get logs of the errors so to fix the corrupted products

πŸ’ͺ Motivation

...so that I can do my requests on the properly loaded products without being blocked by corrupted products

Motivated by ticket #349

πŸ“– Additional Details

Make the api more robust by skipping the corrupted products and generating a log error but answering the user with what is not corrupted

Acceptance Criteria

Given
When I perform
Then I expect

βš™οΈ Engineering Details

No response

@tloubrieu-jpl tloubrieu-jpl added needs:triage requirement the current issue is a requirement labels Jul 20, 2023
@jordanpadams jordanpadams changed the title As a user, I want don't want my api request to fail because of corrupted ticket in the registry As a user, I want don't want my api request to fail because of corrupted document in the registry Jul 31, 2023
@jordanpadams jordanpadams changed the title As a user, I want don't want my api request to fail because of corrupted document in the registry As a user, I want my API request to executed successfully even when the registry contains corrupted documents Jul 31, 2023
@jordanpadams jordanpadams changed the title As a user, I want my API request to executed successfully even when the registry contains corrupted documents As a user, I want my API request to execute successfully even when the registry contains corrupted documents Jul 31, 2023
@al-niessner
Copy link
Contributor

@jordanpadams @tloubrieu-jpl

We can do this because most the problems with parsing the document are local (strings when arrays are expected etc) by installing try/catch blocks. However this will mask a serious host of other errors. Are far enough along in development for such a masking? It also means that we treat all opensearch data as valid (no corrupt) because no one is going to read the log files. Just want to verify that you want to live in a bog before we build the fourth castle in it.

@jordanpadams
Copy link
Member

@al-niessner

It also means that we treat all opensearch data as valid (no corrupt) because no one is going to read the log files.

We need a follow-on ticket in the monitoring repo to then have an alarm to trigger a notification to the dev team when an error is found in the logs.

The rationale here being we would rather give the user as much of the metadata as we can versus totally failing and completely blocking a user from building off of the API.

@miguelp1986
Copy link

@tloubrieu-jpl @gxtchen Issue #349 is referenced as being the motivation for this issue, and Gary mentioned on TestRail that this issue is tested by testing #349.

Is testing #349 sufficient for this issue or is there some other way we want to test this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
B14.0 Epic p.could-have requirement the current issue is a requirement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants