Add user client information to user metrics info (language, device cl…

…ass, name).

Add metrics logging for server start up, user disconnect, and card judging events.

WebContent/license.html

@@ -108,6 +108,9 @@ <h3>jQuery Cookie plugin</h3>
 
   <h2>Server</h2>
 
+This product includes GeoLite2 data created by MaxMind, available from
+<a href="http://www.maxmind.com">http://www.maxmind.com</a>.
+
   <h3>ANTLR</h3>
   Copyright (c) 2010 Terence Parr
   <br /> All rights reserved.

pom.xml

@@ -353,5 +353,15 @@
       <artifactId>geoip2</artifactId>
       <version>2.8.0</version>
     </dependency>
+    <dependency>
+      <groupId>net.sf.uadetector</groupId>
+      <artifactId>uadetector-core</artifactId>
+      <version>0.9.22</version>
+    </dependency>
+    <dependency>
+      <groupId>net.sf.uadetector</groupId>
+      <artifactId>uadetector-resources</artifactId>
+      <version>2014.10</version>
+    </dependency>
   </dependencies>
 </project>

src/main/java/net/socialgamer/cah/RequestWrapper.java

@@ -1,16 +1,16 @@
 /**
- * Copyright (c) 2012, Andy Janata
+ * Copyright (c) 2012-2017, Andy Janata
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without modification, are permitted
  * provided that the following conditions are met:
- * 
+ *
  * * Redistributions of source code must retain the above copyright notice, this list of conditions
  *   and the following disclaimer.
  * * Redistributions in binary form must reproduce the above copyright notice, this list of
  *   conditions and the following disclaimer in the documentation and/or other materials provided
  *   with the distribution.
- * 
+ *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
@@ -30,15 +30,15 @@
 
 /**
  * Wrap around an {@code HttpServletRequest}, to allow parameters to be retrieved by enum value.
- * 
+ *
  * @author Andy Janata ([email protected])
  */
 public class RequestWrapper {
   private final HttpServletRequest request;
 
   /**
    * Create a new RequestWrapper.
-   * 
+   *
    * @param request
    *          An {@code HttpServletRequest} to wrap around.
    */
@@ -48,7 +48,7 @@ public RequestWrapper(final HttpServletRequest request) {
 
   /**
    * Returns the value of a request parameter as a String, or null if the parameter does not exist.
-   * 
+   *
    * @param parameter
    *          Parameter to get.
    * @return Value of parameter, or null if parameter does not exist.
@@ -57,6 +57,18 @@ public String getParameter(final AjaxRequest parameter) {
     return request.getParameter(parameter.toString());
   }
 
+  /**
+   * Returns the value of a request header as a String, or {@code null} if the header does not
+   * exist.
+   *
+   * @param header
+   *          Header to get.
+   * @return Value of header, or {@code null} if header does not exist.
+   */
+  public String getHeader(final String header) {
+    return request.getHeader(header);
+  }
+
   /**
    * If there is an {@code X-Forwarded-For} header, the <strong>first</strong> entry in that list
    * is returned instead.

src/main/java/net/socialgamer/cah/StartupUtils.java

@@ -34,8 +34,10 @@
 import javax.servlet.ServletContextEvent;
 
 import net.socialgamer.cah.CahModule.ServerStarted;
+import net.socialgamer.cah.CahModule.UniqueId;
 import net.socialgamer.cah.cardcast.CardcastModule;
 import net.socialgamer.cah.cardcast.CardcastService;
+import net.socialgamer.cah.metrics.Metrics;
 import net.socialgamer.cah.task.BroadcastGameListUpdateTask;
 import net.socialgamer.cah.task.UserPingTask;
 
@@ -131,6 +133,10 @@ public void contextInitialized(final ServletContextEvent contextEvent) {
     reconfigureLogging(contextEvent.getServletContext());
     reloadProperties(contextEvent.getServletContext());
     CardcastService.hackSslVerifier();
+
+    // log that the server (re-)started to metrics logging (to flush all old games and users)
+    injector.getInstance(Metrics.class).serverStarted(
+        injector.getInstance(Key.get(String.class, UniqueId.class)));
   }
 
   public static void reloadProperties(final ServletContext context) {

src/main/java/net/socialgamer/cah/data/ConnectedUsers.java

@@ -142,7 +142,8 @@ public ErrorCode checkAndAdd(final User user) {
           logger.warn(String.format("Unable to get address for user %s (hostname: %s)",
               user.getNickname(), user.getHostname()), e);
         }
-        metrics.newUser(user.getPersistentId(), user.getSessionId(), geo);
+        metrics.newUser(user.getPersistentId(), user.getSessionId(), geo, user.getAgentName(),
+            user.getAgentType(), user.getAgentOs(), user.getAgentLanguage());
 
         return null;
       }
@@ -162,7 +163,7 @@ public void removeUser(final User user, final DisconnectReason reason) {
     synchronized (users) {
       if (users.containsKey(user.getNickname())) {
         logger.info(String.format("Removing user %s because %s", user.toString(), reason));
-        user.noLongerVaild();
+        user.noLongerValid();
         users.remove(user.getNickname().toLowerCase());
         notifyRemoveUser(user, reason);
       }
@@ -181,7 +182,7 @@ public User getUser(final String nickname) {
   }
 
   /**
-   * Broadcast to all remaining users that a user has left.
+   * Broadcast to all remaining users that a user has left. Also logs for metrics.
    *
    * @param user
    *          User that has left.
@@ -197,6 +198,8 @@ private void notifyRemoveUser(final User user, final DisconnectReason reason) {
       data.put(LongPollResponse.REASON, reason.toString());
       broadcastToAll(MessageType.PLAYER_EVENT, data);
     }
+
+    metrics.userDisconnect(user.getSessionId());
   }
 
   /**
@@ -226,7 +229,7 @@ else if (!u.isAdmin() && System.nanoTime() - u.getLastUserAction() > IDLE_TIMEOU
     // Do this later to not keep users locked
     for (final Entry<User, DisconnectReason> entry : removedUsers.entrySet()) {
       try {
-        entry.getKey().noLongerVaild();
+        entry.getKey().noLongerValid();
         notifyRemoveUser(entry.getKey(), entry.getValue());
         logger.info(String.format("Automatically kicking user %s due to %s", entry.getKey(),
             entry.getValue()));

src/main/java/net/socialgamer/cah/data/Game.java

@@ -56,8 +56,10 @@
 import net.socialgamer.cah.cardcast.CardcastService;
 import net.socialgamer.cah.data.GameManager.GameId;
 import net.socialgamer.cah.data.QueuedMessage.MessageType;
+import net.socialgamer.cah.metrics.Metrics;
 import net.socialgamer.cah.task.SafeTimerTask;
 
+import org.apache.commons.lang3.StringUtils;
 import org.apache.log4j.Logger;
 import org.hibernate.Session;
 
@@ -109,6 +111,7 @@ public class Game {
   private GameState state;
   private final GameOptions options = new GameOptions();
   private final Set<String> cardcastDeckIds = Collections.synchronizedSet(new HashSet<String>());
+  private final Metrics metrics;
 
   private int judgeIndex = 0;
 
@@ -194,14 +197,16 @@ public Game(@GameId final Integer id, final ConnectedUsers connectedUsers,
       final GameManager gameManager, final ScheduledThreadPoolExecutor globalTimer,
       final Provider<Session> sessionProvider,
       final Provider<CardcastService> cardcastServiceProvider,
-      @UniqueId final Provider<String> uniqueIdProvider) {
+      @UniqueId final Provider<String> uniqueIdProvider,
+      final Metrics metrics) {
     this.id = id;
     this.connectedUsers = connectedUsers;
     this.gameManager = gameManager;
     this.globalTimer = globalTimer;
     this.sessionProvider = sessionProvider;
     this.cardcastServiceProvider = cardcastServiceProvider;
     this.uniqueIdProvider = uniqueIdProvider;
+    this.metrics = metrics;
 
     state = GameState.LOBBY;
   }
@@ -683,10 +688,14 @@ public boolean start() {
             options.spectatorLimit, options.scoreGoal, players, currentUniqueId));
         // do this stuff outside the players lock; they will lock players again later for much less
         // time, and not at the same time as trying to lock users, which has caused deadlocks
+        final List<CardSet> cardSets;
         synchronized (options.cardSetIds) {
-          blackDeck = loadBlackDeck(session);
-          whiteDeck = loadWhiteDeck(session);
+          cardSets = loadCardSets(session);
+          blackDeck = loadBlackDeck(cardSets);
+          whiteDeck = loadWhiteDeck(cardSets);
         }
+        metrics.gameStart(currentUniqueId, cardSets, options.blanksInDeck, options.playerLimit,
+            options.scoreGoal, !StringUtils.isBlank(options.password));
         startNextRound();
         gameManager.broadcastGameListRefresh();
       }
@@ -698,7 +707,7 @@ public boolean start() {
     }
   }
 
-  private List<CardSet> loadCardSets(final Session session) {
+  public List<CardSet> loadCardSets(final Session session) {
     synchronized (options.cardSetIds) {
       try {
         final List<CardSet> cardSets = new ArrayList<>();
@@ -738,12 +747,12 @@ private List<CardSet> loadCardSets(final Session session) {
     }
   }
 
-  public BlackDeck loadBlackDeck(final Session session) {
-    return new BlackDeck(loadCardSets(session));
+  public BlackDeck loadBlackDeck(final List<CardSet> cardSets) {
+    return new BlackDeck(cardSets);
   }
 
-  public WhiteDeck loadWhiteDeck(final Session session) {
-    return new WhiteDeck(loadCardSets(session), options.blanksInDeck);
+  public WhiteDeck loadWhiteDeck(final List<CardSet> cardSets) {
+    return new WhiteDeck(cardSets, options.blanksInDeck);
   }
 
   public int getRequiredWhiteCardCount() {
@@ -752,21 +761,21 @@ public int getRequiredWhiteCardCount() {
 
   /**
    * Determine if there are sufficient cards in the selected card sets to start the game.
-   * <p>This could be done more efficiently as we're ending up loading the decks multiple times
-   * with different Sessions, so caching wouldn't help local decks.
    */
   public boolean hasEnoughCards(final Session session) {
     synchronized (options.cardSetIds) {
-      if (options.cardSetIds.isEmpty() && cardcastDeckIds.isEmpty()) {
+      final List<CardSet> cardSets = loadCardSets(session);
+
+      if (cardSets.isEmpty()) {
         return false;
       }
 
-      final BlackDeck tempBlackDeck = loadBlackDeck(session);
+      final BlackDeck tempBlackDeck = loadBlackDeck(cardSets);
       if (tempBlackDeck.totalCount() < MINIMUM_BLACK_CARDS) {
         return false;
       }
 
-      final WhiteDeck tempWhiteDeck = loadWhiteDeck(session);
+      final WhiteDeck tempWhiteDeck = loadWhiteDeck(cardSets);
       if (tempWhiteDeck.totalCount() < getRequiredWhiteCardCount()) {
         return false;
       }
@@ -1503,6 +1512,9 @@ public void process() {
       rescheduleTimer(task, ROUND_INTERMISSION);
     }
 
+    metrics.roundJudged(currentUniqueId, user.getSessionId(), cardPlayer.getUser().getSessionId(),
+        playedCards.cardsByUser());
+
     return null;
   }
 

src/main/java/net/socialgamer/cah/data/PlayerPlayedCardsTracker.java

@@ -1,16 +1,16 @@
 /**
- * Copyright (c) 2012, Andy Janata
+ * Copyright (c) 2012-2017, Andy Janata
  * All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without modification, are permitted
  * provided that the following conditions are met:
- * 
+ *
  * * Redistributions of source code must retain the above copyright notice, this list of conditions
  *   and the following disclaimer.
  * * Redistributions in binary form must reproduce the above copyright notice, this list of
  *   conditions and the following disclaimer in the documentation and/or other materials provided
  *   with the distribution.
- * 
+ *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
@@ -25,20 +25,19 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
-import net.socialgamer.cah.data.WhiteCard;
-
 
 /**
  * Class to track which card(s) have been played by players. Can get the card(s) for a player, and
  * also which player played a given card.
- * 
+ *
  * All methods in this class are synchronized.
- * 
+ *
  * @author Andy Janata ([email protected])
  */
 public class PlayerPlayedCardsTracker {
@@ -53,7 +52,7 @@ public class PlayerPlayedCardsTracker {
 
   /**
    * Add a played card to the mappings.
-   * 
+   *
    * @param player
    *          Player which played the card.
    * @param card
@@ -71,7 +70,7 @@ public synchronized void addCard(final Player player, final WhiteCard card) {
 
   /**
    * Get the {@code Player} that played a card, given the card's ID.
-   * 
+   *
    * @param id
    *          Card ID to check.
    * @return The {@code Player} that played the card.
@@ -82,7 +81,7 @@ public synchronized Player getPlayerForId(final int id) {
 
   /**
    * Determine whether a player has played any cards this round.
-   * 
+   *
    * @param player
    *          Player to check.
    * @return True if the player has played any cards this round.
@@ -102,7 +101,7 @@ public synchronized List<WhiteCard> getCards(final Player player) {
 
   /**
    * Remove and return a player's cards from the played cards tracking.
-   * 
+   *
    * @param player
    *          Player to remove.
    * @return The cards the player had played, or {@code null} if the player had not played cards.
@@ -143,4 +142,16 @@ public synchronized void clear() {
   public synchronized Collection<List<WhiteCard>> cards() {
     return playerCardMap.values();
   }
+
+  /**
+   * @return A {@code Map} of users to a {@code List} of the cards they played.
+   */
+  public synchronized Map<User, List<WhiteCard>> cardsByUser() {
+    final Map<User, List<WhiteCard>> cardsByUser = new HashMap<>();
+    // TODO java8: streams
+    for (final Map.Entry<Player, List<WhiteCard>> entry : playerCardMap.entrySet()) {
+      cardsByUser.put(entry.getKey().getUser(), entry.getValue());
+    }
+    return Collections.unmodifiableMap(cardsByUser);
+  }
 }