change type to time for ttl

darkweak · Jul 22, 2021 · 73fb9bf · 73fb9bf
1 parent ab38615
commit 73fb9bf
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 137 deletions.
diff --git a/cache/coalescing/requestCoalescing.go b/cache/coalescing/requestCoalescing.go
@@ -1,20 +1,19 @@
 package coalescing
 
 import (
+	"net/http"
+	"strings"
+	"time"
+
 	"github.com/darkweak/souin/cache/types"
 	"github.com/darkweak/souin/configurationtypes"
 	"github.com/darkweak/souin/rfc"
 	"golang.org/x/sync/singleflight"
-	"net/http"
-	"strings"
-	"time"
 )
 
 // Temporise will run one call to proxy then use the response for other requests that couldn't reach cached response
 func (r *RequestCoalescing) Temporise(req *http.Request, rw http.ResponseWriter, nextMiddleware func(http.ResponseWriter, *http.Request) error) {
-	key := rfc.GetCacheKey(req)
-	ch := r.requestGroup.DoChan(key, func() (interface{}, error) {
-		defer r.requestGroup.Forget(key)
+	ch := r.requestGroup.DoChan(rfc.GetCacheKey(req), func() (interface{}, error) {
 		e := nextMiddleware(rw, req)
 
 		return nil, e
@@ -61,7 +60,7 @@ func ServeResponse(
 	}
 	if "" != regexpURL {
 		u := retriever.GetConfiguration().GetUrls()[regexpURL]
-		if u.TTL != "" {
+		if u.TTL != 0 {
 			url.TTL = u.TTL
 		}
 		if len(u.Headers) != 0 {

diff --git a/cache/providers/badgerProvider.go b/cache/providers/badgerProvider.go
@@ -2,11 +2,11 @@ package providers
 
 import (
 	"fmt"
-	t "github.com/darkweak/souin/configurationtypes"
-	badger "github.com/dgraph-io/badger/v3"
-	"net/http"
 	"regexp"
 	"time"
+
+	t "github.com/darkweak/souin/configurationtypes"
+	badger "github.com/dgraph-io/badger/v3"
 )
 
 // Badger provider type
@@ -24,7 +24,7 @@ func BadgerConnectionFactory(_ t.AbstractConfigurationInterface) (*Badger, error
 // ListKeys method returns the list of existing keys
 func (provider *Badger) ListKeys() []string {
 	keys := []string{}
-	
+
 	e := provider.DB.View(func(txn *badger.Txn) error {
 		opts := badger.DefaultIteratorOptions
 		opts.PrefetchValues = false
@@ -66,37 +66,10 @@ func (provider *Badger) Get(key string) []byte {
 	return result
 }
 
-// Prefix method returns the populated response if exists, empty response then
-func (provider *Badger) Prefix(key string, req *http.Request) []byte {
-	var result []byte
-
-	_ = provider.DB.View(func(txn *badger.Txn) error {
-		prefix := []byte(key)
-		it := txn.NewIterator(badger.DefaultIteratorOptions)
-		defer it.Close()
-		for it.Seek(prefix); it.ValidForPrefix(prefix); it.Next() {
-			if varyVoter(key, req, string(it.Item().Key())) {
-				_ = it.Item().Value(func(val []byte) error {
-					result = val
-					return nil
-				})
-			}
-		}
-		return nil
-	})
-
-	return result
-}
-
 // Set method will store the response in Badger provider
 func (provider *Badger) Set(key string, value []byte, url t.URL, duration time.Duration) {
 	if duration == 0 {
-		ttl, err := time.ParseDuration(url.TTL)
-		if err != nil {
-			ttl = 0
-			fmt.Println(err)
-		}
-		duration = ttl
+		duration = url.TTL
 	}
 
 	err := provider.DB.Update(func(txn *badger.Txn) error {

diff --git a/cache/providers/embeddedOlricProvider.go b/cache/providers/embeddedOlricProvider.go
@@ -3,23 +3,23 @@ package providers
 import (
 	"context"
 	"fmt"
+	"io/ioutil"
+	"os"
+	"time"
+
 	"github.com/buraksezer/olric"
 	"github.com/buraksezer/olric/config"
 	"github.com/buraksezer/olric/query"
 	t "github.com/darkweak/souin/configurationtypes"
 	"github.com/google/uuid"
 	"go.uber.org/zap"
 	"gopkg.in/yaml.v3"
-	"io/ioutil"
-	"net/http"
-	"os"
-	"time"
 )
 
 // EmbeddedOlric provider type
 type EmbeddedOlric struct {
-	dm       *olric.DMap
-	db       *olric.Olric
+	dm *olric.DMap
+	db *olric.Olric
 }
 
 func tryToLoadConfiguration(olricInstance *config.Config, olricConfiguration t.CacheProvider, logger *zap.Logger) (*config.Config, bool) {
@@ -124,33 +124,6 @@ func (provider *EmbeddedOlric) ListKeys() []string {
 	return keys
 }
 
-// Prefix method returns the populated response if exists, empty response then
-func (provider *EmbeddedOlric) Prefix(key string, req *http.Request) []byte {
-	c, err := provider.dm.Query(query.M{
-		"$onKey": query.M{
-			"$regexMatch": "^" + key,
-		},
-	})
-
-	if err != nil {
-		fmt.Println(fmt.Sprintf("An error occurred while trying to retrieve data in Olric: %s", err))
-		return []byte{}
-	}
-	defer c.Close()
-
-	res := []byte{}
-	err = c.Range(func(k string, v interface{}) bool {
-		if varyVoter(key, req, k) {
-			res = v.([]byte)
-			return false
-		}
-
-		return true
-	})
-
-	return res
-}
-
 // Get method returns the populated response if exists, empty response then
 func (provider *EmbeddedOlric) Get(key string) []byte {
 	val2, err := provider.dm.Get(key)
@@ -165,12 +138,7 @@ func (provider *EmbeddedOlric) Get(key string) []byte {
 // Set method will store the response in EmbeddedOlric provider
 func (provider *EmbeddedOlric) Set(key string, value []byte, url t.URL, duration time.Duration) {
 	if duration == 0 {
-		ttl, err := time.ParseDuration(url.TTL)
-		if err != nil {
-			ttl = 0
-			fmt.Println(err)
-		}
-		duration = ttl
+		duration = url.TTL
 	}
 
 	err := provider.dm.PutEx(key, value, duration)

diff --git a/cache/providers/olricProvider.go b/cache/providers/olricProvider.go
@@ -2,18 +2,18 @@ package providers
 
 import (
 	"fmt"
+	"time"
+
 	"github.com/buraksezer/olric/client"
 	"github.com/buraksezer/olric/config"
 	"github.com/buraksezer/olric/query"
 	t "github.com/darkweak/souin/configurationtypes"
-	"net/http"
-	"time"
 )
 
 // Olric provider type
 type Olric struct {
 	*client.Client
-	dm       *client.DMap
+	dm *client.DMap
 }
 
 // OlricConnectionFactory function create new Olric instance
@@ -63,33 +63,6 @@ func (provider *Olric) ListKeys() []string {
 	return keys
 }
 
-// Prefix method returns the populated response if exists, empty response then
-func (provider *Olric) Prefix(key string, req *http.Request) []byte {
-	c, err := provider.dm.Query(query.M{
-		"$onKey": query.M{
-			"$regexMatch": "^" + key,
-		},
-	})
-
-	if err != nil {
-		fmt.Println(fmt.Sprintf("An error occurred while trying to retrieve data in Olric: %s", err))
-		return []byte{}
-	}
-	defer c.Close()
-
-	res := []byte{}
-	err = c.Range(func(k string, v interface{}) bool {
-		if varyVoter(key, req, k) {
-			res = v.([]byte)
-			return false
-		}
-
-		return true
-	})
-
-	return res
-}
-
 // Get method returns the populated response if exists, empty response then
 func (provider *Olric) Get(key string) []byte {
 	val2, err := provider.dm.Get(key)
@@ -104,12 +77,7 @@ func (provider *Olric) Get(key string) []byte {
 // Set method will store the response in Olric provider
 func (provider *Olric) Set(key string, value []byte, url t.URL, duration time.Duration) {
 	if duration == 0 {
-		ttl, err := time.ParseDuration(url.TTL)
-		if err != nil {
-			ttl = 0
-			fmt.Println(err)
-		}
-		duration = ttl
+		duration = url.TTL
 	}
 
 	err := provider.dm.PutEx(key, value, duration)

diff --git a/configurationtypes/types.go b/configurationtypes/types.go
@@ -1,6 +1,10 @@
 package configurationtypes
 
-import "go.uber.org/zap"
+import (
+	"time"
+
+	"go.uber.org/zap"
+)
 
 // Port config
 type Port struct {
@@ -21,8 +25,8 @@ type Regex struct {
 
 //URL configuration
 type URL struct {
-	TTL     string   `yaml:"ttl"`
-	Headers []string `yaml:"headers"`
+	TTL     time.Duration `yaml:"ttl"`
+	Headers []string      `yaml:"headers"`
 }
 
 //CacheProvider config
@@ -39,7 +43,7 @@ type DefaultCache struct {
 	Olric       CacheProvider `yaml:"olric"`
 	Port        Port          `yaml:"port"`
 	Regex       Regex         `yaml:"regex"`
-	TTL         string        `yaml:"ttl"`
+	TTL         time.Duration `yaml:"ttl"`
 }
 
 // GetDistributed returns if it uses Olric or not as provider
@@ -63,7 +67,7 @@ func (d *DefaultCache) GetRegex() Regex {
 }
 
 // GetTTL returns the default TTL
-func (d *DefaultCache) GetTTL() string {
+func (d *DefaultCache) GetTTL() time.Duration {
 	return d.TTL
 }
 
@@ -73,7 +77,7 @@ type DefaultCacheInterface interface {
 	GetOlric() CacheProvider
 	GetHeaders() []string
 	GetRegex() Regex
-	GetTTL() string
+	GetTTL() time.Duration
 }
 
 // APIEndpoint is the minimal structure to define an endpoint

diff --git a/plugins/caddy/app.go b/plugins/caddy/app.go
@@ -4,7 +4,6 @@ import (
 	"github.com/caddyserver/caddy/v2"
 )
 
-// SouinApp contains the whole Souin necessary items
 type SouinApp struct {
 	*DefaultCache
 	LogLevel string `json:"log_level,omitempty"`
@@ -21,7 +20,7 @@ func (s *SouinApp) Provision(_ caddy.Context) error {
 
 // Start will start the App
 func (s SouinApp) Start() error {
-	if s.DefaultCache != nil && s.DefaultCache.TTL == "" {
+	if s.DefaultCache != nil && s.DefaultCache.TTL == "0s" {
 		return new(defaultCacheError)
 	}
 	return nil
@@ -33,7 +32,7 @@ func (s SouinApp) Stop() error {
 }
 
 // CaddyModule implements caddy.ModuleInfo
-func (s SouinApp) CaddyModule() caddy.ModuleInfo {
+func (a SouinApp) CaddyModule() caddy.ModuleInfo {
 	return caddy.ModuleInfo{
 		ID:  moduleName,
 		New: func() caddy.Module { return new(SouinApp) },

diff --git a/plugins/caddy/configuration.go b/plugins/caddy/configuration.go
@@ -1,6 +1,8 @@
 package caddy
 
 import (
+	"time"
+
 	"github.com/darkweak/souin/configurationtypes"
 	"go.uber.org/zap"
 )
@@ -11,7 +13,7 @@ type DefaultCache struct {
 	Headers     []string
 	Olric       configurationtypes.CacheProvider
 	Regex       configurationtypes.Regex
-	TTL         string
+	TTL         time.Duration
 }
 
 // GetDistributed returns if it uses Olric or not as provider
@@ -35,7 +37,7 @@ func (d *DefaultCache) GetRegex() configurationtypes.Regex {
 }
 
 // GetTTL returns the default TTL
-func (d *DefaultCache) GetTTL() string {
+func (d *DefaultCache) GetTTL() time.Duration {
 	return d.TTL
 }