feat: Presence enabled flag on join payload (#496)

Changes the join payload to include a flag to enable/disable presence features. The flag is automatically set if we find a callback for any event of type `presence`.

Author: filipecabaco

src/RealtimeChannel.ts

@@ -23,7 +23,7 @@ export type RealtimeChannelOptions = {
     /**
      * key option is used to track presence payload across clients
      */
-    presence?: { key?: string }
+    presence?: { key?: string; enabled?: boolean }
     /**
      * defines if the channel is private or not and if RLS policies will be used to check data
      */
@@ -154,7 +154,7 @@ export default class RealtimeChannel {
     this.params.config = {
       ...{
         broadcast: { ack: false, self: false },
-        presence: { key: '' },
+        presence: { key: '', enabled: false },
         private: false,
       },
       ...params.config,
@@ -222,24 +222,28 @@ export default class RealtimeChannel {
         config: { broadcast, presence, private: isPrivate },
       } = this.params
 
-      this._onError((e: Error) =>
-        callback?.(REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR, e)
-      )
-      this._onClose(() => callback?.(REALTIME_SUBSCRIBE_STATES.CLOSED))
+      const postgres_changes =
+        this.bindings.postgres_changes?.map((r) => r.filter) ?? []
 
+      const presence_enabled = !!this.bindings[REALTIME_LISTEN_TYPES.PRESENCE]
       const accessTokenPayload: { access_token?: string } = {}
       const config = {
         broadcast,
-        presence,
-        postgres_changes:
-          this.bindings.postgres_changes?.map((r) => r.filter) ?? [],
+        presence: { ...presence, enabled: presence_enabled },
+        postgres_changes,
         private: isPrivate,
       }
 
       if (this.socket.accessTokenValue) {
         accessTokenPayload.access_token = this.socket.accessTokenValue
       }
 
+      this._onError((e: Error) =>
+        callback?.(REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR, e)
+      )
+
+      this._onClose(() => callback?.(REALTIME_SUBSCRIBE_STATES.CLOSED))
+
       this.updateJoinPayload({ ...{ config }, ...accessTokenPayload })
 
       this.joinedOnce = true
@@ -414,9 +418,19 @@ export default class RealtimeChannel {
   ): RealtimeChannel
   on(
     type: `${REALTIME_LISTEN_TYPES}`,
-    filter: { event: string;[key: string]: string },
+    filter: { event: string; [key: string]: string },
     callback: (payload: any) => void
   ): RealtimeChannel {
+    if (
+      this.state === CHANNEL_STATES.joined &&
+      type === REALTIME_LISTEN_TYPES.PRESENCE
+    ) {
+      this.socket.log(
+        'channel',
+        `resubscribe to ${this.topic} due to change in presence callbacks on joined channel`
+      )
+      this.unsubscribe().then(() => this.subscribe())
+    }
     return this._on(type, filter, callback)
   }
   /**
@@ -535,10 +549,9 @@ export default class RealtimeChannel {
       if (!this._canPush()) {
         leavePush.trigger('ok', {})
       }
+    }).finally(() => {
+      leavePush?.destroy()
     })
-      .finally(() => {
-        leavePush?.destroy()
-      })
   }
   /**
    * Teardown the channel.
@@ -649,7 +662,7 @@ export default class RealtimeChannel {
                 payload.ids?.includes(bindId) &&
                 (bindEvent === '*' ||
                   bindEvent?.toLocaleLowerCase() ===
-                  payload.data?.type.toLocaleLowerCase())
+                    payload.data?.type.toLocaleLowerCase())
               )
             } else {
               const bindEvent = bind?.filter?.event?.toLocaleLowerCase()
@@ -714,7 +727,6 @@ export default class RealtimeChannel {
   /** @internal */
   _on(type: string, filter: { [key: string]: any }, callback: Function) {
     const typeLower = type.toLocaleLowerCase()
-
     const binding = {
       type: typeLower,
       filter: filter,

src/RealtimePresence.ts

@@ -64,6 +64,7 @@ export default class RealtimePresence {
   state: RealtimePresenceState = {}
   pendingDiffs: RawPresenceDiff[] = []
   joinRef: string | null = null
+  enabled: boolean = false
   caller: {
     onJoin: PresenceOnJoinCallback
     onLeave: PresenceOnLeaveCallback