Configurable timeout for HeaderReader polling #2507
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously if the backend stopped responding the client.HeaderByNumber call inside the timed main loop would never return, meaning that if the HeaderReader was only operating in polling mode, calls to LastHeader would always return the last successfully fetched header until OldHeaderTimeout, and if that was set to a high duration then it would effectively always return the last successfully fetched header and never an error. This would lead to the chain appear to be stuck and not advancing to clients of HeaderReader.LastHeader. This change adds a configurable timeout on this call, defaulting to 5s. Other places in HeaderReader that use LastHeader use the passed-in context which the client can control, so no extra timeout was added for these.
Tristan-Wilson
requested review from
diegoximenes,
magicxyyz,
ganeshvanahalli,
tsahee and
a-thomas-22
cla-bot
bot
added
the
s
diegoximenes
approved these changes
Jul 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously if the backend stopped responding the
client.HeaderByNumber call inside the timed main loop would never return, meaning that if the HeaderReader was only operating in polling mode, calls to LastHeader would always return the last successfully fetched header until OldHeaderTimeout, and if that was set to a high duration then it would effectively always return the last successfully fetched header and never an error. This would lead to the chain appear to be stuck and not advancing to clients of HeaderReader.LastHeader.
This change adds a configurable timeout on this call, defaulting to 5s. Other places in HeaderReader that use HeaderByNumber use the passed-in context which the client can control, so no extra timeout was added for these.
NIT-2688
ty @a-thomas-22 for the detailed issue report that made it possible to find this.