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

Display "Elapsed" errors from Timeouts as "timeout" #1657

Closed
teor2345 opened this issue Jan 29, 2021 · 1 comment
Closed

Display "Elapsed" errors from Timeouts as "timeout" #1657

teor2345 opened this issue Jan 29, 2021 · 1 comment
Labels
A-docs Area: Documentation A-rust Area: Updates to Rust code C-bug Category: This is a bug

Comments

@teor2345
Copy link
Contributor

teor2345 commented Jan 29, 2021

Is your feature request related to a problem? Please describe.

Currently, when Zebra encounters a timeout, it debug-prints the Elapsed error, which displays the text:

... Elapsed() ...

But these errors would be a lot more readable if they were displayed as:

... timeout elapsed ...

Describe the solution you'd like

We should print tokio::Timeout's Elapsed errors as timeout elapsed.

But I don't know how to do that easily - maybe we need a wrapper around the Timeout future to modify its error display and debug impls?

We'll also need to make sure there isn't any code that specifically checks for the Elapsed error, or the string Elapsed.

Describe alternatives you've considered

Do nothing.

Explain what Elapsed means in Zebra's documentation.

Related Issues

Noted in #1535, but it's been an issue for a while.

@teor2345 teor2345 added C-bug Category: This is a bug A-docs Area: Documentation A-rust Area: Updates to Rust code S-needs-triage Status: A bug report needs triage P-Low labels Jan 29, 2021
@mpguerra mpguerra removed the S-needs-triage Status: A bug report needs triage label Feb 18, 2021
@teor2345
Copy link
Contributor Author

Would be nice, but we've never actually needed this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation A-rust Area: Updates to Rust code C-bug Category: This is a bug
Projects
None yet
Development

No branches or pull requests

2 participants