Handle SessionExpiredEvent for counting users

Author: LEDfan

src/main/java/eu/openanalytics/containerproxy/ContainerProxyApplication.java

@@ -41,6 +41,7 @@
 import org.springframework.core.env.Environment;
 import org.springframework.data.redis.connection.RedisConnectionFactory;
 import org.springframework.security.core.session.SessionRegistry;
+import org.springframework.security.web.session.HttpSessionEventPublisher;
 import org.springframework.session.FindByIndexNameSessionRepository;
 import org.springframework.session.Session;
 import org.springframework.session.data.redis.config.ConfigureRedisAction;
@@ -157,10 +158,10 @@ public JSR353Module jsr353Module() {
 	 *
 	 * @return
 	 */
-	@Bean
-	public static ConfigureRedisAction configureRedisAction() {
-		return ConfigureRedisAction.NO_OP;
-	}
+//	@Bean TODO TODO TODO https://aws.amazon.com/premiumsupport/knowledge-center/elasticache-redis-keyspace-notifications/ https://docs.spring.io/spring-session/docs/current/reference/html5/#api-redisindexedsessionrepository-sessiondestroyedevent
+//	public static ConfigureRedisAction configureRedisAction() {
+//		return ConfigureRedisAction.NO_OP;
+//	}
 
 	@Bean
 	@ConditionalOnProperty(name = "spring.session.store-type", havingValue = "redis")
@@ -190,6 +191,11 @@ public Health health() {
 		}
 	}
 
+	@Bean
+	public HttpSessionEventPublisher httpSessionEventPublisher() {
+		return new HttpSessionEventPublisher();
+	}
+
 	private static void setDefaultProperties(SpringApplication app) {
 		Properties properties = new Properties();
 

src/main/java/eu/openanalytics/containerproxy/event/ProxyStartEvent.java

@@ -1,3 +1,23 @@
+/**
+ * ContainerProxy
+ *
+ * Copyright (C) 2016-2020 Open Analytics
+ *
+ * ===========================================================================
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Apache License as published by
+ * The Apache Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * Apache License for more details.
+ *
+ * You should have received a copy of the Apache License
+ * along with this program.  If not, see <http://www.apache.org/licenses/>
+ */
 package eu.openanalytics.containerproxy.event;
 
 import org.springframework.context.ApplicationEvent;

src/main/java/eu/openanalytics/containerproxy/event/ProxyStartFailedEvent.java

@@ -1,3 +1,23 @@
+/**
+ * ContainerProxy
+ *
+ * Copyright (C) 2016-2020 Open Analytics
+ *
+ * ===========================================================================
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Apache License as published by
+ * The Apache Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * Apache License for more details.
+ *
+ * You should have received a copy of the Apache License
+ * along with this program.  If not, see <http://www.apache.org/licenses/>
+ */
 package eu.openanalytics.containerproxy.event;
 
 import org.springframework.context.ApplicationEvent;

src/main/java/eu/openanalytics/containerproxy/event/ProxyStopEvent.java

@@ -1,3 +1,23 @@
+/**
+ * ContainerProxy
+ *
+ * Copyright (C) 2016-2020 Open Analytics
+ *
+ * ===========================================================================
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the Apache License as published by
+ * The Apache Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * Apache License for more details.
+ *
+ * You should have received a copy of the Apache License
+ * along with this program.  If not, see <http://www.apache.org/licenses/>
+ */
 package eu.openanalytics.containerproxy.event;
 
 import org.springframework.context.ApplicationEvent;

src/main/java/eu/openanalytics/containerproxy/event/UserLogoutEvent.java

@@ -26,11 +26,20 @@ public class UserLogoutEvent extends ApplicationEvent {
 
     private final String userId;
     private final String sessionId;
+    private final Boolean wasExpired;
 
-    public UserLogoutEvent(Object source, String userId, String sessionId) {
+    /**
+     *
+     * @param source
+     * @param userId
+     * @param sessionId
+     * @param wasExpired whether the user is logged autoamtically because the session has expired
+     */
+    public UserLogoutEvent(Object source, String userId, String sessionId, Boolean wasExpired) {
         super(source);
         this.userId = userId;
         this.sessionId = sessionId;
+        this.wasExpired = wasExpired;
     }
 
     public String getSessionId() {
@@ -40,6 +49,10 @@ public String getSessionId() {
     public String getUserId() {
         return userId;
     }
+
+    public Boolean getWasExpired() {
+        return wasExpired;
+    }
 }
 
 

src/main/java/eu/openanalytics/containerproxy/service/UserService.java

@@ -20,21 +20,26 @@
  */
 package eu.openanalytics.containerproxy.service;
 
-import java.util.ArrayList;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
+import java.util.*;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
 
+import javax.annotation.PostConstruct;
 import javax.inject.Inject;
+import javax.servlet.http.HttpSession;
 
+import com.google.common.cache.*;
 import eu.openanalytics.containerproxy.event.AuthFailedEvent;
 import eu.openanalytics.containerproxy.event.UserLoginEvent;
 import eu.openanalytics.containerproxy.event.UserLogoutEvent;
+import org.apache.commons.lang3.tuple.Pair;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.apache.xpath.operations.Bool;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.ApplicationListener;
 import org.springframework.context.annotation.Lazy;
+import org.springframework.context.event.EventListener;
 import org.springframework.core.env.Environment;
 import org.springframework.security.authentication.AnonymousAuthenticationToken;
 import org.springframework.security.authentication.event.AbstractAuthenticationEvent;
@@ -43,7 +48,12 @@
 import org.springframework.security.authentication.event.InteractiveAuthenticationSuccessEvent;
 import org.springframework.security.core.Authentication;
 import org.springframework.security.core.GrantedAuthority;
+import org.springframework.security.core.context.SecurityContext;
 import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.security.core.session.SessionDestroyedEvent;
+import org.springframework.security.core.userdetails.User;
+import org.springframework.session.Session;
+import org.springframework.session.events.SessionExpiredEvent;
 import org.springframework.stereotype.Service;
 
 import eu.openanalytics.containerproxy.auth.IAuthenticationBackend;
@@ -183,7 +193,8 @@ public void onApplicationEvent(AbstractAuthenticationEvent event) {
 					this,
 					userId,
 					RequestContextHolder.currentRequestAttributes().getSessionId()));
-		} else if (event instanceof AuthenticationSuccessEvent || event instanceof InteractiveAuthenticationSuccessEvent) {
+		} else if (event instanceof AuthenticationSuccessEvent) {
+//		} else if (event instanceof AuthenticationSuccessEvent || event instanceof InteractiveAuthenticationSuccessEvent) {
 			String userName = source.getName();
 			log.info(String.format("User logged in [user: %s]", userName));
 			eventService.post(EventType.Login.toString(), userName, null);
@@ -198,22 +209,46 @@ public void onApplicationEvent(AbstractAuthenticationEvent event) {
 	}
 
 	public void logout(Authentication auth) {
+		// TODO test for anonymous users
 		String userId = getUserId(auth);
 		if (userId == null) return;
-		
-//		if (authentication.getPrincipal() instanceof UserDetails) {
-//			userName = ((UserDetails) authentication.getPrincipal()).getUsername();
-//		}
-		
+
 		eventService.post(EventType.Logout.toString(), userId, null);
 		if (logoutStrategy != null) logoutStrategy.onLogout(userId);
 		log.info(String.format("User logged out [user: %s]", userId));
 
-		// TODO test for anonymous users
+		String sessionId = RequestContextHolder.currentRequestAttributes().getSessionId();
 		applicationEventPublisher.publishEvent(new UserLogoutEvent(
 				this,
 				userId,
-				RequestContextHolder.currentRequestAttributes().getSessionId()));
+				sessionId,
+				false));
+	}
+
+	@EventListener
+	public void onSessionExpiredEvent(SessionExpiredEvent event) {
+		Session session = event.getSession();
+		String sessionId = session.getId();
+
+		Set<String> attributes = session.getAttributeNames();
+
+		for (String attributeName : attributes) {
+			Object attributeValue = session.getAttribute(attributeName);
+			if (attributeValue instanceof SecurityContext) {
+
+				Authentication authentication = ((SecurityContext) attributeValue).getAuthentication();
+				String userId = ((User) authentication.getPrincipal()).getUsername();
+
+				applicationEventPublisher.publishEvent(new UserLogoutEvent(
+						this,
+						userId,
+						sessionId,
+						true
+				));
+
+				break;
+			}
+		}
 	}
 
 }

src/main/java/eu/openanalytics/containerproxy/stat/impl/Micrometer.java

@@ -29,11 +29,18 @@
 import io.micrometer.core.instrument.Timer;
 import org.springframework.context.event.EventListener;
 import org.springframework.core.env.Environment;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.context.SecurityContext;
+import org.springframework.security.core.session.SessionDestroyedEvent;
+import org.springframework.security.core.userdetails.User;
 import org.springframework.stereotype.Component;
+import org.springframework.web.context.request.RequestContextHolder;
 
 import javax.annotation.PostConstruct;
 import javax.inject.Inject;
+import javax.servlet.http.HttpSession;
 import java.io.IOException;
+import java.security.Principal;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicLong;
 
@@ -58,6 +65,10 @@ public class Micrometer implements IStatCollector {
 
     private Counter authFailedCounter;
 
+    private Counter userLogins;
+
+    private Counter userLogouts;
+
     @PostConstruct
     public void init() {
         appsGauge = registry.gauge("apps", new AtomicInteger(0));
@@ -66,6 +77,8 @@ public void init() {
         appUsageTimer = registry.timer("usageTime");
         appStartFailedCounter = registry.counter("startFailed");
         authFailedCounter = registry.counter("authFailed");
+        userLogins = registry.counter("userLogins");
+        userLogouts = registry.counter("userLogouts");
     }
 
     @Override
@@ -74,48 +87,50 @@ public void accept(EventService.Event event, Environment env) throws IOException
             appsGauge.incrementAndGet();
         } else if (event.type.equals(EventService.EventType.ProxyStop.toString())) {
             appsGauge.decrementAndGet();
-        } else {
-            System.out.println("not processing events of this type yet");
         }
     }
 
     @EventListener
     public void onUserLogoutEvent(UserLogoutEvent event) {
+        // TODO in a HA setup this event should only be processed by one server
+        System.out.printf("UserLogoutEvent %s, %s, %s\n", event.getUserId(), event.getSessionId(), event.getWasExpired());
         loggedInUsersGauge.set(sessionInformation.getLoggedInUsersCount());
+        userLogouts.increment();
     }
 
     @EventListener
     public void onUserLoginEvent(UserLoginEvent event) {
+        System.out.printf("UserLoginEvent, %s, %s \n", event.getUserId(), event.getSessionId());
         loggedInUsersGauge.set(sessionInformation.getLoggedInUsersCount());
+        userLogins.increment();
     }
 
     @EventListener
     public void onProxyStartEvent(ProxyStartEvent event) {
-        System.out.printf("ProxyStartEvent %s, %s", event.getUserId(), event.getStartupTime());
+        System.out.printf("ProxyStartEvent %s ,%s\n", event.getUserId(), event.getStartupTime());
 
         appStartupTimer.record(event.getStartupTime());
     }
 
     @EventListener
     public void onProxyStopEvent(ProxyStopEvent event) {
-        System.out.printf("ProxyStopEvent %s, %s", event.getUserId(), event.getUsageTime());
+        System.out.printf("ProxyStopEvent %s, %s\n", event.getUserId(), event.getUsageTime());
 
         appUsageTimer.record(event.getUsageTime());
     }
 
     @EventListener
     public void onProxyStartFailedEvent(ProxyStartFailedEvent event) {
-        System.out.printf("ProxyStartFailedEvent %s, %s", event.getUserId(), event.getSpecId());
+        System.out.printf("ProxyStartFailedEvent %s, %s\n", event.getUserId(), event.getSpecId());
 
         appStartFailedCounter.increment();
     }
 
     @EventListener
     public void onAuthFailedEvent(AuthFailedEvent event) {
-        System.out.printf("AuthFailedEvent %s, %s", event.getUserId(), event.getSessionId());
+        System.out.printf("AuthFailedEvent %s, %s\n", event.getUserId(), event.getSessionId());
 
         authFailedCounter.increment();
     }
 
-
 }