├── .dockerignore ├── .editorconfig ├── .github ├── CODEOWNERS ├── FUNDING.yml ├── dependabot.yml └── workflows │ ├── api-breakage.yml │ ├── ci.yml │ ├── nightly.yml │ ├── validate.yml │ └── verify-documentation.yml ├── .gitignore ├── .spi.yml ├── .swift-format ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── Dockerfile ├── LICENSE ├── Package.swift ├── README.md ├── Sources └── HummingbirdRedis │ ├── Deprecations.swift │ ├── Persist+Redis.swift │ ├── Redis+Codable.swift │ ├── RedisConfiguration.swift │ └── RedisConnectionPoolService.swift ├── Tests └── HummingbirdRedisTests │ ├── PersistTests.swift │ └── RedisTests.swift └── scripts └── validate.sh /.dockerignore: -------------------------------------------------------------------------------- 1 | .build 2 | .git -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | indent_size = 4 6 | end_of_line = lf 7 | insert_final_newline = true 8 | trim_trailing_whitespace = true -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @adam-fowler @Joannis 2 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: adam-fowler 2 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "github-actions" 4 | directory: "/" 5 | schedule: 6 | interval: "daily" 7 | ignore: 8 | - dependency-name: "codecov/codecov-action" 9 | update-types: ["version-update:semver-major"] 10 | groups: 11 | dependencies: 12 | patterns: 13 | - "*" 14 | - package-ecosystem: "swift" 15 | directory: "/" 16 | schedule: 17 | interval: "daily" 18 | open-pull-requests-limit: 5 19 | allow: 20 | - dependency-type: all 21 | groups: 22 | all-dependencies: 23 | patterns: 24 | - "*" 25 | -------------------------------------------------------------------------------- /.github/workflows/api-breakage.yml: -------------------------------------------------------------------------------- 1 | name: API breaking changes 2 | 3 | on: 4 | pull_request: 5 | concurrency: 6 | group: ${{ github.workflow }}-${{ github.ref }}-apibreakage 7 | cancel-in-progress: true 8 | 9 | jobs: 10 | linux: 11 | runs-on: ubuntu-latest 12 | timeout-minutes: 15 13 | container: 14 | image: swift:latest 15 | steps: 16 | - name: Checkout 17 | uses: actions/checkout@v4 18 | with: 19 | fetch-depth: 0 20 | # https://github.com/actions/checkout/issues/766 21 | - name: Mark the workspace as safe 22 | run: git config --global --add safe.directory ${GITHUB_WORKSPACE} 23 | - name: API breaking changes 24 | run: | 25 | swift package diagnose-api-breaking-changes origin/${GITHUB_BASE_REF} 26 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | paths: 8 | - '**.swift' 9 | - '**.yml' 10 | pull_request: 11 | workflow_dispatch: 12 | concurrency: 13 | group: ${{ github.workflow }}-${{ github.ref }}-ci 14 | cancel-in-progress: true 15 | 16 | env: 17 | REDIS_HOSTNAME: redis 18 | jobs: 19 | linux: 20 | runs-on: ubuntu-latest 21 | timeout-minutes: 15 22 | strategy: 23 | matrix: 24 | image: ["swift:5.10", "swift:6.0", "swift:6.1", "swiftlang/swift:nightly-6.2-noble"] 25 | container: 26 | image: ${{ matrix.image }} 27 | services: 28 | redis: 29 | image: redis 30 | ports: 31 | - 6379:6379 32 | options: --entrypoint redis-server 33 | 34 | steps: 35 | - name: Checkout 36 | uses: actions/checkout@v4 37 | - name: Test 38 | run: | 39 | swift test --enable-code-coverage 40 | - name: Convert coverage files 41 | run: | 42 | llvm-cov export -format="lcov" \ 43 | .build/debug/hummingbird-redisPackageTests.xctest \ 44 | -ignore-filename-regex="\/Tests\/" \ 45 | -ignore-filename-regex="\/Benchmarks\/" \ 46 | -instr-profile .build/debug/codecov/default.profdata > info.lcov 47 | - name: Upload to codecov.io 48 | uses: codecov/codecov-action@v4 49 | with: 50 | files: info.lcov 51 | token: ${{ secrets.CODECOV_TOKEN }} 52 | -------------------------------------------------------------------------------- /.github/workflows/nightly.yml: -------------------------------------------------------------------------------- 1 | name: Swift nightly build 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | env: 7 | REDIS_HOSTNAME: redis 8 | jobs: 9 | linux: 10 | runs-on: ubuntu-latest 11 | timeout-minutes: 15 12 | strategy: 13 | matrix: 14 | image: ['nightly-focal', 'nightly-jammy', 'nightly-amazonlinux2'] 15 | container: 16 | image: swiftlang/swift:${{ matrix.image }} 17 | services: 18 | redis: 19 | image: redis 20 | ports: 21 | - 6379:6379 22 | options: --entrypoint redis-server 23 | 24 | steps: 25 | - name: Checkout 26 | uses: actions/checkout@v4 27 | - name: Test 28 | run: | 29 | swift test 30 | -------------------------------------------------------------------------------- /.github/workflows/validate.yml: -------------------------------------------------------------------------------- 1 | name: Validity Check 2 | 3 | on: 4 | pull_request: 5 | concurrency: 6 | group: ${{ github.workflow }}-${{ github.ref }}-validate 7 | cancel-in-progress: true 8 | 9 | jobs: 10 | validate: 11 | runs-on: ubuntu-latest 12 | timeout-minutes: 15 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v4 16 | with: 17 | fetch-depth: 1 18 | - name: run script 19 | run: ./scripts/validate.sh 20 | -------------------------------------------------------------------------------- /.github/workflows/verify-documentation.yml: -------------------------------------------------------------------------------- 1 | name: Verify Documentation 2 | 3 | on: 4 | pull_request: 5 | concurrency: 6 | group: ${{ github.workflow }}-${{ github.ref }}-verifydocs 7 | cancel-in-progress: true 8 | 9 | jobs: 10 | linux: 11 | runs-on: ubuntu-latest 12 | timeout-minutes: 15 13 | container: 14 | image: swift:latest 15 | steps: 16 | - name: Install rsync 📚 17 | run: | 18 | apt-get update && apt-get install -y rsync bc 19 | - name: Checkout 20 | uses: actions/checkout@v4 21 | with: 22 | fetch-depth: 0 23 | path: "package" 24 | - name: Checkout 25 | uses: actions/checkout@v4 26 | with: 27 | repository: "hummingbird-project/hummingbird-docs" 28 | fetch-depth: 0 29 | path: "documentation" 30 | - name: Verify 31 | run: | 32 | cd documentation 33 | swift package edit ${GITHUB_REPOSITORY#*/} --path ../package 34 | ./scripts/build-docc.sh -e 35 | 36 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .build/ 3 | .swiftpm/ 4 | .vscode/ 5 | .index-build/ 6 | .devcontainer/ 7 | /Packages 8 | /*.xcodeproj 9 | xcuserdata/ 10 | Package.resolved 11 | /public 12 | /docs 13 | .benchmarkBaselines -------------------------------------------------------------------------------- /.spi.yml: -------------------------------------------------------------------------------- 1 | version: 1 2 | external_links: 3 | documentation: "https://docs.hummingbird.codes/2.0/documentation/hummingbirdredis" 4 | -------------------------------------------------------------------------------- /.swift-format: -------------------------------------------------------------------------------- 1 | { 2 | "version" : 1, 3 | "indentation" : { 4 | "spaces" : 4 5 | }, 6 | "tabWidth" : 4, 7 | "fileScopedDeclarationPrivacy" : { 8 | "accessLevel" : "private" 9 | }, 10 | "spacesAroundRangeFormationOperators" : false, 11 | "indentConditionalCompilationBlocks" : false, 12 | "indentSwitchCaseLabels" : false, 13 | "lineBreakAroundMultilineExpressionChainComponents" : false, 14 | "lineBreakBeforeControlFlowKeywords" : false, 15 | "lineBreakBeforeEachArgument" : true, 16 | "lineBreakBeforeEachGenericRequirement" : true, 17 | "lineLength" : 150, 18 | "maximumBlankLines" : 1, 19 | "respectsExistingLineBreaks" : true, 20 | "prioritizeKeepingFunctionOutputTogether" : true, 21 | "multiElementCollectionTrailingCommas" : true, 22 | "rules" : { 23 | "AllPublicDeclarationsHaveDocumentation" : false, 24 | "AlwaysUseLiteralForEmptyCollectionInit" : false, 25 | "AlwaysUseLowerCamelCase" : false, 26 | "AmbiguousTrailingClosureOverload" : true, 27 | "BeginDocumentationCommentWithOneLineSummary" : false, 28 | "DoNotUseSemicolons" : true, 29 | "DontRepeatTypeInStaticProperties" : true, 30 | "FileScopedDeclarationPrivacy" : true, 31 | "FullyIndirectEnum" : true, 32 | "GroupNumericLiterals" : true, 33 | "IdentifiersMustBeASCII" : true, 34 | "NeverForceUnwrap" : false, 35 | "NeverUseForceTry" : false, 36 | "NeverUseImplicitlyUnwrappedOptionals" : false, 37 | "NoAccessLevelOnExtensionDeclaration" : true, 38 | "NoAssignmentInExpressions" : true, 39 | "NoBlockComments" : true, 40 | "NoCasesWithOnlyFallthrough" : true, 41 | "NoEmptyTrailingClosureParentheses" : true, 42 | "NoLabelsInCasePatterns" : true, 43 | "NoLeadingUnderscores" : false, 44 | "NoParensAroundConditions" : true, 45 | "NoVoidReturnOnFunctionSignature" : true, 46 | "OmitExplicitReturns" : true, 47 | "OneCasePerLine" : true, 48 | "OneVariableDeclarationPerLine" : true, 49 | "OnlyOneTrailingClosureArgument" : true, 50 | "OrderedImports" : true, 51 | "ReplaceForEachWithForLoop" : true, 52 | "ReturnVoidInsteadOfEmptyTuple" : true, 53 | "UseEarlyExits" : false, 54 | "UseExplicitNilCheckInConditions" : false, 55 | "UseLetInEveryBoundCaseVariable" : false, 56 | "UseShorthandTypeNames" : true, 57 | "UseSingleLinePropertyGetter" : false, 58 | "UseSynthesizedInitializer" : false, 59 | "UseTripleSlashForDocumentationComments" : true, 60 | "UseWhereClausesInForLoops" : false, 61 | "ValidateDocumentationComments" : false 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Code of Conduct 2 | 3 | All developers should feel welcome and encouraged to contribute to Hummingbird. Because of this we have adopted the code of conduct defined by [contributor-covenant.org](https://www.contributor-covenant.org). This document is used across many open source 4 | communities, and we think it articulates our values well. The full text is copied below: 5 | 6 | ## Contributor Code of Conduct v1.3 7 | 8 | As contributors and maintainers of this project, and in the interest of 9 | fostering an open and welcoming community, we pledge to respect all people who 10 | contribute through reporting issues, posting feature requests, updating 11 | documentation, submitting pull requests or patches, and other activities. 12 | 13 | We are committed to making participation in this project a harassment-free 14 | experience for everyone, regardless of level of experience, gender, gender 15 | identity and expression, sexual orientation, disability, personal appearance, 16 | body size, race, ethnicity, age, religion, or nationality. 17 | 18 | Examples of unacceptable behavior by participants include: 19 | 20 | * The use of sexualized language or imagery 21 | * Personal attacks 22 | * Trolling or insulting/derogatory comments 23 | * Public or private harassment 24 | * Publishing other's private information, such as physical or electronic 25 | addresses, without explicit permission 26 | * Other unethical or unprofessional conduct 27 | 28 | Project maintainers have the right and responsibility to remove, edit, or 29 | reject comments, commits, code, wiki edits, issues, and other contributions 30 | that are not aligned to this Code of Conduct, or to ban temporarily or 31 | permanently any contributor for other behaviors that they deem inappropriate, 32 | threatening, offensive, or harmful. 33 | 34 | By adopting this Code of Conduct, project maintainers commit themselves to 35 | fairly and consistently applying these principles to every aspect of managing 36 | this project. Project maintainers who do not follow or enforce the Code of 37 | Conduct may be permanently removed from the project team. 38 | 39 | This Code of Conduct applies both within project spaces and in public spaces 40 | when an individual is representing the project or its community. 41 | 42 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 43 | reported by contacting a project maintainer at [INSERT EMAIL ADDRESS]. All 44 | complaints will be reviewed and investigated and will result in a response that 45 | is deemed necessary and appropriate to the circumstances. Maintainers are 46 | obligated to maintain confidentiality with regard to the reporter of an 47 | incident. 48 | 49 | 50 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 51 | version 1.3.0, available at https://www.contributor-covenant.org/version/1/3/0/code-of-conduct.html 52 | 53 | [homepage]: https://www.contributor-covenant.org 54 | 55 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | ## Legal 4 | By submitting a pull request, you represent that you have the right to license your contribution to the community, and agree by submitting the patch 5 | that your contributions are licensed under the Apache 2.0 license (see [LICENSE](LICENSE)). 6 | 7 | ## Contributor Conduct 8 | All contributors are expected to adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md). 9 | 10 | ## Submitting a bug or issue 11 | Please ensure to include the following in your bug report 12 | - A consise description of the issue, what happened and what you expected. 13 | - Simple reproduction steps 14 | - Version of the library you are using 15 | - Contextual information (Swift version, OS etc) 16 | 17 | ## Submitting a Pull Request 18 | 19 | Please ensure to include the following in your Pull Request 20 | - A description of what you are trying to do. What the PR provides to the library, additional functionality, fixing a bug etc 21 | - A description of the code changes 22 | - Documentation on how these changes are being tested 23 | - Additional tests to show your code working and to ensure future changes don't break your code. 24 | 25 | Please keep your PRs to a minimal number of changes. If a PR is large try to split it up into smaller PRs. Don't move code around unnecessarily it makes comparing old with new very hard. 26 | 27 | The main development branch of the repository is `main`. 28 | 29 | ### Formatting 30 | 31 | We use Apple's swift-format for formatting code. PRs will not be accepted if they haven't be formatted. -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # ================================ 2 | # Build image 3 | # ================================ 4 | FROM swift:6.0 as build 5 | 6 | WORKDIR /build 7 | 8 | # First just resolve dependencies. 9 | # This creates a cached layer that can be reused 10 | # as long as your Package.swift/Package.resolved 11 | # files do not change. 12 | COPY ./Package.* ./ 13 | RUN swift package resolve 14 | 15 | # Copy entire repo into container 16 | COPY . . 17 | 18 | RUN swift test --sanitize=thread 19 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 2021 Adam Fowler 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version:5.9 2 | // The swift-tools-version declares the minimum version of Swift required to build this package. 3 | 4 | import PackageDescription 5 | 6 | let package = Package( 7 | name: "hummingbird-redis", 8 | platforms: [.macOS(.v14), .iOS(.v17), .tvOS(.v17)], 9 | products: [ 10 | .library(name: "HummingbirdRedis", targets: ["HummingbirdRedis"]) 11 | ], 12 | dependencies: [ 13 | .package(url: "https://github.com/hummingbird-project/hummingbird.git", from: "2.5.0"), 14 | .package(url: "https://github.com/swift-server/RediStack.git", from: "1.4.0"), 15 | ], 16 | targets: [ 17 | .target( 18 | name: "HummingbirdRedis", 19 | dependencies: [ 20 | .product(name: "Hummingbird", package: "hummingbird"), 21 | .product(name: "RediStack", package: "RediStack"), 22 | ] 23 | ), 24 | .testTarget( 25 | name: "HummingbirdRedisTests", 26 | dependencies: [ 27 | .byName(name: "HummingbirdRedis"), 28 | .product(name: "Hummingbird", package: "hummingbird"), 29 | .product(name: "HummingbirdTesting", package: "hummingbird"), 30 | ] 31 | ), 32 | ] 33 | ) 34 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | 4 | 5 | 6 |

7 |

8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 |

18 | 19 | # Hummingbird Redis Interface 20 | 21 | Redis is an open source, in-memory data structure store, used as a database, cache, and message broker. 22 | 23 | This is the Hummingbird interface to [RediStack library](https://gitlab.com/mordil/RediStack.git) a Swift driver for Redis. 24 | 25 | ## Usage 26 | 27 | ```swift 28 | import Hummingbird 29 | import HummingbirdRedis 30 | 31 | let redis = try RedisConnectionPoolService( 32 | .init(hostname: redisHostname, port: 6379), 33 | logger: Logger(label: "Redis") 34 | ) 35 | 36 | // create router and add a single GET /redis route 37 | let router = Router() 38 | router.get("redis") { request, _ -> String in 39 | let info = try await redis.send(command: "INFO").get() 40 | return String(describing: info) 41 | } 42 | // create application using router 43 | var app = Application( 44 | router: router, 45 | configuration: .init(address: .hostname("127.0.0.1", port: 8080)) 46 | ) 47 | app.addServices(redis) 48 | // run hummingbird application 49 | try await app.runService() 50 | ``` 51 | 52 | ## Documentation 53 | 54 | Reference documentation for HummingbirdRedis can be found [here](https://docs.hummingbird.codes/2.0/documentation/hummingbirdredis) 55 | -------------------------------------------------------------------------------- /Sources/HummingbirdRedis/Deprecations.swift: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // 3 | // This source file is part of the Hummingbird server framework project 4 | // 5 | // Copyright (c) 2024 the Hummingbird authors 6 | // Licensed under Apache License v2.0 7 | // 8 | // See LICENSE.txt for license information 9 | // See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors 10 | // 11 | // SPDX-License-Identifier: Apache-2.0 12 | // 13 | //===----------------------------------------------------------------------===// 14 | 15 | // Below is a list of unavailable symbols with the "HB" prefix. These are available 16 | // temporarily to ease transition from the old symbols that included the "HB" 17 | // prefix to the new ones. 18 | // 19 | // This file will be removed before we do a 2.0 release 20 | 21 | @_documentation(visibility: internal) @available(*, unavailable, renamed: "RedisConfiguration") 22 | public typealias HBRedisConfiguration = RedisConfiguration 23 | @_documentation(visibility: internal) @available(*, unavailable, renamed: "RedisConnectionPoolService") 24 | public typealias HBRedisConnectionPoolService = RedisConnectionPoolService 25 | @_documentation(visibility: internal) @available(*, unavailable, renamed: "RedisPersistDriver") 26 | public typealias HBRedisPersistDriver = RedisPersistDriver 27 | -------------------------------------------------------------------------------- /Sources/HummingbirdRedis/Persist+Redis.swift: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // 3 | // This source file is part of the Hummingbird server framework project 4 | // 5 | // Copyright (c) 2021-2022 the Hummingbird authors 6 | // Licensed under Apache License v2.0 7 | // 8 | // See LICENSE.txt for license information 9 | // See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors 10 | // 11 | // SPDX-License-Identifier: Apache-2.0 12 | // 13 | //===----------------------------------------------------------------------===// 14 | 15 | import Hummingbird 16 | @preconcurrency import RediStack 17 | 18 | /// Redis driver for persist system for storing persistent cross request key/value pairs 19 | public struct RedisPersistDriver: PersistDriver { 20 | let redisConnectionPool: RedisConnectionPoolService 21 | 22 | public init(redisConnectionPoolService: RedisConnectionPoolService) { 23 | self.redisConnectionPool = redisConnectionPoolService 24 | } 25 | 26 | /// create new key with value. If key already exist throw `PersistError.duplicate` error 27 | public func create(key: String, value: some Codable, expires: Duration?) async throws { 28 | let expiration: RedisSetCommandExpiration? = expires.map { .seconds(Int($0.components.seconds)) } 29 | let result = try await self.redisConnectionPool.set(.init(key), toJSON: value, onCondition: .keyDoesNotExist, expiration: expiration) 30 | switch result { 31 | case .ok: 32 | return 33 | case .conditionNotMet: 34 | throw PersistError.duplicate 35 | } 36 | } 37 | 38 | /// set value for key. If value already exists overwrite it 39 | public func set(key: String, value: some Codable, expires: Duration?) async throws { 40 | if let expires { 41 | let expiration = Int(expires.components.seconds) 42 | _ = try await self.redisConnectionPool.set( 43 | .init(key), 44 | toJSON: value, 45 | onCondition: .none, 46 | expiration: .seconds(expiration) 47 | ) 48 | } else { 49 | _ = try await self.redisConnectionPool.set( 50 | .init(key), 51 | toJSON: value, 52 | onCondition: .none, 53 | expiration: .keepExisting 54 | ) 55 | } 56 | } 57 | 58 | /// get value for key 59 | public func get(key: String, as object: Object.Type) async throws -> Object? { 60 | do { 61 | return try await self.redisConnectionPool.get(.init(key), asJSON: object) 62 | } catch is DecodingError { 63 | throw PersistError.invalidConversion 64 | } 65 | } 66 | 67 | /// remove key 68 | public func remove(key: String) async throws { 69 | _ = try await self.redisConnectionPool.delete(.init(key)).get() 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /Sources/HummingbirdRedis/Redis+Codable.swift: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // 3 | // This source file is part of the Hummingbird server framework project 4 | // 5 | // Copyright (c) 2021-2021 the Hummingbird authors 6 | // Licensed under Apache License v2.0 7 | // 8 | // See LICENSE.txt for license information 9 | // See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors 10 | // 11 | // SPDX-License-Identifier: Apache-2.0 12 | // 13 | //===----------------------------------------------------------------------===// 14 | 15 | import Foundation 16 | import NIO 17 | @preconcurrency import RediStack 18 | 19 | extension RedisClient { 20 | /// Decodes the value associated with this keyfrom JSON. 21 | public func get(_ key: RedisKey, asJSON type: D.Type) async throws -> D? { 22 | guard let data = try await self.get(key, as: Data.self).get() else { return nil } 23 | return try JSONDecoder().decode(D.self, from: data) 24 | } 25 | 26 | /// Sets the value stored in the key provided, overwriting the previous value. 27 | /// 28 | /// Any previous expiration set on the key is discarded if the SET operation was successful. 29 | /// 30 | /// - Important: Regardless of the type of value stored at the key, it will be overwritten to a string value. 31 | /// 32 | /// [https://redis.io/commands/set](https://redis.io/commands/set) 33 | /// - Parameters: 34 | /// - key: The key to use to uniquely identify this value. 35 | /// - value: The value to set the key to. 36 | @inlinable 37 | public func set(_ key: RedisKey, toJSON value: some Encodable) async throws { 38 | try await self.set(key, to: JSONEncoder().encode(value)).get() 39 | } 40 | 41 | /// Sets the key to the provided value with options to control how it is set. 42 | /// 43 | /// [https://redis.io/commands/set](https://redis.io/commands/set) 44 | /// - Important: Regardless of the type of data stored at the key, it will be overwritten to a "string" data type. 45 | /// 46 | /// ie. If the key is a reference to a Sorted Set, its value will be overwritten to be a "string" data type. 47 | /// 48 | /// - Parameters: 49 | /// - key: The key to use to uniquely identify this value. 50 | /// - value: The value to set the key to. 51 | /// - condition: The condition under which the key should be set. 52 | /// - expiration: The expiration to use when setting the key. No expiration is set if `nil`. 53 | /// - Returns: A `NIO.EventLoopFuture` indicating the result of the operation; 54 | /// `.ok` if the operation was successful and `.conditionNotMet` if the specified `condition` was not met. 55 | /// 56 | /// If the condition `.none` was used, then the result value will always be `.ok`. 57 | @_disfavoredOverload 58 | public func set( 59 | _ key: RedisKey, 60 | toJSON value: some Encodable, 61 | onCondition condition: RedisSetCommandCondition = .none, 62 | expiration: RedisSetCommandExpiration? = nil 63 | ) async throws -> RedisSetCommandResult { 64 | try await self.set(key, to: JSONEncoder().encode(value), onCondition: condition, expiration: expiration).get() 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /Sources/HummingbirdRedis/RedisConfiguration.swift: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // 3 | // This source file is part of the Hummingbird server framework project 4 | // 5 | // Copyright (c) 2021-2021 the Hummingbird authors 6 | // Licensed under Apache License v2.0 7 | // 8 | // See LICENSE.txt for license information 9 | // See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors 10 | // 11 | // SPDX-License-Identifier: Apache-2.0 12 | // 13 | //===----------------------------------------------------------------------===// 14 | 15 | import Hummingbird 16 | import Logging 17 | import NIOCore 18 | @preconcurrency import RediStack 19 | 20 | import struct Foundation.URL 21 | 22 | // Based of the Vapor redis configuration that can be found 23 | // here https://github.com/vapor/redis/blob/master/Sources/Redis/RedisConfiguration.swift 24 | 25 | public struct RedisConfiguration { 26 | public typealias ValidationError = RedisConnection.Configuration.ValidationError 27 | 28 | public var serverAddresses: [SocketAddress] 29 | public var password: String? 30 | public var database: Int? 31 | public var pool: PoolOptions 32 | 33 | public struct PoolOptions { 34 | public var maximumConnectionCount: RedisConnectionPoolSize 35 | public var minimumConnectionCount: Int 36 | public var connectionBackoffFactor: Float32 37 | public var initialConnectionBackoffDelay: TimeAmount 38 | public var connectionRetryTimeout: TimeAmount? 39 | 40 | public init( 41 | maximumConnectionCount: RedisConnectionPoolSize = .maximumActiveConnections(2), 42 | minimumConnectionCount: Int = 0, 43 | connectionBackoffFactor: Float32 = 2, 44 | initialConnectionBackoffDelay: TimeAmount = .milliseconds(100), 45 | connectionRetryTimeout: TimeAmount? = nil 46 | ) { 47 | self.maximumConnectionCount = maximumConnectionCount 48 | self.minimumConnectionCount = minimumConnectionCount 49 | self.connectionBackoffFactor = connectionBackoffFactor 50 | self.initialConnectionBackoffDelay = initialConnectionBackoffDelay 51 | self.connectionRetryTimeout = connectionRetryTimeout 52 | } 53 | } 54 | 55 | public init(url string: String, pool: PoolOptions = .init()) throws { 56 | guard let url = URL(string: string) else { throw ValidationError.invalidURLString } 57 | try self.init(url: url, pool: pool) 58 | } 59 | 60 | public init(url: URL, pool: PoolOptions = .init()) throws { 61 | guard 62 | let scheme = url.scheme, 63 | !scheme.isEmpty 64 | else { throw ValidationError.missingURLScheme } 65 | guard scheme == "redis" else { throw ValidationError.invalidURLScheme } 66 | guard let host = url.host, !host.isEmpty else { throw ValidationError.missingURLHost } 67 | 68 | try self.init( 69 | hostname: host, 70 | port: url.port ?? RedisConnection.Configuration.defaultPort, 71 | password: url.password, 72 | database: Int(url.lastPathComponent), 73 | pool: pool 74 | ) 75 | } 76 | 77 | public init( 78 | hostname: String, 79 | port: Int = RedisConnection.Configuration.defaultPort, 80 | password: String? = nil, 81 | database: Int? = nil, 82 | pool: PoolOptions = .init() 83 | ) throws { 84 | if database != nil, database! < 0 { throw ValidationError.outOfBoundsDatabaseID } 85 | 86 | try self.init( 87 | serverAddresses: [.makeAddressResolvingHost(hostname, port: port)], 88 | password: password, 89 | database: database, 90 | pool: pool 91 | ) 92 | } 93 | 94 | public init( 95 | serverAddresses: [SocketAddress], 96 | password: String? = nil, 97 | database: Int? = nil, 98 | pool: PoolOptions = .init() 99 | ) throws { 100 | self.serverAddresses = serverAddresses 101 | self.password = password 102 | self.database = database 103 | self.pool = pool 104 | } 105 | } 106 | 107 | extension RedisConnectionPool.Configuration { 108 | init( 109 | _ config: RedisConfiguration, 110 | logger: Logger 111 | ) { 112 | self.init( 113 | initialServerConnectionAddresses: config.serverAddresses, 114 | maximumConnectionCount: config.pool.maximumConnectionCount, 115 | connectionFactoryConfiguration: .init( 116 | connectionInitialDatabase: config.database, 117 | connectionPassword: config.password, 118 | connectionDefaultLogger: logger, 119 | tcpClient: nil 120 | ), 121 | minimumConnectionCount: config.pool.minimumConnectionCount, 122 | connectionBackoffFactor: config.pool.connectionBackoffFactor, 123 | initialConnectionBackoffDelay: config.pool.initialConnectionBackoffDelay, 124 | connectionRetryTimeout: config.pool.connectionRetryTimeout, 125 | poolDefaultLogger: logger 126 | ) 127 | } 128 | } 129 | -------------------------------------------------------------------------------- /Sources/HummingbirdRedis/RedisConnectionPoolService.swift: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // 3 | // This source file is part of the Hummingbird server framework project 4 | // 5 | // Copyright (c) 2021-2023 the Hummingbird authors 6 | // Licensed under Apache License v2.0 7 | // 8 | // See LICENSE.txt for license information 9 | // See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors 10 | // 11 | // SPDX-License-Identifier: Apache-2.0 12 | // 13 | //===----------------------------------------------------------------------===// 14 | 15 | import Foundation 16 | import Hummingbird 17 | import Logging 18 | import NIOCore 19 | @preconcurrency import RediStack 20 | import ServiceLifecycle 21 | 22 | /// Wrapper for RedisConnectionPool that conforms to ServiceLifecycle Service 23 | public struct RedisConnectionPoolService: Service, @unchecked Sendable { 24 | /// Initialize RedisConnectionPoolService 25 | public init( 26 | _ config: RedisConfiguration, 27 | eventLoopGroupProvider: EventLoopGroupProvider = .singleton, 28 | logger: Logger 29 | ) { 30 | let configuration: RedisConnectionPool.Configuration = .init(config, logger: logger) 31 | let eventLoop = eventLoopGroupProvider.eventLoopGroup.any() 32 | self.pool = .init(configuration: configuration, boundEventLoop: eventLoop) 33 | } 34 | 35 | public let pool: RedisConnectionPool 36 | 37 | @inlinable 38 | public func run() async throws { 39 | /// Ignore cancellation error 40 | try? await gracefulShutdown() 41 | try await self.close() 42 | } 43 | 44 | /// Starts the connection pool. 45 | /// 46 | /// This method is safe to call multiple times. 47 | /// - Parameter logger: An optional logger to use for any log statements generated while starting up the pool. 48 | /// If one is not provided, the pool will use its default logger. 49 | @inlinable 50 | public func activate(logger: Logger? = nil) { 51 | self.pool.activate(logger: logger) 52 | } 53 | 54 | /// Closes all connections in the pool and deactivates the pool from creating new connections. 55 | /// 56 | /// This method is safe to call multiple times. 57 | @inlinable 58 | public func close() async throws { 59 | let promise = self.eventLoop.makePromise(of: Void.self) 60 | self.pool.close(promise: promise) 61 | return try await promise.futureResult.get() 62 | } 63 | } 64 | 65 | extension RedisConnectionPoolService { 66 | /// A unique identifer to represent this connection. 67 | @inlinable 68 | public var id: UUID { self.pool.id } 69 | /// The count of connections that are active and available for use. 70 | @inlinable 71 | public var availableConnectionCount: Int { self.pool.availableConnectionCount } 72 | /// The number of connections that have been handed out and are in active use. 73 | @inlinable 74 | public var leasedConnectionCount: Int { self.pool.leasedConnectionCount } 75 | /// Provides limited exclusive access to a connection to be used in a user-defined specialized closure of operations. 76 | /// - Warning: Attempting to create PubSub subscriptions with connections leased in the closure will result in a failed `NIO.EventLoopFuture`. 77 | /// 78 | /// `RedisConnectionPool` manages PubSub state and requires exclusive control over creating PubSub subscriptions. 79 | /// - Important: This connection **MUST NOT** be stored outside of the closure. It is only available exclusively within the closure. 80 | /// 81 | /// All operations should be done inside the closure as chained `NIO.EventLoopFuture` callbacks. 82 | /// 83 | /// For example: 84 | /// ```swift 85 | /// let countFuture = pool.leaseConnection { 86 | /// let client = $0.logging(to: myLogger) 87 | /// return client.authorize(with: userPassword) 88 | /// .flatMap { connection.select(database: userDatabase) } 89 | /// .flatMap { connection.increment(counterKey) } 90 | /// } 91 | /// ``` 92 | /// - Warning: Some commands change the state of the connection that are not tracked client-side, 93 | /// and will not be automatically reset when the connection is returned to the pool. 94 | /// 95 | /// When the connection is reused from the pool, it will retain this state and may affect future commands executed with it. 96 | /// 97 | /// For example, if `select(database:)` is used, all future commands made with this connection will be against the selected database. 98 | /// 99 | /// To protect against future issues, make sure the final commands executed are to reset the connection to it's previous known state. 100 | /// - Parameter operation: A closure that receives exclusive access to the provided `RedisConnection` for the lifetime of the closure for specialized Redis command chains. 101 | /// - Returns: A `NIO.EventLoopFuture` that resolves the value of the `NIO.EventLoopFuture` in the provided closure operation. 102 | @inlinable 103 | public func leaseConnection(_ operation: @escaping (RedisConnection) -> EventLoopFuture) -> EventLoopFuture { 104 | self.pool.leaseConnection(operation) 105 | } 106 | 107 | /// Updates the list of valid connection addresses. 108 | /// - Warning: This will replace any previously set list of addresses. 109 | /// - Note: This does not invalidate existing connections: as long as those connections continue to stay up, they will be kept by 110 | /// this client. 111 | /// 112 | /// However, no new connections will be made to any endpoint that is not in `newAddresses`. 113 | /// - Parameters: 114 | /// - newAddresses: The new addresses to connect to in future connections. 115 | /// - logger: An optional logger to use for any log statements generated while updating the target addresses. 116 | /// If one is not provided, the pool will use its default logger. 117 | @inlinable 118 | public func updateConnectionAddresses(_ newAddresses: [SocketAddress], logger: Logger? = nil) { 119 | self.pool.updateConnectionAddresses(newAddresses) 120 | } 121 | } 122 | 123 | extension RedisConnectionPoolService: RedisClient { 124 | @inlinable 125 | public var eventLoop: NIOCore.EventLoop { self.pool.eventLoop } 126 | 127 | @inlinable 128 | public func send(command: String, with arguments: [RediStack.RESPValue]) -> NIOCore.EventLoopFuture { 129 | self.pool.send(command: command, with: arguments) 130 | } 131 | 132 | @inlinable 133 | public func logging(to logger: Logging.Logger) -> RediStack.RedisClient { 134 | self.pool.logging(to: logger) 135 | } 136 | 137 | @inlinable 138 | public func subscribe( 139 | to channels: [RedisChannelName], 140 | messageReceiver receiver: @escaping RedisSubscriptionMessageReceiver, 141 | onSubscribe subscribeHandler: RedisSubscriptionChangeHandler?, 142 | onUnsubscribe unsubscribeHandler: RedisSubscriptionChangeHandler? 143 | ) -> EventLoopFuture { 144 | self.pool.subscribe(to: channels, messageReceiver: receiver, onSubscribe: subscribeHandler, onUnsubscribe: unsubscribeHandler) 145 | } 146 | 147 | @inlinable 148 | public func psubscribe( 149 | to patterns: [String], 150 | messageReceiver receiver: @escaping RedisSubscriptionMessageReceiver, 151 | onSubscribe subscribeHandler: RedisSubscriptionChangeHandler?, 152 | onUnsubscribe unsubscribeHandler: RedisSubscriptionChangeHandler? 153 | ) -> EventLoopFuture { 154 | self.pool.psubscribe(to: patterns, messageReceiver: receiver, onSubscribe: subscribeHandler, onUnsubscribe: unsubscribeHandler) 155 | } 156 | 157 | @inlinable 158 | public func unsubscribe(from channels: [RediStack.RedisChannelName]) -> NIOCore.EventLoopFuture { 159 | self.pool.unsubscribe(from: channels) 160 | } 161 | 162 | @inlinable 163 | public func punsubscribe(from patterns: [String]) -> NIOCore.EventLoopFuture { 164 | self.pool.punsubscribe(from: patterns) 165 | } 166 | } 167 | -------------------------------------------------------------------------------- /Tests/HummingbirdRedisTests/PersistTests.swift: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // 3 | // This source file is part of the Hummingbird server framework project 4 | // 5 | // Copyright (c) 2021-2021 the Hummingbird authors 6 | // Licensed under Apache License v2.0 7 | // 8 | // See LICENSE.txt for license information 9 | // See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors 10 | // 11 | // SPDX-License-Identifier: Apache-2.0 12 | // 13 | //===----------------------------------------------------------------------===// 14 | 15 | import Hummingbird 16 | import HummingbirdRedis 17 | import HummingbirdTesting 18 | import Logging 19 | @preconcurrency import RediStack 20 | import XCTest 21 | 22 | final class PersistTests: XCTestCase { 23 | static let redisHostname = Environment().get("REDIS_HOSTNAME") ?? "localhost" 24 | 25 | func createApplication(_ updateRouter: (Router, PersistDriver) -> Void = { _, _ in }) throws -> some ApplicationProtocol { 26 | let router = Router() 27 | let redisConnectionPool = try RedisConnectionPoolService( 28 | .init(hostname: Self.redisHostname, port: 6379), 29 | logger: Logger(label: "Redis") 30 | ) 31 | let persist = RedisPersistDriver(redisConnectionPoolService: redisConnectionPool) 32 | 33 | router.put("/persist/:tag") { request, context -> HTTPResponse.Status in 34 | let buffer = try await request.body.collect(upTo: .max) 35 | let tag = try context.parameters.require("tag") 36 | try await persist.set(key: tag, value: String(buffer: buffer)) 37 | return .ok 38 | } 39 | router.put("/persist/:tag/:time") { request, context -> HTTPResponse.Status in 40 | guard let time = context.parameters.get("time", as: Int.self) else { throw HTTPError(.badRequest) } 41 | let buffer = try await request.body.collect(upTo: .max) 42 | let tag = try context.parameters.require("tag") 43 | try await persist.set(key: tag, value: String(buffer: buffer), expires: .seconds(time)) 44 | return .ok 45 | } 46 | router.get("/persist/:tag") { _, context -> String? in 47 | guard let tag = context.parameters.get("tag", as: String.self) else { throw HTTPError(.badRequest) } 48 | return try await persist.get(key: tag, as: String.self) 49 | } 50 | router.delete("/persist/:tag") { _, context -> HTTPResponse.Status in 51 | guard let tag = context.parameters.get("tag", as: String.self) else { throw HTTPError(.badRequest) } 52 | try await persist.remove(key: tag) 53 | return .noContent 54 | } 55 | updateRouter(router, persist) 56 | var app = Application(responder: router.buildResponder()) 57 | app.addServices(redisConnectionPool, persist) 58 | 59 | return app 60 | } 61 | 62 | func testSetGet() async throws { 63 | let app = try self.createApplication() 64 | try await app.test(.router) { client in 65 | let tag = UUID().uuidString 66 | try await client.execute(uri: "/persist/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "Persist")) { _ in } 67 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 68 | let body = try XCTUnwrap(response.body) 69 | XCTAssertEqual(String(buffer: body), "Persist") 70 | } 71 | } 72 | } 73 | 74 | func testCreateGet() async throws { 75 | let app = try self.createApplication { router, persist in 76 | router.put("/create/:tag") { request, context -> HTTPResponse.Status in 77 | let buffer = try await request.body.collect(upTo: .max) 78 | let tag = try context.parameters.require("tag") 79 | try await persist.create(key: tag, value: String(buffer: buffer)) 80 | return .ok 81 | } 82 | } 83 | try await app.test(.router) { client in 84 | let tag = UUID().uuidString 85 | try await client.execute(uri: "/create/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "Persist")) { _ in } 86 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 87 | let body = try XCTUnwrap(response.body) 88 | XCTAssertEqual(String(buffer: body), "Persist") 89 | } 90 | } 91 | } 92 | 93 | func testDoubleCreateFail() async throws { 94 | let app = try self.createApplication { router, persist in 95 | router.put("/create/:tag") { request, context -> HTTPResponse.Status in 96 | let buffer = try await request.body.collect(upTo: .max) 97 | let tag = try context.parameters.require("tag") 98 | do { 99 | try await persist.create(key: tag, value: String(buffer: buffer)) 100 | } catch let error as PersistError where error == .duplicate { 101 | throw HTTPError(.conflict) 102 | } 103 | return .ok 104 | } 105 | } 106 | try await app.test(.router) { client in 107 | let tag = UUID().uuidString 108 | try await client.execute(uri: "/create/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "Persist")) { response in 109 | XCTAssertEqual(response.status, .ok) 110 | } 111 | try await client.execute(uri: "/create/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "Persist")) { response in 112 | XCTAssertEqual(response.status, .conflict) 113 | } 114 | } 115 | } 116 | 117 | func testSetTwice() async throws { 118 | let app = try self.createApplication() 119 | try await app.test(.router) { client in 120 | 121 | let tag = UUID().uuidString 122 | try await client.execute(uri: "/persist/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "test1")) { _ in } 123 | try await client.execute(uri: "/persist/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "test2")) { response in 124 | XCTAssertEqual(response.status, .ok) 125 | } 126 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 127 | let body = try XCTUnwrap(response.body) 128 | XCTAssertEqual(String(buffer: body), "test2") 129 | } 130 | } 131 | } 132 | 133 | func testExpires() async throws { 134 | let app = try self.createApplication() 135 | try await app.test(.router) { client in 136 | 137 | let tag1 = UUID().uuidString 138 | let tag2 = UUID().uuidString 139 | 140 | try await client.execute(uri: "/persist/\(tag1)/0", method: .put, body: ByteBufferAllocator().buffer(string: "ThisIsTest1")) { _ in } 141 | try await client.execute(uri: "/persist/\(tag2)/10", method: .put, body: ByteBufferAllocator().buffer(string: "ThisIsTest2")) { _ in } 142 | try await Task.sleep(nanoseconds: 1_000_000_000) 143 | try await client.execute(uri: "/persist/\(tag1)", method: .get) { response in 144 | XCTAssertEqual(response.status, .noContent) 145 | } 146 | try await client.execute(uri: "/persist/\(tag2)", method: .get) { response in 147 | let body = try XCTUnwrap(response.body) 148 | XCTAssertEqual(String(buffer: body), "ThisIsTest2") 149 | } 150 | } 151 | } 152 | 153 | func testCodable() async throws { 154 | struct TestCodable: Codable { 155 | let buffer: String 156 | } 157 | let app = try self.createApplication { router, persist in 158 | router.put("/codable/:tag") { request, context -> HTTPResponse.Status in 159 | guard let tag = context.parameters.get("tag") else { throw HTTPError(.badRequest) } 160 | let buffer = try await request.body.collect(upTo: .max) 161 | try await persist.set(key: tag, value: TestCodable(buffer: String(buffer: buffer))) 162 | return .ok 163 | } 164 | router.get("/codable/:tag") { _, context -> String? in 165 | guard let tag = context.parameters.get("tag") else { throw HTTPError(.badRequest) } 166 | let value = try await persist.get(key: tag, as: TestCodable.self) 167 | return value?.buffer 168 | } 169 | } 170 | try await app.test(.router) { client in 171 | 172 | let tag = UUID().uuidString 173 | try await client.execute(uri: "/codable/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "Persist")) { _ in } 174 | try await client.execute(uri: "/codable/\(tag)", method: .get) { response in 175 | let body = try XCTUnwrap(response.body) 176 | XCTAssertEqual(String(buffer: body), "Persist") 177 | } 178 | } 179 | } 180 | 181 | func testInvalidGetAs() async throws { 182 | struct TestCodable: Codable { 183 | let buffer: String 184 | } 185 | let app = try self.createApplication { router, persist in 186 | router.put("/invalid") { _, _ -> HTTPResponse.Status in 187 | try await persist.set(key: "test", value: TestCodable(buffer: "hello")) 188 | return .ok 189 | } 190 | router.get("/invalid") { _, _ -> String? in 191 | do { 192 | return try await persist.get(key: "test", as: String.self) 193 | } catch let error as PersistError where error == .invalidConversion { 194 | throw HTTPError(.badRequest) 195 | } 196 | } 197 | } 198 | try await app.test(.router) { client in 199 | try await client.execute(uri: "/invalid", method: .put) 200 | try await client.execute(uri: "/invalid", method: .get) { response in 201 | XCTAssertEqual(response.status, .badRequest) 202 | } 203 | } 204 | } 205 | 206 | func testRemove() async throws { 207 | let app = try self.createApplication() 208 | try await app.test(.router) { client in 209 | let tag = UUID().uuidString 210 | try await client.execute(uri: "/persist/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "ThisIsTest1")) { _ in } 211 | try await client.execute(uri: "/persist/\(tag)", method: .delete) { _ in } 212 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 213 | XCTAssertEqual(response.status, .noContent) 214 | } 215 | } 216 | } 217 | 218 | func testExpireAndAdd() async throws { 219 | let app = try self.createApplication() 220 | try await app.test(.router) { client in 221 | 222 | let tag = UUID().uuidString 223 | try await client.execute(uri: "/persist/\(tag)/0", method: .put, body: ByteBuffer(string: "ThisIsTest1")) { _ in } 224 | try await Task.sleep(nanoseconds: 1_000_000_000) 225 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 226 | XCTAssertEqual(response.status, .noContent) 227 | } 228 | try await client.execute(uri: "/persist/\(tag)/10", method: .put, body: ByteBuffer(string: "ThisIsTest1")) { response in 229 | XCTAssertEqual(response.status, .ok) 230 | } 231 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 232 | XCTAssertEqual(response.status, .ok) 233 | let body = try XCTUnwrap(response.body) 234 | XCTAssertEqual(String(buffer: body), "ThisIsTest1") 235 | } 236 | } 237 | } 238 | } 239 | -------------------------------------------------------------------------------- /Tests/HummingbirdRedisTests/RedisTests.swift: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // 3 | // This source file is part of the Hummingbird server framework project 4 | // 5 | // Copyright (c) 2021-2021 the Hummingbird authors 6 | // Licensed under Apache License v2.0 7 | // 8 | // See LICENSE.txt for license information 9 | // See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors 10 | // 11 | // SPDX-License-Identifier: Apache-2.0 12 | // 13 | //===----------------------------------------------------------------------===// 14 | 15 | import Hummingbird 16 | import HummingbirdTesting 17 | import Logging 18 | import NIOPosix 19 | @preconcurrency import RediStack 20 | import XCTest 21 | 22 | @testable import HummingbirdRedis 23 | 24 | final class HummingbirdRedisTests: XCTestCase { 25 | static let env = Environment() 26 | static let redisHostname = env.get("REDIS_HOSTNAME") ?? "localhost" 27 | 28 | func testConnectionPoolService() async throws { 29 | let redis = try RedisConnectionPoolService( 30 | .init(hostname: Self.redisHostname, port: 6379), 31 | logger: Logger(label: "Redis") 32 | ) 33 | 34 | let info = try await redis.send(command: "INFO").get() 35 | XCTAssertEqual(info.string?.contains("redis_version"), true) 36 | 37 | try await redis.close() 38 | } 39 | 40 | func testSubscribe() async throws { 41 | let expectation = XCTestExpectation(description: "Waiting on subscription") 42 | expectation.expectedFulfillmentCount = 1 43 | let redis = try RedisConnectionPoolService( 44 | .init(hostname: Self.redisHostname, port: 6379), 45 | logger: Logger(label: "Redis") 46 | ) 47 | let redis2 = try RedisConnectionPoolService( 48 | .init(hostname: Self.redisHostname, port: 6379), 49 | logger: Logger(label: "Redis") 50 | ) 51 | 52 | _ = try await redis.subscribe(to: ["channel"]) { _, value in 53 | XCTAssertEqual(value, .init(from: "hello")) 54 | expectation.fulfill() 55 | }.get() 56 | _ = try await redis2.publish("hello", to: "channel").get() 57 | await fulfillment(of: [expectation], timeout: 5) 58 | _ = try await redis.unsubscribe(from: ["channel"]).get() 59 | try await redis.close() 60 | try await redis2.close() 61 | } 62 | 63 | func testRouteHandler() async throws { 64 | let redis = try RedisConnectionPoolService( 65 | .init(hostname: Self.redisHostname, port: 6379), 66 | logger: Logger(label: "Redis") 67 | ) 68 | let router = Router() 69 | router.get("redis") { _, _ in 70 | try await redis.send(command: "INFO").map(\.description).get() 71 | } 72 | var app = Application(responder: router.buildResponder()) 73 | app.addServices(redis) 74 | try await app.test(.live) { client in 75 | try await client.execute(uri: "/redis", method: .get) { response in 76 | var body = try XCTUnwrap(response.body) 77 | XCTAssertEqual(body.readString(length: body.readableBytes)?.contains("redis_version"), true) 78 | } 79 | } 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /scripts/validate.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | ##===----------------------------------------------------------------------===## 3 | ## 4 | ## This source file is part of the Hummingbird server framework project 5 | ## 6 | ## Copyright (c) 2021-2024 the Hummingbird authors 7 | ## Licensed under Apache License v2.0 8 | ## 9 | ## See LICENSE.txt for license information 10 | ## See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors 11 | ## 12 | ## SPDX-License-Identifier: Apache-2.0 13 | ## 14 | ##===----------------------------------------------------------------------===## 15 | ##===----------------------------------------------------------------------===## 16 | ## 17 | ## This source file is part of the SwiftNIO open source project 18 | ## 19 | ## Copyright (c) 2017-2019 Apple Inc. and the SwiftNIO project authors 20 | ## Licensed under Apache License v2.0 21 | ## 22 | ## See LICENSE.txt for license information 23 | ## See CONTRIBUTORS.txt for the list of SwiftNIO project authors 24 | ## 25 | ## SPDX-License-Identifier: Apache-2.0 26 | ## 27 | ##===----------------------------------------------------------------------===## 28 | 29 | SWIFT_FORMAT_VERSION=0.53.10 30 | 31 | set -eu 32 | here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" 33 | 34 | function replace_acceptable_years() { 35 | # this needs to replace all acceptable forms with 'YEARS' 36 | sed -e 's/20[12][0-9]-20[12][0-9]/YEARS/' -e 's/20[12][0-9]/YEARS/' -e '/^#!/ d' 37 | } 38 | 39 | printf "=> Checking format... " 40 | FIRST_OUT="$(git status --porcelain)" 41 | git ls-files -z '*.swift' | xargs -0 swift format format --parallel --in-place 42 | git diff --exit-code '*.swift' 43 | 44 | SECOND_OUT="$(git status --porcelain)" 45 | if [[ "$FIRST_OUT" != "$SECOND_OUT" ]]; then 46 | printf "\033[0;31mformatting issues!\033[0m\n" 47 | git --no-pager diff 48 | exit 1 49 | else 50 | printf "\033[0;32mokay.\033[0m\n" 51 | fi 52 | printf "=> Checking license headers... " 53 | tmp=$(mktemp /tmp/.soto-core-sanity_XXXXXX) 54 | 55 | exit 0 56 | 57 | for language in swift-or-c; do 58 | declare -a matching_files 59 | declare -a exceptions 60 | expections=( ) 61 | matching_files=( -name '*' ) 62 | case "$language" in 63 | swift-or-c) 64 | exceptions=( -path '*/Benchmarks/.build/*' -o -name Package.swift) 65 | matching_files=( -name '*.swift' -o -name '*.c' -o -name '*.h' ) 66 | cat > "$tmp" <<"EOF" 67 | //===----------------------------------------------------------------------===// 68 | // 69 | // This source file is part of the Hummingbird server framework project 70 | // 71 | // Copyright (c) YEARS the Hummingbird authors 72 | // Licensed under Apache License v2.0 73 | // 74 | // See LICENSE.txt for license information 75 | // See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors 76 | // 77 | // SPDX-License-Identifier: Apache-2.0 78 | // 79 | //===----------------------------------------------------------------------===// 80 | EOF 81 | ;; 82 | bash) 83 | matching_files=( -name '*.sh' ) 84 | cat > "$tmp" <<"EOF" 85 | ##===----------------------------------------------------------------------===## 86 | ## 87 | ## This source file is part of the Hummingbird server framework project 88 | ## 89 | ## Copyright (c) YEARS the Hummingbird authors 90 | ## Licensed under Apache License v2.0 91 | ## 92 | ## See LICENSE.txt for license information 93 | ## See hummingbird/CONTRIBUTORS.txt for the list of Hummingbird authors 94 | ## 95 | ## SPDX-License-Identifier: Apache-2.0 96 | ## 97 | ##===----------------------------------------------------------------------===## 98 | EOF 99 | ;; 100 | *) 101 | echo >&2 "ERROR: unknown language '$language'" 102 | ;; 103 | esac 104 | 105 | lines_to_compare=$(cat "$tmp" | wc -l | tr -d " ") 106 | # need to read one more line as we remove the '#!' line 107 | lines_to_read=$(expr "$lines_to_compare" + 1) 108 | expected_sha=$(cat "$tmp" | shasum) 109 | 110 | ( 111 | cd "$here/.." 112 | find . \ 113 | \( \! -path './.build/*' -a \ 114 | \( "${matching_files[@]}" \) -a \ 115 | \( \! \( "${exceptions[@]}" \) \) \) | while read line; do 116 | if [[ "$(cat "$line" | head -n $lines_to_read | replace_acceptable_years | head -n $lines_to_compare | shasum)" != "$expected_sha" ]]; then 117 | printf "\033[0;31mmissing headers in file '$line'!\033[0m\n" 118 | diff -u <(cat "$line" | head -n $lines_to_read | replace_acceptable_years | head -n $lines_to_compare) "$tmp" 119 | exit 1 120 | fi 121 | done 122 | printf "\033[0;32mokay.\033[0m\n" 123 | ) 124 | done 125 | 126 | rm "$tmp" 127 | --------------------------------------------------------------------------------