upstream-rocketchat/packages/ddp-client/__tests__/DDPDispatcher.spec.ts

import { DDPDispatcher } from '../src/DDPDispatcher';
import { MinimalDDPClient } from '../src/MinimalDDPClient';

const ddp = new MinimalDDPClient();

it('should create a block properly', () => {
	const ddpDispatcher = new DDPDispatcher();

	const test = ddp.call('test');

	ddpDispatcher.wait(test);
	expect(ddpDispatcher.queue).toEqual([
		{
			wait: true,
			items: [test],
		},
	]);
});

it('should push an item to the block properly', () => {
	const ddpDispatcher = new DDPDispatcher();

	const test1 = ddp.call('test1');
	const test2 = ddp.call('test2');
	ddpDispatcher.wait(test1);
	ddpDispatcher.dispatch(test2);
	expect(ddpDispatcher.queue).toEqual([
		{
			wait: true,
			items: [test1],
		},
		{
			wait: false,
			items: [test2],
		},
	]);
});

it('should not keep in the queue if the method doesnt wait', () => {
	const ddpDispatcher = new DDPDispatcher();

	const blockToRemove = ddp.call('test1');
	const test2 = ddp.call('test2');

	ddpDispatcher.dispatch(blockToRemove, { wait: true });
	ddpDispatcher.dispatch(test2, { wait: false });

	expect(ddpDispatcher.queue).toEqual([
		{
			wait: true,
			items: [blockToRemove],
		},
		{
			wait: false,
			items: [test2],
		},
	]);

	ddpDispatcher.removeItem(blockToRemove);

	expect(ddpDispatcher.queue).toEqual([]);
});

it('should send outstanding blocks if there is no block waiting and item is added', () => {
	const fn = jest.fn();

	const ddpDispatcher = new DDPDispatcher();
	ddpDispatcher.on('send', fn);

	ddpDispatcher.dispatch(ddp.call('test1'));

	expect(fn).toHaveBeenCalledTimes(1);
});

it('emits non-method payloads immediately, even when a wait block is at the head', () => {
	// Regression: a connect frame dispatched while a wait `login` method is
	// queued must still reach the server. Otherwise the DDP handshake never
	// completes and the socket wedges open but unconnected.
	const fn = jest.fn();
	const ddpDispatcher = new DDPDispatcher();
	ddpDispatcher.on('send', fn);

	const login = ddp.call('login');
	ddpDispatcher.dispatch(login, { wait: true });
	expect(fn).toHaveBeenCalledTimes(1);
	expect(fn).toHaveBeenNthCalledWith(1, login);

	const connectPayload = { msg: 'connect' as const, version: '1', support: ['1'] };
	ddpDispatcher.dispatch(connectPayload);
	expect(fn).toHaveBeenCalledTimes(2);
	expect(fn).toHaveBeenNthCalledWith(2, connectPayload);

	const subPayload = { msg: 'sub' as const, id: 'a', name: 'foo', params: [] };
	ddpDispatcher.dispatch(subPayload);
	expect(fn).toHaveBeenCalledTimes(3);
	expect(fn).toHaveBeenNthCalledWith(3, subPayload);

	// Wait block remains pending — only the wait method is queued, the
	// non-method frames bypassed it.
	expect(ddpDispatcher.queue).toEqual([{ wait: true, items: [login] }]);
});

it('should send the next blocks if the outstanding block was completed', () => {
	const fn = jest.fn();

	const ddpDispatcher = new DDPDispatcher();
	ddpDispatcher.on('send', fn);

	const block1 = ddp.call('block1');

	const block2 = ddp.call('block2');

	const block3 = ddp.call('test2');

	ddpDispatcher.dispatch(block1, { wait: true });
	ddpDispatcher.dispatch(block2, { wait: true });

	ddpDispatcher.dispatch(block3);

	expect(fn).toHaveBeenCalledTimes(1);

	ddpDispatcher.removeItem(block1);

	expect(fn).toHaveBeenCalledTimes(2);

	expect(ddpDispatcher.queue.length).toBe(2);

	expect(ddpDispatcher.queue).toEqual([
		{
			wait: true,
			items: [block2],
		},
		{
			wait: false,
			items: [block3],
		},
	]);

	ddpDispatcher.removeItem(block2);

	expect(ddpDispatcher.queue.length).toBe(0);

	expect(ddpDispatcher.queue).toEqual([]);

	expect(fn).toHaveBeenCalledTimes(3);
	expect(fn).toHaveBeenNthCalledWith(1, block1);
	expect(fn).toHaveBeenNthCalledWith(2, block2);
	expect(fn).toHaveBeenNthCalledWith(3, block3);
});