[SLING-6070] Reduce temporary storage required in JcrResourceListener, call reportChanges earlier

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: JCR Resource 2.8.0
• Fix Version/s: JCR Resource 2.8.2
• Component/s: JCR
• Assignee: Carsten Ziegeler
• Reporter: Stefan Egli
• Created: 27/Sep/16 12:32
• Updated: 26/Sep/19 12:40
• Resolved: 17/Oct/16 12:12

Description

As noticed in OAK-4581 (here) one advantage of using OakResourceListener over JcrResourceListener (hence the term 'optimize for oak' of the config parameter) is that OakResourceListener uses a NodeObserver, which calls added/removed/changed after each child traversal has finished. This will in turn be used by the OakResourceListener to call ObservationReporter.reportChanges. In the JcrResourceListener.onEvent case however this is not possible, as the events are delivered for each node/property individually, and they first have to be 'mapped' to ResourceChanges. This is currently done by keeping maps of added/removed/changed ResourceChanges and only after all events (that are passed in 1 onEvent) are processed is reportChanges invoked. This has the downside of a potentially very large temporary memory usage (these maps can get big).

A suggested improvement is to follow the same pattern as is done in the OakResourceListener/NodeObserver pair: to forward the events (by callling reportChanges) as early as possible. Since Oak uses a breadth-first tree traversal when compiling the jcr events, this fact can be used to detect the earliest possible moment to forward events, which is as soon as a child traversal has finished. That way, only parent changes need to be kept, not the entire tree of changes.

Issue Links

• is blocked by: OAK-4853 User defined property values in event info
• relates to: OAK-4581 Persistent local journal for more reliable event generation
• relates to: SLING-6056 achieve 1:1 mapping between observation and resource change listener