fix: Fix 2 template properties deserialization WPB-28090

.github/workflows/staging.yml

@@ -1,4 +1,4 @@
-name: Build
+name: Staging
 
 on:
   workflow_dispatch:

docker-compose.yml

@@ -13,12 +13,8 @@ services:
       - WIRE_SDK_API_TOKEN=${WIRE_SDK_API_TOKEN}
       - WIRE_SDK_APP_ID=${WIRE_SDK_APP_ID}
       - WIRE_SDK_CRYPTOGRAPHY_STORAGE_PASSWORD=${WIRE_SDK_CRYPTOGRAPHY_STORAGE_PASSWORD}
-      - WIRE_SDK_USER_ID=${WIRE_SDK_USER_ID}
-      - WIRE_SDK_EMAIL=${WIRE_SDK_EMAIL}
-      - WIRE_SDK_PASSWORD=${WIRE_SDK_PASSWORD}
-      - WIRE_SDK_ENVIRONMENT=${WIRE_SDK_ENVIRONMENT}
     ports:
-      - "${GHAPP_SERVER_PORT}:${GHAPP_SERVER_PORT}"
+      - "${GHAPP_SERVER_PORT:-8083}:${GHAPP_SERVER_PORT:-8083}"
     volumes:
         - github-app:/app
     depends_on:

helm/githubapp/templates/NOTES.txt

@@ -37,12 +37,6 @@ MONITORING & DEBUGGING:
 
 CONFIGURATION:
 {{- range .Values.env }}
-{{- if eq .name "WIRE_SDK_ENVIRONMENT" }}
-- Wire SDK Environment: {{ .value | default "Not configured" }}
-{{- end }}
-{{- if eq .name "WIRE_ENV" }}
-- Wire Environment: {{ .value | default "Not configured" }}
-{{- end }}
 {{- if eq .name "PORT" }}
 - Application Port: {{ .value | default "8080" }}
 {{- end }}

src/main/kotlin/com/wire/github/Routing.kt

@@ -22,6 +22,7 @@ import io.ktor.server.routing.post
 import io.ktor.server.routing.routing
 import java.util.UUID
 import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.SerializationException
 import org.koin.core.context.GlobalContext
 
 @Suppress("LongMethod")
@@ -37,7 +38,7 @@ fun Application.configureRouting() {
 
     routing {
         trace {
-            application.log.info(it.buildText())
+            application.log.debug(it.buildText())
         }
 
         get("/health") {
@@ -84,7 +85,12 @@ fun Application.configureRouting() {
                 )
             }
 
-            val response = KtxSerializer.json.decodeFromString<GitHubResponse>(payload)
+            val response = try {
+                KtxSerializer.json.decodeFromString<GitHubResponse>(payload)
+            } catch (exception: SerializationException) {
+                application.log.error("Failed to deserialize $event delivery $delivery", exception)
+                return@post call.response.status(HttpStatusCode.BadRequest)
+            }
 
             // Handle event response and send message
             val messageTemplate = templateHandler.handleEvent(

src/main/kotlin/com/wire/github/response/model/Comment.kt

@@ -5,7 +5,7 @@ import kotlinx.serialization.Serializable
 
 @Serializable
 data class Comment(
-    val body: String,
+    val body: String? = null,
     val user: User,
     @SerialName("html_url")
     val htmlUrl: String,

src/main/kotlin/com/wire/github/response/model/Issue.kt

@@ -8,7 +8,7 @@ data class Issue(
     @SerialName("html_url")
     val htmlUrl: String,
     val title: String,
-    val body: String,
+    val body: String? = null,
     val user: User,
     val number: Int
 )

src/main/kotlin/com/wire/github/response/model/PullRequest.kt

@@ -8,8 +8,8 @@ data class PullRequest(
     @SerialName("html_url")
     val htmlUrl: String,
     val title: String,
-    val body: String,
+    val body: String? = null,
     val user: User,
-    val merged: Boolean,
+    val merged: Boolean? = null,
     val number: Int
 )

src/main/kotlin/com/wire/github/response/model/Review.kt

@@ -4,7 +4,14 @@ import kotlinx.serialization.Serializable
 
 @Serializable
 data class Review(
-    val body: String,
-    val user: User,
+    val body: String? = null,
+    val user: User? = null,
     val state: String
-)
+) {
+    val emoji: String
+        get() = when (state) {
+            "approved" -> "✅"
+            "changes_requested" -> "🔄"
+            else -> "📝"
+        }
+}

src/main/kotlin/com/wire/github/util/TemplateHandler.kt

@@ -22,13 +22,14 @@ class TemplateHandler {
                 event = event,
                 action = response.action
             )
+            logger.info("Template found for this action: ${template.name}")
 
             populateTemplate(
                 mustache = template,
                 model = response
             )
         } catch (exception: MustacheNotFoundException) {
-            logger.error("MustacheNotFoundException: $exception")
+            logger.info("MustacheNotFoundException: $exception")
             null
         }
 
@@ -62,6 +63,7 @@ class TemplateHandler {
             .apply {
                 mustache.execute(PrintWriter(this), model).flush()
             }.toString()
+            .takeIf { it.isNotBlank() }
 
     private companion object {
         const val LANGUAGE_ENGLISH = "en"

src/main/resources/templates/en/issue_comment.created.template

@@ -1,6 +1,5 @@
-**[{{repository.fullName}}]** New comment by **{{sender.login}}** on issue **{{{issue.title}}}**
-
-{{{comment.body}}}
-
-[comment]({{comment.htmlUrl}})
-—
+📝 **New comment** on PR/issue **{{{issue.title}}}** by **{{sender.login}}**
+**Repository:** {{repository.fullName}}
+**PR/issue:** [#{{issue.number}}]({{issue.htmlUrl}}) - {{issue.title}}
+**Comment:** [link]({{comment.htmlUrl}})
+**Text:** {{{comment.body}}}

src/main/resources/templates/en/pull_request.ready_for_review.template

@@ -0,0 +1,3 @@
+🟢 **New Pull Request Ready for Review!** by **{{sender.login}}**
+**Repository:** {{repository.fullName}}
+**PR:** [#{{pullRequest.number}}]({{pullRequest.htmlUrl}}) - {{pullRequest.title}}

src/main/resources/templates/en/pull_request.reopened.template

@@ -0,0 +1,3 @@
+🟢 **New Pull Request Reopened!** by **{{sender.login}}**
+**Repository:** {{repository.fullName}}
+**PR:** [#{{pullRequest.number}}]({{pullRequest.htmlUrl}}) - {{pullRequest.title}}

src/main/resources/templates/en/pull_request_review.submitted.template

@@ -1,6 +1,6 @@
-{{#review.body}}**[{{repository.fullName}}]** Pull request review **{{pullRequest.title}}** was {{action}} by **{{review.user.login}}**
-
-{{{review.body}}}
-
-[pull request]({{pullRequest.htmlUrl}})
-—{{/review.body}}
+{{#review.body}}
+{{review.emoji}} **Pull request** update: **{{review.state}}** by **{{review.user.login}}**
+**Repository:** {{repository.fullName}}
+**PR:** [#{{pullRequest.number}}]({{pullRequest.htmlUrl}}) - {{pullRequest.title}}
+**Text:** {{{review.body}}}
+{{/review.body}}

src/main/resources/templates/en/pull_request_review_comment.created.template

@@ -1,6 +1,5 @@
-**[{{repository.fullName}}]** Pull request review **{{pullRequest.title}}** was commented by **{{comment.user.login}}**
-
-{{{comment.body}}}
-
-[comment]({{comment.htmlUrl}})
-—
+📝 **Pull request** was **commented** by **{{comment.user.login}}**
+**Repository:** {{repository.fullName}}
+**PR:** [#{{pullRequest.number}}]({{pullRequest.htmlUrl}}) - {{pullRequest.title}}
+**Comment:** [link]({{comment.htmlUrl}})
+**Text:** {{{comment.body}}}

src/main/resources/templates/en/push.template

@@ -1,9 +1,8 @@
 {{^commits.isEmpty}}
-**[{{repository.fullName}}]** Push by **{{sender.login}}**
-
+🫸 **Push** by **{{sender.login}}**
+**Repository:** {{repository.fullName}}
 {{#commits}}
  - {{{message}}}
 {{/commits}}
-
-[compare]({{compare}})
+**Compare:** [link]({{compare}})
 —{{/commits.isEmpty}}

src/test/kotlin/com/wire/github/util/TemplateHandlerTest.kt

@@ -0,0 +1,127 @@
+package com.wire.github.util
+
+import com.wire.github.response.model.Commit
+import com.wire.github.response.model.GitHubResponse
+import com.wire.github.response.model.PullRequest
+import com.wire.github.response.model.Repository
+import com.wire.github.response.model.Review
+import com.wire.github.response.model.User
+import kotlin.test.Test
+import kotlin.test.assertContains
+import kotlin.test.assertNull
+
+class TemplateHandlerTest {
+    private val templateHandler = TemplateHandler()
+
+    @Test
+    fun `does not render a submitted pull request review without a body`() {
+        val message = templateHandler.handleEvent(
+            event = "pull_request_review",
+            response = reviewResponse(body = null)
+        )
+
+        assertNull(message)
+    }
+
+    @Test
+    fun `does not render a submitted pull request review with a blank body`() {
+        val message = templateHandler.handleEvent(
+            event = "pull_request_review",
+            response = reviewResponse(body = "")
+        )
+
+        assertNull(message)
+    }
+
+    @Test
+    fun `renders a submitted pull request review with a body`() {
+        val message = templateHandler.handleEvent(
+            event = "pull_request_review",
+            response = reviewResponse(body = "Looks good")
+        )
+
+        assertContains(message.orEmpty(), "Looks good")
+        assertContains(message.orEmpty(), "✅")
+    }
+
+    @Test
+    fun `renders a note emoji for a commented pull request review`() {
+        val message = templateHandler.handleEvent(
+            event = "pull_request_review",
+            response = reviewResponse(body = "A comment", state = "commented")
+        )
+
+        assertContains(message.orEmpty(), "📝")
+    }
+
+    @Test
+    fun `renders a change emoji for a pull request review with requested changes`() {
+        val message = templateHandler.handleEvent(
+            event = "pull_request_review",
+            response = reviewResponse(body = "Please update this", state = "changes_requested")
+        )
+
+        assertContains(message.orEmpty(), "🔄")
+    }
+
+    @Test
+    fun `does not render a push with no commits`() {
+        val message = templateHandler.handleEvent(
+            event = "push",
+            response = pushResponse(commits = emptyList())
+        )
+
+        assertNull(message)
+    }
+
+    @Test
+    fun `renders a push with commits`() {
+        val message = templateHandler.handleEvent(
+            event = "push",
+            response = pushResponse(commits = listOf(Commit(message = "Add feature")))
+        )
+
+        assertContains(message.orEmpty(), "Add feature")
+    }
+
+    private fun reviewResponse(
+        body: String?,
+        state: String = "approved"
+    ) = GitHubResponse(
+        action = "submitted",
+        pullRequest = PullRequest(
+            htmlUrl = "https://github.com/wire/example/pull/1",
+            title = "Example pull request",
+            user = user,
+            number = 1
+        ),
+        review = Review(
+            body = body,
+            user = user,
+            state = state
+        ),
+        sender = user,
+        repository = Repository(
+            fullName = "wire/example",
+            name = "example"
+        )
+    )
+
+    private fun pushResponse(commits: List<Commit>) =
+        GitHubResponse(
+            commits = commits,
+            sender = user,
+            compare = "https://github.com/wire/example/compare/main",
+            repository = Repository(
+                fullName = "wire/example",
+                name = "example"
+            )
+        )
+
+    private companion object {
+        val user = User(
+            avatarUrl = "https://github.com/wire.png",
+            login = "wire"
+        )
+    }
+}