hotfix(caddy): dispatch with right values (#663)

* hotfix(caddy): dispatch with right badger storage

* bump(deps): plugins

* feat(caddy): bump to latest, tricky way with a channel to dispatch the configuration for the surrogate store

* bump(deps): plugins

* feat(go): bump to v1.25

* feat(caddy): implement validator interface

* fix(coalescing): disable on private or Set-Cookie

* feat(test-suite): separate caddy unit tests and e2e

Author: darkweak

.github/workflows/non-regression.yml

@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
 
 env:
-  GO_VERSION: '1.24'
+  GO_VERSION: '1.25'
 
 jobs:
   lint-validation:

.github/workflows/plugins-master.yml

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

.github/workflows/plugins.yml

@@ -5,6 +5,32 @@ on:
 
 jobs:
   build-caddy-validator:
+    name: Caddy
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Add domain.com host to /etc/hosts
+        run: |
+          sudo echo "127.0.0.1 domain.com etcd redis" | sudo tee -a /etc/hosts
+      -
+        name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: '1.25'
+      -
+        name: Checkout code
+        uses: actions/checkout@v4
+      -
+        name: Install xcaddy
+        run: go install github.com/caddyserver/xcaddy/cmd/xcaddy@latest
+      -
+        name: Build Souin as caddy module
+        run: cd plugins/caddy && xcaddy build --with github.com/darkweak/souin/plugins/caddy=./ --with github.com/darkweak/souin=../.. --with github.com/darkweak/storages/badger/caddy --with github.com/darkweak/storages/etcd/caddy --with github.com/darkweak/storages/nats/caddy --with github.com/darkweak/storages/nuts/caddy --with github.com/darkweak/storages/olric/caddy --with github.com/darkweak/storages/otter/caddy --with github.com/darkweak/storages/redis/caddy
+      -
+        name: Run Caddy tests
+        run: cd plugins/caddy && go test -v ./...
+  build-caddy-validator-e2e:
+    needs: build-caddy-validator
     name: Caddy
     runs-on: ubuntu-latest
     services:
@@ -36,7 +62,7 @@ jobs:
         name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: '1.24'
+          go-version: '1.25'
       -
         name: Checkout code
         uses: actions/checkout@v4
@@ -46,9 +72,6 @@ jobs:
       -
         name: Build Souin as caddy module
         run: cd plugins/caddy && xcaddy build --with github.com/darkweak/souin/plugins/caddy=./ --with github.com/darkweak/souin=../.. --with github.com/darkweak/storages/badger/caddy --with github.com/darkweak/storages/etcd/caddy --with github.com/darkweak/storages/nats/caddy --with github.com/darkweak/storages/nuts/caddy --with github.com/darkweak/storages/olric/caddy --with github.com/darkweak/storages/otter/caddy --with github.com/darkweak/storages/redis/caddy
-      -
-        name: Run Caddy tests
-        run: cd plugins/caddy && go test -v ./...
       -
         name: Run detached caddy
         run: cd plugins/caddy && ./caddy run &
@@ -85,7 +108,7 @@ jobs:
         name: Install Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.24'
+          go-version: '1.25'
 
       - name: Install Node.js
         uses: actions/setup-node@v4
@@ -158,74 +181,74 @@ jobs:
     with:
       CAPITALIZED_NAME: Beego
       LOWER_NAME: beego
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'
   build-chi-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Chi
       LOWER_NAME: chi
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'
   build-dotweb-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Dotweb
       LOWER_NAME: dotweb
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'
   build-echo-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Echo
       LOWER_NAME: echo
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'
   build-fiber-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Fiber
       LOWER_NAME: fiber
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'
   build-gin-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Gin
       LOWER_NAME: gin
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'
   build-goa-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Goa
       LOWER_NAME: goa
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'
   build-kratos-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Kratos
       LOWER_NAME: kratos
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'
   build-souin-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Souin
       LOWER_NAME: souin
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'
   build-traefik-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Traefik
       LOWER_NAME: traefik
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'
   build-webgo-validator:
     uses: ./.github/workflows/plugin_template.yml
     secrets: inherit
     with:
       CAPITALIZED_NAME: Webgo
       LOWER_NAME: webgo
-      GO_VERSION: '1.24'
+      GO_VERSION: '1.25'

.github/workflows/release.yml

@@ -5,7 +5,7 @@ on:
     tags: ["v*"]
 
 env:
-  GO_VERSION: '1.24'
+  GO_VERSION: '1.25'
 
 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.24
+go_version=1.25
 
 IFS= read -r -d '' tpl <<EOF
 name: Build and validate Souin as plugins
@@ -13,6 +13,32 @@ on:
 
 jobs:
   build-caddy-validator:
+    name: Caddy
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Add domain.com host to /etc/hosts
+        run: |
+          sudo echo "127.0.0.1 domain.com etcd redis" | sudo tee -a /etc/hosts
+      -
+        name: Install Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: '$go_version'
+      -
+        name: Checkout code
+        uses: actions/checkout@v4
+      -
+        name: Install xcaddy
+        run: go install github.com/caddyserver/xcaddy/cmd/xcaddy@latest
+      -
+        name: Build Souin as caddy module
+        run: cd plugins/caddy && xcaddy build --with github.com/darkweak/souin/plugins/caddy=./ --with github.com/darkweak/souin=../.. --with github.com/darkweak/storages/badger/caddy --with github.com/darkweak/storages/etcd/caddy --with github.com/darkweak/storages/nats/caddy --with github.com/darkweak/storages/nuts/caddy --with github.com/darkweak/storages/olric/caddy --with github.com/darkweak/storages/otter/caddy --with github.com/darkweak/storages/redis/caddy
+      -
+        name: Run Caddy tests
+        run: cd plugins/caddy && go test -v ./...
+  build-caddy-validator-e2e:
+    needs: build-caddy-validator
     name: Caddy
     runs-on: ubuntu-latest
     services:
@@ -54,9 +80,6 @@ jobs:
       -
         name: Build Souin as caddy module
         run: cd plugins/caddy && xcaddy build --with github.com/darkweak/souin/plugins/caddy=./ --with github.com/darkweak/souin=../.. --with github.com/darkweak/storages/badger/caddy --with github.com/darkweak/storages/etcd/caddy --with github.com/darkweak/storages/nats/caddy --with github.com/darkweak/storages/nuts/caddy --with github.com/darkweak/storages/olric/caddy --with github.com/darkweak/storages/otter/caddy --with github.com/darkweak/storages/redis/caddy
-      -
-        name: Run Caddy tests
-        run: cd plugins/caddy && go test -v ./...
       -
         name: Run detached caddy
         run: cd plugins/caddy && ./caddy run &
@@ -93,7 +116,7 @@ jobs:
         name: Install Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.24'
+          go-version: '1.25'
 
       - name: Install Node.js
         uses: actions/setup-node@v4

go.mod

@@ -1,8 +1,6 @@
 module github.com/darkweak/souin
 
-go 1.24
-
-toolchain go1.24.2
+go 1.25
 
 require (
 	github.com/caddyserver/caddy/v2 v2.10.0

pkg/middleware/middleware.go

@@ -451,10 +451,11 @@ func (s *SouinBaseHandler) Store(
 }
 
 type singleflightValue struct {
-	body           []byte
-	headers        http.Header
-	requestHeaders http.Header
-	code           int
+	body              []byte
+	headers           http.Header
+	requestHeaders    http.Header
+	code              int
+	disableCoalescing bool
 }
 
 func (s *SouinBaseHandler) Upstream(
@@ -464,6 +465,7 @@ func (s *SouinBaseHandler) Upstream(
 	requestCc *cacheobject.RequestCacheDirectives,
 	cachedKey string,
 	uri string,
+	disableCoalescing bool,
 ) error {
 	s.Configuration.GetLogger().Debug("Request the upstream server")
 	prometheus.Increment(prometheus.RequestCounter)
@@ -484,7 +486,7 @@ func (s *SouinBaseHandler) Upstream(
 	}()
 
 	singleflightCacheKey := cachedKey
-	if s.Configuration.GetDefaultCache().IsCoalescingDisable() {
+	if s.Configuration.GetDefaultCache().IsCoalescingDisable() || disableCoalescing {
 		singleflightCacheKey += uuid.NewString()
 	}
 	sfValue, err, shared := s.singleflightPool.Do(singleflightCacheKey, func() (interface{}, error) {
@@ -519,10 +521,11 @@ func (s *SouinBaseHandler) Upstream(
 		})
 
 		return singleflightValue{
-			body:           customWriter.Buf.Bytes(),
-			headers:        customWriter.Header().Clone(),
-			requestHeaders: rq.Header,
-			code:           statusCode,
+			body:              customWriter.Buf.Bytes(),
+			headers:           customWriter.Header().Clone(),
+			requestHeaders:    rq.Header,
+			code:              statusCode,
+			disableCoalescing: strings.Contains(cacheControl, "private") || customWriter.Header().Get("Set-Cookie") != "",
 		}, err
 	})
 	if recoveredFromErr != nil {
@@ -533,17 +536,22 @@ func (s *SouinBaseHandler) Upstream(
 	}
 
 	if sfWriter, ok := sfValue.(singleflightValue); ok {
+		if shared && sfWriter.disableCoalescing {
+			return s.Upstream(customWriter, rq, next, requestCc, cachedKey, uri, true)
+		}
+
 		if vary := sfWriter.headers.Get("Vary"); vary != "" {
 			variedHeaders, isVaryStar := rfc.VariedHeaderAllCommaSepValues(sfWriter.headers)
 			if !isVaryStar {
 				for _, vh := range variedHeaders {
 					if rq.Header.Get(vh) != sfWriter.requestHeaders.Get(vh) {
 						// cachedKey += rfc.GetVariedCacheKey(rq, variedHeaders)
-						return s.Upstream(customWriter, rq, next, requestCc, cachedKey, uri)
+						return s.Upstream(customWriter, rq, next, requestCc, cachedKey, uri, false)
 					}
 				}
 			}
 		}
+
 		if shared {
 			s.Configuration.GetLogger().Infof("Reused response from concurrent request with the key %s", cachedKey)
 		}
@@ -971,7 +979,7 @@ func (s *SouinBaseHandler) ServeHTTP(rw http.ResponseWriter, rq *http.Request, n
 			}
 		}()
 		prometheus.Increment(prometheus.NoCachedResponseCounter)
-		errorCacheCh <- s.Upstream(cw, vr, next, requestCc, cachedKey, uri)
+		errorCacheCh <- s.Upstream(cw, vr, next, requestCc, cachedKey, uri, false)
 	}(req, customWriter)
 
 	select {