1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
|
package grpctool
import (
"fmt"
"io"
"reflect"
"sort"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/grpctool/automata"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/types/descriptorpb"
)
const (
eofState protoreflect.FieldNumber = -1
startState protoreflect.FieldNumber = -2
)
// Stream is a grpc.ServerStream or grpc.ClientStream.
type Stream interface {
RecvMsg(m interface{}) error
}
// MessageCallback is a function with signature func(message someConcreteProtoMessage) error
// someConcreteProtoMessage must be the type passed to NewStreamVisitor().
type MessageCallback interface{}
// InvalidTransitionCallback is a callback that is called when an invalid transition is attempted.
// 'message' is nil when 'to' is eofState.
type InvalidTransitionCallback func(from, to protoreflect.FieldNumber, allowed []protoreflect.FieldNumber, message proto.Message) error
type EOFCallback func() error
// StreamVisitor allows to consume messages in a gRPC stream.
// Message order should follow the automata, defined on fields in a oneof group.
type StreamVisitor struct {
reflectMessage protoreflect.Message
goMessageType reflect.Type
allowedTransitions map[protoreflect.FieldNumber][]protoreflect.FieldNumber
oneof protoreflect.OneofDescriptor
}
func NewStreamVisitor(streamMessage proto.Message) (*StreamVisitor, error) {
reflectMessage := streamMessage.ProtoReflect()
messageDescriptor := reflectMessage.Type().Descriptor()
oneofs := messageDescriptor.Oneofs()
l := oneofs.Len()
if l != 1 {
return nil, fmt.Errorf("one oneof group is expected in %s, %d defined", messageDescriptor.FullName(), l)
}
oneof := oneofs.Get(0)
allowedTransitions, err := allowedTransitionsForOneof(oneof)
if err != nil {
return nil, err
}
return &StreamVisitor{
reflectMessage: reflectMessage,
goMessageType: reflect.TypeOf(streamMessage),
allowedTransitions: allowedTransitions,
oneof: oneof,
}, nil
}
func (s *StreamVisitor) Visit(stream Stream, opts ...StreamVisitorOption) error {
cfg, err := s.applyOptions(opts)
if err != nil {
return err
}
messageType := s.reflectMessage.Type()
currentState := cfg.startState
// Allocate message once. proto.Unmarshal() resets messages on receive so internal message structure is
// fresh on each receive, but we save on allocating the outer object.
// Because objects in fields of the message are fresh on each receive, it's safe to retain pointers to them.
msgRefl := messageType.New()
msg := msgRefl.Interface()
for {
allowedTransitions := s.allowedTransitions[currentState]
err = stream.RecvMsg(msg)
if err != nil {
if err != io.EOF { // nolint:errorlint
return err
}
newState := eofState
if isTransitionAllowed(newState, allowedTransitions) {
return cfg.eofCallback()
} else {
return cfg.invalidTransitionCallback(currentState, newState, allowedTransitions, nil)
}
}
field := msgRefl.WhichOneof(s.oneof)
if field == nil {
return status.Errorf(codes.InvalidArgument, "no fields in the oneof group %s is set", s.oneof.FullName())
}
newState := field.Number()
if !isTransitionAllowed(newState, allowedTransitions) {
return cfg.invalidTransitionCallback(currentState, newState, allowedTransitions, msg)
}
if c, ok := cfg.notExpectingFields[newState]; ok {
return status.Errorf(c, "unexpected field number received: %d", newState)
}
var param reflect.Value
cb, ok := cfg.msgCallbacks[newState]
if ok { // a message callback
param = reflect.ValueOf(msg)
} else { // a field callback
cb = cfg.fieldCallbacks[newState]
value := msgRefl.Get(field)
switch field.Kind() { // nolint:exhaustive
case protoreflect.MessageKind:
param = reflect.ValueOf(value.Message().Interface())
case protoreflect.EnumKind:
// We have tested that values are assignable in WithCallback() so it's safe to convert here.
param = reflect.ValueOf(value.Enum()).Convert(cb.Type().In(0))
default:
param = reflect.ValueOf(value.Interface())
}
}
ret := cb.Call([]reflect.Value{param})
// It might be:
// - an untyped nil
// - error-typed nil
// - non-nil error
// Treat untyped nils as nil error since that's what it is.
err, _ = ret[0].Interface().(error)
if err != nil {
return err
}
currentState = newState
}
}
func (s *StreamVisitor) applyOptions(opts []StreamVisitorOption) (config, error) {
cfg := s.defaultOptions()
for _, o := range opts {
err := o(&cfg)
if err != nil {
return config{}, err
}
}
// We only require reachable fields to have a callback
unreachableFields := getUnreachableFields(cfg.startState, s.allowedTransitions)
fields := s.oneof.Fields()
l := fields.Len()
for i := 0; i < l; i++ {
field := fields.Get(i)
fieldNumber := field.Number()
_, ok := unreachableFields[fieldNumber]
if ok {
continue
}
_, ok = cfg.notExpectingFields[fieldNumber]
if ok {
continue
}
_, ok = cfg.msgCallbacks[fieldNumber]
if ok {
continue
}
_, ok = cfg.fieldCallbacks[fieldNumber]
if ok {
continue
}
return config{}, status.Errorf(codes.Internal, "no callback defined for field %s (%d)", field.FullName(), fieldNumber)
}
return cfg, nil
}
func (s *StreamVisitor) defaultOptions() config {
return config{
reflectMessage: s.reflectMessage,
goMessageType: s.goMessageType,
oneof: s.oneof,
eofCallback: defaultEOFCallback,
invalidTransitionCallback: defaultInvalidTransitionCallback,
startState: startState,
notExpectingFields: make(map[protoreflect.FieldNumber]codes.Code),
msgCallbacks: make(map[protoreflect.FieldNumber]reflect.Value),
fieldCallbacks: make(map[protoreflect.FieldNumber]reflect.Value),
}
}
func allowedTransitionsForOneof(oneof protoreflect.OneofDescriptor) (map[protoreflect.FieldNumber][]protoreflect.FieldNumber, error) {
fields := oneof.Fields()
l := fields.Len()
res := make(map[protoreflect.FieldNumber][]protoreflect.FieldNumber, l)
for i := 0; i < l; i++ { // iterate fields of oneof
field := fields.Get(i)
options := field.Options().(*descriptorpb.FieldOptions)
if !proto.HasExtension(options, automata.E_NextAllowedField) {
return nil, fmt.Errorf("field %s does not have any transitions defined", field.FullName())
}
nextAllowedFieldsInts := proto.GetExtension(options, automata.E_NextAllowedField).([]int32)
nextAllowedFieldsNumbers, err := intsToNumbers(oneof, nextAllowedFieldsInts)
if err != nil {
return nil, err
}
res[field.Number()] = nextAllowedFieldsNumbers
}
oneofOptions := oneof.Options().(*descriptorpb.OneofOptions)
firstAllowedFieldsInts := proto.GetExtension(oneofOptions, automata.E_FirstAllowedField).([]int32)
firstAllowedFieldsNumbers, err := intsToNumbers(oneof, firstAllowedFieldsInts)
if err != nil {
return nil, err
}
res[startState] = firstAllowedFieldsNumbers
unreachables := getUnreachableFields(startState, res)
delete(unreachables, startState) // the default starting state is expected to be unreachable
if len(unreachables) > 0 {
unreachablesList := make([]protoreflect.FieldNumber, 0, len(unreachables))
for f := range unreachables {
unreachablesList = append(unreachablesList, f)
}
sort.Sort(protoFieldNumbers(unreachablesList)) // sort to ensure deterministic results
return nil, fmt.Errorf("unreachable fields in oneof %s: %v", oneof.FullName(), unreachablesList)
}
return res, nil
}
// getUnreachableFields returns a map m where m[f] is present if and only if
// there exists a transition to f in the graph. Note that this also applies to
// the root, so the root is always unreachable unless there is a transition
// to the root.
func getUnreachableFields(root protoreflect.FieldNumber, graph map[protoreflect.FieldNumber][]protoreflect.FieldNumber) map[protoreflect.FieldNumber]struct{} {
stack := []protoreflect.FieldNumber{root}
remaining := make(map[protoreflect.FieldNumber]struct{}, len(graph))
for node := range graph {
remaining[node] = struct{}{}
}
// non-recursive DFS, removing nodes from remaining as they are visited
for len(stack) > 0 {
var node protoreflect.FieldNumber
node, stack = stack[len(stack)-1], stack[:len(stack)-1]
for _, child := range graph[node] {
if _, isRemaining := remaining[child]; isRemaining {
delete(remaining, child)
stack = append(stack, child)
}
}
}
return remaining
}
// implement sort.Interface
type protoFieldNumbers []protoreflect.FieldNumber
func (p protoFieldNumbers) Len() int { return len(p) }
func (p protoFieldNumbers) Swap(i, j int) { p[i], p[j] = p[j], p[i] }
func (p protoFieldNumbers) Less(i, j int) bool { return p[i] < p[j] }
func intsToNumbers(oneof protoreflect.OneofDescriptor, ints []int32) ([]protoreflect.FieldNumber, error) {
if len(ints) == 0 {
return nil, fmt.Errorf("empty allowed field number list in oneof %s", oneof.FullName())
}
fields := oneof.Fields()
allowed := make([]protoreflect.FieldNumber, 0, len(ints))
for _, nextFieldInt := range ints {
nextFieldNumber := protoreflect.FieldNumber(nextFieldInt)
if nextFieldNumber != eofState {
// If it's not EOF then check if it's a valid number
nextField := fields.ByNumber(nextFieldNumber)
if nextField == nil {
return nil, fmt.Errorf("field number %d is not part of oneof %s", nextFieldNumber, oneof.FullName())
}
}
allowed = append(allowed, nextFieldNumber)
}
return allowed, nil
}
func isTransitionAllowed(to protoreflect.FieldNumber, allowed []protoreflect.FieldNumber) bool {
for _, n := range allowed {
if to == n {
return true
}
}
return false
}
|