Seperate documentation lookup from find field type

Author: jnthntatum

cel/fieldpaths.go

@@ -22,9 +22,17 @@ func (f *fieldPath) Documentation() *common.Doc {
 	return common.NewFieldDoc(f.path, f.celType.String(), f.description)
 }
 
+type documentationProvider interface {
+	// FindStructFieldDescription returns documentation for a field if available.
+	// Returns false if the field could not be found.
+	FindStructFieldDescription(typeName, fieldName string) (string, bool)
+}
+
 type backtrack struct {
 	// provider used to resolve types.
 	provider types.Provider
+	// provider for resolving documentation. nil if unsupported
+	docProvider documentationProvider
 	// paths of fields that have been visited along the path.
 	path []string
 	// types of fields that have been visited along the path. used to avoid cycles.
@@ -79,10 +87,14 @@ func (b *backtrack) expandFieldPaths(celType *Type, paths []*fieldPath) []*field
 				continue
 			}
 			b.push(field, celType)
+			description := ""
+			if b.docProvider != nil {
+				description, _ = b.docProvider.FindStructFieldDescription(celType.String(), field)
+			}
 			path := &fieldPath{
 				celType:     fieldType.Type,
 				path:        formatPath(b.path),
-				description: fieldType.Description,
+				description: description,
 				isLeaf:      false,
 			}
 			paths = append(paths, path)
@@ -137,9 +149,10 @@ func (b *backtrack) expandFieldPaths(celType *Type, paths []*fieldPath) []*field
 // fieldPathsForType expands the reachable fields from the given root identifier.
 func fieldPathsForType(provider types.Provider, identifier string, celType *Type) []*fieldPath {
 	b := &backtrack{
-		provider: provider,
-		path:     []string{identifier},
-		types:    []*Type{celType},
+		provider:    provider,
+		docProvider: provider.(documentationProvider),
+		path:        []string{identifier},
+		types:       []*Type{celType},
 	}
 	paths := []*fieldPath{
 		{

common/types/provider.go

@@ -81,9 +81,6 @@ type FieldType struct {
 
 	// GetFrom retrieves the field value on the input object, if set.
 	GetFrom ref.FieldGetter
-
-	// Description provides a description of the field. Empty if no description available.
-	Description string
 }
 
 // Registry provides type information for a set of registered types.
@@ -209,13 +206,26 @@ func (p *Registry) FindStructFieldType(structType, fieldName string) (*FieldType
 		return nil, false
 	}
 	return &FieldType{
-		Type:        fieldDescToCELType(field),
-		IsSet:       field.IsSet,
-		GetFrom:     field.GetFrom,
-		Description: field.Documentation(),
+		Type:    fieldDescToCELType(field),
+		IsSet:   field.IsSet,
+		GetFrom: field.GetFrom,
 	}, true
 }
 
+// FindStructFieldDescription returns documentation for a field if available.
+// Returns false if the field could not be found.
+func (p *Registry) FindStructFieldDescription(structType, fieldName string) (string, bool) {
+	msgType, found := p.pbdb.DescribeType(structType)
+	if !found {
+		return "", false
+	}
+	field, found := msgType.FieldByName(fieldName)
+	if !found {
+		return "", false
+	}
+	return field.Documentation(), true
+}
+
 // FindIdent takes a qualified identifier name and returns a ref.Val if one exists.
 func (p *Registry) FindIdent(identName string) (ref.Val, bool) {
 	if t, found := p.revTypeMap[identName]; found {