PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Replace setImmediate with setTimeout (#12614)

Browse source
This commit is contained in:
Michael Telatynski 2024-06-13 15:15:59 +01:00 committed by GitHub
parent 21ae29c002
commit 8b4e3e6647
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
21 changed files with 46 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
.eslintrc.js
View file

@ -34,6 +34,14 @@ module.exports = {
["*.mxcUrlToHttp", "*.getHttpUriForMxc"],
"Use Media helper instead to centralise access for customisation.",
),
...buildRestrictedPropertiesOptions(["window.setImmediate"], "Use setTimeout instead."),
],
"no-restricted-globals": [
"error",
{
name: "setImmediate",
message: "Use setTimeout instead.",
},
],
"import/no-duplicates": ["error"],

2
src/Lifecycle.ts
View file

@ -920,7 +920,7 @@ export function logout(oidcClientStore?: OidcClientStore): void {
// logout doesn't work for guest sessions
// Also we sometimes want to re-log in a guest session if we abort the login.
// defer until next tick because it calls a synchronous dispatch, and we are likely here from a dispatch.
setImmediate(() => onLoggedOut());
setTimeout(onLoggedOut, 0);
return;
}

2
src/Modal.tsx
View file

@ -422,7 +422,7 @@ export class ModalManager extends TypedEventEmitter<ModalManagerEvent, HandlerMa
</div>
);
setImmediate(() => ReactDOM.render(dialog, ModalManager.getOrCreateContainer()));
setTimeout(() => ReactDOM.render(dialog, ModalManager.getOrCreateContainer()), 0);
} else {
// This is safe to call repeatedly if we happen to do that
ReactDOM.unmountComponentAtNode(ModalManager.getOrCreateContainer());

4
src/components/structures/ContextMenu.tsx
View file

@ -170,7 +170,7 @@ export default class ContextMenu extends React.PureComponent<React.PropsWithChil
// XXX: This isn't pretty but the only way to allow opening a different context menu on right click whilst
// a context menu and its click-guard are up without completely rewriting how the context menus work.
setImmediate(() => {
setTimeout(() => {
const clickEvent = new MouseEvent("contextmenu", {
clientX: x,
clientY: y,
@ -180,7 +180,7 @@ export default class ContextMenu extends React.PureComponent<React.PropsWithChil
relatedTarget: null,
});
document.elementFromPoint(x, y)?.dispatchEvent(clickEvent);
});
}, 0);
}
};

2
src/components/structures/PictureInPictureDragger.tsx
View file

@ -232,7 +232,7 @@ export default class PictureInPictureDragger extends React.Component<IProps> {
this.mouseHeld = false;
// Delaying this to the next event loop tick is necessary for click
// event cancellation to work
setImmediate(() => (this.moving = false));
setTimeout(() => (this.moving = false));
this.snap(true);
};

2
src/components/views/dialogs/BulkRedactDialog.tsx
View file

@ -126,7 +126,7 @@ const BulkRedactDialog: React.FC<Props> = (props) => {
primaryButtonClass="danger"
primaryDisabled={count === 0}
onPrimaryButtonClick={() => {
setImmediate(redact);
setTimeout(redact, 0);
onFinished(true);
}}
onCancel={() => onFinished(false)}

2
src/components/views/dialogs/ForwardDialog.tsx
View file

@ -354,7 +354,7 @@ const ForwardDialog: React.FC<IProps> = ({ matrixClient: cli, event, permalinkCr
placeholder={_t("forward|filter_placeholder")}
onSearch={(query: string): void => {
setQuery(query);
setImmediate(() => {
setTimeout(() => {
const ref = context.state.refs[0];
if (ref) {
context.dispatch({

2
src/components/views/dialogs/spotlight/SpotlightDialog.tsx
View file

@ -505,7 +505,7 @@ const SpotlightDialog: React.FC<IProps> = ({ initialText = "", initialFilter = n
_setQuery(newQuery);
};
useEffect(() => {
setImmediate(() => {
setTimeout(() => {
const ref = rovingContext.state.refs[0];
if (ref) {
rovingContext.dispatch({

2
src/components/views/rooms/NewRoomIntro.tsx
View file

@ -126,7 +126,7 @@ const NewRoomIntro: React.FC = () => {
true,
);
// focus the topic field to help the user find it as it'll gain an outline
setImmediate(() => {
setTimeout(() => {
window.document.getElementById("profileTopic")?.focus();
});
};

8
src/components/views/rooms/RoomSublist.tsx
View file

@ -289,7 +289,7 @@ export default class RoomSublist extends React.Component<IProps, IState> {
if (payload.action === Action.ViewRoom && payload.show_room_tile && this.state.rooms) {
// XXX: we have to do this a tick later because we have incorrect intermediate props during a room change
// where we lose the room we are changing from temporarily and then it comes back in an update right after.
setImmediate(() => {
setTimeout(() => {
const roomIndex = this.state.rooms.findIndex((r) => r.roomId === payload.room_id);
if (!this.state.isExpanded && roomIndex > -1) {
@ -300,7 +300,7 @@ export default class RoomSublist extends React.Component<IProps, IState> {
this.layout.visibleTiles = this.layout.tilesWithPadding(roomIndex + 1, MAX_PADDING_HEIGHT);
this.forceUpdate(); // because the layout doesn't trigger a re-render
}
});
}, 0);
}
};
@ -457,9 +457,9 @@ export default class RoomSublist extends React.Component<IProps, IState> {
this.toggleCollapsed();
// if the bottom list is collapsed then scroll it in so it doesn't expand off screen
if (!isExpanded && isStickyBottom) {
setImmediate(() => {
setTimeout(() => {
sublist.scrollIntoView({ behavior: "smooth" });
});
}, 0);
}
}
};

2
src/components/views/rooms/RoomTile.tsx
View file

@ -195,7 +195,7 @@ export class RoomTile extends React.PureComponent<ClassProps, State> {
payload.room_id === this.props.room.roomId &&
payload.show_room_tile
) {
setImmediate(() => {
setTimeout(() => {
this.scrollIntoView();
});
}

2
src/stores/room-list/RoomListStore.ts
View file

@ -183,7 +183,7 @@ export class RoomListStoreClass extends AsyncStoreWithClient<IState> implements
// We do this to intentionally break out of the current event loop task, allowing
// us to instead wait for a more convenient time to run our updates.
setImmediate(() => this.onDispatchAsync(payload));
setTimeout(() => this.onDispatchAsync(payload));
}
protected async onDispatchAsync(payload: ActionPayload): Promise<void> {

2
src/stores/room-list/filters/SpaceFilterCondition.ts
View file

@ -62,7 +62,7 @@ export class SpaceFilterCondition extends EventEmitter implements IFilterConditi
this.emit(FILTER_CHANGED);
// XXX: Room List Store has a bug where updates to the pre-filter during a local echo of a
// tags transition seem to be ignored, so refire in the next tick to work around it
setImmediate(() => {
setTimeout(() => {
this.emit(FILTER_CHANGED);
});
}

5
test/components/views/context_menus/RoomGeneralContextMenu-test.tsx
View file

@ -20,6 +20,7 @@ import { ReceiptType, MatrixClient, PendingEventOrdering, Room } from "matrix-js
import { KnownMembership } from "matrix-js-sdk/src/types";
import React from "react";
import userEvent from "@testing-library/user-event";
import { sleep } from "matrix-js-sdk/src/utils";
import { ChevronFace } from "../../../../src/components/structures/ContextMenu";
import {
@ -141,7 +142,7 @@ describe("RoomGeneralContextMenu", () => {
const markAsReadBtn = getByLabelText(container, "Mark as read");
fireEvent.click(markAsReadBtn);
await new Promise(setImmediate);
await sleep(0);
expect(mockClient.sendReadReceipt).toHaveBeenCalledWith(event, ReceiptType.Read, true);
expect(onFinished).toHaveBeenCalled();
@ -155,7 +156,7 @@ describe("RoomGeneralContextMenu", () => {
const markAsUnreadBtn = getByLabelText(container, "Mark as unread");
fireEvent.click(markAsUnreadBtn);
await new Promise(setImmediate);
await sleep(0);
expect(mockClient.setRoomAccountData).toHaveBeenCalledWith(ROOM_ID, "com.famedly.marked_unread", {
unread: true,

5
test/components/views/dialogs/ForwardDialog-test.tsx
View file

@ -26,6 +26,7 @@ import {
} from "matrix-js-sdk/src/matrix";
import { act, fireEvent, getByTestId, render, RenderResult, screen, waitFor } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { sleep } from "matrix-js-sdk/src/utils";
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
import ForwardDialog from "../../../../src/components/views/dialogs/ForwardDialog";
@ -199,7 +200,7 @@ describe("ForwardDialog", () => {
await act(async () => {
cancelSend();
// Wait one tick for the button to realize the send failed
await new Promise((resolve) => setImmediate(resolve));
await sleep(0);
});
update();
expect(firstButton.className).toContain("mx_ForwardList_sendFailed");
@ -215,7 +216,7 @@ describe("ForwardDialog", () => {
await act(async () => {
finishSend();
// Wait one tick for the button to realize the send succeeded
await new Promise((resolve) => setImmediate(resolve));
await sleep(0);
});
update();
expect(secondButton.className).toContain("mx_ForwardList_sent");

5
test/components/views/right_panel/PinnedMessagesCard-test.tsx
View file

@ -32,6 +32,7 @@ import {
import { PollStartEvent } from "matrix-js-sdk/src/extensible_events_v1/PollStartEvent";
import { PollResponseEvent } from "matrix-js-sdk/src/extensible_events_v1/PollResponseEvent";
import { PollEndEvent } from "matrix-js-sdk/src/extensible_events_v1/PollEndEvent";
import { sleep } from "matrix-js-sdk/src/utils";
import { stubClient, mkEvent, mkMessage, flushPromises } from "../../../test-utils";
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
@ -98,7 +99,7 @@ describe("<PinnedMessagesCard />", () => {
</MatrixClientContext.Provider>,
);
// Wait a tick for state updates
await new Promise((resolve) => setImmediate(resolve));
await sleep(0);
});
return pins;
@ -114,7 +115,7 @@ describe("<PinnedMessagesCard />", () => {
// @ts-ignore what is going on here?
pinListener(room.currentState.getStateEvents());
// Wait a tick for state updates
await new Promise((resolve) => setImmediate(resolve));
await sleep(0);
});
};

13
test/components/views/rooms/RoomPreviewBar-test.tsx
View file

@ -18,6 +18,7 @@ import React, { ComponentProps } from "react";
import { render, fireEvent, RenderResult, waitFor } from "@testing-library/react";
import { Room, RoomMember, MatrixError, IContent } from "matrix-js-sdk/src/matrix";
import { KnownMembership } from "matrix-js-sdk/src/types";
import { sleep } from "matrix-js-sdk/src/utils";
import { withClientContextRenderOptions, stubClient } from "../../../test-utils";
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
@ -373,7 +374,7 @@ describe("<RoomPreviewBar />", () => {
const onJoinClick = jest.fn();
const onRejectClick = jest.fn();
const component = getComponent({ ...props, onJoinClick, onRejectClick });
await new Promise(setImmediate);
await sleep(0);
expect(getPrimaryActionButton(component)).toBeTruthy();
if (expectSecondaryButton) expect(getSecondaryActionButton(component)).toBeFalsy();
fireEvent.click(getPrimaryActionButton(component)!);
@ -387,7 +388,7 @@ describe("<RoomPreviewBar />", () => {
it("renders error message", async () => {
const component = getComponent({ inviterName, invitedEmail });
await new Promise(setImmediate);
await sleep(0);
expect(getMessage(component)).toMatchSnapshot();
});
@ -404,7 +405,7 @@ describe("<RoomPreviewBar />", () => {
it("renders invite message with invited email", async () => {
const component = getComponent({ inviterName, invitedEmail });
await new Promise(setImmediate);
await sleep(0);
expect(getMessage(component)).toMatchSnapshot();
});
@ -420,7 +421,7 @@ describe("<RoomPreviewBar />", () => {
it("renders invite message with invited email", async () => {
const component = getComponent({ inviterName, invitedEmail });
await new Promise(setImmediate);
await sleep(0);
expect(getMessage(component)).toMatchSnapshot();
});
@ -438,7 +439,7 @@ describe("<RoomPreviewBar />", () => {
it("renders email mismatch message when invite email mxid doesnt match", async () => {
MatrixClientPeg.safeGet().lookupThreePid = jest.fn().mockReturnValue({ mxid: "not userid" });
const component = getComponent({ inviterName, invitedEmail });
await new Promise(setImmediate);
await sleep(0);
expect(getMessage(component)).toMatchSnapshot();
expect(MatrixClientPeg.safeGet().lookupThreePid).toHaveBeenCalledWith(
@ -452,7 +453,7 @@ describe("<RoomPreviewBar />", () => {
it("renders invite message when invite email mxid match", async () => {
MatrixClientPeg.safeGet().lookupThreePid = jest.fn().mockReturnValue({ mxid: userId });
const component = getComponent({ inviterName, invitedEmail });
await new Promise(setImmediate);
await sleep(0);
expect(getMessage(component)).toMatchSnapshot();
await testJoinButton({ inviterName, invitedEmail }, false)();

5
test/setup/setupManualMocks.ts
View file

@ -18,11 +18,6 @@ import fetchMock from "fetch-mock-jest";
import { TextDecoder, TextEncoder } from "util";
import { Response } from "node-fetch";
// jest 27 removes setImmediate from jsdom
// polyfill until setImmediate use in client can be removed
// @ts-ignore - we know the contract is wrong. That's why we're stubbing it.
global.setImmediate = (callback) => window.setTimeout(callback, 0);
// Stub ResizeObserver
// @ts-ignore - we know it's a duplicate (that's why we're stubbing it)
class ResizeObserver {

7
test/stores/LifecycleStore-test.ts
View file

@ -16,6 +16,7 @@ limitations under the License.
import { mocked } from "jest-mock";
import { SyncState } from "matrix-js-sdk/src/matrix";
import { sleep } from "matrix-js-sdk/src/utils";
import { MatrixClientPeg } from "../../src/MatrixClientPeg";
import ToastStore from "../../src/stores/ToastStore";
@ -40,7 +41,7 @@ describe("LifecycleStore", () => {
prevState: SyncState.Prepared,
});
await new Promise(setImmediate);
await sleep(0);
expect(addOrReplaceToast).not.toHaveBeenCalledWith(
expect.objectContaining({
@ -58,7 +59,7 @@ describe("LifecycleStore", () => {
prevState: SyncState.Prepared,
});
await new Promise(setImmediate);
await sleep(0);
expect(addOrReplaceToast).toHaveBeenCalledWith(
expect.objectContaining({
@ -77,7 +78,7 @@ describe("LifecycleStore", () => {
prevState: SyncState.Prepared,
});
await new Promise(setImmediate);
await sleep(0);
addOrReplaceToast.mock.calls[0][0].props.onAccept();

2
test/stores/room-list/RoomListStore-test.ts
View file

@ -323,7 +323,6 @@ describe("RoomListStore", () => {
const algorithmSpy = jest.spyOn(store.algorithm, "handleRoomUpdate").mockReturnValue(undefined);
// @ts-ignore cheat and call protected fn
store.onAction({ action: "MatrixActions.accountData", event, previousEvent });
// flush setImmediate
await flushPromises();
expect(algorithmSpy).toHaveBeenCalledWith(normalRoom, RoomUpdateCause.PossibleMuteChange);
@ -346,7 +345,6 @@ describe("RoomListStore", () => {
// @ts-ignore cheat and call protected fn
store.onAction({ action: "MatrixActions.accountData", event, previousEvent });
// flush setImmediate
await flushPromises();
// only one call to update made for normalRoom

3
test/utils/leave-behaviour-test.ts
View file

@ -16,6 +16,7 @@ limitations under the License.
import { mocked, Mocked } from "jest-mock";
import { MatrixClient, Room } from "matrix-js-sdk/src/matrix";
import { sleep } from "matrix-js-sdk/src/utils";
import { MatrixClientPeg } from "../../src/MatrixClientPeg";
import { mkRoom, resetAsyncStoreWithClient, setupAsyncStoreWithClient, stubClient } from "../test-utils";
@ -78,7 +79,7 @@ describe("leaveRoomBehaviour", () => {
const expectDispatch = async <T extends ActionPayload>(payload: T) => {
const dispatcherSpy = jest.fn();
const dispatcherRef = defaultDispatcher.register(dispatcherSpy);
await new Promise<void>((resolve) => setImmediate(resolve)); // Flush the dispatcher
await sleep(0);
expect(dispatcherSpy).toHaveBeenCalledWith(payload);
defaultDispatcher.unregister(dispatcherRef);
};