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.

Sign up for GitHub

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

Jump to bottom

Restore message context in Timeout middleware #517

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

Restore message context in Timeout middleware #517

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de06ae3
Restore message's original context before exiting the Timeout middlew…
zanvd Nov 21, 2024
9f12134
Use orgCtx as a parent context.
zanvd Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions message/router/middleware/timeout.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,16 @@ import (

// Timeout makes the handler cancel the incoming message's context after a specified time.
// Any timeout-sensitive functionality of the handler should listen on msg.Context().Done() to know when to fail.
// Before exiting this middleware, message's original context is restored to not disrupt the logic of possible
// enveloping handlers (e.g. Retry) that also rely on message context.
func Timeout(timeout time.Duration) func(message.HandlerFunc) message.HandlerFunc {
return func(h message.HandlerFunc) message.HandlerFunc {
return func(msg *message.Message) ([]*message.Message, error) {
orgCtx := msg.Context()

ctx, cancel := context.WithTimeout(msg.Context(), timeout)
zanvd marked this conversation as resolved.
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? 🤔

Copy link

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 •
edited
Loading

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.

cancel()
}()

Expand Down
6 changes: 5 additions & 1 deletion message/router/middleware/timeout_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"testing"
"time"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/ThreeDotsLabs/watermill/message"
Expand All @@ -25,6 +26,9 @@ func TestTimeout(t *testing.T) {
}
})

_, err := h(message.NewMessage("any-uuid", nil))
msg := message.NewMessage("any-uuid", nil)

_, err := h(msg)
require.NoError(t, err)
assert.Nil(t, msg.Context().Err())
}