Generic Editor - Spring YAML Properties Not Support Map Recognition

[yl-yue]

@ConfigurationProperties code definition

@ConfigurationProperties(prefix = "justauth")
public class JustAuthProperties {
    private Map<AuthDefaultSource, AuthConfig> type = new HashMap<>();
}

public enum AuthDefaultSource implements AuthSource {
    ALIPAY {
        @Override
        public String authorize() {
            return "https://openauth.alipay.com/oauth2/publicAppAuthorize.htm";
        }

        @Override
        public String accessToken() {
            return "https://openapi.alipay.com/gateway.do";
        }

        @Override
        public String userInfo() {
            return "https://openapi.alipay.com/gateway.do";
        }
    }
}

public class AuthConfig {
    private String clientId;
    private String clientSecret;
}

yml file config

justauth:
  enabled: true
  type:
    ALIPAY:
      client-id: 20210011
      client-secret: MIIEvwIBADANBgkqh

error show

expectation

Support Map Recognition Prompt Correctly.

[kdvolder]

Some things I needed to do to make the example code complete. In the future please try to package your example as a self-container project. As I am guessing to fill in the gaps, I am not certain that what I'm doing is the same as what you are doing.

I am recording here the steps I did, this is for later reference by myself, and possible for you to see if there's a difference between what O'm doing versus your setup.

• put all the code inside a new spring-boot prpject created by initializer. Java version 1.8, Boot version 2.3.3.RELEASE I placed all code in the 'com.example.demo' package added package declaration and necessary import.
• Added missing type 'AuthSource'

package com.example.demo;

public interface AuthSource {
	String authorize();
	String accessToken();
	String userInfo();
}

• Add getter and setter to JustAuthProperties (I think at least a getter is required, maybe the setter could be omitted.

package com.example.demo;

import java.util.HashMap;
import java.util.Map;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "justauth")
public class JustAuthProperties {
    private Map<AuthDefaultSource, AuthConfig> type = new HashMap<>();

	public Map<AuthDefaultSource, AuthConfig> getType() {
		return type;
	}

	public void setType(Map<AuthDefaultSource, AuthConfig> type) {
		this.type = type;
	}
}

Add getter and setter for AuthConfig:

package com.example.demo;
public class AuthConfig {
    private String clientId;
    private String clientSecret;
	public String getClientSecret() {
		return clientSecret;
	}
	public void setClientSecret(String clientSecret) {
		this.clientSecret = clientSecret;
	}
	public String getClientId() {
		return clientId;
	}
	public void setClientId(String clientId) {
		this.clientId = clientId;
	}
}

• Add spring-boot-configuration-processor dependency to pom.xml

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration-processor</artifactId>
			<optional>true</optional>
		</dependency>

[kdvolder]

Made sure project with new config is built by doing a 'clean' of the project.

I then verified that configuration metadata is generated correctly by Spring Boot configuration processor by checking for a file: /target/classes/META-INF/spring-configuration-metadata.json.

Contains this data for me:

{
  "groups": [
    {
      "name": "justauth",
      "type": "com.example.demo.JustAuthProperties",
      "sourceType": "com.example.demo.JustAuthProperties"
    }
  ],
  "properties": [
    {
      "name": "justauth.type",
      "type": "java.util.Map<com.example.demo.AuthDefaultSource,com.example.demo.AuthConfig>",
      "sourceType": "com.example.demo.JustAuthProperties"
    }
  ],
  "hints": []
}

That seems correct and as expected.

Now we come to the real question... does the editor work properly with this metadata?

I closed all editors (there are sometimes issues with new metadata not being picked up by the editor. So I avoid those... closing all editors stops language servers and forces a 'clean slate'. Then create a src/main/resources/application.yml file and open it.

Editing the application.yml file works nicely. I get content assist for justauth.type and also for the 'ALIPAY` enum and the nested attributes. I created this content and it has no validation errors:

justauth:
  type:
    ALIPAY:
      client-id: 1363636
      client-secret: ASADASDASD

All working nicely for me.

[kdvolder]

@yl-yue Do you see any differences in your setup from mine? Do you really have classes like:

public class AuthConfig {
    private String clientId;
    private String clientSecret;

... without getters or setters? That will definitely explain the problem.

Also please verify if the configuration processor is setup correctlly: check that spring-configuration-metadata.json is created by it on the project's classpath. If that file exists and looks correct, and the editor still doesn't work correctly. Then most likely that the editor/language server has already parsed the data before the file was generated and did not refresh it correctly (this is problem we should try to fix, but at the moment I'm not sure this your problem). Try closing all editors and re-opening. If that fixes the problem, this issue stale data in the editor/language-server.

If you are still experiencing issues, please attach a complete sample project and exact step-by-step instructions on how to reproduce this problem. That will allow us to debug it more easily.

[kdvolder]

I am attaching my own 'complete' sample project created as described above.

justauth-example.zip

[kdvolder]

I'm closing this ticket because as far as I know right now. Interpretation of the kind of metadata as would be created by the example is interpreted correctly. You can still post more comments / details however and we can of course re-open this ticket again if there emerges a problem we can diagose and fix.

[yl-yue]

I am attaching my own 'complete' sample project created as described above.

justauth-example.zip

Through the justauth-example.zip sample project you provided, it has been confirmed that a similar Map data structure is supported.

The problem should be this dependency:

        <dependency>
            <groupId>com.xkcoding.justauth</groupId>
            <artifactId>justauth-spring-boot-starter</artifactId>
            <version>1.3.3</version>
        </dependency>

I checked the

/META-INF/additional-spring-configuration-metadata.json
/META-INF/spring-configuration-metadata.json

These two files are not quite sure what causes this problem.

Because I didn't find an error when I tested IDEA. So at first I thought STS didn't support Map genericity data structure recognition.

[kdvolder]

Okay, thanks for providing extra information. I will try to create a project with dependency:

        <dependency>
            <groupId>com.xkcoding.justauth</groupId>
            <artifactId>justauth-spring-boot-starter</artifactId>
            <version>1.3.3</version>
        </dependency>

And see if I can reproduce the issue that way. So I am re-opening this ticket for further investigation.

[kdvolder]

I am able to reproduce the issue. Don't understand exactly why this happens yet. The info that I see when hovering over type in:

justauth:
  enabled: true
  type:

Seems incorrect, it displays as 'Authconfig' instead of 'Map<...,...>' and the error is consistent with that. Trying to figure out now why the type is being inferred incorrectly.

[kdvolder]

Looking at the metadata for justauth.type. Pasting it here for easy reference.

    {
      "name": "justauth.type",
      "type": "java.util.Map<me.zhyd.oauth.config.AuthDefaultSource,me.zhyd.oauth.config.AuthConfig>",
      "description": "JustAuth 配置.",
      "sourceType": "com.xkcoding.justauth.autoconfigure.JustAuthProperties"
    }
...
  "hints": [
    {
      "name": "justauth.type.keys",
      "providers": [
        {
          "name": "handle-as",
          "parameters": {
            "target": "me.zhyd.oauth.config.AuthSource"
          }
        }
      ]
    },
    {
      "name": "justauth.type.values",
      "providers": [
        {
          "name": "handle-as",
          "parameters": {
            "target": "me.zhyd.oauth.config.AuthConfig"
          }
        }
      ]
    }
  ]

[kdvolder]

I think the reason for how this behaves is the declaration of 'handle-as' AuthSource for justauth.type.keys. I think if this metadata is removed then things will work as expected. In other words STS does not treat the key as an instance of an Enum because it has been explicitly instructed via the justauth libraries metadata to treat it as something else.

I would suggest raising this issue with the maintainers of the justauth boot starter and ask that they change/fix the metadata.

We can discuss more about this if you want. But for the time being I will close the ticket again as I do not beleave this is really a bug in STS.

[kdvolder]

BTW: Just to be clear about what I'm suggesting. I think the solution is for justauth to remove this metadata:

 "hints": [
    {
      "name": "justauth.type.keys",
      "providers": [
        {
          "name": "handle-as",
          "parameters": {
            "target": "me.zhyd.oauth.config.AuthSource"
          }
        }
      ]
    },
    {
      "name": "justauth.type.values",
      "providers": [
        {
          "name": "handle-as",
          "parameters": {
            "target": "me.zhyd.oauth.config.AuthConfig"
          }
        }
      ]
    }
  ]

But you should keep this:

 {
      "name": "justauth.type",
      "type": "java.util.Map<me.zhyd.oauth.config.AuthDefaultSource,me.zhyd.oauth.config.AuthConfig>",
      "description": "JustAuth 配置.",
      "sourceType": "com.xkcoding.justauth.autoconfigure.JustAuthProperties"
    }

And I think it should then all work correctly.

For the record, I did not actually verify this as it is a little difficult for me to strip out the metadata from the jar. But in theory I think it should work (as was verified by my own similar example earlier).