fix(rfc): Ensure supported Vary header (#193)

darkweak · Mar 17, 2022 · ce6ab9e · ce6ab9e
1 parent 7210ad0
commit ce6ab9e
Show file tree

Hide file tree

Showing 4 changed files with 99 additions and 9 deletions.
diff --git a/cache/providers/abstractProvider.go b/cache/providers/abstractProvider.go
@@ -48,8 +48,6 @@ func varyVoter(baseKey string, req *http.Request, currentKey string) bool {
 				return true
 			}
 		}
-
-		return true
 	}
 
 	return false

diff --git a/docs/e2e/Souin E2E.postman_collection.json b/docs/e2e/Souin E2E.postman_collection.json
@@ -281,6 +281,45 @@
 					},
 					"response": []
 				},
+				{
+					"name": "Vary",
+					"event": [
+						{
+							"listen": "test",
+							"script": {
+								"exec": [
+									"utils.validateVary(pm, `${utils.getVar(pm, 'caddy_url')}/vary`)"
+								],
+								"type": "text/javascript"
+							}
+						}
+					],
+					"request": {
+						"method": "GET",
+						"header": [
+							{
+								"key": "X-something",
+								"value": "should-vary-1",
+								"type": "text"
+							},
+							{
+								"key": "Cache-Control",
+								"value": "",
+								"type": "text"
+							}
+						],
+						"url": {
+							"raw": "{{caddy_url}}/vary",
+							"host": [
+								"{{caddy_url}}"
+							],
+							"path": [
+								"vary"
+							]
+						}
+					},
+					"response": []
+				},
 				{
 					"name": "Default no store",
 					"event": [
@@ -1254,9 +1293,10 @@
 				"type": "text/javascript",
 				"exec": [
 					"utils = {",
-					"    request: (url, cacheControl = '', body = null) => ({",
+					"    request: (url, cacheControl = '', body = null, headers = {}) => ({",
 					"        header: {",
-					"            'Cache-Control': cacheControl",
+					"            'Cache-Control': cacheControl,",
+					"            ...headers,",
 					"        },",
 					"        method: 'GET',",
 					"        body,",
@@ -1319,6 +1359,50 @@
 					"            });",
 					"        });",
 					"    },",
+					"    validateVary: (pm, baseUrl = '') => {",
+					"        pm.test(\"Status code is 200 with Cache-Status header\", function () {",
+					"            pm.response.to.have.status(200);",
+					"            pm.response.to.have.header(\"Cache-Status\");",
+					"            pm.expect(pm.response.headers.get(\"Cache-Status\")).to.eql(\"Souin; fwd=uri-miss; stored\");",
+					"            pm.response.to.not.have.header(\"Age\");",
+					"            pm.expect(pm.response.text()).to.eql(\"Hello should-vary-1\");",
+					"        });",
+					"        const vary1 = utils.request(baseUrl, '', null, {'X-Something': 'should-vary-1'});",
+					"        const vary2 = utils.request(baseUrl, '', null, {'X-Something': 'should-vary-2'});",
+					"        pm.sendRequest(vary1, function (_, resVary1) {",
+					"            pm.test('Status code is 200, Cache-Status and Age are present', function () {",
+					"                const expected = pm.expect(resVary1);",
+					"                expected.to.have.status(200);",
+					"                expected.to.have.header(\"Cache-Status\");",
+					"                expected.to.have.header(\"Age\");",
+					"                pm.expect(resVary1.headers.get(\"Cache-Status\")).to.include(\"Souin; hit; ttl=14\");",
+					"                pm.expect(resVary1.text()).to.eql(\"Hello should-vary-1\");",
+					"            });",
+					"",
+					"",
+					"            pm.sendRequest(vary2, function (_, resVary2Stored) {",
+					"                pm.test(\"Status code is 200 with Cache-Status header\", function () {",
+					"                    const expected = pm.expect(resVary2Stored);",
+					"                    expected.to.have.status(200);",
+					"                    expected.to.have.header(\"Cache-Status\");",
+					"                    pm.expect(resVary2Stored.headers.get(\"Cache-Status\")).to.eql(\"Souin; fwd=uri-miss; stored\");",
+					"                    expected.to.not.have.header(\"Age\");",
+					"                    pm.expect(resVary2Stored.text()).to.eql(\"Hello should-vary-2\");",
+					"                });",
+					"",
+					"                pm.sendRequest(vary2, function (_, resVary2) {",
+					"                    pm.test('Status code is 200, Cache-Status and Age are present', function () {",
+					"                        const expected = pm.expect(resVary2);",
+					"                        expected.to.have.status(200);",
+					"                        expected.to.have.header(\"Cache-Status\");",
+					"                        expected.to.have.header(\"Age\");",
+					"                        pm.expect(resVary2.headers.get(\"Cache-Status\")).to.include(\"Souin; hit; ttl=14\");",
+					"                        pm.expect(resVary2.text()).to.eql(\"Hello should-vary-2\");",
+					"                    });",
+					"                });",
+					"            });",
+					"        });",
+					"    },",
 					"    souinAPI: {",
 					"        listKeys: (pm, baseKey, baseUrl = '', additionalPath = '', cacheControl = '') => {",
 					"            const isCached = cacheControl == ''",

diff --git a/plugins/caddy/Caddyfile b/plugins/caddy/Caddyfile
@@ -41,6 +41,14 @@ cache @matchdefault {
     ttl 5s
 }
 
+route /vary {
+    cache {
+        ttl 15s
+    }
+    header Vary X-Something
+    respond "Hello {http.request.header.X-Something}"
+}
+
 route /cache-s-maxage {
     cache
     header Cache-Control "s-maxage=10"

diff --git a/plugins/caddy/httpcache.go b/plugins/caddy/httpcache.go
@@ -65,16 +65,16 @@ type getterContext struct {
 // ServeHTTP implements caddyhttp.MiddlewareHandler.
 func (s *SouinCaddyPlugin) ServeHTTP(rw http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error {
 	req := s.Retriever.GetContext().Method.SetContext(r)
-	if !plugins.CanHandle(req, s.Retriever) {
-		rw.Header().Add("Cache-Status", "Souin; fwd=uri-miss")
-		return next.ServeHTTP(rw, r)
-	}
-
 	if b, handler := s.HandleInternally(req); b {
 		handler(rw, req)
 		return nil
 	}
 
+	if !plugins.CanHandle(req, s.Retriever) {
+		rw.Header().Add("Cache-Status", "Souin; fwd=uri-miss")
+		return next.ServeHTTP(rw, r)
+	}
+
 	req = s.Retriever.GetContext().SetContext(req)
 	customWriter := &plugins.CustomWriter{
 		Response: &http.Response{},