fix: Invalid handling of id in foreach when using discovery components

Author: thampiotr

internal/runtime/internal/controller/foreach_targets_test.go

@@ -0,0 +1,96 @@
+package controller_test
+
+import (
+	"context"
+	"os"
+	"testing"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/otel/trace/noop"
+
+	"github.com/grafana/alloy/internal/component"
+	"github.com/grafana/alloy/internal/component/discovery"
+	"github.com/grafana/alloy/internal/featuregate"
+	"github.com/grafana/alloy/internal/runtime/internal/controller"
+	"github.com/grafana/alloy/internal/runtime/logging"
+	"github.com/grafana/alloy/syntax/ast"
+	"github.com/grafana/alloy/syntax/parser"
+	"github.com/grafana/alloy/syntax/vm"
+)
+
+func TestForeachCollectionTargetsUsesId(t *testing.T) {
+	config := `foreach "default" {
+		collection = targets
+		var = "each"
+		id = "netbox_id"
+		template {
+		}
+	}`
+	moduleController := &moduleControllerStub{}
+	foreachConfigNode := controller.NewForeachConfigNode(getBlockFromConfig(t, config), getComponentGlobals(t, moduleController), nil)
+	vars := map[string]interface{}{
+		"targets": []discovery.Target{
+			discovery.NewTargetFromMap(map[string]string{
+				"__address__": "192.0.2.10",
+				"netbox_id":   "8201",
+				"instance":    "192.0.2.10",
+			}),
+			discovery.NewTargetFromMap(map[string]string{
+				"__address__": "198.51.100.24",
+				"netbox_id":   "8202",
+				"instance":    "198.51.100.24",
+			}),
+		},
+	}
+	require.NoError(t, foreachConfigNode.Evaluate(vm.NewScope(vars)))
+	require.ElementsMatch(t, []string{"foreach_8201_1", "foreach_8202_1"}, moduleController.customComponents)
+}
+
+func getBlockFromConfig(t *testing.T, config string) *ast.BlockStmt {
+	file, err := parser.ParseFile("", []byte(config))
+	require.NoError(t, err)
+	return file.Body[0].(*ast.BlockStmt)
+}
+
+func getComponentGlobals(t *testing.T, moduleController controller.ModuleController) controller.ComponentGlobals {
+	l, _ := logging.New(os.Stderr, logging.DefaultOptions)
+	return controller.ComponentGlobals{
+		Logger:            l,
+		TraceProvider:     noop.NewTracerProvider(),
+		DataPath:          t.TempDir(),
+		MinStability:      featuregate.StabilityGenerallyAvailable,
+		OnBlockNodeUpdate: func(cn controller.BlockNode) { /* no-op */ },
+		Registerer:        prometheus.NewRegistry(),
+		NewModuleController: func(opts controller.ModuleControllerOpts) controller.ModuleController {
+			return moduleController
+		},
+	}
+}
+
+type moduleControllerStub struct {
+	customComponents []string
+}
+
+func (m *moduleControllerStub) NewModule(id string, export component.ExportFunc) (component.Module, error) {
+	return nil, nil
+}
+
+func (m *moduleControllerStub) ModuleIDs() []string {
+	return nil
+}
+
+func (m *moduleControllerStub) NewCustomComponent(id string, export component.ExportFunc) (controller.CustomComponent, error) {
+	m.customComponents = append(m.customComponents, id)
+	return &customComponentStub{}, nil
+}
+
+type customComponentStub struct{}
+
+func (c *customComponentStub) LoadBody(body ast.Body, args map[string]any, customComponentRegistry *controller.CustomComponentRegistry) error {
+	return nil
+}
+
+func (c *customComponentStub) Run(ctx context.Context) error {
+	return nil
+}

internal/runtime/internal/controller/node_config_foreach.go

@@ -20,6 +20,7 @@ import (
 	"github.com/grafana/alloy/internal/nodeconf/foreach"
 	"github.com/grafana/alloy/internal/runner"
 	"github.com/grafana/alloy/internal/runtime/logging/level"
+	"github.com/grafana/alloy/syntax"
 	"github.com/grafana/alloy/syntax/ast"
 	"github.com/grafana/alloy/syntax/vm"
 )
@@ -200,13 +201,9 @@ func (fn *ForeachConfigNode) evaluate(scope *vm.Scope) error {
 
 		// Extract Id from collection if exists
 		if args.Id != "" {
-			if m, ok := args.Collection[i].(map[string]any); ok {
-				if val, exists := m[args.Id]; exists {
-					// Use the field's value for fingerprinting
-					id = val
-				} else {
-					level.Warn(fn.logger).Log("msg", "specified id not found in collection item", "id", args.Id)
-				}
+			if val, ok := collectionItemID(args.Collection[i], args.Id, fn.logger); ok {
+				// Use the field's value for fingerprinting
+				id = val
 			}
 		}
 
@@ -444,6 +441,57 @@ func objectFingerprint(id any, hashId bool) string {
 	}
 }
 
+func collectionItemID(item any, key string, logger log.Logger) (any, bool) {
+	switch value := item.(type) {
+	case map[string]any:
+		// Inline object literals in Alloy decode into map[string]any.
+		val, ok := value[key]
+		if !ok {
+			logMissingCollectionID(logger, key)
+			return nil, false
+		}
+		return val, true
+	case map[string]string:
+		// Object values sourced from Go (e.g., vars) often use map[string]string.
+		val, ok := value[key]
+		if !ok {
+			logMissingCollectionID(logger, key)
+			return nil, false
+		}
+		return val, true
+	case map[string]syntax.Value:
+		// Capsules converted to objects use map[string]syntax.Value (VM canonical form).
+		val, ok := value[key]
+		if !ok {
+			logMissingCollectionID(logger, key)
+			return nil, false
+		}
+		return val.Interface(), true
+	case syntax.ConvertibleIntoCapsule:
+		return collectionItemIDFromCapsule(value, key, logger)
+	default:
+		return nil, false
+	}
+}
+
+func collectionItemIDFromCapsule(value syntax.ConvertibleIntoCapsule, key string, logger log.Logger) (any, bool) {
+	var obj map[string]syntax.Value
+	if err := value.ConvertInto(&obj); err == nil {
+		val, ok := obj[key]
+		if ok {
+			return val.Interface(), true
+		}
+		logMissingCollectionID(logger, key)
+		return nil, false
+	}
+
+	return nil, false
+}
+
+func logMissingCollectionID(logger log.Logger, key string) {
+	level.Warn(logger).Log("msg", "specified id not found in collection item", "id", key)
+}
+
 func replaceNonAlphaNumeric(s string) string {
 	var builder strings.Builder
 	for _, r := range s {

internal/runtime/internal/controller/node_config_foreach_test.go

@@ -16,6 +16,7 @@ import (
 	"github.com/grafana/alloy/internal/component"
 	"github.com/grafana/alloy/internal/featuregate"
 	"github.com/grafana/alloy/internal/runtime/logging"
+	"github.com/grafana/alloy/syntax"
 	"github.com/grafana/alloy/syntax/ast"
 	"github.com/grafana/alloy/syntax/parser"
 	"github.com/grafana/alloy/syntax/vm"
@@ -338,6 +339,47 @@ func TestStringIDHashWithKeySameValue(t *testing.T) {
 	require.ElementsMatch(t, customComponentIds, []string{"foreach_1951d330e1267d082c816bfb3f40cce6eb9a8da9f6a6b9da09ace3c6514361cd_1", "foreach_1951d330e1267d082c816bfb3f40cce6eb9a8da9f6a6b9da09ace3c6514361cd_2"})
 }
 
+func TestForeachCollectionMapAnyUsesId(t *testing.T) {
+	config := `foreach "default" {
+		collection = [obj1, obj2]
+		var = "each"
+		id = "netbox_id"
+		template {
+		}
+	}`
+	foreachConfigNode := NewForeachConfigNode(getBlockFromConfig(t, config), getComponentGlobals(t), nil)
+	vars := map[string]interface{}{
+		"obj1": map[string]any{
+			"netbox_id": "9101",
+		},
+		"obj2": map[string]any{
+			"netbox_id": "9102",
+		},
+	}
+	require.NoError(t, foreachConfigNode.Evaluate(vm.NewScope(vars)))
+	customComponentIds := foreachConfigNode.moduleController.(*ModuleControllerMock).CustomComponents
+	require.ElementsMatch(t, customComponentIds, []string{"foreach_9101_1", "foreach_9102_1"})
+}
+
+func TestForeachCollectionSyntaxValueUsesId(t *testing.T) {
+	config := `foreach "default" {
+		collection = [obj1]
+		var = "each"
+		id = "netbox_id"
+		template {
+		}
+	}`
+	foreachConfigNode := NewForeachConfigNode(getBlockFromConfig(t, config), getComponentGlobals(t), nil)
+	vars := map[string]interface{}{
+		"obj1": map[string]syntax.Value{
+			"netbox_id": syntax.ValueFromString("9103"),
+		},
+	}
+	require.NoError(t, foreachConfigNode.Evaluate(vm.NewScope(vars)))
+	customComponentIds := foreachConfigNode.moduleController.(*ModuleControllerMock).CustomComponents
+	require.ElementsMatch(t, customComponentIds, []string{"foreach_9103_1"})
+}
+
 func TestCollectionNonArrayValue(t *testing.T) {
 	config := `foreach "default" {
 		collection = "aaa"