Removing function argument from diagnostics

hashicorp · Feb 21, 2024 · 1819845 · 1819845
1 parent 76e98fe
commit 1819845
Show file tree

Hide file tree

Showing 13 changed files with 1,254 additions and 1,329 deletions.
diff --git a/internal/logging/keys.go b/internal/logging/keys.go
@@ -11,9 +11,6 @@ const (
 	// Attribute of the diagnostic being logged.
 	KeyDiagnosticAttribute = "diagnostic_attribute"
 
-	// Function Argument of the diagnostic being logged.
-	KeyDiagnosticFunctionArgument = "diagnostic_function_argument"
-
 	// Number of the error diagnostics.
 	KeyDiagnosticErrorCount = "diagnostic_error_count"
 

diff --git a/tfprotov5/diagnostic.go b/tfprotov5/diagnostic.go
@@ -42,10 +42,6 @@ type Diagnostic struct {
 	// indicate that the problem is with a certain field in the resource,
 	// which helps users find the source of the problem.
 	Attribute *tftypes.AttributePath
-
-	// FunctionArgument is the positional function argument for aligning
-	// configuration source.
-	FunctionArgument *int64
 }
 
 // DiagnosticSeverity represents different classes of Diagnostic which affect

diff --git a/tfprotov5/internal/diag/diagnostics.go b/tfprotov5/internal/diag/diagnostics.go
@@ -53,10 +53,6 @@ func (d Diagnostics) Log(ctx context.Context) {
 			diagnosticFields[logging.KeyDiagnosticAttribute] = diagnostic.Attribute.String()
 		}
 
-		if diagnostic.FunctionArgument != nil {
-			diagnosticFields[logging.KeyDiagnosticFunctionArgument] = *diagnostic.FunctionArgument
-		}
-
 		switch diagnostic.Severity {
 		case tfprotov5.DiagnosticSeverityError:
 			logging.ProtocolError(ctx, "Response contains error diagnostic", diagnosticFields)

diff --git a/tfprotov5/internal/tfplugin5/tfplugin5.pb.go b/tfprotov5/internal/tfplugin5/tfplugin5.pb.go
diff --git a/tfprotov5/internal/tfplugin5/tfplugin5.proto b/tfprotov5/internal/tfplugin5/tfplugin5.proto
@@ -41,10 +41,6 @@ message Diagnostic {
     string summary = 2;
     string detail = 3;
     AttributePath attribute = 4;
-
-    // function_argument is the positional function argument for aligning
-    // configuration source.
-    optional int64 function_argument = 5;
 }
 
 message FunctionError {

diff --git a/tfprotov5/internal/toproto/diagnostic.go b/tfprotov5/internal/toproto/diagnostic.go
@@ -16,11 +16,10 @@ func Diagnostic(in *tfprotov5.Diagnostic) *tfplugin5.Diagnostic {
 	}
 
 	resp := &tfplugin5.Diagnostic{
-		Attribute:        AttributePath(in.Attribute),
-		Detail:           ForceValidUTF8(in.Detail),
-		FunctionArgument: in.FunctionArgument,
-		Severity:         Diagnostic_Severity(in.Severity),
-		Summary:          ForceValidUTF8(in.Summary),
+		Attribute: AttributePath(in.Attribute),
+		Detail:    ForceValidUTF8(in.Detail),
+		Severity:  Diagnostic_Severity(in.Severity),
+		Summary:   ForceValidUTF8(in.Summary),
 	}
 
 	return resp

diff --git a/tfprotov5/internal/toproto/diagnostic_test.go b/tfprotov5/internal/toproto/diagnostic_test.go
@@ -8,6 +8,7 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
+
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5/internal/tfplugin5"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5/internal/toproto"
@@ -71,15 +72,6 @@ func TestDiagnostic(t *testing.T) {
 				Severity: tfplugin5.Diagnostic_INVALID,
 			},
 		},
-		"FunctionArgument": {
-			in: &tfprotov5.Diagnostic{
-				FunctionArgument: pointer(int64(123)),
-			},
-			expected: &tfplugin5.Diagnostic{
-				FunctionArgument: pointer(int64(123)),
-				Severity:         tfplugin5.Diagnostic_INVALID,
-			},
-		},
 		"Severity": {
 			in: &tfprotov5.Diagnostic{
 				Severity: tfprotov5.DiagnosticSeverityError,

diff --git a/tfprotov6/diagnostic.go b/tfprotov6/diagnostic.go
@@ -42,10 +42,6 @@ type Diagnostic struct {
 	// indicate that the problem is with a certain field in the resource,
 	// which helps users find the source of the problem.
 	Attribute *tftypes.AttributePath
-
-	// FunctionArgument is the positional function argument for aligning
-	// configuration source.
-	FunctionArgument *int64
 }
 
 // DiagnosticSeverity represents different classes of Diagnostic which affect

diff --git a/tfprotov6/internal/diag/diagnostics.go b/tfprotov6/internal/diag/diagnostics.go
@@ -53,10 +53,6 @@ func (d Diagnostics) Log(ctx context.Context) {
 			diagnosticFields[logging.KeyDiagnosticAttribute] = diagnostic.Attribute.String()
 		}
 
-		if diagnostic.FunctionArgument != nil {
-			diagnosticFields[logging.KeyDiagnosticFunctionArgument] = *diagnostic.FunctionArgument
-		}
-
 		switch diagnostic.Severity {
 		case tfprotov6.DiagnosticSeverityError:
 			logging.ProtocolError(ctx, "Response contains error diagnostic", diagnosticFields)

diff --git a/tfprotov6/internal/tfplugin6/tfplugin6.pb.go b/tfprotov6/internal/tfplugin6/tfplugin6.pb.go
diff --git a/tfprotov6/internal/tfplugin6/tfplugin6.proto b/tfprotov6/internal/tfplugin6/tfplugin6.proto
@@ -41,10 +41,6 @@ message Diagnostic {
     string summary = 2;
     string detail = 3;
     AttributePath attribute = 4;
-
-    // function_argument is the positional function argument for aligning
-    // configuration source.
-    optional int64 function_argument = 5;
 }
 
 message FunctionError {

diff --git a/tfprotov6/internal/toproto/diagnostic.go b/tfprotov6/internal/toproto/diagnostic.go
@@ -16,11 +16,10 @@ func Diagnostic(in *tfprotov6.Diagnostic) *tfplugin6.Diagnostic {
 	}
 
 	resp := &tfplugin6.Diagnostic{
-		Attribute:        AttributePath(in.Attribute),
-		Detail:           ForceValidUTF8(in.Detail),
-		FunctionArgument: in.FunctionArgument,
-		Severity:         Diagnostic_Severity(in.Severity),
-		Summary:          ForceValidUTF8(in.Summary),
+		Attribute: AttributePath(in.Attribute),
+		Detail:    ForceValidUTF8(in.Detail),
+		Severity:  Diagnostic_Severity(in.Severity),
+		Summary:   ForceValidUTF8(in.Summary),
 	}
 
 	return resp

diff --git a/tfprotov6/internal/toproto/diagnostic_test.go b/tfprotov6/internal/toproto/diagnostic_test.go
@@ -8,6 +8,7 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
+
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6/internal/tfplugin6"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6/internal/toproto"
@@ -71,15 +72,6 @@ func TestDiagnostic(t *testing.T) {
 				Severity: tfplugin6.Diagnostic_INVALID,
 			},
 		},
-		"FunctionArgument": {
-			in: &tfprotov6.Diagnostic{
-				FunctionArgument: pointer(int64(123)),
-			},
-			expected: &tfplugin6.Diagnostic{
-				FunctionArgument: pointer(int64(123)),
-				Severity:         tfplugin6.Diagnostic_INVALID,
-			},
-		},
 		"Severity": {
 			in: &tfprotov6.Diagnostic{
 				Severity: tfprotov6.DiagnosticSeverityError,