Consistent error value of context timeout on subscription Fetch() interface. #1011
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
wdhongtw
force-pushed
the
fix-fetch-context-timeout
branch
from
e1208d3
to
009889b
Compare
wdhongtw
force-pushed
the
fix-fetch-context-timeout
branch
from
009889b
to
0834239
Compare
wallyqs
reviewed
Jul 1, 2022
js_test.go
Outdated
| t.Fatalf("Expect ErrTimeout, got err=%#v", err) | ||
| } | ||
| }) | ||
| t.Run("Context timeout should return context error", func(t *testing.T) { |
There was a problem hiding this comment.
I think this test case already covered here: https://github.com/nats-io/nats.go/blob/main/test/js_test.go#L6719-L6726
There was a problem hiding this comment.
nevermind, I see now that this test is the one that has the coverage for the issue. In the one I mentioned the context has not yet timed out but here it has.
wallyqs
reviewed
Jul 1, 2022
js_test.go
Outdated
| @@ -939,6 +941,21 @@ func TestJetStreamExpiredPullRequests(t *testing.T) { | |||
| t.Fatalf("Expected error and wait for 250ms, got err=%v and dur=%v", err, dur) | |||
| } | |||
| } | |||
|
|
|||
| t.Run("MaxWait timeout should return nats error", func(t *testing.T) { | |||
There was a problem hiding this comment.
Could you move these test blocks to be as part of this other test? https://github.com/nats-io/nats.go/blob/main/test/js_test.go#L6869
wallyqs
requested changes
Jul 1, 2022
wdhongtw
force-pushed
the
fix-fetch-context-timeout
branch
from
0834239
to
74018d1
Compare
Follow TDD principle, write test watch it fails.
If user provides context object and context timeout, always return the timeout error from context.
wdhongtw
force-pushed
the
fix-fetch-context-timeout
branch
from
74018d1
to
37edc5e
Compare
|
I accidentally leaved an empty line in |
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.
When using Subscription.Fetch() with
nats.Context(ctx)option,if context timeout receiving any message,
Fetchwill return error.There are two possible value of error here,
nats.ErrTimeoutandcontext.DeadlineExceeded, based on some timing in the process/gorouting. If context timeout before subscription object trying to fetch message,nats.ErrTimeoutis returned. Otherwise,context.DeadlineExceededis returned.This PR make the error value of fetch timeout predicable, if Fetch is called with
nats.Context(ctx), timeout always returncontext.DeadlineExceeded; if called withnats.MaxWait(timeout), timeout always returnnats.ErrTimeout.