Skip to content

Handling redis connection problems in cache implementation #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
megamattron wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Handling redis connection problems in cache implementation #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions app/controllers/RedisCacheMonitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

public class RedisCacheMonitor extends Controller {

public static void cacheInstance() {
public static void cacheInstance() throws RedisCacheImpl.JedisCheckedException {
if (RedisPlugin.isRedisCacheEnabled()) {
Map<String, Object> cacheInstanceInfo = new HashMap<String, Object>(2);
cacheInstanceInfo.put("host", RedisCacheImpl.getCacheConnection().getClient().getHost());
Expand All @@ -21,7 +21,7 @@ public static void cacheInstance() {
}
}

public static void cacheClientInfo() {
public static void cacheClientInfo() throws RedisCacheImpl.JedisCheckedException {
if (RedisPlugin.isRedisCacheEnabled()) {
String clientInfo = RedisCacheImpl.getCacheConnection().info();

Expand All @@ -41,7 +41,7 @@ public static void cacheClientInfo() {
}
}

public static void cacheContents() {
public static void cacheContents() throws RedisCacheImpl.JedisCheckedException {
if (RedisPlugin.isRedisCacheEnabled()) {
Set<String> keys = RedisCacheImpl.getCacheConnection().keys("*");

Expand Down
2 changes: 1 addition & 1 deletion conf/dependencies.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
self: play -> redis 0.3
self: play -> redis 0.4

require:
- play
Expand Down
197 changes: 125 additions & 72 deletions src/play/modules/redis/RedisCacheImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
package play.modules.redis;

import play.Logger;
import play.Play;
import play.cache.CacheImpl;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.exceptions.JedisDataException;
import redis.clients.jedis.exceptions.JedisException;

import java.io.*;
import java.util.HashMap;
Expand All @@ -28,29 +30,47 @@ static RedisCacheImpl getInstance() {
return uniqueInstance;
}

public static Jedis getCacheConnection() {
if (cacheConnection.get() != null) {
return cacheConnection.get();
}

Jedis connection = connectionPool.getResource();
cacheConnection.set(connection);
return connection;
public static class JedisCheckedException extends Exception {

}

public static Jedis getCacheConnection() throws JedisCheckedException {
try {
if (cacheConnection.get() != null) {
return cacheConnection.get();
}

Jedis connection = connectionPool.getResource();
cacheConnection.set(connection);
return connection;
} catch (JedisException e) {
Logger.warn(e, e.getMessage());
throw new JedisCheckedException();
}
}

public static void closeCacheConnection() {
if (cacheConnection.get() != null) {
connectionPool.returnResource(cacheConnection.get());
cacheConnection.remove();
public static void closeCacheConnection() throws JedisCheckedException {
try {
if (cacheConnection.get() != null) {
connectionPool.returnResource(cacheConnection.get());
cacheConnection.remove();
}
} catch (JedisException e) {
Logger.warn(e, e.getMessage());
throw new JedisCheckedException();
}
}

@Override
public void add(String key, Object value, int expiration) {
if (!getCacheConnection().exists(key)) {
set(key, value, expiration);
}
}
try {
if (!getCacheConnection().exists(key)) {
set(key, value, expiration);
}
} catch (JedisCheckedException e) {
Logger.warn("Unable to add " + key + " to redis cache due to previous exception.");
}
}

@Override
public boolean safeAdd(String key, Object value, int expiration) {
Expand All @@ -64,14 +84,18 @@ public boolean safeAdd(String key, Object value, int expiration) {

@Override
public void set(String key, Object value, int expiration) {
Jedis jedis = getCacheConnection();

// Serialize to a byte array
byte[] bytes = toByteArray(value);

jedis.set(key.getBytes(), bytes);
jedis.expire(key, expiration);
}
try {
Jedis jedis = getCacheConnection();

// Serialize to a byte array
byte[] bytes = toByteArray(value);

jedis.set(key.getBytes(), bytes);
jedis.expire(key, expiration);
} catch (JedisCheckedException e) {
Logger.warn("Unable to set " + key + " to redis cache due to previous exception.");
}
}

private static byte[] toByteArray(Object o) {
ObjectOutputStream out = null;
Expand Down Expand Up @@ -104,10 +128,14 @@ public boolean safeSet(String key, Object value, int expiration) {

@Override
public void replace(String key, Object value, int expiration) {
if (getCacheConnection().exists(key)) {
set(key, value, expiration);
}
}
try {
if (getCacheConnection().exists(key)) {
set(key, value, expiration);
}
} catch (JedisCheckedException e) {
Logger.error(e, e.getMessage());
}
}

@Override
public boolean safeReplace(String key, Object value, int expiration) {
Expand All @@ -121,11 +149,16 @@ public boolean safeReplace(String key, Object value, int expiration) {

@Override
public Object get(String key) {
byte[] bytes = getCacheConnection().get(key.getBytes());
if (bytes == null) return null;
try {
byte[] bytes = getCacheConnection().get(key.getBytes());
if (bytes == null) return null;

return fromByteArray(bytes);
}
return fromByteArray(bytes);
} catch (JedisCheckedException e) {
Logger.warn("Unable to get " + key + " to redis cache due to previous exception, returning null.");
return null;
}
}

private static Object fromByteArray(byte[] bytes) {

Expand Down Expand Up @@ -163,58 +196,74 @@ public Map<String, Object> get(String[] keys) {
public long incr(String key, int by) {
Object cacheValue = get(key);
long sum;
if (cacheValue == null) {
Long newCacheValueLong = Long.valueOf(0L + by);
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueLong));
sum = newCacheValueLong.longValue();
} else if (cacheValue instanceof Integer) {
Integer newCacheValueInteger = (Integer)cacheValue + by;
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueInteger));
sum = newCacheValueInteger.longValue();
} else if (cacheValue instanceof Long) {
Long newCacheValueLong = (Long)cacheValue + by;
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueLong));
sum = newCacheValueLong.longValue();
} else {
throw new JedisDataException("Cannot incr on non-integer value (key: " + key + ")");
}

return sum;
try {
if (cacheValue == null) {
Long newCacheValueLong = Long.valueOf(0L + by);
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueLong));
sum = newCacheValueLong.longValue();
} else if (cacheValue instanceof Integer) {
Integer newCacheValueInteger = (Integer)cacheValue + by;
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueInteger));
sum = newCacheValueInteger.longValue();
} else if (cacheValue instanceof Long) {
Long newCacheValueLong = (Long)cacheValue + by;
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueLong));
sum = newCacheValueLong.longValue();
} else {
throw new JedisDataException("Cannot incr on non-integer value (key: " + key + ")");
}
} catch (JedisCheckedException e) {
throw new JedisException("Cannot incr due to server problem (key: " + key + ")");
}

return sum;
}

@Override
public long decr(String key, int by) {
Object cacheValue = get(key);
long difference;
if (cacheValue == null) {
Long newCacheValueLong = Long.valueOf(0L - by);
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueLong));
difference = newCacheValueLong.longValue();
} else if (cacheValue instanceof Integer) {
Integer newCacheValueInteger = (Integer)cacheValue - by;
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueInteger));
difference = newCacheValueInteger.longValue();
} else if (cacheValue instanceof Long) {
Long newCacheValueLong = (Long)cacheValue - by;
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueLong));
difference = newCacheValueLong.longValue();
} else {
throw new JedisDataException("Cannot decr on non-integer value (key: " + key + ")");
}

return difference;
try {
if (cacheValue == null) {
Long newCacheValueLong = Long.valueOf(0L - by);
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueLong));
difference = newCacheValueLong.longValue();
} else if (cacheValue instanceof Integer) {
Integer newCacheValueInteger = (Integer)cacheValue - by;
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueInteger));
difference = newCacheValueInteger.longValue();
} else if (cacheValue instanceof Long) {
Long newCacheValueLong = (Long)cacheValue - by;
getCacheConnection().set(key.getBytes(), toByteArray(newCacheValueLong));
difference = newCacheValueLong.longValue();
} else {
throw new JedisDataException("Cannot decr on non-integer value (key: " + key + ")");
}
} catch (JedisCheckedException e) {
throw new JedisException("Cannot decr due to server problem (key: " + key + ")");
}

return difference;
}

@Override
public void clear() {
getCacheConnection().flushDB();
// TODO: check return status code
try {
getCacheConnection().flushDB();
} catch (JedisCheckedException e) {
Logger.error(e, "Couldn't clear cache due to error: " + e.getMessage());
}
// TODO: check return status code
}

@Override
public void delete(String key) {
getCacheConnection().del(key);
// TODO: check return status code
try {
getCacheConnection().del(key);
} catch (JedisCheckedException e) {
Logger.error(e, "Couldn't delete key " + key + " due to error: " + e.getMessage());
}
// TODO: check return status code
}

@Override
Expand All @@ -229,8 +278,12 @@ public boolean safeDelete(String key) {

@Override
public void stop() {
getCacheConnection().flushAll();
connectionPool.destroy();
try {
getCacheConnection().flushAll();
} catch (JedisCheckedException e) {
Logger.error(e, e.getMessage());
}
connectionPool.destroy();
}

}
8 changes: 6 additions & 2 deletions src/play/modules/redis/RedisPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,12 @@ public void onApplicationStop() {

@Override
public void invocationFinally() {
if (createdRedisCache) RedisCacheImpl.closeCacheConnection();
if (createdRedis) RedisConnectionManager.closeConnection();
try {
if (createdRedisCache) RedisCacheImpl.closeCacheConnection();
} catch (RedisCacheImpl.JedisCheckedException e) {
Logger.error(e, e.getMessage());
}
if (createdRedis) RedisConnectionManager.closeConnection();
}

private static class RedisConnectionInfo {
Expand Down