Updated AttributeInvalidElementTypeDiag with a more descriptive error message

Author: rainkwan

internal/fwschema/diagnostics.go

@@ -68,14 +68,15 @@ func AttributeDefaultTypeMismatchDiag(attributePath path.Path, expectedType attr
 // AttributeInvalidElementTypeDiag returns an error diagnostic to provider
 // developers about using non-primitive types in their Attribute
 // implementation. This is not allowed.
-func AttributeInvalidElementTypeDiag(attributePath path.Path) diag.Diagnostic {
+func AttributeInvalidElementTypeDiag(attributePath path.Path, actualType attr.Type) diag.Diagnostic {
 	// The diagnostic path is intentionally omitted as it is invalid in this
 	// context. Diagnostic paths are intended to be mapped to actual data,
 	// while this path information must be synthesized.
 	return diag.NewErrorDiagnostic(
 		"Invalid Attribute Implementation",
 		"When validating the schema, an implementation issue was found. "+
 			"This is always an issue with the provider and should be reported to the provider developers.\n\n"+
-			fmt.Sprintf("%q contains an Attribute type that is not allowed for Resource Identity. ", attributePath),
+			fmt.Sprintf("%q contains an Attribute of type %q that is not allowed for Lists in Resource Identity. ", attributePath, actualType)+
+			"Lists in Resource Identity may only have primitive element types such as Bool, Int, Float, Number and String.",
 	)
 }

resource/identityschema/list_attribute.go

@@ -168,6 +168,6 @@ func (a ListAttribute) ValidateImplementation(_ context.Context, req fwschema.Va
 	}
 
 	if a.CustomType == nil && !fwtype.IsAllowedPrimitiveType(a.ElementType) {
-		resp.Diagnostics.Append(fwschema.AttributeInvalidElementTypeDiag(req.Path))
+		resp.Diagnostics.Append(fwschema.AttributeInvalidElementTypeDiag(req.Path, a.ElementType))
 	}
 }

resource/identityschema/list_attribute_test.go

@@ -561,7 +561,8 @@ func TestListAttributeValidateImplementation(t *testing.T) {
 						"Invalid Attribute Implementation",
 						"When validating the schema, an implementation issue was found. "+
 							"This is always an issue with the provider and should be reported to the provider developers.\n\n"+
-							"\"test\" contains an Attribute type that is not allowed for Resource Identity. ",
+							"\"test\" contains an Attribute of type \"basetypes.DynamicType\" that is not allowed for Lists in Resource Identity. "+
+							"Lists in Resource Identity may only have primitive element types such as Bool, Int, Float, Number and String.",
 					),
 				},
 			},
@@ -581,7 +582,8 @@ func TestListAttributeValidateImplementation(t *testing.T) {
 						"Invalid Attribute Implementation",
 						"When validating the schema, an implementation issue was found. "+
 							"This is always an issue with the provider and should be reported to the provider developers.\n\n"+
-							"\"test\" contains an Attribute type that is not allowed for Resource Identity. ",
+							"\"test\" contains an Attribute of type \"types.ObjectType[]\" that is not allowed for Lists in Resource Identity. "+
+							"Lists in Resource Identity may only have primitive element types such as Bool, Int, Float, Number and String.",
 					),
 				},
 			},
@@ -601,7 +603,8 @@ func TestListAttributeValidateImplementation(t *testing.T) {
 						"Invalid Attribute Implementation",
 						"When validating the schema, an implementation issue was found. "+
 							"This is always an issue with the provider and should be reported to the provider developers.\n\n"+
-							"\"test\" contains an Attribute type that is not allowed for Resource Identity. ",
+							"\"test\" contains an Attribute of type \"types.MapType[!!! MISSING TYPE !!!]\" that is not allowed for Lists in Resource Identity. "+
+							"Lists in Resource Identity may only have primitive element types such as Bool, Int, Float, Number and String.",
 					),
 				},
 			},