Skip to content

Distinguish different types of table events in watch gRPC API #3587

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

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

Distinguish different types of table events in watch gRPC API #3587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
882ee72
Distinguish different types of table events in watch gRPC API
SampleText2k77 Aug 31, 2026
696df56
Fix flaky TestGRPCWatchEventTypesAdjIn
SampleText2k77 Sep 2, 2026
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
1,244 changes: 666 additions & 578 deletions api/gobgp.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

55 changes: 42 additions & 13 deletions pkg/server/grpc_server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,35 +382,64 @@ func (s *server) watchEvent(ctx context.Context, r *api.WatchEventRequest, fn fu
if len(opts) == 0 {
return status.Errorf(codes.InvalidArgument, "no events to watch")
}
simpleSend := func(paths []*api.Path, when time.Time) {
fn(&api.WatchEventResponse{Event: &api.WatchEventResponse_Table{Table: &api.WatchEventResponse_TableEvent{Paths: paths}}}, when)
simpleSend := func(paths []*api.Path, when time.Time, eventType api.WatchEventResponse_TableEvent_Type) {
fn(&api.WatchEventResponse{
Event: &api.WatchEventResponse_Table{
Table: &api.WatchEventResponse_TableEvent{
Type: eventType,
Paths: paths,
},
},
}, when)
}
err := s.bgpServer.WatchEvent(ctx, WatchEventMessageCallbacks{
OnPathUpdate: func(pathList []*apiutil.Path, timestamp time.Time) {
OnPathUpdate: func(pathList []*apiutil.Path, timestamp time.Time, init bool) {
paths := make([]*api.Path, 0, r.BatchSize)
for _, path := range pathList {
paths = append(paths, toPathApi(path, false, false, false))
if r.BatchSize > 0 && len(paths) > int(r.BatchSize) {
simpleSend(paths, timestamp)
paths = make([]*api.Path, 0, r.BatchSize)
if init && len(pathList) == 0 {
simpleSend(paths, timestamp, api.WatchEventResponse_TableEvent_TYPE_ADJ_IN_EOR)
} else {
eventType := api.WatchEventResponse_TableEvent_TYPE_ADJ_IN_UPDATE
if init {
eventType = api.WatchEventResponse_TableEvent_TYPE_ADJ_IN_INIT
}
for _, path := range pathList {
paths = append(paths, toPathApi(path, false, false, false))
if r.BatchSize > 0 && len(paths) > int(r.BatchSize) {
simpleSend(paths, timestamp, eventType)
paths = make([]*api.Path, 0, r.BatchSize)
}
}

eventType = api.WatchEventResponse_TableEvent_TYPE_ADJ_IN_UPDATE
if init {
eventType = api.WatchEventResponse_TableEvent_TYPE_ADJ_IN_INIT_END
}
simpleSend(paths, timestamp, eventType)
}
simpleSend(paths, timestamp)
},
OnBestPath: func(pathList []*apiutil.Path, timestamp time.Time) {
OnBestPath: func(pathList []*apiutil.Path, timestamp time.Time, init bool) {
eventType := api.WatchEventResponse_TableEvent_TYPE_BEST_UPDATE
if init {
eventType = api.WatchEventResponse_TableEvent_TYPE_BEST_INIT
}
pl := make([]*api.Path, 0, r.BatchSize)
for _, path := range pathList {
pl = append(pl, toPathApi(path, false, false, false))
if r.BatchSize > 0 && len(pl) > int(r.BatchSize) {
simpleSend(pl, timestamp)
simpleSend(pl, timestamp, eventType)
pl = make([]*api.Path, 0, r.BatchSize)
}
}
simpleSend(pl, timestamp)

eventType = api.WatchEventResponse_TableEvent_TYPE_BEST_UPDATE
if init {
eventType = api.WatchEventResponse_TableEvent_TYPE_BEST_INIT_END
}
simpleSend(pl, timestamp, eventType)
},
OnPathEor: func(path *apiutil.Path, timestamp time.Time) {
p := toPathApi(path, false, false, false)
simpleSend([]*api.Path{p}, timestamp)
simpleSend([]*api.Path{p}, timestamp, api.WatchEventResponse_TableEvent_TYPE_EOR)
},
OnPeerUpdate: func(peer *apiutil.WatchEventMessage_PeerEvent, timestamp time.Time) {
p := peer.Peer
Expand Down
Loading