refactor: apply review suggestions, better error handling, better naming

internal/features/stacks/decoder/path_reader.go

@@ -45,7 +45,7 @@ func (pr *PathReader) PathContext(path lang.Path) (*decoder.PathContext, error)
 
 func stackPathContext(record *state.StackRecord) (*decoder.PathContext, error) {
 	// TODO: this should only work for terraform 1.8 and above
-	version := record.TerraformVersion
+	version := record.RequiredTerraformVersion
 	if version == nil {
 		version = stackschema.LatestAvailableVersion
 	}
@@ -75,7 +75,7 @@ func stackPathContext(record *state.StackRecord) (*decoder.PathContext, error) {
 
 func deployPathContext(record *state.StackRecord) (*decoder.PathContext, error) {
 	// TODO: this should only work for terraform 1.8 and above
-	version := record.TerraformVersion
+	version := record.RequiredTerraformVersion
 	if version == nil {
 		version = stackschema.LatestAvailableVersion
 	}

internal/features/stacks/events.go

@@ -60,7 +60,7 @@ func (f *StacksFeature) didOpen(ctx context.Context, dir document.DirHandle, lan
 		Func: func(ctx context.Context) error {
 			return jobs.LoadTerraformVersion(ctx, f.fs, f.store, path)
 		},
-		Type: operation.OpTypeLoadTerraformVersion.String(),
+		Type: operation.OpTypeLoadStackRequiredTerraformVersion.String(),
 	})
 	if err != nil {
 		return ids, err

internal/features/stacks/jobs/version.go

@@ -27,27 +27,36 @@ func LoadTerraformVersion(ctx context.Context, fs ReadOnlyFS, stackStore *state.
 	}
 
 	// Avoid parsing if it is already in progress or already known
-	if stackRecord.TerraformVersionState != operation.OpStateUnknown && !job.IgnoreState(ctx) {
+	if stackRecord.RequiredTerraformVersionState != operation.OpStateUnknown && !job.IgnoreState(ctx) {
 		return job.StateNotChangedErr{Dir: document.DirHandleFromPath(stackPath)}
 	}
 
-	stackStore.SetTerraformVersionState(stackPath, operation.OpStateLoading)
+	err = stackStore.SetTerraformVersionState(stackPath, operation.OpStateLoading)
+	if err != nil {
+		return err
+	}
 
 	// read version file
 	v, err := fs.ReadFile(filepath.Join(stackPath, ".terraform-version"))
 	if err != nil {
-		stackStore.SetTerraformVersionError(stackPath, err)
+		updateErr := stackStore.SetTerraformVersionError(stackPath, err)
+		if updateErr != nil {
+			return updateErr
+		}
+
 		return err
 	}
 
 	// parse version
 	version, err := version.NewVersion(strings.TrimSpace(string(v)))
 	if err != nil {
-		stackStore.SetTerraformVersionError(stackPath, err)
+		updateErr := stackStore.SetTerraformVersionError(stackPath, err)
+		if updateErr != nil {
+			return updateErr
+		}
+
 		return err
 	}
 
-	stackStore.SetTerraformVersion(stackPath, version)
-
-	return nil
+	return stackStore.SetTerraformVersion(stackPath, version)
 }

internal/features/stacks/jobs/version_test.go

@@ -51,16 +51,16 @@ func TestLoadTerraformVersion(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	if record.TerraformVersion.String() != "1.9.0" {
-		t.Fatalf("expected version 1.9.0, got %s", record.TerraformVersion.String())
+	if record.RequiredTerraformVersion.String() != "1.9.0" {
+		t.Fatalf("expected version 1.9.0, got %s", record.RequiredTerraformVersion.String())
 	}
 
-	if record.TerraformVersionState != operation.OpStateLoaded {
-		t.Fatalf("expected state %s, got %s", operation.OpStateLoaded, record.TerraformVersionState)
+	if record.RequiredTerraformVersionState != operation.OpStateLoaded {
+		t.Fatalf("expected state %s, got %s", operation.OpStateLoaded, record.RequiredTerraformVersionState)
 	}
 
-	if record.TerraformVersionErr != nil {
-		t.Fatalf("expected nil error, got %s", record.TerraformVersionErr)
+	if record.RequiredTerraformVersionErr != nil {
+		t.Fatalf("expected nil error, got %s", record.RequiredTerraformVersionErr)
 	}
 }
 
@@ -116,15 +116,15 @@ func TestLoadTerraformVersion_invalid(t *testing.T) {
 				t.Fatal(err)
 			}
 
-			if record.TerraformVersion != nil {
-				t.Fatalf("expected nil version, got %s", record.TerraformVersion.String())
+			if record.RequiredTerraformVersion != nil {
+				t.Fatalf("expected nil version, got %s", record.RequiredTerraformVersion.String())
 			}
 
-			if record.TerraformVersionState != operation.OpStateLoaded {
-				t.Fatalf("expected state %s, got %s", operation.OpStateLoaded, record.TerraformVersionState)
+			if record.RequiredTerraformVersionState != operation.OpStateLoaded {
+				t.Fatalf("expected state %s, got %s", operation.OpStateLoaded, record.RequiredTerraformVersionState)
 			}
 
-			if record.TerraformVersionErr == nil {
+			if record.RequiredTerraformVersionErr == nil {
 				t.Fatal("expected error in record, got nil")
 			}
 		})

internal/features/stacks/state/stack_record.go

@@ -25,9 +25,9 @@ type StackRecord struct {
 	Diagnostics      ast.SourceDiagnostics
 	DiagnosticsState globalAst.DiagnosticSourceState
 
-	TerraformVersion      *version.Version
-	TerraformVersionErr   error
-	TerraformVersionState operation.OpState
+	RequiredTerraformVersion      *version.Version
+	RequiredTerraformVersionErr   error
+	RequiredTerraformVersionState operation.OpState
 }
 
 func (m *StackRecord) Path() string {

internal/features/stacks/state/stack_store.go

@@ -213,9 +213,9 @@ func (s *StackStore) setTerraformVersionWithChangeNotification(path string, vers
 	}
 	stack := oldStack.Copy()
 
-	stack.TerraformVersion = version
-	stack.TerraformVersionErr = vErr
-	stack.TerraformVersionState = state
+	stack.RequiredTerraformVersion = version
+	stack.RequiredTerraformVersionErr = vErr
+	stack.RequiredTerraformVersionState = state
 
 	err = txn.Insert(s.tableName, stack)
 	if err != nil {
@@ -248,7 +248,7 @@ func (s *StackStore) SetTerraformVersionState(path string, state operation.OpSta
 		return err
 	}
 
-	stack.TerraformVersionState = state
+	stack.RequiredTerraformVersionState = state
 	err = txn.Insert(s.tableName, stack)
 	if err != nil {
 		return err
@@ -312,19 +312,19 @@ func (s *StackStore) queueRecordChange(oldRecord, newRecord *StackRecord) error
 	switch {
 	// new record added
 	case oldRecord == nil && newRecord != nil:
-		if newRecord.TerraformVersion != nil {
+		if newRecord.RequiredTerraformVersion != nil {
 			changes.TerraformVersion = true
 		}
 	// record removed
 	case oldRecord != nil && newRecord == nil:
 		changes.IsRemoval = true
 
-		if oldRecord.TerraformVersion != nil {
+		if oldRecord.RequiredTerraformVersion != nil {
 			changes.TerraformVersion = true
 		}
 	// record changed
 	default:
-		if oldRecord.TerraformVersion == nil || !oldRecord.TerraformVersion.Equal(newRecord.TerraformVersion) {
+		if !oldRecord.RequiredTerraformVersion.Equal(newRecord.RequiredTerraformVersion) {
 			changes.TerraformVersion = true
 		}
 	}

internal/terraform/module/operation/operation.go

@@ -36,5 +36,5 @@ const (
 	OpTypeReferenceValidation
 	OpTypeTerraformValidate
 	OpTypeParseStackConfiguration
-	OpTypeLoadTerraformVersion
+	OpTypeLoadStackRequiredTerraformVersion
 )