// Copyright (c) HashiCorp, Inc. // SPDX-License-Identifier: BUSL-1.1 package stackstate import ( "google.golang.org/protobuf/types/known/anypb" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/collections" "github.com/hashicorp/terraform/internal/stacks/stackaddrs" "github.com/hashicorp/terraform/internal/stacks/stackstate/statekeys" "github.com/hashicorp/terraform/internal/states" ) // State represents a previous run's state snapshot. // // Unlike [states.State] and its associates, State is an immutable data // structure constructed to represent only the previous run state. It should // not be modified after it's been constructed; results of planning or applying // changes are represented in other ways inside the stacks language runtime. type State struct { componentInstances collections.Map[stackaddrs.AbsComponentInstance, *componentInstanceState] // discardUnsupportedKeys is the set of state keys that we encountered // during decoding which are of types that are not supported by this // version of Terraform, if and only if they are of a type which is // specified as being discarded when unrecognized. We should emit // events during the apply phase to delete the objects associated with // these keys. discardUnsupportedKeys collections.Set[statekeys.Key] inputRaw map[string]*anypb.Any } // NewState constructs a new, empty state. func NewState() *State { return &State{ componentInstances: collections.NewMap[stackaddrs.AbsComponentInstance, *componentInstanceState](), discardUnsupportedKeys: statekeys.NewKeySet(), inputRaw: nil, } } func (s *State) HasComponentInstance(addr stackaddrs.AbsComponentInstance) bool { return s.componentInstances.HasKey(addr) } // AllComponentInstances returns a set of addresses for all of the component // instances that are tracked in the state. // // This includes both instances that were explicitly represented in the source // raw state _and_ any that were missing but implied by a resource instance // existing inside them. There should typically be an explicit component // instance record tracked in raw state, but it can potentially be absent in // exceptional cases such as if Terraform Core crashed partway through the // previous run. func (s *State) AllComponentInstances() collections.Set[stackaddrs.AbsComponentInstance] { var ret collections.Set[stackaddrs.AbsComponentInstance] if s.componentInstances.Len() == 0 { return ret } ret = collections.NewSet[stackaddrs.AbsComponentInstance]() for _, elem := range s.componentInstances.Elems() { ret.Add(elem.K) } return ret } func (s *State) componentInstanceState(addr stackaddrs.AbsComponentInstance) *componentInstanceState { return s.componentInstances.Get(addr) } // ComponentInstanceResourceInstanceObjects returns a set of addresses for // all of the resource instance objects belonging to the component instance // with the given address. func (s *State) ComponentInstanceResourceInstanceObjects(addr stackaddrs.AbsComponentInstance) collections.Set[stackaddrs.AbsResourceInstanceObject] { var ret collections.Set[stackaddrs.AbsResourceInstanceObject] cs, ok := s.componentInstances.GetOk(addr) if !ok { return ret } ret = collections.NewSet[stackaddrs.AbsResourceInstanceObject]() for _, elem := range cs.resourceInstanceObjects.Elems { objKey := stackaddrs.AbsResourceInstanceObject{ Component: addr, Item: elem.Key, } ret.Add(objKey) } return ret } // AllResourceInstanceObjects returns a set of addresses for all of the resource // instance objects that are tracked in the state, across all components. func (s *State) AllResourceInstanceObjects() collections.Set[stackaddrs.AbsResourceInstanceObject] { ret := collections.NewSet[stackaddrs.AbsResourceInstanceObject]() for _, elem := range s.componentInstances.Elems() { componentAddr := elem.K for _, elem := range elem.V.resourceInstanceObjects.Elems { objKey := stackaddrs.AbsResourceInstanceObject{ Component: componentAddr, Item: elem.Key, } ret.Add(objKey) } } return ret } // ResourceInstanceObjectSrc returns the source (i.e. still encoded) version of // the resource instance object for the given address, or nil if no such // object is tracked in the state. func (s *State) ResourceInstanceObjectSrc(addr stackaddrs.AbsResourceInstanceObject) *states.ResourceInstanceObjectSrc { rios := s.resourceInstanceObjectState(addr) if rios == nil { return nil } return rios.src } // RequiredProviderInstances returns a description of all of the provider // instance slots that are required to satisfy the resource instances // belonging to the given component instance. // // See also stackeval.ComponentConfig.RequiredProviderInstances for a similar // function that operates on the configuration of a component instance rather // than the state of one. func (s *State) RequiredProviderInstances(component stackaddrs.AbsComponentInstance) addrs.Set[addrs.RootProviderConfig] { state, ok := s.componentInstances.GetOk(component) if !ok { // Then we have no state for this component, which is fine. return addrs.MakeSet[addrs.RootProviderConfig]() } providerInstances := addrs.MakeSet[addrs.RootProviderConfig]() for _, elem := range state.resourceInstanceObjects.Elems { providerInstances.Add(addrs.RootProviderConfig{ Provider: elem.Value.providerConfigAddr.Provider, Alias: elem.Value.providerConfigAddr.Alias, }) } return providerInstances } func (s *State) resourceInstanceObjectState(addr stackaddrs.AbsResourceInstanceObject) *resourceInstanceObjectState { cs, ok := s.componentInstances.GetOk(addr.Component) if !ok { return nil } return cs.resourceInstanceObjects.Get(addr.Item) } // ComponentInstanceStateForModulesRuntime returns a [states.State] // representation of the objects tracked for the given component instance. // // This produces only a very bare-bones [states.State] that should be // sufficient for use as a prior state for the modules runtime's plan function // to consider, but likely won't be of much other use. func (s *State) ComponentInstanceStateForModulesRuntime(addr stackaddrs.AbsComponentInstance) *states.State { return states.BuildState(func(ss *states.SyncState) { objAddrs := s.ComponentInstanceResourceInstanceObjects(addr) for _, objAddr := range objAddrs.Elems() { rios := s.resourceInstanceObjectState(objAddr) if objAddr.Item.IsCurrent() { ss.SetResourceInstanceCurrent( objAddr.Item.ResourceInstance, rios.src, rios.providerConfigAddr, ) } else { ss.SetResourceInstanceDeposed( objAddr.Item.ResourceInstance, objAddr.Item.DeposedKey, rios.src, rios.providerConfigAddr, ) } } }) } // RawKeysToDiscard returns a set of raw state keys that the apply phase should // emit "delete" events for to remove objects from the raw state map that // will no longer be relevant or meaningful after this plan is applied. // // Do not modify the returned set. func (s *State) RawKeysToDiscard() collections.Set[statekeys.Key] { return s.discardUnsupportedKeys } // InputRaw returns the raw representation of state that this object was built // from, or nil if this object wasn't constructed by decoding a protocol buffers // representation. // // All callers of this method get the same map, so callers must not modify // the map or anything reachable through it. func (s *State) InputRaw() map[string]*anypb.Any { return s.inputRaw } func (s *State) ensureComponentInstanceState(addr stackaddrs.AbsComponentInstance) *componentInstanceState { if existing, ok := s.componentInstances.GetOk(addr); ok { return existing } s.componentInstances.Put(addr, &componentInstanceState{ resourceInstanceObjects: addrs.MakeMap[addrs.AbsResourceInstanceObject, *resourceInstanceObjectState](), }) return s.componentInstances.Get(addr) } func (s *State) addResourceInstanceObject(addr stackaddrs.AbsResourceInstanceObject, src *states.ResourceInstanceObjectSrc, providerConfigAddr addrs.AbsProviderConfig) { cs := s.ensureComponentInstanceState(addr.Component) cs.resourceInstanceObjects.Put(addr.Item, &resourceInstanceObjectState{ src: src, providerConfigAddr: providerConfigAddr, }) } type componentInstanceState struct { resourceInstanceObjects addrs.Map[addrs.AbsResourceInstanceObject, *resourceInstanceObjectState] } type resourceInstanceObjectState struct { src *states.ResourceInstanceObjectSrc providerConfigAddr addrs.AbsProviderConfig }