forked from cockroachdb/cockroach
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
kvserver/rangefeed: move active streams to stream muxer
This patch moves the existing active stream management to StreamMuxer without changing any existing behaviour. The main purpose is to make future commits cleaner. Part of: cockroachdb#126561 Release note: none
- Loading branch information
Showing
5 changed files
with
326 additions
and
54 deletions.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| // Copyright 2024 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package rangefeed | ||
|
|
||
| import ( | ||
| "context" | ||
| "sync" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/kv/kvpb" | ||
| "github.com/cockroachdb/cockroach/pkg/roachpb" | ||
| "github.com/cockroachdb/cockroach/pkg/testutils" | ||
| "github.com/cockroachdb/cockroach/pkg/util/hlc" | ||
| "github.com/cockroachdb/cockroach/pkg/util/leaktest" | ||
| "github.com/cockroachdb/cockroach/pkg/util/log" | ||
| "github.com/cockroachdb/cockroach/pkg/util/stop" | ||
| "github.com/cockroachdb/errors" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| // TestStreamMuxer tests that correctly forwards rangefeed completion errors to | ||
| // the server stream. | ||
| func TestStreamMuxer(t *testing.T) { | ||
| defer leaktest.AfterTest(t)() | ||
| defer log.Scope(t).Close(t) | ||
|
|
||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
| stopper := stop.NewStopper() | ||
| defer stopper.Stop(ctx) | ||
|
|
||
| testServerStream := newTestServerStream() | ||
| muxer := NewStreamMuxer(testServerStream) | ||
| require.NoError(t, muxer.Start(ctx, stopper)) | ||
| defer muxer.Stop() | ||
|
|
||
| t.Run("nil handling", func(t *testing.T) { | ||
| const streamID = 0 | ||
| const rangeID = 1 | ||
| streamCtx, cancel := context.WithCancel(context.Background()) | ||
| muxer.AddStream(0, cancel) | ||
| // Note that kvpb.NewError(nil) == nil. | ||
| muxer.DisconnectRangefeedWithError(streamID, rangeID, kvpb.NewError(nil)) | ||
| require.Equal(t, context.Canceled, streamCtx.Err()) | ||
| expectedErrEvent := &kvpb.MuxRangeFeedEvent{ | ||
| StreamID: streamID, | ||
| RangeID: rangeID, | ||
| } | ||
| expectedErrEvent.MustSetValue(&kvpb.RangeFeedError{ | ||
| Error: *kvpb.NewError(kvpb.NewRangeFeedRetryError(kvpb.RangeFeedRetryError_REASON_RANGEFEED_CLOSED)), | ||
| }) | ||
| time.Sleep(10 * time.Millisecond) | ||
| require.Equal(t, 1, testServerStream.totalEventsSent()) | ||
| require.True(t, testServerStream.hasEvent(expectedErrEvent)) | ||
|
|
||
| // Repeat closing the stream does nothing. | ||
| muxer.DisconnectRangefeedWithError(streamID, rangeID, | ||
| kvpb.NewError(kvpb.NewRangeFeedRetryError(kvpb.RangeFeedRetryError_REASON_RANGEFEED_CLOSED))) | ||
| time.Sleep(10 * time.Millisecond) | ||
| require.Equal(t, 1, testServerStream.totalEventsSent()) | ||
| }) | ||
|
|
||
| t.Run("send rangefeed completion error", func(t *testing.T) { | ||
| testRangefeedCompletionErrors := []struct { | ||
| streamID int64 | ||
| rangeID roachpb.RangeID | ||
| Error error | ||
| }{ | ||
| {0, 1, kvpb.NewRangeFeedRetryError(kvpb.RangeFeedRetryError_REASON_RANGEFEED_CLOSED)}, | ||
| {1, 1, context.Canceled}, | ||
| {2, 2, &kvpb.NodeUnavailableError{}}, | ||
| } | ||
|
|
||
| for _, muxError := range testRangefeedCompletionErrors { | ||
| muxer.AddStream(muxError.streamID, func() {}) | ||
| } | ||
|
|
||
| var wg sync.WaitGroup | ||
| for _, muxError := range testRangefeedCompletionErrors { | ||
| wg.Add(1) | ||
| go func(streamID int64, rangeID roachpb.RangeID, err error) { | ||
| defer wg.Done() | ||
| muxer.DisconnectRangefeedWithError(streamID, rangeID, kvpb.NewError(err)) | ||
| }(muxError.streamID, muxError.rangeID, muxError.Error) | ||
| } | ||
| wg.Wait() | ||
|
|
||
| for _, muxError := range testRangefeedCompletionErrors { | ||
| testutils.SucceedsSoon(t, func() error { | ||
| ev := &kvpb.MuxRangeFeedEvent{ | ||
| StreamID: muxError.streamID, | ||
| RangeID: muxError.rangeID, | ||
| } | ||
| ev.MustSetValue(&kvpb.RangeFeedError{ | ||
| Error: *kvpb.NewError(muxError.Error), | ||
| }) | ||
| if testServerStream.hasEvent(ev) { | ||
| return nil | ||
| } | ||
| return errors.Newf("expected error %v not found", muxError) | ||
| }) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| // TestStreamMuxerOnBlockingIO tests that the | ||
| // StreamMuxer.DisconnectRangefeedWithError doesn't block on IO. | ||
| func TestStreamMuxerOnBlockingIO(t *testing.T) { | ||
| defer leaktest.AfterTest(t)() | ||
| defer log.Scope(t).Close(t) | ||
|
|
||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
| stopper := stop.NewStopper() | ||
| defer stopper.Stop(ctx) | ||
|
|
||
| testServerStream := newTestServerStream() | ||
| muxer := NewStreamMuxer(testServerStream) | ||
| require.NoError(t, muxer.Start(ctx, stopper)) | ||
| defer muxer.Stop() | ||
|
|
||
| const streamID = 0 | ||
| const rangeID = 1 | ||
| streamCtx, streamCancel := context.WithCancel(context.Background()) | ||
| muxer.AddStream(0, streamCancel) | ||
|
|
||
| ev := &kvpb.MuxRangeFeedEvent{ | ||
| StreamID: streamID, | ||
| RangeID: rangeID, | ||
| } | ||
| ev.MustSetValue(&kvpb.RangeFeedCheckpoint{ | ||
| Span: roachpb.Span{Key: roachpb.Key("a"), EndKey: roachpb.Key("m")}, | ||
| ResolvedTS: hlc.Timestamp{WallTime: 1}, | ||
| }) | ||
| require.NoError(t, muxer.sender.Send(ev)) | ||
| require.Truef(t, testServerStream.hasEvent(ev), | ||
| "expected event %v not found in %v", ev, testServerStream) | ||
|
|
||
| // Block the stream. | ||
| unblock := testServerStream.BlockSend() | ||
|
|
||
| // Although stream is blocked, we should be able to disconnect the stream | ||
| // without blocking. | ||
| muxer.DisconnectRangefeedWithError(streamID, rangeID, | ||
| kvpb.NewError(kvpb.NewRangeFeedRetryError(kvpb.RangeFeedRetryError_REASON_NO_LEASEHOLDER))) | ||
| require.Equal(t, streamCtx.Err(), context.Canceled) | ||
| unblock() | ||
| time.Sleep(100 * time.Millisecond) | ||
| expectedErrEvent := &kvpb.MuxRangeFeedEvent{ | ||
| StreamID: streamID, | ||
| RangeID: rangeID, | ||
| } | ||
| expectedErrEvent.MustSetValue(&kvpb.RangeFeedError{ | ||
| Error: *kvpb.NewError(kvpb.NewRangeFeedRetryError(kvpb.RangeFeedRetryError_REASON_NO_LEASEHOLDER)), | ||
| }) | ||
| // Receive the event after unblocking. | ||
| require.Truef(t, testServerStream.hasEvent(expectedErrEvent), | ||
| "expected event %v not found in %v", ev, testServerStream) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| // Copyright 2024 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package rangefeed | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "reflect" | ||
| "strings" | ||
| "sync" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/kv/kvpb" | ||
| "github.com/cockroachdb/cockroach/pkg/util/syncutil" | ||
| ) | ||
|
|
||
| // testServerStream mocks grpc server stream for testing. | ||
| type testServerStream struct { | ||
| syncutil.Mutex | ||
| // eventsSent is the total number of events sent. | ||
| eventsSent int | ||
| // streamEvents is a map of streamID to a list of events sent to that stream. | ||
| streamEvents map[int64][]*kvpb.MuxRangeFeedEvent | ||
| } | ||
|
|
||
| func newTestServerStream() *testServerStream { | ||
| return &testServerStream{ | ||
| streamEvents: make(map[int64][]*kvpb.MuxRangeFeedEvent), | ||
| } | ||
| } | ||
|
|
||
| func (s *testServerStream) totalEventsSent() int { | ||
| s.Lock() | ||
| defer s.Unlock() | ||
| return s.eventsSent | ||
| } | ||
|
|
||
| // hasEvent returns true if the event is found in the streamEvents map. Note | ||
| // that it does a deep equal comparison. | ||
| func (s *testServerStream) hasEvent(e *kvpb.MuxRangeFeedEvent) bool { | ||
| if e == nil { | ||
| return false | ||
| } | ||
| s.Lock() | ||
| defer s.Unlock() | ||
| for _, streamEvent := range s.streamEvents[e.StreamID] { | ||
| if reflect.DeepEqual(e, streamEvent) { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // String returns a string representation of the events sent in the stream. | ||
| func (s *testServerStream) String() string { | ||
| str := strings.Builder{} | ||
| for streamID, eventList := range s.streamEvents { | ||
| fmt.Fprintf(&str, "StreamID:%d, Len:%d\n", streamID, len(eventList)) | ||
| } | ||
| return str.String() | ||
| } | ||
|
|
||
| func (s *testServerStream) SendIsThreadSafe() {} | ||
|
|
||
| // Send mocks grpc.ServerStream Send method. It only counts events and stores | ||
| // events by streamID in streamEvents. | ||
| func (s *testServerStream) Send(e *kvpb.MuxRangeFeedEvent) error { | ||
| s.Lock() | ||
| defer s.Unlock() | ||
| s.eventsSent++ | ||
| s.streamEvents[e.StreamID] = append(s.streamEvents[e.StreamID], e) | ||
| return nil | ||
| } | ||
|
|
||
| // BlockSend blocks any subsequent Send methods until the unblock callback is | ||
| // called. | ||
| func (s *testServerStream) BlockSend() (unblock func()) { | ||
| s.Lock() | ||
| var once sync.Once | ||
| return func() { | ||
| // safe to call multiple times, e.g. defer and explicit | ||
| once.Do(s.Unlock) //nolint:deferunlockcheck | ||
| } | ||
| } |
Oops, something went wrong.