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

Restore message context in Timeout middleware #517

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

zanvd
Copy link

@zanvd zanvd commented Nov 21, 2024

This resolves #467.

It simply stores the original message context and restores it in the defer.

Copy link

@ccoVeille ccoVeille left a comment

Choose a reason for hiding this comment

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

A minor remark

message/router/middleware/timeout.go Outdated Show resolved Hide resolved
defer func() {
msg.SetContext(orgCtx)
Copy link
Member

Choose a reason for hiding this comment

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

@zanvd how about we use context.WithoutCancel(ctx) here? This way the cancellation won't be propagated while the values stored in the context can be. Would that also solve the root issue? 🤔

Choose a reason for hiding this comment

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

context.WithoutCancel was a great addition to context lately, but here if we use it, it means the context stored again won't be canceled if orgCtx is canceled. It doesn't a good move

Copy link
Member

Choose a reason for hiding this comment

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

Ah, you're right.

My point is that restoring the context will also remove all context values. If someone uses middleware that uses the context after the handler is executed, it will be lost this way.

Copy link

@ccoVeille ccoVeille Nov 24, 2024

Choose a reason for hiding this comment

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

Here is the way then

orgCtx := msg.Context() 
ctx, cancel := context.WithTimeout(orgCtx, timeout)

defer func() {
   cancel()
   ctx, cancel2 := context.WithCancelWithCause(context.WithoutCancel(ctx))
   msg.SetContext(ctx)
   go func() {
        <- ctx.Done()
        cancel2(ctx.Err())
   }
}()

But I find it ugly

Copy link
Author

Choose a reason for hiding this comment

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

I'd have to test it out, but this is more or less why I was asking on Discord about usage of context within Message - makes it sort of a global object that anyone can modify. Since the blueprint for this was the net/http package, I'd follow its logic and not even allow changing of the Message's context. Not something to solve in this PR, though.

What would be an example of values stored in the context that we should be vary of? Perhaps copying them to the original context might be a temporary solution.

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.

Timeout middleware: context is not restored
3 participants