mirror of
https://github.com/vector-im/element-call.git
synced 2026-02-26 05:17:04 +00:00
b0587fcfb3
* Avoid reactivity bugs in how we track external state
Many of our hooks which attempt to bridge external state from an EventEmitter or EventTarget into React had subtle bugs which could cause them to fail to react to certain updates. The conditions necessary for triggering these bugs are explained by the tests that I've included.
In the majority of cases, I don't think we were triggering these bugs in practice. They could've become problems if we refactored our components in certain ways. The one concrete case I'm aware of in which we actually triggered such a bug was the race condition with the useRoomEncryptionSystem shared secret logic (addressed by a1110af6d5).
But, particularly with all the weird reactivity issues we're debugging this week, I think we need to eliminate the possibility that any of the bugs in these hooks are the cause of our current headaches.
* Reuse useTypedEventEmitterState in useLocalStorage
* Fix type error
38 lines
1.1 KiB
TypeScript
38 lines
1.1 KiB
TypeScript
/*
|
|
Copyright 2022-2024 New Vector Ltd.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE in the repository root for full details.
|
|
*/
|
|
|
|
import { useCallback } from "react";
|
|
import {
|
|
type RoomState,
|
|
RoomStateEvent,
|
|
type Room,
|
|
RoomEvent,
|
|
} from "matrix-js-sdk";
|
|
|
|
import { useTypedEventEmitterState } from "../useEvents";
|
|
|
|
/**
|
|
* A React hook for values computed from room state.
|
|
* @param room The room.
|
|
* @param f A mapping from the current room state to the computed value.
|
|
* @returns The computed value.
|
|
*/
|
|
export function useRoomState<T>(room: Room, f: (state: RoomState) => T): T {
|
|
// TODO: matrix-js-sdk says that Room.currentState is deprecated, but it's not
|
|
// clear how to reactively track the current state of the room without it
|
|
const currentState = useTypedEventEmitterState(
|
|
room,
|
|
RoomEvent.CurrentStateUpdated,
|
|
useCallback(() => room.currentState, [room]),
|
|
);
|
|
return useTypedEventEmitterState(
|
|
currentState,
|
|
RoomStateEvent.Update,
|
|
useCallback(() => f(currentState), [f, currentState]),
|
|
);
|
|
}
|