Update references to QrCodeEvent, SasEvent and VerificationEvent (#10991)

* Basic test for IncomingSasDialog

* Basic test for VerificationPanel

* Replace references to IGeneratedSas and ISasEvent

* Some secret references to the callbacks types

* Update references to `QrCodeEvent`, `SasEvent` and `VerificationEvent`
This commit is contained in:
Richard van der Hoff 2023-05-26 10:29:32 +01:00 committed by GitHub
parent 530197bfcd
commit 810b8ff6d7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 241 additions and 21 deletions

View file

@ -15,8 +15,8 @@ limitations under the License.
*/
import React, { ReactNode } from "react";
import { IGeneratedSas, ISasEvent, SasEvent } from "matrix-js-sdk/src/crypto/verification/SAS";
import { VerificationBase, VerificationEvent } from "matrix-js-sdk/src/crypto/verification/Base";
import { VerificationBase } from "matrix-js-sdk/src/crypto/verification/Base";
import { GeneratedSas, ShowSasCallbacks, VerifierEvent } from "matrix-js-sdk/src/crypto-api/verification";
import { logger } from "matrix-js-sdk/src/logger";
import { MatrixClientPeg } from "../../../MatrixClientPeg";
@ -37,7 +37,7 @@ const PHASE_VERIFIED = 3;
const PHASE_CANCELLED = 4;
interface IProps {
verifier: VerificationBase<SasEvent, any>;
verifier: VerificationBase<VerifierEvent, any>;
onFinished(verified?: boolean): void;
}
@ -50,11 +50,11 @@ interface IState {
displayname?: string;
} | null;
opponentProfileError: Error | null;
sas: IGeneratedSas | null;
sas: GeneratedSas | null;
}
export default class IncomingSasDialog extends React.Component<IProps, IState> {
private showSasEvent: ISasEvent | null;
private showSasEvent: ShowSasCallbacks | null;
public constructor(props: IProps) {
super(props);
@ -73,8 +73,8 @@ export default class IncomingSasDialog extends React.Component<IProps, IState> {
opponentProfileError: null,
sas: null,
};
this.props.verifier.on(SasEvent.ShowSas, this.onVerifierShowSas);
this.props.verifier.on(VerificationEvent.Cancel, this.onVerifierCancel);
this.props.verifier.on(VerifierEvent.ShowSas, this.onVerifierShowSas);
this.props.verifier.on(VerifierEvent.Cancel, this.onVerifierCancel);
this.fetchOpponentProfile();
}
@ -82,7 +82,7 @@ export default class IncomingSasDialog extends React.Component<IProps, IState> {
if (this.state.phase !== PHASE_CANCELLED && this.state.phase !== PHASE_VERIFIED) {
this.props.verifier.cancel(new Error("User cancel"));
}
this.props.verifier.removeListener(SasEvent.ShowSas, this.onVerifierShowSas);
this.props.verifier.removeListener(VerifierEvent.ShowSas, this.onVerifierShowSas);
}
private async fetchOpponentProfile(): Promise<void> {
@ -118,7 +118,7 @@ export default class IncomingSasDialog extends React.Component<IProps, IState> {
});
};
private onVerifierShowSas = (e: ISasEvent): void => {
private onVerifierShowSas = (e: ShowSasCallbacks): void => {
this.showSasEvent = e;
this.setState({
phase: PHASE_SHOW_SAS,

View file

@ -16,7 +16,7 @@ limitations under the License.
import React from "react";
import { verificationMethods } from "matrix-js-sdk/src/crypto";
import { QrCodeEvent, ReciprocateQRCode, SCAN_QR_CODE_METHOD } from "matrix-js-sdk/src/crypto/verification/QRCode";
import { ReciprocateQRCode, SCAN_QR_CODE_METHOD } from "matrix-js-sdk/src/crypto/verification/QRCode";
import {
Phase,
VerificationRequest,
@ -24,9 +24,10 @@ import {
} from "matrix-js-sdk/src/crypto/verification/request/VerificationRequest";
import { RoomMember } from "matrix-js-sdk/src/models/room-member";
import { User } from "matrix-js-sdk/src/models/user";
import { SAS, SasEvent } from "matrix-js-sdk/src/crypto/verification/SAS";
import { SAS } from "matrix-js-sdk/src/crypto/verification/SAS";
import { logger } from "matrix-js-sdk/src/logger";
import { DeviceInfo } from "matrix-js-sdk/src/crypto/deviceinfo";
import { ShowQrCodeCallbacks, ShowSasCallbacks, VerifierEvent } from "matrix-js-sdk/src/crypto-api/verification";
import { MatrixClientPeg } from "../../../MatrixClientPeg";
import VerificationQRCode from "../elements/crypto/VerificationQRCode";
@ -48,10 +49,10 @@ interface IProps {
}
interface IState {
sasEvent?: SAS["sasEvent"];
sasEvent?: ShowSasCallbacks;
emojiButtonClicked?: boolean;
reciprocateButtonClicked?: boolean;
reciprocateQREvent?: ReciprocateQRCode["reciprocateQREvent"];
reciprocateQREvent?: ShowQrCodeCallbacks;
}
export default class VerificationPanel extends React.PureComponent<IProps, IState> {
@ -401,8 +402,8 @@ export default class VerificationPanel extends React.PureComponent<IProps, IStat
const { request } = this.props;
const sasEvent = (request.verifier as SAS).sasEvent;
const reciprocateQREvent = (request.verifier as ReciprocateQRCode).reciprocateQREvent;
request.verifier?.off(SasEvent.ShowSas, this.updateVerifierState);
request.verifier?.off(QrCodeEvent.ShowReciprocateQr, this.updateVerifierState);
request.verifier?.off(VerifierEvent.ShowSas, this.updateVerifierState);
request.verifier?.off(VerifierEvent.ShowReciprocateQr, this.updateVerifierState);
this.setState({ sasEvent, reciprocateQREvent });
};
@ -411,8 +412,8 @@ export default class VerificationPanel extends React.PureComponent<IProps, IStat
const hadVerifier = this.hasVerifier;
this.hasVerifier = !!request.verifier;
if (!hadVerifier && this.hasVerifier) {
request.verifier?.on(SasEvent.ShowSas, this.updateVerifierState);
request.verifier?.on(QrCodeEvent.ShowReciprocateQr, this.updateVerifierState);
request.verifier?.on(VerifierEvent.ShowSas, this.updateVerifierState);
request.verifier?.on(VerifierEvent.ShowReciprocateQr, this.updateVerifierState);
try {
// on the requester side, this is also awaited in startSAS,
// but that's ok as verify should return the same promise.
@ -437,8 +438,8 @@ export default class VerificationPanel extends React.PureComponent<IProps, IStat
public componentWillUnmount(): void {
const { request } = this.props;
if (request.verifier) {
request.verifier.off(SasEvent.ShowSas, this.updateVerifierState);
request.verifier.off(QrCodeEvent.ShowReciprocateQr, this.updateVerifierState);
request.verifier.off(VerifierEvent.ShowSas, this.updateVerifierState);
request.verifier.off(VerifierEvent.ShowReciprocateQr, this.updateVerifierState);
}
request.off(VerificationRequestEvent.Change, this.onRequestChange);
}

View file

@ -15,8 +15,8 @@ limitations under the License.
*/
import React from "react";
import { IGeneratedSas } from "matrix-js-sdk/src/crypto/verification/SAS";
import { DeviceInfo } from "matrix-js-sdk/src//crypto/deviceinfo";
import { GeneratedSas } from "matrix-js-sdk/src/crypto-api/verification";
import { _t, _td } from "../../../languageHandler";
import { PendingActionSpinner } from "../right_panel/EncryptionInfo";
@ -29,7 +29,7 @@ interface IProps {
device?: DeviceInfo;
onDone: () => void;
onCancel: () => void;
sas: IGeneratedSas;
sas: GeneratedSas;
isSelf?: boolean;
inDialog?: boolean; // whether this component is being shown in a dialog and to use DialogButtons
}