Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
75 changes: 75 additions & 0 deletions clientv3/integration/watch_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import (
mvccpb "go.etcd.io/etcd/mvcc/mvccpb"
"go.etcd.io/etcd/pkg/testutil"

"github.com/stretchr/testify/require"
"google.golang.org/grpc/metadata"
)

Expand Down Expand Up @@ -1184,3 +1185,77 @@ func testWatchClose(t *testing.T, wctx *watchctx) {
t.Fatalf("read wch got %v; expected closed channel", wresp)
}
}

func TestWatch(t *testing.T) {
defer testutil.AfterTest(t)
clus := integration.NewClusterV3(t, &integration.ClusterConfig{Size: 1})
defer clus.Terminate(t)
client := clus.Client(0)

tcs := []struct {
name string
key string
opts []clientv3.OpOption
wantError error
wantEvents []*clientv3.Event
}{
{
name: "Watch with negative revision",
key: "/",
opts: []clientv3.OpOption{clientv3.WithRev(-1)},
wantError: rpctypes.ErrCompacted,
},
{
name: "Watch with zero revision",
key: "/",
opts: []clientv3.OpOption{clientv3.WithRev(0)},
},
{
name: "Watch with positive revision",
key: "/",
opts: []clientv3.OpOption{clientv3.WithRev(1)},
},
}
ctx := t.Context()

t.Log("Open watches")
watches := make([]clientv3.WatchChan, len(tcs))
for i, tc := range tcs {
watchCtx, cancel := context.WithTimeout(ctx, time.Second)
defer cancel()
watches[i] = client.Watch(watchCtx, tc.key, tc.opts...)
}

t.Log("Validate")
for i, tc := range tcs {
t.Run(tc.name, func(t *testing.T) {
_, err := collectEvents(ctx, watches[i])
if tc.wantError == nil {
require.NoError(t, err)
} else {
require.ErrorContains(t, err, tc.wantError.Error())
}
})
}
}

func collectEvents(ctx context.Context, watch clientv3.WatchChan) (events []*clientv3.Event, err error) {
for {
select {
case resp, ok := <-watch:
if !ok {
return events, nil
}
err := resp.Err()
if err != nil {
return events, err
}
events = append(events, resp.Events...)
case <-ctx.Done():
return events, ctx.Err()
// Watch resync interval * 1.5
case <-time.After(150 * time.Millisecond):
return events, nil
}
}
}
16 changes: 16 additions & 0 deletions etcdserver/api/v3rpc/watch.go
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,22 @@ func (sws *serverWatchStream) recvLoop() error {
// support >= key queries
creq.RangeEnd = []byte{}
}
if creq.StartRevision < 0 {
wr := &pb.WatchResponse{
Header: sws.newResponseHeader(sws.watchStream.Rev()),
WatchId: clientv3.InvalidWatchID,
Canceled: true,
Created: true,
CancelReason: rpctypes.ErrCompacted.Error(),
}

select {
case sws.ctrlStream <- wr:
continue
case <-sws.closec:
return nil
}
}

err := sws.isWatchPermitted(creq)
if err != nil {
Expand Down
4 changes: 4 additions & 0 deletions mvcc/watchable_store.go
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,10 @@ func (s *watchableStore) syncWatchers() int {
compactionRev := s.store.compactMainRev

wg, minRev := s.unsynced.choose(maxWatchersPerSync, curRev, compactionRev)
if minRev < 0 {
s.store.lg.Warn("Unexpected negative revision range start", zap.Int64("minRev", minRev))
minRev = 0
}
minBytes, maxBytes := newRevBytes(), newRevBytes()
revToBytes(revision{main: minRev}, minBytes)
revToBytes(revision{main: curRev + 1}, maxBytes)
Expand Down
11 changes: 11 additions & 0 deletions proxy/grpcproxy/watch.go
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,17 @@ func (wps *watchProxyStream) recvLoop() error {
case *pb.WatchRequest_CreateRequest:
cr := uv.CreateRequest

if cr.StartRevision < 0 {
wps.watchCh <- &pb.WatchResponse{
Header: &pb.ResponseHeader{},
WatchId: clientv3.InvalidWatchID,
Created: true,
Canceled: true,
CancelReason: rpctypes.ErrCompacted.Error(),
}
continue
}

if err := wps.checkPermissionForWatch(cr.Key, cr.RangeEnd); err != nil {
wps.watchCh <- &pb.WatchResponse{
Header: &pb.ResponseHeader{},
Expand Down