Skip to content
This repository was archived by the owner on Oct 9, 2025. It is now read-only.

fix: set proper error states on error #468

Merged
merged 1 commit into from
May 12, 2025
Merged

fix: set proper error states on error #468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/RealtimeChannel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,8 @@ export default class RealtimeChannel {
})
} else {
this.unsubscribe()
this.state = CHANNEL_STATES.errored

callback?.(
REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR,
new Error(
Expand All @@ -296,6 +298,7 @@ export default class RealtimeChannel {
}
})
.receive('error', (error: { [key: string]: any }) => {
this.state = CHANNEL_STATES.errored
callback?.(
REALTIME_SUBSCRIBE_STATES.CHANNEL_ERROR,
new Error(
Expand Down
97 changes: 56 additions & 41 deletions test/channel.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import RealtimeChannel from '../src/RealtimeChannel'
import { Response } from '@supabase/node-fetch'
import Worker from 'web-worker'
import { Server, WebSocket } from 'mock-socket'
import { CHANNEL_STATES } from '../src/lib/constants'
import Push from '../src/lib/push'

const defaultRef = '1'
const defaultTimeout = 1000
Expand Down Expand Up @@ -127,8 +129,8 @@ describe('subscribe', () => {

test('sets state to joining', () => {
channel.subscribe()
assert.equal(channel.state, 'joining')
})
assert.equal(channel.state, CHANNEL_STATES.joining)
}) //@ts-ignore - we're aware that we're testing a private method, needs improvements to our testing methodology

test('sets joinedOnce to true', () => {
assert.ok(!channel.joinedOnce)
Expand Down Expand Up @@ -303,19 +305,19 @@ describe('subscribe', () => {

test('unsubscribes to channel with incorrect server postgres_changes resp', () => {
const unsubscribeSpy = sinon.spy(channel, 'unsubscribe')
const cbSpy = sinon.spy()
const func = () => {}
const callbackSpy = sinon.spy()
const dummyCallback = () => {}

channel.bindings.postgres_changes = [
{
type: 'postgres_changes',
filter: { event: '*', schema: '*' },
callback: func,
callback: dummyCallback,
},
{
type: 'postgres_changes',
filter: { event: 'INSERT', schema: 'public', table: 'test' },
callback: func,
callback: dummyCallback,
},
{
type: 'postgres_changes',
Expand All @@ -325,27 +327,28 @@ describe('subscribe', () => {
table: 'test',
filter: 'id=eq.1',
},
callback: func,
callback: dummyCallback,
},
]
channel.subscribe(cbSpy)

const cb = channel.bindings['chan_reply_1'][0].callback
cb({
channel.subscribe(callbackSpy)
const replyCallback = channel.bindings['chan_reply_1'][0].callback
replyCallback({
status: 'ok',
response: { postgres_changes: [{ id: 'abc', event: '*', schema: '*' }] },
})

assert.ok(unsubscribeSpy.calledOnce)
assert.ok(
cbSpy.calledWith(
callbackSpy.calledWith(
'CHANNEL_ERROR',
sinon.match({
message:
'mismatch between server and client bindings for postgres changes',
})
)
)
assert.equal(channel.state, CHANNEL_STATES.errored)
})

test('can set timeout on joinPush', () => {
Expand Down Expand Up @@ -379,7 +382,7 @@ describe('subscribe', () => {

channel.joinPush.trigger('ok', {})

assert.equal(channel.state, 'joined')
assert.equal(channel.state, CHANNEL_STATES.joined)

clock.tick(defaultTimeout / 2)
assert.equal(spy.callCount, 1)
Expand Down Expand Up @@ -411,7 +414,7 @@ describe('joinPush', () => {
}

beforeEach(() => {
channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')
joinPush = channel.joinPush

channel.subscribe()
Expand All @@ -428,9 +431,9 @@ describe('joinPush', () => {
})

test('sets channel state to joined', () => {
assert.notEqual(channel.state, 'joined')
assert.notEqual(channel.state, CHANNEL_STATES.joined)
helpers.receiveOk()
assert.equal(channel.state, 'joined')
assert.equal(channel.state, CHANNEL_STATES.joined)
})

test("triggers receive('ok') callback after ok response", () => {
Expand Down Expand Up @@ -488,7 +491,7 @@ describe('joinPush', () => {

test('sets channel state to joined', () => {
helpers.receiveOk()
assert.equal(channel.state, 'joined')
assert.equal(channel.state, CHANNEL_STATES.joined)
})

test('resets channel rejoinTimer', () => {
Expand All @@ -503,7 +506,7 @@ describe('joinPush', () => {
const spy = sinon.spy(pushEvent, 'send')
channel.pushBuffer.push(pushEvent)
helpers.receiveOk()
assert.equal(channel.state, 'joined')
assert.equal(channel.state, CHANNEL_STATES.joined)
assert.ok(spy.calledOnce)
assert.equal(channel.pushBuffer.length, 0)
})
Expand Down Expand Up @@ -594,6 +597,7 @@ describe('joinPush', () => {
helpers.receiveError()

assert.ok(spyError.calledOnce)
assert.equal(channel.state, CHANNEL_STATES.errored)
})

test("triggers receive('error') callback if error response already received", () => {
Expand Down Expand Up @@ -651,7 +655,8 @@ describe('joinPush', () => {
})

test("does not trigger channel's buffered pushEvents", () => {
const pushEvent = { send: () => {} }
// @ts-ignore - we're only testing the pushBuffer
const pushEvent: Push = { send: () => {} }
const spy = sinon.spy(pushEvent, 'send')

channel.pushBuffer.push(pushEvent)
Expand All @@ -674,7 +679,7 @@ describe('onError', () => {
sinon.stub(socket, 'isConnected').callsFake(() => true)
sinon.stub(socket, 'push').callsFake(() => true)

channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')

joinPush = channel.joinPush

Expand Down Expand Up @@ -718,7 +723,7 @@ describe('onError', () => {
})

test('does not rejoin if channel leaving', () => {
channel.state = 'leaving'
channel.state = CHANNEL_STATES.leaving

const spy = sinon.stub(joinPush, 'send')

Expand All @@ -734,7 +739,7 @@ describe('onError', () => {
})

test('does not rejoin if channel closed', () => {
channel.state = 'closed'
channel.state = CHANNEL_STATES.closed

const spy = sinon.stub(joinPush, 'send')

Expand All @@ -751,6 +756,7 @@ describe('onError', () => {

test('triggers additional callbacks', () => {
const spy = sinon.spy()
//@ts-ignore - we're aware that we're testing a private method, needs improvements to our testing methodology
channel._onError(spy)

assert.equal(spy.callCount, 0)
Expand All @@ -771,7 +777,7 @@ describe('onClose', () => {
sinon.stub(socket, 'isConnected').callsFake(() => true)
sinon.stub(socket, 'push').callsFake(() => true)

channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')

joinPush = channel.joinPush

Expand Down Expand Up @@ -805,6 +811,7 @@ describe('onClose', () => {

test('triggers additional callbacks', () => {
const spy = sinon.spy()
//@ts-ignore - we're aware that we're testing a private method, needs improvements to our testing methodology
channel._onClose(spy)

assert.equal(spy.callCount, 0)
Expand All @@ -828,7 +835,7 @@ describe('onMessage', () => {
beforeEach(() => {
socket = new RealtimeClient('ws://example.com/socket')

channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')
})

afterEach(() => {
Expand All @@ -848,7 +855,7 @@ describe('canPush', () => {
beforeEach(() => {
socket = new RealtimeClient('ws://example.com/socket')

channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')
})

afterEach(() => {
Expand All @@ -858,27 +865,27 @@ describe('canPush', () => {

test('returns true when socket connected and channel joined', () => {
sinon.stub(socket, 'isConnected').returns(true)
channel.state = 'joined'

channel.state = CHANNEL_STATES.joined
//@ts-ignore - we're aware that we're testing a private method, needs improvements to our testing methodology
assert.ok(channel._canPush())
})

test('otherwise returns false', () => {
const isConnectedStub = sinon.stub(socket, 'isConnected')

isConnectedStub.returns(false)
channel.state = 'joined'

channel.state = CHANNEL_STATES.joined
//@ts-ignore - we're aware that we're testing a private method, needs improvements to our testing methodology
assert.ok(!channel._canPush())

isConnectedStub.returns(true)
channel.state = 'joining'

channel.state = CHANNEL_STATES.joining
//@ts-ignore - we're aware that we're testing a private method, needs improvements to our testing methodology
assert.ok(!channel._canPush())

isConnectedStub.returns(false)
channel.state = 'joining'

channel.state = CHANNEL_STATES.joining
//@ts-ignore - we're aware that we're testing a private method, needs improvements to our testing methodology
assert.ok(!channel._canPush())
})
})
Expand All @@ -887,8 +894,7 @@ describe('on', () => {
beforeEach(() => {
socket = new RealtimeClient('ws://example.com/socket')
sinon.stub(socket, '_makeRef').callsFake(() => defaultRef)

channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')
})

afterEach(() => {
Expand All @@ -901,7 +907,7 @@ describe('on', () => {

channel._trigger('event', {}, defaultRef)
assert.ok(!spy.called)

//@ts-ignore - we're aware that we're a non supported event, needs improvements to our testing methodology
channel.on('event', {}, spy)

channel._trigger('event', {}, defaultRef)
Expand All @@ -916,8 +922,10 @@ describe('on', () => {
channel._trigger('event', {}, defaultRef)

assert.ok(!ignoredSpy.called)

//@ts-ignore - we're aware that we're a non supported event, needs improvements to our testing methodology
channel.on('event', {}, spy)

//@ts-ignore - we're aware that we're a non supported event, needs improvements to our testing methodology
channel.on('otherEvent', {}, ignoredSpy)

channel._trigger('event', {}, defaultRef)
Expand All @@ -931,6 +939,7 @@ describe('on', () => {
channel._trigger('realtime', { event: 'INSERT' }, defaultRef)
assert.ok(!spy.called)

//@ts-ignore - we're aware that we're a non supported event, needs improvements to our testing methodology
channel.on('realtime', { event: 'INSERT' }, spy)
channel._trigger('realtime', { event: 'INSERT' }, defaultRef)
assert.ok(spy.called)
Expand All @@ -940,7 +949,7 @@ describe('on', () => {
describe('off', () => {
beforeEach(() => {
sinon.stub(socket, '_makeRef').callsFake(() => defaultRef)
channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')
})

afterEach(() => {
Expand All @@ -952,8 +961,13 @@ describe('off', () => {
const spy2 = sinon.spy()
const spy3 = sinon.spy()

//@ts-ignore - we're aware that we're a non supported event, needs improvements to our testing methodology
channel.on('event', {}, spy1)

//@ts-ignore - we're aware that we're a non supported event, needs improvements to our testing methodology
channel.on('event', {}, spy2)

//@ts-ignore - we're aware that we're a non supported event, needs improvements to our testing methodology
channel.on('other', {}, spy3)

channel._off('event', {})
Expand Down Expand Up @@ -983,7 +997,7 @@ describe('push', () => {
sinon.stub(socket, 'isConnected').callsFake(() => true)
socketSpy = sinon.stub(socket, 'push')

channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')
})

afterEach(() => {
Expand Down Expand Up @@ -1086,7 +1100,7 @@ describe('leave', () => {
sinon.stub(socket, 'isConnected').callsFake(() => true)
socketSpy = sinon.stub(socket, 'push')

channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')
channel.subscribe()
channel.joinPush.trigger('ok', {})
})
Expand Down Expand Up @@ -1160,7 +1174,7 @@ describe('leave', () => {

describe('presence helper methods', () => {
beforeEach(() => {
channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')
})

test('gets presence state', () => {
Expand Down Expand Up @@ -1289,7 +1303,7 @@ describe('trigger', () => {
let spy

beforeEach(() => {
channel = socket.channel('topic', { one: 'two' })
channel = socket.channel('topic')
})

test('triggers when type is insert, update, delete', () => {
Expand Down Expand Up @@ -1405,6 +1419,7 @@ describe('worker', () => {
})

afterAll(() => {
// @ts-ignore - Deliberately removing Worker to clean up test environment
window.Worker = undefined
mockServer.close()
})
Expand Down