Missing metadata when using @Name with a constructor-bound property

[prishedko]

Hello,

I'd like to suggest a fix for a bug that I've found while using @Name annotation with Type-safe Configuration Properties.

Problem description

When @Name annotation is used, the metadata items extracted from executable elements (like description and deprecation data) are missing. The following example demonstrates it:

Let's say we have record like this:

/**
 * @param namedPropertyExample this should be in the metadata description.
 */
@ConfigurationProperties(prefix = "example.properties")
public record ExampleProperties(
        @Deprecated
        @DeprecatedConfigurationProperty(reason = "Some reason")
        String namedPropertyExample) {}

Then it's generated metadata is:

{
  "groups": [
    {
      "name": "example.properties",
      "type": "org.some.example.ExampleProperties",
      "sourceType": "org.some.example.ExampleProperties"
    }
  ],
  "properties": [
    {
      "name": "example.properties.named-property-example",
      "type": "java.lang.String",
      "description": "this should be in the metadata description.",
      "sourceType": "org.some.example.ExampleProperties",
      "deprecated": true,
      "deprecation": {
        "reason": "Some reason"
      }
    }
  ],
  "hints": [],
  "ignored": {
    "properties": []
  }
}

But if @Name annotation is added:

/**
 * @param namedPropertyExample this should be in the metadata description.
 */
@ConfigurationProperties(prefix = "example.properties")
public record ExampleProperties(
        @Name("named.property")
        @Deprecated
        @DeprecatedConfigurationProperty(reason = "Some reason")
        String namedPropertyExample) {}

the metadata misses several attributes:

{
  "groups": [
    {
      "name": "example.properties",
      "type": "org.some.example.ExampleProperties",
      "sourceType": "org.some.example.ExampleProperties"
    }
  ],
  "properties": [
    {
      "name": "example.properties.named.property",
      "type": "java.lang.String",
      "sourceType": "org.some.example.ExampleProperties"
    }
  ],
  "hints": [],
  "ignored": {
    "properties": []
  }
}

Root cause and the fix descriptions

The root cause is the using Name#value for locating executable elements in org.springframework.boot.configurationprocessor.PropertyDescriptorResolver#extracted:

		String name = getPropertyName(parameter);
		TypeMirror type = parameter.asType();
		ExecutableElement getter = members.getPublicGetter(name, type);
		ExecutableElement setter = members.getPublicSetter(name, type);
		VariableElement field = members.getFields().get(name);
		RecordComponentElement recordComponent = members.getRecordComponents().get(name);

...

	private String getPropertyName(VariableElement parameter) {
		return getPropertyName(parameter, parameter.getSimpleName().toString());
	}

	private String getPropertyName(VariableElement parameter, String fallback) {
		AnnotationMirror nameAnnotation = this.environment.getNameAnnotation(parameter);
		if (nameAnnotation != null) {
			return this.environment.getAnnotationElementStringValue(nameAnnotation, "value");
		}
		return fallback;
	}

For the example above it means searching record component with name named.property. I'd like to suggest using parameter name for locating the executable elements:

		String parameterName = parameter.getSimpleName().toString();
		TypeMirror type = parameter.asType();
		ExecutableElement getter = members.getPublicGetter(parameterName, type);
		ExecutableElement setter = members.getPublicSetter(parameterName, type);
		VariableElement field = members.getFields().get(parameterName);
		RecordComponentElement recordComponent = members.getRecordComponents().get(parameterName);

[snicoll]

Thanks for the detail explanation and the fix. Reviewing the code change, I've noticed another related problem, see #46662