├── .github ├── CHANGELOG.md ├── README.md └── workflows │ ├── lint.yml │ ├── run-gosec.yml │ └── tests.yml ├── .gitignore ├── LICENCE ├── cache.go ├── cache_test.go ├── go.mod └── go.sum /.github/CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | All notable changes to this project will be documented in this file. 3 | 4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 5 | 6 | (Dates are in YYYY-MM-DD format. This message is mainly for my own sake.) 7 | 8 | ## [Unreleased] 9 | 10 | ## [2.1.2] - 2020-09-29 11 | ### Added 12 | * Deprecation notice. 13 | 14 | ## [2.1.1] - 2020-09-25 15 | ### Fixed 16 | * Dynamic routes are now properly cached ([#3](https://github.com/codemicro/fiber-cache/issues/3)) 17 | 18 | ## [2.1.0] - 2020-09-22 19 | ### Changed 20 | * The `Content-Type` header is now cached and sent automatically. 21 | 22 | ## [2.0.1] - 2020-09-14 23 | ### Fixed 24 | * Errors are now properly forwarded to the error handler and are no longer lost in the endless void of space and time. 25 | * Thanks [@Fenny](https://github.com/Fenny) 26 | 27 | ## [2.0.0] - 2020-09-14 28 | ### Changed 29 | * Update to support Fiber version 2.0.0. 30 | ### Removed 31 | * Removed Go 1.11.x support. 32 | 33 | ## [1.0.2] - 2020-09-06 34 | ### Added 35 | * Add support for caching without expiration. 36 | 37 | ## [1.0.1] - 2020-08-28 38 | ### Fixed 39 | * Add missing mutex to status code storage map (t'was an oversight). 40 | 41 | ## [1.0.0] - 2020-08-27 42 | * Initial release 43 | 44 | [Unreleased]: https://github.com/codemicro/fiber-cache/compare/v2.1.2...HEAD 45 | [2.1.2]: https://github.com/codemicro/fiber-cache/compare/v2.1.1...v2.1.2 46 | [2.1.1]: https://github.com/codemicro/fiber-cache/compare/v2.1.0...v2.1.1 47 | [2.1.0]: https://github.com/codemicro/fiber-cache/compare/v2.0.1...v2.1.0 48 | [2.0.1]: https://github.com/codemicro/fiber-cache/compare/v2.0.0...v2.0.1 49 | [2.0.0]: https://github.com/codemicro/fiber-cache/compare/v1.0.2...v2.0.0 50 | [1.0.2]: https://github.com/codemicro/fiber-cache/compare/v1.0.1...v1.0.2 51 | [1.0.1]: https://github.com/codemicro/fiber-cache/compare/v1.0.0...v1.0.1 52 | [1.0.0]: https://github.com/codemicro/fiber-cache/releases/tag/v1.0.0 53 | -------------------------------------------------------------------------------- /.github/README.md: -------------------------------------------------------------------------------- 1 | # fiber-cache 2 | [![GitHub release (latest by date)](https://img.shields.io/github/v/release/codemicro/fiber-cache)](https://github.com/codemicro/fiber-cache/releases/latest) [![Keep a Changelog v1.0.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.0.0-%23E05735)](https://github.com/codemicro/fiber-cache/blob/master/.github/CHANGELOG.md) [![PkgGoDev](https://pkg.go.dev/badge/codemicro/fiber-cache/v2)](https://pkg.go.dev/github.com/codemicro/fiber-cache/v2) ![Tests](https://github.com/codemicro/fiber-cache/workflows/Run%20tests/badge.svg) ![Gosec audit](https://github.com/codemicro/fiber-cache/workflows/Gosec%20audit/badge.svg) 3 | 4 | fiber-cache is middleware that provides caching for specific routes in a Fiber application. 5 | 6 | # fiber-cache is now deprecated 7 | 8 | Fiber v2.0.3+ now includes a bundled cache middleware, hence this package is no longer required. See https://github.com/gofiber/fiber/tree/master/middleware/cache for more info. 9 | 10 | ### Examples 11 | 12 | The most basic caching you can do is like this: 13 | 14 | ```go 15 | app.Get("/your/route", fcache.New(), yourHandler) 16 | ``` 17 | 18 | This will then cache the response and status code generated by that endpoint for the default TTL (Time-To-Live) specified. You don't have to do anything different in your handler than you normally would. If you have not changed the default TTL value, it is `5 * time.Minute`. 19 | 20 | You can change the default TTL for all endpoints by setting `fcache.Config.DefaultTTL` to a `time.Duration`. This will only have an effect on handlers registered after you change the value. 21 | 22 | ```go 23 | fcache.Config.DefaultTTL = time.Minute * 2 24 | ``` 25 | 26 | You can also set the TTL for each different handler, for example if you want to set one handler to a 20 second TTL while also maintaining the default TTL at 5 minutes. 27 | 28 | ```go 29 | app.Get("/your/route", fcache.NewWithTTL(fcache.AutoGenerateKey, time.Second*20), yourHandler) 30 | ``` 31 | 32 | Whenever you have the option to set a TTL, you can also set it to have no expiration. The handler function will be called once and the value stored until your program has exited. This can be done using `fcache.NoExpiration`. 33 | 34 | ```go 35 | app.Get("/your/route", fcache.NewWithTTL(fcache.AutoGenerateKey, fcache.NoExpiration), yourHandler) 36 | ``` 37 | 38 | Internally, caching is done using key-value pairs. Normally, the keys are automatically generated, but you can choose to set them manually if you want. 39 | 40 | ```go 41 | app.Get("/your/route", fcache.NewWithKey("yourKeyHere"), yourHandler) 42 | ``` 43 | 44 | The cache key for the current route is stored in `c.Locals` as `cacheKey`. This is especially useful if you're using automatically generated keys and want to access the underlying cache engine. This can be done through the `fcache.Cache` variable. [Please click here for information about that.](https://github.com/patrickmn/go-cache) 45 | 46 | ```go 47 | app.Get("/your/route", fcache.New(), func(c *fiber.Ctx) error { 48 | cacheKey := c.Locals("cacheKey").(string) // -> cacheKey-0 49 | 50 | data, found := fcache.Cache.Get(cacheKey) 51 | 52 | // ... 53 | 54 | return c.Send("My cache key is: " + cacheKey) // -> My cache key is: cacheKey-0 55 | }) 56 | ``` 57 | 58 | ### Limitations 59 | 60 | #### 1: headers 61 | 62 | Aside from the `Content-Type` header, fiber-cache will not cache headers. If you want a certain header to be added to every response on a specific endpoint, you'll have to add a custom middleware before the cache middleware. 63 | 64 | ```go 65 | app.Get("/", func(c *fiber.Ctx) error { 66 | c.Append("server", "potato") 67 | return c.Next() 68 | }, fcache.New(), yourHandler) 69 | ``` 70 | 71 | The `Content-Type` header is the only header that is automatically cached and sent. 72 | 73 | #### 2: scope 74 | 75 | `fiber-cache` should not be registered as a global middleware (`app.Use(fcache.New())`) as it will cache every endpoint, 76 | including responses from POST and DELETE endpoints while also not running the handler endpoint. 77 | 78 | ### Reference 79 | 80 | [https://pkg.go.dev/github.com/codemicro/fiber-cache/v2](https://pkg.go.dev/github.com/codemicro/fiber-cache/v2) 81 | 82 | ### Installation 83 | You must have Go 1.14 or higher installed before attempting installation. 84 | 85 | Installation is done using the `go get` command: 86 | 87 | ``` 88 | go get -u github.com/codemicro/fiber-cache/v2 89 | ``` 90 | 91 | You can then import the package as follows: 92 | 93 | ```go 94 | import ( 95 | fcache "github.com/codemicro/fiber-cache/v2" 96 | ) 97 | ``` 98 | 99 | ### Benchmarks 100 | 101 | Consider the following example: 102 | 103 | ```go 104 | app.Get("/", fcache.New(), func(c *fiber.Ctx) error { 105 | time.Sleep(time.Second * 5) 106 | return c.SendString("Hello world") 107 | }) 108 | ``` 109 | 110 | [Bombardier](https://github.com/codesenberg/bombardier) output (after 1 initial request) 111 | 112 | ``` 113 | > bombardier -c 125 -n 50000 http://127.0.0.1:5000 114 | Bombarding http://127.0.0.1:5000 with 50000 request(s) using 125 connection(s) 115 | 50000 / 50000 [=====================================================================================] 100.00% 124517/s 0s 116 | Done! 117 | Statistics Avg Stdev Max 118 | Reqs/sec 160806.70 22109.28 175973.08 119 | Latency 775.73us 274.91us 15.00ms 120 | HTTP codes: 121 | 1xx - 0, 2xx - 50000, 3xx - 0, 4xx - 0, 5xx - 0 122 | others - 0 123 | Throughput: 28.90MB/s 124 | ``` 125 | 126 | ### Licence 127 | fiber-cache is free and open source software covered by the Mozilla Public Licence v2. 128 | 129 | #### Third party library licences 130 | * [gofiber/fiber](https://github.com/gofiber/fiber/blob/master/LICENSE) 131 | * [patrickmn/go-cache](https://github.com/patrickmn/go-cache/blob/master/LICENSE) 132 | 133 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | name: Lint codebase 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | branches: 9 | - master 10 | workflow_dispatch: 11 | 12 | jobs: 13 | Golint: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Fetch Repository 17 | uses: actions/checkout@v2 18 | - name: Run Golint 19 | uses: reviewdog/action-golangci-lint@v1 20 | with: 21 | golangci_lint_flags: "--tests=false" -------------------------------------------------------------------------------- /.github/workflows/run-gosec.yml: -------------------------------------------------------------------------------- 1 | name: Gosec audit 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | branches: 9 | - master 10 | workflow_dispatch: 11 | 12 | jobs: 13 | 14 | tests: 15 | runs-on: ubuntu-latest 16 | env: 17 | GO111MODULE: on 18 | steps: 19 | - name: Checkout Source 20 | uses: actions/checkout@v2 21 | - name: Run Gosec Security Scanner 22 | uses: securego/gosec@master 23 | with: 24 | args: -exclude=G104 ./... -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: Run tests 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | branches: 9 | - master 10 | workflow_dispatch: 11 | 12 | jobs: 13 | 14 | Build: 15 | strategy: 16 | matrix: 17 | go-version: [1.14.x] 18 | platform: [ubuntu-latest, windows-latest] 19 | runs-on: ${{ matrix.platform }} 20 | steps: 21 | - name: Install Go 22 | uses: actions/setup-go@v1 23 | with: 24 | go-version: ${{ matrix.go-version }} 25 | - name: Fetch Repository 26 | uses: actions/checkout@v2 27 | - name: Run Test 28 | run: go test ./... -v -race -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.toptal.com/developers/gitignore/api/go,jetbrains+all,windows 3 | # Edit at https://www.toptal.com/developers/gitignore?templates=go,jetbrains+all,windows 4 | 5 | ### Go ### 6 | # Binaries for programs and plugins 7 | *.exe 8 | *.exe~ 9 | *.dll 10 | *.so 11 | *.dylib 12 | 13 | # Test binary, built with `go test -c` 14 | *.test 15 | 16 | # Output of the go coverage tool, specifically when used with LiteIDE 17 | *.out 18 | 19 | # Dependency directories (remove the comment below to include it) 20 | # vendor/ 21 | 22 | ### Go Patch ### 23 | /vendor/ 24 | /Godeps/ 25 | 26 | ### JetBrains+all ### 27 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 28 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 29 | 30 | # User-specific stuff 31 | .idea/**/workspace.xml 32 | .idea/**/tasks.xml 33 | .idea/**/usage.statistics.xml 34 | .idea/**/dictionaries 35 | .idea/**/shelf 36 | 37 | # Generated files 38 | .idea/**/contentModel.xml 39 | 40 | # Sensitive or high-churn files 41 | .idea/**/dataSources/ 42 | .idea/**/dataSources.ids 43 | .idea/**/dataSources.local.xml 44 | .idea/**/sqlDataSources.xml 45 | .idea/**/dynamic.xml 46 | .idea/**/uiDesigner.xml 47 | .idea/**/dbnavigator.xml 48 | 49 | # Gradle 50 | .idea/**/gradle.xml 51 | .idea/**/libraries 52 | 53 | # Gradle and Maven with auto-import 54 | # When using Gradle or Maven with auto-import, you should exclude module files, 55 | # since they will be recreated, and may cause churn. Uncomment if using 56 | # auto-import. 57 | # .idea/artifacts 58 | # .idea/compiler.xml 59 | # .idea/jarRepositories.xml 60 | # .idea/modules.xml 61 | # .idea/*.iml 62 | # .idea/modules 63 | # *.iml 64 | # *.ipr 65 | 66 | # CMake 67 | cmake-build-*/ 68 | 69 | # Mongo Explorer plugin 70 | .idea/**/mongoSettings.xml 71 | 72 | # File-based project format 73 | *.iws 74 | 75 | # IntelliJ 76 | out/ 77 | 78 | # mpeltonen/sbt-idea plugin 79 | .idea_modules/ 80 | 81 | # JIRA plugin 82 | atlassian-ide-plugin.xml 83 | 84 | # Cursive Clojure plugin 85 | .idea/replstate.xml 86 | 87 | # Crashlytics plugin (for Android Studio and IntelliJ) 88 | com_crashlytics_export_strings.xml 89 | crashlytics.properties 90 | crashlytics-build.properties 91 | fabric.properties 92 | 93 | # Editor-based Rest Client 94 | .idea/httpRequests 95 | 96 | # Android studio 3.1+ serialized cache file 97 | .idea/caches/build_file_checksums.ser 98 | 99 | ### JetBrains+all Patch ### 100 | # Ignores the whole .idea folder and all .iml files 101 | # See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360 102 | 103 | .idea/ 104 | 105 | # Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023 106 | 107 | *.iml 108 | modules.xml 109 | .idea/misc.xml 110 | *.ipr 111 | 112 | # Sonarlint plugin 113 | .idea/sonarlint 114 | 115 | ### Windows ### 116 | # Windows thumbnail cache files 117 | Thumbs.db 118 | Thumbs.db:encryptable 119 | ehthumbs.db 120 | ehthumbs_vista.db 121 | 122 | # Dump file 123 | *.stackdump 124 | 125 | # Folder config file 126 | [Dd]esktop.ini 127 | 128 | # Recycle Bin used on file shares 129 | $RECYCLE.BIN/ 130 | 131 | # Windows Installer files 132 | *.cab 133 | *.msi 134 | *.msix 135 | *.msm 136 | *.msp 137 | 138 | # Windows shortcuts 139 | *.lnk 140 | 141 | # End of https://www.toptal.com/developers/gitignore/api/go,jetbrains+all,windows 142 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /cache.go: -------------------------------------------------------------------------------- 1 | // package fcache provides caching middleware for the Fiber web framework. The caching engine can be accessed through the Cache variable. 2 | package fcache 3 | 4 | import ( 5 | "github.com/gofiber/fiber/v2/utils" 6 | "time" 7 | "fmt" 8 | 9 | "github.com/gofiber/fiber/v2" 10 | gc "github.com/patrickmn/go-cache" 11 | ) 12 | 13 | var ( 14 | Cache *gc.Cache 15 | Config internalConfig 16 | ) 17 | 18 | const ( 19 | AutoGenerateKey = "" 20 | NoExpiration = gc.NoExpiration 21 | ) 22 | 23 | func init() { 24 | fmt.Println("fiber-cache is now deprecated, since Fiber v2.0.3+ now includes a bundled cache middleware.\nSee https://github.com/gofiber/fiber/tree/master/middleware/cache for more info.") 25 | Config.DefaultTTL = 5 * time.Minute 26 | Config.CleanupInterval = 10 * time.Minute 27 | Cache = gc.New(Config.DefaultTTL, Config.CleanupInterval) 28 | } 29 | 30 | type CacheEntry struct { 31 | Body []byte 32 | StatusCode int 33 | ContentType []byte 34 | } 35 | 36 | type internalConfig struct { 37 | CleanupInterval time.Duration 38 | DefaultTTL time.Duration 39 | } 40 | 41 | func createMiddleware(selectedKey string, ttl time.Duration) func(*fiber.Ctx) error { 42 | return func(c *fiber.Ctx) error { 43 | 44 | var key string 45 | 46 | if selectedKey == AutoGenerateKey { 47 | key = utils.ImmutableString(c.Path()) 48 | } else { 49 | key = selectedKey 50 | } 51 | 52 | val, found := Cache.Get(key) 53 | if found { 54 | entry := val.(CacheEntry) 55 | c.Response().SetBody(entry.Body) 56 | c.Response().SetStatusCode(entry.StatusCode) 57 | c.Response().Header.SetContentTypeBytes(entry.ContentType) 58 | return nil 59 | } 60 | 61 | c.Locals("cacheKey", key) 62 | 63 | err := c.Next() 64 | 65 | if err == nil { 66 | Cache.Set(key, CacheEntry{ 67 | Body: c.Response().Body(), 68 | StatusCode: c.Response().StatusCode(), 69 | ContentType: c.Response().Header.ContentType(), 70 | }, ttl) 71 | } 72 | 73 | return err 74 | 75 | } 76 | } 77 | 78 | // New returns a new instance of the caching middleware, with an automatically generated key and the default TTL. 79 | func New() func(*fiber.Ctx) error { 80 | return createMiddleware(AutoGenerateKey, Config.DefaultTTL) 81 | } 82 | 83 | // NewWithKey returns a new instance of the caching middleware with the default TTL and the option to set your own cache key. If this is an empty string or AutoGenerateKey, a key will be automatically generated. 84 | func NewWithKey(key string) func(*fiber.Ctx) error { 85 | return createMiddleware(key, Config.DefaultTTL) 86 | } 87 | 88 | // NewWithTTL returns a new instance of the caching middleware with the option to define your own cache key and your own TTL. If the cache key you set is an empty string or AutoGenerateKey, a key will be automatically generated. 89 | func NewWithTTL(key string, ttl time.Duration) func(*fiber.Ctx) error { 90 | return createMiddleware(key, ttl) 91 | } 92 | -------------------------------------------------------------------------------- /cache_test.go: -------------------------------------------------------------------------------- 1 | package fcache 2 | 3 | import ( 4 | "bytes" 5 | "net/http" 6 | "net/http/httptest" 7 | "testing" 8 | "time" 9 | 10 | "github.com/gofiber/fiber/v2" 11 | gc "github.com/patrickmn/go-cache" 12 | ) 13 | 14 | // createNewCacheForTest is needed as the cache is global to the import in the package. If this is run before 15 | // each new test, it prevents data from other tests leaking over. 16 | func createNewCacheForTest() { 17 | Cache = gc.New(Config.DefaultTTL, Config.CleanupInterval) 18 | } 19 | 20 | func getResponseBody(resp *http.Response) string { 21 | buf := new(bytes.Buffer) 22 | buf.ReadFrom(resp.Body) 23 | return buf.String() 24 | } 25 | 26 | func Test_valueStored(t *testing.T) { 27 | createNewCacheForTest() 28 | app := fiber.New() 29 | 30 | responseText := "thisIsAResponse" 31 | handlerKey := "sampleKey" 32 | 33 | app.Get("/", NewWithKey(handlerKey), func(c *fiber.Ctx) error { 34 | return c.SendString(responseText) 35 | }) 36 | 37 | app.Test(httptest.NewRequest("GET", "/", nil)) 38 | 39 | value, _ := Cache.Get(handlerKey) 40 | 41 | if string(value.(CacheEntry).Body) != responseText { 42 | t.Fatal("Value in cache does not match expected") 43 | } 44 | } 45 | 46 | func Test_cacheValueReturned(t *testing.T) { 47 | createNewCacheForTest() 48 | app := fiber.New() 49 | 50 | responseText := "thisIsAResponse" 51 | modResponse := "thisIsAModifiedResponse" 52 | handlerKey := "sampleKey" 53 | 54 | app.Get("/", NewWithKey(handlerKey), func(c *fiber.Ctx) error { 55 | c.SendString(responseText) 56 | return nil 57 | }) 58 | 59 | Cache.Set(handlerKey, CacheEntry{ 60 | Body: []byte(modResponse), 61 | StatusCode: 200, 62 | ContentType: []byte("text/plain"), 63 | }, Config.DefaultTTL) 64 | 65 | resp, _ := app.Test(httptest.NewRequest("GET", "/", nil)) 66 | 67 | returnedResponse := getResponseBody(resp) 68 | 69 | if returnedResponse != modResponse { 70 | t.Fatal("Value in cache does not match expected") 71 | } 72 | } 73 | 74 | func Test_customTTL(t *testing.T) { 75 | createNewCacheForTest() 76 | app := fiber.New() 77 | 78 | responseText := "thisIsAResponse" 79 | handlerKey := "sampleKey" 80 | 81 | app.Get("/", NewWithTTL(handlerKey, time.Second*2), func(c *fiber.Ctx) error { 82 | c.SendString(responseText) 83 | return nil 84 | }) 85 | 86 | app.Test(httptest.NewRequest("GET", "/", nil)) 87 | 88 | time.Sleep(time.Second * 3) // by this point, the cache should have expired 89 | 90 | responseText = "thisIsDifferent" 91 | 92 | resp, _ := app.Test(httptest.NewRequest("GET", "/", nil)) 93 | 94 | returnedResponse := getResponseBody(resp) 95 | 96 | if returnedResponse != responseText { 97 | t.Fatal("Cache was not refreshed after TTL expired") 98 | } 99 | } 100 | 101 | func Test_automaticKeyGeneration(t *testing.T) { 102 | createNewCacheForTest() 103 | app := fiber.New() 104 | 105 | responseText1 := "thisIsAResponse" 106 | responseText2 := "thisIsADifferentResponse" 107 | 108 | app.Get("/", New(), func(c *fiber.Ctx) error { 109 | c.SendString(responseText1) 110 | return nil 111 | }) 112 | 113 | app.Get("/other", New(), func(c *fiber.Ctx) error { 114 | c.SendString(responseText2) 115 | return nil 116 | }) 117 | 118 | resp1, _ := app.Test(httptest.NewRequest("GET", "/", nil)) 119 | resp2, _ := app.Test(httptest.NewRequest("GET", "/other", nil)) 120 | 121 | returnedResponse1 := getResponseBody(resp1) 122 | returnedResponse2 := getResponseBody(resp2) 123 | 124 | if returnedResponse1 == returnedResponse2 { 125 | t.Fatal("A collision has occured between automatically generated keys") 126 | } else if returnedResponse1 != responseText1 || returnedResponse2 != responseText2 { 127 | t.Fatal("Incorrect values are being stored in cache for automatically generated keys") 128 | } 129 | } 130 | 131 | func Test_automaticKeyGenerationWithFlag(t *testing.T) { 132 | createNewCacheForTest() 133 | 134 | app := fiber.New() 135 | responseText := "hello world this is a response" 136 | var cacheKey string 137 | 138 | app.Get("/", NewWithKey(AutoGenerateKey), func(c *fiber.Ctx) error { 139 | cacheKey = c.Locals("cacheKey").(string) 140 | c.SendString(responseText) 141 | return nil 142 | }) 143 | 144 | app.Test(httptest.NewRequest("GET", "/", nil)) 145 | 146 | if cacheKey == "" { 147 | t.Fatal("Automatic key generation is failing or the cache key is not being set") 148 | } 149 | } 150 | 151 | func Test_correctContentTypeSet(t *testing.T) { 152 | createNewCacheForTest() 153 | 154 | app := fiber.New() 155 | 156 | app.Get("/", New(), func(c *fiber.Ctx) error { 157 | return c.JSON(map[string]string{"hello":"world"}) 158 | }) 159 | 160 | app.Test(httptest.NewRequest("GET", "/", nil)) // load cache response 161 | 162 | resp, _ := app.Test(httptest.NewRequest("GET", "/", nil)) 163 | 164 | if resp.Header["Content-Type"][0] != "application/json" { 165 | t.Fatal("The content type header is not being set correctly") 166 | } 167 | } 168 | 169 | func Test_dynamicRoutes(t *testing.T) { 170 | createNewCacheForTest() 171 | app := fiber.New() 172 | 173 | responseText := "sampleResponse" 174 | 175 | app.Get("/:id", New(), func(c *fiber.Ctx) error { 176 | return c.SendString(responseText + c.Params("id")) 177 | }) 178 | 179 | resp1, _ := app.Test(httptest.NewRequest("GET", "/123", nil)) 180 | resp2, _ := app.Test(httptest.NewRequest("GET", "/789", nil)) 181 | 182 | returnedResponse1 := getResponseBody(resp1) 183 | returnedResponse2 := getResponseBody(resp2) 184 | 185 | if returnedResponse1 == returnedResponse2 { 186 | t.Fatal("The same response has been cached for a dynamic URL with different parameters") 187 | } 188 | } 189 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/codemicro/fiber-cache/v2 2 | 3 | go 1.14 4 | 5 | require ( 6 | github.com/gofiber/fiber/v2 v2.0.4 7 | github.com/klauspost/compress v1.11.0 // indirect 8 | github.com/patrickmn/go-cache v2.1.0+incompatible 9 | ) 10 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/andybalholm/brotli v1.0.0 h1:7UCwP93aiSfvWpapti8g88vVVGp2qqtGyePsSuDafo4= 2 | github.com/andybalholm/brotli v1.0.0/go.mod h1:loMXtMfwqflxFJPmdbJO0a3KNoPuLBgiu3qAvBg8x/Y= 3 | github.com/gofiber/fiber/v2 v2.0.0 h1:YF2BcEO7aJtIR84QjfMzxwEVsbOmh2xFzPlNvX53hTs= 4 | github.com/gofiber/fiber/v2 v2.0.0/go.mod h1:GeIpT8VILgZt3Tn6gATjwb39Ff8OdM0qnZ2grAA0Vts= 5 | github.com/gofiber/fiber/v2 v2.0.4 h1:57Q8Uq6Y/N/Glx9666ScyBbjcIW1xDyl8ic/W8sT9qY= 6 | github.com/gofiber/fiber/v2 v2.0.4/go.mod h1:VyfrlfcUCW0TcO5uaLHVlxZ8N25BgwnP6YjkzJmJP24= 7 | github.com/klauspost/compress v1.10.7 h1:7rix8v8GpI3ZBb0nSozFRgbtXKv+hOe+qfEpZqybrAg= 8 | github.com/klauspost/compress v1.10.7/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs= 9 | github.com/klauspost/compress v1.11.0 h1:wJbzvpYMVGG9iTI9VxpnNZfd4DzMPoCWze3GgSqz8yg= 10 | github.com/klauspost/compress v1.11.0/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs= 11 | github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc= 12 | github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ= 13 | github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw= 14 | github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc= 15 | github.com/valyala/fasthttp v1.16.0 h1:9zAqOYLl8Tuy3E5R6ckzGDJ1g8+pw15oQp2iL9Jl6gQ= 16 | github.com/valyala/fasthttp v1.16.0/go.mod h1:YOKImeEosDdBPnxc0gy7INqi3m1zK6A+xl6TwOBhHCA= 17 | github.com/valyala/tcplisten v0.0.0-20161114210144-ceec8f93295a h1:0R4NLDRDZX6JcmhJgXi5E4b8Wg84ihbmUKp/GvSPEzc= 18 | github.com/valyala/tcplisten v0.0.0-20161114210144-ceec8f93295a/go.mod h1:v3UYOV9WzVtRmSR+PDvWpU/qWl4Wa5LApYYX4ZtKbio= 19 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= 20 | golang.org/x/net v0.0.0-20200602114024-627f9648deb9/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= 21 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 22 | golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 23 | golang.org/x/sys v0.0.0-20200602225109-6fdc65e7d980 h1:OjiUf46hAmXblsZdnoSXsEUSKU8r1UEzcL5RVZ4gO9Y= 24 | golang.org/x/sys v0.0.0-20200602225109-6fdc65e7d980/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 25 | golang.org/x/sys v0.0.0-20200909081042-eff7692f9009 h1:W0lCpv29Hv0UaM1LXb9QlBHLNP8UFfcKjblhVCWftOM= 26 | golang.org/x/sys v0.0.0-20200909081042-eff7692f9009/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 27 | golang.org/x/sys v0.0.0-20200929083018-4d22bbb62b3c h1:/h0vtH0PyU0xAoZJVcRw1k0Ng+U0JAy3QDiFmppIlIE= 28 | golang.org/x/sys v0.0.0-20200929083018-4d22bbb62b3c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 29 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 30 | --------------------------------------------------------------------------------