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

[FIXED] Panic in ordered consumer #1686

Merged
merged 3 commits into from
Aug 1, 2024
Merged

[FIXED] Panic in ordered consumer #1686

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0743ae0
jetstream: ordered consumer: handle closed subscriptions gracefully
zonque Jun 25, 2024
7ba030d
[FIXED] Panic when stopping ordered consumer during reset
piotrpio Jul 23, 2024
9ea0dae
Fixed issues after resolving conflicts
piotrpio Jul 25, 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
42 changes: 30 additions & 12 deletions jetstream/ordered.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,10 @@ const (
consumerTypeFetch
)

var errOrderedSequenceMismatch = errors.New("sequence mismatch")
var (
errOrderedSequenceMismatch = errors.New("sequence mismatch")
errOrderedConsumerClosed = errors.New("ordered consumer closed")
)

// Consume can be used to continuously receive messages and handle them
// with the provided callback function. Consume cannot be used concurrently
Expand Down Expand Up @@ -142,6 +145,9 @@ func (c *orderedConsumer) Consume(handler MessageHandler, opts ...PullConsumeOpt
select {
case <-c.doReset:
if err := c.reset(); err != nil {
if errors.Is(err, errOrderedConsumerClosed) {
Copy link
Member

Choose a reason for hiding this comment

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

The only case for errOrderedConsumerClosed is when its stopped, so there is no point to try resetting it again, right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, there is no point. I used continue here because when the consumer is stopped we'll eventually end up in <-sub.done case where the actual cleanup is performed.

continue
}
c.errHandler(c.serial)(c.currentSub, err)
}
if c.withStopAfter {
Expand Down Expand Up @@ -173,6 +179,12 @@ func (c *orderedConsumer) Consume(handler MessageHandler, opts ...PullConsumeOpt
c.Unlock()
}
case <-sub.done:
s := sub.consumer.currentSub
if s != nil {
s.consumer.Lock()
s.Stop()
s.consumer.Unlock()
}
return
case msgsLeft, ok := <-c.stopAfterMsgsLeft:
if !ok {
Expand Down Expand Up @@ -276,6 +288,9 @@ func (s *orderedSubscription) Next() (Msg, error) {
s.opts[len(s.opts)-1] = StopAfter(s.consumer.stopAfter)
}
if err := s.consumer.reset(); err != nil {
if errors.Is(err, errOrderedConsumerClosed) {
return nil, ErrMsgIteratorClosed
}
return nil, err
}
cc, err := s.consumer.currentConsumer.Messages(s.opts...)
Expand All @@ -297,6 +312,9 @@ func (s *orderedSubscription) Next() (Msg, error) {
dseq := meta.Sequence.Consumer
if dseq != s.consumer.cursor.deliverSeq+1 {
if err := s.consumer.reset(); err != nil {
if errors.Is(err, errOrderedConsumerClosed) {
return nil, ErrMsgIteratorClosed
}
return nil, err
}
cc, err := s.consumer.currentConsumer.Messages(s.opts...)
Expand All @@ -316,19 +334,23 @@ func (s *orderedSubscription) Stop() {
if !atomic.CompareAndSwapUint32(&s.closed, 0, 1) {
return
}
s.consumer.Lock()
defer s.consumer.Unlock()
s.consumer.currentSub.Stop()
if s.consumer.currentSub != nil {
s.consumer.currentConsumer.Lock()
s.consumer.currentSub.Stop()
s.consumer.currentConsumer.Unlock()
}
close(s.done)
}

func (s *orderedSubscription) Drain() {
if !atomic.CompareAndSwapUint32(&s.closed, 0, 1) {
return
}
s.consumer.currentConsumer.Lock()
defer s.consumer.currentConsumer.Unlock()
s.consumer.currentSub.Drain()
if s.consumer.currentSub != nil {
s.consumer.currentConsumer.Lock()
s.consumer.currentSub.Drain()
s.consumer.currentConsumer.Unlock()
}
close(s.done)
}

Expand Down Expand Up @@ -504,23 +526,19 @@ func (c *orderedConsumer) reset() error {
err = retryWithBackoff(func(attempt int) (bool, error) {
isClosed := atomic.LoadUint32(&c.subscription.closed) == 1
if isClosed {
return false, nil
return false, errOrderedConsumerClosed
}
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
cons, err = c.jetStream.CreateOrUpdateConsumer(ctx, c.stream, *consumerConfig)
if err != nil {
return true, err
}
c.currentConsumer = cons.(*pullConsumer)
return false, nil
}, backoffOpts)
if err != nil {
return err
}
if cons == nil {
return nats.ErrSubscriptionClosed
}
c.currentConsumer = cons.(*pullConsumer)
return nil
}
Expand Down
1 change: 1 addition & 0 deletions jetstream/test/kv_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -967,6 +967,7 @@ func TestKeyValueListKeys(t *testing.T) {

func TestKeyValueCrossAccounts(t *testing.T) {
conf := createConfFile(t, []byte(`
listen: 127.0.0.1:-1
jetstream: enabled
accounts: {
A: {
Expand Down
39 changes: 39 additions & 0 deletions jetstream/test/ordered_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,45 @@ func TestOrderedConsumerConsume(t *testing.T) {
cc.Drain()
wg.Wait()
})

t.Run("stop consume during reset", func(t *testing.T) {
srv := RunBasicJetStreamServer()
defer shutdownJSServerAndRemoveStorage(t, srv)
nc, err := nats.Connect(srv.ClientURL())
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}

js, err := jetstream.New(nc)
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
defer nc.Close()

ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
s, err := js.CreateStream(ctx, jetstream.StreamConfig{Name: "foo", Subjects: []string{"FOO.*"}})
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
for i := 0; i < 10; i++ {
c, err := s.OrderedConsumer(context.Background(), jetstream.OrderedConsumerConfig{})
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
cc, err := c.Consume(func(msg jetstream.Msg) {
msg.Ack()
})
if err != nil {
t.Fatalf("Unexpected error: %v", err)
}
if err := s.DeleteConsumer(context.Background(), c.CachedInfo().Name); err != nil {
t.Fatalf("Unexpected error: %v", err)
}
cc.Stop()
time.Sleep(50 * time.Millisecond)
}
})
}

func TestOrderedConsumerMessages(t *testing.T) {
Expand Down