feat(dependencies): bump to Souin v1.6.39 (#56)

darkweak · web-flow · commit 8a819c26f2d6 · 2023-07-19T18:25:47.000+02:00
diff --git a/Caddyfile b/Caddyfile
@@ -287,6 +287,15 @@ route /custom-key/without-* {
     respond "Hello to the authenticated user."
 }
 
+route /must-revalidate {
+    cache {
+        ttl 5s
+        stale 5s
+    }
+    header Cache-Control "must-revalidate"
+    reverse_proxy 127.0.0.1:81
+}
+
 route /cache-authorization {
     cache {
         cache_keys {
@@ -299,6 +308,49 @@ route /cache-authorization {
     respond "Hello to the authenticated user."
 }
 
+route /bypass {
+    cache {
+        mode bypass
+    }
+
+    header Cache-Control "no-store"
+    respond "Hello bypass"
+}
+
+route /bypass_request {
+    cache {
+        mode bypass_request
+    }
+
+    respond "Hello bypass_request"
+}
+
+route /bypass_response {
+    cache {
+        mode bypass_response
+    }
+
+    header Cache-Control "no-cache, no-store"
+    respond "Hello bypass_response"
+}
+
+route /strict_request {
+    cache {
+        mode strict
+    }
+
+    respond "Hello strict"
+}
+
+route /strict_response {
+    cache {
+        mode strict
+    }
+
+    header Cache-Control "no-cache, no-store"
+    respond "Hello strict"
+}
+
 cache @souin-api {
 }
 
diff --git a/README.md b/README.md
@@ -79,6 +79,7 @@ Here are all the available options for the global options
             headers Content-Type Authorization
         }
         log_level debug
+        mode bypass
         nuts {
             path /path/to/the/storage
         }
@@ -384,6 +385,7 @@ What does these directives mean?
 | `key.disable_query`                       | Disable the query string part in the key                                                                                                     | `true`<br/><br/>`(default: false)`                                                                                      |
 | `key.headers`                             | Add headers to the key matching the regexp                                                                                                   | `Authorization Content-Type X-Additional-Header`                                                                        |
 | `key.hide`                                | Prevent the key from being exposed in the `Cache-Status` HTTP response header                                                                | `true`<br/><br/>`(default: false)`                                                                                      |
+| `mode`                                    | Bypass the RFC respect                                                                                                                       | One of `bypass` `bypass_request` `bypass_response` `strict` (default `strict`)                                          |
 | `nuts`                                    | Configure the Nuts cache storage                                                                                                             |                                                                                                                         |
 | `nuts.path`                               | Set the Nuts file path storage                                                                                                               | `/anywhere/nuts/storage`                                                                                                |
 | `nuts.configuration`                      | Configure Nuts directly in the Caddyfile or your JSON caddy configuration                                                                    | [See the Nuts configuration for the options](https://github.com/nutsdb/nutsdb#default-options)                          |
diff --git a/configuration.go b/configuration.go
@@ -28,6 +28,8 @@ type DefaultCache struct {
 	Headers []string `json:"headers"`
 	// Configure the global key generation.
 	Key configurationtypes.Key `json:"key"`
+	// Mode defines if strict or bypass.
+	Mode string `json:"mode"`
 	// Olric provider configuration.
 	Olric configurationtypes.CacheProvider `json:"olric"`
 	// Redis provider configuration.
@@ -86,6 +88,11 @@ func (d *DefaultCache) GetEtcd() configurationtypes.CacheProvider {
 	return d.Etcd
 }
 
+// GetMode returns mdoe configuration
+func (d *DefaultCache) GetMode() string {
+	return d.Mode
+}
+
 // GetNuts returns nuts configuration
 func (d *DefaultCache) GetNuts() configurationtypes.CacheProvider {
 	return d.Nuts
@@ -274,6 +281,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 							switch directive {
 							case "basepath":
 								apiConfiguration.Debug.BasePath = h.RemainingArgs()[0]
+							default:
+								return h.Errf("unsupported debug directive: %s", directive)
 							}
 						}
 					case "prometheus":
@@ -284,6 +293,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 							switch directive {
 							case "basepath":
 								apiConfiguration.Prometheus.BasePath = h.RemainingArgs()[0]
+							default:
+								return h.Errf("unsupported prometheus directive: %s", directive)
 							}
 						}
 					case "souin":
@@ -294,8 +305,12 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 							switch directive {
 							case "basepath":
 								apiConfiguration.Souin.BasePath = h.RemainingArgs()[0]
+							default:
+								return h.Errf("unsupported souin directive: %s", directive)
 							}
 						}
+					default:
+						return h.Errf("unsupported api directive: %s", directive)
 					}
 				}
 				cfg.API = apiConfiguration
@@ -310,6 +325,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 					case "configuration":
 						provider.Configuration = parseCaddyfileRecursively(h)
 						provider.Configuration = parseBadgerConfiguration(provider.Configuration.(map[string]interface{}))
+					default:
+						return h.Errf("unsupported badger directive: %s", directive)
 					}
 				}
 				cfg.DefaultCache.Badger = provider
@@ -337,6 +354,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 							ck.Hide = true
 						case "headers":
 							ck.Headers = h.RemainingArgs()
+						default:
+							return h.Errf("unsupported cache_keys (%s) directive: %s", rg, directive)
 						}
 					}
 
@@ -367,6 +386,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 						cdn.Provider = h.RemainingArgs()[0]
 					case "strategy":
 						cdn.Strategy = h.RemainingArgs()[0]
+					default:
+						return h.Errf("unsupported cdn directive: %s", directive)
 					}
 				}
 				cfg.DefaultCache.CDN = cdn
@@ -381,6 +402,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 					switch directive {
 					case "configuration":
 						provider.Configuration = parseCaddyfileRecursively(h)
+					default:
+						return h.Errf("unsupported etcd directive: %s", directive)
 					}
 				}
 				cfg.DefaultCache.Etcd = provider
@@ -403,12 +426,20 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 						config_key.Hide = true
 					case "headers":
 						config_key.Headers = h.RemainingArgs()
+					default:
+						return h.Errf("unsupported key directive: %s", directive)
 					}
 				}
 				cfg.DefaultCache.Key = config_key
 			case "log_level":
 				args := h.RemainingArgs()
 				cfg.LogLevel = args[0]
+			case "mode":
+				args := h.RemainingArgs()
+				if len(args) > 1 {
+					return h.Errf("mode must contains only one arg: %s given", args)
+				}
+				cfg.DefaultCache.Mode = args[0]
 			case "nuts":
 				provider := configurationtypes.CacheProvider{}
 				for nesting := h.Nesting(); h.NextBlock(nesting); {
@@ -422,6 +453,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 						provider.Path = urlArgs[0]
 					case "configuration":
 						provider.Configuration = parseCaddyfileRecursively(h)
+					default:
+						return h.Errf("unsupported nuts directive: %s", directive)
 					}
 				}
 				cfg.DefaultCache.Nuts = provider
@@ -439,6 +472,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 						provider.Path = urlArgs[0]
 					case "configuration":
 						provider.Configuration = parseCaddyfileRecursively(h)
+					default:
+						return h.Errf("unsupported olric directive: %s", directive)
 					}
 				}
 				cfg.DefaultCache.Olric = provider
@@ -457,6 +492,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 					case "configuration":
 						provider.Configuration = parseCaddyfileRecursively(h)
 						provider.Configuration = parseRedisConfiguration(provider.Configuration.(map[string]interface{}))
+					default:
+						return h.Errf("unsupported redis directive: %s", directive)
 					}
 				}
 				cfg.DefaultCache.Redis = provider
@@ -466,6 +503,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 					switch directive {
 					case "exclude":
 						cfg.DefaultCache.Regex.Exclude = h.RemainingArgs()[0]
+					default:
+						return h.Errf("unsupported regex directive: %s", directive)
 					}
 				}
 			case "stale":
@@ -493,6 +532,8 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 							d.Duration = ttl
 						}
 						timeout.Cache = d
+					default:
+						return h.Errf("unsupported timeout directive: %s", directive)
 					}
 				}
 				cfg.DefaultCache.Timeout = timeout
@@ -503,9 +544,7 @@ func parseConfiguration(cfg *Configuration, h *caddyfile.Dispenser, isBlocking b
 					cfg.DefaultCache.TTL.Duration = ttl
 				}
 			default:
-				if isBlocking {
-					return h.Errf("unsupported root directive: %s", rootOption)
-				}
+				return h.Errf("unsupported root directive: %s", rootOption)
 			}
 		}
 	}
diff --git a/go.mod b/go.mod
@@ -5,7 +5,7 @@ go 1.19
 require (
 	github.com/buraksezer/olric v0.5.4
 	github.com/caddyserver/caddy/v2 v2.6.4
-	github.com/darkweak/souin v1.6.36
+	github.com/darkweak/souin v1.6.39
 	go.uber.org/zap v1.24.0
 )
 
@@ -102,7 +102,7 @@ require (
 	github.com/mschoch/smat v0.2.0 // indirect
 	github.com/onsi/ginkgo/v2 v2.9.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
-	github.com/pquerna/cachecontrol v0.1.0 // indirect
+	github.com/pquerna/cachecontrol v0.1.1-0.20230415224848-baaf0ee61529 // indirect
 	github.com/prometheus/client_golang v1.14.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect
 	github.com/prometheus/common v0.41.0 // indirect
diff --git a/go.sum b/go.sum
@@ -656,8 +656,8 @@ github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7Do
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/darkweak/go-esi v0.0.5 h1:b9LHI8Tz46R+i6p8avKPHAIBRQUCZDebNmKm5w/Zrns=
 github.com/darkweak/go-esi v0.0.5/go.mod h1:koCJqwum1u6mslyZuq/Phm6hfG1K3ZK5Y7jrUBTH654=
-github.com/darkweak/souin v1.6.36 h1:T+7xZFjnDgbjOPF/1jEFj3cBcTMK6hzdG0X3iQiGkGg=
-github.com/darkweak/souin v1.6.36/go.mod h1:/C9ISWex+bkdmHgAT2wZpq9VQddcMLb0i8/ykrapN40=
+github.com/darkweak/souin v1.6.39 h1:uVO18+pvy5N8dJH+CCfuBD3gx7AXWaBv+RjC9ee1pCk=
+github.com/darkweak/souin v1.6.39/go.mod h1:7B7VqPbFrF7AWJDRP6FCbE+zGiRUUqHAmWOs3Q2n4hk=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -1115,8 +1115,8 @@ github.com/pkg/sftp v1.13.1/go.mod h1:3HaPG6Dq1ILlpPZRO0HVMrsydcdLt6HRDccSgb87qR
 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/posener/complete v1.1.1/go.mod h1:em0nMJCgc9GFtwrmVmEMR/ZL6WyhyjMBndrE9hABlRI=
-github.com/pquerna/cachecontrol v0.1.0 h1:yJMy84ti9h/+OEWa752kBTKv4XC30OtVVHYv/8cTqKc=
-github.com/pquerna/cachecontrol v0.1.0/go.mod h1:NrUG3Z7Rdu85UNR3vm7SOsl1nFIeSiQnrHV5K9mBcUI=
+github.com/pquerna/cachecontrol v0.1.1-0.20230415224848-baaf0ee61529 h1:wcNVCAIsWcLpEJ5FhXHKC7dBi6SIZQukrOTY5eHes0M=
+github.com/pquerna/cachecontrol v0.1.1-0.20230415224848-baaf0ee61529/go.mod h1:NrUG3Z7Rdu85UNR3vm7SOsl1nFIeSiQnrHV5K9mBcUI=
 github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw=
 github.com/prometheus/client_golang v1.0.0/go.mod h1:db9x61etRT2tGnBNRi70OPL5FsnadC4Ky3P0J6CfImo=
 github.com/prometheus/client_golang v1.4.0/go.mod h1:e9GMxYsXl05ICDXkRhurwBS4Q3OK1iX/F2sw+iXX5zU=
diff --git a/httpcache_test.go b/httpcache_test.go

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,8 @@ type DefaultCache struct {`
`28`	`28`	Headers []string `json:"headers"`
`29`	`29`	`// Configure the global key generation.`
`30`	`30`	Key configurationtypes.Key `json:"key"`
	`31`	`+ // Mode defines if strict or bypass.`
	`32`	+ Mode string `json:"mode"`
`31`	`33`	`// Olric provider configuration.`
`32`	`34`	Olric configurationtypes.CacheProvider `json:"olric"`
`33`	`35`	`// Redis provider configuration.`
`@@ -86,6 +88,11 @@ func (d *DefaultCache) GetEtcd() configurationtypes.CacheProvider {`
`86`	`88`	`return d.Etcd`
`87`	`89`	`}`
`88`	`90`
	`91`	`+// GetMode returns mdoe configuration`
	`92`	`+func (d *DefaultCache) GetMode() string {`
	`93`	`+ return d.Mode`
	`94`	`+}`
	`95`	`+`
`89`	`96`	`// GetNuts returns nuts configuration`
`90`	`97`	`func (d *DefaultCache) GetNuts() configurationtypes.CacheProvider {`
`91`	`98`	`return d.Nuts`
`@@ -274,6 +281,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`274`	`281`	`switch directive {`
`275`	`282`	`case "basepath":`
`276`	`283`	`apiConfiguration.Debug.BasePath = h.RemainingArgs()[0]`
	`284`	`+ default:`
	`285`	`+ return h.Errf("unsupported debug directive: %s", directive)`
`277`	`286`	`}`
`278`	`287`	`}`
`279`	`288`	`case "prometheus":`
`@@ -284,6 +293,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`284`	`293`	`switch directive {`
`285`	`294`	`case "basepath":`
`286`	`295`	`apiConfiguration.Prometheus.BasePath = h.RemainingArgs()[0]`
	`296`	`+ default:`
	`297`	`+ return h.Errf("unsupported prometheus directive: %s", directive)`
`287`	`298`	`}`
`288`	`299`	`}`
`289`	`300`	`case "souin":`
`@@ -294,8 +305,12 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`294`	`305`	`switch directive {`
`295`	`306`	`case "basepath":`
`296`	`307`	`apiConfiguration.Souin.BasePath = h.RemainingArgs()[0]`
	`308`	`+ default:`
	`309`	`+ return h.Errf("unsupported souin directive: %s", directive)`
`297`	`310`	`}`
`298`	`311`	`}`
	`312`	`+ default:`
	`313`	`+ return h.Errf("unsupported api directive: %s", directive)`
`299`	`314`	`}`
`300`	`315`	`}`
`301`	`316`	`cfg.API = apiConfiguration`
`@@ -310,6 +325,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`310`	`325`	`case "configuration":`
`311`	`326`	`provider.Configuration = parseCaddyfileRecursively(h)`
`312`	`327`	`provider.Configuration = parseBadgerConfiguration(provider.Configuration.(map[string]interface{}))`
	`328`	`+ default:`
	`329`	`+ return h.Errf("unsupported badger directive: %s", directive)`
`313`	`330`	`}`
`314`	`331`	`}`
`315`	`332`	`cfg.DefaultCache.Badger = provider`
`@@ -337,6 +354,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`337`	`354`	`ck.Hide = true`
`338`	`355`	`case "headers":`
`339`	`356`	`ck.Headers = h.RemainingArgs()`
	`357`	`+ default:`
	`358`	`+ return h.Errf("unsupported cache_keys (%s) directive: %s", rg, directive)`
`340`	`359`	`}`
`341`	`360`	`}`
`342`	`361`
`@@ -367,6 +386,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`367`	`386`	`cdn.Provider = h.RemainingArgs()[0]`
`368`	`387`	`case "strategy":`
`369`	`388`	`cdn.Strategy = h.RemainingArgs()[0]`
	`389`	`+ default:`
	`390`	`+ return h.Errf("unsupported cdn directive: %s", directive)`
`370`	`391`	`}`
`371`	`392`	`}`
`372`	`393`	`cfg.DefaultCache.CDN = cdn`
`@@ -381,6 +402,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`381`	`402`	`switch directive {`
`382`	`403`	`case "configuration":`
`383`	`404`	`provider.Configuration = parseCaddyfileRecursively(h)`
	`405`	`+ default:`
	`406`	`+ return h.Errf("unsupported etcd directive: %s", directive)`
`384`	`407`	`}`
`385`	`408`	`}`
`386`	`409`	`cfg.DefaultCache.Etcd = provider`
`@@ -403,12 +426,20 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`403`	`426`	`config_key.Hide = true`
`404`	`427`	`case "headers":`
`405`	`428`	`config_key.Headers = h.RemainingArgs()`
	`429`	`+ default:`
	`430`	`+ return h.Errf("unsupported key directive: %s", directive)`
`406`	`431`	`}`
`407`	`432`	`}`
`408`	`433`	`cfg.DefaultCache.Key = config_key`
`409`	`434`	`case "log_level":`
`410`	`435`	`args := h.RemainingArgs()`
`411`	`436`	`cfg.LogLevel = args[0]`
	`437`	`+ case "mode":`
	`438`	`+ args := h.RemainingArgs()`
	`439`	`+ if len(args) > 1 {`
	`440`	`+ return h.Errf("mode must contains only one arg: %s given", args)`
	`441`	`+ }`
	`442`	`+ cfg.DefaultCache.Mode = args[0]`
`412`	`443`	`case "nuts":`
`413`	`444`	`provider := configurationtypes.CacheProvider{}`
`414`	`445`	`for nesting := h.Nesting(); h.NextBlock(nesting); {`
`@@ -422,6 +453,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`422`	`453`	`provider.Path = urlArgs[0]`
`423`	`454`	`case "configuration":`
`424`	`455`	`provider.Configuration = parseCaddyfileRecursively(h)`
	`456`	`+ default:`
	`457`	`+ return h.Errf("unsupported nuts directive: %s", directive)`
`425`	`458`	`}`
`426`	`459`	`}`
`427`	`460`	`cfg.DefaultCache.Nuts = provider`
`@@ -439,6 +472,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`439`	`472`	`provider.Path = urlArgs[0]`
`440`	`473`	`case "configuration":`
`441`	`474`	`provider.Configuration = parseCaddyfileRecursively(h)`
	`475`	`+ default:`
	`476`	`+ return h.Errf("unsupported olric directive: %s", directive)`
`442`	`477`	`}`
`443`	`478`	`}`
`444`	`479`	`cfg.DefaultCache.Olric = provider`
`@@ -457,6 +492,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`457`	`492`	`case "configuration":`
`458`	`493`	`provider.Configuration = parseCaddyfileRecursively(h)`
`459`	`494`	`provider.Configuration = parseRedisConfiguration(provider.Configuration.(map[string]interface{}))`
	`495`	`+ default:`
	`496`	`+ return h.Errf("unsupported redis directive: %s", directive)`
`460`	`497`	`}`
`461`	`498`	`}`
`462`	`499`	`cfg.DefaultCache.Redis = provider`
`@@ -466,6 +503,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`466`	`503`	`switch directive {`
`467`	`504`	`case "exclude":`
`468`	`505`	`cfg.DefaultCache.Regex.Exclude = h.RemainingArgs()[0]`
	`506`	`+ default:`
	`507`	`+ return h.Errf("unsupported regex directive: %s", directive)`
`469`	`508`	`}`
`470`	`509`	`}`
`471`	`510`	`case "stale":`
`@@ -493,6 +532,8 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`493`	`532`	`d.Duration = ttl`
`494`	`533`	`}`
`495`	`534`	`timeout.Cache = d`
	`535`	`+ default:`
	`536`	`+ return h.Errf("unsupported timeout directive: %s", directive)`
`496`	`537`	`}`
`497`	`538`	`}`
`498`	`539`	`cfg.DefaultCache.Timeout = timeout`
`@@ -503,9 +544,7 @@ func parseConfiguration(cfg Configuration, h caddyfile.Dispenser, isBlocking b`
`503`	`544`	`cfg.DefaultCache.TTL.Duration = ttl`
`504`	`545`	`}`
`505`	`546`	`default:`
`506`		`- if isBlocking {`
`507`		`- return h.Errf("unsupported root directive: %s", rootOption)`
`508`		`- }`
	`547`	`+ return h.Errf("unsupported root directive: %s", rootOption)`
`509`	`548`	`}`
`510`	`549`	`}`
`511`	`550`	`}`