@supabase/realtime-js 2.80.1-canary.2 → 2.80.1-canary.3

package/src/lib/serializer.ts

@@ -1,16 +1,160 @@
 // This file draws heavily from https://github.com/phoenixframework/phoenix/commit/cf098e9cf7a44ee6479d31d911a97d3c7430c6fe
 // License: https://github.com/phoenixframework/phoenix/blob/master/LICENSE.md
+import { CHANNEL_EVENTS } from '../lib/constants'
+
+export type Msg<T> = {
+  join_ref: string
+  ref: string
+  topic: string
+  event: string
+  payload: T
+}
 
 export default class Serializer {
   HEADER_LENGTH = 1
+  META_LENGTH = 4
+  USER_BROADCAST_PUSH_META_LENGTH = 5
+  KINDS = { push: 0, reply: 1, broadcast: 2, userBroadcastPush: 3, userBroadcast: 4 }
+  BINARY_ENCODING = 0
+  JSON_ENCODING = 1
+  BROADCAST = 'broadcast'
+
+  encode(
+    msg: Msg<{ [key: string]: any } | ArrayBuffer>,
+    callback: (result: ArrayBuffer | string) => any
+  ) {
+    if (this._isArrayBuffer(msg.payload)) {
+      return callback(this._binaryEncodePush(msg as Msg<ArrayBuffer>))
+    }
+
+    if (
+      msg.event === this.BROADCAST &&
+      !(msg.payload instanceof ArrayBuffer) &&
+      typeof msg.payload.event === 'string'
+    ) {
+      return callback(
+        this._binaryEncodeUserBroadcastPush(msg as Msg<{ event: string } & { [key: string]: any }>)
+      )
+    }
+
+    let payload = [msg.join_ref, msg.ref, msg.topic, msg.event, msg.payload]
+    return callback(JSON.stringify(payload))
+  }
+
+  private _binaryEncodePush(message: Msg<ArrayBuffer>) {
+    const { join_ref, ref, event, topic, payload } = message
+    const metaLength = this.META_LENGTH + join_ref.length + ref.length + topic.length + event.length
+
+    const header = new ArrayBuffer(this.HEADER_LENGTH + metaLength)
+    let view = new DataView(header)
+    let offset = 0
+
+    view.setUint8(offset++, this.KINDS.push) // kind
+    view.setUint8(offset++, join_ref.length)
+    view.setUint8(offset++, ref.length)
+    view.setUint8(offset++, topic.length)
+    view.setUint8(offset++, event.length)
+    Array.from(join_ref, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+    Array.from(ref, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+    Array.from(topic, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+    Array.from(event, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+
+    var combined = new Uint8Array(header.byteLength + payload.byteLength)
+    combined.set(new Uint8Array(header), 0)
+    combined.set(new Uint8Array(payload), header.byteLength)
+
+    return combined.buffer
+  }
+
+  private _binaryEncodeUserBroadcastPush(message: Msg<{ event: string } & { [key: string]: any }>) {
+    if (this._isArrayBuffer(message.payload?.payload)) {
+      return this._encodeBinaryUserBroadcastPush(message)
+    } else {
+      return this._encodeJsonUserBroadcastPush(message)
+    }
+  }
+
+  private _encodeBinaryUserBroadcastPush(message: Msg<{ event: string } & { [key: string]: any }>) {
+    const { join_ref, ref, topic } = message
+    const userEvent = message.payload.event
+    const userPayload = message.payload?.payload ?? new ArrayBuffer(0)
+
+    const metaLength =
+      this.USER_BROADCAST_PUSH_META_LENGTH +
+      join_ref.length +
+      ref.length +
+      topic.length +
+      userEvent.length
+
+    const header = new ArrayBuffer(this.HEADER_LENGTH + metaLength)
+    let view = new DataView(header)
+    let offset = 0
+
+    view.setUint8(offset++, this.KINDS.userBroadcastPush) // kind
+    view.setUint8(offset++, join_ref.length)
+    view.setUint8(offset++, ref.length)
+    view.setUint8(offset++, topic.length)
+    view.setUint8(offset++, userEvent.length)
+    view.setUint8(offset++, this.BINARY_ENCODING)
+    Array.from(join_ref, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+    Array.from(ref, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+    Array.from(topic, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+    Array.from(userEvent, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+
+    var combined = new Uint8Array(header.byteLength + userPayload.byteLength)
+    combined.set(new Uint8Array(header), 0)
+    combined.set(new Uint8Array(userPayload), header.byteLength)
+
+    return combined.buffer
+  }
+
+  private _encodeJsonUserBroadcastPush(message: Msg<{ event: string } & { [key: string]: any }>) {
+    const { join_ref, ref, topic } = message
+    const userEvent = message.payload.event
+    const userPayload = message.payload?.payload ?? {}
+
+    const encoder = new TextEncoder() // Encodes to UTF-8
+    const encodedUserPayload = encoder.encode(JSON.stringify(userPayload)).buffer
+
+    const metaLength =
+      this.USER_BROADCAST_PUSH_META_LENGTH +
+      join_ref.length +
+      ref.length +
+      topic.length +
+      userEvent.length
+
+    const header = new ArrayBuffer(this.HEADER_LENGTH + metaLength)
+    let view = new DataView(header)
+    let offset = 0
+
+    view.setUint8(offset++, this.KINDS.userBroadcastPush) // kind
+    view.setUint8(offset++, join_ref.length)
+    view.setUint8(offset++, ref.length)
+    view.setUint8(offset++, topic.length)
+    view.setUint8(offset++, userEvent.length)
+    view.setUint8(offset++, this.JSON_ENCODING)
+    Array.from(join_ref, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+    Array.from(ref, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+    Array.from(topic, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+    Array.from(userEvent, (char) => view.setUint8(offset++, char.charCodeAt(0)))
+
+    var combined = new Uint8Array(header.byteLength + encodedUserPayload.byteLength)
+    combined.set(new Uint8Array(header), 0)
+    combined.set(new Uint8Array(encodedUserPayload), header.byteLength)
+
+    return combined.buffer
+  }
 
   decode(rawPayload: ArrayBuffer | string, callback: Function) {
-    if (rawPayload.constructor === ArrayBuffer) {
-      return callback(this._binaryDecode(rawPayload))
+    if (this._isArrayBuffer(rawPayload)) {
+      let result = this._binaryDecode(rawPayload as ArrayBuffer)
+      return callback(result)
     }
 
     if (typeof rawPayload === 'string') {
-      return callback(JSON.parse(rawPayload))
+      const jsonPayload = JSON.parse(rawPayload)
+      const [join_ref, ref, topic, event, payload] = jsonPayload
+      return callback({ join_ref, ref, topic, event, payload })
     }
 
     return callback({})
@@ -18,9 +162,84 @@ export default class Serializer {
 
   private _binaryDecode(buffer: ArrayBuffer) {
     const view = new DataView(buffer)
+    const kind = view.getUint8(0)
     const decoder = new TextDecoder()
+    switch (kind) {
+      case this.KINDS.push:
+        return this._decodePush(buffer, view, decoder)
+      case this.KINDS.reply:
+        return this._decodeReply(buffer, view, decoder)
+      case this.KINDS.broadcast:
+        return this._decodeBroadcast(buffer, view, decoder)
+      case this.KINDS.userBroadcast:
+        return this._decodeUserBroadcast(buffer, view, decoder)
+    }
+  }
+
+  private _decodePush(
+    buffer: ArrayBuffer,
+    view: DataView,
+    decoder: TextDecoder
+  ): {
+    join_ref: string
+    ref: null
+    topic: string
+    event: string
+    payload: { [key: string]: any }
+  } {
+    const joinRefSize = view.getUint8(1)
+    const topicSize = view.getUint8(2)
+    const eventSize = view.getUint8(3)
+    let offset = this.HEADER_LENGTH + this.META_LENGTH - 1 // pushes have no ref
+    const joinRef = decoder.decode(buffer.slice(offset, offset + joinRefSize))
+    offset = offset + joinRefSize
+    const topic = decoder.decode(buffer.slice(offset, offset + topicSize))
+    offset = offset + topicSize
+    const event = decoder.decode(buffer.slice(offset, offset + eventSize))
+    offset = offset + eventSize
+    const data = JSON.parse(decoder.decode(buffer.slice(offset, buffer.byteLength)))
+    return {
+      join_ref: joinRef,
+      ref: null,
+      topic: topic,
+      event: event,
+      payload: data,
+    }
+  }
 
-    return this._decodeBroadcast(buffer, view, decoder)
+  private _decodeReply(
+    buffer: ArrayBuffer,
+    view: DataView,
+    decoder: TextDecoder
+  ): {
+    join_ref: string
+    ref: string
+    topic: string
+    event: CHANNEL_EVENTS.reply
+    payload: { status: string; response: { [key: string]: any } }
+  } {
+    const joinRefSize = view.getUint8(1)
+    const refSize = view.getUint8(2)
+    const topicSize = view.getUint8(3)
+    const eventSize = view.getUint8(4)
+    let offset = this.HEADER_LENGTH + this.META_LENGTH
+    const joinRef = decoder.decode(buffer.slice(offset, offset + joinRefSize))
+    offset = offset + joinRefSize
+    const ref = decoder.decode(buffer.slice(offset, offset + refSize))
+    offset = offset + refSize
+    const topic = decoder.decode(buffer.slice(offset, offset + topicSize))
+    offset = offset + topicSize
+    const event = decoder.decode(buffer.slice(offset, offset + eventSize))
+    offset = offset + eventSize
+    const data = JSON.parse(decoder.decode(buffer.slice(offset, buffer.byteLength)))
+    const payload = { status: event, response: data }
+    return {
+      join_ref: joinRef,
+      ref: ref,
+      topic: topic,
+      event: CHANNEL_EVENTS.reply,
+      payload: payload,
+    }
   }
 
   private _decodeBroadcast(
@@ -28,6 +247,7 @@ export default class Serializer {
     view: DataView,
     decoder: TextDecoder
   ): {
+    join_ref: null
     ref: null
     topic: string
     event: string
@@ -42,6 +262,52 @@ export default class Serializer {
     offset = offset + eventSize
     const data = JSON.parse(decoder.decode(buffer.slice(offset, buffer.byteLength)))
 
-    return { ref: null, topic: topic, event: event, payload: data }
+    return { join_ref: null, ref: null, topic: topic, event: event, payload: data }
+  }
+
+  private _decodeUserBroadcast(
+    buffer: ArrayBuffer,
+    view: DataView,
+    decoder: TextDecoder
+  ): {
+    join_ref: null
+    ref: null
+    topic: string
+    event: string
+    payload: { [key: string]: any }
+  } {
+    const topicSize = view.getUint8(1)
+    const userEventSize = view.getUint8(2)
+    const metadataSize = view.getUint8(3)
+    const payloadEncoding = view.getUint8(4)
+
+    let offset = this.HEADER_LENGTH + 4
+    const topic = decoder.decode(buffer.slice(offset, offset + topicSize))
+    offset = offset + topicSize
+    const userEvent = decoder.decode(buffer.slice(offset, offset + userEventSize))
+    offset = offset + userEventSize
+    const metadata = decoder.decode(buffer.slice(offset, offset + metadataSize))
+    offset = offset + metadataSize
+
+    const payload = buffer.slice(offset, buffer.byteLength)
+    const parsedPayload =
+      payloadEncoding === this.JSON_ENCODING ? JSON.parse(decoder.decode(payload)) : payload
+
+    const data: { [key: string]: any } = {
+      type: this.BROADCAST,
+      event: userEvent,
+      payload: parsedPayload,
+    }
+
+    // Metadata is optional and always JSON encoded
+    if (metadataSize > 0) {
+      data['meta'] = JSON.parse(metadata)
+    }
+
+    return { join_ref: null, ref: null, topic: topic, event: this.BROADCAST, payload: data }
+  }
+
+  private _isArrayBuffer(buffer: any): boolean {
+    return buffer instanceof ArrayBuffer || buffer?.constructor?.name === 'ArrayBuffer'
   }
 }

package/src/lib/version.ts

@@ -4,4 +4,4 @@
 // - Debugging and support (identifying which version is running)
 // - Telemetry and logging (version reporting in errors/analytics)
 // - Ensuring build artifacts match the published package version
-export const version = '2.80.1-canary.2'
+export const version = '2.80.1-canary.3'