feat: Forward newsletter user attribute to Redis

openfoodfacts · Oct 12, 2024 · dd62c44 · dd62c44
1 parent ec60a8b
commit dd62c44
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 8 deletions.
diff --git a/src/main/java/openfoodfacts/github/keycloak/events/RedisClient.java b/src/main/java/openfoodfacts/github/keycloak/events/RedisClient.java
@@ -7,6 +7,7 @@
 import org.keycloak.models.RealmModel;
 import org.keycloak.models.UserModel;
 
+import openfoodfacts.github.keycloak.utils.UserAttributes;
 import redis.clients.jedis.JedisPooled;
 import redis.clients.jedis.StreamEntryID;
 
@@ -28,7 +29,10 @@ public void postUserRegistered(final UserModel user, final RealmModel realm) {
             throw new IllegalArgumentException("realm");
         }
 
-        postUserEvent("user-registered", user, realm);
+        final String newsletter = user.getFirstAttribute(UserAttributes.NEWSLETTER);
+        final HashMap<String, String> additionalData = new HashMap<>();
+        putIfNotNull(additionalData, "newsletter", newsletter);
+        postUserEvent("user-registered", user, realm, additionalData);
     }
 
     public void postUserDeleted(final UserModel user, final RealmModel realm) {
@@ -40,10 +44,11 @@ public void postUserDeleted(final UserModel user, final RealmModel realm) {
             throw new IllegalArgumentException("realm");
         }
 
-        postUserEvent("user-deleted", user, realm);
+        postUserEvent("user-deleted", user, realm, null);
     }
 
-    private void postUserEvent(final String key, final UserModel user, final RealmModel realm) {
+    private void postUserEvent(final String key, final UserModel user, final RealmModel realm,
+            final HashMap<String, String> additionalData) {
         if (key == null) {
             throw new IllegalArgumentException("key");
         }
@@ -62,6 +67,10 @@ private void postUserEvent(final String key, final UserModel user, final RealmMo
         putIfNotNull(data, "userName", user.getUsername());
         putIfNotNull(data, "realm", realm.getName());
 
+        if (additionalData != null) {
+            data.putAll(additionalData);
+        }
+
         try {
             this.addEntriesToRedisStream(key, data);
             log.debugf("A new %s event has been forwarded to Redis", key);

diff --git a/src/main/java/openfoodfacts/github/keycloak/utils/UserAttributes.java b/src/main/java/openfoodfacts/github/keycloak/utils/UserAttributes.java
@@ -0,0 +1,5 @@
+package openfoodfacts.github.keycloak.utils;
+
+public class UserAttributes {
+    public static final String NEWSLETTER = "newsletter";
+}
diff --git a/...ub/keycloak/events/EmailVerificationEventIsForwardedToRedisIfValidationIsEnabledTest.java b/...ub/keycloak/events/EmailVerificationEventIsForwardedToRedisIfValidationIsEnabledTest.java
@@ -34,7 +34,7 @@ void testRegisterEventIsForwarded() {
         openfoodfacts.github.keycloak.events.RedisEventListenerProviderFactory factory = new openfoodfacts.github.keycloak.events.RedisEventListenerProviderFactory();
         factory.init(Utils.createScope(redisURI));
 
-        KeycloakSessionFactory sessionFactory = Utils.createKeycloakSessionFactory(true, false);
+        KeycloakSessionFactory sessionFactory = Utils.createKeycloakSessionFactory(true, false, "subscribe");
         KeycloakSession session = sessionFactory.create();
         factory.postInit(sessionFactory);
         EventListenerProvider eventListenerProvider = factory.create(session);
@@ -74,6 +74,7 @@ public EventType getType() {
             Assertions.assertEquals("[email protected]", fields.get("email"));
             Assertions.assertEquals("theUserName", fields.get("userName"));
             Assertions.assertEquals("open-products-facts", fields.get("realm"));
+            Assertions.assertEquals("subscribe", fields.get("newsletter"));
         }
     }
 

diff --git a/src/test/java/openfoodfacts/github/keycloak/events/Utils.java b/src/test/java/openfoodfacts/github/keycloak/events/Utils.java
@@ -125,7 +125,8 @@ public Set<String> getPropertyNames() {
         };
     }
 
-    public static KeycloakSession createKeycloakSession(final boolean isVerifyEmail, final boolean isEmailVerified) {
+    public static KeycloakSession createKeycloakSession(final boolean isVerifyEmail, final boolean isEmailVerified,
+            final String userNewsletterAttribute) {
         return new KeycloakSession() {
 
             @Override
@@ -1850,7 +1851,11 @@ public void removeAttribute(String name) {
 
                                 @Override
                                 public String getFirstAttribute(String name) {
-                                    throw new UnsupportedOperationException("Unimplemented method 'getFirstAttribute'");
+                                    if ("newsletter".equals(name)) {
+                                        return userNewsletterAttribute;
+                                    }
+
+                                    return null;
                                 }
 
                                 @Override
@@ -2191,11 +2196,16 @@ public IdentityProviderStorageProvider identityProviders() {
     }
 
     public static KeycloakSessionFactory createKeycloakSessionFactory() {
-        return createKeycloakSessionFactory(true, false);
+        return createKeycloakSessionFactory(true, false, null);
     }
 
     public static KeycloakSessionFactory createKeycloakSessionFactory(final boolean isVerifyEmail,
             final boolean isEmailVerified) {
+        return createKeycloakSessionFactory(isVerifyEmail, isEmailVerified, null);
+    }
+
+    public static KeycloakSessionFactory createKeycloakSessionFactory(final boolean isVerifyEmail,
+            final boolean isEmailVerified, final String userNewsletterAttribute) {
         return new KeycloakSessionFactory() {
             private ProviderEventListener listener;
 
@@ -2225,7 +2235,7 @@ public void invalidate(KeycloakSession session, InvalidableObjectType type, Obje
 
             @Override
             public KeycloakSession create() {
-                return createKeycloakSession(isVerifyEmail, isEmailVerified);
+                return createKeycloakSession(isVerifyEmail, isEmailVerified, userNewsletterAttribute);
             }
 
             @Override