PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

port existing tests

Browse source
This commit is contained in:
Bruno Windels 2019-02-21 17:06:06 +01:00
parent 29be28919d
commit 5ef673e80e
1 changed files with 307 additions and 396 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

703
test/matrix-to-test.js
View file

@ -14,14 +14,51 @@ limitations under the License.
import expect from 'expect'; import expect from 'expect';
import peg from '../src/MatrixClientPeg'; import peg from '../src/MatrixClientPeg';
import { import {
makeEventPermalink,
makeGroupPermalink, makeGroupPermalink,
makeRoomPermalink, makeRoomPermalink,
makeUserPermalink, makeUserPermalink,
pickServerCandidates, RoomPermaLinkCreator,
} from "../src/matrix-to"; } from "../src/matrix-to";
import * as testUtils from "./test-utils"; import * as testUtils from "./test-utils";
function mockRoom(roomId, members, serverACL) {
members.forEach(m => m.membership = "join");
const powerLevelsUsers = members.reduce((pl, member) => {
if (Number.isFinite(member.powerLevel)) {
pl[member.userId] = member.powerLevel;
}
return pl;
}, {});
return {
roomId,
getJoinedMembers: () => members,
getMember: (userId) => members.find(m => m.userId === userId),
currentState: {
getStateEvents: (type, key) => {
if (key) {
return null;
}
let content;
switch (type) {
case "m.room.server_acl":
content = serverACL;
break;
case "m.room.power_levels":
content = {users: powerLevelsUsers, users_default: 0};
break;
}
if (content) {
return {
getContent: () => content,
};
} else {
return null;
}
},
},
};
}
describe('matrix-to', function() { describe('matrix-to', function() {
let sandbox; let sandbox;
@ -36,444 +73,320 @@ describe('matrix-to', function() {
sandbox.restore(); sandbox.restore();
}); });
it('should pick no candidate servers when the room is not found', function() {
peg.get().getRoom = () => null;
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(0);
});
it('should pick no candidate servers when the room has no members', function() { it('should pick no candidate servers when the room has no members', function() {
peg.get().getRoom = () => { const room = mockRoom(null, []);
return { const creator = new RoomPermaLinkCreator(room);
getJoinedMembers: () => [], creator.load();
}; expect(creator._serverCandidates).toBeTruthy();
}; expect(creator._serverCandidates.length).toBe(0);
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(0);
}); });
it('should pick a candidate server for the highest power level user in the room', function() { it('should pick a candidate server for the highest power level user in the room', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:pl_50",
{ powerLevel: 50,
userId: "@alice:pl_50", },
powerLevel: 50, {
}, userId: "@alice:pl_75",
{ powerLevel: 75,
userId: "@alice:pl_75", },
powerLevel: 75, {
}, userId: "@alice:pl_95",
{ powerLevel: 95,
userId: "@alice:pl_95", },
powerLevel: 95, ]);
}, const creator = new RoomPermaLinkCreator(room);
], creator.load();
}; expect(creator._serverCandidates).toBeTruthy();
}; expect(creator._serverCandidates.length).toBe(3);
const pickedServers = pickServerCandidates("!somewhere:example.org"); expect(creator._serverCandidates[0]).toBe("pl_95");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(3);
expect(pickedServers[0]).toBe("pl_95");
// we don't check the 2nd and 3rd servers because that is done by the next test // we don't check the 2nd and 3rd servers because that is done by the next test
}); });
it('should pick candidate servers based on user population', function() { it('should pick candidate servers based on user population', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:first",
{ powerLevel: 0,
userId: "@alice:first", },
powerLevel: 0, {
}, userId: "@bob:first",
{ powerLevel: 0,
userId: "@bob:first", },
powerLevel: 0, {
}, userId: "@charlie:first",
{ powerLevel: 0,
userId: "@charlie:first", },
powerLevel: 0, {
}, userId: "@alice:second",
{ powerLevel: 0,
userId: "@alice:second", },
powerLevel: 0, {
}, userId: "@bob:second",
{ powerLevel: 0,
userId: "@bob:second", },
powerLevel: 0, {
}, userId: "@charlie:third",
{ powerLevel: 0,
userId: "@charlie:third", },
powerLevel: 0, ]);
}, const creator = new RoomPermaLinkCreator(room);
], creator.load();
}; expect(creator._serverCandidates).toBeTruthy();
}; expect(creator._serverCandidates.length).toBe(3);
const pickedServers = pickServerCandidates("!somewhere:example.org"); expect(creator._serverCandidates[0]).toBe("first");
expect(pickedServers).toBeTruthy(); expect(creator._serverCandidates[1]).toBe("second");
expect(pickedServers.length).toBe(3); expect(creator._serverCandidates[2]).toBe("third");
expect(pickedServers[0]).toBe("first");
expect(pickedServers[1]).toBe("second");
expect(pickedServers[2]).toBe("third");
}); });
it('should pick prefer candidate servers with higher power levels', function() { it('should pick prefer candidate servers with higher power levels', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:first",
{ powerLevel: 100,
userId: "@alice:first", },
powerLevel: 100, {
}, userId: "@alice:second",
{ powerLevel: 0,
userId: "@alice:second", },
powerLevel: 0, {
}, userId: "@bob:second",
{ powerLevel: 0,
userId: "@bob:second", },
powerLevel: 0, {
}, userId: "@charlie:third",
{ powerLevel: 0,
userId: "@charlie:third", },
powerLevel: 0, ]);
}, const creator = new RoomPermaLinkCreator(room);
], creator.load();
}; expect(creator._serverCandidates.length).toBe(3);
}; expect(creator._serverCandidates[0]).toBe("first");
const pickedServers = pickServerCandidates("!somewhere:example.org"); expect(creator._serverCandidates[1]).toBe("second");
expect(pickedServers).toBeTruthy(); expect(creator._serverCandidates[2]).toBe("third");
expect(pickedServers.length).toBe(3);
expect(pickedServers[0]).toBe("first");
expect(pickedServers[1]).toBe("second");
expect(pickedServers[2]).toBe("third");
}); });
it('should pick a maximum of 3 candidate servers', function() { it('should pick a maximum of 3 candidate servers', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:alpha",
{ powerLevel: 100,
userId: "@alice:alpha", },
powerLevel: 100, {
}, userId: "@alice:bravo",
{ powerLevel: 0,
userId: "@alice:bravo", },
powerLevel: 0, {
}, userId: "@alice:charlie",
{ powerLevel: 0,
userId: "@alice:charlie", },
powerLevel: 0, {
}, userId: "@alice:delta",
{ powerLevel: 0,
userId: "@alice:delta", },
powerLevel: 0, {
}, userId: "@alice:echo",
{ powerLevel: 0,
userId: "@alice:echo", },
powerLevel: 0, ]);
}, const creator = new RoomPermaLinkCreator(room);
], creator.load();
}; expect(creator._serverCandidates).toBeTruthy();
}; expect(creator._serverCandidates.length).toBe(3);
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(3);
}); });
it('should not consider IPv4 hosts', function() { it('should not consider IPv4 hosts', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:127.0.0.1",
{ powerLevel: 100,
userId: "@alice:127.0.0.1", },
powerLevel: 100, ]);
}, const creator = new RoomPermaLinkCreator(room);
], creator.load();
}; expect(creator._serverCandidates).toBeTruthy();
}; expect(creator._serverCandidates.length).toBe(0);
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(0);
}); });
it('should not consider IPv6 hosts', function() { it('should not consider IPv6 hosts', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:[::1]",
{ powerLevel: 100,
userId: "@alice:[::1]", },
powerLevel: 100, ]);
}, const creator = new RoomPermaLinkCreator(room);
], creator.load();
}; expect(creator._serverCandidates).toBeTruthy();
}; expect(creator._serverCandidates.length).toBe(0);
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(0);
}); });
it('should not consider IPv4 hostnames with ports', function() { it('should not consider IPv4 hostnames with ports', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:127.0.0.1:8448",
{ powerLevel: 100,
userId: "@alice:127.0.0.1:8448", },
powerLevel: 100, ]);
}, const creator = new RoomPermaLinkCreator(room);
], creator.load();
}; expect(creator._serverCandidates).toBeTruthy();
}; expect(creator._serverCandidates.length).toBe(0);
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(0);
}); });
it('should not consider IPv6 hostnames with ports', function() { it('should not consider IPv6 hostnames with ports', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:[::1]:8448",
{ powerLevel: 100,
userId: "@alice:[::1]:8448", },
powerLevel: 100, ]);
}, const creator = new RoomPermaLinkCreator(room);
], creator.load();
}; expect(creator._serverCandidates).toBeTruthy();
}; expect(creator._serverCandidates.length).toBe(0);
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(0);
}); });
it('should work with hostnames with ports', function() { it('should work with hostnames with ports', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:example.org:8448",
{ powerLevel: 100,
userId: "@alice:example.org:8448", },
powerLevel: 100, ]);
},
], const creator = new RoomPermaLinkCreator(room);
}; creator.load();
}; expect(creator._serverCandidates).toBeTruthy();
const pickedServers = pickServerCandidates("!somewhere:example.org"); expect(creator._serverCandidates.length).toBe(1);
expect(pickedServers).toBeTruthy(); expect(creator._serverCandidates[0]).toBe("example.org:8448");
expect(pickedServers.length).toBe(1);
expect(pickedServers[0]).toBe("example.org:8448");
}); });
it('should not consider servers explicitly denied by ACLs', function() { it('should not consider servers explicitly denied by ACLs', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:evilcorp.com",
{ powerLevel: 100,
userId: "@alice:evilcorp.com", },
powerLevel: 100, {
}, userId: "@bob:chat.evilcorp.com",
{ powerLevel: 0,
userId: "@bob:chat.evilcorp.com", },
powerLevel: 0, ], {
}, deny: ["evilcorp.com", "*.evilcorp.com"],
], allow: ["*"],
currentState: { });
getStateEvents: (type, key) => { const creator = new RoomPermaLinkCreator(room);
if (type !== "m.room.server_acl" || key !== "") return null; creator.load();
return { expect(creator._serverCandidates).toBeTruthy();
getContent: () => { expect(creator._serverCandidates.length).toBe(0);
return {
deny: ["evilcorp.com", "*.evilcorp.com"],
allow: ["*"],
};
},
};
},
},
};
};
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(0);
}); });
it('should not consider servers not allowed by ACLs', function() { it('should not consider servers not allowed by ACLs', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:evilcorp.com",
{ powerLevel: 100,
userId: "@alice:evilcorp.com", },
powerLevel: 100, {
}, userId: "@bob:chat.evilcorp.com",
{ powerLevel: 0,
userId: "@bob:chat.evilcorp.com", },
powerLevel: 0, ], {
}, deny: [],
], allow: [], // implies "ban everyone"
currentState: { });
getStateEvents: (type, key) => { const creator = new RoomPermaLinkCreator(room);
if (type !== "m.room.server_acl" || key !== "") return null; creator.load();
return { expect(creator._serverCandidates).toBeTruthy();
getContent: () => { expect(creator._serverCandidates.length).toBe(0);
return {
deny: [],
allow: [], // implies "ban everyone"
};
},
};
},
},
};
};
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(0);
}); });
it('should consider servers not explicitly banned by ACLs', function() { it('should consider servers not explicitly banned by ACLs', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:evilcorp.com",
{ powerLevel: 100,
userId: "@alice:evilcorp.com", },
powerLevel: 100, {
}, userId: "@bob:chat.evilcorp.com",
{ powerLevel: 0,
userId: "@bob:chat.evilcorp.com", },
powerLevel: 0, ], {
}, deny: ["*.evilcorp.com"], // evilcorp.com is still good though
], allow: ["*"],
currentState: { });
getStateEvents: (type, key) => { const creator = new RoomPermaLinkCreator(room);
if (type !== "m.room.server_acl" || key !== "") return null; creator.load();
return { expect(creator._serverCandidates).toBeTruthy();
getContent: () => { expect(creator._serverCandidates.length).toBe(1);
return { expect(creator._serverCandidates[0]).toEqual("evilcorp.com");
deny: ["*.evilcorp.com"], // evilcorp.com is still good though
allow: ["*"],
};
},
};
},
},
};
};
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(1);
expect(pickedServers[0]).toEqual("evilcorp.com");
}); });
it('should consider servers not disallowed by ACLs', function() { it('should consider servers not disallowed by ACLs', function() {
peg.get().getRoom = () => { const room = mockRoom(null, [
return { {
getJoinedMembers: () => [ userId: "@alice:evilcorp.com",
{ powerLevel: 100,
userId: "@alice:evilcorp.com", },
powerLevel: 100, {
}, userId: "@bob:chat.evilcorp.com",
{ powerLevel: 0,
userId: "@bob:chat.evilcorp.com", },
powerLevel: 0, ], {
}, deny: [],
], allow: ["evilcorp.com"], // implies "ban everyone else"
currentState: { });
getStateEvents: (type, key) => { const creator = new RoomPermaLinkCreator(room);
if (type !== "m.room.server_acl" || key !== "") return null; creator.load();
return { expect(creator._serverCandidates).toBeTruthy();
getContent: () => { expect(creator._serverCandidates.length).toBe(1);
return { expect(creator._serverCandidates[0]).toEqual("evilcorp.com");
deny: [],
allow: ["evilcorp.com"], // implies "ban everyone else"
};
},
};
},
},
};
};
const pickedServers = pickServerCandidates("!somewhere:example.org");
expect(pickedServers).toBeTruthy();
expect(pickedServers.length).toBe(1);
expect(pickedServers[0]).toEqual("evilcorp.com");
}); });
it('should generate an event permalink for room IDs with no candidate servers', function() { it('should generate an event permalink for room IDs with no candidate servers', function() {
peg.get().getRoom = () => null; const room = mockRoom("!somewhere:example.org", []);
const result = makeEventPermalink("!somewhere:example.org", "$something:example.com"); const creator = new RoomPermaLinkCreator(room);
creator.load();
const result = creator.forEvent("$something:example.com");
expect(result).toBe("https://matrix.to/#/!somewhere:example.org/$something:example.com"); expect(result).toBe("https://matrix.to/#/!somewhere:example.org/$something:example.com");
}); });
it('should generate an event permalink for room IDs with some candidate servers', function() { it('should generate an event permalink for room IDs with some candidate servers', function() {
peg.get().getRoom = () => { const room = mockRoom("!somewhere:example.org", [
return { {
getJoinedMembers: () => [ userId: "@alice:first",
{ powerLevel: 100,
userId: "@alice:first", },
powerLevel: 100, {
}, userId: "@bob:second",
{ powerLevel: 0,
userId: "@bob:second", },
powerLevel: 0, ]);
}, const creator = new RoomPermaLinkCreator(room);
], creator.load();
}; const result = creator.forEvent("$something:example.com");
};
const result = makeEventPermalink("!somewhere:example.org", "$something:example.com");
expect(result).toBe("https://matrix.to/#/!somewhere:example.org/$something:example.com?via=first&via=second"); expect(result).toBe("https://matrix.to/#/!somewhere:example.org/$something:example.com?via=first&via=second");
}); });
it('should generate a room permalink for room IDs with no candidate servers', function() {
peg.get().getRoom = () => null;
const result = makeRoomPermalink("!somewhere:example.org");
expect(result).toBe("https://matrix.to/#/!somewhere:example.org");
});
it('should generate a room permalink for room IDs with some candidate servers', function() { it('should generate a room permalink for room IDs with some candidate servers', function() {
peg.get().getRoom = () => { peg.get().getRoom = (roomId) => {
return { return mockRoom(roomId, [
getJoinedMembers: () => [ {
{ userId: "@alice:first",
userId: "@alice:first", powerLevel: 100,
powerLevel: 100, },
}, {
{ userId: "@bob:second",
userId: "@bob:second", powerLevel: 0,
powerLevel: 0, },
}, ]);
],
};
}; };
const result = makeRoomPermalink("!somewhere:example.org"); const result = makeRoomPermalink("!somewhere:example.org");
expect(result).toBe("https://matrix.to/#/!somewhere:example.org?via=first&via=second"); expect(result).toBe("https://matrix.to/#/!somewhere:example.org?via=first&via=second");
}); });
// Technically disallowed but we'll test it anyways
it('should generate an event permalink for room aliases with no candidate servers', function() {
peg.get().getRoom = () => null;
const result = makeEventPermalink("#somewhere:example.org", "$something:example.com");
expect(result).toBe("https://matrix.to/#/#somewhere:example.org/$something:example.com");
});
// Technically disallowed but we'll test it anyways
it('should generate an event permalink for room aliases without candidate servers', function() {
peg.get().getRoom = () => {
return {
getJoinedMembers: () => [
{
userId: "@alice:first",
powerLevel: 100,
},
{
userId: "@bob:second",
powerLevel: 0,
},
],
};
};
const result = makeEventPermalink("#somewhere:example.org", "$something:example.com");
expect(result).toBe("https://matrix.to/#/#somewhere:example.org/$something:example.com");
});
it('should generate a room permalink for room aliases with no candidate servers', function() { it('should generate a room permalink for room aliases with no candidate servers', function() {
peg.get().getRoom = () => null; peg.get().getRoom = () => null;
const result = makeRoomPermalink("#somewhere:example.org"); const result = makeRoomPermalink("#somewhere:example.org");
@ -481,19 +394,17 @@ describe('matrix-to', function() {
}); });
it('should generate a room permalink for room aliases without candidate servers', function() { it('should generate a room permalink for room aliases without candidate servers', function() {
peg.get().getRoom = () => { peg.get().getRoom = (roomId) => {
return { return mockRoom(roomId, [
getJoinedMembers: () => [ {
{ userId: "@alice:first",
userId: "@alice:first", powerLevel: 100,
powerLevel: 100, },
}, {
{ userId: "@bob:second",
userId: "@bob:second", powerLevel: 0,
powerLevel: 0, },
}, ]);
],
};
}; };
const result = makeRoomPermalink("#somewhere:example.org"); const result = makeRoomPermalink("#somewhere:example.org");
expect(result).toBe("https://matrix.to/#/#somewhere:example.org"); expect(result).toBe("https://matrix.to/#/#somewhere:example.org");