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

Provide meaningful error messages #331

Open
ducvan0212 opened this issue Aug 16, 2018 · 12 comments
Open

Provide meaningful error messages #331

ducvan0212 opened this issue Aug 16, 2018 · 12 comments
Assignees

Comments

@ducvan0212
Copy link
Collaborator

ducvan0212 commented Aug 16, 2018

The services from Abu side return following error code:

screen shot 2018-08-16 at 8 46 40 am

@arlin would you please help me translate the error codes to meaningful messages to display in the portal?

@ducvan0212
Copy link
Collaborator Author

ducvan0212 commented Aug 16, 2018

For now, I added the error in portal. It looks like this (the second line)

screen shot 2018-08-16 at 9 45 17 am

@epontell
Copy link
Member

The "Please try again in an hour" does not make sense - if the error is due to the size of the list, that will not change in one hour

@ducvan0212
Copy link
Collaborator Author

@epontell @arlin I updated error messages.

screen shot 2018-08-16 at 4 21 49 pm

And for Chas's list, the error is

screen shot 2018-08-16 at 4 21 31 pm

@arlin
Copy link
Member

arlin commented Aug 17, 2018

@ducvan0212, the portal is an interactive web tool, so we want to provide users with guidance at the level of how they interact with the portal (by clicking buttons, selecting files, entering text, etc), not at the level of how the portal interacts internally with web services.

In the case of Chas's list, for instance, we might want to say "Getting a tree from this list failed because we could not find enough taxa in OpenTree's synthetic tree (at least 2 are needed). This usually means that your list includes taxa that are extinct or have an uncertain placement. Try another source of names."

@arlin
Copy link
Member

arlin commented Aug 17, 2018

@ducvan0212 could you please move this ticket into the In Progress column on the tracker?

@arlin
Copy link
Member

arlin commented Aug 17, 2018

@DucVan, I suggest the following error message for > 1000 names: "Your source has > 1000 names. To maintain performance, we currently do not process lists this large. Please find another source with fewer names."

@arlin
Copy link
Member

arlin commented Aug 17, 2018

With respect to the other errors in the table above, these should not be appearing in the portal. The behavior expected from a client is that it will validate commands before sending inoperable commands to services. Therefore we should never see low-level errors about missing arguments.

@ducvan0212
Copy link
Collaborator Author

@DucVan, I suggest the following error message for > 1000 names: "Your source has > 1000 names. To maintain performance, we currently do not process lists this large. Please find another source with fewer names."

I updated the message.

screen shot 2018-08-17 at 3 18 13 pm

@ducvan0212
Copy link
Collaborator Author

In the case of Chas's list, for instance, we might want to say "Getting a tree from this list failed because we could not find enough taxa in OpenTree's synthetic tree (at least 2 are needed). This usually means that your list includes taxa that are extinct or have an uncertain placement. Try another source of names."

Updated as well

screen shot 2018-08-17 at 3 21 55 pm

@arlin
Copy link
Member

arlin commented Aug 17, 2018

The first sentence is not necessary and introduces a distinction that the user may not understand.

@arlin
Copy link
Member

arlin commented Aug 17, 2018

In both cases, the first sentence is not necessary. Let's try to keep these messages as succinct as possible.

@ducvan0212
Copy link
Collaborator Author

I removed the first sentence on both cases

screen shot 2018-08-17 at 3 23 42 pm

screen shot 2018-08-17 at 3 23 53 pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants