feat(realtime): implement V2 serializer (#1829)

Author: edgurgel

packages/core/realtime-js/src/RealtimeClient.ts

@@ -7,7 +7,9 @@ import {
   DEFAULT_TIMEOUT,
   SOCKET_STATES,
   TRANSPORTS,
-  VSN,
+  DEFAULT_VSN,
+  VSN_1_0_0,
+  VSN_2_0_0,
   WS_CLOSE_NORMAL,
 } from './lib/constants'
 
@@ -70,6 +72,7 @@ export type RealtimeClientOptions = {
   timeout?: number
   heartbeatIntervalMs?: number
   heartbeatCallback?: (status: HeartbeatStatus) => void
+  vsn?: string
   logger?: Function
   encode?: Function
   decode?: Function
@@ -109,6 +112,7 @@ export default class RealtimeClient {
   heartbeatCallback: (status: HeartbeatStatus) => void = noop
   ref: number = 0
   reconnectTimer: Timer | null = null
+  vsn: string = DEFAULT_VSN
   logger: Function = noop
   logLevel?: LogLevel
   encode!: Function
@@ -226,7 +230,7 @@ export default class RealtimeClient {
    * @returns string The URL of the websocket.
    */
   endpointURL(): string {
-    return this._appendParams(this.endPoint, Object.assign({}, this.params, { vsn: VSN }))
+    return this._appendParams(this.endPoint, Object.assign({}, this.params, { vsn: this.vsn }))
   }
 
   /**
@@ -811,6 +815,8 @@ export default class RealtimeClient {
     this.worker = options?.worker ?? false
     this.accessToken = options?.accessToken ?? null
     this.heartbeatCallback = options?.heartbeatCallback ?? noop
+    this.vsn = options?.vsn ?? DEFAULT_VSN
+
     // Handle special cases
     if (options?.params) this.params = options.params
     if (options?.logger) this.logger = options.logger
@@ -826,13 +832,27 @@ export default class RealtimeClient {
         return RECONNECT_INTERVALS[tries - 1] || DEFAULT_RECONNECT_FALLBACK
       })
 
-    this.encode =
-      options?.encode ??
-      ((payload: JSON, callback: Function) => {
-        return callback(JSON.stringify(payload))
-      })
+    switch (this.vsn) {
+      case VSN_1_0_0:
+        this.encode =
+          options?.encode ??
+          ((payload: JSON, callback: Function) => {
+            return callback(JSON.stringify(payload))
+          })
 
-    this.decode = options?.decode ?? this.serializer.decode.bind(this.serializer)
+        this.decode =
+          options?.decode ??
+          ((payload: string, callback: Function) => {
+            return callback(JSON.parse(payload))
+          })
+        break
+      case VSN_2_0_0:
+        this.encode = options?.encode ?? this.serializer.encode.bind(this.serializer)
+        this.decode = options?.decode ?? this.serializer.decode.bind(this.serializer)
+        break
+      default:
+        throw new Error(`Unsupported serializer version: ${this.vsn}`)
+    }
 
     // Handle worker setup
     if (this.worker) {

packages/core/realtime-js/src/lib/constants.ts

@@ -1,7 +1,10 @@
 import { version } from './version'
 
 export const DEFAULT_VERSION = `realtime-js/${version}`
-export const VSN: string = '1.0.0'
+
+export const VSN_1_0_0: string = '1.0.0'
+export const VSN_2_0_0: string = '2.0.0'
+export const DEFAULT_VSN: string = VSN_1_0_0
 
 export const VERSION = version