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

feat(gateway): add configurable response write timeout #812

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

gitsrc
Copy link

@gitsrc gitsrc commented Jan 23, 2025

This commit introduces a configurable response write timeout for the IPFS gateway.
The timeout can be set via the ResponseWriteTimeout field in the gateway configuration.
If not set, a default timeout of 30 seconds is applied.

The implementation includes:

  • A new timeoutResponseWriter struct that wraps the standard http.ResponseWriter
    and enforces the timeout.
  • A middleware function WithResponseWriteTimeout that applies the timeout logic
    to the HTTP handler chain.
  • Comprehensive unit tests to verify the timeout behavior under various scenarios.

The timeout ensures that slow or unresponsive clients do not indefinitely hold
server resources, improving the overall reliability and stability of the gateway.

This change also attempts to address the issue described in #679
by providing a mechanism to handle slow or stuck HTTP responses more gracefully.

[skip changelog]

@gitsrc gitsrc requested a review from lidel as a code owner January 23, 2025 14:35
Copy link

welcome bot commented Jan 23, 2025

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions
    and stakeholders linked/mentioned.

  • Your contribution itself is clear (code comments, self-review for the
    rest) and in its best form. Follow the code contribution
    guidelines

    if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on
    any missing things and potentially assigning a reviewer for high
    priority items.

  • The PR gets reviews, discussed and approvals as needed.

  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

Copy link
Contributor

@gammazero gammazero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This addresses what was asked for in #679 but I think that if can live without the ask, "Every time data is written successfully, the timer is reset" then things can be much simpler. For example: #818

gateway/handler.go Show resolved Hide resolved
gateway/handler.go Show resolved Hide resolved
gateway/handler.go Show resolved Hide resolved
gateway/handler.go Show resolved Hide resolved
gateway/handler.go Show resolved Hide resolved
gateway/handler.go Show resolved Hide resolved
gateway/handler.go Show resolved Hide resolved
@gitsrc
Copy link
Author

gitsrc commented Feb 1, 2025

OK, I understand, it would be cleaner to set a uniform timeout.

This addresses what was asked for in #679 but I think that if can live without the ask, "Every time data is written successfully, the timer is reset" then things can be much simpler. For example: #818

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

Successfully merging this pull request may close these issues.

4 participants