Add user advice to UnableToDetermineCurrentEpoch error.
#1992
Conversation
Ideally, we'd be able to give the user some indication of how long they should wait, but assuming we cannot reliably know this information, letting them know that waiting may resolve the issue is arguably better than giving no advice at all.
| "I'm unable to determine the current epoch." | ||
| apiError err500 UnableToDetermineCurrentEpoch $ mconcat | ||
| [ "I'm unable to determine the current epoch. " | ||
| , "Please wait a while for the node to sync and try again." |
There was a problem hiding this comment.
Since it's unexpected for a node client to not know which epoch they are in at any time, it might be helpful to add a little detail as to why this cannot be known. If it's too complex to provide over an error message, maybe a link to some docs would be something to add later when available. I assume this is a common issue for chain-sync clients.
There was a problem hiding this comment.
If it's too complex to provide over an error message, maybe a link to some docs would be something to add later when available.
This sounds like a sensible suggestion. 👍
From conversations with @Anviking, it seems that this situation will only occur very rarely, around the time of a hard fork, and when a node is not yet fully in sync. I think if we do start seeing reports of this error in the wild, we can look into adding more information to the error.
|
bors r+ |
Build succeeded |
jonathanknowles
added
the
IMPROVEMENT
Issue Number
#1939
Overview
This PR revises the error we show if we cannot determine the current epoch, inviting the user to wait and try again.
Comments
Ideally, we'd be able to give the user some indication of how long they should wait, but assuming we cannot reliably know this information, letting them know that waiting may resolve the issue is arguably better than giving no advice at all.