Skip to content

stacks: emit state updates for unclaimed components #36702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 2, 2025
Merged

stacks: emit state updates for unclaimed components #36702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b594089
stacks: allow multiple removed blocks to target the same component
liamcervante Mar 13, 2025
cfcc999
make linter happy
liamcervante Mar 13, 2025
7442773
stacks: emit state updates for unclaimed components
liamcervante Mar 14, 2025
85359ab
Merge branch 'main' of github.com:hashicorp/terraform into liamcervan…
liamcervante Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions internal/stacks/stackruntime/apply_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1891,6 +1891,57 @@ After applying this plan, Terraform will no longer manage these objects. You wil
},
},
},
"unknown-component": {
path: path.Join("with-single-input", "removed-component-instance"),
state: stackstate.NewStateBuilder().
AddComponentInstance(stackstate.NewComponentInstanceBuilder(mustAbsComponentInstance("component.self[\"main\"]")).
AddInputVariable("id", cty.StringVal("main")).
AddInputVariable("input", cty.StringVal("main"))).
AddResourceInstance(stackstate.NewResourceInstanceBuilder().
SetAddr(mustAbsResourceInstanceObject("component.self[\"main\"].testing_resource.data")).
SetProviderAddr(mustDefaultRootProvider("testing")).
SetResourceInstanceObjectSrc(states.ResourceInstanceObjectSrc{
Status: states.ObjectReady,
AttrsJSON: mustMarshalJSONAttrs(map[string]any{
"id": "main",
"value": "main",
}),
})).
Build(),
store: stacks_testing_provider.NewResourceStoreBuilder().
AddResource("main", cty.ObjectVal(map[string]cty.Value{
"id": cty.StringVal("main"),
"value": cty.StringVal("main"),
})).
Build(),
cycles: []TestCycle{
{
planInputs: map[string]cty.Value{
"input": cty.UnknownVal(cty.Set(cty.String)),
"removed": cty.SetValEmpty(cty.String),
},
wantAppliedChanges: []stackstate.AppliedChange{
&stackstate.AppliedChangeComponentInstance{
ComponentAddr: mustAbsComponent("component.self"),
ComponentInstanceAddr: mustAbsComponentInstance("component.self[\"main\"]"),
OutputValues: make(map[addrs.OutputValue]cty.Value),
InputVariables: map[addrs.InputVariable]cty.Value{
mustInputVariable("id"): cty.StringVal("main"),
mustInputVariable("input"): cty.StringVal("main"),
},
},
&stackstate.AppliedChangeInputVariable{
Addr: mustStackInputVariable("input"),
Value: cty.UnknownVal(cty.Set(cty.String)),
},
&stackstate.AppliedChangeInputVariable{
Addr: mustStackInputVariable("removed"),
Value: cty.SetValEmpty(cty.String),
},
},
},
},
},
}

for name, tc := range tcs {
Expand Down
104 changes: 57 additions & 47 deletions internal/stacks/stackruntime/internal/stackeval/main_apply.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"go.opentelemetry.io/otel/trace"
"google.golang.org/protobuf/types/known/anypb"

"github.com/hashicorp/terraform/internal/addrs"
"github.com/hashicorp/terraform/internal/collections"
"github.com/hashicorp/terraform/internal/plans"
"github.com/hashicorp/terraform/internal/promising"
Expand Down Expand Up @@ -99,72 +100,53 @@ func ApplyPlan(ctx context.Context, config *stackconfig.Config, plan *stackplan.

var inst ApplyableComponentInstance

if removed != nil {
Blocks:
for _, block := range removed {
if insts, unknown, _ := block.Instances(ctx, ApplyPhase); unknown {
// It might be that either the removed block
// or component block was deferred but the
// other one had proper changes. We'll note
// this in the logs but just skip processing
// it.
log.Printf("[TRACE]: %s has planned changes, but was unknown. Check further messages to find out if this was an error.", addr)
} else {
for _, i := range insts {
if i.from.Item.Key == addr.Item.Key {
inst = i
break Blocks
}
matchedUnknownBlock := false

Blocks:
for _, block := range removed {
if insts, unknown, _ := block.Instances(ctx, ApplyPhase); unknown {
matchedUnknownBlock = true
} else {
for _, i := range insts {
if i.from.Item.Key == addr.Item.Key {
inst = i
break Blocks
}
}
}
if inst == nil {
// Again, this might be okay if the component
// block was deferred but the removed block had
// proper changes (or vice versa). We'll note
// this in the logs but just skip processing it.
log.Printf("[TRACE]: %s has planned changes, but does not seem to be declared. Check further messages to find out if this was an error.", addr)
}
}

if component != nil {
if insts, unknown := component.Instances(ctx, ApplyPhase); unknown {
// It might be that either the removed block
// or component block was deferred but the
// other one had proper changes. We'll note
// this in the logs but just skip processing
// it.
log.Printf("[TRACE]: %s has planned changes, but was unknown. Check further messages to find out if this was an error.", addr)
matchedUnknownBlock = true
} else {
if i, ok := insts[addr.Item.Key]; !ok {
// Again, this might be okay if the component
// block was deferred but the removed block had
// proper changes (or vice versa). We'll note
// this in the logs but just skip processing it.
log.Printf("[TRACE]: %s has planned changes, but does not seem to be declared. Check further messages to find out if this was an error.", addr)
} else {
if i, ok := insts[addr.Item.Key]; ok {
if inst != nil {
// Problem! We have both a removed block and
// a component instance that point to the same
// address. This should not happen. The plan
// should have caught this and resulted in an
// unapplyable plan.
var diags tfdiags.Diagnostics
diags = diags.Append(tfdiags.Sourceless(
tfdiags.Error,
"Invalid component instance",
fmt.Sprintf("There was a plan for %s, which matched both removed and component blocks.", addr),
))
log.Printf("[ERROR] stackeval: %s has both a component and a removed block that point to the same address", addr)
span.SetStatus(codes.Error, "both component and removed block present")
return nil, nil
return nil, diags
}
inst = i
}
}
}

if inst == nil {
// Then we have a problem. We have a component
// that has planned changes but no instance to
// apply them to. This should not happen.
if inst == nil && !matchedUnknownBlock {
var diags tfdiags.Diagnostics
diags = diags.Append(tfdiags.Sourceless(
tfdiags.Error,
"Invalid component instance",
fmt.Sprintf("There was a plan for %s, which matched no known component instances.", addr),
))
log.Printf("[ERROR] stackeval: %s has planned changes, but no instance to apply them to", addr)
span.SetStatus(codes.Error, "no instance to apply changes to")
return nil, nil
return nil, diags
}

modulesRuntimePlan, err := componentInstPlan.ForModulesRuntime()
Expand All @@ -186,6 +168,34 @@ func ApplyPlan(ctx context.Context, config *stackconfig.Config, plan *stackplan.
return nil, diags
}

if matchedUnknownBlock && inst == nil {
log.Printf("[TRACE] stackeval: %s matched an unknown block so returning prior state unchanged.", addr)
span.SetStatus(codes.Ok, "apply unknown")

for _, step := range addr.Stack {
if step.Key == addrs.WildcardKey {
// for instances that were unknown we don't
// emit any updates for them.
return nil, nil
}
}
if addr.Item.Key == addrs.WildcardKey {
// for instances that were unknown we don't
// emit any updates for them.
return nil, nil
}

// if we get here, then this was a concrete instance
// that was in state before the original plan, we
// do want to emit a "nothing changed" update for
// this instance.

return &ComponentInstanceApplyResult{
FinalState: modulesRuntimePlan.PrevRunState,
Complete: false,
}, nil
}

var waitForComponents collections.Set[stackaddrs.AbsComponent]
var waitForRemoveds collections.Set[stackaddrs.AbsComponent]
if action == plans.Delete || action == plans.Forget {
Expand Down