Issue #382: Warning when PEAR contains a JCAS class that is used as a feature range outside the PEAR

- Do not issue warning on range mismatch if range class was loaded from a PEAR classloader
- Clean up

Author: reckart

uimaj-core/src/main/java/org/apache/uima/cas/impl/FSClassRegistry.java

@@ -115,8 +115,8 @@
  *       via accessing/updating a thread local instance of TypeSystemImpl.SlotAllocate.
  */
 // @formatter:on
-public abstract class FSClassRegistry { // abstract to prevent instantiating; this class only has
-                                        // static methods
+// abstract to prevent instantiating; this class only has static methods
+public abstract class FSClassRegistry {
 
   static final String RECORD_JCAS_CLASSLOADERS = "uima.record_jcas_classloaders";
   static final boolean IS_RECORD_JCAS_CLASSLOADERS = Misc
@@ -1371,6 +1371,31 @@ private static void checkConformance(Class<?> clazz, TypeSystemImpl tsi, TypeImp
         if (rangeClass.getName().equals("org.apache.uima.jcas.cas.Sofa")
                 && returnClass.getName().equals("org.apache.uima.cas.SofaFS")) {
           // empty
+        } else if (rangeClass.getClassLoader() instanceof UIMAClassLoader) {
+          // This can happen if:
+          //
+          // * we are in a PEAR which contains a local JCas wrapper for type X
+          // * -AND- additionally the type X also exists at a global level
+          // * -AND- there is another global type Y with a field x of type X
+          // * -AND- the PEAR does -NOT- have a local JCas wrapper for Y
+          //
+          // In this case, the getter/setter range class for Y.x are not compatible with the X from
+          // the PEAR which we found in the ti.getJavaClass() because that field inconveniently
+          // always contains the latest JCas wrapper that was encountered.
+          //
+          // The thing is that the PEAR would not be able to call the Y.x getter/setter anyway
+          // because the PEAR cannot access the class Y (that is assuming the best practice
+          // that the PEAR should always locally include all JCas wrapper classes it directly uses).
+          // In order to use the Y.x getter/setter, the PEAR would need to have a compile-time
+          // dependency on Y and then it should be bundled in the PEAR. So if it is not in the PEAR,
+          // then the PEAR cannot use it and therefore the warning would be pointless.
+          //
+          // What the PEAR could do though is created instances of Y via the CAS interface and use
+          // the CAS API to get/set feature values. This is covered by the PEARs trampoline
+          // mechanism.
+          //
+          // So if the range class is defined by an UIMAClassLoader (i.e. has been locally loaded by
+          // a PEAR) then we ignore the mismatch.
         } else {
           // CAS type system type "{0}" (loaded by {1}) defines field "{2}" with range "{3}" (loaded
           // by {4}), but JCas getter method is returning "{5}" (loaded by {6}) which is not a

uimaj-core/src/test/java/org/apache/uima/cas/test/JCasClassLoaderTest.java

@@ -33,13 +33,11 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.lang.invoke.MethodHandles;
 import java.net.MalformedURLException;
 import java.util.ArrayList;
 import java.util.stream.Stream;
 import java.util.stream.StreamSupport;
 
-import org.apache.uima.UIMAFramework;
 import org.apache.uima.analysis_component.Annotator_ImplBase;
 import org.apache.uima.analysis_component.JCasAnnotator_ImplBase;
 import org.apache.uima.analysis_engine.AnalysisEngine;
@@ -57,22 +55,14 @@
 import org.apache.uima.resource.ResourceManager;
 import org.apache.uima.resource.metadata.TypeDescription;
 import org.apache.uima.resource.metadata.TypeSystemDescription;
-import org.apache.uima.spi.JCasClassProviderForTesting;
 import org.apache.uima.test.IsolatingClassloader;
 import org.apache.uima.util.InvalidXMLException;
 import org.apache.uima.util.XMLInputSource;
 import org.assertj.core.api.AutoCloseableSoftAssertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.io.TempDir;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import x.y.z.Token;
-import x.y.z.TokenType;
 
 public class JCasClassLoaderTest {
-  private static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
   public static final String TYPE_NAME_TOKEN = Token.class.getName();
   public static final String TYPE_NAME_ARRAY_HOST = "uima.testing.ArrayHost";
@@ -446,44 +436,6 @@ void thatFSArrayToArrayReturnsProperJCasWrapper() throws Exception {
     }
   }
 
-  @Test
-  void thatFeatureRangeClassRedefinedInPearDoesNotCauseProblems(@TempDir File aTemp)
-          throws Exception {
-    var tsd = UIMAFramework.getXMLParser().parseTypeSystemDescription(
-            new XMLInputSource("src/test/java/org/apache/uima/jcas/test/generatedx.xml"));
-
-    LOG.info("-- Base runtime context --------------------------------------------------");
-    LOG.info("{} loaded using {}", Token.class, Token.class.getClassLoader());
-    LOG.info("{} loaded using {}", TokenType.class, TokenType.class.getClassLoader());
-
-    LOG.info(
-            "-- JCas/PEAR-like classloader context ----------------------------------------------");
-    var rootCl = getClass().getClassLoader();
-    var clForCas = new IsolatingClassloader("CAS Classloader", rootCl) //
-            .redefining(TokenType.class) //
-            .redefining(JCasClassProviderForTesting.class) //
-            .redefining(JCasCreator.class);
-
-    var jcasCreatorClass = clForCas.loadClass(JCasCreatorImpl.class.getName());
-    var creator = (JCasCreator) jcasCreatorClass.getDeclaredConstructor().newInstance();
-    var jcas = creator.createJCas(clForCas, tsd);
-    var cas = jcas.getCas();
-
-    var t = cas.createFS(cas.getTypeSystem().getType(Token.class.getName()));
-    var tt = cas.createFS(cas.getTypeSystem().getType(TokenType.class.getName()));
-
-    LOG.info("{} loaded using {}", t.getClass(), t.getClass().getClassLoader());
-    LOG.info("{} loaded using {}", tt.getClass(), tt.getClass().getClassLoader());
-
-    assertThat(t.getClass().getClassLoader()) //
-            .isSameAs(Token.class.getClassLoader());
-
-    assertThat(tt.getClass().getClassLoader()) //
-            .isSameAs(clForCas);
-
-    t.setFeatureValue(t.getType().getFeatureByBaseName(Token._FeatName_ttype), tt);
-  }
-
   public static Class<?> loadTokenClass(ClassLoader cl) {
     try {
       return cl.loadClass(TYPE_NAME_TOKEN);

uimaj-core/src/test/resources/log4j2-test.xml

@@ -25,7 +25,7 @@
     </Console>
   </Appenders>
   <Loggers>
-    <Root level="info">
+    <Root level="WARN">
       <AppenderRef ref="Console"/>
     </Root>
   </Loggers>

uimaj-it-pear-with-typesystem/src/test/resources/simplelogger.properties

@@ -1 +1 @@
-org.slf4j.simpleLogger.defaultLogLevel=debug
+org.slf4j.simpleLogger.defaultLogLevel=WARN