Skip to content

Commit c3f216c

Browse files
blakerouseblakerouse
authored
Ensure unique ID for dynamic variable replacement. (#1866)
* Ensure unique ID for dynamic variable replacement. * Add changelog.
1 parent 00d40bb commit c3f216c

File tree

8 files changed

+109
-24
lines changed

8 files changed

+109
-24
lines changed

‎changelog/fragments/1669928791-Ensure-unique-input-ID-when-variable-substition-occurs-from-a-dynamic-provider.yaml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Kind can be one of:
2+
# - breaking-change: a change to previously-documented behavior
3+
# - deprecation: functionality that is being removed in a later release
4+
# - bug-fix: fixes a problem in a previous version
5+
# - enhancement: extends functionality but does not break or fix existing behavior
6+
# - feature: new functionality
7+
# - known-issue: problems that we are aware of in a given version
8+
# - security: impacts on the security of a product or a user’s deployment.
9+
# - upgrade: important information for someone upgrading from a prior version
10+
# - other: does not fit into any of the other categories
11+
kind: feature
12+
13+
# Change summary; a 80ish characters long description of the change.
14+
summary: Ensure unique input ID when variable substition occurs from a dynamic provider
15+
16+
# Long description; in case the summary is not enough to describe the change
17+
# this field accommodate a description without length limits.
18+
#description:
19+
20+
# Affected component; a word indicating the component this changeset affects.
21+
component:
22+
23+
# PR number; optional; the PR number that added the changeset.
24+
# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added.
25+
# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number.
26+
# Please provide it if you are adding a fragment for a different PR.
27+
pr: 1866
28+
29+
# Issue number; optional; the GitHub issue related to this changeset (either closes or is part of).
30+
# If not present is automatically filled by the tooling with the issue linked to the PR number.
31+
issue: 1751

‎internal/pkg/agent/transpiler/ast_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1840,7 +1840,7 @@ func TestLookupString(t *testing.T) {
18401840
}
18411841

18421842
func mustMakeVars(mapping map[string]interface{}) *Vars {
1843-
v, err := NewVars(mapping, nil)
1843+
v, err := NewVars("", mapping, nil)
18441844
if err != nil {
18451845
panic(err)
18461846
}

‎internal/pkg/agent/transpiler/utils.go

+37-4
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ func RenderInputs(inputs Node, varsArray []*Vars) (Node, error) {
1515
if !ok {
1616
return nil, fmt.Errorf("inputs must be an array")
1717
}
18-
nodes := []*Dict{}
18+
var nodes []varIDMap
1919
nodesMap := map[string]*Dict{}
2020
for _, vars := range varsArray {
2121
for _, node := range l.Value().([]Node) {
@@ -41,17 +41,50 @@ func RenderInputs(inputs Node, varsArray []*Vars) (Node, error) {
4141
_, exists := nodesMap[hash]
4242
if !exists {
4343
nodesMap[hash] = dict
44-
nodes = append(nodes, dict)
44+
nodes = append(nodes, varIDMap{vars.ID(), dict})
4545
}
4646
}
4747
}
48-
nInputs := []Node{}
48+
var nInputs []Node
4949
for _, node := range nodes {
50-
nInputs = append(nInputs, promoteProcessors(node))
50+
if node.id != "" {
51+
// vars has unique ID, concat ID onto existing ID
52+
idNode, ok := node.d.Find("id")
53+
if ok {
54+
idKey, _ := idNode.(*Key) // always a Key
55+
56+
// clone original and update its key to 'original_id'
57+
origKey, _ := idKey.Clone().(*Key) // always a Key
58+
origKey.name = "original_id"
59+
node.d.Insert(origKey)
60+
61+
// update id field to concat the id of the variable context set
62+
switch idVal := idKey.value.(type) {
63+
case *StrVal:
64+
idVal.value = fmt.Sprintf("%s-%s", idVal.value, node.id)
65+
case *IntVal:
66+
idKey.value = NewStrVal(fmt.Sprintf("%d-%s", idVal.value, node.id))
67+
case *UIntVal:
68+
idKey.value = NewStrVal(fmt.Sprintf("%d-%s", idVal.value, node.id))
69+
case *FloatVal:
70+
idKey.value = NewStrVal(fmt.Sprintf("%f-%s", idVal.value, node.id))
71+
default:
72+
return nil, fmt.Errorf("id field type invalid, expected string, int, uint, or float got: %T", idKey.value)
73+
}
74+
} else {
75+
node.d.Insert(NewKey("id", NewStrVal(node.id)))
76+
}
77+
}
78+
nInputs = append(nInputs, promoteProcessors(node.d))
5179
}
5280
return NewList(nInputs), nil
5381
}
5482

83+
type varIDMap struct {
84+
id string
85+
d *Dict
86+
}
87+
5588
func promoteProcessors(dict *Dict) *Dict {
5689
p := dict.Processors()
5790
if p == nil {

‎internal/pkg/agent/transpiler/utils_test.go

+20-10
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,7 @@ func TestRenderInputs(t *testing.T) {
363363
"vars with processors": {
364364
input: NewKey("inputs", NewList([]Node{
365365
NewDict([]Node{
366+
NewKey("id", NewStrVal("initial")),
366367
NewKey("type", NewStrVal("logfile")),
367368
NewKey("streams", NewList([]Node{
368369
NewDict([]Node{
@@ -385,6 +386,7 @@ func TestRenderInputs(t *testing.T) {
385386
})),
386387
expected: NewList([]Node{
387388
NewDict([]Node{
389+
NewKey("id", NewStrVal("initial-value1")),
388390
NewKey("type", NewStrVal("logfile")),
389391
NewKey("streams", NewList([]Node{
390392
NewDict([]Node{
@@ -411,8 +413,10 @@ func TestRenderInputs(t *testing.T) {
411413
})),
412414
}),
413415
})),
416+
NewKey("original_id", NewStrVal("initial")),
414417
}),
415418
NewDict([]Node{
419+
NewKey("id", NewStrVal("initial-value2")),
416420
NewKey("type", NewStrVal("logfile")),
417421
NewKey("streams", NewList([]Node{
418422
NewDict([]Node{
@@ -439,10 +443,11 @@ func TestRenderInputs(t *testing.T) {
439443
})),
440444
}),
441445
})),
446+
NewKey("original_id", NewStrVal("initial")),
442447
}),
443448
}),
444449
varsArray: []*Vars{
445-
mustMakeVarsP(map[string]interface{}{
450+
mustMakeVarsP("value1", map[string]interface{}{
446451
"var1": map[string]interface{}{
447452
"name": "value1",
448453
},
@@ -458,7 +463,7 @@ func TestRenderInputs(t *testing.T) {
458463
},
459464
},
460465
}),
461-
mustMakeVarsP(map[string]interface{}{
466+
mustMakeVarsP("value2", map[string]interface{}{
462467
"var1": map[string]interface{}{
463468
"name": "value2",
464469
},
@@ -499,6 +504,7 @@ func TestRenderInputs(t *testing.T) {
499504
})),
500505
}),
501506
})),
507+
NewKey("id", NewStrVal("value1")),
502508
NewKey("processors", NewList([]Node{
503509
NewDict([]Node{
504510
NewKey("add_fields", NewDict([]Node{
@@ -519,6 +525,7 @@ func TestRenderInputs(t *testing.T) {
519525
})),
520526
}),
521527
})),
528+
NewKey("id", NewStrVal("value2")),
522529
NewKey("processors", NewList([]Node{
523530
NewDict([]Node{
524531
NewKey("add_fields", NewDict([]Node{
@@ -532,7 +539,7 @@ func TestRenderInputs(t *testing.T) {
532539
}),
533540
}),
534541
varsArray: []*Vars{
535-
mustMakeVarsP(map[string]interface{}{
542+
mustMakeVarsP("value1", map[string]interface{}{
536543
"var1": map[string]interface{}{
537544
"name": "value1",
538545
},
@@ -548,7 +555,7 @@ func TestRenderInputs(t *testing.T) {
548555
},
549556
},
550557
}),
551-
mustMakeVarsP(map[string]interface{}{
558+
mustMakeVarsP("value2", map[string]interface{}{
552559
"var1": map[string]interface{}{
553560
"name": "value2",
554561
},
@@ -599,6 +606,7 @@ func TestRenderInputs(t *testing.T) {
599606
NewKey("invalid", NewStrVal("value")),
600607
})),
601608
})),
609+
NewKey("id", NewStrVal("value1")),
602610
}),
603611
NewDict([]Node{
604612
NewKey("type", NewStrVal("logfile")),
@@ -614,10 +622,11 @@ func TestRenderInputs(t *testing.T) {
614622
NewKey("invalid", NewStrVal("value")),
615623
})),
616624
})),
625+
NewKey("id", NewStrVal("value2")),
617626
}),
618627
}),
619628
varsArray: []*Vars{
620-
mustMakeVarsP(map[string]interface{}{
629+
mustMakeVarsP("value1", map[string]interface{}{
621630
"var1": map[string]interface{}{
622631
"name": "value1",
623632
},
@@ -633,7 +642,7 @@ func TestRenderInputs(t *testing.T) {
633642
},
634643
},
635644
}),
636-
mustMakeVarsP(map[string]interface{}{
645+
mustMakeVarsP("value2", map[string]interface{}{
637646
"var1": map[string]interface{}{
638647
"name": "value2",
639648
},
@@ -674,6 +683,7 @@ func TestRenderInputs(t *testing.T) {
674683
})),
675684
}),
676685
})),
686+
NewKey("id", NewStrVal("value1")),
677687
NewKey("processors", NewList([]Node{
678688
NewDict([]Node{
679689
NewKey("add_fields", NewDict([]Node{
@@ -687,7 +697,7 @@ func TestRenderInputs(t *testing.T) {
687697
}),
688698
}),
689699
varsArray: []*Vars{
690-
mustMakeVarsP(map[string]interface{}{
700+
mustMakeVarsP("value1", map[string]interface{}{
691701
"var1": map[string]interface{}{
692702
"name": "value1",
693703
},
@@ -703,7 +713,7 @@ func TestRenderInputs(t *testing.T) {
703713
},
704714
},
705715
}),
706-
mustMakeVarsP(map[string]interface{}{
716+
mustMakeVarsP("value2", map[string]interface{}{
707717
"var1": map[string]interface{}{
708718
"name": "value1",
709719
},
@@ -736,8 +746,8 @@ func TestRenderInputs(t *testing.T) {
736746
}
737747
}
738748

739-
func mustMakeVarsP(mapping map[string]interface{}, processorKey string, processors Processors) *Vars {
740-
v, err := NewVarsWithProcessors(mapping, processorKey, processors, nil)
749+
func mustMakeVarsP(id string, mapping map[string]interface{}, processorKey string, processors Processors) *Vars {
750+
v, err := NewVarsWithProcessors(id, mapping, processorKey, processors, nil)
741751
if err != nil {
742752
panic(err)
743753
}

‎internal/pkg/agent/transpiler/vars.go

+10-4
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,25 @@ var ErrNoMatch = fmt.Errorf("no matching vars")
2121

2222
// Vars is a context of variables that also contain a list of processors that go with the mapping.
2323
type Vars struct {
24+
id string
2425
tree *AST
2526
processorsKey string
2627
processors Processors
2728
fetchContextProviders mapstr.M
2829
}
2930

3031
// NewVars returns a new instance of vars.
31-
func NewVars(mapping map[string]interface{}, fetchContextProviders mapstr.M) (*Vars, error) {
32-
return NewVarsWithProcessors(mapping, "", nil, fetchContextProviders)
32+
func NewVars(id string, mapping map[string]interface{}, fetchContextProviders mapstr.M) (*Vars, error) {
33+
return NewVarsWithProcessors(id, mapping, "", nil, fetchContextProviders)
3334
}
3435

3536
// NewVarsWithProcessors returns a new instance of vars with attachment of processors.
36-
func NewVarsWithProcessors(mapping map[string]interface{}, processorKey string, processors Processors, fetchContextProviders mapstr.M) (*Vars, error) {
37+
func NewVarsWithProcessors(id string, mapping map[string]interface{}, processorKey string, processors Processors, fetchContextProviders mapstr.M) (*Vars, error) {
3738
tree, err := NewAST(mapping)
3839
if err != nil {
3940
return nil, err
4041
}
41-
return &Vars{tree, processorKey, processors, fetchContextProviders}, nil
42+
return &Vars{id, tree, processorKey, processors, fetchContextProviders}, nil
4243
}
4344

4445
// Replace returns a new value based on variable replacement.
@@ -91,6 +92,11 @@ func (v *Vars) Replace(value string) (Node, error) {
9192
return NewStrValWithProcessors(result+value[lastIndex:], processors), nil
9293
}
9394

95+
// ID returns the unique ID for the vars.
96+
func (v *Vars) ID() string {
97+
return v.id
98+
}
99+
94100
// Lookup returns the value from the vars.
95101
func (v *Vars) Lookup(name string) (interface{}, bool) {
96102
// lookup in the AST tree

‎internal/pkg/agent/transpiler/vars_test.go

+2
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,7 @@ func TestVars_ReplaceWithProcessors(t *testing.T) {
227227
},
228228
}
229229
vars, err := NewVarsWithProcessors(
230+
"",
230231
map[string]interface{}{
231232
"testing": map[string]interface{}{
232233
"key1": "data1",
@@ -293,6 +294,7 @@ func TestVars_ReplaceWithFetchContextProvider(t *testing.T) {
293294
"kubernetes_secrets": mockFetchProvider,
294295
}
295296
vars, err := NewVarsWithProcessors(
297+
"id",
296298
map[string]interface{}{
297299
"testing": map[string]interface{}{
298300
"key1": "data1",

‎internal/pkg/composable/controller.go

+7-4
Original file line numberDiff line numberDiff line change
@@ -193,15 +193,16 @@ func (c *controller) Run(ctx context.Context) error {
193193
mapping[name] = state.Current()
194194
}
195195
// this is ensured not to error, by how the mappings states are verified
196-
vars[0], _ = transpiler.NewVars(mapping, fetchContextProviders)
196+
vars[0], _ = transpiler.NewVars("", mapping, fetchContextProviders)
197197

198198
// add to the vars list for each dynamic providers mappings
199199
for name, state := range c.dynamicProviders {
200200
for _, mappings := range state.Mappings() {
201201
local, _ := cloneMap(mapping) // will not fail; already been successfully cloned once
202202
local[name] = mappings.mapping
203+
id := fmt.Sprintf("%s-%s", name, mappings.id)
203204
// this is ensured not to error, by how the mappings states are verified
204-
v, _ := transpiler.NewVarsWithProcessors(local, name, mappings.processors, fetchContextProviders)
205+
v, _ := transpiler.NewVarsWithProcessors(id, local, name, mappings.processors, fetchContextProviders)
205206
vars = append(vars, v)
206207
}
207208
}
@@ -237,7 +238,7 @@ func (c *contextProviderState) Set(mapping map[string]interface{}) error {
237238
return err
238239
}
239240
// ensure creating vars will not error
240-
_, err = transpiler.NewVars(mapping, nil)
241+
_, err = transpiler.NewVars("", mapping, nil)
241242
if err != nil {
242243
return err
243244
}
@@ -262,6 +263,7 @@ func (c *contextProviderState) Current() map[string]interface{} {
262263
}
263264

264265
type dynamicProviderMapping struct {
266+
id string
265267
priority int
266268
mapping map[string]interface{}
267269
processors transpiler.Processors
@@ -292,7 +294,7 @@ func (c *dynamicProviderState) AddOrUpdate(id string, priority int, mapping map[
292294
return err
293295
}
294296
// ensure creating vars will not error
295-
_, err = transpiler.NewVars(mapping, nil)
297+
_, err = transpiler.NewVars("", mapping, nil)
296298
if err != nil {
297299
return err
298300
}
@@ -305,6 +307,7 @@ func (c *dynamicProviderState) AddOrUpdate(id string, priority int, mapping map[
305307
return nil
306308
}
307309
c.mappings[id] = dynamicProviderMapping{
310+
id: id,
308311
priority: priority,
309312
mapping: mapping,
310313
processors: processors,

‎pkg/component/component.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ func (r *RuntimeSpecs) PolicyToComponents(policy map[string]interface{}) ([]Comp
145145
if err != nil {
146146
return nil, nil, err
147147
}
148-
vars, err := transpiler.NewVars(map[string]interface{}{
148+
vars, err := transpiler.NewVars("", map[string]interface{}{
149149
"runtime": map[string]interface{}{
150150
"platform": r.platform.String(),
151151
"os": r.platform.OS,

0 commit comments

Comments
 (0)