Keycloak 18自定义EventListenerProvider更新事件详情失败排查

你的代码存在两个关键遗漏点，导致自定义orgId没有被正确添加到事件详情中：

1. 未正确注册事务到Keycloak事务管理器 #

你注释掉了keycloakSession.getTransactionManager().enlistAfterCompletion(tx);这行代码，而EventListenerTransaction必须被注册到Keycloak的事务管理器中，才能在事务完成后触发事件的持久化或后续处理。没有这一步，你添加到tx里的克隆事件根本不会被执行。

2. 事件修改逻辑的冗余与潜在问题 #

你克隆了事件并修改了克隆对象的详情，但实际上可以直接修改原事件的详情（Event类的setDetails方法是公开可写的），除非你需要保留原事件的原始状态。不过即使克隆，也必须确保事务被正确注册，否则修改后的事件无法生效。

修正后的代码示例 #

public TenantEventListenerProvider(KeycloakSession keycloakSession) {
    this.keycloakSession = keycloakSession;
    Consumer<Event> eventConsumer = this::processEvent;
    BiConsumer<AdminEvent, Boolean> adminEventConsumer = this::processAdminEvent;
    this.tx = new EventListenerTransaction(adminEventConsumer, eventConsumer);
    // 必须注册事务到Keycloak事务管理器，确保事件在事务完成后被处理
    keycloakSession.getTransactionManager().enlistAfterCompletion(tx);
}

@Override
public void onEvent(Event event) {
    LOGGER.infof("Event is %s", event);
    if (event.getType() == EventType.LOGIN || event.getType() == EventType.LOGIN_ERROR) {
        String userId = event.getUserId();
        String clientId = event.getClientId();
        String orgId = extractOrgId(event);

        // 直接修改原事件的详情，无需克隆（如果不需要保留原始详情的话）
        Map<String, String> eventDetails = new HashMap<>(event.getDetails() != null ? event.getDetails() : new HashMap<>());
        eventDetails.put("orgId", orgId);
        event.setDetails(eventDetails);

        LOGGER.infof("Captured Event: %s | User: %s | Tenant: %s | Client: %s",
            event.getType().name(), userId, orgId, clientId);
        tx.addEvent(event);
    }
}

额外注意事项 #

• 确保processEvent方法正确处理事件的持久化或后续逻辑，比如将事件保存到数据库或发送到外部系统。如果processEvent只是空实现或没有处理事件的持久化，那即使修改了事件也不会看到效果。
• 检查extractOrgId方法是否正确获取到了有效的orgId值，避免空值导致属性未被正确添加。
• Keycloak 18中，事件的处理是绑定到事务生命周期的，必须确保事务正常提交，否则事件可能不会被触发。

内容的提问来源于stack exchange，提问作者Pat's