session-desktop/ts/test/session/sending/MessageQueue_test.ts

import { expect } from 'chai';
import * as sinon from 'sinon';
import { GroupUtils } from '../../../session/utils';
import { Stubs, TestUtils } from '../../../test/test-utils';
import { MessageQueue } from '../../../session/sending/MessageQueue';
import {
  generateChatMessage,
  generateClosedGroupMessage,
  generateFakePubkey,
  generateMemberList,
  generateOpenGroupMessage,
} from '../../test-utils/testUtils';
import { OpenGroupMessage } from '../../../session/messages/outgoing';
import { PubKey, RawMessage } from '../../../session/types';
import { UserUtil } from '../../../util';
import { MessageSender } from '../../../session/sending';
import { toRawMessage } from '../../../session/utils/Messages';
import { SessionProtocol } from '../../../session/protocols';
import { PendingMessageCache } from '../../../session/sending/PendingMessageCache';

// Equivalent to Data.StorageItem
interface StorageItem {
  id: string;
  value: any;
}

describe('MessageQueue', () => {
  // Initialize new stubbed cache
  let data: StorageItem;
  const sandbox = sinon.createSandbox();
  const ourNumber = generateFakePubkey().key;

  // Keep track of Session Requests in each test
  let sessionRequestSent: boolean;

  // Initialize new stubbed cache
  let messageQueueStub: MessageQueue;
  // Message Sender Stubs
  let sendStub: sinon.SinonStub<[RawMessage, (number | undefined)?]>;
  let sendToOpenGroupStub: sinon.SinonStub<[OpenGroupMessage]>;
  // Group Utils Stubs
  let isMediumGroupStub: sinon.SinonStub<[PubKey], boolean>;
  let groupMembersStub: sinon.SinonStub;
  // Session Protocol Stubs
  let hasSessionStub: sinon.SinonStub<[PubKey], Promise<boolean>>;

  beforeEach(async () => {
    // Stub out methods which touch the database
    const storageID = 'pendingMessages';
    data = {
      id: storageID,
      value: '[]',
    };

    // Pending Message Cache Data Stubs
    TestUtils.stubData('getItemById')
      .withArgs('pendingMessages')
      .callsFake(async () => {
        return data;
      });
    TestUtils.stubData('createOrUpdateItem').callsFake((item: StorageItem) => {
      if (item.id === storageID) {
        data = item;
      }
    });

    // Utils Stubs
    sandbox.stub(UserUtil, 'getCurrentDevicePubKey').resolves(ourNumber);
    TestUtils.stubData('getPairedDevicesFor').callsFake(async () => {
      return generateMemberList(2);
    });
    TestUtils.stubWindow('libsignal', {
      SignalProtocolAddress: sandbox.stub(),
      SessionCipher: Stubs.SessionCipherStub,
    } as any);

    // Message Sender Stubs
    sendStub = sandbox.stub(MessageSender, 'send').resolves();
    sendToOpenGroupStub = sandbox
      .stub(MessageSender, 'sendToOpenGroup')
      .resolves(true);

    // Group Utils Stubs
    isMediumGroupStub = sandbox
      .stub(GroupUtils, 'isMediumGroup')
      .resolves(false);
    groupMembersStub = sandbox
      .stub(GroupUtils, 'getGroupMembers' as any)
      .callsFake(async () => generateMemberList(10));

    // Session Protocol Stubs
    hasSessionStub = sandbox.stub(SessionProtocol, 'hasSession').resolves(true);
    sandbox.stub(SessionProtocol, 'sendSessionRequest').resolves();
    sandbox
      .stub(SessionProtocol, 'sendSessionRequestIfNeeded')
      .callsFake(async (pubkey: PubKey) => {
        pubkey;
        sessionRequestSent = true;
      });

    // Pending Mesage Cache Stubs
    const chatMessages = Array.from({ length: 10 }, generateChatMessage);
    const rawMessage = toRawMessage(
      generateFakePubkey(),
      generateChatMessage()
    );

    sandbox.stub(PendingMessageCache.prototype, 'add').resolves(rawMessage);
    sandbox.stub(PendingMessageCache.prototype, 'remove').resolves();
    sandbox
      .stub(PendingMessageCache.prototype, 'getDevices')
      .returns(generateMemberList(10));
    sandbox
      .stub(PendingMessageCache.prototype, 'getForDevice')
      .returns(chatMessages.map(m => toRawMessage(generateFakePubkey(), m)));

    messageQueueStub = new MessageQueue();
  });

  afterEach(() => {
    TestUtils.restoreStubs();
    sandbox.restore();
  });

  it('can send to a single device', async () => {
    const device = generateFakePubkey();
    const message = generateChatMessage();

    const promise = messageQueueStub.send(device, message);
    await expect(promise).to.be.fulfilled;
  });

  it('can send to many devices', async () => {
    const devices = generateMemberList(10);
    const message = generateChatMessage();

    const promise = messageQueueStub.sendMessageToDevices(devices, message);
    await expect(promise).to.be.fulfilled;
  });

  it('can send using multidevice', async () => {
    const device = generateFakePubkey();
    const message = generateChatMessage();

    const promise = messageQueueStub.sendUsingMultiDevice(device, message);
    await expect(promise).to.be.fulfilled;
  });

  it('can send to open group', async () => {
    const message = generateOpenGroupMessage();
    const success = await messageQueueStub.sendToGroup(message);

    expect(success).to.equal(true, 'sending to group failed');
  });

  it('can send to closed group', async () => {
    const message = generateClosedGroupMessage();
    const success = await messageQueueStub.sendToGroup(message);

    expect(success).to.equal(true, 'sending to group failed');
  });

  it('wont send message to empty group', async () => {
    groupMembersStub.callsFake(async () => generateMemberList(0));

    const message = generateClosedGroupMessage();
    const response = await messageQueueStub.sendToGroup(message);

    expect(response).to.equal(
      false,
      'sendToGroup send a message to an empty group'
    );
  });

  it('wont send invalid message type to group', async () => {
    // Regular chat message should return false
    const message = generateChatMessage();
    const response = await messageQueueStub.sendToGroup(message);

    expect(response).to.equal(
      false,
      'sendToGroup considered an invalid message type as valid'
    );
  });

  it('will send sync message if no session', async () => {
    hasSessionStub.resolves(false);

    const device = generateFakePubkey();
    const promise = messageQueueStub.processPending(device);

    expect(promise).to.be.fulfilled;
  });

  it('can send sync message', async () => {
    const devices = generateMemberList(3);
    const message = generateChatMessage();

    const promise = messageQueueStub.sendSyncMessage(message, devices);
    expect(promise).to.be.fulfilled;
  });
});