Issue.1555 zrange withscores arg (#1565)

michael-grunder · web-flow · commit 19f3efcfe6e1 · 2019-06-02T17:44:26.000-07:00
Allows ZRANGE to be called either with `true` or `['withscores' => true]` so it's consistent with `ZRANGEBYSCORE` but also backward compatible. Fixes #1555
diff --git a/redis_cluster.c b/redis_cluster.c
@@ -2440,7 +2440,7 @@ static void cluster_raw_cmd(INTERNAL_FUNCTION_PARAMETERS, char *kw, int kw_len)
     }
 
     /* We at least need the key or [host,port] argument */
-    if (argc<1) {
+    if (argc < 1) {
         php_error_docref(0 TSRMLS_CC, E_WARNING,
             "Command requires at least an argument to direct to a node");
         RETURN_FALSE;
@@ -3069,6 +3069,8 @@ PHP_METHOD(RedisCluster, xtrim) {
     CLUSTER_PROCESS_CMD(xtrim, cluster_long_resp, 0);
 }
 
+
+
 /* {{{ proto string RedisCluster::echo(string key, string msg)
  *     proto string RedisCluster::echo(array host_port, string msg) */
 PHP_METHOD(RedisCluster, echo) {
diff --git a/redis_commands.c b/redis_commands.c
@@ -491,6 +491,12 @@ int redis_fmt_scan_cmd(char **cmd, REDIS_SCAN_TYPE type, char *key, int key_len,
     return cmdstr.len;
 }
 
+/* ZRANGEBYSCORE/ZREVRANGEBYSCORE */
+#define IS_WITHSCORES_ARG(s, l) \
+    (l == sizeof("withscores") - 1 && !strncasecmp(s, "withscores", l))
+#define IS_LIMIT_ARG(s, l) \
+    (l == sizeof("limit") - 1 && !strncasecmp(s,"limit", l))
+
 /* ZRANGE/ZREVRANGE */
 int redis_zrange_cmd(INTERNAL_FUNCTION_PARAMETERS, RedisSock *redis_sock,
                      char *kw, char **cmd, int *cmd_len, int *withscores,
@@ -499,33 +505,43 @@ int redis_zrange_cmd(INTERNAL_FUNCTION_PARAMETERS, RedisSock *redis_sock,
     char *key;
     size_t key_len;
     zend_long start, end;
-    zend_bool ws = 0;
+    zend_string *zkey;
+    zval *z_ws = NULL, *z_ele;
 
-    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sll|b", &key, &key_len,
-                             &start, &end, &ws) == FAILURE)
+    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sll|z", &key, &key_len,
+                             &start, &end, &z_ws) == FAILURE)
     {
         return FAILURE;
     }
 
-    if (ws) {
+    // Clear withscores arg
+    *withscores = 0;
+
+    /* Accept ['withscores' => true], or the legacy `true` value */
+    if (z_ws) {
+        if (Z_TYPE_P(z_ws) == IS_ARRAY) {
+            ZEND_HASH_FOREACH_STR_KEY_VAL(Z_ARRVAL_P(z_ws), zkey, z_ele) {
+                ZVAL_DEREF(z_ele);
+                if (IS_WITHSCORES_ARG(ZSTR_VAL(zkey), ZSTR_LEN(zkey))) {
+                    *withscores = zval_is_true(z_ele);
+                    break;
+                }
+            } ZEND_HASH_FOREACH_END();
+        } else if (Z_TYPE_P(z_ws) == IS_TRUE) {
+            *withscores = Z_TYPE_P(z_ws) == IS_TRUE;
+        }
+    }
+
+    if (*withscores) {
         *cmd_len = REDIS_CMD_SPPRINTF(cmd, kw, "kdds", key, key_len, start, end,
             "WITHSCORES", sizeof("WITHSCORES") - 1);
     } else {
         *cmd_len = REDIS_CMD_SPPRINTF(cmd, kw, "kdd", key, key_len, start, end);
     }
 
-    // Push out WITHSCORES option
-    *withscores = ws;
-
     return SUCCESS;
 }
 
-/* ZRANGEBYSCORE/ZREVRANGEBYSCORE */
-#define IS_WITHSCORES_ARG(s, l) \
-    (l == sizeof("withscores") - 1 && !strncasecmp(s, "withscores", l))
-#define IS_LIMIT_ARG(s, l) \
-    (l == sizeof("limit") - 1 && !strncasecmp(s,"limit", l))
-
 int redis_zrangebyscore_cmd(INTERNAL_FUNCTION_PARAMETERS, RedisSock *redis_sock,
                             char *kw, char **cmd, int *cmd_len, int *withscores,
                             short *slot, void **ctx)
diff --git a/tests/RedisTest.php b/tests/RedisTest.php
@@ -2350,6 +2350,19 @@ public function testZX() {
         $this->assertTrue(0 === $this->redis->zRevRank('z', 'five'));
     }
 
+    public function testZRangeScoreArg() {
+        $this->redis->del('{z}');
+
+        $arr_mems = ['one' => 1.0, 'two' => 2.0, 'three' => 3.0];
+        foreach ($arr_mems as $str_mem => $score) {
+            $this->redis->zAdd('{z}', $score, $str_mem);
+        }
+
+        /* Verify we can pass true and ['withscores' => true] */
+        $this->assertEquals($arr_mems, $this->redis->zRange('{z}', 0, -1, true));
+        $this->assertEquals($arr_mems, $this->redis->zRange('{z}', 0, -1, ['withscores' => true]));
+    }
+
     public function testZRangeByLex() {
         /* ZRANGEBYLEX available on versions >= 2.8.9 */
         if(version_compare($this->version, "2.8.9", "lt")) {
