added keys, hkeys, info, echo, rate-limit commands

Author: alash3al

README.md

@@ -10,6 +10,7 @@ Features
 - Very compatible with any `redis client` including `redis-cli`
 - Standalone with no external dependencies
 - Helpers commands for `Time`, `Encode <hex|md5|sha1|sha256|sha512> <payload>`, `RANDINT`, `RANDSTR`
+- Implements `RATELIMIT` helpers natively.
 
 Why
 ===
@@ -100,7 +101,9 @@ Supported Commands
 - `DEL <key1> [<key2> ...]`
 - `EXISTS <key>`
 - `INCR <key> [<by>]`
-- `TTL <key>` returns `-1` if key will never expire, `-2` if it doesn't exists (expired), other wise will returns the `seconds` remain before the key will expire.
+- `TTL <key>` returns `-1` if key will never expire, `-2` if it doesn't exists (expired), otherwise will returns the `seconds` remain before the key will expire.
+- `KEYS [<regexp-pattern>]`
+
 
 ## # HASHES
 > I enhanced the HASH MAP implementation and added some features like TTL per nested key,
@@ -116,6 +119,7 @@ Supported Commands
 - `HEXISTS <HASHMAP> [<key>]`.
 - `HINCR <HASHMAP> <key> [<by>]`
 - `HTTL <HASHMAP> <key>`, the same as `TTL` but for `HASHMAP`
+- `HKEYS <HASHMAP>`
 
 ## # LIST
 > I applied a new concept, you can push or push-unique values into the list,
@@ -146,6 +150,11 @@ Supported Commands
 - `WEBSOCKETOPEN <channel>`, opens a websocket endpoint and returns its id, so you can receive updates through `ws://server.address:port/stream/ws/{generated_id_here}`
 - `WEBSOCKETCLOSE <ID>`, closes the specified websocket endpoint using the above generated id. 
 
+## # Ratelimit
+- `RATELIMITSET <bucket> <limit> <seconds>`, create a new `$bucket` that accepts num of `$limit` of actions per the specified num of `$seconds`, it will returns `1` for success.
+- `RATELIMITTAKE <bucket>`, do an action in the specified `bucket` and take an item from it, it will return `-1` if the bucket not exists or it has unlimited actions `$limit < 1`, `0` if there are no more actions to be done right now, `reminder` of actions on success.
+- `RATELIMITGET <bucket>`, returns array [`$limit`, `$seconds`, `$remaining_time`, `$counter`] information for the specified bucket
+
 ## # Utils
 > a helpers commands
 
@@ -157,6 +166,8 @@ Supported Commands
 - `TIME`, returns the current time in `utc`, `seconds` and `nanoseconds`
 - `DBSIZE`, returns the database size in bytes.
 - `GC`, runs the Garbage Collector.
+- `ECHO [<arg1> <arg2> ...]`
+- `INFO`
 
 TODO
 =====

commands_hash.go

@@ -87,6 +87,7 @@ func hdelCommand(c Context) {
 func hgetallCommand(c Context) {
 	if len(c.args) < 1 {
 		c.WriteError("HGETALL command requires at least one argument: HGETALL <hashmap>")
+		return
 	}
 
 	prefix := c.args[0] + "/{HASH}/"
@@ -119,6 +120,42 @@ func hgetallCommand(c Context) {
 	}
 }
 
+// hkeysCommand - HKEYS <hashmap>
+func hkeysCommand(c Context) {
+	if len(c.args) < 1 {
+		c.WriteError("HKEYS command requires at least one argument: HKEYS <hashmap>")
+		return
+	}
+
+	prefix := c.args[0] + "/{HASH}/"
+	data := []string{}
+	err := c.db.Scan(kvstore.ScannerOptions{
+		FetchValues:   false,
+		IncludeOffset: true,
+		Prefix:        prefix,
+		Offset:        prefix,
+		Handler: func(k, _ string) bool {
+			p := strings.SplitN(k, "/{HASH}/", 2)
+			if len(p) < 2 {
+				return true
+			}
+			data = append(data, p[1])
+			return true
+		},
+	})
+
+	if err != nil {
+		c.WriteError(err.Error())
+		return
+	}
+
+	c.WriteArray(len(data))
+
+	for _, k := range data {
+		c.WriteBulkString(k)
+	}
+}
+
 // hmsetCommand - HMSET <HASHMAP> <key1> <val1> [<key2> <val2> ...]
 func hmsetCommand(c Context) {
 	var ns string
@@ -185,6 +222,7 @@ func hexistsCommand(c Context) {
 	c.WriteInt(found)
 }
 
+// hincrCommand - HINCR <hash> <key> [<number>]
 func hincrCommand(c Context) {
 	if len(c.args) < 2 {
 		c.WriteError("HINCR command must has at least two arguments: HINCR <hash> <key> [number]")

commands_list.go

@@ -87,7 +87,10 @@ func lrangeCommand(c Context) {
 		limit, _ = strconv.Atoi(c.args[2])
 	}
 
+	includeOffsetVals := false
+
 	if offset == "" {
+		includeOffsetVals = true
 		offset = prefix
 	} else {
 		of, err := hex.DecodeString(offset)
@@ -101,7 +104,7 @@ func lrangeCommand(c Context) {
 	data := []string{}
 	loaded := 0
 	err := c.db.Scan(kvstore.ScannerOptions{
-		IncludeOffset: true,
+		IncludeOffset: includeOffsetVals,
 		Offset:        offset,
 		Prefix:        prefix,
 		FetchValues:   true,

commands_ratelimit.go

@@ -0,0 +1,105 @@
+package main
+
+import (
+	"strconv"
+	"strings"
+	"time"
+)
+
+// ratelimitsetCommand - RATELIMITSET <bucket> <limit> <seconds>
+func ratelimitsetCommand(c Context) {
+	if len(c.args) < 3 {
+		c.WriteError("RATELMITSET command requires at least 3 arguments: RATELIMITSET <bucket> <limit> <seconds>")
+		return
+	}
+
+	bucket, limit, seconds := c.args[0], c.args[1], c.args[2]
+
+	if err := c.db.MSet(map[string]string{
+		"/{RATELIMITBUCKET}/" + bucket: limit + ";" + seconds,
+		"/{RATELIMITSTAT}/" + bucket + "/" + strconv.FormatInt(time.Now().Unix(), 10): "0",
+	}); err != nil {
+		c.WriteError(err.Error())
+		return
+	}
+
+	c.WriteInt(1)
+}
+
+// ratelimittakeCommand - RATELIMITTAKE <bucket>
+func ratelimittakeCommand(c Context) {
+	if len(c.args) < 1 {
+		c.WriteError("RATELIMITTAKE command requires at least 1 argument: RATELIMITTAKE <bucket>")
+		return
+	}
+
+	bucket := c.args[0]
+
+	meta, err := c.db.Get("/{RATELIMITBUCKET}/" + bucket)
+	if err != nil {
+		c.WriteInt(-1)
+		return
+	}
+
+	parts := strings.SplitN(meta, ";", 2)
+	if len(parts) < 2 {
+		c.db.Del([]string{"/{RATELIMITBUCKET}/" + bucket})
+		c.WriteInt(-1)
+		return
+	}
+
+	limit, _ := strconv.Atoi(parts[0])
+	seconds, _ := strconv.Atoi(parts[1])
+	now := int(time.Now().Unix())
+
+	if limit < 1 {
+		c.WriteInt(-1)
+		return
+	}
+
+	key := "/{RATELIMITSTAT}/" + bucket + "/" + strconv.Itoa(now/seconds)
+	reachedVal, _ := c.db.Get("/{RATELIMITSTAT}/" + bucket + "/" + strconv.Itoa(now/seconds))
+	reachedInt, _ := strconv.Atoi(reachedVal)
+
+	if reachedInt >= limit {
+		c.WriteInt(0)
+		return
+	}
+
+	val, err := c.db.Incr(key, 1)
+	if err != nil {
+		c.WriteError(err.Error())
+		return
+	}
+
+	c.WriteInt64(int64(limit) - val)
+}
+
+// ratelimitgetCommand - RATELIMITGET <bucket>
+func ratelimitgetCommand(c Context) {
+	if len(c.args) < 1 {
+		c.WriteError("RATELIMITGET command requires at least 1 argument: RATELIMITGET <bucket>")
+		return
+	}
+
+	bucket := c.args[0]
+
+	val, err := c.db.Get("/{RATELIMITBUCKET}/" + bucket)
+	if err != nil {
+		c.WriteInt(-1)
+		return
+	}
+
+	parts := strings.SplitN(val, ";", 2)
+	limit, _ := strconv.Atoi(parts[0])
+	seconds, _ := strconv.Atoi(parts[1])
+	now := time.Now().Unix()
+	val, _ = c.db.Get("/{RATELIMITSTAT}/" + bucket + "/" + strconv.Itoa(int(now/int64(seconds))))
+	reached, _ := strconv.Atoi(val)
+
+	c.WriteArray(4)
+	c.WriteInt(limit)
+	c.WriteInt(seconds)
+	c.WriteInt64(now / int64(seconds))
+	c.WriteInt(reached)
+}

commands_strings.go

@@ -2,7 +2,10 @@ package main
 
 import (
 	"fmt"
+	"regexp"
 	"strconv"
+
+	"github.com/alash3al/redix/kvstore"
 )
 
 // setCommand - SET <key> <value> [<TTL "millisecond">]
@@ -161,10 +164,50 @@ func incrCommand(c Context) {
 	c.WriteInt64(int64(val))
 }
 
+// ttlCommand - TTL <key>
 func ttlCommand(c Context) {
 	if len(c.args) < 1 {
 		c.WriteError("TTL command requires at least 1 argument, TTL <key>")
 		return
 	}
 	c.WriteInt64(int64(c.db.TTL(c.args[0])))
 }
+
+// keysCommand - KEYS [<regexp-pattern>]
+func keysCommand(c Context) {
+	var data []string
+	var pattern *regexp.Regexp
+	var err error
+
+	if len(c.args) > 0 {
+		pattern, err = regexp.CompilePOSIX(c.args[0])
+	}
+
+	if err != nil {
+		c.WriteError(err.Error())
+		return
+	}
+
+	err = c.db.Scan(kvstore.ScannerOptions{
+		FetchValues:   false,
+		IncludeOffset: true,
+		Handler: func(k, _ string) bool {
+			if pattern != nil && pattern.MatchString(k) {
+				data = append(data, k)
+			} else if nil == pattern {
+				data = append(data, k)
+			}
+			return true
+		},
+	})
+
+	if err != nil {
+		c.WriteError(err.Error())
+		return
+	}
+
+	c.WriteArray(len(data))
+	for _, k := range data {
+		c.WriteBulkString(k)
+	}
+}

commands_utils.go

@@ -141,3 +141,25 @@ func gcCommand(c Context) {
 	}
 	c.WriteInt(1)
 }
+
+// infoCommand - INFO
+func infoCommand(c Context) {
+	info := map[string]string{
+		"database":           *flagEngine,
+		"database_size":      strconv.Itoa(int(c.db.Size())),
+		"database_directory": *flagStorageDir,
+		"redis_port":         *flagRESPListenAddr,
+		"http_port":          *flagHTTPListenAddr,
+		"workers":            strconv.Itoa(*flagWorkers),
+	}
+
+	c.WriteArray(len(info))
+	for k, v := range info {
+		c.WriteBulkString(k + " : " + v)
+	}
+}
+
+// echoCommand - ECHO [<arg1> <arg2>]
+func echoCommand(c Context) {
+	c.WriteString(strings.Join(c.args, " "))
+}

helpers.go

@@ -34,9 +34,9 @@ func openDB(engine, dbpath string) (kvstore.DB, error) {
 	switch strings.ToLower(engine) {
 	default:
 		return nil, errors.New("unsupported engine: " + engine)
-	case "badger":
+	case "badger", "badgerdb":
 		return badger.OpenBadger(dbpath)
-	case "bolt":
+	case "bolt", "boltdb":
 		return bolt.OpenBolt(dbpath)
 	}
 }

main.go

@@ -8,7 +8,7 @@ import (
 
 func main() {
 	fmt.Printf("⇨ redix resp server available at: %s \n", color.GreenString(*flagRESPListenAddr))
-	fmt.Printf("⇨ redix http server available at: %s\n", color.GreenString(*flagHTTPListenAddr))
+	fmt.Printf("⇨ redix http server available at: %s \n", color.GreenString(*flagHTTPListenAddr))
 
 	err := make(chan error)
 

server_http.go

@@ -31,10 +31,7 @@ func initHTTPServer() error {
 	}
 
 	e.GET("/", func(c echo.Context) error {
-		return c.JSON(200, map[string]interface{}{
-			"success": true,
-			"message": "welcome to redix real-time db :)",
-		})
+		return c.JSON(200, "PONG ;)")
 	})
 
 	e.GET("/stream/ws/:userID", func(c echo.Context) error {

vars.go

@@ -35,6 +35,7 @@ var (
 		"exists": existsCommand,
 		"incr":   incrCommand,
 		"ttl":    ttlCommand,
+		"keys":   keysCommand,
 
 		// lists
 		"lpush":      lpushCommand,
@@ -54,6 +55,7 @@ var (
 		"hget":    hgetCommand,
 		"hdel":    hdelCommand,
 		"hgetall": hgetallCommand,
+		"hkeys":   hkeysCommand,
 		"hmset":   hmsetCommand,
 		"hexists": hexistsCommand,
 		"hincr":   hincrCommand,
@@ -76,13 +78,22 @@ var (
 		"time":    timeCommand,
 		"dbsize":  dbsizeCommand,
 		"gc":      gcCommand,
+		"info":    infoCommand,
+		"echo":    echoCommand,
+
+		// ratelimit
+		"ratelimitset":  ratelimitsetCommand,
+		"ratelimittake": ratelimittakeCommand,
+		"ratelimitget":  ratelimitgetCommand,
 	}
 
 	defaultPubSubAllTopic = "*"
 
 	supportedEngines = map[string]bool{
-		"badger": true,
-		"bolt":   true,
+		"badger":   true,
+		"badgerdb": true,
+		"bolt":     true,
+		"boltdb":   true,
 	}
 
 	redixBrand = `