feat(storages): add simplefs (#17)

darkweak · web-flow · commit 88bb38dfa2b6 · 2024-10-27T15:38:42.000+01:00
* feat(storages): add simplefs

* fix(simplefs): don't return error if not getting the mapping key

* fix(simplefs): call Start to start the goroutine

* fix(go-redis): support TLS configuration

* feat(deps): bump go-redis client version

* feat(deps): bump to prepare the release
diff --git a/.github/workflows/generate_release.sh b/.github/workflows/generate_release.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-release=("badger"  "core"  "etcd"  "go-redis"  "nats"  "nuts"  "olric"  "otter"  "redis")
+release=("badger"  "core"  "etcd"  "go-redis"  "nats"  "nuts"  "olric"  "otter"  "redis"  "simplefs")
 
 IFS= read -r -d '' tpl <<EOF
 name: Tag submodules on release
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -210,3 +210,25 @@ jobs:
               ref: 'refs/tags/redis/caddy/${{ github.ref_name }}',
               sha: context.sha
             })
+      -
+        name: Create Simplefs tag
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.git.createRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: 'refs/tags/simplefs/${{ github.ref_name }}',
+              sha: context.sha
+            })
+      -
+        name: Create Simplefs caddy tag
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.git.createRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: 'refs/tags/simplefs/caddy/${{ github.ref_name }}',
+              sha: context.sha
+            })
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -46,6 +46,7 @@ jobs:
           - nuts
           - otter
           - redis
+          - simplefs
     name: Validate quality
     runs-on: ubuntu-latest
     steps:
diff --git a/Makefile b/Makefile
@@ -1,8 +1,8 @@
 .PHONY: bump-version dependencies generate-release golangci-lint unit-tests
 
-MODULES_LIST=badger core etcd go-redis nats nuts olric otter redis
-STORAGES_LIST=badger etcd go-redis nats nuts olric otter redis
-TESTS_LIST=badger core etcd go-redis nats nuts otter redis
+MODULES_LIST=badger core etcd go-redis nats nuts olric otter redis simplefs
+STORAGES_LIST=badger etcd go-redis nats nuts olric otter redis simplefs
+TESTS_LIST=badger core etcd go-redis nats nuts otter redis simplefs
 
 bump-version:
 	test $(from)
@@ -17,6 +17,7 @@ bump-version:
 	sed -i '' 's/github.com\/darkweak\/storages\/olric $(from)/github.com\/darkweak\/storages\/olric $(to)/' olric/caddy/go.mod
 	sed -i '' 's/github.com\/darkweak\/storages\/otter $(from)/github.com\/darkweak\/storages\/otter $(to)/' otter/caddy/go.mod
 	sed -i '' 's/github.com\/darkweak\/storages\/redis $(from)/github.com\/darkweak\/storages\/redis $(to)/' redis/caddy/go.mod
+	sed -i '' 's/github.com\/darkweak\/storages\/simplefs $(from)/github.com\/darkweak\/storages\/simplefs $(to)/' simplefs/caddy/go.mod
 
 	for storage in $(STORAGES_LIST) ; do \
 		sed -i '' 's/github.com\/darkweak\/storages\/core $(from)/github.com\/darkweak\/storages\/core $(to)/' $$storage/go.mod ; \
diff --git a/README.md b/README.md
@@ -13,3 +13,4 @@ Using caddy, you can build your instance using the following template `xcaddy bu
 * [Olric](https://github.com/buraksezer/olric)
 * [Otter](https://github.com/maypok86/otter)
 * [Redis](https://github.com/redis/rueidis)
+* [Simplefs](https://github.com/darkweak/simplefs)
diff --git a/badger/caddy/go.mod b/badger/caddy/go.mod
@@ -4,8 +4,8 @@ go 1.22.1
 
 require (
 	github.com/caddyserver/caddy/v2 v2.8.4
-	github.com/darkweak/storages/badger v0.0.10
-	github.com/darkweak/storages/core v0.0.10
+	github.com/darkweak/storages/badger v0.0.11
+	github.com/darkweak/storages/core v0.0.11
 )
 
 require (
diff --git a/badger/go.mod b/badger/go.mod
@@ -4,7 +4,7 @@ go 1.22.1
 
 require (
 	dario.cat/mergo v1.0.0
-	github.com/darkweak/storages/core v0.0.10
+	github.com/darkweak/storages/core v0.0.11
 	github.com/dgraph-io/badger/v3 v3.2103.5
 	github.com/pierrec/lz4/v4 v4.1.21
 	go.uber.org/zap v1.27.0
diff --git a/etcd/caddy/go.mod b/etcd/caddy/go.mod
@@ -4,8 +4,8 @@ go 1.22.1
 
 require (
 	github.com/caddyserver/caddy/v2 v2.8.4
-	github.com/darkweak/storages/core v0.0.10
-	github.com/darkweak/storages/etcd v0.0.10
+	github.com/darkweak/storages/core v0.0.11
+	github.com/darkweak/storages/etcd v0.0.11
 )
 
 require (
diff --git a/etcd/go.mod b/etcd/go.mod
@@ -5,7 +5,7 @@ go 1.22.1
 replace github.com/darkweak/storages/core => ../core
 
 require (
-	github.com/darkweak/storages/core v0.0.10
+	github.com/darkweak/storages/core v0.0.11
 	github.com/pierrec/lz4/v4 v4.1.21
 	go.etcd.io/etcd/client/v3 v3.5.14
 	go.uber.org/zap v1.27.0
diff --git a/go-redis/caddy/go.mod b/go-redis/caddy/go.mod
@@ -4,8 +4,8 @@ go 1.22.1
 
 require (
 	github.com/caddyserver/caddy/v2 v2.8.4
-	github.com/darkweak/storages/core v0.0.10
-	github.com/darkweak/storages/go-redis v0.0.10
+	github.com/darkweak/storages/core v0.0.11
+	github.com/darkweak/storages/go-redis v0.0.11
 )
 
 require (
@@ -75,7 +75,7 @@ require (
 	github.com/prometheus/procfs v0.12.0 // indirect
 	github.com/quic-go/qpack v0.4.0 // indirect
 	github.com/quic-go/quic-go v0.44.0 // indirect
-	github.com/redis/go-redis/v9 v9.5.4 // indirect
+	github.com/redis/go-redis/v9 v9.6.0 // indirect
 	github.com/rs/xid v1.5.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/shopspring/decimal v1.2.0 // indirect
diff --git a/go-redis/caddy/go.sum b/go-redis/caddy/go.sum
@@ -323,8 +323,8 @@ github.com/quic-go/qpack v0.4.0 h1:Cr9BXA1sQS2SmDUWjSofMPNKmvF6IiIfDRmgU0w1ZCo=
 github.com/quic-go/qpack v0.4.0/go.mod h1:UZVnYIfi5GRk+zI9UMaCPsmZ2xKJP7XBUvVyT1Knj9A=
 github.com/quic-go/quic-go v0.44.0 h1:So5wOr7jyO4vzL2sd8/pD9Kesciv91zSk8BoFngItQ0=
 github.com/quic-go/quic-go v0.44.0/go.mod h1:z4cx/9Ny9UtGITIPzmPTXh1ULfOyWh4qGQlpnPcWmek=
-github.com/redis/go-redis/v9 v9.5.4 h1:vOFYDKKVgrI5u++QvnMT7DksSMYg7Aw/Np4vLJLKLwY=
-github.com/redis/go-redis/v9 v9.5.4/go.mod h1:hdY0cQFCN4fnSYT6TkisLufl/4W5UIXyv0b/CLO2V2M=
+github.com/redis/go-redis/v9 v9.6.0 h1:NLck+Rab3AOTHw21CGRpvQpgTrAU4sgdCswqGtlhGRA=
+github.com/redis/go-redis/v9 v9.6.0/go.mod h1:hdY0cQFCN4fnSYT6TkisLufl/4W5UIXyv0b/CLO2V2M=
 github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
 github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
 github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
diff --git a/go-redis/go-redis.go b/go-redis/go-redis.go
@@ -3,6 +3,7 @@ package redis
 import (
 	"bytes"
 	"context"
+	"crypto/tls"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -51,6 +52,20 @@ func Factory(redisConfiguration core.CacheProvider, logger core.Logger, stale ti
 					hashtags = v
 				}
 			}
+
+			if value, ok := redisConfig["TLSConfig"]; ok {
+				tlsConfigBytes, err := json.Marshal(value)
+				if err != nil {
+					return nil, err
+				}
+
+				var tlsConfig tls.Config
+				if err = json.Unmarshal(tlsConfigBytes, &tlsConfig); err != nil {
+					return nil, err
+				}
+
+				options.TLSConfig = &tlsConfig
+			}
 		}
 	} else {
 		options = redis.UniversalOptions{
diff --git a/go-redis/go.mod b/go-redis/go.mod
@@ -5,9 +5,9 @@ go 1.22.1
 replace github.com/darkweak/storages/core => ../core
 
 require (
-	github.com/darkweak/storages/core v0.0.10
+	github.com/darkweak/storages/core v0.0.11
 	github.com/pierrec/lz4/v4 v4.1.21
-	github.com/redis/go-redis/v9 v9.5.4
+	github.com/redis/go-redis/v9 v9.6.0
 	go.uber.org/zap v1.27.0
 )
 
diff --git a/go-redis/go.sum b/go-redis/go.sum
@@ -14,8 +14,8 @@ github.com/pierrec/lz4/v4 v4.1.21 h1:yOVMLb6qSIDP67pl/5F7RepeKYu/VmTyEXvuMI5d9mQ
 github.com/pierrec/lz4/v4 v4.1.21/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/redis/go-redis/v9 v9.5.4 h1:vOFYDKKVgrI5u++QvnMT7DksSMYg7Aw/Np4vLJLKLwY=
-github.com/redis/go-redis/v9 v9.5.4/go.mod h1:hdY0cQFCN4fnSYT6TkisLufl/4W5UIXyv0b/CLO2V2M=
+github.com/redis/go-redis/v9 v9.6.0 h1:NLck+Rab3AOTHw21CGRpvQpgTrAU4sgdCswqGtlhGRA=
+github.com/redis/go-redis/v9 v9.6.0/go.mod h1:hdY0cQFCN4fnSYT6TkisLufl/4W5UIXyv0b/CLO2V2M=
 github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
diff --git a/go.work b/go.work
@@ -18,4 +18,6 @@ use (
 	./otter/caddy
 	./redis
 	./redis/caddy
+	./simplefs
+	./simplefs/caddy
 )
diff --git a/go.work.sum b/go.work.sum
@@ -279,6 +279,8 @@ github.com/rabbitmq/amqp091-go v1.2.0 h1:1pHBxAsQh54R9eX/xo679fUEAfv3loMqi0pvRFO
 github.com/rabbitmq/amqp091-go v1.2.0/go.mod h1:ogQDLSOACsLPsIq0NpbtiifNZi2YOz0VTJ0kHRghqbM=
 github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 h1:N/ElC8H3+5XpJzTSTfLsJV/mx9Q9g7kxmchpfZyxgzM=
 github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475/go.mod h1:bCqnVzQkZxMG4s8nGwiZ5l3QUCyqpo9Y+/ZMZ9VjZe4=
+github.com/redis/go-redis/v9 v9.6.0 h1:NLck+Rab3AOTHw21CGRpvQpgTrAU4sgdCswqGtlhGRA=
+github.com/redis/go-redis/v9 v9.6.0/go.mod h1:hdY0cQFCN4fnSYT6TkisLufl/4W5UIXyv0b/CLO2V2M=
 github.com/rs/zerolog v1.15.0 h1:uPRuwkWF4J6fGsJ2R0Gn2jB1EQiav9k3S6CSdygQJXY=
 github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo=
 github.com/ryanuber/columnize v2.1.0+incompatible h1:j1Wcmh8OrK4Q7GXY+V7SVSY8nUWQxHW5TkBe7YUl+2s=
diff --git a/nats/caddy/go.mod b/nats/caddy/go.mod
@@ -4,8 +4,8 @@ go 1.22.1
 
 require (
 	github.com/caddyserver/caddy/v2 v2.8.4
-	github.com/darkweak/storages/core v0.0.10
-	github.com/darkweak/storages/nats v0.0.10
+	github.com/darkweak/storages/core v0.0.11
+	github.com/darkweak/storages/nats v0.0.11
 )
 
 require (
diff --git a/nats/go.mod b/nats/go.mod
@@ -6,7 +6,7 @@ replace github.com/darkweak/storages/core => ../core
 
 require (
 	dario.cat/mergo v1.0.0
-	github.com/darkweak/storages/core v0.0.10
+	github.com/darkweak/storages/core v0.0.11
 	github.com/nats-io/nats.go v1.36.0
 	github.com/pierrec/lz4/v4 v4.1.21
 	go.uber.org/zap v1.27.0
diff --git a/nuts/caddy/go.mod b/nuts/caddy/go.mod
@@ -4,8 +4,8 @@ go 1.22.1
 
 require (
 	github.com/caddyserver/caddy/v2 v2.8.4
-	github.com/darkweak/storages/core v0.0.10
-	github.com/darkweak/storages/nuts v0.0.10
+	github.com/darkweak/storages/core v0.0.11
+	github.com/darkweak/storages/nuts v0.0.11
 )
 
 require (
diff --git a/nuts/go.mod b/nuts/go.mod
@@ -6,7 +6,7 @@ replace github.com/darkweak/storages/core => ../core
 
 require (
 	dario.cat/mergo v1.0.0
-	github.com/darkweak/storages/core v0.0.10
+	github.com/darkweak/storages/core v0.0.11
 	github.com/nutsdb/nutsdb v1.0.4
 	github.com/pierrec/lz4/v4 v4.1.21
 	go.uber.org/zap v1.27.0
diff --git a/olric/caddy/go.mod b/olric/caddy/go.mod
@@ -4,8 +4,8 @@ go 1.22.1
 
 require (
 	github.com/caddyserver/caddy/v2 v2.8.4
-	github.com/darkweak/storages/core v0.0.10
-	github.com/darkweak/storages/olric v0.0.10
+	github.com/darkweak/storages/core v0.0.11
+	github.com/darkweak/storages/olric v0.0.11
 )
 
 require (
diff --git a/olric/go.mod b/olric/go.mod
@@ -6,7 +6,7 @@ replace github.com/darkweak/storages/core => ../core
 
 require (
 	github.com/buraksezer/olric v0.5.6
-	github.com/darkweak/storages/core v0.0.10
+	github.com/darkweak/storages/core v0.0.11
 	github.com/pierrec/lz4/v4 v4.1.21
 	go.uber.org/zap v1.27.0
 )
diff --git a/otter/caddy/go.mod b/otter/caddy/go.mod
@@ -4,8 +4,8 @@ go 1.22.1
 
 require (
 	github.com/caddyserver/caddy/v2 v2.8.4
-	github.com/darkweak/storages/core v0.0.10
-	github.com/darkweak/storages/otter v0.0.10
+	github.com/darkweak/storages/core v0.0.11
+	github.com/darkweak/storages/otter v0.0.11
 )
 
 require (
diff --git a/otter/go.mod b/otter/go.mod
@@ -5,7 +5,7 @@ go 1.22.1
 replace github.com/darkweak/storages/core => ../core
 
 require (
-	github.com/darkweak/storages/core v0.0.10
+	github.com/darkweak/storages/core v0.0.11
 	github.com/maypok86/otter v1.2.1
 	github.com/pierrec/lz4/v4 v4.1.21
 	go.uber.org/zap v1.27.0
diff --git a/otter/otter.go b/otter/otter.go
@@ -64,7 +64,7 @@ func (provider *Otter) MapKeys(prefix string) map[string]string {
 	keys := map[string]string{}
 
 	provider.cache.Range(func(key string, val []byte) bool {
-		if !strings.HasPrefix(key, prefix) {
+		if strings.HasPrefix(key, prefix) {
 			k, _ := strings.CutPrefix(key, prefix)
 			keys[k] = string(val)
 		}
diff --git a/redis/caddy/go.mod b/redis/caddy/go.mod
@@ -4,8 +4,8 @@ go 1.22.1
 
 require (
 	github.com/caddyserver/caddy/v2 v2.8.4
-	github.com/darkweak/storages/core v0.0.10
-	github.com/darkweak/storages/redis v0.0.10
+	github.com/darkweak/storages/core v0.0.11
+	github.com/darkweak/storages/redis v0.0.11
 )
 
 require (
diff --git a/redis/go.mod b/redis/go.mod
@@ -5,7 +5,7 @@ go 1.22.1
 replace github.com/darkweak/storages/core => ../core
 
 require (
-	github.com/darkweak/storages/core v0.0.10
+	github.com/darkweak/storages/core v0.0.11
 	github.com/pierrec/lz4/v4 v4.1.21
 	github.com/redis/rueidis v1.0.39
 	go.uber.org/zap v1.27.0
diff --git a/simplefs/caddy/Caddyfile b/simplefs/caddy/Caddyfile
@@ -0,0 +1,20 @@
+{
+    debug
+    cache {
+        simplefs
+    }
+}
+
+http://localhost {
+    route /hello {
+        cache
+    }
+
+    route /any {
+        cache {
+            simplefs {
+                size 100000
+            }
+        }
+    }
+}
diff --git a/simplefs/caddy/Makefile b/simplefs/caddy/Makefile
@@ -0,0 +1,7 @@
+.PHONY:
+
+build:
+	go mod tidy
+	go mod download
+	XCADDY_RACE_DETECTOR=1 XCADDY_DEBUG=1 xcaddy build --with github.com/darkweak/storages/core=../../core/ --with github.com/darkweak/storages/simplefs=../ --with github.com/darkweak/storages/simplefs/caddy=./
+	./caddy run
diff --git a/simplefs/caddy/go.mod b/simplefs/caddy/go.mod
diff --git a/simplefs/caddy/go.sum b/simplefs/caddy/go.sum
diff --git a/simplefs/caddy/simplefs.go b/simplefs/caddy/simplefs.go
diff --git a/simplefs/go.mod b/simplefs/go.mod
diff --git a/simplefs/go.sum b/simplefs/go.sum
diff --git a/simplefs/simplefs.go b/simplefs/simplefs.go
diff --git a/simplefs/simplefs_test.go b/simplefs/simplefs_test.go

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@ go 1.22.1`
`4`	`4`
`5`	`5`	`require (`
`6`	`6`	`github.com/caddyserver/caddy/v2 v2.8.4`
`7`		`- github.com/darkweak/storages/badger v0.0.10`
`8`		`- github.com/darkweak/storages/core v0.0.10`
	`7`	`+ github.com/darkweak/storages/badger v0.0.11`
	`8`	`+ github.com/darkweak/storages/core v0.0.11`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`require (`