Unwrap response from within a reply payload

Author: dsrees

src/main/kotlin/org/phoenixframework/Message.kt

@@ -37,19 +37,24 @@ class Message(
   @SerializedName("event")
   val event: String = "",
 
-  /** The payload of the message */
+  /** The raw payload of the message. It is recommended that you use `payload` instead. */
   @SerializedName("payload")
-  val payload: Payload = HashMap(),
+  val rawPayload: Payload = HashMap(),
 
   /** The ref sent during a join event. Empty if not present. */
   @SerializedName("join_ref")
   val joinRef: String? = null) {
 
 
+  /** The payload of the message */
+  @Suppress("UNCHECKED_CAST")
+  val payload: Payload
+    get() = rawPayload["response"] as? Payload ?: rawPayload
+
   /**
    * Convenience var to access the message's payload's status. Equivalent
    * to checking message.payload["status"] yourself
    */
   val status: String?
-    get() = payload["status"] as? String
+    get() = rawPayload["status"] as? String
 }

src/test/kotlin/org/phoenixframework/MessageTest.kt

@@ -8,18 +8,56 @@ import org.junit.jupiter.api.Test
 class MessageTest {
 
   @Nested
-  @DisplayName("status")
-  inner class Status {
+  @DisplayName("json parsing")
+  inner class JsonParsing {
 
     @Test
-    internal fun `returns the status from the payload`() {
-      val payload = mapOf("one" to "two", "status" to "ok")
-      val message = Message("ref", "topic", "event", payload, null)
-
-      assertThat(message.ref).isEqualTo("ref")
-      assertThat(message.topic).isEqualTo("topic")
-      assertThat(message.event).isEqualTo("event")
-      assertThat(message.payload).isEqualTo(payload)
+    internal fun `jsonParsing parses normal message`() {
+      val json = """
+        {
+          "event": "update",
+          "payload": {
+            "user": "James S.",
+            "message": "This is a test"
+          },
+          "ref": "6",
+          "topic": "my-topic"
+        }
+      """.trimIndent()
+
+      val message = Defaults.decode.invoke(json)
+
+      assertThat(message.ref).isEqualTo("6")
+      assertThat(message.topic).isEqualTo("my-topic")
+      assertThat(message.event).isEqualTo("update")
+      assertThat(message.payload).isEqualTo(mapOf("user" to "James S.", "message" to "This is a test"))
+      assertThat(message.joinRef).isNull()
+      assertThat(message.status).isNull()
+    }
+
+    @Test
+    internal fun `jsonParsing parses a reply`() {
+      val json = """
+        {
+          "event": "phx_reply",
+          "payload": {
+            "response": {
+              "user": "James S.",
+              "message": "This is a test"
+            },
+            "status": "ok"
+          },
+          "ref": "6",
+          "topic": "my-topic"
+        }
+      """.trimIndent()
+
+      val message = Defaults.decode.invoke(json)
+
+      assertThat(message.ref).isEqualTo("6")
+      assertThat(message.topic).isEqualTo("my-topic")
+      assertThat(message.event).isEqualTo("phx_reply")
+      assertThat(message.payload).isEqualTo(mapOf("user" to "James S.", "message" to "This is a test"))
       assertThat(message.joinRef).isNull()
       assertThat(message.status).isEqualTo("ok")
     }