Remove offline session cache entry lifespan override options by ruchikajha95 · Pull Request #54644 · keycloak/keycloak

ruchikajha95 · 2026-11-04T15:28:21Z

Removes the deprecated SPI configuration options for overriding offline session cache entry lifespans:

spi-user-sessions--infinispan--offline-session-cache-entry-lifespan-override
spi-user-sessions--infinispan--offline-client-session-cache-entry-lifespan-override

Copilot

🟡 Changes recommended

Removing offline caches from persistent-session configuration bypasses critical safeguards against unbounded growth and stale entries, while deleting their size-limit CLI options breaks existing configurations.

3 open issues

What changed in this PR

Removes the deprecated offline-session cache lifespan overrides from Keycloak’s Infinispan session provider for Keycloak 27, addressing #40981.

Changes:

Removes override configuration, metadata, helper methods, and the dedicated model test.
Removes offline-cache max-count entries from configuration lists and CLI help snapshots.
Updates caching documentation and upgrade guidance.

File	Description
`testsuite/model/src/test/java/org/keycloak/testsuite/model/session/UserSessionProviderOfflineModelTest.java`	Removes the lifespan-override test and unused imports.
`testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/Infinispan.java`	Removes override settings from test configuration.
`quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityMetadataHelpAll.approved.txt`	Removes offline max-count options from extended metadata help.
`quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityMetadataHelp.approved.txt`	Removes offline max-count options from metadata help.
`quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityCheckHelpAll.approved.txt`	Removes offline max-count options from extended compatibility-check help.
`quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityCheckHelp.approved.txt`	Removes offline max-count options from compatibility-check help.
`quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt`	Removes offline max-count options from extended optimized-start help.
`quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelp.approved.txt`	Removes offline max-count options from optimized-start help.
`quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt`	Removes offline max-count options from extended start help.
`quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelp.approved.txt`	Removes offline max-count options from start help.
`quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt`	Removes offline max-count options from extended development-start help.
`quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelp.approved.txt`	Removes offline max-count options from development-start help.
`quarkus/config-api/src/main/java/org/keycloak/config/CachingOptions.java`	Removes offline caches from the max-count CLI option list.
`model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/InfinispanUserSessionProviderFactory.java`	Removes overrides and uses standard session-lifespan calculations.
`model/infinispan/src/main/java/org/keycloak/connections/infinispan/InfinispanConnectionProvider.java`	Removes offline caches from the provider’s max-count list.
`docs/guides/server/caching.adoc`	Changes the cache-limit example and removes the volatile-mode warning.
`docs/documentation/upgrading/topics/changes/changes-27_0_0.adoc`	Documents removal of the lifespan override options.
`docs/documentation/server_admin/topics/sessions/offline.adoc`	Revises offline-session storage and caching guidance.

_{Review effort: Balanced}

Copilot

🔵 Needs a closer look

The caching documentation omits the volatile-session exception, misleading operators into expecting memory limits on sessions and clientSessions to take effect when only offline cache limits remain supported in that mode.

No open issues 🎉

1 previously missed issue

In code that hasn't changed since last review

Clarify volatile sessions ignore sessions and clientSessions cache limits

docs/guides/server/caching.adoc:159

Please retain the volatile-session exception: CacheConfigurator.configureSessionsCachesForVolatileSessions() still explicitly ignores limits on sessions and clientSessions (lines 282–294). Without that qualification, this example tells volatile-mode operators they can bound memory with an option that has no effect; the offline cache limits remain supported in that mode.

3 resolved since last review

_{Review effort: Balanced}

Closes keycloak#40981 Signed-off-by: Ruchika <ruchika.jha1@ibm.com>

- Restore offline caches to CLUSTERED_MAX_COUNT_CACHES arrays to preserve persistent-session safeguards (memory bounds, single ownership, expiration-reaper config) - Revert help snapshots to keep CLI cache max-count options which are independent of the deprecated SPI lifespan override options - Fix documentation to remove incorrect claim that persistent sessions are mandatory - volatile sessions are still selectable Signed-off-by: Ruchika <Ruchika.Jha1@ibm.com>

Signed-off-by: Alexander Schwartz <alexander.schwartz@ibm.com>

Copilot

🟢 Approval recommended

No active review issues remain for the change to standard offline-session cache lifespan calculations.

No open issues 🎉

_{Review effort: Balanced}

keycloak-github-bot Bot added the team/production-readiness label Nov 4, 2026

ruchikajha95 self-assigned this Nov 4, 2026

ruchikajha95 requested a review from ahus1 November 4, 2026 16:15

ahus1 changed the title ~~Remove cache embedded offline sessions max count .~~ Remove cache embedded offline sessions max count Nov 4, 2026

ruchikajha95 force-pushed the iss-40981/Remove-cache-embedded-offline-sessions-max-count branch 4 times, most recently from 29e2a62 to f9e37bb Compare November 11, 2026 09:48

ruchikajha95 changed the title ~~Remove cache embedded offline sessions max count~~ Remove offline session cache entry lifespan override options Nov 11, 2026

ruchikajha95 requested a balanced review from Copilot November 11, 2026 13:28

Copilot started reviewing on behalf of ruchikajha95 November 11, 2026 13:28

View session

Copilot AI reviewed Nov 11, 2026

View reviewed changes

ahus1 reviewed Nov 11, 2026

View reviewed changes

Comment thread ...rg/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelp.approved.txt Resolved

ruchikajha95 requested a balanced review from Copilot November 12, 2026 09:35

Copilot started reviewing on behalf of ruchikajha95 November 12, 2026 09:35

View session

Copilot AI reviewed Nov 12, 2026

View reviewed changes

ruchikajha95 requested a review from ahus1 November 12, 2026 10:18

ruchikajha95 and others added 7 commits November 12, 2026 11:48

Remove cache embedded offline sessions max count .

d806c9b

Closes keycloak#40981 Signed-off-by: Ruchika <ruchika.jha1@ibm.com>

Spotless failure.

e66a294

Closes keycloak#40981 Signed-off-by: Ruchika <ruchika.jha1@ibm.com>

Removal of of cli options for the cache stacksFixed ci failures

6501c10

Closes keycloak#40981 Signed-off-by: Ruchika <ruchika.jha1@ibm.com>

Removal of of cli options

4fc42c0

Closes keycloak#40981 Signed-off-by: Ruchika <ruchika.jha1@ibm.com>

SPI lifespan override options removal

0abef2a

Closes keycloak#40981 Signed-off-by: Ruchika <ruchika.jha1@ibm.com>

Review

c9a87b8

Signed-off-by: Alexander Schwartz <alexander.schwartz@ibm.com>

ahus1 force-pushed the iss-40981/Remove-cache-embedded-offline-sessions-max-count branch from 184ea11 to c9a87b8 Compare November 12, 2026 10:49

ahus1 approved these changes Nov 12, 2026

View reviewed changes

ahus1 marked this pull request as ready for review November 12, 2026 10:50

8000 ahus1 requested review from a team as code owners November 12, 2026 10:50

ahus1 requested review from a team as code owners November 12, 2026 10:50

Copilot AI balanced review requested due to automatic review settings November 12, 2026 10:50

ahus1 enabled auto-merge (squash) November 12, 2026 10:50

Copilot started reviewing on behalf of ahus1 November 12, 2026 10:50

View session

Copilot AI reviewed Nov 12, 2026

View reviewed changes

ahus1 self-assigned this Nov 12, 2026

ahus1 merged commit c8a943d into keycloak:main Nov 12, 2026
96 checks passed

Navigation Menu

Repository navigation

Remove offline session cache entry lifespan override options - #54644

Remove offline session cache entry lifespan override options#54644
ahus1 merged 7 commits into
keycloak:mainfrom
ruchikajha95:iss-40981/Remove-cache-embedded-offline-sessions-max-count

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Uh oh!

Uh oh!

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

🔵 Needs a closer look

Uh oh!

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants