Merge pull request #6 from fractalliter/upgrade_ktor

upgrade_ktor

Author: fractalliter

.github/pull_request_template.md

@@ -7,6 +7,7 @@
 <!-- You can erase any parts of this template not applicable to your Pull Request. -->
 
 ### How to test
+
 <!-- Add description about the tests -->
 
 ### New Feature Submissions:

CODE_OF_CONDUCT.md

@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

README.md

@@ -1,8 +1,12 @@
 # Kotlin Ktor and postgres backend
+
 Here lays a Kotlin web project with Ktor framework, Postgres database, and JWT Authentication.
 
 The project comprises following ingredients:
-- [Ktor](https://ktor.io/) server includes [JSON serializers](https://ktor.io/docs/serialization.html), [Authentication](https://ktor.io/docs/authentication.html), and [Testing](https://ktor.io/docs/testing.html)
+
+- [Ktor](https://ktor.io/) server
+  includes [JSON serializers](https://ktor.io/docs/serialization.html), [Authentication](https://ktor.io/docs/authentication.html),
+  and [Testing](https://ktor.io/docs/testing.html)
 - [Netty](https://netty.io/) web server
 - [Postgres](https://www.postgresql.org/) as database
 - [Exposed](https://github.com/JetBrains/Exposed) as ORM
@@ -15,11 +19,13 @@ better go for [GUAVA Graph](https://github.com/google/guava/wiki/GraphsExplained
 
 Project is agnostic about database, you can dynamically change Postgres to any other databases that Exposed JDBC
 supports by changing a couple of variables:
+
 - the database driver version in `gradle.properties`
 - the database driver dependency in `build.gradle.kts`
 - the **WEB_DB_URL** variable in `.env` file
 
 ## Flow
+
 1. deploy the docker compose with `docker compose up -d` command
 2. sign up to the system `/signup` with a username and password(not hardened enough)
 3. log in to with username and password to get access token `/login`
@@ -31,7 +37,8 @@ supports by changing a couple of variables:
 > You need **root access** for docker
 
 Go to the root directory of the project where `docker-compose.yml` is and change the environment variables in
-`.env-example` with yours and rename the file to `mv .env-example .env` then deploy the application with following command:
+`.env-example` with yours and rename the file to `mv .env-example .env` then deploy the application with following
+command:
 
 ```bash
 docker-compose up
@@ -145,17 +152,21 @@ The response will be the access token
 ```
 
 ## How to test locally
+
 For testing the project locally you can run docker compose with `docker-compose-test.yml` file. It will run the tests
 against a test database.
+
 ```bash
 docker-compose --file docker-compose-test.yml up 
 ```
-After finishing the tests you can clean test data nd  shut the containers down with following command:
+
+After finishing the tests you can clean test data nd shut the containers down with following command:
 
 ```bash
 docker-compose --file docker-compose-test.yml down -v
 ```
 
 ## Continues Integration
+
 For continues integration, the CI workflow prepares the database, run the gradle build with tests, and generates report
 to Codacy about the quality of code.

build.gradle.kts

@@ -6,10 +6,11 @@ val database_driver_version: String by project
 val gson_version: String by project
 val jbcrypt_version: String by project
 val hikaricp_version: String by project
+val redis_version: String by project
 
 plugins {
     application
-    kotlin("jvm") version "1.6.20"
+    kotlin("jvm") version "1.8.0"
     id("org.jetbrains.kotlin.plugin.serialization") version "1.6.20"
     id("com.github.johnrengelman.shadow") version "7.0.0"
 }
@@ -37,26 +38,26 @@ repositories {
 }
 
 dependencies {
-    implementation("io.ktor:ktor-server-content-negotiation-jvm:$ktor_version")
-    implementation("io.ktor:ktor-client-content-negotiation:$ktor_version")
-    implementation("io.ktor:ktor-server-core-jvm:$ktor_version")
-    implementation("io.ktor:ktor-serialization-kotlinx-json-jvm:$ktor_version")
-    implementation("io.ktor:ktor-server-netty-jvm:$ktor_version")
     implementation("ch.qos.logback:logback-classic:$logback_version")
     implementation("org.jetbrains.exposed:exposed-core:$exposed_version")
     implementation("org.jetbrains.exposed:exposed-dao:$exposed_version")
     implementation("org.jetbrains.exposed:exposed-jdbc:$exposed_version")
     // add database driver below, default is postgres
     implementation("org.postgresql:postgresql:$database_driver_version")
     implementation("com.google.code.gson:gson:$gson_version")
+    implementation("org.mindrot:jbcrypt:$jbcrypt_version")
+    implementation("io.github.crackthecodeabhi:kreds:$redis_version")
+    implementation("com.zaxxer:HikariCP:$hikaricp_version")
+    implementation("io.ktor:ktor-server-content-negotiation-jvm:$ktor_version")
+    implementation("io.ktor:ktor-client-content-negotiation:$ktor_version")
+    implementation("io.ktor:ktor-server-core-jvm:$ktor_version")
+    implementation("io.ktor:ktor-serialization-kotlinx-json-jvm:$ktor_version")
+    implementation("io.ktor:ktor-server-netty-jvm:$ktor_version")
     implementation("io.ktor:ktor-server-auth:$ktor_version")
     implementation("io.ktor:ktor-server-status-pages:$ktor_version")
-    implementation("org.mindrot", "jbcrypt", "0.4")
     implementation("io.ktor:ktor-server-auth-jwt:$ktor_version")
-    implementation("io.github.crackthecodeabhi:kreds:0.8")
-    implementation("com.zaxxer:HikariCP:$hikaricp_version")
-    testImplementation("io.ktor:ktor-server-tests-jvm:$ktor_version")
     testImplementation("org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version")
-    testImplementation("io.ktor:ktor-server-test-host:$ktor_version")
     testImplementation("org.jetbrains.kotlin:kotlin-test:$kotlin_version")
+    testImplementation("io.ktor:ktor-server-tests-jvm:$ktor_version")
+    testImplementation("io.ktor:ktor-server-test-host-jvm:$ktor_version")
 }

docker-compose.yml

@@ -30,32 +30,4 @@ services:
       - "5432:5432"
     healthcheck:
       test: [ "CMD-SHELL", "pg_isready -U postgres" ]
-      interval: 1s
-#  auth-db:
-#    image: postgres
-#    volumes:
-#      - postgres_data:/var/lib/postgresql/data
-#    environment:
-#      POSTGRES_DB: ${AUTH_DB_DATABASE}
-#      POSTGRES_USER: ${AUTH_DB_USER}
-#      POSTGRES_PASSWORD: ${AUTH_DB_PASSWORD}
-#  keycloak:
-#      image: docker.io/bitnami/keycloak:latest
-#      environment:
-#        DB_VENDOR: ${AUTH_DB_VENDOR}
-#        KEYCLOAK_DATABASE_HOST: ${AUTH_DB_ADDRESS}
-#        KEYCLOAK_DATABASE_PORT: ${AUTH_DB_PORT}
-#        KEYCLOAK_DATABASE_NAME: ${AUTH_DB_DATABASE}
-#        KEYCLOAK_DATABASE_USER: ${AUTH_DB_USER}
-#        KEYCLOAK_DATABASE_SCHEMA: ${AUTH_DB_SCHEMA}
-#        KEYCLOAK_DATABASE_PASSWORD: ${AUTH_DB_PASSWORD}
-#        KEYCLOAK_MANAGEMENT_USER: ${AUTH_SERVER_USER}
-#        KEYCLOAK_MANAGEMENT_PASSWORD: ${AUTH_SERVER_PASSWORD}
-#        KEYCLOAK_ADMIN_USER: ${AUTH_ADMIN_USER}
-#        KEYCLOAK_ADMIN_PASSWORD: ${AUTH_ADMIN_PASSWORD}
-#        # Uncomment the line below if you want to specify JDBC parameters. The parameter below is just an example, and it shouldn't be used in production without knowledge. It is highly recommended that you read the PostgreSQL JDBC driver documentation in order to use it.
-#        #KEYCLOAK_JDBC_PARAMS: "ssl=true"
-#      ports:
-#        - "8080:8080"
-#      depends_on:
-#        - auth-db
+      interval: 1s

gradle.properties

@@ -1,4 +1,4 @@
-ktor_version=2.2.4
+ktor_version=2.3.0
 kotlin_version=1.6.20
 logback_version=1.2.11
 kotlin.code.style=official
@@ -8,3 +8,4 @@ database_driver_version=42.5.1
 gson_version=2.9.0
 jbcrypt_version=0.4
 hikaricp_version=5.0.1
+redis_version=0.8

src/main/kotlin/com/personia/routes/HierarchyRoutes.kt

@@ -39,13 +39,13 @@ fun Route.hierarchyRouting(nodeService: NodeService) {
 
             val response = nodeService.retrieveSupervisors(name, level)
             val json: String = gson.toJson(response)
-            call.respondText(text = json,contentType = applicationJson)
+            call.respondText(text = json, contentType = applicationJson)
         }
         post {
             val hierarchy = call.receive<Map<String, String>>()
             val response = nodeService.createHierarchy(hierarchy)
             val json = gson.toJson(response)
-            call.respondText(text = json,contentType = applicationJson)
+            call.respondText(text = json, contentType = applicationJson)
         }
     }
 }