|
| 1 | +// eslint-disable-next-line @typescript-eslint/no-var-requires |
| 2 | +const { Socket } = require('@rocket.chat/sdk/lib/drivers/ddp'); |
| 3 | + |
| 4 | +const buildSocket = () => { |
| 5 | + const socket = new Socket({ |
| 6 | + logger: { debug: jest.fn(), info: jest.fn(), error: jest.fn(), warn: jest.fn() }, |
| 7 | + timeout: 10000 |
| 8 | + }); |
| 9 | + const send = jest.fn(); |
| 10 | + const close = jest.fn(); |
| 11 | + socket.connection = { |
| 12 | + send, |
| 13 | + close, |
| 14 | + readyState: 1, |
| 15 | + onopen: jest.fn(), |
| 16 | + onmessage: jest.fn(), |
| 17 | + onerror: jest.fn(), |
| 18 | + onclose: jest.fn() |
| 19 | + }; |
| 20 | + return { socket, send, close }; |
| 21 | +}; |
| 22 | + |
| 23 | +describe('Socket.probe', () => { |
| 24 | + afterEach(() => { |
| 25 | + jest.useRealTimers(); |
| 26 | + }); |
| 27 | + |
| 28 | + it('resolves true when pong arrives within deadline', async () => { |
| 29 | + const { socket } = buildSocket(); |
| 30 | + const probePromise = socket.probe(); |
| 31 | + socket.emit('pong'); |
| 32 | + await expect(probePromise).resolves.toBe(true); |
| 33 | + }); |
| 34 | + |
| 35 | + it('resolves false when no pong arrives within 2s deadline', async () => { |
| 36 | + jest.useFakeTimers(); |
| 37 | + const { socket } = buildSocket(); |
| 38 | + const probePromise = socket.probe(); |
| 39 | + await jest.advanceTimersByTimeAsync(2000); |
| 40 | + await expect(probePromise).resolves.toBe(false); |
| 41 | + }); |
| 42 | + |
| 43 | + it('resolves false when raw connection.send throws', async () => { |
| 44 | + const { socket, send } = buildSocket(); |
| 45 | + send.mockImplementation(() => { |
| 46 | + throw new Error('boom'); |
| 47 | + }); |
| 48 | + await expect(socket.probe()).resolves.toBe(false); |
| 49 | + }); |
| 50 | +}); |
| 51 | + |
| 52 | +describe('Socket.forceReopen awaitability', () => { |
| 53 | + it('returned promise resolves only after open() resolves', async () => { |
| 54 | + const { socket } = buildSocket(); |
| 55 | + let resolveOpen: () => void = () => undefined; |
| 56 | + const openPromise = new Promise<void>(res => { |
| 57 | + resolveOpen = res; |
| 58 | + }); |
| 59 | + socket.open = jest.fn(() => openPromise); |
| 60 | + |
| 61 | + let settled = false; |
| 62 | + const result = socket.forceReopen(); |
| 63 | + result.then(() => { |
| 64 | + settled = true; |
| 65 | + }); |
| 66 | + |
| 67 | + await Promise.resolve(); |
| 68 | + await Promise.resolve(); |
| 69 | + expect(settled).toBe(false); |
| 70 | + |
| 71 | + resolveOpen(); |
| 72 | + await result; |
| 73 | + expect(settled).toBe(true); |
| 74 | + }); |
| 75 | + |
| 76 | + it('concurrent invocations share the same in-flight reconnect', async () => { |
| 77 | + const { socket } = buildSocket(); |
| 78 | + let resolveOpen: () => void = () => undefined; |
| 79 | + const openPromise = new Promise<void>(res => { |
| 80 | + resolveOpen = res; |
| 81 | + }); |
| 82 | + const openMock = jest.fn(() => openPromise); |
| 83 | + socket.open = openMock; |
| 84 | + |
| 85 | + const a = socket.forceReopen(); |
| 86 | + const b = socket.forceReopen(); |
| 87 | + |
| 88 | + expect(openMock).toHaveBeenCalledTimes(1); |
| 89 | + |
| 90 | + resolveOpen(); |
| 91 | + await Promise.all([a, b]); |
| 92 | + expect(openMock).toHaveBeenCalledTimes(1); |
| 93 | + }); |
| 94 | + |
| 95 | + it("emits 'close' synchronously before opening so app-level Redux disconnect dispatches", async () => { |
| 96 | + const { socket } = buildSocket(); |
| 97 | + socket.open = jest.fn(() => Promise.resolve()); |
| 98 | + const closeListener = jest.fn(); |
| 99 | + socket.on('close', closeListener); |
| 100 | + const reopenPromise = socket.forceReopen(); |
| 101 | + // Synchronous emit: must have fired by the time forceReopen returns. |
| 102 | + expect(closeListener).toHaveBeenCalledTimes(1); |
| 103 | + const [event] = closeListener.mock.calls[0]; |
| 104 | + expect(event).toEqual({ code: 4000 }); |
| 105 | + await reopenPromise; |
| 106 | + }); |
| 107 | +}); |
| 108 | + |
| 109 | +describe('Socket.checkAndReopen bucket dispatch', () => { |
| 110 | + const buildWithSpies = () => { |
| 111 | + const { socket } = buildSocket(); |
| 112 | + const { ping } = socket.config; |
| 113 | + const forceReopen = jest.fn(); |
| 114 | + const probe = jest.fn(); |
| 115 | + socket.forceReopen = forceReopen; |
| 116 | + socket.probe = probe; |
| 117 | + return { socket, forceReopen, probe, ping }; |
| 118 | + }; |
| 119 | + |
| 120 | + it('stale (elapsed > ping*2) calls forceReopen and skips probe', async () => { |
| 121 | + const { socket, forceReopen, probe, ping } = buildWithSpies(); |
| 122 | + socket.lastPing = Date.now() - ping * 2 - 1000; |
| 123 | + await socket.checkAndReopen(); |
| 124 | + expect(forceReopen).toHaveBeenCalledTimes(1); |
| 125 | + expect(probe).not.toHaveBeenCalled(); |
| 126 | + }); |
| 127 | + |
| 128 | + it('fresh (elapsed < 2000ms) is a no-op', async () => { |
| 129 | + const { socket, forceReopen, probe } = buildWithSpies(); |
| 130 | + socket.lastPing = Date.now() - 500; |
| 131 | + await socket.checkAndReopen(); |
| 132 | + expect(forceReopen).not.toHaveBeenCalled(); |
| 133 | + expect(probe).not.toHaveBeenCalled(); |
| 134 | + }); |
| 135 | + |
| 136 | + it('gray-zone with successful probe does not call forceReopen', async () => { |
| 137 | + const { socket, forceReopen, probe } = buildWithSpies(); |
| 138 | + probe.mockResolvedValue(true); |
| 139 | + socket.lastPing = Date.now() - 5000; |
| 140 | + await socket.checkAndReopen(); |
| 141 | + expect(probe).toHaveBeenCalledTimes(1); |
| 142 | + expect(forceReopen).not.toHaveBeenCalled(); |
| 143 | + }); |
| 144 | + |
| 145 | + it('gray-zone with failed probe calls forceReopen', async () => { |
| 146 | + const { socket, forceReopen, probe } = buildWithSpies(); |
| 147 | + probe.mockResolvedValue(false); |
| 148 | + socket.lastPing = Date.now() - 5000; |
| 149 | + await socket.checkAndReopen(); |
| 150 | + expect(probe).toHaveBeenCalledTimes(1); |
| 151 | + expect(forceReopen).toHaveBeenCalledTimes(1); |
| 152 | + }); |
| 153 | + |
| 154 | + it('stale and probe-fail buckets resolve only after forceReopen resolves', async () => { |
| 155 | + const tryBucket = async (setup: (s: any) => void) => { |
| 156 | + const { socket } = buildSocket(); |
| 157 | + let resolveReopen: () => void = () => undefined; |
| 158 | + const reopenPromise = new Promise<void>(res => { |
| 159 | + resolveReopen = res; |
| 160 | + }); |
| 161 | + socket.forceReopen = jest.fn(() => reopenPromise); |
| 162 | + socket.probe = jest.fn().mockResolvedValue(false); |
| 163 | + setup(socket); |
| 164 | + let settled = false; |
| 165 | + const p = socket.checkAndReopen().then(() => { |
| 166 | + settled = true; |
| 167 | + }); |
| 168 | + await Promise.resolve(); |
| 169 | + await Promise.resolve(); |
| 170 | + expect(settled).toBe(false); |
| 171 | + resolveReopen(); |
| 172 | + await p; |
| 173 | + expect(settled).toBe(true); |
| 174 | + }; |
| 175 | + |
| 176 | + await tryBucket(socket => { |
| 177 | + socket.lastPing = Date.now() - socket.config.ping * 2 - 1000; |
| 178 | + }); |
| 179 | + await tryBucket(socket => { |
| 180 | + socket.lastPing = Date.now() - 5000; |
| 181 | + }); |
| 182 | + }); |
| 183 | +}); |
0 commit comments