├── .github └── workflows │ ├── go-cross.yml │ └── main.yml ├── .gitignore ├── .golangci.toml ├── .traefik.yml ├── LICENCE ├── Makefile ├── README.md ├── go.mod ├── rewritebody.go └── rewritebody_test.go /.github/workflows/go-cross.yml: -------------------------------------------------------------------------------- 1 | name: Go Matrix 2 | on: [push, pull_request] 3 | 4 | jobs: 5 | 6 | cross: 7 | name: Go 8 | runs-on: ${{ matrix.os }} 9 | env: 10 | CGO_ENABLED: 0 11 | 12 | strategy: 13 | matrix: 14 | go-version: [ 1.15, 1.16, 1.x ] 15 | os: [ubuntu-latest, macos-latest, windows-latest] 16 | 17 | steps: 18 | # https://github.com/marketplace/actions/setup-go-environment 19 | - name: Set up Go ${{ matrix.go-version }} 20 | uses: actions/setup-go@v2 21 | with: 22 | go-version: ${{ matrix.go-version }} 23 | 24 | # https://github.com/marketplace/actions/checkout 25 | - name: Checkout code 26 | uses: actions/checkout@v2 27 | 28 | # https://github.com/marketplace/actions/cache 29 | - name: Cache Go modules 30 | uses: actions/cache@v2 31 | with: 32 | # In order: 33 | # * Module download cache 34 | # * Build cache (Linux) 35 | # * Build cache (Mac) 36 | # * Build cache (Windows) 37 | path: | 38 | ~/go/pkg/mod 39 | ~/.cache/go-build 40 | ~/Library/Caches/go-build 41 | %LocalAppData%\go-build 42 | key: ${{ runner.os }}-${{ matrix.go-version }}-go-${{ hashFiles('**/go.sum') }} 43 | restore-keys: | 44 | ${{ runner.os }}-${{ matrix.go-version }}-go- 45 | 46 | - name: Test 47 | run: go test -v -cover ./... 48 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Main 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | tags: 8 | - v* 9 | pull_request: 10 | 11 | jobs: 12 | 13 | main: 14 | name: Main Process 15 | runs-on: ubuntu-latest 16 | env: 17 | GO_VERSION: 1.16 18 | GOLANGCI_LINT_VERSION: v1.41.1 19 | YAEGI_VERSION: v0.9.20 20 | CGO_ENABLED: 0 21 | defaults: 22 | run: 23 | working-directory: ${{ github.workspace }}/go/src/github.com/${{ github.repository }} 24 | 25 | steps: 26 | 27 | # https://github.com/marketplace/actions/setup-go-environment 28 | - name: Set up Go ${{ env.GO_VERSION }} 29 | uses: actions/setup-go@v2 30 | with: 31 | go-version: ${{ env.GO_VERSION }} 32 | 33 | # https://github.com/marketplace/actions/checkout 34 | - name: Check out code 35 | uses: actions/checkout@v2 36 | with: 37 | path: go/src/github.com/${{ github.repository }} 38 | fetch-depth: 0 39 | 40 | # https://github.com/marketplace/actions/cache 41 | - name: Cache Go modules 42 | uses: actions/cache@v2 43 | with: 44 | path: ${{ github.workspace }}/go/pkg/mod 45 | key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} 46 | restore-keys: | 47 | ${{ runner.os }}-go- 48 | 49 | # https://golangci-lint.run/usage/install#other-ci 50 | - name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }} 51 | run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION} 52 | 53 | - name: Install Yaegi ${{ env.YAEGI_VERSION }} 54 | run: curl -sfL https://raw.githubusercontent.com/traefik/yaegi/master/install.sh | bash -s -- -b $(go env GOPATH)/bin ${YAEGI_VERSION} 55 | 56 | - name: Setup GOPATH 57 | run: go env -w GOPATH=${{ github.workspace }}/go 58 | 59 | - name: Check and get dependencies 60 | run: | 61 | go mod tidy 62 | git diff --exit-code go.mod 63 | # git diff --exit-code go.sum 64 | go mod vendor 65 | # git diff --exit-code ./vendor/ 66 | 67 | - name: Lint and Tests 68 | run: make 69 | 70 | - name: Run tests with Yaegi 71 | run: make yaegi_test 72 | env: 73 | GOPATH: ${{ github.workspace }}/go 74 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /.golangci.toml: -------------------------------------------------------------------------------- 1 | [run] 2 | timeout = "3m" 3 | skip-files = [] 4 | skip-dirs = [] 5 | 6 | [linters-settings] 7 | 8 | [linters-settings.govet] 9 | check-shadowing = false 10 | 11 | [linters-settings.golint] 12 | min-confidence = 0.0 13 | 14 | [linters-settings.gocyclo] 15 | min-complexity = 12.0 16 | 17 | [linters-settings.maligned] 18 | suggest-new = true 19 | 20 | [linters-settings.goconst] 21 | min-len = 3.0 22 | min-occurrences = 4.0 23 | 24 | [linters-settings.misspell] 25 | locale = "US" 26 | 27 | [linters-settings.funlen] 28 | lines = 60 # default 60 29 | statements = 40 # default 40 30 | 31 | [linters] 32 | enable-all = true 33 | disable = [ 34 | "scopelint", # deprecated 35 | "golint", # deprecated 36 | "interfacer", # deprecated 37 | "maligned", # deprecated 38 | "bodyclose", 39 | "goerr113", 40 | "wrapcheck", 41 | "maligned", 42 | "exhaustivestruct", 43 | "testpackage", 44 | "paralleltest", 45 | "tparallel", 46 | ] 47 | 48 | [issues] 49 | exclude-use-default = false 50 | max-per-linter = 0 51 | max-same-issues = 0 52 | exclude = [ 53 | "don't use an underscore in package name", 54 | "ST1003: should not use underscores in package names" 55 | ] 56 | 57 | [[issues.exclude-rules]] 58 | path = "(.+)_test.go" 59 | linters = ["goconst", "funlen", "godot"] 60 | -------------------------------------------------------------------------------- /.traefik.yml: -------------------------------------------------------------------------------- 1 | displayName: Rewrite Body 2 | summary: Rewrites the HTTP response body by replacing a search regex by a replacement string. 3 | type: middleware 4 | import: github.com/traefik/plugin-rewritebody 5 | compatibility: TODO 6 | testData: 7 | lastModified: true 8 | rewrites: 9 | - regex: "bar" 10 | replacement: "foo" 11 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2020 Containous SAS 190 | Copyright 2020 Traefik Labs 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: lint test vendor clean 2 | 3 | export GO111MODULE=on 4 | 5 | default: lint test 6 | 7 | lint: 8 | golangci-lint run 9 | 10 | test: 11 | go test -v -cover ./... 12 | 13 | yaegi_test: 14 | yaegi test -v . 15 | 16 | vendor: 17 | go mod vendor 18 | 19 | clean: 20 | rm -rf ./vendor -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Rewrite Body 2 | 3 | Rewrite body is a middleware plugin for [Traefik](https://github.com/traefik/traefik) which rewrites the HTTP response body by replacing a search regex by a replacement string. 4 | 5 | ## Configuration 6 | 7 | ### Static 8 | 9 | ```toml 10 | [pilot] 11 | token = "xxxx" 12 | 13 | [experimental.plugins.rewritebody] 14 | modulename = "github.com/traefik/plugin-rewritebody" 15 | version = "v0.3.1" 16 | ``` 17 | 18 | ### Dynamic 19 | 20 | To configure the `Rewrite Body` plugin you should create a [middleware](https://doc.traefik.io/traefik/middlewares/overview/) in 21 | your dynamic configuration as explained [here](https://doc.traefik.io/traefik/middlewares/overview/). 22 | The following example creates and uses the `rewritebody` middleware plugin to replace all `foo` occurrences by `bar` in the HTTP response body. 23 | 24 | If you want to apply some limits on the response body, you can chain this middleware plugin with the [Buffering middleware](https://doc.traefik.io/traefik/middlewares/http/buffering/) from Traefik. 25 | 26 | ```toml 27 | [http.routers] 28 | [http.routers.my-router] 29 | rule = "Host(`localhost`)" 30 | middlewares = ["rewrite-foo"] 31 | service = "my-service" 32 | 33 | [http.middlewares] 34 | [http.middlewares.rewrite-foo.plugin.rewritebody] 35 | # Keep Last-Modified header returned by the HTTP service. 36 | # By default, the Last-Modified header is removed. 37 | lastModified = true 38 | 39 | # Rewrites all "foo" occurences by "bar" 40 | [[http.middlewares.rewrite-foo.plugin.rewritebody.rewrites]] 41 | regex = "foo" 42 | replacement = "bar" 43 | 44 | [http.services] 45 | [http.services.my-service] 46 | [http.services.my-service.loadBalancer] 47 | [[http.services.my-service.loadBalancer.servers]] 48 | url = "http://127.0.0.1" 49 | ``` 50 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/traefik/plugin-rewritebody 2 | 3 | go 1.15 4 | -------------------------------------------------------------------------------- /rewritebody.go: -------------------------------------------------------------------------------- 1 | // Package plugin_rewritebody a plugin to rewrite response body. 2 | package plugin_rewritebody 3 | 4 | import ( 5 | "bufio" 6 | "bytes" 7 | "context" 8 | "fmt" 9 | "log" 10 | "net" 11 | "net/http" 12 | "regexp" 13 | ) 14 | 15 | // Rewrite holds one rewrite body configuration. 16 | type Rewrite struct { 17 | Regex string `json:"regex,omitempty"` 18 | Replacement string `json:"replacement,omitempty"` 19 | } 20 | 21 | // Config holds the plugin configuration. 22 | type Config struct { 23 | LastModified bool `json:"lastModified,omitempty"` 24 | Rewrites []Rewrite `json:"rewrites,omitempty"` 25 | } 26 | 27 | // CreateConfig creates and initializes the plugin configuration. 28 | func CreateConfig() *Config { 29 | return &Config{} 30 | } 31 | 32 | type rewrite struct { 33 | regex *regexp.Regexp 34 | replacement []byte 35 | } 36 | 37 | type rewriteBody struct { 38 | name string 39 | next http.Handler 40 | rewrites []rewrite 41 | lastModified bool 42 | } 43 | 44 | // New creates and returns a new rewrite body plugin instance. 45 | func New(_ context.Context, next http.Handler, config *Config, name string) (http.Handler, error) { 46 | rewrites := make([]rewrite, len(config.Rewrites)) 47 | 48 | for i, rewriteConfig := range config.Rewrites { 49 | regex, err := regexp.Compile(rewriteConfig.Regex) 50 | if err != nil { 51 | return nil, fmt.Errorf("error compiling regex %q: %w", rewriteConfig.Regex, err) 52 | } 53 | 54 | rewrites[i] = rewrite{ 55 | regex: regex, 56 | replacement: []byte(rewriteConfig.Replacement), 57 | } 58 | } 59 | 60 | return &rewriteBody{ 61 | name: name, 62 | next: next, 63 | rewrites: rewrites, 64 | lastModified: config.LastModified, 65 | }, nil 66 | } 67 | 68 | func (r *rewriteBody) ServeHTTP(rw http.ResponseWriter, req *http.Request) { 69 | wrappedWriter := &responseWriter{ 70 | lastModified: r.lastModified, 71 | ResponseWriter: rw, 72 | } 73 | 74 | r.next.ServeHTTP(wrappedWriter, req) 75 | 76 | bodyBytes := wrappedWriter.buffer.Bytes() 77 | 78 | contentEncoding := wrappedWriter.Header().Get("Content-Encoding") 79 | 80 | if contentEncoding != "" && contentEncoding != "identity" { 81 | if _, err := rw.Write(bodyBytes); err != nil { 82 | log.Printf("unable to write body: %v", err) 83 | } 84 | 85 | return 86 | } 87 | 88 | for _, rwt := range r.rewrites { 89 | bodyBytes = rwt.regex.ReplaceAll(bodyBytes, rwt.replacement) 90 | } 91 | 92 | if _, err := rw.Write(bodyBytes); err != nil { 93 | log.Printf("unable to write rewrited body: %v", err) 94 | } 95 | } 96 | 97 | type responseWriter struct { 98 | buffer bytes.Buffer 99 | lastModified bool 100 | wroteHeader bool 101 | 102 | http.ResponseWriter 103 | } 104 | 105 | func (r *responseWriter) WriteHeader(statusCode int) { 106 | if !r.lastModified { 107 | r.ResponseWriter.Header().Del("Last-Modified") 108 | } 109 | 110 | r.wroteHeader = true 111 | 112 | // Delegates the Content-Length Header creation to the final body write. 113 | r.ResponseWriter.Header().Del("Content-Length") 114 | 115 | r.ResponseWriter.WriteHeader(statusCode) 116 | } 117 | 118 | func (r *responseWriter) Write(p []byte) (int, error) { 119 | if !r.wroteHeader { 120 | r.WriteHeader(http.StatusOK) 121 | } 122 | 123 | return r.buffer.Write(p) 124 | } 125 | 126 | func (r *responseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) { 127 | hijacker, ok := r.ResponseWriter.(http.Hijacker) 128 | if !ok { 129 | return nil, nil, fmt.Errorf("%T is not a http.Hijacker", r.ResponseWriter) 130 | } 131 | 132 | return hijacker.Hijack() 133 | } 134 | 135 | func (r *responseWriter) Flush() { 136 | if flusher, ok := r.ResponseWriter.(http.Flusher); ok { 137 | flusher.Flush() 138 | } 139 | } 140 | -------------------------------------------------------------------------------- /rewritebody_test.go: -------------------------------------------------------------------------------- 1 | package plugin_rewritebody 2 | 3 | import ( 4 | "bytes" 5 | "context" 6 | "fmt" 7 | "net/http" 8 | "net/http/httptest" 9 | "strconv" 10 | "testing" 11 | ) 12 | 13 | func TestServeHTTP(t *testing.T) { 14 | tests := []struct { 15 | desc string 16 | contentEncoding string 17 | rewrites []Rewrite 18 | lastModified bool 19 | resBody string 20 | expResBody string 21 | expLastModified bool 22 | }{ 23 | { 24 | desc: "should replace foo by bar", 25 | rewrites: []Rewrite{ 26 | { 27 | Regex: "foo", 28 | Replacement: "bar", 29 | }, 30 | }, 31 | resBody: "foo is the new bar", 32 | expResBody: "bar is the new bar", 33 | }, 34 | { 35 | desc: "should replace foo by bar, then by foo", 36 | rewrites: []Rewrite{ 37 | { 38 | Regex: "foo", 39 | Replacement: "bar", 40 | }, 41 | { 42 | Regex: "bar", 43 | Replacement: "foo", 44 | }, 45 | }, 46 | resBody: "foo is the new bar", 47 | expResBody: "foo is the new foo", 48 | }, 49 | { 50 | desc: "should not replace anything if content encoding is not identity or empty", 51 | rewrites: []Rewrite{ 52 | { 53 | Regex: "foo", 54 | Replacement: "bar", 55 | }, 56 | }, 57 | contentEncoding: "gzip", 58 | resBody: "foo is the new bar", 59 | expResBody: "foo is the new bar", 60 | }, 61 | { 62 | desc: "should replace foo by bar if content encoding is identity", 63 | rewrites: []Rewrite{ 64 | { 65 | Regex: "foo", 66 | Replacement: "bar", 67 | }, 68 | }, 69 | contentEncoding: "identity", 70 | resBody: "foo is the new bar", 71 | expResBody: "bar is the new bar", 72 | }, 73 | { 74 | desc: "should not remove the last modified header", 75 | rewrites: []Rewrite{ 76 | { 77 | Regex: "foo", 78 | Replacement: "bar", 79 | }, 80 | }, 81 | contentEncoding: "identity", 82 | lastModified: true, 83 | resBody: "foo is the new bar", 84 | expResBody: "bar is the new bar", 85 | expLastModified: true, 86 | }, 87 | } 88 | 89 | for _, test := range tests { 90 | t.Run(test.desc, func(t *testing.T) { 91 | config := &Config{ 92 | LastModified: test.lastModified, 93 | Rewrites: test.rewrites, 94 | } 95 | 96 | next := func(rw http.ResponseWriter, req *http.Request) { 97 | rw.Header().Set("Content-Encoding", test.contentEncoding) 98 | rw.Header().Set("Last-Modified", "Thu, 02 Jun 2016 06:01:08 GMT") 99 | rw.Header().Set("Content-Length", strconv.Itoa(len(test.resBody))) 100 | rw.WriteHeader(http.StatusOK) 101 | 102 | _, _ = fmt.Fprintf(rw, test.resBody) 103 | } 104 | 105 | rewriteBody, err := New(context.Background(), http.HandlerFunc(next), config, "rewriteBody") 106 | if err != nil { 107 | t.Fatal(err) 108 | } 109 | 110 | recorder := httptest.NewRecorder() 111 | req := httptest.NewRequest(http.MethodGet, "/", nil) 112 | 113 | rewriteBody.ServeHTTP(recorder, req) 114 | 115 | if _, exists := recorder.Result().Header["Last-Modified"]; exists != test.expLastModified { 116 | t.Errorf("got last-modified header %v, want %v", exists, test.expLastModified) 117 | } 118 | 119 | if _, exists := recorder.Result().Header["Content-Length"]; exists { 120 | t.Error("The Content-Length Header must be deleted") 121 | } 122 | 123 | if !bytes.Equal([]byte(test.expResBody), recorder.Body.Bytes()) { 124 | t.Errorf("got body %q, want %q", recorder.Body.Bytes(), test.expResBody) 125 | } 126 | }) 127 | } 128 | } 129 | 130 | func TestNew(t *testing.T) { 131 | tests := []struct { 132 | desc string 133 | rewrites []Rewrite 134 | expErr bool 135 | }{ 136 | { 137 | desc: "should return no error", 138 | rewrites: []Rewrite{ 139 | { 140 | Regex: "foo", 141 | Replacement: "bar", 142 | }, 143 | { 144 | Regex: "bar", 145 | Replacement: "foo", 146 | }, 147 | }, 148 | expErr: false, 149 | }, 150 | { 151 | desc: "should return an error", 152 | rewrites: []Rewrite{ 153 | { 154 | Regex: "*", 155 | Replacement: "bar", 156 | }, 157 | }, 158 | expErr: true, 159 | }, 160 | } 161 | for _, test := range tests { 162 | t.Run(test.desc, func(t *testing.T) { 163 | config := &Config{ 164 | Rewrites: test.rewrites, 165 | } 166 | 167 | _, err := New(context.Background(), nil, config, "rewriteBody") 168 | if test.expErr && err == nil { 169 | t.Fatal("expected error on bad regexp format") 170 | } 171 | }) 172 | } 173 | } 174 | --------------------------------------------------------------------------------