Method parseComponentYAML

runtime/parser/parse_component.go:83–172

parseComponentYAML parses and validates a ComponentYAML. It is separated from parseComponent to allow inline creation of components from a canvas YAML file.

(tmp *ComponentYAML)

// parseComponentYAML parses and validates a ComponentYAML.
// It is separated from parseComponent to allow inline creation of components from a canvas YAML file.
func (p *Parser) parseComponentYAML(tmp *ComponentYAML) (*runtimev1.ComponentSpec, []ResourceName, error) {
	// Display name backwards compatibility
	if tmp.Title != "" && tmp.DisplayName == "" {
		tmp.DisplayName = tmp.Title
	}

	// Description backwards compatibility
	if tmp.Subtitle != "" && tmp.Description == "" {
		tmp.Description = tmp.Subtitle
	}

	// Discover and validate the renderer
	n := 0
	var renderer string
	var rendererProps *structpb.Struct
	if len(tmp.Other) == 1 {
		n++
		var props map[string]any
		for renderer, props = range tmp.Other {
			break
		}

		propsPB, err := structpb.NewStruct(props)
		if err != nil {
			return nil, nil, fmt.Errorf(`failed to convert property %q to struct: %w`, renderer, err)
		}

		rendererProps = propsPB
	} else {
		n += len(tmp.Other)
	}

	// Check there is exactly one renderer
	if n == 0 {
		return nil, nil, errors.New(`missing renderer configuration`)
	}
	if n > 1 {
		return nil, nil, errors.New(`multiple renderers are not allowed`)
	}

	// We generally treat the renderer props as untyped, but since "metrics_view" is a very common field,
	// and adding it to refs generally makes for nicer error messages, we specifically search for and link it here.
	var refs []ResourceName
	if rendererProps != nil {
		for k, v := range rendererProps.Fields {
			if k == "metrics_view" {
				name := v.GetStringValue()
				if name != "" {
					refs = append(refs, ResourceName{Kind: ResourceKindMetricsView, Name: name})
				}
				break
			}
		}
	}

	// Parse input variables
	var input []*runtimev1.ComponentVariable
	if len(tmp.Input) > 0 {