Support room upgrades #100
Conversation
Signed-off-by: Will Hunt <will@half-shot.uk>
| */ | ||
| class RoomUpgradeHandler { | ||
| /** | ||
| * @param {RoomUpgradeHandler~Options} opts |
There was a problem hiding this comment.
They should be described here in the jsdoc if we expect people to create this object.
There was a problem hiding this comment.
I'm not describing them 3 times, people have the ability to click on hyperlinks.
There was a problem hiding this comment.
that's fair, I thought this was much higher in the stack. Do we even need jsdoc here?
There was a problem hiding this comment.
Yes, otherwise we don't know the type that we are passing.
|
also this needs options for handling ghosts. |
It doesn't. Ghosts are very particular to the bridge and should be handled on |
Signed-off-by: Will Hunt <will@half-shot.uk>
Signed-off-by: Will Hunt <will@half-shot.uk>
Signed-off-by: Will Hunt <will@half-shot.uk>
Signed-off-by: Will Hunt <will@half-shot.uk>
Signed-off-by: Will Hunt <will@half-shot.uk>
Signed-off-by: Will Hunt <will@half-shot.uk>
More than JSDoc? |
There was a problem hiding this comment.
I'm going to be picky and say that we need a ghost copy option on the upgrade handler. We're already cutting over the room entry in the store and the appservice user themselves - most bridges are going to want to blind copy the users in as well. There's a few bridges I can think of that won't want to do this, which is why it should be a flag.
As for documentation: A mention to what the room upgrade handler is in the README is all I'm looking for. We don't have good enough docs to support the actual level of documentation I would normally expect, so I won't block this on that.
| */ | ||
| class RoomUpgradeHandler { | ||
| /** | ||
| * @param {RoomUpgradeHandler~Options} opts |
There was a problem hiding this comment.
that's fair, I thought this was much higher in the stack. Do we even need jsdoc here?
Signed-off-by: Will Hunt <will@half-shot.uk>
Signed-off-by: Will Hunt <will@half-shot.uk>
Signed-off-by: Will Hunt <will@half-shot.uk>
Signed-off-by: Will Hunt <will@half-shot.uk>
Signed-off-by: Will Hunt <will@half-shot.uk>
Fixes #95
This works by listening for a
m.room.tombstoneevent and attempts to join the referenced room (first by room_id, then by alias). If that succeeds it finds all entries by the old room id and replace with the new room id. If the join fails, it waits for a subsequent invite before trying to update the entries.The entry update logic can be overriden by providing a callback, and bridges can hook into another callback once an upgrade has been completed.
This functionality is disabled by default and must be enabled by providing a config.