Skip to content

Use the JoinRuleSettings component for the guest link access prompt. #28614

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

Merged
merged 3 commits into from
May 2, 2025
Merged

Use the JoinRuleSettings component for the guest link access prompt. #28614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf01a12
Use the JoinRuleSettings component for the guest link access prompt.
toger5 Dec 2, 2024
d18a145
increase timeout
toger5 May 2, 2025
6f9035a
fix tests
toger5 May 2, 2025
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
12 changes: 12 additions & 0 deletions res/css/views/settings/_JoinRuleSettings.pcss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ Please see LICENSE files in the repository root for full details.
display: block;
}

&.mx_StyledRadioButton_disabled {
opacity: 0.5;
}

&.mx_StyledRadioButton_disabled + span {
opacity: 0.5;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this from a design? In general I'd prefer things to just be actual colours rather than rely on opacity blending with the background.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not from design but a conscious decision. This way any styling inside the element (like the black title vs grey subtitle) will get adjusted accordingly.


& + span {
display: inline-block;
margin-left: 34px;
Expand All @@ -71,3 +79,7 @@ Please see LICENSE files in the repository root for full details.
font: var(--cpd-font-body-md-regular);
margin-top: var(--cpd-space-2x);
}

.mx_JoinRuleSettings_recommended {
color: $accent-1000;
}
46 changes: 23 additions & 23 deletions src/components/views/rooms/RoomHeader/CallGuestLinkButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ import { EventType, JoinRule, type Room } from "matrix-js-sdk/src/matrix";
import Modal from "../../../../Modal";
import { ShareDialog } from "../../dialogs/ShareDialog";
import { _t } from "../../../../languageHandler";
import SettingsStore from "../../../../settings/SettingsStore";
import { calculateRoomVia } from "../../../../utils/permalinks/Permalinks";
import BaseDialog from "../../dialogs/BaseDialog";
import { useGuestAccessInformation } from "../../../../hooks/room/useGuestAccessInformation";
import JoinRuleSettings from "../../settings/JoinRuleSettings";
import SettingsStore from "../../../../settings/SettingsStore";

/**
* Display a button to open a dialog to share a link to the call using a element call guest spa url (`element_call:guest_spa_url` in the EW config).
Expand Down Expand Up @@ -114,33 +115,32 @@ export const JoinRuleDialog: React.FC<{
"",
);
// Show the dialog for a bit to give the user feedback
setTimeout(() => onFinished(), 500);
setTimeout(() => onFinished(), 1000);
},
[isUpdating, onFinished, room.client, room.roomId],
);
return (
<BaseDialog title={_t("update_room_access_modal|title")} onFinished={onFinished} className="mx_JoinRuleDialog">
<p>{_t("update_room_access_modal|description")}</p>
<div className="mx_JoinRuleDialogButtons">
{askToJoinEnabled && canInvite && (
<Button
kind="secondary"
className="mx_Dialog_nonDialogButton"
disabled={isUpdating === JoinRule.Knock}
onClick={() => changeJoinRule(JoinRule.Knock)}
>
{_t("action|ask_to_join")}
</Button>
)}
<Button
className="mx_Dialog_nonDialogButton"
kind="destructive"
disabled={isUpdating === JoinRule.Public}
onClick={() => changeJoinRule(JoinRule.Public)}
>
{_t("common|public")}
</Button>
</div>
<p>{_t("update_room_access_modal|description", {}, { b: (sub) => <strong>{sub}</strong> })}</p>
<p>
{_t("update_room_access_modal|revert_access_description", {}, { b: (sub) => <strong>{sub}</strong> })}
</p>
<JoinRuleSettings
recommendedOption={JoinRule.Knock}
room={room}
disabledOptions={new Set([JoinRule.Invite, JoinRule.Private, JoinRule.Restricted])}
hiddenOptions={
new Set([JoinRule.Restricted].concat(askToJoinEnabled && canInvite ? [] : [JoinRule.Knock]))
}
beforeChange={async (newRule) => {
await changeJoinRule(newRule).catch(() => {
return false;
});
return true;
}}
closeSettingsFn={() => {}}
onError={(error: unknown) => logger.error("Could not generate change access level:", error)}
/>
<p>{_t("update_room_access_modal|dont_change_description")}</p>
<div className="mx_JoinRuleDialogButtons">
<Button
Expand Down
30 changes: 23 additions & 7 deletions src/components/views/settings/JoinRuleSettings.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ export interface JoinRuleSettingsProps {
onError(error: unknown): void;
beforeChange?(joinRule: JoinRule): Promise<boolean>; // if returns false then aborts the change
aliasWarning?: ReactNode;
disabledOptions?: Set<JoinRule>;
hiddenOptions?: Set<JoinRule>;
recommendedOption?: JoinRule;
}

const JoinRuleSettings: React.FC<JoinRuleSettingsProps> = ({
Expand All @@ -45,6 +48,9 @@ const JoinRuleSettings: React.FC<JoinRuleSettingsProps> = ({
onError,
beforeChange,
closeSettingsFn,
disabledOptions,
hiddenOptions,
recommendedOption,
}) => {
const cli = room.client;

Expand Down Expand Up @@ -147,7 +153,7 @@ const JoinRuleSettings: React.FC<JoinRuleSettingsProps> = ({
}
});

closeSettingsFn();
closeSettingsFn?.();

// switch to the new room in the background
dis.dispatch<ViewRoomPayload>({
Expand All @@ -170,18 +176,26 @@ const JoinRuleSettings: React.FC<JoinRuleSettingsProps> = ({
{_t("room_settings|security|join_rule_upgrade_required")}
</span>
);
const withRecommendLabel = (label: string, rule: JoinRule): React.ReactNode =>
rule === recommendedOption ? (
<>
{label} (<span className="mx_JoinRuleSettings_recommended">{_t("common|recommended")}</span>)
</>
) : (
label
);

const definitions: IDefinition<JoinRule>[] = [
{
value: JoinRule.Invite,
label: _t("room_settings|security|join_rule_invite"),
label: withRecommendLabel(_t("room_settings|security|join_rule_invite"), JoinRule.Invite),
description: _t("room_settings|security|join_rule_invite_description"),
checked:
joinRule === JoinRule.Invite || (joinRule === JoinRule.Restricted && !restrictedAllowRoomIds?.length),
},
{
value: JoinRule.Public,
label: _t("common|public"),
label: withRecommendLabel(_t("common|public"), JoinRule.Public),
description: (
<>
{_t("room_settings|security|join_rule_public_description")}
Expand Down Expand Up @@ -292,7 +306,7 @@ const JoinRuleSettings: React.FC<JoinRuleSettingsProps> = ({
value: JoinRule.Restricted,
label: (
<>
{_t("room_settings|security|join_rule_restricted")}
{withRecommendLabel(_t("room_settings|security|join_rule_restricted"), JoinRule.Restricted)}
{preferredRestrictionVersion && upgradeRequiredPill}
</>
),
Expand All @@ -303,11 +317,11 @@ const JoinRuleSettings: React.FC<JoinRuleSettingsProps> = ({
}

if (askToJoinEnabled && (roomSupportsKnock || preferredKnockVersion)) {
definitions.push({
definitions.splice(Math.max(0, definitions.length - 1), 0, {
value: JoinRule.Knock,
label: (
<>
{_t("room_settings|security|join_rule_knock")}
{withRecommendLabel(_t("room_settings|security|join_rule_knock"), JoinRule.Knock)}
{preferredKnockVersion && upgradeRequiredPill}
</>
),
Expand Down Expand Up @@ -397,7 +411,9 @@ const JoinRuleSettings: React.FC<JoinRuleSettingsProps> = ({
name="joinRule"
value={joinRule}
onChange={onChange}
definitions={definitions}
definitions={definitions
.map((d) => (disabledOptions?.has(d.value) ? { ...d, disabled: true } : d))
.filter((d) => !hiddenOptions?.has(d.value))}
disabled={disabled}
className="mx_JoinRuleSettings_radioButton"
/>
Expand Down
7 changes: 4 additions & 3 deletions src/i18n/strings/en_EN.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3804,10 +3804,11 @@
"unavailable": "Unavailable"
},
"update_room_access_modal": {
"description": "To create a share link, you need to allow guests to join this room. This may make the room less secure. When you're done with the call, you can make the room private again.",
"dont_change_description": "Alternatively, you can hold the call in a separate room.",
"description": "To create a share link, make this room <b>public</b> or enable the option for users to <b>ask to join</b>. This allows guests to join without being invited.",
"dont_change_description": "If you don't want to change the access of this room, you can create a new room for the call link.",
"no_change": "I don't want to change the access level.",
"title": "Change the room access level"
"revert_access_description": "(This can be reverted to the previous value in the Room Settings: <b>Security & Privacy</b> / <b>Access</b>)",
"title": "Allow guest users to join this room"
},
"upload_failed_generic": "The file '%(fileName)s' failed to upload.",
"upload_failed_size": "The file '%(fileName)s' exceeds this homeserver's size limit for uploads",
Expand Down
19 changes: 11 additions & 8 deletions test/unit-tests/components/views/rooms/RoomHeader/CallGuestLinkButton-test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,11 @@ describe("<CallGuestLinkButton />", () => {
*/
const makeRoom = (isVideoRoom = true): Room => {
const room = new Room(roomId, sdkContext.client!, sdkContext.client!.getSafeUserId());
sdkContext.client!.getRoomDirectoryVisibility = jest.fn().mockResolvedValue("public");
jest.spyOn(room, "isElementVideoRoom").mockReturnValue(isVideoRoom);
// stub
jest.spyOn(room, "getPendingEvents").mockReturnValue([]);
jest.spyOn(room, "getVersion").mockReturnValue("9");
return room;
};
function mockRoomMembers(room: Room, count: number) {
Expand Down Expand Up @@ -221,32 +223,33 @@ describe("<CallGuestLinkButton />", () => {
});

it("shows ask to join if feature is enabled", () => {
const { container } = getComponent(room);
expect(getByText(container, "Ask to join")).toBeInTheDocument();
getComponent(room);
expect(screen.getByRole("radio", { name: "Ask to join ( Recommended )" })).toBeInTheDocument();
});
it("font show ask to join if feature is enabled but cannot invite", () => {
it("dont show ask to join if feature is enabled but cannot invite", () => {
getComponent(room, false);
expect(screen.queryByText("Ask to join")).not.toBeInTheDocument();
expect(screen.queryByRole("radio", { name: "Ask to join ( Recommended )" })).not.toBeInTheDocument();
});
it("doesn't show ask to join if feature is disabled", () => {
jest.spyOn(SettingsStore, "getValue").mockReturnValue(false);
getComponent(room);
expect(screen.queryByText("Ask to join")).not.toBeInTheDocument();
expect(screen.queryByRole("radio", { name: "Ask to join ( Recommended )" })).not.toBeInTheDocument();
});

it("sends correct state event on click", async () => {
const sendStateSpy = jest.spyOn(sdkContext.client!, "sendStateEvent");

let container;
container = getComponent(room).container;
fireEvent.click(getByText(container, "Ask to join"));
fireEvent.click(screen.getByRole("radio", { name: "Ask to join ( Recommended )" }));
expect(sendStateSpy).toHaveBeenCalledWith(
"!room:server.org",
"m.room.join_rules",
{ join_rule: "knock" },
"",
);
expect(sendStateSpy).toHaveBeenCalledTimes(1);
await waitFor(() => expect(onFinished).toHaveBeenCalledTimes(1));
await waitFor(() => expect(onFinished).toHaveBeenCalledTimes(1), { timeout: 3000 });
onFinished.mockClear();
sendStateSpy.mockClear();

Expand All @@ -260,7 +263,7 @@ describe("<CallGuestLinkButton />", () => {
);
expect(sendStateSpy).toHaveBeenCalledTimes(1);
container = getComponent(room).container;
await waitFor(() => expect(onFinished).toHaveBeenCalledTimes(1));
await waitFor(() => expect(onFinished).toHaveBeenCalledTimes(1), { timeout: 3000 });
onFinished.mockClear();
sendStateSpy.mockClear();

Expand Down
Loading