v0.1.1

Author: donchev7

README.md

@@ -10,6 +10,35 @@
 [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=neurocode-io_cache-offloader&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=neurocode-io_cache-offloader)
 
 
+# Install
+
+pre go 1.15
+go get github.com/neurocode-io/cache-offloader@v0.1.1
+
+after go 1.15
+go install github.com/neurocode-io/cache-offloader@v0.1.1
+
+
+# Using the service
+
+This service provides a stale while revalidate cache for your HTTP requests. If a request is made to a URL that is already in the cache, the cache will be used. The cache will also be used if the cache is stale. However, an asynchronous request will be made to the server to refresh the cache if the cache is stale.
+
+Check out the `dev.env` file for configuration options.
+
+Essentially you can choose between in-memory or redis persistence. 
+
+Redis persistence is recommended when you have multiple processes running the service (or multiple pods).
+
+
+The environment variable CACHE_IGNORE_ENDPOINTS defines the endpoints that are allowed to passthrough without any checks from this service.
+
+You can also choose to incude query parameters in the cache key. `CACHE_SHOULD_HASH_QUERY` is a boolean flag that defines whether or not to hash the query parameters. 
+
+By `CACHE_HASH_QUERY_IGNORE` you can define which query parameters should be ignored when hashing the query.
+
+Another useful configuration option is `CACHE_STALE_WHILE_REVALIDATE_SEC`. This defines the time in seconds that the cache entry is considered stale and the cache is revalidated asynchronously.
+
+
 # Dev
 
 ```
@@ -27,11 +56,3 @@ http localhost:8000/probes/readiness
 ```
 go install github.com/golang/mock/mockgen@latest
 ```
-
-
-# Configuration
-... ADD MORE
-
-CACHE_IGNORE_ENDPOINTS=/management/prometheus, /api-docs
-
-Note that the environment variable CACHE_IGNORE_ENDPOINTS defines the endpoints that are allowed to passthrough without any checks from this service.

cmd/cache-offloader.go

@@ -4,16 +4,16 @@ import (
 	"strings"
 	"time"
 
+	"github.com/neurocode-io/cache-offloader/config"
+	"github.com/neurocode-io/cache-offloader/pkg/client"
+	"github.com/neurocode-io/cache-offloader/pkg/http"
+	"github.com/neurocode-io/cache-offloader/pkg/metrics"
+	"github.com/neurocode-io/cache-offloader/pkg/probes"
+	"github.com/neurocode-io/cache-offloader/pkg/storage"
+	"github.com/neurocode-io/cache-offloader/pkg/worker"
 	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 	"github.com/rs/zerolog/pkgerrors"
-	"neurocode.io/cache-offloader/config"
-	"neurocode.io/cache-offloader/pkg/client"
-	"neurocode.io/cache-offloader/pkg/http"
-	"neurocode.io/cache-offloader/pkg/metrics"
-	"neurocode.io/cache-offloader/pkg/probes"
-	"neurocode.io/cache-offloader/pkg/storage"
-	"neurocode.io/cache-offloader/pkg/worker"
 )
 
 func getInMemoryStorage(cfg config.Config) http.Cacher {

dev.env

@@ -1,6 +1,6 @@
 # ServerConfig
 SERVER_PORT=8000
-SERVER_LOG_LEVEL=ERROR
+SERVER_LOG_LEVEL=debug
 SERVER_STORAGE=memory
 DOWNSTREAM_HOST=http://httpbin.org
 SHUTDOWN_GRACE_PERIOD=30

go.mod

@@ -1,4 +1,4 @@
-module neurocode.io/cache-offloader
+module github.com/neurocode-io/cache-offloader
 
 go 1.18
 

pkg/client/redis.go

@@ -5,8 +5,8 @@ import (
 	"fmt"
 
 	"github.com/go-redis/redis/v8"
+	"github.com/neurocode-io/cache-offloader/config"
 	"github.com/rs/zerolog/log"
-	"neurocode.io/cache-offloader/config"
 )
 
 type RedisClient struct {

pkg/http/cache-mock_test.go

@@ -16,8 +16,8 @@ import (
 
 	"github.com/rs/zerolog/log"
 
-	"neurocode.io/cache-offloader/config"
-	"neurocode.io/cache-offloader/pkg/model"
+	"github.com/neurocode-io/cache-offloader/config"
+	"github.com/neurocode-io/cache-offloader/pkg/model"
 )
 
 //go:generate mockgen -source=./cache.go -destination=./cache-mock_test.go -package=http

pkg/http/cache.go

@@ -9,9 +9,9 @@ import (
 	"testing"
 
 	gomock "github.com/golang/mock/gomock"
+	"github.com/neurocode-io/cache-offloader/config"
+	"github.com/neurocode-io/cache-offloader/pkg/model"
 	"github.com/stretchr/testify/assert"
-	"neurocode.io/cache-offloader/config"
-	"neurocode.io/cache-offloader/pkg/model"
 )
 
 type responseMatcher struct {

pkg/http/cache_test.go

@@ -9,8 +9,8 @@ import (
 	"syscall"
 	"time"
 
+	"github.com/neurocode-io/cache-offloader/config"
 	"github.com/rs/zerolog/log"
-	"neurocode.io/cache-offloader/config"
 )
 
 type ServerOpts struct {

pkg/http/server.go

@@ -3,7 +3,7 @@ package storage
 import (
 	"time"
 
-	"neurocode.io/cache-offloader/pkg/model"
+	"github.com/neurocode-io/cache-offloader/pkg/model"
 )
 
 func getSize(value model.Response) float64 {