Review LSP4Jakarta diagnostic code and resolve remaining issues with matching qualified class names.

[mrglavas]

While reviewing #860 I noticed additional issues in the way that the LSP4Jakarta diagnostic collectors are matching qualified names. Specifically BeanValidationDiagnosticsCollector is checking if a type name ends with the simple name of several classes (constants defined in BeanValidationConstants).

For instance this code type.getCanonicalText().endsWith(BIG_DECIMAL) was likely intended to only match java.math.BigDecimal but will match a BigDecimal in any Java package (e.g. com.example.BigDecimal). There may yet still be other instances of qualified names that are not processed correctly. We should thoroughly review the code to ensure that we fully address these issues once and for all.

Code review check list for each of the diagnostic collectors within io.openliberty.tools.intellij.lsp4jakarta.lsp4ij:

• AbstractDiagnosticsCollector - usage of nameEndsWith() in conjunction with isImportedJavaElement() should be investigated.
• annotations.AnnotationDiagnosticsCollector - isValidAnnotation() uses endsWith() instead of equals()
• beanvalidation.BeanValidationDiagnosticsCollector - see issues described in the section above
• cdi.ManagedBeanDiagnosticsCollector - no issues but should remove unused unqualified names from ManagedBeanConstants
• di.DependencyInjectionDiagnosticsCollector - no issues but should remove unused unqualified names from DependencyInjectionConstants
• jax_rs.Jax_RSClassDiagnosticsCollector - no issues
• jax_rs.ResourceMethodDiagnosticsCollector - no issues
• jsonb.JsonbDiagnosticsCollector - no issues
• jsonp.JsonpDiagnosticCollector - no issues
• persistence.PersistenceEntityDiagnosticsCollector - no issues
• persistence.PersistenceMapKeyDiagnosticsCollector - no issues
• servlet.FilterDiagnosticsCollector - no issues but should remove unused unqualified names from ServletConstants
• servlet.ListenerDiagnosticsCollector - no issues
• servlet.ServletDiagnosticsCollector - no issues
• websocket.WebSocketDiagnosticsCollector - isWrapper() uses unqualified names to check for classes in the java.lang package. Should remove unused unqualified names from WebSocketConstants.

Investigate and resolve issues in diagnostic collectors that were identified by the code review:

• AbstractDiagnosticsCollector: Investigate and resolve issues with matching qualified names. #1025
• annotations.AnnotationDiagnosticsCollector: Investigate and resolve issues with matching qualified names. #1026
• beanvalidation.BeanValidationDiagnosticsCollector: Investigate and resolve issues with matching qualified names. #1027
• cdi.ManagedBeanDiagnosticsCollector: Investigate and resolve issues with matching qualified names. #1028
• di.DependencyInjectionDiagnosticsCollector: Investigate and resolve issues with matching qualified names. #1029
• servlet.FilterDiagnosticsCollector: Investigate and resolve issues with matching qualified names. #1030
• websocket.WebSocketDiagnosticsCollector: Investigate and resolve issues with matching qualified names. #1031

Expand test coverage for processing of qualified names:

• Jakarta: Create java.lang and java.math imposter classes for use in testing qualified names. #1080

[mrglavas]

I have started reviewing the LSP4Jakarta diagnostic collectors. Will document additional discoveries here.

[mrglavas]

AnnotationDiagnosticsCollector is checking whether two annotation names match using endsWith() instead of equals(). As an example, this means that if the expected name is jakarta.annotation.PostConstruct it would match on.PostConstruct.

    private static boolean isValidAnnotation(String annotationName, String[] validAnnotations) {
        if (annotationName != null) {
            for (String fqName : validAnnotations) {
                if (fqName.endsWith(annotationName)) {
                    return true;
                }
            }
        }
        return false;
    }

Should also delete the unused non-qualified class names from AnnotationConstants to help prevent accidental future usage.

[mrglavas]

Analysis of BeanValidationDiagnosticsCollector is in the description. Should replace the unqualified names with qualified names and use equals() for comparing them instead of endsWith().

[mrglavas]

WebSocketDiagnosticsCollector is checking whether a value class is a primitive type wrapper using unqualified names for classes in the java.lang package.

    private boolean isWrapper(String valueClass) {
        return WebSocketConstants.WRAPPER_OBJS.contains(valueClass)
                || WebSocketConstants.RAW_WRAPPER_OBJS.contains(valueClass);
    }

This method should only use the qualified names to determine if a class is a wrapper.

[mrglavas]

All tasks have been completed on this epic.