Draft: suspendapp-update

.devcontainer/devcontainer.json

@@ -0,0 +1,12 @@
+{
+  "name": "Java",
+  "image": "mcr.microsoft.com/devcontainers/java:1-21",
+  "features": {
+    "ghcr.io/devcontainers/features/java:1": {
+      "version": "none",
+      "installMaven": "true",
+      "mavenVersion": "3.8.6",
+      "installGradle": "true"
+    }
+  }
+}

.github/workflows/junie.yml

@@ -0,0 +1,22 @@
+name: Junie
+run-name: Junie run ${{ inputs.run_id }}
+
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  workflow_dispatch:
+    inputs:
+      run_id:
+        description: "id of workflow process"
+        required: true
+      workflow_params:
+        description: "stringified params"
+        required: true
+
+jobs:
+  call-workflow-passing-data:
+    uses: jetbrains-junie/junie-workflows/.github/workflows/ej-issue.yml@main
+    with:
+      workflow_params: ${{ inputs.workflow_params }}

.github/workflows/main.yml

@@ -1,40 +1,40 @@
 name: "build"
 
-on: push
+on: [push, pull_request]
 
 env:
-  GRADLE_OPTS: -Dorg.gradle.jvmargs="-Xmx5g -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8"
+  GRADLE_OPTS: -Dorg.gradle.jvmargs="-Xmx6g -XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8"
 
 jobs:
   build:
     runs-on: 'ubuntu-latest'
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.0.2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Set up Java
-        uses: actions/setup-java@v3.4.1
+        uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 19
 
       - name: Build
-        uses: gradle/gradle-build-action@v2.2.3
+        uses: gradle/gradle-build-action@v3
         with:
           arguments: build --full-stacktrace
 
       - name: Upload reports
         if: always()
-        uses: actions/upload-artifact@v3.1.0
+        uses: actions/upload-artifact@v4
         with:
           name: 'reports-${{ matrix.os }}'
           path: '**/build/reports/**'
 
       - name: Upload Code Scanning code analysis report
-        if: always()
-        uses: github/codeql-action/upload-sarif@v2
+        if: ${{ hashFiles('build/reports/detekt/main.sarif') != '' }}
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: 'build/reports/detekt/main.sarif'

CONTRIBUTING.MD

@@ -0,0 +1,54 @@
+# Contributing to Ktor Arrow Example
+
+I want to encourage everyone to contribute to Ktor Arrow Example,
+if you're unsure if you did everything correctly please just submit a PR, and ask for advice.
+I'll be more than happy to help you out!
+
+If you have any suggestions, or ideas feel free to open an issue or open a PR immediately.
+I'm happy to receive any suggestions, or feedback and we can discuss on the issue or PR on how to procced.
+
+## Implementing a new feature
+
+All issues are end-to-end, meaning that when solving an issue you probably need to:
+1. Add respective operation in the repository layer (repo package).
+2. (optional) If operation is more complex than a single database operation, add service layer function that implements the operation
+3. Add route that handles, and validates requests, and calls the respective service or repository layer function.
+4. Writing a couple of tests that verify the correct behavior. See [writing tests](#writing-tests)
+
+Step 2 is optional because I personally don't like unnecessary wrapping repository layer functions in a service layer.
+
+## Writing tests
+
+When writing tests we typically want to test more than the happy path. So ideally we test following scenarios:
+ - Check happy path
+ - Check with incorrect, or missing, query/path parameters
+ - Check different error responses, and/or not found responses.
+ - If route is authenticated: test what happens if unauthorised 
+
+## Creating new files
+
+The project currently uses the traditional packaging by layer approach,
+the app exists out of 3 _main_ layers:
+
+- repo: All persistence layer code belongs here. 1 file/interface per table.
+- service: All service layer code, this is code combining persistence layers in higher-level functionality
+- routes: All Ktor routing belongs in this package. Files are split amongst their respective endpoint
+
+## Formatting the project
+
+The project uses Spotless and KtFmt for formatting the code.
+To format the code simply run `./gradlew spotlessApply`, this is being checked and verified on GitHub Actions.
+
+## Running the project
+
+To run the project, you first need to start the environment.
+This can be done with `docker-compose up`,
+and then you can start the Ktor server with `./gradlew run`.
+
+```shell
+docker-compose up
+./gradlew run
+curl -i 0.0.0.0:8080/readiness
+```
+
+Beware that `./gradlew run` doesn't properly run JVM Shutdown hooks, and the port remains bound.

LICENSE.MD

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.MD

@@ -1,21 +1,34 @@
 # Ktor Arrow Real World Example
 
-> While most "todo" demos provide an excellent cursory glance at a framework's capabilities, they typically don't convey the knowledge & perspective required to actually build real applications with it.
+> While most "todo" demos provide an excellent cursory glance at a framework's capabilities, they typically don't convey
+> the knowledge & perspective required to actually build real applications with it.
 
-*Read the [full blog post announcing RealWorld on Medium.](https://medium.com/@ericsimons/introducing-realworld-6016654d36b5)*
+*Read
+the [full blog post announcing RealWorld on Medium.](https://medium.com/@ericsimons/introducing-realworld-6016654d36b5)*
 
 Over 100 implementations have been created using various languages, libraries, and frameworks.
 
 Explore them on [**CodebaseShow**](https://codebase.show/projects/realworld).
 
-In order for Real World back-end and front-end examples to be able to work together we need to follow a predefined [openapi.yml](https://github.com/gothinkster/realworld/blob/main/api/openapi.yml).
+In order for Real World back-end and front-end examples to be able to work together we need to follow a
+predefined [openapi.yml](https://github.com/gothinkster/realworld/blob/main/api/openapi.yml).
+
+## Looking to contribute?
+
+If you're looking to contribute check-out [CONTRIBUTING.MD](CONTRIBUTING.MD).
+Also, this project participates in hacktoberfest!
+
+I will provide personal guidance, and support to everyone that is interested in learning about Ktor, Arrow and Kotlin by
+contributing to this repository!
 
 ## How it works
 
-This example uses [Kotlin](https://kotlinlang.org/docs/home.html) with [Ktor](https://ktor.io/) and [Arrow](https://arrow-kt.io/) as the main building blocks.
+This example uses [Kotlin](https://kotlinlang.org/docs/home.html) with [Ktor](https://ktor.io/)
+and [Arrow](https://arrow-kt.io/) as the main building blocks.
 Other technologies used:
- - [SqlDelight](https://cashapp.github.io/sqldelight/) for the persistence layer
- - [Kotest](https://kotest.io/) for testing
+
+- [SqlDelight](https://cashapp.github.io/sqldelight/) for the persistence layer
+- [Kotest](https://kotest.io/) for testing
 
 ## Running the project
 
@@ -26,5 +39,7 @@ and then you can start the Ktor server with `./gradlew run`.
 ```shell
 docker-compose up
 ./gradlew run
-curl 0.0.0.0:8080/health
+curl -i 0.0.0.0:8080/readiness
 ```
+
+Beware that `./gradlew run` doesn't properly run JVM Shutdown hooks, and the port remains bound.