Separate caches for what needs to be sent to e.g. Redis vs. not

orbeon / orbeon-forms

Orbeon Forms is an open source web forms solution. It includes an XForms engine, the Form Builder web-based form editor, and the Form Runner runtime.

http://www.orbeon.com/

GNU Lesser General Public License v2.1

518 stars 220 forks source link

Separate caches for what needs to be sent to e.g. Redis vs. not #6555

Open avernet opened 1 month ago

avernet commented 1 month ago

Should not be sent to Redis:

form-runner.persistence.form-definition
form-runner.persistence.form-metadata

See #6554

avernet commented 1 month ago

Discussed:

Always use Ehcache 3
- For
  - form-runner.persistence.form-definition
  - form-runner.persistence.form-metadata
- In this future we could also use Ehcache 3 for other cache we are now doing on our own
Honor oxf.xforms.cache.provider
- Can be set to either ehcache2 or jcache
- In the future: remove support for ehcache2, so always JCache, which by default uses Ehcache 3, like other caches
- For
  - xforms.state
  - xforms.resources (?)

ebruchez commented 1 month ago

We also access Ehcache 3 via JCache, so we need to add support for multiple JCache providers.

avernet commented 1 month ago

@ebruchez If it is simpler, for the caches that always remain local (form-runner.persistence.form-definition and form-runner.persistence.form-metadata, and more to come), we can also hardcode the use of Ehcache3 (through JCache or not), as we don't need (or want) users to be able to configure what cache is used for those.

ebruchez commented 4 weeks ago

Looking for a good name to differentiate the two categories of caches. Differences:

true cache (data can be recreated); local (should not be replicated); not serializable
store (data cannot be recreated); distributable (must be replicated); serializable

After discussion, leaning towards adding store properties:

oxf.xforms.store.provider
oxf.xforms.store.jcache.classname
oxf.xforms.store.jcache.resource
oxf.xforms.store.jcache.uri

If a store property is missing, use the corresponding cache property.

ebruchez commented 4 weeks ago

[ ] doc
[x] ~~backport~~
- RESOLUTION: We don't include this on 2023.1.x. This will be a 2024.1 feature.

ebruchez commented 4 weeks ago

Difficulties I encountered:

we need to use versions 2.x of jaxb-api, jaxb-core, jaxb-impl for Ehcache 3
there doesn't seem to be a declarative configuration possible in ehcache3.xml to tell that we want to store values on the heap by reference
- default was by value, which triggered serialization
- so that is now specified in code
- possible now that we make a distinction between store and cache

ebruchez commented 3 weeks ago

I think we delayed backporting to 2023.1-pe until we have feedback.

ebruchez commented 2 weeks ago

RESOLUTION: We don't include this on 2023.1.x. This will be a 2024.1 feature.