├── .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 └── HummingbirdPostgres │ ├── CreatePersistTable.swift │ └── PostgresPersistDriver.swift ├── Tests └── HummingbirdPostgresTests │ └── PersistTests.swift ├── docker-compose.yaml └── 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 @thoven87 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 | jobs: 17 | # macOS: 18 | # runs-on: macOS-13 19 | # steps: 20 | # - name: Checkout 21 | # uses: actions/checkout@v4 22 | # - name: SPM tests 23 | # run: swift test --enable-code-coverage 24 | # - name: Convert coverage files 25 | # run: | 26 | # xcrun llvm-cov export -format "lcov" \ 27 | # .build/debug/hummingbirdPackageTests.xctest/Contents/MacOs/hummingbirdPackageTests \ 28 | # -ignore-filename-regex="\/Tests\/" \ 29 | # -ignore-filename-regex="\/Benchmarks\/" \ 30 | # -instr-profile=.build/debug/codecov/default.profdata > info.lcov 31 | # - name: Upload to codecov.io 32 | # uses: codecov/codecov-action@v5 33 | # with: 34 | # file: info.lcov 35 | linux: 36 | runs-on: ubuntu-latest 37 | timeout-minutes: 15 38 | strategy: 39 | matrix: 40 | image: 41 | - 'swift:5.10' 42 | - 'swift:6.0' 43 | - 'swift:6.1' 44 | postgres-image: 45 | - 'postgres:17' 46 | - 'postgres:16' 47 | - 'postgres:14' 48 | include: 49 | - postgres-image: postgres:17 50 | postgres-auth: scram-sha-256 51 | - postgres-image: postgres:16 52 | postgres-auth: scram-sha-256 53 | - postgres-image: postgres:14 54 | postgres-auth: md5 55 | container: 56 | image: ${{ matrix.image }} 57 | volumes: [ 'pgrunshare:/var/run/postgresql' ] 58 | env: 59 | POSTGRES_DB: 'test_database' 60 | POSTGRES_USER: 'test_user' 61 | POSTGRES_PASSWORD: 'test_password' 62 | POSTGRES_HOSTNAME: 'psql' 63 | POSTGRES_SOCKET: '/var/run/postgresql/.s.PGSQL.5432' 64 | POSTGRES_HOST_AUTH_METHOD: ${{ matrix.postgres-auth }} 65 | services: 66 | psql: 67 | image: ${{ matrix.postgres-image }} 68 | volumes: [ 'pgrunshare:/var/run/postgresql' ] 69 | env: 70 | POSTGRES_DB: 'test_database' 71 | POSTGRES_USER: 'test_user' 72 | POSTGRES_PASSWORD: 'test_password' 73 | POSTGRES_HOST_AUTH_METHOD: ${{ matrix.postgres-auth }} 74 | POSTGRES_INITDB_ARGS: --auth-host=${{ matrix.postgres-auth }} 75 | steps: 76 | - name: Checkout 77 | uses: actions/checkout@v4 78 | - name: Test 79 | run: | 80 | swift test --enable-code-coverage 81 | - name: Convert coverage files 82 | run: | 83 | llvm-cov export -format="lcov" \ 84 | .build/debug/hummingbird-postgresPackageTests.xctest \ 85 | -ignore-filename-regex="\/Tests\/" \ 86 | -ignore-filename-regex="\/Benchmarks\/" \ 87 | -instr-profile .build/debug/codecov/default.profdata > info.lcov 88 | - name: Upload to codecov.io 89 | uses: codecov/codecov-action@v5 90 | with: 91 | files: info.lcov 92 | token: ${{ secrets.CODECOV_TOKEN }} -------------------------------------------------------------------------------- /.github/workflows/nightly.yml: -------------------------------------------------------------------------------- 1 | name: Swift nightly build 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | jobs: 7 | linux: 8 | runs-on: ubuntu-latest 9 | timeout-minutes: 15 10 | strategy: 11 | matrix: 12 | image: ['nightly-focal', 'nightly-jammy', 'nightly-amazonlinux2'] 13 | 14 | container: 15 | image: swiftlang/swift:${{ matrix.image }} 16 | steps: 17 | - name: Checkout 18 | uses: actions/checkout@v4 19 | - name: Test 20 | run: | 21 | swift test 22 | -------------------------------------------------------------------------------- /.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/hummingbirdpostgres" 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.10 2 | // The swift-tools-version declares the minimum version of Swift required to build this package. 3 | 4 | import PackageDescription 5 | 6 | let swiftSettings: [SwiftSetting] = [.enableExperimentalFeature("StrictConcurrency=complete")] 7 | 8 | let package = Package( 9 | name: "hummingbird-postgres", 10 | platforms: [.macOS(.v14), .iOS(.v17), .tvOS(.v17)], 11 | products: [ 12 | .library(name: "HummingbirdPostgres", targets: ["HummingbirdPostgres"]) 13 | ], 14 | dependencies: [ 15 | .package(url: "https://github.com/hummingbird-project/hummingbird.git", from: "2.5.0"), 16 | .package(url: "https://github.com/hummingbird-project/postgres-migrations", from: "0.1.0"), 17 | .package(url: "https://github.com/vapor/postgres-nio", from: "1.25.0"), 18 | ], 19 | targets: [ 20 | .target( 21 | name: "HummingbirdPostgres", 22 | dependencies: [ 23 | .product(name: "PostgresMigrations", package: "postgres-migrations"), 24 | .product(name: "Hummingbird", package: "hummingbird"), 25 | .product(name: "PostgresNIO", package: "postgres-nio"), 26 | ], 27 | swiftSettings: swiftSettings 28 | ), 29 | .testTarget( 30 | name: "HummingbirdPostgresTests", 31 | dependencies: [ 32 | "HummingbirdPostgres", 33 | .product(name: "HummingbirdTesting", package: "hummingbird"), 34 | ] 35 | ), 36 | ], 37 | swiftLanguageVersions: [.v5, .version("6")] 38 | ) 39 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | 4 | 5 | 6 |

7 |

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

18 | 19 | # Hummingbird Postgres 20 | 21 | HummingbirdPostgres provides implementations of the persist frameworks from Hummingbird using `PostgresClient` from PostgresNIO. 22 | 23 | ## Local Development setup 24 | 25 | Setup run 26 | ```sh 27 | docker compose up 28 | ``` 29 | 30 | Tear down 31 | ```sh 32 | docker compose down 33 | ``` 34 | 35 | ## Documentation 36 | 37 | Reference documentation and guides for HummingbirdPostgres can be found [here](https://docs.hummingbird.codes/2.0/documentation/hummingbirdpostgres). 38 | -------------------------------------------------------------------------------- /Sources/HummingbirdPostgres/CreatePersistTable.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 | import Logging 16 | import PostgresMigrations 17 | import PostgresNIO 18 | 19 | struct CreatePersistTable: DatabaseMigration { 20 | func apply(connection: PostgresConnection, logger: Logger) async throws { 21 | try await connection.query( 22 | """ 23 | CREATE TABLE IF NOT EXISTS _hb_pg_persist ( 24 | "id" text PRIMARY KEY, 25 | "data" json NOT NULL, 26 | "expires" timestamp with time zone NOT NULL 27 | ) 28 | """, 29 | logger: logger 30 | ) 31 | } 32 | 33 | func revert(connection: PostgresConnection, logger: Logger) async throws { 34 | try await connection.query( 35 | "DROP TABLE _hb_pg_persist", 36 | logger: logger 37 | ) 38 | } 39 | 40 | var name: String { "_Create_Persist_Table_" } 41 | var group: DatabaseMigrationGroup { .persist } 42 | } 43 | 44 | extension DatabaseMigrationGroup { 45 | /// Persist driver migration group 46 | public static var persist: Self { .init("_hb_pg_persist") } 47 | } 48 | -------------------------------------------------------------------------------- /Sources/HummingbirdPostgres/PostgresPersistDriver.swift: -------------------------------------------------------------------------------- 1 | //===----------------------------------------------------------------------===// 2 | // 3 | // This source file is part of the Hummingbird server framework project 4 | // 5 | // Copyright (c) 2021-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 | import AsyncAlgorithms 16 | import Foundation 17 | import Hummingbird 18 | import NIOCore 19 | import PostgresMigrations 20 | import PostgresNIO 21 | 22 | extension PSQLError { 23 | public var serverError: PostgresError.Code? { 24 | switch self.code { 25 | case .server: return self.serverInfo?[.sqlState].map { PostgresError.Code(raw: $0) } ?? nil 26 | default: return nil 27 | } 28 | } 29 | } 30 | 31 | /// Postgres driver for persist system for storing persistent cross request key/value pairs 32 | /// 33 | /// The Postgres driver uses the database migration service ``/PostgresMigrations/DatabaseMigrations`` to 34 | /// create its database table. Before the server is running you should run the migrations 35 | /// to build your table. 36 | /// ``` 37 | /// let migrations = DatabaseMigrations() 38 | /// let persist = PostgresPersistDriver( 39 | /// client: postgresClient, 40 | /// migrations: migrations, 41 | /// logger: logger 42 | /// ) 43 | /// var app = Application(...) 44 | /// app.runBeforeServerStart { 45 | /// try await migrations.apply(client: postgresClient, logger: logger, dryRun: applyMigrations) 46 | /// } 47 | /// ``` 48 | public final class PostgresPersistDriver: PersistDriver { 49 | struct WrapperObject: PostgresCodable, Codable { 50 | let value: Value 51 | 52 | init(_ value: Value) { 53 | self.value = value 54 | } 55 | 56 | init(from decoder: Decoder) throws { 57 | let container = try decoder.singleValueContainer() 58 | self.value = try container.decode(Value.self) 59 | } 60 | 61 | func encode(to encoder: Encoder) throws { 62 | var container = encoder.singleValueContainer() 63 | try container.encode(self.value) 64 | } 65 | } 66 | 67 | let client: PostgresClient 68 | let logger: Logger 69 | let tidyUpFrequency: Duration 70 | let migrations: DatabaseMigrations 71 | 72 | /// Initialize PostgresPersistDriver 73 | /// - Parameters: 74 | /// - client: Postgres client 75 | /// - migrations: ``/PostgresMigrations/DatabaseMigrations`` array to add persist migrations 76 | /// - tidyUpFrequency: How frequently cleanup expired database entries should occur 77 | /// - logger: Logger used by persist 78 | public init(client: PostgresClient, migrations: DatabaseMigrations, tidyUpFrequency: Duration = .seconds(600), logger: Logger) async { 79 | self.client = client 80 | self.logger = logger 81 | self.tidyUpFrequency = tidyUpFrequency 82 | self.migrations = migrations 83 | await migrations.add(CreatePersistTable()) 84 | } 85 | 86 | /// Create new key. This doesn't check for the existence of this key already so may fail if the key already exists 87 | public func create(key: String, value: some Codable, expires: Duration?) async throws { 88 | let expires = expires.map { Date.now + Double($0.components.seconds) } ?? Date.distantFuture 89 | do { 90 | try await self.client.query( 91 | "INSERT INTO _hb_pg_persist (id, data, expires) VALUES (\(key), \(WrapperObject(value)), \(expires))", 92 | logger: self.logger 93 | ) 94 | } catch let error as PSQLError { 95 | if error.serverError == .uniqueViolation { 96 | throw PersistError.duplicate 97 | } else { 98 | throw error 99 | } 100 | } 101 | } 102 | 103 | /// Set value for key. 104 | public func set(key: String, value: some Codable, expires: Duration?) async throws { 105 | if let expires { 106 | let expires = Date.now + Double(expires.components.seconds) 107 | try await self.client.query( 108 | """ 109 | INSERT INTO _hb_pg_persist (id, data, expires) VALUES (\(key), \(WrapperObject(value)), \(expires)) 110 | ON CONFLICT (id) 111 | DO UPDATE SET data = \(WrapperObject(value)), expires = \(expires) 112 | """, 113 | logger: self.logger 114 | ) 115 | 116 | } else { 117 | try await self.client.query( 118 | """ 119 | INSERT INTO _hb_pg_persist (id, data, expires) VALUES (\(key), \(WrapperObject(value)), \(Date.distantFuture)) 120 | ON CONFLICT (id) 121 | DO UPDATE SET data = \(WrapperObject(value)) 122 | """, 123 | logger: self.logger 124 | ) 125 | } 126 | } 127 | 128 | /// Get value for key 129 | public func get(key: String, as object: Object.Type) async throws -> Object? { 130 | let stream = try await self.client.query( 131 | "SELECT data, expires FROM _hb_pg_persist WHERE id = \(key)", 132 | logger: self.logger 133 | ) 134 | do { 135 | guard 136 | let (object, expires) = try await stream.decode((WrapperObject, Date).self) 137 | .first(where: { _ in true }) 138 | else { 139 | return nil 140 | } 141 | guard expires > .now else { return nil } 142 | return object.value 143 | } catch is DecodingError { 144 | throw PersistError.invalidConversion 145 | } 146 | } 147 | 148 | /// Remove key 149 | public func remove(key: String) async throws { 150 | try await self.client.query( 151 | "DELETE FROM _hb_pg_persist WHERE id = \(key)", 152 | logger: self.logger 153 | ) 154 | } 155 | 156 | /// tidy up database by cleaning out expired keys 157 | func tidy() async throws { 158 | try await self.client.query( 159 | "DELETE FROM _hb_pg_persist WHERE expires < \(Date.now)", 160 | logger: self.logger 161 | ) 162 | } 163 | } 164 | 165 | /// Service protocol requirements 166 | extension PostgresPersistDriver { 167 | public func run() async throws { 168 | self.logger.info("Waiting for persist driver migrations to complete") 169 | try await self.migrations.waitUntilCompleted() 170 | 171 | // do an initial tidy to clear out expired values 172 | self.logger.info("Tidy persist database") 173 | try await self.tidy() 174 | 175 | let timerSequence = AsyncTimerSequence( 176 | interval: self.tidyUpFrequency, 177 | clock: .suspending 178 | ).cancelOnGracefulShutdown() 179 | 180 | for try await _ in timerSequence { 181 | try await self.tidy() 182 | } 183 | } 184 | } 185 | -------------------------------------------------------------------------------- /Tests/HummingbirdPostgresTests/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 HummingbirdPostgres 17 | import HummingbirdTesting 18 | import Logging 19 | import PostgresMigrations 20 | import PostgresNIO 21 | import ServiceLifecycle 22 | import XCTest 23 | 24 | func getPostgresConfiguration() async throws -> PostgresClient.Configuration { 25 | let env = try await Environment().merging(with: .dotEnv()) 26 | return .init( 27 | host: env.get("POSTGRES_HOSTNAME") ?? "localhost", 28 | port: env.get("POSTGRES_PORT", as: Int.self) ?? 5432, 29 | username: env.get("POSTGRES_USER") ?? "test_user", 30 | password: env.get("POSTGRES_PASSWORD") ?? "test_password", 31 | database: env.get("POSTGRES_DB") ?? "test_db", 32 | tls: .disable 33 | ) 34 | } 35 | 36 | final class PersistTests: XCTestCase { 37 | static func createApplication( 38 | _ updateRouter: (Router, PersistDriver) -> Void = { _, _ in } 39 | ) async throws -> some ApplicationProtocol { 40 | struct PostgresErrorMiddleware: RouterMiddleware { 41 | func handle(_ request: Request, context: Context, next: (Request, Context) async throws -> Response) async throws -> Response { 42 | do { 43 | return try await next(request, context) 44 | } catch let error as PSQLError { 45 | XCTFail("\(String(reflecting: error))") 46 | throw error 47 | } catch { 48 | throw error 49 | } 50 | } 51 | } 52 | let logger = { 53 | var logger = Logger(label: "PersistTests") 54 | logger.logLevel = .debug 55 | return logger 56 | }() 57 | let postgresClient = try await PostgresClient( 58 | configuration: getPostgresConfiguration(), 59 | backgroundLogger: logger 60 | ) 61 | let postgresMigrations = DatabaseMigrations() 62 | let persist = await PostgresPersistDriver(client: postgresClient, migrations: postgresMigrations, logger: logger) 63 | let router = Router() 64 | router.middlewares.add(PostgresErrorMiddleware()) 65 | router.put("/persist/:tag") { request, context -> HTTPResponse.Status in 66 | let buffer = try await request.body.collect(upTo: .max) 67 | let tag = try context.parameters.require("tag") 68 | try await persist.set(key: tag, value: String(buffer: buffer)) 69 | return .ok 70 | } 71 | router.put("/persist/:tag/:time") { request, context -> HTTPResponse.Status in 72 | guard let time = context.parameters.get("time", as: Int.self) else { throw HTTPError(.badRequest) } 73 | let buffer = try await request.body.collect(upTo: .max) 74 | let tag = try context.parameters.require("tag") 75 | try await persist.set(key: tag, value: String(buffer: buffer), expires: .seconds(time)) 76 | return .ok 77 | } 78 | router.get("/persist/:tag") { _, context -> String? in 79 | guard let tag = context.parameters.get("tag", as: String.self) else { throw HTTPError(.badRequest) } 80 | return try await persist.get(key: tag, as: String.self) 81 | } 82 | router.delete("/persist/:tag") { _, context -> HTTPResponse.Status in 83 | guard let tag = context.parameters.get("tag", as: String.self) else { throw HTTPError(.badRequest) } 84 | try await persist.remove(key: tag) 85 | return .noContent 86 | } 87 | updateRouter(router, persist) 88 | var app = Application(responder: router.buildResponder()) 89 | app.addServices(postgresClient, persist) 90 | app.beforeServerStarts { 91 | try await postgresMigrations.apply(client: postgresClient, groups: [.persist], logger: logger, dryRun: false) 92 | } 93 | 94 | return app 95 | } 96 | 97 | func testSetGet() async throws { 98 | let app = try await Self.createApplication() 99 | try await app.test(.router) { client in 100 | let tag = UUID().uuidString 101 | try await client.execute(uri: "/persist/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "Persist")) { _ in } 102 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 103 | let body = try XCTUnwrap(response.body) 104 | XCTAssertEqual(String(buffer: body), "Persist") 105 | } 106 | } 107 | } 108 | 109 | func testCreateGet() async throws { 110 | let app = try await Self.createApplication { router, persist in 111 | router.put("/create/:tag") { request, context -> HTTPResponse.Status in 112 | let buffer = try await request.body.collect(upTo: .max) 113 | let tag = try context.parameters.require("tag") 114 | try await persist.create(key: tag, value: String(buffer: buffer)) 115 | return .ok 116 | } 117 | } 118 | try await app.test(.router) { client in 119 | let tag = UUID().uuidString 120 | try await client.execute(uri: "/create/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "Persist")) { _ in } 121 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 122 | let body = try XCTUnwrap(response.body) 123 | XCTAssertEqual(String(buffer: body), "Persist") 124 | } 125 | } 126 | } 127 | 128 | func testDoubleCreateFail() async throws { 129 | let app = try await Self.createApplication { router, persist in 130 | router.put("/create/:tag") { request, context -> HTTPResponse.Status in 131 | let buffer = try await request.body.collect(upTo: .max) 132 | let tag = try context.parameters.require("tag") 133 | do { 134 | try await persist.create(key: tag, value: String(buffer: buffer)) 135 | } catch let error as PersistError where error == .duplicate { 136 | throw HTTPError(.conflict) 137 | } 138 | return .ok 139 | } 140 | } 141 | try await app.test(.router) { client in 142 | let tag = UUID().uuidString 143 | try await client.execute(uri: "/create/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "Persist")) { response in 144 | XCTAssertEqual(response.status, .ok) 145 | } 146 | try await client.execute(uri: "/create/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "Persist")) { response in 147 | XCTAssertEqual(response.status, .conflict) 148 | } 149 | } 150 | } 151 | 152 | func testSetTwice() async throws { 153 | let app = try await Self.createApplication() 154 | try await app.test(.router) { client in 155 | 156 | let tag = UUID().uuidString 157 | try await client.execute(uri: "/persist/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "test1")) { _ in } 158 | try await client.execute(uri: "/persist/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "test2")) { response in 159 | XCTAssertEqual(response.status, .ok) 160 | } 161 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 162 | let body = try XCTUnwrap(response.body) 163 | XCTAssertEqual(String(buffer: body), "test2") 164 | } 165 | } 166 | } 167 | 168 | func testExpires() async throws { 169 | let app = try await Self.createApplication() 170 | try await app.test(.router) { client in 171 | 172 | let tag1 = UUID().uuidString 173 | let tag2 = UUID().uuidString 174 | 175 | try await client.execute(uri: "/persist/\(tag1)/0", method: .put, body: ByteBufferAllocator().buffer(string: "ThisIsTest1")) { _ in } 176 | try await client.execute(uri: "/persist/\(tag2)/10", method: .put, body: ByteBufferAllocator().buffer(string: "ThisIsTest2")) { _ in } 177 | try await Task.sleep(nanoseconds: 1_000_000_000) 178 | try await client.execute(uri: "/persist/\(tag1)", method: .get) { response in 179 | XCTAssertEqual(response.status, .noContent) 180 | } 181 | try await client.execute(uri: "/persist/\(tag2)", method: .get) { response in 182 | let body = try XCTUnwrap(response.body) 183 | XCTAssertEqual(String(buffer: body), "ThisIsTest2") 184 | } 185 | } 186 | } 187 | 188 | func testCodable() async throws { 189 | struct TestCodable: Codable { 190 | let buffer: String 191 | } 192 | let app = try await Self.createApplication { router, persist in 193 | router.put("/codable/:tag") { request, context -> HTTPResponse.Status in 194 | guard let tag = context.parameters.get("tag") else { throw HTTPError(.badRequest) } 195 | let buffer = try await request.body.collect(upTo: .max) 196 | try await persist.set(key: tag, value: TestCodable(buffer: String(buffer: buffer))) 197 | return .ok 198 | } 199 | router.get("/codable/:tag") { _, context -> String? in 200 | guard let tag = context.parameters.get("tag") else { throw HTTPError(.badRequest) } 201 | let value = try await persist.get(key: tag, as: TestCodable.self) 202 | return value?.buffer 203 | } 204 | } 205 | try await app.test(.router) { client in 206 | 207 | let tag = UUID().uuidString 208 | try await client.execute(uri: "/codable/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "Persist")) { _ in } 209 | try await client.execute(uri: "/codable/\(tag)", method: .get) { response in 210 | let body = try XCTUnwrap(response.body) 211 | XCTAssertEqual(String(buffer: body), "Persist") 212 | } 213 | } 214 | } 215 | 216 | func testInvalidGetAs() async throws { 217 | struct TestCodable: Codable { 218 | let buffer: String 219 | } 220 | let app = try await Self.createApplication { router, persist in 221 | router.put("/invalid") { _, _ -> HTTPResponse.Status in 222 | try await persist.set(key: "test", value: TestCodable(buffer: "hello")) 223 | return .ok 224 | } 225 | router.get("/invalid") { _, _ -> String? in 226 | do { 227 | return try await persist.get(key: "test", as: String.self) 228 | } catch let error as PersistError where error == .invalidConversion { 229 | throw HTTPError(.badRequest) 230 | } 231 | } 232 | } 233 | try await app.test(.router) { client in 234 | try await client.execute(uri: "/invalid", method: .put) 235 | try await client.execute(uri: "/invalid", method: .get) { response in 236 | XCTAssertEqual(response.status, .badRequest) 237 | } 238 | } 239 | } 240 | 241 | func testRemove() async throws { 242 | let app = try await Self.createApplication() 243 | try await app.test(.router) { client in 244 | let tag = UUID().uuidString 245 | try await client.execute(uri: "/persist/\(tag)", method: .put, body: ByteBufferAllocator().buffer(string: "ThisIsTest1")) { _ in } 246 | try await client.execute(uri: "/persist/\(tag)", method: .delete) { _ in } 247 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 248 | XCTAssertEqual(response.status, .noContent) 249 | } 250 | } 251 | } 252 | 253 | func testExpireAndAdd() async throws { 254 | let app = try await Self.createApplication() 255 | try await app.test(.router) { client in 256 | 257 | let tag = UUID().uuidString 258 | try await client.execute(uri: "/persist/\(tag)/0", method: .put, body: ByteBuffer(string: "ThisIsTest1")) { _ in } 259 | try await Task.sleep(nanoseconds: 1_000_000_000) 260 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 261 | XCTAssertEqual(response.status, .noContent) 262 | } 263 | try await client.execute(uri: "/persist/\(tag)/10", method: .put, body: ByteBuffer(string: "ThisIsTest1")) { response in 264 | XCTAssertEqual(response.status, .ok) 265 | } 266 | try await client.execute(uri: "/persist/\(tag)", method: .get) { response in 267 | XCTAssertEqual(response.status, .ok) 268 | let body = try XCTUnwrap(response.body) 269 | XCTAssertEqual(String(buffer: body), "ThisIsTest1") 270 | } 271 | } 272 | } 273 | } 274 | -------------------------------------------------------------------------------- /docker-compose.yaml: -------------------------------------------------------------------------------- 1 | services: 2 | postgres: 3 | image: postgres:16.3-alpine 4 | ports: 5 | - 5432:5432 6 | volumes: 7 | - db:/var/lib/postgresql/hummingbird 8 | environment: 9 | - POSTGRES_PASSWORD=test_password 10 | - POSTGRES_USER=test_user 11 | - POSTGRES_DB=test_db 12 | volumes: 13 | db: 14 | driver: local 15 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------