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

Handle API query errors gracefully and inform the user of failures #473

Open
nmcharlton opened this issue Mar 5, 2022 · 5 comments
Open
Assignees
Labels
size: medium Medium-size issue tool: Capture Matching Relates to the Capture Matching tool tool: Captures Relates to the capture data tool (Captures page, formerly Trees) tool: Dashboard Relates to the Admin Panel dashboard (Home page) tool: Earnings Relates to the Earnings tool (formerly Payments) tool: Growers Relates to the Grower Management tool (Growers page, formerly Planters) tool: Species Relates to the Species management tool tool: User Manager Relates to the User Manager tool tool: Verify Relates to the capture verification tool (Verify page) type: enhancement New feature or request

Comments

@nmcharlton
Copy link
Collaborator

We've had several instances recently of errors in API responses not being handled gracefully and not being reported to the user.
In several places, we have no error handling at all, so either quietly ignore errors or assume success, often resulting in unexpected behaviour.

Ideally, we would have a mechanism in the Admin Panel to allow users to report errors directly when they occur, along with the network request and response details, but a good start would be graceful handling of failures.

@nmcharlton nmcharlton added type: enhancement New feature or request tool: Verify Relates to the capture verification tool (Verify page) tool: Growers Relates to the Grower Management tool (Growers page, formerly Planters) tool: Capture Matching Relates to the Capture Matching tool tool: User Manager Relates to the User Manager tool tool: Species Relates to the Species management tool tool: Dashboard Relates to the Admin Panel dashboard (Home page) size: medium Medium-size issue tool: Captures Relates to the capture data tool (Captures page, formerly Trees) tool: Earnings Relates to the Earnings tool (formerly Payments) labels Mar 5, 2022
@nmcharlton nmcharlton changed the title Handling API query errors gracefully and inform the user of failures Handle API query errors gracefully and inform the user of failures Mar 5, 2022
@xxGreyscale
Copy link
Contributor

Hello, @nmcharlton I think I might be able to handle this if assigned. This would need a UI consultation too, don't you think?

@nmcharlton
Copy link
Collaborator Author

@xxGreyscale That would be awesome. I think a UI consultation would be good, but it doesn’t need to be anything too fancy 😀

@nmcharlton
Copy link
Collaborator Author

Hi @xxGreyscale. Have you been able to make any progress on this issue? The team has been discussing the best strategy for API error handling across the Admin Panel, and @gwynndp has proposed some changes in #566, focussed on the Messaging tool. It would be good to share and align the work on this area.

@nmcharlton nmcharlton added this to the 2022-04 milestone Apr 3, 2022
@xxGreyscale
Copy link
Contributor

So far I haven't made any significant progress ready to be aligned with the main repository. Just figured out a way of handling most errors. But yet to be implemented

@OlhaD
Copy link
Contributor

OlhaD commented Apr 4, 2023

@nmcharlton I would like to work on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: medium Medium-size issue tool: Capture Matching Relates to the Capture Matching tool tool: Captures Relates to the capture data tool (Captures page, formerly Trees) tool: Dashboard Relates to the Admin Panel dashboard (Home page) tool: Earnings Relates to the Earnings tool (formerly Payments) tool: Growers Relates to the Grower Management tool (Growers page, formerly Planters) tool: Species Relates to the Species management tool tool: User Manager Relates to the User Manager tool tool: Verify Relates to the capture verification tool (Verify page) type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants