Skip to content

fix: don't set empty cache control headers #1246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
df-wg merged 1 commit into from
Oct 6, 2024
Merged

fix: don't set empty cache control headers #1246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions router-tests/header_propagation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,8 +556,9 @@ func TestHeaderPropagation(t *testing.T) {
res := xEnv.MakeGraphQLRequestOK(testenv.GraphQLRequest{
Query: queryEmployeeWithNoHobby,
})
cc := res.Response.Header.Get("Cache-Control")
require.Equal(t, "", cc)
val, present := res.Response.Header["Cache-Control"]
require.False(t, present)
require.Equal(t, []string(nil), val)
require.Equal(t, `{"data":{"employee":{"id":1}}}`, res.Body)
})
})
Expand All @@ -582,6 +583,26 @@ func TestHeaderPropagation(t *testing.T) {
})
})

t.Run("doesn't set cache control on unrelated requests", func(t *testing.T) {
t.Parallel()
testenv.Run(t, &testenv.Config{
CacheControlPolicy: config.CacheControlPolicy{
Subgraphs: []config.SubgraphCacheControlRule{
{Name: "employees"},
{Name: "hobbies"},
},
},
Subgraphs: cacheOptions("", ""),
}, func(t *testing.T, xEnv *testenv.Environment) {
res := xEnv.MakeGraphQLRequestOK(testenv.GraphQLRequest{
Query: queryEmployeeWithHobby,
})
val, present := res.Response.Header["Cache-Control"]
require.False(t, present)
require.Equal(t, []string(nil), val)
require.Equal(t, `{"data":{"employee":{"id":1,"hobbies":[{},{"name":"Counter Strike"},{},{},{}]}}}`, res.Body)
})
})
t.Run("set operation can override cache control policies", func(t *testing.T) {
t.Run("global set operation", func(t *testing.T) {
t.Parallel()
Expand Down
12 changes: 9 additions & 3 deletions router/core/header_rule_engine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,9 +452,12 @@ func (h *HeaderPropagation) applyResponseRuleMostRestrictiveCacheControl(res *ht
return
}

reqDir, _ := cachedirective.ParseRequestCacheControl(res.Request.Header.Get(cacheControlKey))
resDir, _ := cachedirective.ParseResponseCacheControl(res.Header.Get(cacheControlKey))
expiresHeader, _ := http.ParseTime(res.Header.Get("Expires"))
reqCacheHeader := res.Request.Header.Get(cacheControlKey)
reqDir, _ := cachedirective.ParseRequestCacheControl(reqCacheHeader)
resCacheHeader := res.Header.Get(cacheControlKey)
resDir, _ := cachedirective.ParseResponseCacheControl(resCacheHeader)
expiresHeaderVal := res.Header.Get("Expires")
expiresHeader, _ := http.ParseTime(expiresHeaderVal)
dateHeader, _ := http.ParseTime(res.Header.Get("Date"))
lastModifiedHeader, _ := http.ParseTime(res.Header.Get("Last-Modified"))

Expand Down Expand Up @@ -495,6 +498,9 @@ func (h *HeaderPropagation) applyResponseRuleMostRestrictiveCacheControl(res *ht
if rule.Default != "" {
propagation.previousCacheControl = defaultCacheControlObj
propagation.header.Set(cacheControlKey, rule.Default)
} else if reqCacheHeader == "" && resCacheHeader == "" && expiresHeaderVal == "" {
// There is no default/previous value to set, and since no cache control headers have been set, exit early
return
} else {
propagation.previousCacheControl = obj
propagation.header.Set(cacheControlKey, res.Header.Get(cacheControlKey))
Expand Down