Skip to content

fix(matrix): throttle room history backfill requests #2249

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

Open
webguru-hypha wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(matrix): throttle room history backfill requests #2249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 43 additions & 2 deletions packages/core/src/matrix/client/providers/matrix-provider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,10 @@ export const MATRIX_UPLOAD_TIMEOUT_MS = 120_000;
const MATRIX_UPLOAD_STAGGER_MS = 400;

const MATRIX_UPLOAD_RATE_LIMIT_MAX_ATTEMPTS = 4;
const MATRIX_HISTORY_BATCH_DELAY_MS = 220;
const MATRIX_HISTORY_RATE_LIMIT_MAX_RETRIES = 3;
const MATRIX_HISTORY_RECENT_LOAD_COOLDOWN_MS = 45_000;
const MATRIX_HISTORY_TARGET_EVENTS = 220;
const MATRIX_GROUP_CALL_EVENT_TYPE = 'org.matrix.msc3401.call';
const MATRIX_GROUP_CALL_MEMBER_EVENT_TYPE = 'org.matrix.msc3401.call.member';
const MATRIX_LEGACY_CALL_MEMBER_EVENT_TYPE = 'm.call.member';
Expand Down Expand Up @@ -488,6 +492,9 @@ export const MatrixProvider: React.FC<MatrixProviderProps> = ({ children }) => {
const roomHistoryLoadRef = React.useRef<Map<string, Promise<void>>>(
new Map(),
);
const roomHistoryLastLoadedAtRef = React.useRef<Map<string, number>>(
new Map(),
);
const [registeredRoomListeners, setRegisteredRoomListeners] = React.useState<
RoomMessageListenerRecord[]
>([]);
Expand Down Expand Up @@ -1283,25 +1290,59 @@ export const MatrixProvider: React.FC<MatrixProviderProps> = ({ children }) => {
return;
}

const pageSize = Math.max(10, options?.pageSize ?? 50);
const maxBatches = Math.max(1, options?.maxBatches ?? 40);
const now = Date.now();
const lastLoadedAt = roomHistoryLastLoadedAtRef.current.get(roomId) ?? 0;
const hasRecentLoad =
now - lastLoadedAt < MATRIX_HISTORY_RECENT_LOAD_COOLDOWN_MS;
const existingEventsCount = room.getLiveTimeline().getEvents().length;
if (
hasRecentLoad ||
existingEventsCount >= MATRIX_HISTORY_TARGET_EVENTS
) {
return;
}

const pageSize = Math.max(10, options?.pageSize ?? 25);
const maxBatches = Math.max(1, options?.maxBatches ?? 8);
const loadPromise = (async () => {
let rateLimitRetries = 0;
for (let i = 0; i < maxBatches; i++) {
const beforeCount = room.getLiveTimeline().getEvents().length;
try {
if (i > 0) {
await delay(MATRIX_HISTORY_BATCH_DELAY_MS);
}
await client.scrollback(room, pageSize);
} catch (error) {
if (
isMatrixRateLimitedError(error) &&
rateLimitRetries < MATRIX_HISTORY_RATE_LIMIT_MAX_RETRIES
) {
const backoffMs = matrixRateLimitBackoffMs(
error,
rateLimitRetries,
);
rateLimitRetries += 1;
await delay(backoffMs);
i -= 1;
continue;
}
console.warn(
'[MatrixProvider] Failed while loading room history:',
error,
);
break;
}
rateLimitRetries = 0;
const afterCount = room.getLiveTimeline().getEvents().length;
if (afterCount <= beforeCount) {
break;
}
if (afterCount >= MATRIX_HISTORY_TARGET_EVENTS) {
break;
}
}
roomHistoryLastLoadedAtRef.current.set(roomId, Date.now());
})();

roomHistoryLoadRef.current.set(roomId, loadPromise);
Expand Down
Loading