Using json serializer v2

Author: dsrees

ChatExample/app/build.gradle

@@ -5,11 +5,11 @@ apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
 
 android {
-    compileSdkVersion 28
+    compileSdkVersion 30
     defaultConfig {
         applicationId "com.github.dsrees.chatexample"
         minSdkVersion 19
-        targetSdkVersion 28
+        targetSdkVersion 30
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -36,8 +36,8 @@ dependencies {
             `/build/lib/*.jar` to `/ChatExample/app/libs`
         and comment out the mavenCentral() dependency
      */
-//    implementation fileTree(dir: 'libs', include: ['*.jar'])
-    implementation 'com.github.dsrees:JavaPhoenixClient:0.3.4'
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+//    implementation 'com.github.dsrees:JavaPhoenixClient:0.3.4'
 
 
     implementation "com.google.code.gson:gson:2.8.5"

ChatExample/app/libs/JavaPhoenixClient-0.3.4.jar renamed to ChatExample/app/libs/JavaPhoenixClient-0.7.0.jar

@@ -224,7 +224,7 @@ class Channel(
 
     // Perform when the join reply is received
     this.on(Event.REPLY) { message ->
-      this.trigger(replyEventName(message.ref), message.payload, message.ref, message.joinRef)
+      this.trigger(replyEventName(message.ref), message.rawPayload, message.ref, message.joinRef)
     }
   }
 
@@ -394,7 +394,7 @@ class Channel(
     ref: String = "",
     joinRef: String? = null
   ) {
-    this.trigger(Message(ref, topic, event, payload, joinRef))
+    this.trigger(Message(joinRef, ref, topic, event, payload))
   }
 
   internal fun trigger(message: Message) {

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

@@ -25,6 +25,7 @@ package org.phoenixframework
 import com.google.gson.FieldNamingPolicy
 import com.google.gson.Gson
 import com.google.gson.GsonBuilder
+import com.google.gson.reflect.TypeToken
 import okhttp3.HttpUrl
 import java.net.URL
 
@@ -36,6 +37,9 @@ object Defaults {
   /** Default heartbeat interval of 30s */
   const val HEARTBEAT: Long = 30_000
 
+  /** Default JSON Serializer Version set to 2.0.0 */
+  const val VSN: String = "2.0.0"
+
   /** Default reconnect algorithm for the socket */
   val reconnectSteppedBackOff: (Int) -> Long = { tries ->
     if (tries > 9) 5_000 else listOf(
@@ -59,8 +63,21 @@ object Defaults {
    * Default JSON decoder, backed by GSON, that takes JSON and converts it
    * into a Message object.
    */
+  @Suppress("UNCHECKED_CAST")
   val decode: DecodeClosure = { rawMessage ->
-    gson.fromJson(rawMessage, Message::class.java)
+    val anyType = object : TypeToken<List<Any>>() {}.type
+    val result = gson.fromJson<List<Any>>(rawMessage, anyType)
+
+
+    // vsn=2.0.0 message structure
+    // [join_ref, ref, topic, event, payload]
+    Message(
+      joinRef = result[0] as? String?,
+      ref = result[1] as? String ?: "",
+      topic = result[2] as? String ?: "",
+      event = result[3] as? String ?: "",
+      rawPayload = result[4] as? Payload ?: mapOf()
+    )
   }
 
   /**
@@ -81,7 +98,8 @@ object Defaults {
    */
   internal fun buildEndpointUrl(
     endpoint: String,
-    paramsClosure: PayloadClosure
+    paramsClosure: PayloadClosure,
+    vsn: String
   ): URL {
     var mutableUrl = endpoint
     // Silently replace web socket URLs with HTTP URLs.
@@ -91,19 +109,20 @@ object Defaults {
       mutableUrl = "https:" + endpoint.substring(4)
     }
 
-    // If there are query params, append them now
-    var httpUrl =
-      HttpUrl.parse(mutableUrl) ?: throw IllegalArgumentException("invalid url: $endpoint")
+    // Add the VSN query parameter
+    var httpUrl = HttpUrl.parse(mutableUrl)
+      ?: throw IllegalArgumentException("invalid url: $endpoint")
+    val httpBuilder = httpUrl.newBuilder()
+    httpBuilder.addQueryParameter("vsn", vsn)
+
+    // Append any additional query params
     paramsClosure.invoke()?.let {
-      val httpBuilder = httpUrl.newBuilder()
       it.forEach { (key, value) ->
         httpBuilder.addQueryParameter(key, value.toString())
       }
-
-      httpUrl = httpBuilder.build()
     }
 
-    // Store the URL that will be used to establish a connection
-    return httpUrl.url()
+    // Return the [URL] that will be used to establish a connection
+    return httpBuilder.build().url()
   }
 }

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

@@ -22,29 +22,23 @@
 
 package org.phoenixframework
 
-import com.google.gson.annotations.SerializedName
 
-class Message(
+data class Message(
+  /** The ref sent during a join event. Empty if not present. */
+  val joinRef: String? = null,
+
   /** The unique string ref. Empty if not present */
-  @SerializedName("ref")
   val ref: String = "",
 
   /** The message topic */
-  @SerializedName("topic")
   val topic: String = "",
 
   /** The message event name, for example "phx_join" or any other custom name */
-  @SerializedName("event")
   val event: String = "",
 
   /** The raw payload of the message. It is recommended that you use `payload` instead. */
-  @SerializedName("payload")
-  val rawPayload: Payload = HashMap(),
-
-  /** The ref sent during a join event. Empty if not present. */
-  @SerializedName("join_ref")
-  val joinRef: String? = null) {
-
+  internal val rawPayload: Payload = HashMap()
+) {
 
   /** The payload of the message */
   @Suppress("UNCHECKED_CAST")

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

@@ -126,7 +126,7 @@ class Presence(channel: Channel, opts: Options = Options.defaults) {
     if (stateEvent != null && diffEvent != null) {
 
       this.channel.on(stateEvent) { message ->
-        val newState = message.payload.toMutableMap() as PresenceState
+        val newState = message.rawPayload.toMutableMap() as PresenceState
 
         this.joinRef = this.channel.joinRef
         this.state =
@@ -142,7 +142,7 @@ class Presence(channel: Channel, opts: Options = Options.defaults) {
       }
 
       this.channel.on(diffEvent) { message ->
-        val diff = message.payload.toMutableMap() as PresenceDiff
+        val diff = message.rawPayload.toMutableMap() as PresenceDiff
         if (isPendingSyncState) {
           this.pendingDiffs.add(diff)
         } else {

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

@@ -22,8 +22,6 @@
 
 package org.phoenixframework
 
-import com.google.gson.Gson
-import okhttp3.HttpUrl
 import okhttp3.OkHttpClient
 import okhttp3.Response
 import java.net.URL
@@ -105,7 +103,7 @@ const val WS_CLOSE_ABNORMAL = 1006
 typealias PayloadClosure = () -> Payload?
 
 /** A closure that will encode a Map<String, Any> into a JSON String */
-typealias EncodeClosure = (Map<String, Any>) -> String
+typealias EncodeClosure = (Any) -> String
 
 /** A closure that will decode a JSON String into a [Message] */
 typealias DecodeClosure = (String) -> Message
@@ -125,13 +123,15 @@ typealias DecodeClosure = (String) -> Message
  * ```
  * @param url Url to connect to such as https://example.com/socket
  * @param paramsClosure Closure which allows to change parameters sent during connection.
+ * @param vsn JSON Serializer version to use. Defaults to 2.0.0
  * @param encode Optional. Provide a custom JSON encoding implementation
  * @param decode Optional. Provide a custom JSON decoding implementation
  * @param client Default OkHttpClient to connect with. You can provide your own if needed.
  */
 class Socket(
   url: String,
   val paramsClosure: PayloadClosure,
+  val vsn: String = Defaults.VSN,
   private val encode: EncodeClosure = Defaults.encode,
   private val decode: DecodeClosure = Defaults.decode,
   private val client: OkHttpClient = OkHttpClient.Builder().build()
@@ -235,17 +235,19 @@ class Socket(
    *
    * @param url Url to connect to such as https://example.com/socket
    * @param params Constant parameters to send when connecting. Defaults to null
+   * @param vsn JSON Serializer version to use. Defaults to 2.0.0
    * @param encode Optional. Provide a custom JSON encoding implementation
    * @param decode Optional. Provide a custom JSON decoding implementation
    * @param client Default OkHttpClient to connect with. You can provide your own if needed.
    */
   constructor(
     url: String,
     params: Payload? = null,
+    vsn: String = Defaults.VSN,
     encode: EncodeClosure = Defaults.encode,
     decode: DecodeClosure = Defaults.decode,
     client: OkHttpClient = OkHttpClient.Builder().build()
-  ) : this(url, { params }, encode, decode, client)
+  ) : this(url, { params }, vsn, encode, decode, client)
 
   init {
     var mutableUrl = url
@@ -266,7 +268,7 @@ class Socket(
 
     // Store the URL that will be used to establish a connection. Could potentially be
     // different at the time connect() is called based on a changing params closure.
-    this.endpointUrl = Defaults.buildEndpointUrl(this.endpoint, this.paramsClosure)
+    this.endpointUrl = Defaults.buildEndpointUrl(this.endpoint, this.paramsClosure, this.vsn)
 
     // Create reconnect timer
     this.reconnectTimer = TimeoutTimer(
@@ -305,7 +307,7 @@ class Socket(
 
     // Build the new endpointUrl with the params closure. The payload returned
     // from the closure could be different such as a changing authToken.
-    this.endpointUrl = Defaults.buildEndpointUrl(this.endpoint, this.paramsClosure)
+    this.endpointUrl = Defaults.buildEndpointUrl(this.endpoint, this.paramsClosure, this.vsn)
 
     // Now create the connection transport and attempt to connect
     this.connection = this.transport(endpointUrl)
@@ -390,14 +392,7 @@ class Socket(
   ) {
 
     val callback: (() -> Unit) = {
-      val body = mutableMapOf<String, Any>()
-      body["topic"] = topic
-      body["event"] = event
-      body["payload"] = payload
-
-      ref?.let { body["ref"] = it }
-      joinRef?.let { body["join_ref"] = it }
-
+      val body = listOf(joinRef, ref, topic, event, payload)
       val data = this.encode(body)
       connection?.let { transport ->
         this.logItems("Push: Sending $data")

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

@@ -42,4 +42,26 @@ internal class DefaultsTest {
     assertThat(reconnect(4)).isEqualTo(10_000)
     assertThat(reconnect(5)).isEqualTo(10_000)
   }
+
+
+  @Test
+  internal fun `decoder converts json array into message`() {
+    val v2Json = """
+      [null,null,"room:lobby","shout",{"message":"Hi","name":"Tester"}]
+    """.trimIndent()
+
+    val message = Defaults.decode(v2Json)
+    assertThat(message.joinRef).isNull()
+    assertThat(message.ref).isEqualTo("")
+    assertThat(message.topic).isEqualTo("room:lobby")
+    assertThat(message.event).isEqualTo("shout")
+    assertThat(message.payload).isEqualTo(mapOf("message" to "Hi", "name" to "Tester"))
+  }
+
+  @Test
+  internal fun `encode converts message into json`() {
+    val body = listOf(null, null, "topic", "event", mapOf("one" to "two"))
+    assertThat(Defaults.encode(body))
+      .isEqualTo("[null,null,\"topic\",\"event\",{\"one\":\"two\"}]")
+  }
 }

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

@@ -14,15 +14,7 @@ class MessageTest {
     @Test
     internal fun `jsonParsing parses normal message`() {
       val json = """
-        {
-          "event": "update",
-          "payload": {
-            "user": "James S.",
-            "message": "This is a test"
-          },
-          "ref": "6",
-          "topic": "my-topic"
-        }
+        [null, "6", "my-topic", "update", {"user": "James S.", "message": "This is a test"}]
       """.trimIndent()
 
       val message = Defaults.decode.invoke(json)
@@ -38,18 +30,7 @@ class MessageTest {
     @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"
-        }
+        [null, "6", "my-topic", "phx_reply", {"response": {"user": "James S.","message": "This is a test"},"status": "ok"}]
       """.trimIndent()
 
       val message = Defaults.decode.invoke(json)