feat: allow override presence enabled

Author: filipecabaco

src/RealtimeChannel.ts

@@ -238,8 +238,9 @@ export default class RealtimeChannel {
         this.bindings.postgres_changes?.map((r) => r.filter) ?? []
 
       const presence_enabled =
-        !!this.bindings[REALTIME_LISTEN_TYPES.PRESENCE] &&
-        this.bindings[REALTIME_LISTEN_TYPES.PRESENCE].length > 0
+        (!!this.bindings[REALTIME_LISTEN_TYPES.PRESENCE] &&
+          this.bindings[REALTIME_LISTEN_TYPES.PRESENCE].length > 0) ||
+        this.params.config.presence?.enabled === true
       const accessTokenPayload: { access_token?: string } = {}
       const config = {
         broadcast,

test/RealtimeChannel.lifecycle.test.ts

@@ -137,6 +137,33 @@ describe('Channel Lifecycle Management', () => {
         },
         testChannelDefaults: false,
       },
+      {
+        name: 'sets up joinPush object with presence enabled when config.presence.enabled is true even without bindings',
+        config: {
+          private: true,
+          presence: { key: '', enabled: true },
+        },
+        setup: (channel: RealtimeChannel) => {
+          // No presence bindings added
+          channel.subscribe()
+        },
+        expectedParams: {
+          config: {
+            broadcast: { ack: false, self: false },
+            presence: { key: '', enabled: true },
+            private: true,
+          },
+        },
+        expectedJoinPayload: {
+          config: {
+            broadcast: { ack: false, self: false },
+            presence: { key: '', enabled: true },
+            postgres_changes: [],
+            private: true,
+          },
+        },
+        testChannelDefaults: false,
+      },
     ])(
       '$name',
       ({

test/RealtimeChannel.presence.test.ts

@@ -8,6 +8,7 @@ import {
   TestSetup,
   setupJoinedChannelWithSocket,
 } from './helpers/setup'
+import { REALTIME_LISTEN_TYPES } from '../src/RealtimeChannel'
 
 const defaultTimeout = 1000
 
@@ -167,6 +168,96 @@ describe('Presence helper methods', () => {
   )
 })
 
+describe('Presence configuration override', () => {
+  test('should enable presence when config.presence.enabled is true even without bindings', () => {
+    const channelWithPresenceEnabled = testSetup.socket.channel(
+      'test-presence-override',
+      { config: { presence: { enabled: true } } }
+    )
+    assert.equal(
+      channelWithPresenceEnabled.bindings[REALTIME_LISTEN_TYPES.PRESENCE]
+        ?.length,
+      undefined
+    )
+    channelWithPresenceEnabled.subscribe()
+    const joinPayload = channelWithPresenceEnabled.joinPush.payload
+    assert.equal(joinPayload.config.presence.enabled, true)
+    channelWithPresenceEnabled.unsubscribe()
+  })
+
+  test('should enable presence when both bindings exist and config.presence.enabled is true', () => {
+    const channelWithBoth = testSetup.socket.channel('test-presence-both', {
+      config: { presence: { enabled: true } },
+    })
+    channelWithBoth.on('presence', { event: 'sync' }, () => {})
+    channelWithBoth.subscribe()
+    const joinPayload = channelWithBoth.joinPush.payload
+    assert.equal(joinPayload.config.presence.enabled, true)
+    channelWithBoth.unsubscribe()
+  })
+
+  test('should enable presence when only bindings exist (existing behavior)', () => {
+    const channelWithBindingsOnly = testSetup.socket.channel(
+      'test-presence-bindings-only'
+    )
+    channelWithBindingsOnly.on('presence', { event: 'sync' }, () => {})
+    channelWithBindingsOnly.subscribe()
+    const joinPayload = channelWithBindingsOnly.joinPush.payload
+    assert.equal(joinPayload.config.presence.enabled, true)
+    channelWithBindingsOnly.unsubscribe()
+  })
+
+  test('should not enable presence when neither bindings exist nor config.presence.enabled is true', () => {
+    const channelWithNeither = testSetup.socket.channel('test-presence-neither')
+    assert.equal(
+      channelWithNeither.bindings[REALTIME_LISTEN_TYPES.PRESENCE]?.length,
+      undefined
+    )
+    channelWithNeither.subscribe()
+    const joinPayload = channelWithNeither.joinPush.payload
+    assert.equal(joinPayload.config.presence.enabled, false)
+    channelWithNeither.unsubscribe()
+  })
+
+  test('should allow using track() method when presence is enabled via config override', async () => {
+    const channelWithPresenceEnabled = testSetup.socket.channel(
+      'test-presence-track',
+      { config: { presence: { enabled: true } } }
+    )
+    setupJoinedChannelWithSocket(channelWithPresenceEnabled, testSetup.socket)
+    const sendStub = vi
+      .spyOn(channelWithPresenceEnabled, 'send')
+      .mockResolvedValue('ok')
+    await channelWithPresenceEnabled.track({ id: 123, name: 'Test User' })
+    expect(sendStub).toHaveBeenCalledWith(
+      {
+        type: 'presence',
+        event: 'track',
+        payload: { id: 123, name: 'Test User' },
+      },
+      1000
+    )
+    channelWithPresenceEnabled.unsubscribe()
+  })
+
+  test('should allow using untrack() method when presence is enabled via config override', async () => {
+    const channelWithPresenceEnabled = testSetup.socket.channel(
+      'test-presence-untrack',
+      { config: { presence: { enabled: true } } }
+    )
+    setupJoinedChannelWithSocket(channelWithPresenceEnabled, testSetup.socket)
+    const sendStub = vi
+      .spyOn(channelWithPresenceEnabled, 'send')
+      .mockResolvedValue('ok')
+    await channelWithPresenceEnabled.untrack()
+    expect(sendStub).toHaveBeenCalledWith(
+      { type: 'presence', event: 'untrack' },
+      {}
+    )
+    channelWithPresenceEnabled.unsubscribe()
+  })
+})
+
 describe('RealtimePresence static methods', () => {
   // Helper function to clone objects (from original RealtimePresence tests)
   const clone = (obj: any) => {