Device manager - extract device deletion logic into util (#9168)

* extract deletedevices logic into util fn

* unit test deleteDevices

* test devicespanel device deletion

* remove debug logs

* i18n

* assert more on deleteMultipleDevices calls
This commit is contained in:
Kerry 2022-08-10 18:26:48 +02:00 committed by GitHub
parent b7872f2ff7
commit f020ed0b13
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 764 additions and 71 deletions

View file

@ -22,12 +22,10 @@ import { CrossSigningInfo } from "matrix-js-sdk/src/crypto/CrossSigning";
import { MatrixClientPeg } from '../../../MatrixClientPeg';
import { _t } from '../../../languageHandler';
import Modal from '../../../Modal';
import { SSOAuthEntry } from "../auth/InteractiveAuthEntryComponents";
import InteractiveAuthDialog from "../dialogs/InteractiveAuthDialog";
import DevicesPanelEntry from "./DevicesPanelEntry";
import Spinner from "../elements/Spinner";
import AccessibleButton from "../elements/AccessibleButton";
import { deleteDevicesWithInteractiveAuth } from './devices/deleteDevices';
interface IProps {
className?: string;
@ -79,7 +77,6 @@ export default class DevicesPanel extends React.Component<IProps, IState> {
crossSigningInfo: crossSigningInfo,
};
});
console.log(this.state);
},
(error) => {
if (this.unmounted) { return; }
@ -178,76 +175,38 @@ export default class DevicesPanel extends React.Component<IProps, IState> {
});
};
private onDeleteClick = (): void => {
private onDeleteClick = async (): Promise<void> => {
if (this.state.selectedDevices.length === 0) { return; }
this.setState({
deleting: true,
});
this.makeDeleteRequest(null).catch((error) => {
if (this.unmounted) { return; }
if (error.httpStatus !== 401 || !error.data || !error.data.flows) {
// doesn't look like an interactive-auth failure
throw error;
}
// pop up an interactive auth dialog
const numDevices = this.state.selectedDevices.length;
const dialogAesthetics = {
[SSOAuthEntry.PHASE_PREAUTH]: {
title: _t("Use Single Sign On to continue"),
body: _t("Confirm logging out these devices by using Single Sign On to prove your identity.", {
count: numDevices,
}),
continueText: _t("Single Sign On"),
continueKind: "primary",
try {
await deleteDevicesWithInteractiveAuth(
MatrixClientPeg.get(),
this.state.selectedDevices,
(success) => {
if (success) {
// Reset selection to [], update device list
this.setState({
selectedDevices: [],
});
this.loadDevices();
}
this.setState({
deleting: false,
});
},
[SSOAuthEntry.PHASE_POSTAUTH]: {
title: _t("Confirm signing out these devices", {
count: numDevices,
}),
body: _t("Click the button below to confirm signing out these devices.", {
count: numDevices,
}),
continueText: _t("Sign out devices", { count: numDevices }),
continueKind: "danger",
},
};
Modal.createDialog(InteractiveAuthDialog, {
title: _t("Authentication"),
matrixClient: MatrixClientPeg.get(),
authData: error.data,
makeRequest: this.makeDeleteRequest.bind(this),
aestheticsForStagePhases: {
[SSOAuthEntry.LOGIN_TYPE]: dialogAesthetics,
[SSOAuthEntry.UNSTABLE_LOGIN_TYPE]: dialogAesthetics,
},
});
}).catch((e) => {
logger.error("Error deleting sessions", e);
if (this.unmounted) { return; }
}).finally(() => {
);
} catch (error) {
logger.error("Error deleting sessions", error);
this.setState({
deleting: false,
});
});
}
};
// TODO: proper typing for auth
private makeDeleteRequest(auth?: any): Promise<any> {
return MatrixClientPeg.get().deleteMultipleDevices(this.state.selectedDevices, auth).then(
() => {
// Reset selection to [], update device list
this.setState({
selectedDevices: [],
});
this.loadDevices();
},
);
}
private renderDevice = (device: IMyDevice): JSX.Element => {
const myDeviceId = MatrixClientPeg.get().getDeviceId();
const myDevice = this.state.devices.find((device) => (device.device_id === myDeviceId));
@ -289,6 +248,7 @@ export default class DevicesPanel extends React.Component<IProps, IState> {
const myDeviceId = MatrixClientPeg.get().getDeviceId();
const myDevice = devices.find((device) => (device.device_id === myDeviceId));
if (!myDevice) {
return loadError;
}
@ -373,6 +333,7 @@ export default class DevicesPanel extends React.Component<IProps, IState> {
onClick={this.onDeleteClick}
kind="danger_outline"
disabled={this.state.selectedDevices.length === 0}
data-testid='sign-out-devices-btn'
>
{ _t("Sign out %(count)s selected devices", { count: this.state.selectedDevices.length }) }
</AccessibleButton>;

View file

@ -0,0 +1,83 @@
/*
Copyright 2022 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import { MatrixClient } from "matrix-js-sdk/src/matrix";
import { IAuthData } from "matrix-js-sdk/src/interactive-auth";
import { _t } from "../../../../languageHandler";
import Modal from "../../../../Modal";
import { InteractiveAuthCallback } from "../../../structures/InteractiveAuth";
import { SSOAuthEntry } from "../../auth/InteractiveAuthEntryComponents";
import InteractiveAuthDialog from "../../dialogs/InteractiveAuthDialog";
const makeDeleteRequest = (
matrixClient: MatrixClient, deviceIds: string[],
) => async (auth?: IAuthData): Promise<void> => {
await matrixClient.deleteMultipleDevices(deviceIds, auth);
};
export const deleteDevicesWithInteractiveAuth = async (
matrixClient: MatrixClient, deviceIds: string[], onFinished?: InteractiveAuthCallback,
) => {
if (!deviceIds.length) {
return;
}
try {
await makeDeleteRequest(matrixClient, deviceIds)();
// no interactive auth needed
onFinished(true, undefined);
} catch (error) {
if (error.httpStatus !== 401 || !error.data?.flows) {
// doesn't look like an interactive-auth failure
throw error;
}
// pop up an interactive auth dialog
const numDevices = deviceIds.length;
const dialogAesthetics = {
[SSOAuthEntry.PHASE_PREAUTH]: {
title: _t("Use Single Sign On to continue"),
body: _t("Confirm logging out these devices by using Single Sign On to prove your identity.", {
count: numDevices,
}),
continueText: _t("Single Sign On"),
continueKind: "primary",
},
[SSOAuthEntry.PHASE_POSTAUTH]: {
title: _t("Confirm signing out these devices", {
count: numDevices,
}),
body: _t("Click the button below to confirm signing out these devices.", {
count: numDevices,
}),
continueText: _t("Sign out devices", { count: numDevices }),
continueKind: "danger",
},
};
Modal.createDialog(InteractiveAuthDialog, {
title: _t("Authentication"),
matrixClient: matrixClient,
authData: error.data,
onFinished,
makeRequest: makeDeleteRequest(matrixClient, deviceIds),
aestheticsForStagePhases: {
[SSOAuthEntry.LOGIN_TYPE]: dialogAesthetics,
[SSOAuthEntry.UNSTABLE_LOGIN_TYPE]: dialogAesthetics,
},
});
}
};

View file

@ -1284,15 +1284,6 @@
"Session key:": "Session key:",
"Your homeserver does not support device management.": "Your homeserver does not support device management.",
"Unable to load device list": "Unable to load device list",
"Confirm logging out these devices by using Single Sign On to prove your identity.|other": "Confirm logging out these devices by using Single Sign On to prove your identity.",
"Confirm logging out these devices by using Single Sign On to prove your identity.|one": "Confirm logging out this device by using Single Sign On to prove your identity.",
"Confirm signing out these devices|other": "Confirm signing out these devices",
"Confirm signing out these devices|one": "Confirm signing out this device",
"Click the button below to confirm signing out these devices.|other": "Click the button below to confirm signing out these devices.",
"Click the button below to confirm signing out these devices.|one": "Click the button below to confirm signing out this device.",
"Sign out devices|other": "Sign out devices",
"Sign out devices|one": "Sign out device",
"Authentication": "Authentication",
"Deselect all": "Deselect all",
"Select all": "Select all",
"Verified devices": "Verified devices",
@ -1692,6 +1683,15 @@
"Please enter verification code sent via text.": "Please enter verification code sent via text.",
"Verification code": "Verification code",
"Discovery options will appear once you have added a phone number above.": "Discovery options will appear once you have added a phone number above.",
"Confirm logging out these devices by using Single Sign On to prove your identity.|other": "Confirm logging out these devices by using Single Sign On to prove your identity.",
"Confirm logging out these devices by using Single Sign On to prove your identity.|one": "Confirm logging out this device by using Single Sign On to prove your identity.",
"Confirm signing out these devices|other": "Confirm signing out these devices",
"Confirm signing out these devices|one": "Confirm signing out this device",
"Click the button below to confirm signing out these devices.|other": "Click the button below to confirm signing out these devices.",
"Click the button below to confirm signing out these devices.|one": "Click the button below to confirm signing out this device.",
"Sign out devices|other": "Sign out devices",
"Sign out devices|one": "Sign out device",
"Authentication": "Authentication",
"Last activity": "Last activity",
"Verified": "Verified",
"Unverified": "Unverified",