mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-19 17:59:05 -05:00
75c7834ca6
Most of our transformers are pure compute and so don't really have a strong need to generate trace spans under our current focus of only exposing user-facing concepts and external requests in our traces, but unfortunately some of them indirectly depend on provider schema, which in turn means that they can potentially be unlucky enough to be the trigger for making all of the provider requests needed to fill the schema cache and therefore would end up with provider request spans being reported beneath them. As usual with these interface updates, this initial change focuses only on changing the interface and updating its direct callers and implementers to match, without any further refactoring or attempts to plumb contexts to or from other functions that don't have them yet. That means there are a few new context.TODO() calls here that we'll tidy up in a later commit that hopefully won't involve all of the noise that is caused by changing an interface API. Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
75 lines
2.0 KiB
Go
75 lines
2.0 KiB
Go
// Copyright (c) The OpenTofu Authors
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
// Copyright (c) 2023 HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package tofu
|
|
|
|
import (
|
|
"context"
|
|
"log"
|
|
|
|
"github.com/opentofu/opentofu/internal/addrs"
|
|
"github.com/opentofu/opentofu/internal/logging"
|
|
"github.com/opentofu/opentofu/internal/tfdiags"
|
|
)
|
|
|
|
// GraphBuilder is an interface that can be implemented and used with
|
|
// OpenTofu to build the graph that OpenTofu walks.
|
|
type GraphBuilder interface {
|
|
// Build builds the graph for the given module path. It is up to
|
|
// the interface implementation whether this build should expand
|
|
// the graph or not.
|
|
Build(context.Context, addrs.ModuleInstance) (*Graph, tfdiags.Diagnostics)
|
|
}
|
|
|
|
// BasicGraphBuilder is a GraphBuilder that builds a graph out of a
|
|
// series of transforms and (optionally) validates the graph is a valid
|
|
// structure.
|
|
type BasicGraphBuilder struct {
|
|
Steps []GraphTransformer
|
|
// Optional name to add to the graph debug log
|
|
Name string
|
|
}
|
|
|
|
func (b *BasicGraphBuilder) Build(ctx context.Context, path addrs.ModuleInstance) (*Graph, tfdiags.Diagnostics) {
|
|
var diags tfdiags.Diagnostics
|
|
g := &Graph{Path: path}
|
|
|
|
var lastStepStr string
|
|
for _, step := range b.Steps {
|
|
if step == nil {
|
|
continue
|
|
}
|
|
log.Printf("[TRACE] Executing graph transform %T", step)
|
|
|
|
err := step.Transform(ctx, g)
|
|
|
|
if logging.IsDebugOrHigher() {
|
|
if thisStepStr := g.StringWithNodeTypes(); thisStepStr != lastStepStr {
|
|
log.Printf("[TRACE] Completed graph transform %T with new graph:\n%s ------", step, logging.Indent(thisStepStr))
|
|
lastStepStr = thisStepStr
|
|
} else {
|
|
log.Printf("[TRACE] Completed graph transform %T (no changes)", step)
|
|
}
|
|
}
|
|
|
|
if err != nil {
|
|
if nf, isNF := err.(tfdiags.NonFatalError); isNF {
|
|
diags = diags.Append(nf.Diagnostics)
|
|
} else {
|
|
diags = diags.Append(err)
|
|
return g, diags
|
|
}
|
|
}
|
|
}
|
|
|
|
if err := g.Validate(); err != nil {
|
|
log.Printf("[ERROR] Graph validation failed. Graph:\n\n%s", g.String())
|
|
diags = diags.Append(err)
|
|
return nil, diags
|
|
}
|
|
|
|
return g, diags
|
|
}
|