add timeout option to redis session store

Author: jknack

coverage-report/src/test/java/org/jooby/jedis/session/RedisSessionDataFeature.java

@@ -15,7 +15,8 @@ public class RedisSessionDataFeature extends ServerFeature {
 
   {
     use(ConfigFactory.empty()
-        .withValue("db", ConfigValueFactory.fromAnyRef("redis://localhost:6379")));
+        .withValue("db", ConfigValueFactory.fromAnyRef("redis://localhost:6379"))
+        .withValue("application.session.timeout", ConfigValueFactory.fromAnyRef(120)));
 
     use(new Redis());
 
@@ -34,10 +35,6 @@ public class RedisSessionDataFeature extends ServerFeature {
       return session.attributes();
     });
 
-    get("/destroy", req -> {
-      req.session().destroy();;
-      return "done";
-    });
   }
 
   @Test
@@ -52,11 +49,7 @@ public void save() throws Exception {
                 .expect(rsp -> {
                   assertTrue(rsp.equals("{name=edgar, age=34}")
                       || rsp.equals("{age=34, name=edgar}"));
-                }).request(r2 -> {
-                  // cleanup
-                    r2.get("/destroy")
-                        .expect("done");
-                  })
+                })
         );
 
   }

coverage-report/src/test/java/org/jooby/jedis/session/RedisSessionDataNoTimeoutFeature.java

@@ -0,0 +1,64 @@
+package org.jooby.jedis.session;
+
+import static org.junit.Assert.assertTrue;
+
+import org.jooby.Session;
+import org.jooby.jedis.Redis;
+import org.jooby.jedis.RedisSessionStore;
+import org.jooby.test.ServerFeature;
+import org.junit.Test;
+
+import com.typesafe.config.ConfigFactory;
+import com.typesafe.config.ConfigValueFactory;
+
+public class RedisSessionDataNoTimeoutFeature extends ServerFeature {
+
+  {
+    use(ConfigFactory.empty()
+        .withValue("db", ConfigValueFactory.fromAnyRef("redis://localhost:6379"))
+        .withValue("application.session.timeout", ConfigValueFactory.fromAnyRef("0")));
+
+    use(new Redis());
+
+    session(RedisSessionStore.class);
+
+    get("/s1", req -> {
+      Session session = req.session();
+      session
+          .set("name", "edgar")
+          .set("age", 34);
+      return session.attributes();
+    });
+
+    get("/s2", req -> {
+      Session session = req.session();
+      return session.attributes();
+    });
+
+    get("/destroy", req -> {
+      req.session().destroy();;
+      return "done";
+    });
+  }
+
+  @Test
+  public void save() throws Exception {
+    request()
+        .get("/s1")
+        .expect(rsp -> {
+          assertTrue(rsp.equals("{name=edgar, age=34}") || rsp.equals("{age=34, name=edgar}"));
+        })
+        .request(r1 ->
+            r1.get("/s2")
+                .expect(rsp -> {
+                  assertTrue(rsp.equals("{name=edgar, age=34}")
+                      || rsp.equals("{age=34, name=edgar}"));
+                }).request(r2 -> {
+                  // cleanup
+                    r2.get("/destroy")
+                        .expect("done");
+                  })
+        );
+
+  }
+}

jooby-jedis/src/main/java/org/jooby/jedis/RedisSessionStore.java

@@ -22,8 +22,10 @@
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.concurrent.TimeUnit;
 
 import javax.inject.Inject;
+import javax.inject.Named;
 import javax.inject.Singleton;
 
 import org.jooby.Session;
@@ -32,37 +34,133 @@
 import redis.clients.jedis.Jedis;
 import redis.clients.jedis.JedisPool;
 
+import com.typesafe.config.Config;
+import com.typesafe.config.ConfigFactory;
+import com.typesafe.config.ConfigValueFactory;
+
+/**
+ * A {@link Session.Store} powered by <a href="http://redis.io/">Redis</a>.
+ *
+ * <h2>usage</h2>
+ *
+ * <pre>
+ * {
+ *   use(new Redis());
+ *
+ *   session(RedisSessionStore.class);
+ *
+ *   get("/", req {@literal ->} {
+ *    req.session().set("name", "jooby");
+ *   });
+ * }
+ * </pre>
+ *
+ * The <code>name</code> attribute and value will be stored in a
+ * <a href="http://redis.io/">Redis</a> db.
+ *
+ * Session are persisted as
+ * a <a href="http://redis.io/topics/data-types#hashes">Redis Hash</a>.
+ *
+ * <h2>options</h2>
+ *
+ * <h3>timeout</h3>
+ * <p>
+ * By default, a redis session will expire after <code>30 minutes</code>. Changing the default
+ * timeout is as simple as:
+ * </p>
+ *
+ * <pre>
+ * # 8 hours
+ * session.timeout = 8h
+ *
+ * # 15 seconds
+ * session.timeout = 15
+ *
+ * # 120 minutes
+ * session.timeout = 120m
+ * </pre>
+ *
+ * If no timeout is required, use <code>-1</code>.
+ *
+ * <h3>key prefix</h3>
+ * <p>
+ * Default redis key prefix is <code>sessions</code>. Sessions in redis will look like:
+ * <code>sessions:ID</code>
+ *
+ * <p>
+ * It's possible to change the default key setting the <code>jedis.sesssion.prefix</code> properties
+ * </p>
+ *
+ * @author edgar
+ * @since 0.5.0
+ */
 @Singleton
 public class RedisSessionStore implements Session.Store {
 
   private JedisPool pool;
 
-  @Inject
-  public RedisSessionStore(final JedisPool pool) {
+  private int timeout;
+
+  private String prefix;
+
+  /**
+   * Creates a new {@link RedisSessionStore}.
+   *
+   * @param pool Jedis pool.
+   * @param prefix Session key prefix on redis.
+   * @param timeout Session timeout in seconds.
+   */
+  public RedisSessionStore(final JedisPool pool, final String prefix,
+      final int timeout) {
     this.pool = requireNonNull(pool, "Jedis pool is required.");
+    this.timeout = timeout;
+    this.prefix = requireNonNull(prefix, "Prefix is required.");
+  }
+
+  /**
+   * Creates a new {@link RedisSessionStore}.
+   *
+   * @param pool Jedis pool.
+   * @param prefix Session key prefix on redis.
+   * @param timeout Session timeout expression, like <code>30m</code>.
+   */
+  @Inject
+  public RedisSessionStore(final JedisPool pool,
+      final @Named("jedis.session.prefix") String prefix,
+      @Named("jedis.session.timeout") final String timeout) {
+    this(pool, prefix, seconds(timeout));
   }
 
   @Override
   public Session get(final Builder builder) {
     try (Jedis jedis = pool.getResource()) {
-      Map<String, String> attrs = jedis.hgetAll("sessions:" + builder.sessionId());
+      String key = key(builder.sessionId());
+      Map<String, String> attrs = jedis.hgetAll(key);
+      if (timeout > 0) {
+        // touch session
+        jedis.expire(key, timeout);
+      }
       return builder
-          .accessedAt(Long.parseLong(attrs.remove("accessedAt")))
-          .createdAt(Long.parseLong(attrs.remove("createdAt")))
-          .savedAt(Long.parseLong(attrs.remove("savedAt")))
-          .set(attrs).build();
+          .accessedAt(Long.parseLong(attrs.remove("_accessedAt")))
+          .createdAt(Long.parseLong(attrs.remove("_createdAt")))
+          .savedAt(Long.parseLong(attrs.remove("_savedAt")))
+          .set(attrs)
+          .build();
     }
   }
 
   @Override
   public void save(final Session session) {
     try (Jedis jedis = pool.getResource()) {
-      String key = "sessions:" + session.id();
+      String key = key(session);
       Map<String, String> attrs = new HashMap<>(session.attributes());
-      attrs.put("createdAt", Long.toString(session.createdAt()));
-      attrs.put("accessedAt", Long.toString(session.accessedAt()));
-      attrs.put("savedAt", Long.toString(session.savedAt()));
+      attrs.put("_createdAt", Long.toString(session.createdAt()));
+      attrs.put("_accessedAt", Long.toString(session.accessedAt()));
+      attrs.put("_savedAt", Long.toString(session.savedAt()));
       jedis.hmset(key, attrs);
+      if (timeout > 0) {
+        jedis.expire(key, timeout);
+      }
     }
   }
 
@@ -74,10 +172,26 @@ public void create(final Session session) {
   @Override
   public void delete(final String id) {
     try (Jedis jedis = pool.getResource()) {
-      String key = "sessions:" + id;
-      jedis.del(key);
+      jedis.del(key(id));
     }
 
   }
 
+  private String key(final String id) {
+    return prefix + ":" + id;
+  }
+
+  private String key(final Session session) {
+    return key(session.id());
+  }
+
+  private static int seconds(final String value) {
+    try {
+      return Integer.parseInt(value);
+    } catch (NumberFormatException ex) {
+      Config config = ConfigFactory.empty()
+          .withValue("timeout", ConfigValueFactory.fromAnyRef(value));
+      return (int) config.getDuration("timeout", TimeUnit.SECONDS);
+    }
+  }
 }

jooby-jedis/src/main/resources/org/jooby/jedis/jedis.conf

@@ -20,3 +20,7 @@ jedis.pool.timeBetweenEvictionRuns = -1
 jedis.pool.blockWhenExhausted = true
 jedis.pool.jmxEnabled = false
 jedis.pool.jmxNamePrefix = redis-pool
+
+# session store, key prefix and timeout in seconds 
+jedis.session.prefix = sessions
+jedis.session.timeout = ${application.session.timeout}