fix(timeline): clear the unread marker when the room is read on another device

This commit is contained in:
Erwan Leboucher authored and 7w1 committed 2026-07-31 15:27:08 -05:00
1 parent 91da38b283
commit fd1d03ec00
2 files changed
+80 -1

No files matched your search

@@ -1,8 +1,10 @@
import { EventEmitter } from 'events';
import { forwardRef, useImperativeHandle, type ReactNode } from 'react';
import { act, render } from '@testing-library/react';
import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest';
import type { Editor } from 'slate';
import type { Room } from '$types/matrix-sdk';
import { RoomEvent } from '$types/matrix-sdk';
import type { ProcessedEvent } from '$hooks/timeline/useProcessedTimeline';
import type * as DomUtils from '$utils/dom';
import { RoomTimeline } from './RoomTimeline';
@@ -259,11 +261,21 @@ const fireResize = (element: Element) => {
});
};
const roomEmitter = new EventEmitter();
const room = {
roomId: '!room:example.org',
getLiveTimeline: () => undefined,
on: roomEmitter.on.bind(roomEmitter),
removeListener: roomEmitter.removeListener.bind(roomEmitter),
} as unknown as Room;
const emitReceiptFor = (userId: string) =>
roomEmitter.emit(
RoomEvent.Receipt,
{ getContent: () => ({ '$evt:example.org': { 'm.read': { [userId]: { ts: 1 } } } }) },
room
);
const getContentEl = (container: HTMLElement) => {
const contentEl = container.querySelector('[data-testid="vlist-content"]');
expect(contentEl).toBeTruthy();
@@ -374,6 +386,50 @@ describe('RoomTimeline content ResizeObserver', () => {
});
});
describe('remote read receipts', () => {
const unread = {
readUptoEventId: '$read:example.org',
inLiveTimeline: true,
scrollTo: false,
};
it('clears the marker when the room is read on another device', () => {
getRoomUnreadInfoMock.mockReturnValue(unread);
renderTimeline();
expect(processedTimelineOptions.current?.readUptoEventId).toBe('$read:example.org');
getRoomUnreadInfoMock.mockReturnValue(undefined);
act(() => {
emitReceiptFor('@me:example.org');
});
expect(processedTimelineOptions.current?.readUptoEventId).toBeUndefined();
});
it('ignores receipts belonging to other users', () => {
getRoomUnreadInfoMock.mockReturnValue(unread);
renderTimeline();
getRoomUnreadInfoMock.mockReturnValue(undefined);
act(() => {
emitReceiptFor('@bob:example.org');
});
expect(processedTimelineOptions.current?.readUptoEventId).toBe('$read:example.org');
});
it('keeps the marker when the room is still unread after the receipt', () => {
getRoomUnreadInfoMock.mockReturnValue(unread);
renderTimeline();
act(() => {
emitReceiptFor('@me:example.org');
});
expect(processedTimelineOptions.current?.readUptoEventId).toBe('$read:example.org');
});
});
describe('MemoizedTimelineItem', () => {
it('re-renders message rows when canRedact flips (power-level update)', () => {
const { container, rerender } = renderTimeline();
+24 -1
View File
@@ -13,7 +13,7 @@ import {
import type { Editor } from 'slate';
import { useAtomValue, useSetAtom, useStore } from 'jotai';
import type { Room, MatrixEvent, EventTimelineSet } from '$types/matrix-sdk';
import { Direction, EventTimeline, EventType } from '$types/matrix-sdk';
import { Direction, EventTimeline, EventType, RoomEvent } from '$types/matrix-sdk';
import classNames from 'classnames';
import type { VListHandle } from 'virtua';
import { VList } from 'virtua';
@@ -23,6 +23,7 @@ import { ArrowDown, ChatTeardropDots, Checks, chipIcon } from '$components/icons
import { MessageBase, CompactPlaceholder, DefaultPlaceholder } from '$components/message';
import { RoomIntro } from '$components/room-intro';
import { useMatrixClient } from '$hooks/useMatrixClient';
import { useMatrixEvent } from '$hooks/useMatrixEvent';
import { useAlive } from '$hooks/useAlive';
import { useMessageEdit } from '$hooks/useMessageEdit';
import { useDocumentFocusChange } from '$hooks/useDocumentFocusChange';
@@ -989,6 +990,28 @@ export function RoomTimeline({
)
);
// Reading elsewhere clears the room list badge, so clear the in-room marker too.
useMatrixEvent(
room,
RoomEvent.Receipt,
useCallback(
(mEvent: MatrixEvent) => {
const myUserId = mx.getUserId();
if (!myUserId) return;
const content =
mEvent.getContent<Record<string, Record<string, Record<string, unknown>>>>();
const isMyReceipt = Object.values(content).some((byType) =>
Object.values(byType ?? {}).some((byUser) => myUserId in (byUser ?? {}))
);
// Re-anchoring on a partial remote read would move the divider mid-read.
if (!isMyReceipt || getRoomUnreadInfo(room)) return;
readUptoEventIdRef.current = undefined;
setUnreadInfo(undefined);
},
[mx, room]
)
);
useEffect(() => {
if (atBottomState && isWindowFocused() && timelineSync.liveTimelineLinked) tryAutoMarkAsRead();
}, [