Display room's parent in room switcher #1732

nishanthkarthik · 2024-05-18T00:32:33Z

When rooms in different spaces have the same name #general, it is hard to distinguish them. This PR adds a user-configurable option to display parent room names by the side

(ignore my theme!)

Also removed a hack for QTBUG-93281

nishanthkarthik · 2024-06-14T16:37:00Z

@deepbluev7 Would you be interested in reviewing this PR?

deepbluev7 · 2024-06-14T16:37:02Z

Sorry, but I don't know what that command means.

Thanks for asking 🥰

redsky17 · 2024-06-14T20:06:38Z

That was a bot Nico uses to help do some administrivia for PRs and such, not an actual response from the person that is Nico. I let him know about your comment @nishanthkarthik :).

redsky17

This looks good to me, but we can wait for Nico to review if you want :)

nishanthkarthik · 2024-06-14T21:12:09Z

Rebased and fixed linter feedback. Let's wait for Nico too

deepbluev7 · 2024-06-16T20:45:07Z

src/Cache.cpp

+    auto getParentRoomIdsWithTxn = [&](const std::string &id) -> std::optional<std::string> {
+        auto cursor         = lmdb::cursor::open(txn, spacesParentsDb_);
+        std::string_view sp = id, space_parent;
+        if (cursor.get(sp, space_parent, MDB_SET)) {
+            while (cursor.get(sp, space_parent, MDB_FIRST_DUP)) {
+                if (!space_parent.empty())
+                    return std::make_optional(static_cast<std::string>(space_parent));
+            }
+        }
+        cursor.close();
+
+        return std::nullopt;
+    };


This actually gets a random room parent. I would suggest you actually query the canonical room parent. Otherwise it might appear quite random, which room is actually listed here. I would suggest you check the parentSpace function in the TimelineModel.

Actually since you don't need the parentSpace for anything but displaying the name of the filtered entries, I would suggest you might want to do (in RoomsModel::roleNames()):

auto parent = roomList->getRoomById(); if (parent) { auto desc = parent->parentSpace(); if (desc) return desc->roomName(); }

I'm not sure why, a room's parentSpace is empty. I tried to read off mtx::events::state::space::Parent events manually from a room and I did not find a parent. That's why I think I gave up and used spacesParentsDb.

This is the diff I used to test your approach

case Roles::RoomParent: { const auto roomPtr = roomListModel_.getRoomById(QString::fromStdString(rooms[index.row()].id)); if (auto &room = *roomPtr; roomPtr) { if (const auto &parent = room.parentSpace(); parent) { qInfo() << "Parent has name" << parent->roomName(); return parent->roomName(); } else { qWarning() << "No parent for room" << "expected" << rooms[index.row()].parent; } } else { qWarning() << "No room with ID"; } return QString{}; }

Did that room possibly not have a canonical parent? Can you maybe log the space parent event for that room?

I don't think these rooms have any parents.

cache::client()->getStateEventsWithType<mtx::events::state::space::Parent>(this->room_id_.toStdString()).size() is 0.

I think spacesParentsDb_ builds this relation using mtx::events::state::space::Child. MSC2946 describes walking the spaces tree using m.space.child.

The matrix spec also says

Spaces form a hierarchy of rooms which clients can use to structure their room list into a tree-like view. The parent/child relationship can be defined in two ways: with m.space.child state events in the space-room, or with m.space.parent state events in the child room.

In most cases, both the child and parent relationship should be defined to aid discovery of the space and its rooms. When only a m.space.child is used, the space is effectively a curated list of rooms which the rooms themselves might not be aware of. When only a m.space.parent is used, the rooms are “secretly” added to spaces with the effect of not being advertised directly by the space.

...

To avoid situations where a room falsely claims it is part of a given space, m.space.parent events should be ignored unless one of the following is true: A corresponding m.space.child event can be found in the supposed parent space. ...

I think m.space.child should be the primary sources of truth

All 3 options are valid:

only space.child

only space.parent

both

We generally only accept canonicalParents as something added to the room name in Nheko, because this means the room admin accepted that relationship. Otherwise a room can have multiple parents or someone could maliciously craft space.child events to make a room belong to a community it doesn't want to. So I think we really should only accept canonical parent events.

In case the canonical parent events are not available for a room, can this be an opt-in config? This is the structure that mautrix - matrix bridges use, so I'd really like to use the parent-child relationship from spacesParentsDb_. I think I can manually add the parent event to my ~50 matrix rooms but I'd prefer not to.

Alternatively, I can make an issue on mautrix about this but I'm not aware of the technical decisions behind not doing this by default.

I think we really should stick to only showing the canonical parent as the "official" parent. There are other features that rely on that like custom stickers and emojis. Maybe mautrix could change their spaces to use canonical parents?

In any case, if there is a canonical parent, we should really pick that one!

deepbluev7 · 2024-06-16T20:46:22Z

resources/qml/Completer.qml

+                        Loader {
+                            active: Settings.displayParentInSwitcher && model.roomParent !== ""
+                            sourceComponent: Label {
+                                color: model.index == popup.currentIndex ? palette.highlightedText : palette.text
+                                text: "[" + model.roomParent + "]"
+                                font.pixelSize: popup.avatarHeight * 0.5
+                            }
+                        }


Could you make this font somehow special, so that it doesn't just look like a suffix to the roomname? I.e. make it smaller, bold, different color or whatever?

This is fixed in Qt 6.7.0 and signal `imagesLoaded` was removed. Nheko warns about `No such signal QTextDocument::imagesLoaded()`

todo remove it from the cache

nishanthkarthik · 2024-08-24T00:16:16Z

Ready for next round of feedback :)

deepbluev7 · 2024-11-17T18:35:21Z

src/Cache.cpp

            result.push_back(RoomNameAlias{
              .id              = std::move(room_id_str),
              .name            = std::move(info.name),
              .alias           = std::move(alias),
              .recent_activity = info.approximate_last_modification_ts,
              .is_tombstoned   = info.is_tombstoned,
              .is_space        = info.is_space,
+              .parent          = std::move(parentName),


Can we load this information lazily when it is accessed first in the RoomsModel instead? Looking up this data seems to add quite a lot of overhead to constructing the fuzzy search structure, but we only need it when displaying specific results,so we can really look it up only when showing a certain entry.

I have a few deadlines coming up. I'll make the fixups in a few weeks :)

redsky17 approved these changes Jun 14, 2024

View reviewed changes

nishanthkarthik force-pushed the search-space branch from ddfc818 to 7640c3f Compare June 14, 2024 21:11

deepbluev7 reviewed Jun 16, 2024

View reviewed changes

nishanthkarthik added 6 commits June 20, 2024 09:52

Remove workaround for QTBUG-93281

2b9e056

This is fixed in Qt 6.7.0 and signal `imagesLoaded` was removed. Nheko warns about `No such signal QTextDocument::imagesLoaded()`

List parent room name next to room names in room switcher

46a8019

Add configuration to display room's parent in room switcher

7582c6d

fixup! remove unnecessary logging

10cd106

fixup! linter fixes

492511a

wip change how we read parent room

00f2fe7

todo remove it from the cache

nishanthkarthik force-pushed the search-space branch from 7640c3f to 00f2fe7 Compare July 4, 2024 17:38

deepbluev7 reviewed Nov 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display room's parent in room switcher #1732

Display room's parent in room switcher #1732

nishanthkarthik commented May 18, 2024 •

edited

Loading

nishanthkarthik commented Jun 14, 2024

deepbluev7 commented Jun 14, 2024

redsky17 commented Jun 14, 2024

redsky17 left a comment

nishanthkarthik commented Jun 14, 2024

deepbluev7 Jun 16, 2024

nishanthkarthik Jun 17, 2024

deepbluev7 Jun 20, 2024

nishanthkarthik Jun 22, 2024

nishanthkarthik Jun 22, 2024 •

edited

Loading

deepbluev7 Jun 25, 2024

nishanthkarthik Jun 26, 2024

deepbluev7 Nov 17, 2024 •

edited

Loading

deepbluev7 Jun 16, 2024

nishanthkarthik Jun 17, 2024

nishanthkarthik commented Aug 24, 2024

deepbluev7 Nov 17, 2024

nishanthkarthik Nov 20, 2024

Display room's parent in room switcher #1732

Are you sure you want to change the base?

Display room's parent in room switcher #1732

Conversation

nishanthkarthik commented May 18, 2024 • edited Loading

nishanthkarthik commented Jun 14, 2024

deepbluev7 commented Jun 14, 2024

redsky17 commented Jun 14, 2024

redsky17 left a comment

Choose a reason for hiding this comment

nishanthkarthik commented Jun 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nishanthkarthik Jun 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deepbluev7 Nov 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nishanthkarthik commented Aug 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nishanthkarthik commented May 18, 2024 •

edited

Loading

nishanthkarthik Jun 22, 2024 •

edited

Loading

deepbluev7 Nov 17, 2024 •

edited

Loading