Merge pull request #15 from lstrojny/feature/eval

EVAL/EVALSHA support

Author: prog8

README.md

@@ -32,7 +32,7 @@ Configure the query parser plugin in `solrconfig.xml`. Add the following to the
 
 ### Allowed parameters for the RedisQParserPlugin:
 
- * **command** - Redis command. Currently allowed: `SMEMBERS`, `SRANDMEMBER`, `SDIFF`, `SINTER`, `SUNION`, `ZRANGE`, `ZREVRANGE`, `ZRANGEBYSCORE`, `ZREVRANGEBYSCORE`, `HKEYS`, `HMGET`, `HVALS`, `LRANGE`, `LINDEX`, `GET`, `MGET`, `KEYS`, `SORT` (required)
+ * **command** - Redis command. Currently allowed: `SMEMBERS`, `SRANDMEMBER`, `SDIFF`, `SINTER`, `SUNION`, `ZRANGE`, `ZREVRANGE`, `ZRANGEBYSCORE`, `ZREVRANGEBYSCORE`, `HKEYS`, `HMGET`, `HVALS`, `LRANGE`, `LINDEX`, `GET`, `MGET`, `KEYS`, `SORT`, `EVAL`, `EVALSHA` (required)
  * **key** - Key used to fetch data from Redis (required)
  * **operator** - Operator which connects terms taken from Redis. Allowed values are AND/OR (optional - default is OR)
  * **useAnalyzer** - Turns on and off query time analyzer true/false (optional - default is true)
@@ -75,6 +75,18 @@ SORT specific parameters:
  * **by** - Specify a different sort keys
  * **get\*** - Anything that starts with the prefix **get** is assumed to a redis SORT GET parameter
 
+EVAL specific parameters:
+ * **script** - Specify the LUA script to run
+ * **returns_hash** - Specify if a LUA table like the following should be treated as a hash: `{1.2, 'str1', 2.2, 'str2'}`
+ * **key\*** - Anything that starts with the prefix **key** is assumed to be a key
+ * **arg\*** - Anything that starts with the prefix **arg** is assumed to be an arg
+
+EVALSHA specific parameters:
+ * **sha1** - Specify the SHA1 hash of the stored script
+ * **returns_hash** - Specify if a LUA table like the following should be treated as a hash: `{1.2, 'str1', 2.2, 'str2'}`
+ * **key\*** - Anything that starts with the prefix **key** is assumed to be a key
+ * **arg\*** - Anything that starts with the prefix **arg** is assumed to be an arg
+
 Examples of usage:
  * `q=*:*&fq={!redis command=SMEMBERS key=some_key}field`
  * `q=*:*&fq={!redis command=SRANDMEMBER key=some_key count=2}field`

src/main/java/com/sematext/solr/redis/RedisQParser.java

@@ -1,6 +1,8 @@
 package com.sematext.solr.redis;
 
 import com.sematext.solr.redis.command.Command;
+import com.sematext.solr.redis.command.Eval;
+import com.sematext.solr.redis.command.EvalSha;
 import com.sematext.solr.redis.command.Get;
 import com.sematext.solr.redis.command.HGet;
 import com.sematext.solr.redis.command.HKeys;
@@ -75,13 +77,15 @@ final class RedisQParser extends QParser {
     commands.put("KEYS", new Keys());
 
     commands.put("SORT", new Sort());
+
+    commands.put("EVAL", new Eval());
+    commands.put("EVALSHA", new EvalSha());
   }
 
   private final JedisPool jedisPool;
   private Map<String, Float> results;
   private BooleanClause.Occur operator = BooleanClause.Occur.SHOULD;
   private final String redisCommand;
-  private final String redisKey;
   private final boolean useQueryTimeAnalyzer;
   private final int maxJedisRetries;
 
@@ -96,7 +100,6 @@ final class RedisQParser extends QParser {
     this.jedisPool = jedisPool;
 
     redisCommand = localParams.get("command") == null ? null : localParams.get("command").toUpperCase();
-    redisKey = localParams.get("key");
     final String operatorString = localParams.get("operator");
 
     if (redisCommand == null) {
@@ -107,11 +110,6 @@ final class RedisQParser extends QParser {
       throw new IllegalArgumentException(String.format("Wrong Redis command '%s'.", redisCommand));
     }
 
-    if (redisKey == null || redisKey.isEmpty()) {
-      log.error("No key argument passed to RedisQParser");
-      throw new IllegalArgumentException("No key argument passed to RedisQParser");
-    }
-
     operator = "AND".equalsIgnoreCase(operatorString) ? BooleanClause.Occur.MUST : BooleanClause.Occur.SHOULD;
 
     useQueryTimeAnalyzer = localParams.getBool("useAnalyzer", true);
@@ -125,7 +123,7 @@ public Query parse() throws SyntaxError {
     final BooleanQuery booleanQuery = new BooleanQuery(true);
     int booleanClausesTotal = 0;
 
-    fetchDataFromRedis(redisCommand, redisKey, maxJedisRetries);
+    fetchDataFromRedis(redisCommand, maxJedisRetries);
 
     if (results != null) {
       log.debug("Preparing a query for {} redis objects for field: {}", results.size(), fieldName);
@@ -178,20 +176,20 @@ public Query parse() throws SyntaxError {
     return booleanQuery;
   }
 
-  private void fetchDataFromRedis(final String redisCommand, final String redisKey, final int maxJedisRetries) {
+  private void fetchDataFromRedis(final String redisCommand, final int maxRetries) {
     int retries = 0;
     final Command command = commands.get(redisCommand);
 
-    while (results == null && retries++ < maxJedisRetries + 1) {
+    while (results == null && retries++ < maxRetries + 1) {
       Jedis jedis = null;
       try {
         jedis = jedisPool.getResource();
-        results = command.execute(jedis, redisKey, localParams);
+        results = command.execute(jedis, localParams);
         jedisPool.returnResource(jedis);
       } catch (final JedisException ex) {
         jedisPool.returnBrokenResource(jedis);
         log.debug("There was an error fetching data from redis. Retrying", ex);
-        if (retries >= maxJedisRetries + 1) {
+        if (retries >= maxRetries + 1) {
           throw ex;
         }
       }

src/main/java/com/sematext/solr/redis/RedisQParserPlugin.java

@@ -47,13 +47,13 @@ public QParser createParser(final String qstr, final SolrParams localParams, fin
   @Override
   public void init(final NamedList args) {
     final GenericObjectPoolConfig poolConfig = new GenericObjectPoolConfig();
-    poolConfig.setMaxTotal(getInteger(args, MAX_CONNECTIONS_FIELD, DEFAULT_MAX_CONNECTIONS));
+    poolConfig.setMaxTotal(getInt(args, MAX_CONNECTIONS_FIELD, DEFAULT_MAX_CONNECTIONS));
 
     final String host = getString(args, HOST_FIELD, HostAndPort.LOCALHOST_STR);
-    final Integer timeout = getInteger(args, TIMEOUT_FIELD, Protocol.DEFAULT_TIMEOUT);
+    final int timeout = getInt(args, TIMEOUT_FIELD, Protocol.DEFAULT_TIMEOUT);
     final String password = getString(args, PASSWORD_FIELD, null);
-    final Integer database = getInteger(args, DATABASE_FIELD, Protocol.DEFAULT_DATABASE);
-    retries = getInteger(args, RETRIES_FIELD, DEFAULT_RETRIES);
+    final int database = getInt(args, DATABASE_FIELD, Protocol.DEFAULT_DATABASE);
+    retries = getInt(args, RETRIES_FIELD, DEFAULT_RETRIES);
 
     log.info("Initializing RedisQParserPlugin with host: " + host);
     final String[] hostAndPort = host.split(":");
@@ -72,7 +72,7 @@ JedisPool createPool(final GenericObjectPoolConfig poolConfig, final String host
     return new JedisPool(poolConfig, host, port, timeout, password, database);
   }
 
-  private Integer getInteger(final NamedList args, final String key, final Integer def) {
+  private int getInt(final NamedList args, final String key, final int def) {
     final Object value = args != null ? args.get(key) : null;
     return value instanceof String ? Integer.parseInt((String) value) : def;
   }

src/main/java/com/sematext/solr/redis/command/Command.java

@@ -4,5 +4,5 @@
 import java.util.Map;
 
 public interface Command<T> {
-  Map<String, Float> execute(T client, String key, SolrParams params);
+  Map<String, Float> execute(T client, SolrParams params);
 }

src/main/java/com/sematext/solr/redis/command/Eval.java

@@ -0,0 +1,21 @@
+package com.sematext.solr.redis.command;
+
+import org.apache.solr.common.params.SolrParams;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import redis.clients.jedis.ScriptingCommands;
+import java.util.Map;
+
+public class Eval extends ScriptingCommand {
+  private static final Logger log = LoggerFactory.getLogger(Eval.class);
+
+  @Override
+  protected Map<String, Float> invokeCommand(final ScriptingCommands client, final SolrParams params,
+    final int keyLength, final String[] args) {
+    final String script = ParamUtil.assertGetStringByName(params, "script");
+
+    log.debug("Fetching EVAL from Redis for script: {}", script);
+
+    return createReturnValue(params, client.eval(script, keyLength, args));
+  }
+}

src/main/java/com/sematext/solr/redis/command/EvalSha.java

@@ -0,0 +1,21 @@
+package com.sematext.solr.redis.command;
+
+import org.apache.solr.common.params.SolrParams;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import redis.clients.jedis.ScriptingCommands;
+import java.util.Map;
+
+public class EvalSha extends ScriptingCommand {
+  private static final Logger log = LoggerFactory.getLogger(EvalSha.class);
+
+  @Override
+  protected Map<String, Float> invokeCommand(final ScriptingCommands client, final SolrParams params,
+    final int keyLength, final String[] args) {
+    final String sha1 = ParamUtil.assertGetStringByName(params, "sha1");
+
+    log.debug("Fetching EVALSHA from Redis for SHA1 sum: {}", sha1);
+
+    return createReturnValue(params, client.evalsha(sha1, keyLength, args));
+  }
+}

src/main/java/com/sematext/solr/redis/command/Get.java

@@ -11,7 +11,9 @@ public final class Get implements Command<JedisCommands> {
   private static final Logger log = LoggerFactory.getLogger(Get.class);
 
   @Override
-  public Map<String, Float> execute(final JedisCommands client, final String key, final SolrParams params) {
+  public Map<String, Float> execute(final JedisCommands client, final SolrParams params) {
+    final String key = ParamUtil.assertGetStringByName(params, "key");
+
     log.debug("Fetching GET from Redis for key: {}", key);
 
     return ResultUtil.stringIteratorToMap(Arrays.asList(client.get(key)));

src/main/java/com/sematext/solr/redis/command/HGet.java

@@ -11,12 +11,9 @@ public final class HGet implements Command<JedisCommands> {
   private static final Logger log = LoggerFactory.getLogger(HGet.class);
 
   @Override
-  public Map<String, Float> execute(final JedisCommands client, final String key, final SolrParams params) {
-    final String field = ParamUtil.getStringByName(params, "field", null);
-
-    if (field == null) {
-      throw new IllegalArgumentException("Required parameter \"field\" missing");
-    }
+  public Map<String, Float> execute(final JedisCommands client, final SolrParams params) {
+    final String key = ParamUtil.assertGetStringByName(params, "key");
+    final String field = ParamUtil.assertGetStringByName(params, "field");
 
     log.debug("Fetching HGET from Redis for key: {} ({})", key, field);
 

src/main/java/com/sematext/solr/redis/command/HKeys.java

@@ -10,7 +10,9 @@ public final class HKeys implements Command<JedisCommands> {
   private static final Logger log = LoggerFactory.getLogger(HKeys.class);
 
   @Override
-  public Map<String, Float> execute(final JedisCommands client, final String key, final SolrParams params) {
+  public Map<String, Float> execute(final JedisCommands client, final SolrParams params) {
+    final String key = ParamUtil.assertGetStringByName(params, "key");
+
     log.debug("Fetching HKEYS from Redis for key: {}", key);
 
     return ResultUtil.stringIteratorToMap(client.hkeys(key));

src/main/java/com/sematext/solr/redis/command/HMGet.java

@@ -10,7 +10,8 @@ public final class HMGet implements Command<JedisCommands> {
   private static final Logger log = LoggerFactory.getLogger(HMGet.class);
 
   @Override
-  public Map<String, Float> execute(final JedisCommands client, final String key, final SolrParams params) {
+  public Map<String, Float> execute(final JedisCommands client, final SolrParams params) {
+    final String key = ParamUtil.assertGetStringByName(params, "key");
     final String[] fields = ParamUtil.getStringByPrefix(params, "field");
 
     log.debug("Fetching HMGET from Redis for key: {} ({})", key, fields);