keejef
/
session-desktop
mirror of https://github.com/oxen-io/session-desktop
2
0
Fork 0
Code Issues 8 Projects Releases Wiki Activity

fix tests for swarm polling

Browse Source
pull/1839/head
audric 4 years ago
parent e5dab2781e
commit 6a50484597
5 changed files with 130 additions and 882 deletions
Show Stats Download Patch File Download Diff File

36
ts/session/snode_api/swarmPolling.ts
Unescape Escape View File

@ -79,6 +79,18 @@ export class SwarmPolling {
this.groupPolling = [];
}
public TEST_forcePolledTimestamp(pubkey: PubKey, lastPoll: number) {
this.groupPolling = this.groupPolling.map(group => {
if (PubKey.isEqual(pubkey, group.pubkey)) {
return {
...group,
lastPolledTimestamp: lastPoll,
};
}
return group;
});
}
public addGroupId(pubkey: PubKey) {
if (this.groupPolling.findIndex(m => m.pubkey.key === pubkey.key) === -1) {
window?.log?.info('Swarm addGroupId: adding pubkey to polling', pubkey.key);
@ -199,14 +211,15 @@ export class SwarmPolling {
nodesToPoll = _.concat(nodesToPoll, newNodes);
}
const arrayOfResultsWithNull = (
await Promise.allSettled(
nodesToPoll.map(async (n: Snode) => {
// this returns null if an exception occurs
return this.pollNodeForKey(n, pubkey);
})
)
).flatMap(entry => (entry.status === 'fulfilled' ? entry.value : null));
const promisesSettled = await Promise.allSettled(
nodesToPoll.map(async (n: Snode) => {
return this.pollNodeForKey(n, pubkey);
})
);
const arrayOfResultsWithNull = promisesSettled.map(entry =>
entry.status === 'fulfilled' ? entry.value : null
);
// filter out null (exception thrown)
const arrayOfResults = _.compact(arrayOfResultsWithNull);
@ -230,7 +243,11 @@ export class SwarmPolling {
return group;
});
} else if (isGroup) {
window?.log?.info(`Polled for group(${ed25519Str(pubkey.key)}):, but no results.`);
window?.log?.info(
`Polled for group(${ed25519Str(
pubkey.key
)}):, but no snode returned something else than null.`
);
}
perfStart(`handleSeenMessages-${pkStr}`);
@ -283,6 +300,7 @@ export class SwarmPolling {
} else {
window.inboxStore?.dispatch(updateIsOnline(true));
}
window?.log?.info('pollNodeForKey failed with', e.message);
return null;
}
}

113
ts/test/session/unit/onion/OnionPaths_test.ts
Unescape Escape View File

@ -11,6 +11,7 @@ import * as SNodeAPI from '../../../../session/snode_api';
import chaiAsPromised from 'chai-as-promised';
import * as OnionPaths from '../../../../session/onions/onionPath';
import { Snode } from '../../../../data/data';
import { generateFakeSnodes, generateFakeSnodeWithEdKey } from '../../../test-utils/utils';
chai.use(chaiAsPromised as any);
chai.should();
@ -20,112 +21,12 @@ const guard1ed = 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f916153
const guard2ed = 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615349';
const guard3ed = 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f9161534a';
const fakeSnodePool = [
{
ip: '136.243.103.171',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f9161534d',
version: '',
},
{
ip: '136.243.103.172',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615341',
version: '',
},
{
ip: '136.243.103.173',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615342',
version: '',
},
{
ip: '136.243.103.174',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615343',
version: '',
},
{
ip: '136.243.103.175',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615344',
version: '',
},
{
ip: '136.243.103.176',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615345',
version: '',
},
{
ip: '136.243.103.177',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615346',
version: '',
},
{
ip: '136.243.103.178',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615347',
version: '',
},
{
ip: '136.243.103.179',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615348',
version: '',
},
{
ip: '136.243.103.180',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: guard1ed,
version: '',
},
{
ip: '136.243.103.181',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: guard2ed,
version: '',
},
{
ip: '136.243.103.182',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: guard3ed,
version: '',
},
{
ip: '136.243.103.183',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615356',
version: '',
},
{
ip: '136.243.103.183',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615357',
version: '',
},
{
ip: '136.243.103.183',
port: 22116,
pubkey_x25519: '0f78775bf189a6eaca2f9c873524832aae8e87a5bf792fb394df97b21173f50c',
pubkey_ed25519: 'e3ec6fcc79e64c2af6a48a9865d4bf4b739ec7708d75f35acc3d478f91615358',
version: '',
},
const fakeSnodePool: Array<Snode> = [
...generateFakeSnodes(12),
generateFakeSnodeWithEdKey(guard1ed),
generateFakeSnodeWithEdKey(guard2ed),
generateFakeSnodeWithEdKey(guard3ed),
...generateFakeSnodes(3),
];
const fakeGuardNodesEd25519 = [guard1ed, guard2ed, guard3ed];

112
ts/test/session/unit/swarm_polling/SwarmPolling_test.ts
Unescape Escape View File

@ -9,7 +9,7 @@ import { TestUtils } from '../../../test-utils';
import { UserUtils } from '../../../../session/utils';
import { getConversationController } from '../../../../session/conversations';
import * as Data from '../../../../../ts/data/data';
import { getSwarmPollingInstance, SnodePool } from '../../../../session/snode_api';
import { getSwarmPollingInstance, SNodeAPI, SnodePool } from '../../../../session/snode_api';
import { SwarmPolling } from '../../../../session/snode_api/swarmPolling';
import { SWARM_POLLING_TIMEOUT } from '../../../../session/constants';
import {
@ -19,6 +19,7 @@ import {
} from '../../../../models/conversation';
import { PubKey } from '../../../../session/types';
import { noop } from 'lodash';
import { generateFakeSnodes } from '../../../test-utils/utils';
// tslint:disable: chai-vague-errors
chai.use(chaiAsPromised as any);
@ -33,7 +34,8 @@ describe('SwarmPolling', () => {
const ourPubkey = TestUtils.generateFakePubKey();
const ourNumber = ourPubkey.key;
let pollOnceForKeySpy: Sinon.SinonSpy<any>;
// tslint:disable-next-line: variable-name
let TEST_pollOnceForKeySpy: Sinon.SinonSpy<any>;
let swarmPolling: SwarmPolling;
@ -46,9 +48,13 @@ describe('SwarmPolling', () => {
sandbox.stub(Data, 'getItemById').resolves();
sandbox.stub(Data, 'saveConversation').resolves();
sandbox.stub(Data, 'getSwarmNodesForPubkey').resolves();
sandbox.stub(SnodePool, 'getSwarmFor').resolves([]);
sandbox.stub(Data, 'getLastHashBySnode').resolves();
sandbox.stub(SnodePool, 'getSwarmFor').resolves(generateFakeSnodes(5));
sandbox.stub(SNodeAPI, 'retrieveNextMessages').resolves([]);
TestUtils.stubWindow('profileImages', { removeImagesNotInArray: noop, hasImage: noop });
TestUtils.stubWindow('inboxStore', undefined);
TestUtils.stubWindow('getGlobalOnlineStatus', () => true);
TestUtils.stubWindowLog();
const convoController = getConversationController();
@ -57,7 +63,7 @@ describe('SwarmPolling', () => {
swarmPolling = getSwarmPollingInstance();
swarmPolling.TEST_reset();
pollOnceForKeySpy = sandbox.spy(swarmPolling, 'TEST_pollOnceForKey');
TEST_pollOnceForKeySpy = sandbox.spy(swarmPolling, 'TEST_pollOnceForKey');
clock = sinon.useFakeTimers(Date.now());
});
@ -135,8 +141,8 @@ describe('SwarmPolling', () => {
convo.set('active_at', Date.now() - 1000 * 3600 * 25);
await swarmPolling.start(true);
expect(pollOnceForKeySpy.callCount).to.eq(1);
expect(pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.callCount).to.eq(1);
expect(TEST_pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
});
it('does run for our pubkey even if activeAt is recent ', async () => {
@ -147,8 +153,8 @@ describe('SwarmPolling', () => {
convo.set('active_at', Date.now());
await swarmPolling.start(true);
expect(pollOnceForKeySpy.callCount).to.eq(1);
expect(pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.callCount).to.eq(1);
expect(TEST_pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
});
it('does run for group pubkey on start no matter the recent timestamp ', async () => {
@ -162,9 +168,9 @@ describe('SwarmPolling', () => {
await swarmPolling.start(true);
// our pubkey will be polled for, hence the 2
expect(pollOnceForKeySpy.callCount).to.eq(2);
expect(pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.callCount).to.eq(2);
expect(TEST_pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
});
it('does run for group pubkey on start no matter the old timestamp ', async () => {
@ -179,9 +185,9 @@ describe('SwarmPolling', () => {
await swarmPolling.start(true);
// our pubkey will be polled for, hence the 2
expect(pollOnceForKeySpy.callCount).to.eq(2);
expect(pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.callCount).to.eq(2);
expect(TEST_pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
});
it('does run for group pubkey on start but not another time if activeAt is old ', async () => {
@ -200,10 +206,10 @@ describe('SwarmPolling', () => {
// this should only call the stub one more time: for our direct pubkey but not for the group pubkey
await swarmPolling.TEST_pollForAllKeys();
expect(pollOnceForKeySpy.callCount).to.eq(3);
expect(pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.callCount).to.eq(3);
expect(TEST_pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
});
it('does run twice if activeAt less than one hour ', async () => {
@ -220,10 +226,10 @@ describe('SwarmPolling', () => {
// no need to do that as the tick will trigger a call in all cases after 5 secs
// await swarmPolling.TEST_pollForAllKeys();
expect(pollOnceForKeySpy.callCount).to.eq(4);
expect(pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
expect(pollOnceForKeySpy.lastCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.callCount).to.eq(4);
expect(TEST_pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.lastCall.args).to.deep.eq([groupConvoPubkey, true]);
});
it('does run twice if activeAt is inactive and we tick longer than 2 minutes', async () => {
@ -232,23 +238,24 @@ describe('SwarmPolling', () => {
ConversationTypeEnum.GROUP
);
TEST_pollOnceForKeySpy.resetHistory();
convo.set('active_at', Date.now());
const groupConvoPubkey = PubKey.cast(convo.id as string);
swarmPolling.addGroupId(groupConvoPubkey);
// this call the stub two times already
// this call the stub two times already, one for our direct pubkey and one for the group
await swarmPolling.start(true);
// more than week old, we should tick only once for this group
const timeToTick = 3 * 60 * 1000;
swarmPolling.TEST_forcePolledTimestamp(groupConvoPubkey, Date.now() - timeToTick);
// more than week old, so inactive group but we have to tick after more than 2 min
convo.set('active_at', Date.now() - 7 * 25 * 3600 * 1000);
clock.tick(3 * 60 * 1000);
clock.tick(timeToTick);
// we should have two more calls here, so 4 total.
expect(pollOnceForKeySpy.callCount).to.eq(4);
expect(pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
expect(pollOnceForKeySpy.getCalls()[3].args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.callCount).to.eq(4);
expect(TEST_pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.getCalls()[3].args).to.deep.eq([groupConvoPubkey, true]);
});
it('does run once only if group is inactive and we tick less than 2 minutes ', async () => {
@ -256,6 +263,7 @@ describe('SwarmPolling', () => {
TestUtils.generateFakePubKeyStr(),
ConversationTypeEnum.GROUP
);
TEST_pollOnceForKeySpy.resetHistory();
convo.set('active_at', Date.now());
const groupConvoPubkey = PubKey.cast(convo.id as string);
@ -268,9 +276,9 @@ describe('SwarmPolling', () => {
clock.tick(1 * 60 * 1000);
// we should have only one more call here, the one for our direct pubkey fetch
expect(pollOnceForKeySpy.callCount).to.eq(3);
expect(pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]); // this one comes from the swarmPolling.start
expect(pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.callCount).to.eq(3);
expect(TEST_pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]); // this one comes from the swarmPolling.start
expect(TEST_pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
});
describe('multiple runs', () => {
@ -290,39 +298,45 @@ describe('SwarmPolling', () => {
});
it('does run twice if activeAt is less than 2 days', async () => {
pollOnceForKeySpy.resetHistory();
TEST_pollOnceForKeySpy.resetHistory();
// less than 2 days old, this is an active group
convo.set('active_at', Date.now() - 2 * 24 * 3600 * 1000 - 3600 * 1000);
const timeToTick = 6 * 1000;
swarmPolling.TEST_forcePolledTimestamp(convo.id, timeToTick);
// we tick more than 5 sec
clock.tick(6 * 1000);
clock.tick(timeToTick);
await swarmPolling.TEST_pollForAllKeys();
// we have 4 calls total. 2 for our direct promises run each 5 seconds, and 2 for the group pubkey active (so run every 5 sec too)
expect(pollOnceForKeySpy.callCount).to.eq(4);
expect(TEST_pollOnceForKeySpy.callCount).to.eq(4);
// first two calls are our pubkey
expect(pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
expect(pollOnceForKeySpy.getCalls()[3].args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.getCalls()[3].args).to.deep.eq([groupConvoPubkey, true]);
});
it('does run twice if activeAt is more than 2 days old and we tick more than one minute ', async () => {
pollOnceForKeySpy.resetHistory();
TEST_pollOnceForKeySpy.resetHistory();
convo.set('active_at', Date.now() - 2 * 25 * 3600 * 1000); // medium active
clock.tick(65 * 1000); // should tick twice more (one more our direct pubkey and one for the group)
const timeToTick = 65 * 1000;
swarmPolling.TEST_forcePolledTimestamp(convo.id, timeToTick);
clock.tick(timeToTick); // should tick twice more (one more our direct pubkey and one for the group)
await swarmPolling.TEST_pollForAllKeys();
expect(pollOnceForKeySpy.callCount).to.eq(4);
expect(TEST_pollOnceForKeySpy.callCount).to.eq(4);
// first two calls are our pubkey
expect(pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.firstCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.secondCall.args).to.deep.eq([groupConvoPubkey, true]);
expect(pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
expect(pollOnceForKeySpy.getCalls()[3].args).to.deep.eq([groupConvoPubkey, true]);
expect(TEST_pollOnceForKeySpy.thirdCall.args).to.deep.eq([ourPubkey, false]);
expect(TEST_pollOnceForKeySpy.getCalls()[3].args).to.deep.eq([groupConvoPubkey, true]);
});
});
});

25
ts/test/test-utils/utils/pubkey.ts
Unescape Escape View File

@ -1,4 +1,6 @@
import * as crypto from 'crypto';
import _ from 'lodash';
import { Snode } from '../../../data/data';
import { ECKeyPair } from '../../../receiver/keypairs';
import { PubKey } from '../../../session/types';
@ -32,3 +34,26 @@ export function generateFakePubKeys(amount: number): Array<PubKey> {
// tslint:disable-next-line: no-unnecessary-callback-wrapper
return new Array(numPubKeys).fill(0).map(() => generateFakePubKey());
}
export function generateFakeSnode(): Snode {
return {
ip: '136.243.103.171',
port: 22116,
pubkey_x25519: generateFakePubKeyStr(),
pubkey_ed25519: generateFakePubKeyStr(),
};
}
export function generateFakeSnodeWithEdKey(ed25519Pubkey: string): Snode {
return {
ip: '136.243.103.171',
port: 22116,
pubkey_x25519: generateFakePubKeyStr(),
pubkey_ed25519: ed25519Pubkey,
};
}
export function generateFakeSnodes(amount: number): Array<Snode> {
const ar: Array<Snode> = _.times(amount, generateFakeSnode);
return ar;
}

726
yarn.lock
View File

File diff suppressed because it is too large Load Diff
Write Preview
Loading…
Cancel
Save