Skip to content
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.

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

Reset power selector on API failure to prevent state mismatch #12319

Merged
merged 5 commits into from
Mar 8, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
18 changes: 13 additions & 5 deletions src/components/views/elements/PowerSelector.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ interface Props<K extends undefined | string> {
// The name to annotate the selector with
label?: string;

onChange(value: number, powerLevelKey: K extends undefined ? void : K): void;
onChange(value: number, powerLevelKey: K extends undefined ? void : K): void | Promise<void>;

// Optional key to pass as the second argument to `onChange`
powerLevelKey: K extends undefined ? void : K;
Expand Down Expand Up @@ -106,27 +106,35 @@ export default class PowerSelector<K extends undefined | string> extends React.C
});
}

private onSelectChange = (event: React.ChangeEvent<HTMLSelectElement>): void => {
private onSelectChange = async (event: React.ChangeEvent<HTMLSelectElement>): Promise<void> => {
const isCustom = event.target.value === CUSTOM_VALUE;
if (isCustom) {
this.setState({ custom: true });
} else {
const powerLevel = parseInt(event.target.value);
this.props.onChange(powerLevel, this.props.powerLevelKey);
this.setState({ selectValue: powerLevel });
try {
await this.props.onChange(powerLevel, this.props.powerLevelKey);
} catch {
this.initStateFromProps();
t3chguy marked this conversation as resolved.
Show resolved Hide resolved
}
t3chguy marked this conversation as resolved.
Show resolved Hide resolved
}
};

private onCustomChange = (event: React.ChangeEvent<HTMLInputElement>): void => {
this.setState({ customValue: parseInt(event.target.value) });
};

private onCustomBlur = (event: React.FocusEvent): void => {
private onCustomBlur = async (event: React.FocusEvent): Promise<void> => {
event.preventDefault();
event.stopPropagation();

if (Number.isFinite(this.state.customValue)) {
this.props.onChange(this.state.customValue, this.props.powerLevelKey);
try {
await this.props.onChange(this.state.customValue, this.props.powerLevelKey);
} catch {
this.initStateFromProps();
t3chguy marked this conversation as resolved.
Show resolved Hide resolved
}
} else {
this.initStateFromProps(); // reset, invalid input
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ export default class RolesRoomSettingsTab extends React.Component<IProps> {
}
}

private onPowerLevelsChanged = (value: number, powerLevelKey: string): void => {
private onPowerLevelsChanged = async (value: number, powerLevelKey: string): Promise<void> => {
const client = this.context;
const room = this.props.room;
const plEvent = room.currentState.getStateEvents(EventType.RoomPowerLevels, "");
Expand Down Expand Up @@ -203,17 +203,22 @@ export default class RolesRoomSettingsTab extends React.Component<IProps> {
parentObj[keyPath[keyPath.length - 1]] = value;
}

client.sendStateEvent(this.props.room.roomId, EventType.RoomPowerLevels, plContent).catch((e) => {
try {
await client.sendStateEvent(this.props.room.roomId, EventType.RoomPowerLevels, plContent);
} catch (e) {
logger.error(e);

Modal.createDialog(ErrorDialog, {
title: _t("room_settings|permissions|error_changing_pl_reqs_title"),
description: _t("room_settings|permissions|error_changing_pl_reqs_description"),
});
});

// Rethrow so that the PowerSelector can roll back
throw e;
}
};

private onUserPowerLevelChanged = (value: number, powerLevelKey: string): void => {
private onUserPowerLevelChanged = async (value: number, powerLevelKey: string): Promise<void> => {
const client = this.context;
const room = this.props.room;
const plEvent = room.currentState.getStateEvents(EventType.RoomPowerLevels, "");
Expand All @@ -226,14 +231,19 @@ export default class RolesRoomSettingsTab extends React.Component<IProps> {
if (!plContent["users"]) plContent["users"] = {};
plContent["users"][powerLevelKey] = value;

client.sendStateEvent(this.props.room.roomId, EventType.RoomPowerLevels, plContent).catch((e) => {
try {
await client.sendStateEvent(this.props.room.roomId, EventType.RoomPowerLevels, plContent);
} catch (e) {
logger.error(e);

Modal.createDialog(ErrorDialog, {
title: _t("room_settings|permissions|error_changing_pl_title"),
description: _t("room_settings|permissions|error_changing_pl_description"),
});
});

// Rethrow so that the PowerSelector can roll back
throw e;
}
};

public render(): React.ReactNode {
Expand Down
22 changes: 22 additions & 0 deletions test/components/views/elements/PowerSelector-test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ limitations under the License.

import React from "react";
import { fireEvent, render, screen } from "@testing-library/react";
import { defer } from "matrix-js-sdk/src/utils";

import PowerSelector from "../../../../src/components/views/elements/PowerSelector";

Expand Down Expand Up @@ -75,4 +76,25 @@ describe("<PowerSelector />", () => {
expect(option.selected).toBeTruthy();
expect(fn).not.toHaveBeenCalled();
});

it("should reset when onChange promise rejects", async () => {
const deferred = defer<void>();
render(
<PowerSelector
value={25}
maxValue={100}
usersDefault={0}
onChange={() => deferred.promise}
powerLevelKey="key"
/>,
);

const input = screen.getByLabelText("Power level");
fireEvent.change(input, { target: { value: 40 } });
fireEvent.blur(input);

await screen.findByDisplayValue(40);
deferred.reject("Some error");
await screen.findByDisplayValue(25);
});
});
Loading