Reduce per-container memory: cache by GUID instead of Container, share JSON keys by labkey-jeckels · Pull Request #8134 · LabKey/platform

labkey-jeckels · 2026-10-04T23:21:02Z

Tasks

Rationale

Lower the server's memory footprint on servers with many containers and concurrent bulk JSON API requests. A heap dump from a production server with about 74,000 workbooks and 41 concurrent bulk list inserts showed two main costs:

Source	In the dump	Estimated after this PR
Bulk JSON payloads: the parse trees of 41 concurrent `insertRows` requests	1.88 GB, about 108 B per cell	about half of that, ~0.95 GB saved, because each distinct key is stored once per request instead of once per row
Caches holding one entry per container	0.39 GB across all caches	~175–230 MB saved
`Container` objects	194,496 for 74,338 containers; stale copies are kept alive as keys in Container-keyed caches	one per container

Savings are estimates from object layouts and the dump's entry counts, not measurements of the patched code. The dump came from the outage in GH Issue 1639.

BVT-EHR currently runs develop's specimen module rather than this branch's, so expect container-delete failures there until GH Issue 1643 is resolved.

Related Pull Requests

LabKey/limsModules#2516
LabKey/premiumModules#776
Reduce per-container memory: cache by GUID instead of Container, share JSON keys customModules#282
Reduce per-container memory: cache by GUID instead of Container targetedms#1287

Changes

Container-scoped caches use the container's GUID as their key instead of the Container object, and the cache layer now rejects Container keys
Container cache invalidation removes only the affected entries instead of clearing whole caches, and reuses cached Container objects
The folder-type and reports usage metrics and the required-modules calculation query the database directly instead of filling a cache entry for every container
The pipeline-root and file-root tables are each cached as a single map, and the WebDAV folder cache is capped at a fixed size
The search crawler indexes only a workbook's own lists, not its parent's
Bulk JSON request parsing stores one copy of each repeated object key
Optimize some metrics (folder type counts, etc) to do a single SQL query to get results instead of iterating all containers

…d similar

It's now on fb_audit_provided_values_1640 for GH Issue 1640.

…ull containers in query uncache, use a set for property URI uncaching

## Rationale Companion to LabKey/platform#8134, which rejects `Container` objects as cache keys to reduce per-container memory. ## Related Pull Requests - LabKey/platform#8134 ## Changes - Container-scoped caches use the container's GUID as their key instead of the `Container` object

…nObjectMemory

…nObjectMemory # Conflicts: # experiment/src/org/labkey/experiment/PropertyQueryChangeListener.java # query/src/org/labkey/query/persist/QueryDefCache.java

labkey-adam · 2026-10-08T00:51:34Z

Coming to this idea a little late, but did you consider leaving all the Container key caches and code in place, but translating those Containers to GUIDs (and vice versa) at a lower level? I think we could accomplish this easily with a SimpleCache<Container, V> that wraps an EhSimpleCache<GUID, V> and does the Container <-> GUID translations.

## Rationale Using `Container` objects as cache keys can be very expensive, especially on servers with a large number of containers and workbooks. We want to cache using each container's `GUID` instead of the Container object itself. See analysis here: #8134 ## Changes The above referenced PR and companion PRs switch every Container-keyed cache to a GUID-keyed cache. Each cache then implements new get/put/remove and other behaviors that map Containers to GUID and back, as needed. This PR takes a different approach. Cache factory methods now optionally receive the cache key's class. In the case of a Container key, the factory returns a special cache whose methods take Containers but whose underlying cache uses GUID keys. Passing in Container.class is the only change needed to switch to this more efficient cache. `SimpleKeyMappingCache` implements the five critical cache methods, mapping keys using the passed in `Function`s. This general-purpose class can be used to map any cache key to a more efficient alternative. CacheManager has a registry that maps key classes to specialized caches that can be a SimpleKeyMappingCache (or some other specialized implementation). `ContainerKeySimpleCache` is a one-line class that extends SimpleKeyMappingCache and provides the simple Container <-> GUID mapping functions. ## Tasks - [x] Claude Code Review - [x] Test Automation - junit tests added

…Cache and DomainPropertyManager. Move key validation to EhSimpleCache (CacheWrapper validation is too early since it hits before keys are mapped by SimpleKeyMappingCache).

…Cache and DomainPropertyManager. Move key validation to EhSimpleCache (CacheWrapper validation is too early since it hits before keys are mapped by SimpleKeyMappingCache). Pass debugName to EhSimpleCache for better logging.

… into fb_containerAndJsonObjectMemory

…s CacheLoader a bit

labkey-adam · 2026-10-09T20:47:12Z

+ * JSONTokener that returns one shared String instance per distinct object key, so a bulk payload's rows don't each
+ * hold their own copy of every column name.
+ */
+public class KeySharingJSONTokener extends JSONTokener


Would it make sense to contribute this to the JSONObject project? That way, they'd maintain it. And others could benefit.

Issue opened. If the maintainer likes the idea I'll create a PR. stleary/JSON-java#1091

labkey-jeckels added 5 commits October 3, 2026 11:01

Reduce per-container memory; optimize JSON memory use for saveRows an…

c3067cb

…d similar

Remove unused method

e3b7655

Move provided-values audit fix to its own branch

d50332e

It's now on fb_audit_provided_values_1640 for GH Issue 1640.

Test fixes and Claude review

8f8698f

Handle null containers

f89702d

This was referenced Oct 4, 2026

Reduce per-container memory: cache by GUID instead of Container, share JSON keys LabKey/customModules#282

Merged

Reduce per-container memory: cache by GUID instead of Container LabKey/targetedms#1287

Merged

labkey-jeckels self-assigned this Oct 4, 2026

Skip workbook child query for containers without children, tolerate n…

a0f039b

…ull containers in query uncache, use a set for property URI uncaching

labkey-jeckels added 2 commits October 6, 2026 16:37

Merge remote-tracking branch 'origin/develop' into fb_containerAndJso…

e4e3aad

…nObjectMemory

Merge remote-tracking branch 'origin/develop' into fb_containerAndJso…

75a557e

…nObjectMemory # Conflicts: # experiment/src/org/labkey/experiment/PropertyQueryChangeListener.java # query/src/org/labkey/query/persist/QueryDefCache.java

labkey-jeckels marked this pull request as ready for review October 7, 2026 16:28

labkey-jeckels requested a review from a team October 7, 2026 16:28

labkey-adam mentioned this pull request Oct 8, 2026

Introduce SimpleKeyMappingCache and ContainerKeySimpleCache #8150

Merged

2 tasks done

Merge from develop. Fix conflicts in OntologyManager cache clearing.

8d0a3c0

labkey-adam added 7 commits October 9, 2026 11:13

Merge in ContainerKeySimpleCache. Resolve conflicts in FolderSettings…

4dbdd49

…Cache and DomainPropertyManager. Move key validation to EhSimpleCache (CacheWrapper validation is too early since it hits before keys are mapped by SimpleKeyMappingCache).

try-with-resources for new test

851c4f4

Merge remote-tracking branch 'origin/fb_containerAndJsonObjectMemory'…

c0393d0

… into fb_containerAndJsonObjectMemory

Unused import

108ab85

Restore Container-keyed caches

a64ccf3

Convert REQUIRED_MODULES_CACHE to Container-keyed, which cleans up it…

371dcc3

…s CacheLoader a bit

labkey-adam approved these changes Oct 9, 2026

View reviewed changes

labkey-jeckels merged commit 5271ec4 into develop Oct 10, 2026
12 checks passed

labkey-jeckels deleted the fb_containerAndJsonObjectMemory branch October 10, 2026 14:55

Navigation Menu

Repository navigation

Reduce per-container memory: cache by GUID instead of Container, share JSON keys - #8134

Reduce per-container memory: cache by GUID instead of Container, share JSON keys#8134
labkey-jeckels merged 16 commits into
developfrom
fb_containerAndJsonObjectMemory

labkey-jeckels commented Oct 4, 2026 •

edited

Loading

Uh oh!

labkey-adam commented Oct 8, 2026

Uh oh!

Uh oh!

labkey-adam Oct 9, 2026

Uh oh!

labkey-jeckels Oct 12, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

labkey-jeckels commented Oct 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tasks

Rationale

Related Pull Requests

Changes

Uh oh!

labkey-adam commented Oct 8, 2026

Uh oh!

Uh oh!

labkey-adam Oct 9, 2026

Choose a reason for hiding this comment

Uh oh!

labkey-jeckels Oct 12, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

labkey-jeckels commented Oct 4, 2026 •

edited

Loading