remove sorting IdPs in cache , improve nd extra logs for federation t…

…ask execution
eosc-kc · Sep 6, 2024 · 68eeea5 · 68eeea5
1 parent ddafe77
commit 68eeea5
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,6 +26,7 @@ Our Keycloak version is working well with PostgreSQL database. For using other S
 - Fix bugs in AutoUpdated schedule task
 - Correct query for autoUpdated IdP
 - Do not change lastRefreshTime during IdP update
+- Improvements and logs in SAML federation task execution
 
 ## [22.0.10-1.7] - 2024-07-10
 

diff --git a/model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/RealmAdapter.java b/model/infinispan/src/main/java/org/keycloak/models/cache/infinispan/RealmAdapter.java
@@ -17,6 +17,7 @@
 
 package org.keycloak.models.cache.infinispan;
 
+import org.jboss.logging.Logger;
 import org.keycloak.Config;
 import org.keycloak.common.enums.SslRequired;
 import org.keycloak.component.ComponentModel;
@@ -38,6 +39,9 @@
  * @version $Revision: 1 $
  */
 public class RealmAdapter implements CachedRealmModel {
+
+    protected static final Logger logger = Logger.getLogger(RealmAdapter.class);
+
     protected CachedRealm cached;
     protected RealmCacheSession cacheSession;
     protected volatile RealmModel updated;
@@ -977,6 +981,7 @@ public void taskExecutionFederation(FederationModel federationModel, List<Identi
         updated.taskExecutionFederation(federationModel, addIdPs, updatedIdPs, removedIdPs);
         //invalidate cache for users related with removed IdPs
         session.users().preRemove(removedIdPs);
+        logger.info("finish updating cache for the SAML federation (id): " + federationModel.getAlias());
     }
 
     @Override

diff --git a/model/jpa/src/main/java/org/keycloak/models/jpa/RealmAdapter.java b/model/jpa/src/main/java/org/keycloak/models/jpa/RealmAdapter.java
@@ -1295,6 +1295,11 @@ public IdentityProviderModel getIdentityProviderByAlias(String alias) {
 
     @Override
     public void addIdentityProvider(IdentityProviderModel identityProvider) {
+        addIdentityProviderMain(identityProvider);
+        em.flush();
+    }
+
+    private void addIdentityProviderMain(IdentityProviderModel identityProvider) {
         IdentityProviderEntity entity = new IdentityProviderEntity();
 
         if (identityProvider.getInternalId() == null) {
@@ -1359,24 +1364,6 @@ public void updateIdentityProvider(IdentityProviderModel identityProvider) {
 
         em.flush();
 
-    }
-
-    /**
-     * method for update when federation task is executed
-     * @param identityProvider
-     */
-    private void updateIdentityProviderFromFed(IdentityProviderModel identityProvider) {
-
-        IdentityProviderEntity entity =(IdentityProviderEntity)  em.find(IdentityProviderEntity.class,identityProvider.getInternalId());
-        modelToEntity(entity,identityProvider);
-        if (identityProvider.getFederations() != null) {
-            entity.setFederations(identityProvider.getFederations().stream().map(id -> {
-                FederationEntity fed = new FederationEntity();
-                fed.setInternalId(id);
-                return fed;
-            }).collect(Collectors.toSet()));
-        }
-
         session.getKeycloakSessionFactory().publish(new RealmModel.IdentityProviderUpdatedEvent() {
 
             @Override
@@ -1394,6 +1381,24 @@ public KeycloakSession getKeycloakSession() {
                 return session;
             }
         });
+
+    }
+
+    /**
+     * method for update when federation task is executed
+     * @param identityProvider
+     */
+    private void updateIdentityProviderFromFed(IdentityProviderModel identityProvider) {
+
+        IdentityProviderEntity entity =(IdentityProviderEntity)  em.find(IdentityProviderEntity.class,identityProvider.getInternalId());
+        modelToEntity(entity,identityProvider);
+        if (identityProvider.getFederations() != null) {
+            entity.setFederations(identityProvider.getFederations().stream().map(id -> {
+                FederationEntity fed = new FederationEntity();
+                fed.setInternalId(id);
+                return fed;
+            }).collect(Collectors.toSet()));
+        }
     }
 
     private FederationModel entityToModel(FederationEntity entity) {
@@ -1552,8 +1557,9 @@ public void updateSAMLFederation(FederationModel federationModel) {
     @Override
     public void taskExecutionFederation(FederationModel federationModel, List<IdentityProviderModel> addIdPs, List<IdentityProviderModel> updatedIdPs, List<String> removedIdPs) {
 
+        logger.info("Strating updating in database the SAML federation (id): " + federationModel.getAlias());
 	    addIdPs.stream().forEach(idp -> {
-            this.addIdentityProvider(idp);
+            this.addIdentityProviderMain(idp);
             //add mappers from federation for new identity providers
             federationModel.getFederationMapperModels().stream().map(mapper -> new IdentityProviderMapperModel(mapper, idp.getAlias())).forEach(mapper ->{
                 try {
@@ -1572,7 +1578,10 @@ public void taskExecutionFederation(FederationModel federationModel, List<Identi
                 this.removeFederationIdp(federationModel, alias);
             });
         }
+        logger.info("Finish updating IdPs of the SAML federation (id): " + federationModel.getAlias());
         this.updateSAMLFederation(federationModel);
+        em.flush();
+        logger.info("Finish updating in database the SAML federation (id): " + federationModel.getAlias());
     }
 
     @Override

diff --git a/services/src/main/java/org/keycloak/broker/saml/federation/SAMLFederationProvider.java b/services/src/main/java/org/keycloak/broker/saml/federation/SAMLFederationProvider.java
@@ -165,7 +165,7 @@ public void enableUpdateTask() {
 	@Override
 	public synchronized void updateSamlEntities() {
 
-		logger.info("Started updating the SAML federation (id): " + model.getInternalId());
+		logger.info("Started updating the SAML federation (id): " + model.getAlias());
 
 		RealmModel realm = session.realms().getRealm(realmId);
 
@@ -353,6 +353,7 @@ public synchronized void updateSamlEntities() {
 				}
 			});
 
+			logger.info("finish parsing the SAML federation (id): " + model.getAlias());
 			model.setLastMetadataRefreshTimestamp(new Date().getTime());
 			realm.taskExecutionFederation(model, addedIdps, updatedIdps, existingIdps);