release(v1.7.7) (#637)

* feat(chore): opt-out surrogate storage

* fix(ci): bump golangci-lint to latest (v2+)

* fix(ci): use golangci-lint-action v8

* fix(tests): revert condition to use surrogate if not disabled

* fix(disable_surrogate_key): add documentation

* fix(disable_surrogate_key): caddy

Author: darkweak

.github/workflows/non-regression.yml

@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
 
 env:
-  GO_VERSION: '1.22'
+  GO_VERSION: '1.24'
 
 jobs:
   lint-validation:
@@ -19,7 +19,7 @@ jobs:
         with:
           go-version: ${{ env.GO_VERSION }}
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v8
         with:
           args: --timeout=240s
   unit-test-golang:

.github/workflows/plugin_template.yml

@@ -34,11 +34,12 @@ jobs:
         uses: actions/checkout@v4
       - 
         name: golangci-lint
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v8
         with:
-          version: v1.59.1
+          version: latest
           working-directory: plugins/${{ inputs.LOWER_NAME }}
-          args: --exclude-dirs=override --timeout=240s
+          args: -c ../../.golangci.yml
+        if: ${{ ! startsWith(inputs.LOWER_NAME, 'traefik') }}
       -
         name: Run ${{ inputs.CAPITALIZED_NAME }} tests
         run: cd plugins/${{ inputs.LOWER_NAME }} && go test -v .
@@ -69,4 +70,4 @@ jobs:
         with:
           collection: "docs/e2e/Souin E2E.postman_collection.json"
           folder: '["${{ inputs.CAPITALIZED_NAME }}"]'
-          delayRequest: 5000
+          delayRequest: 5000

.github/workflows/plugins-master.yml

@@ -6,7 +6,7 @@ on:
       - master
 
 env:
-  GO_VERSION: '1.22'
+  GO_VERSION: '1.24'
 
 jobs:
   build-caddy-validator:

.github/workflows/plugins.yml

@@ -8,12 +8,6 @@ jobs:
     name: Caddy
     runs-on: ubuntu-latest
     services:
-      nats:
-        image: darkweak/nats
-        ports:
-          - 4222:4222
-          - 6222:6222
-          - 8222:8222
       redis:
         image: redis
         ports:
@@ -42,7 +36,7 @@ jobs:
         name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: '1.22'
+          go-version: '1.24'
       -
         name: Checkout code
         uses: actions/checkout@v4
@@ -91,7 +85,7 @@ jobs:
         name: Install Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.22'
+          go-version: '1.24'
 
       - name: Install Node.js
         uses: actions/setup-node@v4
@@ -164,74 +158,74 @@ jobs:
     with:
       CAPITALIZED_NAME: Beego
       LOWER_NAME: beego
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'
   build-chi-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Chi
       LOWER_NAME: chi
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'
   build-dotweb-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Dotweb
       LOWER_NAME: dotweb
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'
   build-echo-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Echo
       LOWER_NAME: echo
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'
   build-fiber-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Fiber
       LOWER_NAME: fiber
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'
   build-gin-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Gin
       LOWER_NAME: gin
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'
   build-goa-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Goa
       LOWER_NAME: goa
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'
   build-kratos-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Kratos
       LOWER_NAME: kratos
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'
   build-souin-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Souin
       LOWER_NAME: souin
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'
   build-traefik-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Traefik
       LOWER_NAME: traefik
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'
   build-webgo-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Webgo
       LOWER_NAME: webgo
-      GO_VERSION: '1.22'
+      GO_VERSION: '1.24'

.github/workflows/release.yml

@@ -5,7 +5,7 @@ on:
     tags: ["v*"]
 
 env:
-  GO_VERSION: '1.22'
+  GO_VERSION: '1.24'
 
 jobs:
   generate-souin-traefik-docker:

.github/workflows/workflow_plugins_generator.sh

@@ -3,7 +3,7 @@
 # Disabled go-zero and hertz temporary
 # plugins=("beego"  "chi"  "dotweb"  "echo"  "fiber"  "gin"  "goa"  "go-zero"  "hertz"  "kratos"  "roadrunner"  "souin"  "traefik"  "tyk"  "webgo")
 plugins=("beego"  "chi"  "dotweb"  "echo"  "fiber"  "gin"  "goa"  "kratos"  "souin"  "traefik"  "webgo")
-go_version=1.22
+go_version=1.24
 
 IFS= read -r -d '' tpl <<EOF
 name: Build and validate Souin as plugins
@@ -93,7 +93,7 @@ jobs:
         name: Install Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.22'
+          go-version: '1.24'
 
       - name: Install Node.js
         uses: actions/setup-node@v4
@@ -177,4 +177,4 @@ for i in ${!plugins[@]}; do
 EOF
   workflow+="$tpl"
 done
-echo "${workflow%$'\n'}" >  "$( dirname -- "$0"; )/plugins.yml"
+echo "${workflow%$'\n'}" >  "$( dirname -- "$0"; )/plugins.yml"

.golangci.yml

@@ -0,0 +1,11 @@
+version: "2"
+
+issues:
+  fix: true
+
+linters:
+  disable:
+    - staticcheck
+
+run:
+  timeout: 5m

Makefile

@@ -147,9 +147,9 @@ generate-workflow: ## Generate plugin workflow
 	bash .github/workflows/workflow_plugins_generator.sh
 
 golangci-lint: ## Run golangci-lint to ensure the code quality
-	docker run --rm -v $(PWD):/app -w /app golangci/golangci-lint:latest golangci-lint run -v --timeout 180s ./...
-	for plugin in $(PLUGINS_LIST) ; do \
-		echo "Starting lint $$plugin \n" && docker run --rm -v $(PWD):/app -w /app golangci/golangci-lint:latest golangci-lint run -v --exclude-dirs=override --timeout 240s ./plugins/$$plugin; \
+	golangci-lint run -v ./...
+	for plugin in $(MOD_PLUGINS_LIST) ; do \
+		echo "Starting lint $$plugin \n" && cd ./plugins/$$plugin && golangci-lint run -v -c ../../.golangci.yml ./...; cd -; \
 	done
 	cd plugins/caddy && go mod tidy && go mod download
 

README.md

@@ -202,7 +202,7 @@ surrogate_keys:
 | `cdn.service_id`                                  | The service id if required, depending the provider                                                                                          | `123456_id`                                                                                                                                                                                                                   |
 | `cdn.zone_id`                                     | The zone id if required, depending the provider                                                                                             | `anywhere_zone`                                                                                                                                                                                                               |
 | `default_cache.allowed_http_verbs`                | The HTTP verbs to support cache                                                                                                             | `- GET`<br/><br/>`- POST`<br/><br/>`(default: GET, HEAD)`                                                                                                                                                                     |
-| `default_cache.allowed_additional_status_codes`   | The additional HTTP status code to support cache                                                                                            | `- 200`<br/><br/>`- 404`                                                                                                                                                                     |
+| `default_cache.allowed_additional_status_codes`   | The additional HTTP status code to support cache                                                                                            | `- 200`<br/><br/>`- 404`                                                                                                                                                                                                      |
 | `default_cache.badger`                            | Configure the Badger cache storage                                                                                                          |                                                                                                                                                                                                                               |
 | `default_cache.badger.path`                       | Configure Badger with a file                                                                                                                | `/anywhere/badger_configuration.json`                                                                                                                                                                                         |
 | `default_cache.badger.configuration`              | Configure Badger directly in the Caddyfile or your JSON caddy configuration                                                                 | [See the Badger configuration for the options](https://dgraph.io/docs/badger/get-started/)                                                                                                                                    |
@@ -241,6 +241,9 @@ surrogate_keys:
 | `default_cache.redis.configuration`               | Configure Redis directly in the Caddyfile or your JSON caddy configuration                                                                  | [See the Go-redis configuration for the options](https://github.com/redis/go-redis/blob/master/options.go#L31) or [See the Rueidis configuration for the options](https://github.com/redis/rueidis/blob/master/rueidis.go#56) |
 | `default_cache.regex.exclude`                     | The regex used to prevent paths being cached                                                                                                | `^[A-z]+.*$`                                                                                                                                                                                                                  |
 | `default_cache.stale`                             | The stale duration                                                                                                                          | `25m`                                                                                                                                                                                                                         |
+| `default_cache.simplefs`                          | Configure the SimpleFS cache storage                                                                                                        |                                                                                                                                                                                                                               |
+| `default_cache.simplefs.configuration`            | Configure SimpleFS directly in the Caddyfile or your JSON caddy configuration                                                               |                                                                                                                                                                                                                               |
+| `default_cache.simplefs.configuration.size`       | Set the size of the pool in Otter                                                                                                           | `999999` (default `10000`)                                                                                                                                                                                                    |
 | `default_cache.timeout`                           | The timeout configuration                                                                                                                   |                                                                                                                                                                                                                               |
 | `default_cache.timeout.backend`                   | The timeout duration to consider the backend as unreachable                                                                                 | `10s`                                                                                                                                                                                                                         |
 | `default_cache.timeout.cache`                     | The timeout duration to consider the cache provider as unreachable                                                                          | `10ms`                                                                                                                                                                                                                        |
@@ -254,10 +257,23 @@ surrogate_keys:
 | `surrogate_keys.{key name}.headers`               | Headers that should match to be part of the surrogate key group                                                                             | `Authorization: ey.+`<br/><br/>`Content-Type: json`                                                                                                                                                                           |
 | `surrogate_keys.{key name}.headers.{header name}` | Header name that should be present a match the regex to be part of the surrogate key group                                                  | `Content-Type: json`                                                                                                                                                                                                          |
 | `surrogate_keys.{key name}.url`                   | Url that should match to be part of the surrogate key group                                                                                 | `.+`                                                                                                                                                                                                                          |
+| `disable_surrogate_key`                           | Disable the Surrogate keys storage system                                                                                                   | `true`                                                                                                                                                                                                                        |
 | `ykeys.{key name}.headers`                        | (DEPRECATED) Headers that should match to be part of the ykey group                                                                         | `Authorization: ey.+`<br/><br/>`Content-Type: json`                                                                                                                                                                           |
 | `ykeys.{key name}.headers.{header name}`          | (DEPRECATED) Header name that should be present a match the regex to be part of the ykey group                                              | `Content-Type: json`                                                                                                                                                                                                          |
 | `ykeys.{key name}.url`                            | (DEPRECATED) Url that should match to be part of the ykey group                                                                             | `.+`                                                                                                                                                                                                                          |
 
+## Storages
+Since `v1.7.0` Souin implements only one storage. If you need a specific storage you have to take it from [the storages repository](https://github.com/darkweak/storages) and add it either in your code, during the build otherwise. 
+
+Supported storages
+- [Badger](https://github.com/dgraph-io/badger)
+- [Etcd](https://github.com/etcd-io/etcd)
+- [NutsDB](https://github.com/nutsdb/nutsdb)
+- [Olric](https://github.com/buraksezer/olric)
+- [Otter](https://github.com/maypok86/otter)
+- [Redis](https://github.com/redis/redis)
+- [Simplefs](https://github.com/darkweak/storages)
+
 ## APIs
 All endpoints are accessible through the `api.basepath` configuration line or by default through `/souin-api` to avoid named route conflicts. Be sure to define an unused route to not break your existing application.
 
@@ -311,9 +327,12 @@ See the sequence diagram for the minimal version below
 ## Cache systems
 Supported providers
  - [Badger](https://github.com/dgraph-io/badger)
- - [NutsDB](https://github.com/nutsdb/nutsdb)
  - [Etcd](https://github.com/etcd-io/etcd)
+ - [NutsDB](https://github.com/nutsdb/nutsdb)
  - [Olric](https://github.com/buraksezer/olric)
+ - [Otter](https://github.com/maypok86/otter)
+ - [Redis](https://github.com/redis/redis)
+ - [Simplefs](https://github.com/darkweak/storages)
 
 The cache system sits on top of three providers at the moment. It provides two in-memory storage solutions (badger and nuts), and two distributed storages Olric and Etcd because setting, getting, updating and deleting keys in these providers is as easy as it gets.  
 **The Badger provider (default one)**: you can tune its configuration using the badger configuration inside your Souin configuration. In order to do that, you have to declare the `badger` block. See the following json example.
@@ -966,7 +985,7 @@ experimental:
   plugins:
     souin:
       moduleName: github.com/darkweak/souin
-      version: v1.7.6
+      version: v1.7.7
 ```
 After that you can declare either the whole configuration at once in the middleware block or by service. See the examples below.
 ```yaml

configurationtypes/types.go

@@ -106,7 +106,7 @@ func (c *CacheKeys) MarshalJSON() ([]byte, error) {
 	for _, cacheKey := range *c {
 		for rg, key := range cacheKey {
 			keyBytes, _ := json.Marshal(key)
-			strKeys = append(strKeys, fmt.Sprintf(`"%s": %v`, rg.Regexp.String(), string(keyBytes)))
+			strKeys = append(strKeys, fmt.Sprintf(`"%s": %v`, rg.String(), string(keyBytes)))
 		}
 	}
 
@@ -120,7 +120,7 @@ type Duration struct {
 
 // MarshalYAML transform the Duration into a time.duration object
 func (d *Duration) MarshalYAML() (interface{}, error) {
-	return yaml.Marshal(d.Duration.String())
+	return yaml.Marshal(d.String())
 }
 
 // UnmarshalYAML parse the time.duration into a Duration object
@@ -132,7 +132,7 @@ func (d *Duration) UnmarshalYAML(b *yaml.Node) (e error) {
 
 // MarshalJSON transform the Duration into a time.duration object
 func (d Duration) MarshalJSON() ([]byte, error) {
-	return json.Marshal(d.Duration.String())
+	return json.Marshal(d.String())
 }
 
 // UnmarshalJSON parse the time.duration into a Duration object
@@ -481,5 +481,6 @@ type AbstractConfigurationInterface interface {
 	SetLogger(core.Logger)
 	GetYkeys() map[string]SurrogateKeys
 	GetSurrogateKeys() map[string]SurrogateKeys
+	IsSurrogateDisabled() bool
 	GetCacheKeys() CacheKeys
 }