Merge pull request #38 from ochom/dev

update ussd readme file

Author: ochom

cache/cache.go

@@ -3,8 +3,12 @@ package cache
 import (
 	"sync"
 	"time"
+
+	"github.com/ochom/gutils/env"
+	"github.com/ochom/gutils/logs"
 )
 
+var cacheWorkers int
 var memoryCache map[string]cacheItem
 var mut sync.Mutex
 
@@ -13,34 +17,42 @@ type V []byte
 
 // cacheItem ...
 type cacheItem struct {
-	key       string
-	value     V
+	value     []byte
 	createdAt time.Time
 	expiry    time.Duration
 	callBack  func()
 }
 
+// expired ...
+func (c cacheItem) expired() bool {
+	return time.Since(c.createdAt) > c.expiry
+}
+
 func init() {
+	cacheWorkers = env.Int("CACHE_TOTAL_WORKERS", 10)
 	memoryCache = make(map[string]cacheItem)
 	go CleanUp()
 }
 
 // Set ...
 func Set(key string, value V) {
-	SetWithExpiry(key, value, 0)
+	expiry := time.Hour * time.Duration(env.Int("MAX_CACHE_HOUR", 24))
+	SetWithExpiry(key, value, expiry)
 }
 
 // SetWithExpiry ...
 func SetWithExpiry(key string, value V, expiry time.Duration) {
-	SetWithCallback(key, value, expiry, nil)
+	callback := func() {
+		logs.Info("Session item expired: %s", key)
+	}
+	SetWithCallback(key, value, expiry, callback)
 }
 
 // SetWithCallback ...
 func SetWithCallback(key string, value V, expiry time.Duration, callback func()) {
 	mut.Lock()
 	defer mut.Unlock()
 	item := cacheItem{
-		key:       key,
 		value:     value,
 		createdAt: time.Now(),
 		expiry:    expiry,
@@ -62,17 +74,45 @@ func Get(key string) V {
 	return item.value
 }
 
+// Delete ...
+func Delete(key string) {
+	mut.Lock()
+	defer mut.Unlock()
+	delete(memoryCache, key)
+}
+
 // CleanUp deletes expired cache items and calls their callbacks
 func CleanUp() {
-	tk := time.NewTicker(time.Millisecond * 20)
+	jobs := make(chan cacheItem, 100)
+
+	//  start workers
+	for i := 0; i < cacheWorkers; i++ {
+		go runCallbacks(jobs)
+	}
+
+	tick(jobs)
+}
+
+// tick to run the ticker
+func tick(jobs chan<- cacheItem) {
+	tk := time.NewTicker(time.Second) // every second
 	for range tk.C {
+		// acquire
+		mut.Lock()
 		for key, item := range memoryCache {
-			if item.expiry > 0 && time.Since(item.createdAt) > item.expiry {
+			if item.expired() {
+				jobs <- item
 				delete(memoryCache, key)
-				if item.callBack != nil {
-					item.callBack()
-				}
 			}
 		}
+
+		// release
+		mut.Unlock()
+	}
+}
+
+func runCallbacks(jobs <-chan cacheItem) {
+	for item := range jobs {
+		item.callBack()
 	}
 }

cache/cache_test.go

@@ -0,0 +1,45 @@
+package cache
+
+import (
+	"testing"
+	"time"
+)
+
+func TestSetWithExpiry(t *testing.T) {
+	type args struct {
+		key    string
+		value  V
+		expiry time.Duration
+	}
+	tests := []struct {
+		name string
+		args args
+	}{
+		{
+			name: "test 1",
+			args: args{
+				key:    "test",
+				value:  V("value"),
+				expiry: time.Second * 2,
+			},
+		},
+		{
+			name: "test 2",
+			args: args{
+				key:    "test123",
+				value:  V("value"),
+				expiry: time.Second * 1,
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			SetWithExpiry(tt.args.key, tt.args.value, tt.args.expiry)
+			time.Sleep(tt.args.expiry + time.Second)
+
+			if _, ok := memoryCache[tt.args.key]; ok {
+				t.Errorf("SetWithExpiry() = %v", ok)
+			}
+		})
+	}
+}

env/env.go

@@ -0,0 +1,76 @@
+package env
+
+import (
+	"os"
+	"strconv"
+
+	_ "github.com/joho/godotenv/autoload"
+	"github.com/ochom/gutils/logs"
+)
+
+// Get returns env variable or the provided default value when variable not found
+func Get(props ...string) string {
+	if len(props) == 0 {
+		logs.Error("Get Env: props cannot be empty")
+		return ""
+	}
+
+	key := props[0]
+	defaultValue := ""
+	if len(props) > 1 {
+		defaultValue = props[1]
+	}
+
+	value, ok := os.LookupEnv(key)
+	if !ok {
+		logs.Warn("Get Env: %s not found", key)
+		return defaultValue
+	}
+
+	return value
+}
+
+// Int returns an integer from env variable or the provided default value when variable not found
+func Int(key string, defaultValue int) int {
+	value, ok := os.LookupEnv(key)
+	if !ok {
+		return defaultValue
+	}
+
+	val, err := strconv.Atoi(value)
+	if err != nil {
+		return defaultValue
+	}
+
+	return val
+}
+
+// Bool returns a boolean from env variable or the provided default value when variable not found
+func Bool(key string, defaultValue bool) bool {
+	value, ok := os.LookupEnv(key)
+	if !ok {
+		return defaultValue
+	}
+
+	val, err := strconv.ParseBool(value)
+	if err != nil {
+		return defaultValue
+	}
+
+	return val
+}
+
+// Float returns a float from env variable or the provided default value when variable not found
+func Float(key string, defaultValue float64) float64 {
+	value, ok := os.LookupEnv(key)
+	if !ok {
+		return defaultValue
+	}
+
+	val, err := strconv.ParseFloat(value, 64)
+	if err != nil {
+		return defaultValue
+	}
+
+	return val
+}