fix(sliding-sync): refresh stale room member display names when global profile differs (#1530)

<!-- Please read
https://github.com/SableClient/Sable/blob/dev/CONTRIBUTING.md before
submitting your pull request -->

### Description

<!-- Please include a summary of the change. Please also include
relevant motivation and context. List any dependencies that are required
for this change. -->

Fixes #1520

#### Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update

### Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings

### AI disclosure:

- [ ] Partially AI assisted (clarify which code was AI assisted and
briefly explain what it does).
- [ ] Fully AI generated (explain what all the generated code does in
moderate detail).
<!-- Write any explanation required here, but do not generate the
explanation using AI!! You must prove you understand what the code in
this PR does. -->
This commit is contained in:
7w1 authored and GitHub committed 2026-07-31 20:33:16 +00:00
commit 9beded4fcc
6 files changed
+101 -28

No files matched your search

@@ -0,0 +1,5 @@
---
default: patch
---
Fix outdated user display names in chats under sliding sync by force-refreshing room member state when the global profile suggests the per-room name is stale.
+1 -1
View File
@@ -493,7 +493,7 @@ function MessageInternal(
// Avatars
// Prefer the room-scoped member avatar (m.room.member) over the global profile
// avatar so per-room avatar overrides are respected in the timeline.
useRoomMemberHydration(room, senderId, mEvent.sender !== null);
useRoomMemberHydration(room, senderId, mEvent.sender !== null, profile.displayName);
const memberAvatarMxc = mEvent.sender?.getMxcAvatarUrl() ?? getMemberAvatarMxc(room, senderId);
const avatarUrl = useMemo(() => {
const mxc = pmp?.avatar_url || memberAvatarMxc || profile.avatarUrl;
@@ -51,7 +51,15 @@ vi.mock('$hooks/useSableCosmetics', () => ({
}));
vi.mock('$hooks/useRoomMemberHydration', () => ({
useRoomMemberHydration: vi.fn<(room: unknown, userId: string) => void>(),
useRoomMemberHydration:
vi.fn<
(
room: unknown,
userId: string,
hasTimelineMember?: boolean,
profileDisplayName?: string
) => void
>(),
}));
vi.mock('$state/hooks/userRoomProfile', () => ({
+28 -22
View File
@@ -5,15 +5,11 @@ import { useMatrixClient } from './useMatrixClient';
import { useIsInactivePanel } from './useRoom';
import { useTimelineScrolling } from './useTimelineScrollActivity';
/**
* Under sliding sync, m.room.member events only arrive for senders in the
* lazy-loaded sync window. Fetch the member on demand and bump local state so
* the caller re-reads room member state (avatar, display name) once hydrated.
*/
export const useRoomMemberHydration = (
room: Room,
userId: string,
hasTimelineMember = false
hasTimelineMember = false,
profileDisplayName?: string
): number => {
const mx = useMatrixClient();
const [version, setVersion] = useState(0);
@@ -21,22 +17,32 @@ export const useRoomMemberHydration = (
const timelineScrolling = useTimelineScrolling();
useEffect(() => {
if (
isInactivePanel ||
timelineScrolling ||
hasTimelineMember ||
!userId.startsWith('@') ||
room.getMember(userId)
)
return undefined;
let disposed = false;
void hydrateRoomMember(mx, room.roomId, userId).then(() => {
if (!disposed && room.getMember(userId)) setVersion((v) => v + 1);
});
return () => {
disposed = true;
};
}, [mx, room, userId, hasTimelineMember, isInactivePanel, timelineScrolling]);
if (isInactivePanel || timelineScrolling || !userId.startsWith('@')) return undefined;
const member = room.getMember(userId);
if (!member && !hasTimelineMember) {
let disposed = false;
void hydrateRoomMember(mx, room.roomId, userId).then(() => {
if (!disposed && room.getMember(userId)) setVersion((v) => v + 1);
});
return () => {
disposed = true;
};
}
if (member && profileDisplayName && profileDisplayName !== member.rawDisplayName) {
let disposed = false;
void hydrateRoomMember(mx, room.roomId, userId, true).then(() => {
if (!disposed && room.getMember(userId)) setVersion((v) => v + 1);
});
return () => {
disposed = true;
};
}
return undefined;
}, [mx, room, userId, hasTimelineMember, isInactivePanel, timelineScrolling, profileDisplayName]);
return version;
};
+35
View File
@@ -116,6 +116,41 @@ describe('hydrateRoomMember', () => {
});
});
describe('hydrateRoomMember (force)', () => {
beforeEach(() => {
vi.useFakeTimers();
});
afterEach(() => {
vi.useRealTimers();
});
it('re-fetches and injects state when force=true even if the member exists', async () => {
const { mx, getStateEvent, setStateEvents, getMember } = makeFakes();
getMember.mockReturnValue({ rawDisplayName: 'OldName' } as RoomMember);
await hydrateRoomMember(mx, ROOM_ID, USER_ID, true);
expect(getStateEvent).toHaveBeenCalledTimes(1);
expect(setStateEvents).toHaveBeenCalledTimes(1);
});
it('respects the refresh cooldown so repeated force calls do not refetch', async () => {
const { mx, getStateEvent, getMember } = makeFakes();
getMember.mockReturnValue({ rawDisplayName: 'OldName' } as RoomMember);
await hydrateRoomMember(mx, ROOM_ID, USER_ID, true);
await hydrateRoomMember(mx, ROOM_ID, USER_ID, true);
expect(getStateEvent).toHaveBeenCalledTimes(1);
vi.advanceTimersByTime(10 * 60_000 + 1);
await hydrateRoomMember(mx, ROOM_ID, USER_ID, true);
expect(getStateEvent).toHaveBeenCalledTimes(2);
});
});
describe('hydrateRoomMembers', () => {
it('dedups user ids and filters non-user ids', async () => {
const { mx, getStateEvent } = makeFakes();
+23 -4
View File
@@ -11,6 +11,9 @@ const failedAt = new WeakMap<MatrixClient, Map<string, number>>();
const activeRequests = new WeakMap<MatrixClient, number>();
const requestQueues = new WeakMap<MatrixClient, Array<() => void>>();
const REFRESH_TTL_MS = 10 * 60_000;
const refreshedAt = new WeakMap<MatrixClient, Map<string, number>>();
const scheduleRequest = <T>(mx: MatrixClient, task: () => Promise<T>): Promise<T> =>
new Promise<T>((resolve, reject) => {
const run = () => {
@@ -38,12 +41,21 @@ const scheduleRequest = <T>(mx: MatrixClient, task: () => Promise<T>): Promise<T
export const hydrateRoomMember = (
mx: MatrixClient,
roomId: string,
userId: string
userId: string,
force = false
): Promise<void> => {
const room = mx.getRoom(roomId);
if (!room || room.getMember(userId)) return Promise.resolve();
if (!room) return Promise.resolve();
if (!force && room.getMember(userId)) return Promise.resolve();
const key = `${roomId}\u0000${userId}`;
if (force) {
const lastRefreshed = refreshedAt.get(mx)?.get(key);
if (lastRefreshed !== undefined && Date.now() - lastRefreshed < REFRESH_TTL_MS)
return Promise.resolve();
}
const failedTs = failedAt.get(mx)?.get(key);
if (failedTs !== undefined && Date.now() - failedTs < FAILURE_TTL_MS) return Promise.resolve();
@@ -56,10 +68,12 @@ export const hydrateRoomMember = (
// A request may have waited in the queue while another event supplied the
// member state. Avoid issuing a redundant network request in that case.
const requestRoom = mx.getRoom(roomId);
if (!requestRoom || requestRoom.getMember(userId)) return;
if (!requestRoom) return;
if (!force && requestRoom.getMember(userId)) return;
const content = await mx.getStateEvent(roomId, EventType.RoomMember, userId);
const currentRoom = mx.getRoom(roomId);
if (!currentRoom || currentRoom.getMember(userId)) return;
if (!currentRoom) return;
if (!force && currentRoom.getMember(userId)) return;
currentRoom.currentState.setStateEvents([
new MatrixEvent({
type: EventType.RoomMember,
@@ -72,6 +86,11 @@ export const hydrateRoomMember = (
})
.then(() => {
failedAt.get(mx)?.delete(key);
if (force) {
const refreshMap = refreshedAt.get(mx) ?? new Map<string, number>();
refreshedAt.set(mx, refreshMap);
refreshMap.set(key, Date.now());
}
})
.catch(() => {
const failures = failedAt.get(mx) ?? new Map<string, number>();