-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feat: Support to compress and cache the static files (#777)
* Feat: Support to compress and cache the static files Signed-off-by: barnettZQG <[email protected]> * Fix: Code style Signed-off-by: barnettZQG <[email protected]> * Fix: Code style Signed-off-by: barnettZQG <[email protected]> --------- Signed-off-by: barnettZQG <[email protected]>
- Loading branch information
1 parent
d3985d1
commit 000b65c
Showing
7 changed files
with
313 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| Copyright 2023 The KubeVela Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package filters | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "strings" | ||
|
|
||
| "github.com/emicklei/go-restful/v3" | ||
| "k8s.io/klog/v2" | ||
|
|
||
| "github.com/kubevela/velaux/pkg/server/utils" | ||
| ) | ||
|
|
||
| // Gzip static file compression | ||
| func Gzip(req *http.Request, res http.ResponseWriter, chain *utils.FilterChain) { | ||
| doCompress, encoding := wantsCompressedResponse(req, res) | ||
| if doCompress { | ||
| w, err := restful.NewCompressingResponseWriter(res, encoding) | ||
| if err != nil { | ||
| res.WriteHeader(http.StatusInternalServerError) | ||
| return | ||
| } | ||
| defer func() { | ||
| if err = w.Close(); err != nil { | ||
| klog.Errorf("failed to close the compressing writer, err: %s", err.Error()) | ||
| } | ||
| }() | ||
| chain.ProcessFilter(req, w) | ||
| return | ||
| } | ||
| chain.ProcessFilter(req, res) | ||
| } | ||
|
|
||
| // WantsCompressedResponse reads the Accept-Encoding header to see if and which encoding is requested. | ||
| // It also inspects the httpWriter whether its content-encoding is already set (non-empty). | ||
| func wantsCompressedResponse(httpRequest *http.Request, httpWriter http.ResponseWriter) (bool, string) { | ||
| if contentEncoding := httpWriter.Header().Get(restful.HEADER_ContentEncoding); contentEncoding != "" { | ||
| return false, "" | ||
| } | ||
| header := httpRequest.Header.Get(restful.HEADER_AcceptEncoding) | ||
| gi := strings.Index(header, restful.ENCODING_GZIP) | ||
| zi := strings.Index(header, restful.ENCODING_DEFLATE) | ||
| // use in order of appearance | ||
| if gi == -1 { | ||
| return zi != -1, restful.ENCODING_DEFLATE | ||
| } | ||
| if zi == -1 { | ||
| return gi != -1, restful.ENCODING_GZIP | ||
| } | ||
| if gi < zi { | ||
| return true, restful.ENCODING_GZIP | ||
| } | ||
| return true, restful.ENCODING_DEFLATE | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| Copyright 2023 The KubeVela Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package filters | ||
|
|
||
| import ( | ||
| "compress/gzip" | ||
| "io" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "net/url" | ||
| "testing" | ||
|
|
||
| "github.com/emicklei/go-restful/v3" | ||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "github.com/kubevela/velaux/pkg/server/utils" | ||
| ) | ||
|
|
||
| func TestGZip(t *testing.T) { | ||
| chain := utils.NewFilterChain(loadJS, Gzip) | ||
| res1 := httptest.NewRecorder() | ||
| u, err := url.Parse("/test.js?v=1") | ||
| assert.Equal(t, err, nil) | ||
| reqHeader := http.Header{} | ||
| reqHeader.Set(restful.HEADER_AcceptEncoding, restful.ENCODING_GZIP) | ||
| chain.ProcessFilter(&http.Request{Method: "GET", URL: u, Header: reqHeader}, res1) | ||
| assert.Equal(t, res1.Code, 200) | ||
| assert.Equal(t, res1.HeaderMap.Get(restful.HEADER_ContentEncoding), restful.ENCODING_GZIP) | ||
|
|
||
| // Gzip decode | ||
| reader, err := gzip.NewReader(res1.Body) | ||
| assert.Equal(t, err, nil) | ||
| body, err := io.ReadAll(reader) | ||
| assert.Equal(t, err, nil) | ||
| assert.Equal(t, string(body), jsContent) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| /* | ||
| Copyright 2023 The KubeVela Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package filters | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "net/http" | ||
| "strings" | ||
|
|
||
| "github.com/golang/groupcache/lru" | ||
| "k8s.io/klog/v2" | ||
|
|
||
| "github.com/kubevela/velaux/pkg/server/utils" | ||
| ) | ||
|
|
||
| var jsFileCache = lru.New(100) | ||
|
|
||
| // HeaderHitCache the header key | ||
| var HeaderHitCache = "Hit-Cache" | ||
|
|
||
| func matchCacheCondition(req *http.Request) bool { | ||
| return strings.HasSuffix(req.URL.Path, ".js") && req.Method == "GET" | ||
| } | ||
|
|
||
| // JSCache cache the JS static file. | ||
| func JSCache(req *http.Request, res http.ResponseWriter, chain *utils.FilterChain) { | ||
| if matchCacheCondition(req) { | ||
| if value, ok := jsFileCache.Get(req.URL.String()); ok { | ||
| if cacheData, ok := value.(*cacheData); ok { | ||
| cacheData.Write(res) | ||
| return | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if matchCacheCondition(req) { | ||
| res.Header().Set(HeaderHitCache, "false") | ||
| cacheWriter := &CacheWriter{writer: res, cacheData: &cacheData{}} | ||
| chain.ProcessFilter(req, cacheWriter) | ||
| jsFileCache.Add(req.URL.String(), cacheWriter.cacheData) | ||
| return | ||
| } | ||
| chain.ProcessFilter(req, res) | ||
| } | ||
|
|
||
| type cacheData struct { | ||
| code int | ||
| data bytes.Buffer | ||
| header http.Header | ||
| } | ||
|
|
||
| func (c *cacheData) Write(w http.ResponseWriter) { | ||
| for k, values := range c.header { | ||
| for _, value := range values { | ||
| w.Header().Add(k, value) | ||
| } | ||
| } | ||
| w.Header().Set(HeaderHitCache, "true") | ||
| w.WriteHeader(c.code) | ||
| if _, err := w.Write(c.data.Bytes()); err != nil { | ||
| klog.Errorf("failed to write the cache content, err: %s", err.Error()) | ||
| } | ||
| } | ||
|
|
||
| // CacheWriter generate the cache item the response body and status | ||
| type CacheWriter struct { | ||
| writer http.ResponseWriter | ||
| cacheData *cacheData | ||
| } | ||
|
|
||
| // Header cache the header | ||
| func (c *CacheWriter) Header() http.Header { | ||
| header := c.writer.Header() | ||
| c.cacheData.header = header | ||
| return header | ||
| } | ||
|
|
||
| // Write cache the data | ||
| func (c *CacheWriter) Write(b []byte) (int, error) { | ||
| if _, err := c.cacheData.data.Write(b); err != nil { | ||
| return -1, err | ||
| } | ||
| return c.writer.Write(b) | ||
| } | ||
|
|
||
| // WriteHeader cache the status code | ||
| func (c *CacheWriter) WriteHeader(statusCode int) { | ||
| c.writer.WriteHeader(statusCode) | ||
| c.cacheData.code = statusCode | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| Copyright 2023 The KubeVela Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package filters | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "net/url" | ||
| "testing" | ||
|
|
||
| "github.com/emicklei/go-restful/v3" | ||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "github.com/kubevela/velaux/pkg/server/utils" | ||
| ) | ||
|
|
||
| func TestJSCache(t *testing.T) { | ||
| chain := utils.NewFilterChain(loadJS, JSCache) | ||
| res1 := httptest.NewRecorder() | ||
| u, err := url.Parse("/test.js?v=1") | ||
| assert.Equal(t, err, nil) | ||
| chain.ProcessFilter(&http.Request{Method: "GET", URL: u}, res1) | ||
| assert.Equal(t, res1.Code, 200) | ||
| assert.Equal(t, res1.Body.String(), jsContent) | ||
| assert.Equal(t, res1.HeaderMap.Get(HeaderHitCache), "false") | ||
| assert.Equal(t, jsFileCache.Len(), 1) | ||
| data, ok := jsFileCache.Get(u.String()) | ||
| assert.Equal(t, ok, true) | ||
| assert.Equal(t, data.(*cacheData).data.String(), jsContent) | ||
|
|
||
| res2 := httptest.NewRecorder() | ||
| chain = utils.NewFilterChain(loadJS, JSCache) | ||
| chain.ProcessFilter(&http.Request{Method: "GET", URL: u}, res2) | ||
| assert.Equal(t, res2.Code, 200) | ||
| assert.Equal(t, res2.Body.String(), jsContent) | ||
|
|
||
| assert.Equal(t, res2.HeaderMap.Get(HeaderHitCache), "true") | ||
|
|
||
| u2, err := url.Parse("/test.js?v=2") | ||
| assert.Equal(t, err, nil) | ||
| res3 := httptest.NewRecorder() | ||
| chain = utils.NewFilterChain(loadJS, JSCache) | ||
| chain.ProcessFilter(&http.Request{Method: "GET", URL: u2}, res3) | ||
| assert.Equal(t, res3.Code, 200) | ||
| assert.Equal(t, res3.Body.String(), jsContent) | ||
| assert.Equal(t, res3.HeaderMap.Get(HeaderHitCache), "false") | ||
| } | ||
|
|
||
| var jsContent = "console.log(\"hello\")" | ||
|
|
||
| func loadJS(req *http.Request, res http.ResponseWriter) { | ||
| fmt.Printf("miss cache,path:%s \n", req.URL.String()) | ||
| res.WriteHeader(200) | ||
| res.Write([]byte(jsContent)) | ||
| res.Header().Add(restful.HEADER_ContentType, "application/javascript") | ||
| } |