Updated KC dependency to 22.0.0

diversit commented 11 months ago

For compatibility with KC22: replaced Java EE with Jakarta EE. Test: replaced obsolete 'com.github.stefanbirker:system-rules' dependency with a similar library 'uk.org.webcompere:system-stubs-junit4'.

Note: this change might NOT be compatible with KC < 22.x !

Motivation

Metrics not compatible with Keycloak 22 due to change from Java EE to Jakarta EE. https://github.com/aerogear/keycloak-metrics-spi/issues/168

What

Replaces Java EE imports with Jakarta EE imports. No further code changes.

Why

Keycloak 22 replaced Java EE with Jakarta EE making this library not compatible anymore, throwing a ClassNotFoundException at startup.

How

Replaces Java EE imports with Jakarta EE imports. No further code changes.

For test had to replace the old (and obsolete?) system-rules dependency with a more current version by uk.org.compere due to module issues since Keycloak 22 now also is just for Java 17 (Java 11 compatibility was dropped).

 PrometheusExporterTest.shouldBuildPushgateway » InaccessibleObject Unable to make field private final java.util.Map java.util.Collections$UnmodifiableMap.m accessible: module java.base does not "opens java.util" to unnamed module @70beb599

Updating the dependency fixed this issue.

Verification Steps

Add this version to KC 22 install
Start KC 22
Login to KC 22
Enable 'metrics-listener' to realm events settings
Logout en login to KC to trigger event to send to metrics listener
Verify metics on /auth/realms/master/metrics endpoint

Checklist:

[x] Code has been tested locally by PR requester
[ ] Changes have been successfully verified by another team member

Progress

[x] build library with fix
[x] deployed fix to local repository
[x] build KC22 container with fixed metrics api
[x] deployed KC22 contain on Kubernetes
[x] verified Prometheus target on /auth/realms/master/metrics is 'Up'
[x] verified Keycloak dashboard displays realm metrics again
[ ] Merge PR and build new version
[ ] Replace snapshot dependency with released dependency

Additional Notes

Due to the changes in KC 22 (dropped Java 11 compatibility, change from Java EE to Jakarta EE), these changes are likely not compatible with KC versions < 22.x.

pb82 commented 11 months ago

thanks @diversit ! will give it a quick try and then merge this.

pb82 commented 11 months ago

This works as expected with Keycloak 22 :+1: However, I can also confirm that it does not work in older versions: java.lang.NoClassDefFoundError: jakarta/ws/rs/WebApplicationException.

So v4.0.0 with an explicit note makes sense.

aerogear / keycloak-metrics-spi