Skip to content
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

Jump to bottom

OTEL: Instrument PreloadEmbeddedSchema job #1334

Merged
merged 1 commit into from
Aug 1, 2023
Merged

OTEL: Instrument PreloadEmbeddedSchema job #1334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
172 changes: 115 additions & 57 deletions internal/terraform/module/module_ops.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,14 @@ import (
tfschema "github.com/hashicorp/terraform-schema/schema"
"github.com/zclconf/go-cty/cty"
ctyjson "github.com/zclconf/go-cty/cty/json"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
"go.opentelemetry.io/otel/trace"
)

const tracerName = "github.com/hashicorp/terraform-ls/internal/terraform/module"

type DeferFunc func(opError error)

type ModuleOperation struct {
Expand Down Expand Up @@ -223,72 +229,124 @@ func PreloadEmbeddedSchema(ctx context.Context, logger *log.Logger, fs fs.ReadDi
}

for pAddr := range missingReqs {
startTime := time.Now()

if pAddr.IsLegacy() && pAddr.Type == "terraform" {
// The terraform provider is built into Terraform 0.11+
// and while it's possible, users typically don't declare
// entry in required_providers block for it.
pAddr = tfaddr.NewProvider(tfaddr.BuiltInProviderHost, tfaddr.BuiltInProviderNamespace, "terraform")
} else if pAddr.IsLegacy() {
// Since we use recent version of Terraform to generate
// embedded schemas, these will never contain legacy
// addresses.
//
// A legacy namespace may come from missing
// required_providers entry & implied requirement
// from the provider block or 0.12-style entry,
// such as { grafana = "1.0" }.
//
// Implying "hashicorp" namespace here mimics behaviour
// of all recent (0.14+) Terraform versions.
originalAddr := pAddr
pAddr.Namespace = "hashicorp"
logger.Printf("preloading schema for %s (implying %s)",
originalAddr.ForDisplay(), pAddr.ForDisplay())
}

pSchemaFile, err := schemas.FindProviderSchemaFile(fs, pAddr)
err := preloadSchemaForProviderAddr(ctx, pAddr, fs, schemaStore, logger)
if err != nil {
if errors.Is(err, schemas.SchemaNotAvailable{Addr: pAddr}) {
logger.Printf("preloaded schema not available for %s", pAddr)
continue
}
return err
}
}

b, err := io.ReadAll(pSchemaFile.File)
if err != nil {
return err
}
return nil
}

jsonSchemas := tfjson.ProviderSchemas{}
err = json.Unmarshal(b, &jsonSchemas)
if err != nil {
return err
}
ps, ok := jsonSchemas.Schemas[pAddr.String()]
if !ok {
return fmt.Errorf("%q: no schema found in file", pAddr)
func preloadSchemaForProviderAddr(ctx context.Context, pAddr tfaddr.Provider, fs fs.ReadDirFS,
schemaStore *state.ProviderSchemaStore, logger *log.Logger) error {

startTime := time.Now()

if pAddr.IsLegacy() && pAddr.Type == "terraform" {
// The terraform provider is built into Terraform 0.11+
// and while it's possible, users typically don't declare
// entry in required_providers block for it.
pAddr = tfaddr.NewProvider(tfaddr.BuiltInProviderHost, tfaddr.BuiltInProviderNamespace, "terraform")
} else if pAddr.IsLegacy() {
// Since we use recent version of Terraform to generate
// embedded schemas, these will never contain legacy
// addresses.
//
// A legacy namespace may come from missing
// required_providers entry & implied requirement
// from the provider block or 0.12-style entry,
// such as { grafana = "1.0" }.
//
// Implying "hashicorp" namespace here mimics behaviour
// of all recent (0.14+) Terraform versions.
originalAddr := pAddr
pAddr.Namespace = "hashicorp"
logger.Printf("preloading schema for %s (implying %s)",
originalAddr.ForDisplay(), pAddr.ForDisplay())
}

ctx, rootSpan := otel.Tracer(tracerName).Start(ctx, "preloadProviderSchema",
trace.WithAttributes(attribute.KeyValue{
Key: attribute.Key("ProviderAddress"),
Value: attribute.StringValue(pAddr.String()),
}))
defer rootSpan.End()

pSchemaFile, err := schemas.FindProviderSchemaFile(fs, pAddr)
if err != nil {
rootSpan.RecordError(err)
rootSpan.SetStatus(codes.Error, "schema file not found")
if errors.Is(err, schemas.SchemaNotAvailable{Addr: pAddr}) {
logger.Printf("preloaded schema not available for %s", pAddr)
return nil
}
return err
}

pSchema := tfschema.ProviderSchemaFromJson(ps, pAddr)
pSchema.SetProviderVersion(pAddr, pSchemaFile.Version)
err = schemaStore.AddPreloadedSchema(pAddr, pSchemaFile.Version, pSchema)
if err != nil {
existsError := &state.AlreadyExistsError{}
if errors.As(err, &existsError) {
// This accounts for a possible race condition
// where we may be preloading the same schema
// for different providers at the same time
logger.Printf("schema for %s is already loaded", pAddr)
continue
}
return err
_, span := otel.Tracer(tracerName).Start(ctx, "readProviderSchemaFile",
trace.WithAttributes(attribute.KeyValue{
Key: attribute.Key("ProviderAddress"),
Value: attribute.StringValue(pAddr.String()),
}))
b, err := io.ReadAll(pSchemaFile.File)
if err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, "schema file not readable")
return err
}
span.SetStatus(codes.Ok, "schema file read successfully")
span.End()

_, span = otel.Tracer(tracerName).Start(ctx, "decodeProviderSchemaData",
trace.WithAttributes(attribute.KeyValue{
Key: attribute.Key("ProviderAddress"),
Value: attribute.StringValue(pAddr.String()),
}))
jsonSchemas := tfjson.ProviderSchemas{}
err = json.Unmarshal(b, &jsonSchemas)
if err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, "schema file not decodable")
return err
}
span.SetStatus(codes.Ok, "schema data decoded successfully")
span.End()

ps, ok := jsonSchemas.Schemas[pAddr.String()]
if !ok {
return fmt.Errorf("%q: no schema found in file", pAddr)
}

pSchema := tfschema.ProviderSchemaFromJson(ps, pAddr)
pSchema.SetProviderVersion(pAddr, pSchemaFile.Version)

_, span = otel.Tracer(tracerName).Start(ctx, "loadProviderSchemaDataIntoMemDb",
trace.WithAttributes(attribute.KeyValue{
Key: attribute.Key("ProviderAddress"),
Value: attribute.StringValue(pAddr.String()),
}))
err = schemaStore.AddPreloadedSchema(pAddr, pSchemaFile.Version, pSchema)
if err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, "loading schema into mem-db failed")
span.End()
existsError := &state.AlreadyExistsError{}
if errors.As(err, &existsError) {
// This accounts for a possible race condition
// where we may be preloading the same schema
// for different providers at the same time
logger.Printf("schema for %s is already loaded", pAddr)
return nil
}
elapsedTime := time.Now().Sub(startTime)
logger.Printf("preloaded schema for %s %s in %s", pAddr, pSchemaFile.Version, elapsedTime)
return err
}
span.SetStatus(codes.Ok, "schema loaded successfully")
span.End()

elapsedTime := time.Now().Sub(startTime)
logger.Printf("preloaded schema for %s %s in %s", pAddr, pSchemaFile.Version, elapsedTime)
rootSpan.SetStatus(codes.Ok, "schema loaded successfully")

return nil
}
Expand Down