Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor getRoomUpgradeHistory to use Room.findPredecessorRoomId #3090

Merged
merged 2 commits into from
Jan 25, 2023
Merged

Refactor getRoomUpgradeHistory to use Room.findPredecessorRoomId #3090

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
812792d
Refactor getRoomUpgradeHistory to use Room.findPredecessorRoomId
andybalaam Jan 24, 2023
c25dcde
Simplify getRoomUpgradeHistory implementation a little
andybalaam Jan 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 45 additions & 41 deletions src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4990,68 +4990,72 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
* history.
*/
public getRoomUpgradeHistory(roomId: string, verifyLinks = false): Room[] {
let currentRoom = this.getRoom(roomId);
const currentRoom = this.getRoom(roomId);
if (!currentRoom) return [];

const upgradeHistory = [currentRoom];
const before = this.findPredecessorRooms(currentRoom, verifyLinks);
const after = this.findSuccessorRooms(currentRoom, verifyLinks);

// Work backwards first, looking at create events.
let successorRoomId = currentRoom.roomId;
let createEvent = currentRoom.currentState.getStateEvents(EventType.RoomCreate, "");
while (createEvent) {
const predecessor = createEvent.getContent()["predecessor"];
if (predecessor && predecessor["room_id"]) {
const refRoom = this.getRoom(predecessor["room_id"]);
if (!refRoom) break; // end of the chain

if (verifyLinks) {
const tombstone = refRoom.currentState.getStateEvents(EventType.RoomTombstone, "");
return [...before, currentRoom, ...after];
}

if (!tombstone || tombstone.getContent()["replacement_room"] !== successorRoomId) {
break;
}
}
private findPredecessorRooms(room: Room, verifyLinks: boolean): Room[] {
const ret: Room[] = [];

// Insert at the front because we're working backwards from the currentRoom
upgradeHistory.splice(0, 0, refRoom);
successorRoomId = refRoom.roomId;
createEvent = refRoom.currentState.getStateEvents(EventType.RoomCreate, "");
} else {
// No further create events to look at
// Work backwards from newer to older rooms
let predecessorRoomId = room.findPredecessorRoomId();
while (predecessorRoomId !== null) {
const predecessorRoom = this.getRoom(predecessorRoomId);
if (predecessorRoom === null) {
break;
}
if (verifyLinks) {
const tombstone = predecessorRoom.currentState.getStateEvents(EventType.RoomTombstone, "");
if (!tombstone || tombstone.getContent()["replacement_room"] !== room.roomId) {
break;
}
}

// Insert at the front because we're working backwards from the currentRoom
ret.splice(0, 0, predecessorRoom);

room = predecessorRoom;
predecessorRoomId = room.findPredecessorRoomId();
}
return ret;
}

private findSuccessorRooms(room: Room, verifyLinks: boolean): Room[] {
const ret: Room[] = [];

// Work forwards next, looking at tombstone events
let tombstoneEvent = currentRoom.currentState.getStateEvents(EventType.RoomTombstone, "");
// Work forwards, looking at tombstone events
let tombstoneEvent = room.currentState.getStateEvents(EventType.RoomTombstone, "");
while (tombstoneEvent) {
const refRoom = this.getRoom(tombstoneEvent.getContent()["replacement_room"]);
if (!refRoom) break; // end of the chain
if (refRoom.roomId === currentRoom.roomId) break; // Tombstone is referencing it's own room
const successorRoom = this.getRoom(tombstoneEvent.getContent()["replacement_room"]);
if (!successorRoom) break; // end of the chain
if (successorRoom.roomId === room.roomId) break; // Tombstone is referencing it's own room

if (verifyLinks) {
createEvent = refRoom.currentState.getStateEvents(EventType.RoomCreate, "");
if (!createEvent || !createEvent.getContent()["predecessor"]) break;

const predecessor = createEvent.getContent()["predecessor"];
if (predecessor["room_id"] !== currentRoom.roomId) break;
const predecessorRoomId = successorRoom.findPredecessorRoomId();
if (!predecessorRoomId || predecessorRoomId !== room.roomId) {
break;
}
}

// Push to the end because we're looking forwards
upgradeHistory.push(refRoom);
const roomIds = new Set(upgradeHistory.map((ref) => ref.roomId));
if (roomIds.size < upgradeHistory.length) {
ret.push(successorRoom);
const roomIds = new Set(ret.map((ref) => ref.roomId));
if (roomIds.size < ret.length) {
// The last room added to the list introduced a previous roomId
// To avoid recursion, return the last rooms - 1
return upgradeHistory.slice(0, upgradeHistory.length - 1);
return ret.slice(0, ret.length - 1);
}

// Set the current room to the reference room so we know where we're at
currentRoom = refRoom;
tombstoneEvent = currentRoom.currentState.getStateEvents(EventType.RoomTombstone, "");
room = successorRoom;
tombstoneEvent = room.currentState.getStateEvents(EventType.RoomTombstone, "");
}

return upgradeHistory;
return ret;
}

/**
Expand Down