feat: Add Helm configuration #WPB-21554

Author: spoonman01

.dockerignore

@@ -1,6 +1,7 @@
 Makefile
 .gradle
 .idea
+build
 .kotlin
 .gitignore
 LICENSE

.env.example

@@ -0,0 +1,17 @@
+# Database
+DB_USER=remind-app-user
+DB_PASSWORD=super-secret-wire-pwd
+DB_URL=jdbc:postgresql://db:5432/remind-app
+DB_NAME=remind-app
+
+# Init
+SDK_APP_ID=myAppUuid
+SDK_APP_TOKEN=myApiToken
+API_HOST_URL=https://staging-nginz-https.zinfra.io
+CRYPTO_PASSWORD=myDummyPasswordmyDummyPassword01
+
+# SDK
+WIRE_SDK_USER_ID=myUserUuid
+WIRE_SDK_EMAIL=[email protected]
+WIRE_SDK_PASSWORD=mySecretPassword01!
+WIRE_SDK_ENVIRONMENT=staging.zinfra.io

.env.sample

@@ -38,10 +38,6 @@ nb-configuration.xml
 # Plugin directory
 /.quarkus/cli/plugins/
 
-**/demo.properties
-
-# Ignore SQLite database
-*.db
-
-# Ignore Core-crypto directory
-cryptography
+# Ignore Storage directory content but keep the directory
+storage/*
+!storage/.gitkeep

.gitignore

@@ -9,7 +9,9 @@ COPY . .
 
 RUN ./gradlew clean build --no-daemon
 
-FROM registry.access.redhat.com/ubi9/openjdk-21
+FROM eclipse-temurin:21-jre
+
+WORKDIR /deployments
 
 ENV LANGUAGE='en_US:en'
 
@@ -19,9 +21,9 @@ COPY --chown=185 --from=build /setup/build/quarkus-app/quarkus-run.jar /deployme
 COPY --chown=185 --from=build /setup/build/quarkus-app/app/ /deployments/app/
 COPY --chown=185 --from=build /setup/build/quarkus-app/quarkus/ /deployments/quarkus/
 
+RUN mkdir -p /deployments/storage && chown -R 185:0 /deployments/storage
+
 EXPOSE 8080
 USER 185
-ENV JAVA_OPTS_APPEND="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
-ENV JAVA_APP_JAR="/deployments/quarkus-run.jar"
 
-ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ]
+ENTRYPOINT ["java", "-jar", "-Dquarkus.http.host=0.0.0.0", "-Djava.util.logging.manager=org.jboss.logmanager.LogManager", "/deployments/quarkus-run.jar"]

Dockerfile

@@ -14,9 +14,9 @@ This is an app that can create reminders for conversation, and send a message wh
 - Delete reminders
 
 > [!IMPORTANT]  
-> As of now, the bot only supports a maximum of 5 active reminders per group.
+> As of now, the app only supports a maximum of 5 active reminders per group.
 
-## Getting started
+## Commands
 
 ### The basics of `/remind` command:
 
@@ -39,13 +39,13 @@ This is an app that can create reminders for conversation, and send a message wh
 | one time reminder  | `/remind to` | `"Fill in your invoices by end of day"`        | `"tomorrow at 17:30"`               |
 | one time reminder  | `/remind to` | `"Fill in your invoices by end of day"`        | `"next Tue at 17:30"`               |
 | one time reminder  | `/remind to` | `"Reply to HR email"`                          | `"in 10 minutes"`                   |
-| one time reminder  | `/remind to` | `"Travel back in time to not develop the bot"` | `"11/11/2150"`                      |
+| one time reminder  | `/remind to` | `"Travel back in time to not develop the app"` | `"11/11/2150"`                      |
 | recurrent reminder | `/remind to` | `"Join the daily stand-up"`                    | `"every day at 10:00"`              |
 | recurrent reminder | `/remind to` | `"Empty the unread emails"`                    | `"every Friday at 17:00"`           |
 | recurrent reminder | `/remind to` | `"Empty the unread emails"`                    | `"every Mon, TUE, friday at 17:00"` |
 
 > [!TIP]  
-> You can set reminders for yourself. To do so, you can use the commands in a private conversation, a 1:1 with the bot.
+> You can set reminders for yourself. To do so, you can use the commands in a private conversation, a 1:1 with the app.
 
 ### Other helpful commands:
 
@@ -54,33 +54,24 @@ This is an app that can create reminders for conversation, and send a message wh
 - `/remind delete <reminder-identifier>` (deletes the target reminder, the identifier can be obtained from the list
   command)
 
-## Technical details
+## Development setup
 
-### Bot Architecture
+You first need to set all the env variables required by the app itself and the SDK inside.
+Check the `.env.sample` and create a new `.env` file while setting the properties.
 
-We are using a DDD-like architecture, but without the burden of defining a full DDD model (involving domains "experts"
-and so on). The idea is to have a clear separation of concerns between the different layers of the application.
-So each layer does the following:
+And also the env variables required by `Wire Applications JVM SDK`, check related README 
+[SDK README](https://github.com/wireapp/wire-apps-jvm-sdk/blob/main/README.md)
 
-- **Application**: Exposes the REST API and handles the HTTP requests, it's what the clients see.
-- **Domain**: Contains the business logic, domain core entities, this layer is "clean" in other words, doesn't have any
-  dependency on other layers or frameworks. To access the logic, we provide UseCases, so we can group them (kind of
-  services + aggregates in DDD)
-- **Infrastructure**: Contains the implementation of the domain repositories, and other external dependencies, like
-  databases, queues technologies, framework configurations, etc.
 
-<img src="https://imgpile.com/images/C7Q2Gj.png" width="800"/>
 
-**Note**: To enforce layer dependency, can be split into different gradle modules, but for now, we are keeping it
-simple.
-
-### Bot Framework
+## Running the application in dev mode
 
 This project uses Quarkus, the Supersonic Subatomic Java Framework.
-
 If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
 
-## Running the application in dev mode
+If you don't want to mess with Quarkus, use the provided `Dockerfile` or `docker-compose.yml`
+
+Otherwise you can just start the `db` service in docker to have Postgres running and run the app yourself.
 
 You can run your application in dev mode that enables live coding using:
 ```shell script
@@ -119,7 +110,7 @@ Or, if you don't have GraalVM installed, you can run the native executable build
 ./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true
 ```
 
-You can then execute your native executable with: `./build/reminders-bots-1.0.0-SNAPSHOT-runner`
+You can then execute your native executable inside the `build` directory
 
 If you want to learn more about building native executables, please consult https://quarkus.io/guides/gradle-tooling.
 

README.md

@@ -28,8 +28,8 @@ val quarkusPlatformVersion: String by project
  */
 configurations.all {
     resolutionStrategy {
-        force("com.google.protobuf:protobuf-java:4.32.0")
-        force("com.google.protobuf:protobuf-kotlin:4.32.0")
+        force("com.google.protobuf:protobuf-java:4.33.0")
+        force("com.google.protobuf:protobuf-kotlin:4.33.0")
     }
 }
 
@@ -45,6 +45,8 @@ dependencies {
     implementation("io.quarkus:quarkus-flyway")
     implementation("io.quarkus:quarkus-quartz")
     implementation("io.quarkus:quarkus-jdbc-postgresql")
+    implementation("io.quarkus:quarkus-smallrye-health")
+    implementation("io.quarkus:quarkus-logging-json")
 
     // Kotlin support
     implementation("io.quarkus:quarkus-kotlin")
@@ -55,7 +57,7 @@ dependencies {
     implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.9.0")
     implementation("com.rubiconproject.oss:jchronic:0.2.8")
     implementation("io.arrow-kt:arrow-core:2.1.2")
-    implementation("com.wire:wire-apps-jvm-sdk:0.0.16")
+    implementation("com.wire:wire-apps-jvm-sdk:0.0.18")
 
     // Test dependencies
     testImplementation("io.quarkus:quarkus-junit5")

build.gradle.kts

@@ -1,5 +1,10 @@
-<?xml version="1.0" ?>
+<?xml version='1.0' encoding='UTF-8'?>
 <SmellBaseline>
-  <ManuallySuppressedIssues></ManuallySuppressedIssues>
-  <CurrentIssues></CurrentIssues>
+  <ManuallySuppressedIssues/>
+  <CurrentIssues>
+    <ID>UseCheckOrError:MlsSdkClient.kt$MlsSdkClient$throw IllegalStateException("API_HOST_URL environment variable is required")</ID>
+    <ID>UseCheckOrError:MlsSdkClient.kt$MlsSdkClient$throw IllegalStateException("CRYPTO_PASSWORD environment variable is required")</ID>
+    <ID>UseCheckOrError:MlsSdkClient.kt$MlsSdkClient$throw IllegalStateException("SDK_APP_ID environment variable is required")</ID>
+    <ID>UseCheckOrError:MlsSdkClient.kt$MlsSdkClient$throw IllegalStateException("SDK_APP_TOKEN environment variable is required")</ID>
+  </CurrentIssues>
 </SmellBaseline>

config/detekt/baseline.xml

@@ -1,26 +1,30 @@
 version: '3'
 
 services:
-  reminders_bot:
-    image: wirebots/reminders:latest
+  reminders_app:
+    platform: linux/amd64 # Allows using core-crypto on macOs
     build:
       context: ./
       dockerfile: Dockerfile
     environment:
-      QUARKUS_DATASOURCE_URL: jdbc:postgresql://db/quarkus
+      QUARKUS_DATASOURCE_URL: jdbc:postgresql://db/${DB_NAME}
+    env_file: .env
+    volumes:
+      - reminders_app-storage:/deployments/storage
     depends_on:
       - db
 
   db:
     image: postgres:13
     environment:
-      - POSTGRES_USER=quarkus
-      - POSTGRES_PASSWORD=quarkus
-      - POSTGRES_DB=quarkus
+      - POSTGRES_USER=${DB_USER}
+      - POSTGRES_PASSWORD=${DB_PASSWORD}
+      - POSTGRES_DB=${DB_NAME}
     ports:
       - 5432:5432
     volumes:
-      - reminders_bot-db:/var/lib/postgresql/data/
+      - reminders_app-db:/var/lib/postgresql/data/
 
 volumes:
-  reminders_bot-db:
+  reminders_app-storage:
+  reminders_app-db:

docker-compose.yml

@@ -0,0 +1,9 @@
+apiVersion: v2
+name: remindapp
+description: Wire Remind-App - A Helm chart for deploying the Wire Remind app
+type: application
+version: 0.1.0
+appVersion: "0.1.0"
+home: https://github.com/wireapp/remind-app
+maintainers:
+  - name: Wire Integrations Team