Add support for `org.ehcache:ehcache:3.10.8-jakarta` by linghengqian · Pull Request #124 · oracle/graalvm-reachability-metadata

linghengqian · 2022-11-24T21:34:32Z

What does this PR do?

Fixes Add support for org.ehcache:ehcache-jakarta #123 .

Checklist before merging

I have properly formatted metadata files (see CONTRIBUTING document)
I have added thorough tests. (see this)

linghengqian · 2022-11-24T22:04:23Z

+String libraryVersion = TestUtils.testedLibraryVersion.split("-")[0]
+
+dependencies {
+    testImplementation("org.ehcache:ehcache:$libraryVersion") {
+        capabilities {
+            requireCapability('org.ehcache:ehcache-jakarta')
+        }
+    }


I don't know at all whether this can be used normally when the user uses the jakarta variant of ehcache. At least I solved the error of ./gradlew clean test -Pcoordinates=org.ehcache:ehcache:3.10.8-jakarta through this processing.

Can a friend expand https://github.com/oracle/graalvm-reachability-metadata/blob/master/CONTRIBUTING.md ?

linghengqian · 2022-11-24T22:45:30Z

+    testImplementation 'ch.qos.logback:logback-classic:1.4.5'
+    testImplementation 'ch.qos.logback:logback-core:1.4.5'
+}
+


Now execute ./gradlew clean test -Pcoordinates=org.ehcache:ehcache:3.10.8-jakarta, we will see a Warning Log. Do I need to do something or ignore it? Refer to Java 11 support ehcache/ehcache3#2671 .

04:12:09.769 [main] WARN org.ehcache.sizeof.ObjectGraphWalker - The JVM is preventing Ehcache from accessing the subgraph beneath 'private final byte[] java.lang.String.value' - cache sizes may be underestimated as a result java.lang.reflect.InaccessibleObjectException: Unable to make field private final byte[] java.lang.String.value accessible: module java.base does not "opens java.lang" to unnamed module @3e7dfd44 at java.base@17.0.5/java.lang.reflect.AccessibleObject.checkCanSetAccessible(AccessibleObject.java:354) at java.base@17.0.5/java.lang.reflect.AccessibleObject.checkCanSetAccessible(AccessibleObject.java:297) at java.base@17.0.5/java.lang.reflect.Field.checkCanSetAccessible(Field.java:178) at java.base@17.0.5/java.lang.reflect.Field.setAccessible(Field.java:172) at org.ehcache.sizeof.ObjectGraphWalker.getAllFields(ObjectGraphWalker.java:245) at org.ehcache.sizeof.ObjectGraphWalker.getFilteredFields(ObjectGraphWalker.java:204) at org.ehcache.sizeof.ObjectGraphWalker.walk(ObjectGraphWalker.java:159) at org.ehcache.sizeof.SizeOf.deepSizeOf(SizeOf.java:70) at org.ehcache.impl.internal.sizeof.DefaultSizeOfEngine.sizeof(DefaultSizeOfEngine.java:51) at org.ehcache.impl.internal.store.heap.OnHeapStore.getSizeOfKeyValuePairs(OnHeapStore.java:981) at org.ehcache.impl.internal.store.heap.OnHeapStore.makeValue(OnHeapStore.java:1529) at org.ehcache.impl.internal.store.heap.OnHeapStore.makeValue(OnHeapStore.java:1515) at org.ehcache.impl.internal.store.heap.OnHeapStore.newCreateValueHolder(OnHeapStore.java:1464) at org.ehcache.impl.internal.store.heap.OnHeapStore.lambda$put$8(OnHeapStore.java:344) at org.ehcache.impl.internal.concurrent.ConcurrentHashMap.compute(ConcurrentHashMap.java:1934) at org.ehcache.impl.internal.store.heap.SimpleBackend.compute(SimpleBackend.java:98)

wilkinsona · 2022-11-25T10:55:12Z

Many of the entries in reflect-config.json are for classes that aren't part of EhCache. For example, there are numerous entries for classes beneath jakarta.xml.bind. Unless EhCache is doing something with JAX-B that is unique, I don't think such entries belong in its reachability metadata. We've seen previously (#108 and #113 for example) the problems that can be caused by things being too broad and I think this may have similar problems.

linghengqian · 2022-11-25T11:27:51Z

Many of the entries in reflect-config.json are for classes that aren't part of EhCache. For example, there are numerous entries for classes beneath jakarta.xml.bind. Unless EhCache is doing something with JAX-B that is unique, I don't think such entries belong in its reachability metadata. We've seen previously (#108 and #113 for example) the problems that can be caused by things being too broad and I think this may have similar problems.

@wilkinsona I have removed the GraalVM reachability metadata related to javax.management.**. But unfortunately, whether it is proxy-config.json or reflect-config.json, once I remove the entry related to jakarta.xml.bind.**, ./gradlew clean test -Pcoordinates=org.ehcache:ehcache:3.10.8-jakarta will fail. Ehcache is really using JAXB to parse xml files.

wilkinsona · 2022-11-25T11:31:07Z

Ehcache is really using JAXB to parse xml files.

I believe anyone using JAXB may have this problem. As such, I am not sure that it's appropriate for EhCache to provide the reachability metadata that makes it work. It may be that there should be some reachability metadata for JAXB itself. Put another way, depending on Ehcache shouldn't magically make JAXB start working in other places.

linghengqian · 2022-11-25T11:37:49Z

Ehcache is really using JAXB to parse xml files.

I believe anyone using JAXB may have this problem. As such, I am not sure that it's appropriate for EhCache to provide the reachability metadata that makes it work. It may be that there should be some reachability metadata for JAXB itself. Put another way, depending on Ehcache shouldn't magically make JAXB start working in other places.

I guess you want me to provide GraalVM reachability metadata for org.glassfish.jaxb:jaxb-runtime:3.0.2, but I honestly don't know how to write as many units as possible for this infrastructure for testing, I've never dealt with JAXB directly. 🧐

wilkinsona · 2022-11-25T11:57:46Z

I suspect that someone should do that, but it doesn't have to be you of course. To proceed here, I think we need to understand how Ehcache is using JAXB. That would give us the information that's needed to determine where the metadata should go. Until that's been done, I think adding it under Ehcache would be the wrong thing to do.

linghengqian · 2022-11-25T12:14:20Z

I suspect that someone should do that, but it doesn't have to be you of course. To proceed here, I think we need to understand how Ehcache is using JAXB. That would give us the information that's needed to determine where the metadata should go. Until that's been done, I think adding it under Ehcache would be the wrong thing to do.

I would first generate GraalVM metadata for org.glassfish.jaxb:jaxb-runtime:3.0.2 and hang it in test/resources/META-INF/native-image/org.glassfish.jaxb/jaxb-runtime directory. This will take some time.

linghengqian · 2022-11-26T12:28:43Z

I have resolved the whole issue of this PR. I have temporarily hosted parts of GraalVM Reachability metadata with jakarta.xml.bind:jakarta.xml.bind-api:3.0.1 and org.glassfish.jaxb:jaxb-runtime:3.0.2 in the test/resources folder.
It just looks like GraalVM Trace Agent is not strong enough in Conditional Mode and needs me to handle it manually.

linghengqian · 2022-12-12T16:18:35Z

@dnestoro I'm assuming I need to resolve merge conflicts first, right?

dnestoro · 2022-12-12T16:37:29Z

@dnestoro I'm assuming I need to resolve merge conflicts first, right?

Yes. Sorry, I forgot to ask for that

# Conflicts: # metadata/index.json # tests/src/index.json

sdeleuze · 2022-12-15T16:59:49Z

+    {
+      "name": "com.sun.org.apache.xerces.internal.impl.msg.SAXMessages",
+      "locales": [
+        "und",


Could you please elaborate on why only those locales are needed?
I am also wondering if that belongs in ehcache hints or not.

@dnestoro @gradinac Do we support conditions on bundles?

This is simply generated by Conditional Agent Mode. Do I need to remove it?

sdeleuze · 2022-12-15T17:01:11Z

I will test it tomorrow with https://github.com/spring-projects/spring-aot-smoke-tests.

Does not work yet, see oracle/graalvm-reachability-metadata#124.

sdeleuze · 2022-12-16T13:05:05Z

@linghengqian I have tested with spring-projects/spring-aot-smoke-tests#160 and had the following error:

Caused by: java.lang.IllegalArgumentException: The serializer: org.ehcache.impl.serialization.PlainJavaSerializer does not have a constructor that takes in a ClassLoader.
	at org.ehcache.impl.config.serializer.DefaultSerializationProviderConfiguration.addSerializerFor(DefaultSerializationProviderConfiguration.java:99) ~[cache-ehcache:3.10.8]
	at org.ehcache.impl.config.serializer.DefaultSerializationProviderConfiguration.addSerializerFor(DefaultSerializationProviderConfiguration.java:75) ~[cache-ehcache:3.10.8]
	at org.ehcache.jsr107.EhcacheCachingProvider.createCacheManager(EhcacheCachingProvider.java:148) ~[cache-ehcache:3.10.8]
	at org.ehcache.jsr107.EhcacheCachingProvider.getCacheManager(EhcacheCachingProvider.java:134) ~[cache-ehcache:3.10.8]
	at org.ehcache.jsr107.EhcacheCachingProvider.getCacheManager(EhcacheCachingProvider.java:85) ~[cache-ehcache:3.10.8]

Could you please add the constructor hints for serializer + related tests and test with the sample from the PR I linked above:

By customizing reachabilityMetadataUrl property in gradle.properties, for example on my computer I used reachabilityMetadataUrl=file:///home/seb/workspace/graalvm-reachability-metadata/metadata
Running ./gradlew clean framework:cache-ehcache:nativeAppTest

linghengqian · 2022-12-18T15:15:50Z

@sdeleuze

Because I'm on a business trip these days, the reply is late. To be honest, I don't quite understand the operating mechanism of https://github.com/spring-projects/spring-aot-smoke-tests, so I added some related tests in the new commit based on my guess, and it passed New tests pull more relevant metadata.

{
     "condition": {
       "typeReachable": "org.ehcache.impl.config.serializer.DefaultSerializationProviderConfiguration"
     },
     "name": "org.ehcache.impl.serialization.PlainJavaSerializer",
     "methods": [
       {
         "name": "<init>",
         "parameterTypes": [
           "java.lang.ClassLoader"
         ]
       }
     ]
   }

Will a6cddb2 help?

sdeleuze · 2023-01-02T16:19:06Z

Ok I will test again to check how it goes now.

sdeleuze · 2023-01-04T16:31:50Z

Works as expected on Spring side.

@dnestoro You can merge this PR.

linghengqian force-pushed the ehcache-jakarta branch from 558c300 to d1f272a Compare November 24, 2022 21:59

linghengqian commented Nov 24, 2022

View reviewed changes

This was referenced Nov 24, 2022

Introduce initial caching support spring-attic/spring-native#465

Closed

Add support for GraalVM Native Image ehcache/ehcache3#2992

Closed

wilkinsona mentioned this pull request Nov 25, 2022

Add support for com.hazelcast:hazelcast:5.2.1 #122

Closed

2 tasks

linghengqian force-pushed the ehcache-jakarta branch from 30c1cb7 to c12b567 Compare November 25, 2022 15:55

linghengqian commented Nov 25, 2022

View reviewed changes

Comment thread metadata/org.ehcache/ehcache/3.10.8-jakarta/reflect-config.json

linghengqian force-pushed the ehcache-jakarta branch from f0ef929 to 042dc54 Compare November 26, 2022 22:10

This was referenced Dec 1, 2022

In CONTRIBUTING.md point out that PR needs to remove GraalVM reachability metadata related to MBeans #133

Closed

Add support for javax.cache:cache-api:1.1.1 #136

Closed

Add more metatdata for org.glassfish.jaxb:jaxb-runtime:3.0.2 #137

Closed

Add support for org.ehcache:ehcache:3.10.8-jakarta

deb8fa6

linghengqian force-pushed the ehcache-jakarta branch from a880255 to deb8fa6 Compare December 5, 2022 15:59

This was referenced Dec 7, 2022

Ehcache native support apache/camel-quarkus#1638

Open

支持Native-Image以及优化建议 alibaba/easyexcel#2853

Open

Add support for Testcontainers #132

Merged

dnestoro added 5 commits December 12, 2022 12:08

Add new line at the end of config file

fff79ff

Add new line in multiple-managers.xml file

fffef73

Update multiple-variants.xml

69d48c1

Add new line at the end of the my-config.xml

f884153

Add a new line at the end of the template-sample.xml

dea5853

dnestoro approved these changes Dec 12, 2022

View reviewed changes

Merge branch 'master' into ehcache-jakarta

8b0b661

Merge remote-tracking branch 'oracle/master' into ehcache-jakarta

29029d3

# Conflicts: # metadata/index.json # tests/src/index.json

sdeleuze reviewed Dec 15, 2022

View reviewed changes

sdeleuze added a commit to sdeleuze/spring-aot-smoke-tests that referenced this pull request Dec 16, 2022

Add draft EhCache support

2743edc

Does not work yet, see oracle/graalvm-reachability-metadata#124.

sdeleuze mentioned this pull request Dec 16, 2022

Add EhCache support spring-projects/spring-aot-smoke-tests#160

Draft

Add unit tests related to Jcache

a6cddb2

vjovanov merged commit 378bcfe into oracle:master Jan 11, 2023

linghengqian deleted the ehcache-jakarta branch January 11, 2023 08:34

This was referenced Jan 14, 2023

Add support for javax.cache:cache-api:1.1.1 #176

Merged

Graalvm support ben-manes/caffeine#434

Closed

Conversation

linghengqian commented Nov 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Checklist before merging

Uh oh!

linghengqian Nov 24, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

linghengqian Nov 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wilkinsona commented Nov 25, 2022

Uh oh!

linghengqian commented Nov 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wilkinsona commented Nov 25, 2022

Uh oh!

linghengqian commented Nov 25, 2022

Uh oh!

wilkinsona commented Nov 25, 2022

Uh oh!

linghengqian commented Nov 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

linghengqian commented Nov 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linghengqian commented Dec 12, 2022

Uh oh!

dnestoro commented Dec 12, 2022

Uh oh!

sdeleuze Dec 15, 2022

Choose a reason for hiding this comment

Uh oh!

linghengqian Dec 15, 2022

Choose a reason for hiding this comment

Uh oh!

sdeleuze commented Dec 15, 2022

Uh oh!

sdeleuze commented Dec 16, 2022

Uh oh!

linghengqian commented Dec 18, 2022

Uh oh!

sdeleuze commented Jan 2, 2023

Uh oh!

sdeleuze commented Jan 4, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

linghengqian commented Nov 24, 2022 •

edited

Loading

linghengqian Nov 24, 2022 •

edited

Loading

linghengqian commented Nov 25, 2022 •

edited

Loading

linghengqian commented Nov 25, 2022 •

edited

Loading

linghengqian commented Nov 26, 2022 •

edited

Loading