"use strict"; var sdk = require("../.."); var Room = sdk.Room; var RoomState = sdk.RoomState; var MatrixEvent = sdk.MatrixEvent; var utils = require("../test-utils"); describe("Room", function() { var roomId = "!foo:bar"; var userA = "@alice:bar"; var userB = "@bertha:bar"; var userC = "@clarissa:bar"; var userD = "@dorothy:bar"; var room; beforeEach(function() { utils.beforeEach(this); room = new Room(roomId); // mock RoomStates room.oldState = utils.mock(sdk.RoomState, "oldState"); room.currentState = utils.mock(sdk.RoomState, "currentState"); }); describe("getAvatarUrl", function() { var hsUrl = "https://my.home.server"; it("should return the URL from m.room.avatar preferentially", function() { room.currentState.getStateEvents.andCallFake(function(type, key) { if (type === "m.room.avatar" && key === "") { return utils.mkEvent({ event: true, type: "m.room.avatar", skey: "", room: roomId, user: userA, content: { url: "mxc://flibble/wibble" } }); } }); var url = room.getAvatarUrl(hsUrl); // we don't care about how the mxc->http conversion is done, other // than it contains the mxc body. expect(url.indexOf("flibble/wibble")).not.toEqual(-1); }); it("should return an identicon HTTP URL if allowDefault was set and there " + "was no m.room.avatar event", function() { var url = room.getAvatarUrl(hsUrl, 64, 64, "crop", true); expect(url.indexOf("http")).toEqual(0); // don't care about form }); it("should return nothing if there is no m.room.avatar and allowDefault=false", function() { var url = room.getAvatarUrl(hsUrl, 64, 64, "crop", false); expect(url).toEqual(null); }); }); describe("getMember", function() { beforeEach(function() { // clobber members property with test data room.currentState.members = { "@alice:bar": { userId: userA, roomId: roomId } }; }); it("should return null if the member isn't in current state", function() { expect(room.getMember("@bar:foo")).toEqual(null); }); it("should return the member from current state", function() { expect(room.getMember(userA)).not.toEqual(null); }); }); describe("addEvents", function() { var events = [ utils.mkMessage({ room: roomId, user: userA, msg: "changing room name", event: true }), utils.mkEvent({ type: "m.room.name", room: roomId, user: userA, event: true, content: { name: "New Room Name" } }) ]; it("should call RoomState.setTypingEvent on m.typing events", function() { room.currentState = utils.mock(RoomState); var typing = utils.mkEvent({ room: roomId, type: "m.typing", event: true, content: { user_ids: [userA] } }); room.addEvents([typing]); expect(room.currentState.setTypingEvent).toHaveBeenCalledWith(typing); }); it("should throw if duplicateStrategy isn't 'replace' or 'ignore'", function() { expect(function() { room.addEvents(events, "foo"); }).toThrow(); }); it("should replace a timeline event if dupe strategy is 'replace'", function() { // make a duplicate var dupe = utils.mkMessage({ room: roomId, user: userA, msg: "dupe", event: true }); dupe.event.event_id = events[0].getId(); room.addEvents(events); expect(room.timeline[0]).toEqual(events[0]); room.addEvents([dupe], "replace"); expect(room.timeline[0]).toEqual(dupe); }); it("should ignore a given dupe event if dupe strategy is 'ignore'", function() { // make a duplicate var dupe = utils.mkMessage({ room: roomId, user: userA, msg: "dupe", event: true }); dupe.event.event_id = events[0].getId(); room.addEvents(events); expect(room.timeline[0]).toEqual(events[0]); room.addEvents([dupe], "ignore"); expect(room.timeline[0]).toEqual(events[0]); }); }); describe("addEventsToTimeline", function() { var events = [ utils.mkMessage({ room: roomId, user: userA, msg: "changing room name", event: true }), utils.mkEvent({ type: "m.room.name", room: roomId, user: userA, event: true, content: { name: "New Room Name" } }) ]; it("should be able to add events to the end", function() { room.addEventsToTimeline(events); expect(room.timeline.length).toEqual(2); expect(room.timeline[0]).toEqual(events[0]); expect(room.timeline[1]).toEqual(events[1]); }); it("should be able to add events to the start", function() { room.addEventsToTimeline(events, true); expect(room.timeline.length).toEqual(2); expect(room.timeline[0]).toEqual(events[1]); expect(room.timeline[1]).toEqual(events[0]); }); it("should emit 'Room.timeline' events when added to the end", function() { var callCount = 0; room.on("Room.timeline", function(event, emitRoom, toStart) { callCount += 1; expect(room.timeline.length).toEqual(callCount); expect(event).toEqual(events[callCount - 1]); expect(emitRoom).toEqual(room); expect(toStart).toBeFalsy(); }); room.addEventsToTimeline(events); expect(callCount).toEqual(2); }); it("should emit 'Room.timeline' events when added to the start", function() { var callCount = 0; room.on("Room.timeline", function(event, emitRoom, toStart) { callCount += 1; expect(room.timeline.length).toEqual(callCount); expect(event).toEqual(events[callCount - 1]); expect(emitRoom).toEqual(room); expect(toStart).toBe(true); }); room.addEventsToTimeline(events, true); expect(callCount).toEqual(2); }); it("should set event.sender for new and old events", function() { var sentinel = { userId: userA, membership: "join", name: "Alice" }; var oldSentinel = { userId: userA, membership: "join", name: "Old Alice" }; room.currentState.getSentinelMember.andCallFake(function(uid) { if (uid === userA) { return sentinel; } return null; }); room.oldState.getSentinelMember.andCallFake(function(uid) { if (uid === userA) { return oldSentinel; } return null; }); var newEv = utils.mkEvent({ type: "m.room.name", room: roomId, user: userA, event: true, content: { name: "New Room Name" } }); var oldEv = utils.mkEvent({ type: "m.room.name", room: roomId, user: userA, event: true, content: { name: "Old Room Name" } }); room.addEventsToTimeline([newEv]); expect(newEv.sender).toEqual(sentinel); room.addEventsToTimeline([oldEv], true); expect(oldEv.sender).toEqual(oldSentinel); }); it("should set event.target for new and old m.room.member events", function() { var sentinel = { userId: userA, membership: "join", name: "Alice" }; var oldSentinel = { userId: userA, membership: "join", name: "Old Alice" }; room.currentState.getSentinelMember.andCallFake(function(uid) { if (uid === userA) { return sentinel; } return null; }); room.oldState.getSentinelMember.andCallFake(function(uid) { if (uid === userA) { return oldSentinel; } return null; }); var newEv = utils.mkMembership({ room: roomId, mship: "invite", user: userB, skey: userA, event: true }); var oldEv = utils.mkMembership({ room: roomId, mship: "ban", user: userB, skey: userA, event: true }); room.addEventsToTimeline([newEv]); expect(newEv.target).toEqual(sentinel); room.addEventsToTimeline([oldEv], true); expect(oldEv.target).toEqual(oldSentinel); }); it("should call setStateEvents on the right RoomState with the right " + "forwardLooking value", function() { room.oldState = utils.mock(RoomState); room.currentState = utils.mock(RoomState); var events = [ utils.mkMembership({ room: roomId, mship: "invite", user: userB, skey: userA, event: true }), utils.mkEvent({ type: "m.room.name", room: roomId, user: userB, event: true, content: { name: "New room" } }) ]; room.addEventsToTimeline(events); expect(room.currentState.setStateEvents).toHaveBeenCalledWith( [events[0]] ); expect(room.currentState.setStateEvents).toHaveBeenCalledWith( [events[1]] ); expect(events[0].forwardLooking).toBe(true); expect(events[1].forwardLooking).toBe(true); expect(room.oldState.setStateEvents).not.toHaveBeenCalled(); // test old room.addEventsToTimeline(events, true); expect(room.oldState.setStateEvents).toHaveBeenCalledWith( [events[0]] ); expect(room.oldState.setStateEvents).toHaveBeenCalledWith( [events[1]] ); expect(events[0].forwardLooking).toBe(false); expect(events[1].forwardLooking).toBe(false); }); }); describe("getJoinedMembers", function() { it("should return members whose membership is 'join'", function() { room.currentState.getMembers.andCallFake(function() { return [ { userId: "@alice:bar", membership: "join" }, { userId: "@bob:bar", membership: "invite" }, { userId: "@cleo:bar", membership: "leave" } ]; }); var res = room.getJoinedMembers(); expect(res.length).toEqual(1); expect(res[0].userId).toEqual("@alice:bar"); }); it("should return an empty list if no membership is 'join'", function() { room.currentState.getMembers.andCallFake(function() { return [ { userId: "@bob:bar", membership: "invite" } ]; }); var res = room.getJoinedMembers(); expect(res.length).toEqual(0); }); }); describe("hasMembershipState", function() { it("should return true for a matching userId and membership", function() { room.currentState.getMembers.andCallFake(function() { return [ { userId: "@alice:bar", membership: "join" }, { userId: "@bob:bar", membership: "invite" } ]; }); expect(room.hasMembershipState("@bob:bar", "invite")).toBe(true); }); it("should return false if match membership but no match userId", function() { room.currentState.getMembers.andCallFake(function() { return [ { userId: "@alice:bar", membership: "join" } ]; }); expect(room.hasMembershipState("@bob:bar", "join")).toBe(false); }); it("should return false if match userId but no match membership", function() { room.currentState.getMembers.andCallFake(function() { return [ { userId: "@alice:bar", membership: "join" } ]; }); expect(room.hasMembershipState("@alice:bar", "ban")).toBe(false); }); it("should return false if no match membership or userId", function() { room.currentState.getMembers.andCallFake(function() { return [ { userId: "@alice:bar", membership: "join" } ]; }); expect(room.hasMembershipState("@bob:bar", "invite")).toBe(false); }); it("should return false if no members exist", function() { room.currentState.getMembers.andCallFake(function() { return []; }); expect(room.hasMembershipState("@foo:bar", "join")).toBe(false); }); }); describe("recalculate", function() { var stateLookup = { // event.type + "$" event.state_key : MatrixEvent }; var setJoinRule = function(rule) { stateLookup["m.room.join_rules$"] = utils.mkEvent({ type: "m.room.join_rules", room: roomId, user: userA, content: { join_rule: rule }, event: true }); }; var setAliases = function(aliases, stateKey) { if (!stateKey) { stateKey = "flibble"; } stateLookup["m.room.aliases$" + stateKey] = utils.mkEvent({ type: "m.room.aliases", room: roomId, skey: stateKey, content: { aliases: aliases }, event: true }); }; var setRoomName = function(name) { stateLookup["m.room.name$"] = utils.mkEvent({ type: "m.room.name", room: roomId, user: userA, content: { name: name }, event: true }); }; var addMember = function(userId, state) { if (!state) { state = "join"; } stateLookup["m.room.member$" + userId] = utils.mkMembership({ room: roomId, mship: state, user: userId, skey: userId, event: true }); }; beforeEach(function() { stateLookup = {}; room.currentState.getStateEvents.andCallFake(function(type, key) { if (key === undefined) { var prefix = type + "$"; var list = []; for (var stateBlob in stateLookup) { if (!stateLookup.hasOwnProperty(stateBlob)) { continue; } if (stateBlob.indexOf(prefix) === 0) { list.push(stateLookup[stateBlob]); } } return list; } else { return stateLookup[type + "$" + key]; } }); room.currentState.getMembers.andCallFake(function() { var memberEvents = room.currentState.getStateEvents("m.room.member"); var members = []; for (var i = 0; i < memberEvents.length; i++) { members.push({ // not interested in user ID vs display name semantics. // That should be tested in RoomMember UTs. name: memberEvents[i].getSender(), userId: memberEvents[i].getSender() }); } return members; }); }); describe("Room.recalculate => Stripped State Events", function() { it("should set stripped state events as actual state events if the " + "room is an invite room", function() { var roomName = "flibble"; addMember(userA, "invite"); stateLookup["m.room.member$" + userA].event.invite_room_state = [ { type: "m.room.name", state_key: "", content: { name: roomName } } ]; room.recalculate(userA); expect(room.currentState.setStateEvents).toHaveBeenCalled(); // first call, first arg (which is an array), first element in array var fakeEvent = room.currentState.setStateEvents.calls[0].args[0][0]; expect(fakeEvent.getContent()).toEqual({ name: roomName }); }); it("should not clobber state events if it isn't an invite room", function() { addMember(userA, "join"); stateLookup["m.room.member$" + userA].event.invite_room_state = [ { type: "m.room.name", state_key: "", content: { name: "flibble" } } ]; room.recalculate(userA); expect(room.currentState.setStateEvents).not.toHaveBeenCalled(); }); }); describe("Room.recalculate => Room Name", function() { it("should return the names of members in a private (invite join_rules)" + " room if a room name and alias don't exist and there are >3 members.", function() { setJoinRule("invite"); addMember(userA); addMember(userB); addMember(userC); addMember(userD); room.recalculate(userA); var name = room.name; // we expect at least 1 member to be mentioned var others = [userB, userC, userD]; var found = false; for (var i = 0; i < others.length; i++) { if (name.indexOf(others[i]) !== -1) { found = true; break; } } expect(found).toEqual(true, name); }); it("should return the names of members in a private (invite join_rules)" + " room if a room name and alias don't exist and there are >2 members.", function() { setJoinRule("invite"); addMember(userA); addMember(userB); addMember(userC); room.recalculate(userA); var name = room.name; expect(name.indexOf(userB)).not.toEqual(-1, name); expect(name.indexOf(userC)).not.toEqual(-1, name); }); it("should return the names of members in a public (public join_rules)" + " room if a room name and alias don't exist and there are >2 members.", function() { setJoinRule("public"); addMember(userA); addMember(userB); addMember(userC); room.recalculate(userA); var name = room.name; expect(name.indexOf(userB)).not.toEqual(-1, name); expect(name.indexOf(userC)).not.toEqual(-1, name); }); it("should show the other user's name for public (public join_rules)" + " rooms if a room name and alias don't exist and it is a 1:1-chat.", function() { setJoinRule("public"); addMember(userA); addMember(userB); room.recalculate(userA); var name = room.name; expect(name.indexOf(userB)).not.toEqual(-1, name); }); it("should show the other user's name for private " + "(invite join_rules) rooms if a room name and alias don't exist and it" + " is a 1:1-chat.", function() { setJoinRule("invite"); addMember(userA); addMember(userB); room.recalculate(userA); var name = room.name; expect(name.indexOf(userB)).not.toEqual(-1, name); }); it("should show the other user's name for private" + " (invite join_rules) rooms if you are invited to it.", function() { setJoinRule("invite"); addMember(userA, "invite"); addMember(userB); room.recalculate(userA); var name = room.name; expect(name.indexOf(userB)).not.toEqual(-1, name); }); it("should show the room alias if one exists for private " + "(invite join_rules) rooms if a room name doesn't exist.", function() { var alias = "#room_alias:here"; setJoinRule("invite"); setAliases([alias, "#another:one"]); room.recalculate(userA); var name = room.name; expect(name).toEqual(alias); }); it("should show the room alias if one exists for public " + "(public join_rules) rooms if a room name doesn't exist.", function() { var alias = "#room_alias:here"; setJoinRule("public"); setAliases([alias, "#another:one"]); room.recalculate(userA); var name = room.name; expect(name).toEqual(alias); }); it("should show the room name if one exists for private " + "(invite join_rules) rooms.", function() { var roomName = "A mighty name indeed"; setJoinRule("invite"); setRoomName(roomName); room.recalculate(userA); var name = room.name; expect(name).toEqual(roomName); }); it("should show the room name if one exists for public " + "(public join_rules) rooms.", function() { var roomName = "A mighty name indeed"; setJoinRule("public"); setRoomName(roomName); room.recalculate(userA); var name = room.name; expect(name).toEqual(roomName); }); it("should show your name for private (invite join_rules) rooms if" + " a room name and alias don't exist and it is a self-chat.", function() { setJoinRule("invite"); addMember(userA); room.recalculate(userA); var name = room.name; expect(name).toEqual(userA); }); it("should show your name for public (public join_rules) rooms if a" + " room name and alias don't exist and it is a self-chat.", function() { setJoinRule("public"); addMember(userA); room.recalculate(userA); var name = room.name; expect(name).toEqual(userA); }); it("should return '?' if there is no name, alias or members in the room.", function() { room.recalculate(userA); var name = room.name; expect(name).toEqual("?"); }); }); }); describe("receipts", function() { var eventToAck = utils.mkMessage({ room: roomId, user: userA, msg: "PLEASE ACKNOWLEDGE MY EXISTENCE", event: true }); function mkReceipt(roomId, records) { var content = {}; records.forEach(function(r) { if (!content[r.eventId]) { content[r.eventId] = {}; } if (!content[r.eventId][r.type]) { content[r.eventId][r.type] = {}; } content[r.eventId][r.type][r.userId] = { ts: r.ts }; }); return new MatrixEvent({ content: content, room_id: roomId, type: "m.receipt" }); } function mkRecord(eventId, type, userId, ts) { ts = ts || Date.now(); return { eventId: eventId, type: type, userId: userId, ts: ts }; } describe("addReceipt", function() { it("should store the receipt so it can be obtained via getReceiptsForEvent", function() { var ts = 13787898424; room.addReceipt(mkReceipt(roomId, [ mkRecord(eventToAck.getId(), "m.read", userB, ts) ])); expect(room.getReceiptsForEvent(eventToAck)).toEqual([{ type: "m.read", userId: userB, data: { ts: ts } }]); }); it("should emit an event when a receipt is added", function() { var listener = jasmine.createSpy('spy'); room.on("Room.receipt", listener); var ts = 13787898424; var receiptEvent = mkReceipt(roomId, [ mkRecord(eventToAck.getId(), "m.read", userB, ts) ]); room.addReceipt(receiptEvent); expect(listener).toHaveBeenCalledWith(receiptEvent, room); }); it("should clobber receipts based on type and user ID", function() { var nextEventToAck = utils.mkMessage({ room: roomId, user: userA, msg: "I AM HERE YOU KNOW", event: true }); var ts = 13787898424; room.addReceipt(mkReceipt(roomId, [ mkRecord(eventToAck.getId(), "m.read", userB, ts) ])); var ts2 = 13787899999; room.addReceipt(mkReceipt(roomId, [ mkRecord(nextEventToAck.getId(), "m.read", userB, ts2) ])); expect(room.getReceiptsForEvent(eventToAck)).toEqual([]); expect(room.getReceiptsForEvent(nextEventToAck)).toEqual([{ type: "m.read", userId: userB, data: { ts: ts2 } }]); }); it("should persist multiple receipts for a single event ID", function() { var ts = 13787898424; room.addReceipt(mkReceipt(roomId, [ mkRecord(eventToAck.getId(), "m.read", userB, ts), mkRecord(eventToAck.getId(), "m.read", userC, ts), mkRecord(eventToAck.getId(), "m.read", userD, ts) ])); expect(room.getUsersReadUpTo(eventToAck)).toEqual( [userB, userC, userD] ); }); it("should persist multiple receipts for a single receipt type", function() { var eventTwo = utils.mkMessage({ room: roomId, user: userA, msg: "2222", event: true }); var eventThree = utils.mkMessage({ room: roomId, user: userA, msg: "3333", event: true }); var ts = 13787898424; room.addReceipt(mkReceipt(roomId, [ mkRecord(eventToAck.getId(), "m.read", userB, ts), mkRecord(eventTwo.getId(), "m.read", userC, ts), mkRecord(eventThree.getId(), "m.read", userD, ts) ])); expect(room.getUsersReadUpTo(eventToAck)).toEqual([userB]); expect(room.getUsersReadUpTo(eventTwo)).toEqual([userC]); expect(room.getUsersReadUpTo(eventThree)).toEqual([userD]); }); it("should persist multiple receipts for a single user ID", function() { room.addReceipt(mkReceipt(roomId, [ mkRecord(eventToAck.getId(), "m.delivered", userB, 13787898424), mkRecord(eventToAck.getId(), "m.read", userB, 22222222), mkRecord(eventToAck.getId(), "m.seen", userB, 33333333), ])); expect(room.getReceiptsForEvent(eventToAck)).toEqual([ { type: "m.delivered", userId: userB, data: { ts: 13787898424 } }, { type: "m.read", userId: userB, data: { ts: 22222222 } }, { type: "m.seen", userId: userB, data: { ts: 33333333 } } ]); }); }); describe("getUsersReadUpTo", function() { it("should return user IDs read up to the given event", function() { var ts = 13787898424; room.addReceipt(mkReceipt(roomId, [ mkRecord(eventToAck.getId(), "m.read", userB, ts) ])); expect(room.getUsersReadUpTo(eventToAck)).toEqual([userB]); }); }); }); describe("tags", function() { function mkTags(roomId, tags) { var content = { "tags" : tags }; return new MatrixEvent({ content: content, room_id: roomId, type: "m.tag" }); } describe("addTag", function() { it("should set tags on rooms from event stream so " + "they can be obtained by the tags property", function() { var tags = { "m.foo": { "order": 0.5 } }; room.addTags(mkTags(roomId, tags)); expect(room.tags).toEqual(tags); }); it("should emit Room.tags event when new tags are " + "received on the event stream", function() { var listener = jasmine.createSpy('spy'); room.on("Room.tags", listener); var tags = { "m.foo": { "order": 0.5 } }; var event = mkTags(roomId, tags); room.addTags(event); expect(listener).toHaveBeenCalledWith(event, room); }); // XXX: shouldn't we try injecting actual m.tag events onto the eventstream // rather than injecting via room.addTags()? }); }); });