wip

Author: richvdh

src/components/structures/MatrixChat.tsx

@@ -141,6 +141,7 @@ import Markdown from "../../Markdown";
 import { sanitizeHtmlParams } from "../../Linkify";
 import { isOnlyAdmin } from "../../utils/membership";
 import { ModuleApi } from "../../modules/Api.ts";
+import { logErrorAndShowErrorDialog } from "../../utils/ErrorUtils.tsx";
 
 // legacy export
 export { default as Views } from "../../Views";
@@ -408,61 +409,13 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
      *
      * {@link onWillStartClient} and {@link onClientStarted} will already have been called (but not necessarily
      * completed).
-     *
-     * This method either calls {@link onLiggedIn} directly, or switches to {@link Views.E2E_SETUP} or
-     * {@link Views.COMPLETE_SECURITY}, which will later call {@link onCompleteSecurityE2eSetupFinished}.
      */
     private async postLoginSetup(): Promise<void> {
-        const cli = MatrixClientPeg.safeGet();
-        const cryptoEnabled = Boolean(cli.getCrypto());
-        if (!cryptoEnabled) {
-            this.onLoggedIn();
-        }
-
-        const promisesList: Promise<any>[] = [this.firstSyncPromise.promise];
-        let crossSigningIsSetUp = false;
-        if (cryptoEnabled) {
-            // check if the user has previously published public cross-signing keys,
-            // as a proxy to figure out if it's worth prompting the user to verify
-            // from another device.
-            promisesList.push(
-                (async (): Promise<void> => {
-                    crossSigningIsSetUp = Boolean(await cli.getCrypto()?.userHasCrossSigningKeys());
-                })(),
-            );
-        }
-
+        // TODO: move to onUserCompletedLoginFlow?
         // Now update the state to say we're waiting for the first sync to complete rather
         // than for the login to finish.
         this.setState({ pendingInitialSync: true });
-
-        await Promise.all(promisesList);
-
-        if (!cryptoEnabled) {
-            this.setState({ pendingInitialSync: false });
-            return;
-        }
-
-        if (crossSigningIsSetUp) {
-            // if the user has previously set up cross-signing, verify this device so we can fetch the
-            // private keys.
-
-            const cryptoExtension = ModuleRunner.instance.extensions.cryptoSetup;
-            if (cryptoExtension.SHOW_ENCRYPTION_SETUP_UI == false) {
-                this.onLoggedIn();
-            } else {
-                this.setStateForNewView({ view: Views.COMPLETE_SECURITY });
-            }
-        } else if (!(await shouldSkipSetupEncryption(cli))) {
-            // if cross-signing is not yet set up, do so now if possible.
-            InitialCryptoSetupStore.sharedInstance().startInitialCryptoSetup(
-                cli,
-                this.onCompleteSecurityE2eSetupFinished,
-            );
-            this.setStateForNewView({ view: Views.E2E_SETUP });
-        } else {
-            this.onLoggedIn();
-        }
+        await this.firstSyncPromise.promise;
         this.setState({ pendingInitialSync: false });
     }
 
@@ -472,6 +425,9 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
             | (Pick<IState, K> | IState | null),
         callback?: () => void,
     ): void {
+        if (state && "view" in state) {
+            logger.log("Changing view from", this.state.view, "to", state.view);
+        }
         if (this.shouldTrackPageChange(this.state, { ...this.state, ...state })) {
             this.startPageChangeTimer();
         }
@@ -643,6 +599,7 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
     private onAction = (payload: ActionPayload): void => {
         // once the session lock has been stolen, don't try to do anything.
         if (this.state.view === Views.LOCK_STOLEN) {
+            logger.warn("Ignoring action as session lock has been stolen");
             return;
         }
 
@@ -1378,10 +1335,10 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
     /**
      * Returns true if the user must go through the device verification process before they
      * can use the app.
-     * @returns true if the user must verify
+     *
+     * @returns true if the device is unverified, but crypto is enabled.
      */
-    private async shouldForceVerification(): Promise<boolean> {
-        if (!SdkConfig.get("force_verification")) return false;
+    private async deviceNeedsVerification(): Promise<boolean> {
         const mustVerifyFlag = localStorage.getItem("must_verify_device");
         if (!mustVerifyFlag) return false;
 
@@ -1409,8 +1366,6 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
         ThemeController.isLogin = false;
         this.themeWatcher?.recheck();
         StorageManager.tryPersistStorage();
-
-        await this.onShowPostLoginScreen();
     }
 
     /**
@@ -1422,12 +1377,54 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
      *  - by {@link onCompleteSecurityE2eSetupFinished}
      *
      * In other words, whenever we think we have completed the login and E2E setup tasks.
+     *
+     * TODO: fix docs
      */
-    private async onShowPostLoginScreen(): Promise<void> {
+    private async showNextPostLoginView(): Promise<void> {
+        const cli = MatrixClientPeg.safeGet();
+
+        // First of all, figure out if we need to do some cross-signing setup.
+        // Traditionally, we would only do that just after logging in, but with the advent of `force_verification`,
+        // we may need to do it on every restart.
+        if (
+            (this.state.view == Views.LOGIN ||
+                this.state.view == Views.REGISTER ||
+                SdkConfig.get("force_verification")) &&
+            !(await shouldSkipSetupEncryption(cli))
+        ) {
+            const crypto = cli.getCrypto()!;
+
+            // Check if we need to create cross-signing keys for this user.
+            if (!(await crypto!.userHasCrossSigningKeys())) {
+                logger.info("showNextPostLoginScreen: user lacks cross-signing keys, starting setup");
+                InitialCryptoSetupStore.sharedInstance().startInitialCryptoSetup(
+                    cli,
+                    this.onCompleteSecurityE2eSetupFinished,
+                );
+                this.setStateForNewView({ view: Views.E2E_SETUP });
+                return;
+            }
+
+            // We have cross-signing keys, so see if we need to verify this device.
+            if (
+                ModuleRunner.instance.extensions.cryptoSetup.SHOW_ENCRYPTION_SETUP_UI &&
+                (await this.deviceNeedsVerification())
+            ) {
+                logger.info("showNextPostLoginScreen: user must verify device, starting verification");
+                this.setStateForNewView({ view: Views.COMPLETE_SECURITY });
+                return;
+            }
+        }
+
+        // We've done the E2E setup stuff, so we can transition to the regular application, with
+        // an appropriate screen.
+        logger.info("showNextPostLoginScreen: E2E setup done, transitioning to logged in view.");
+
         this.setStateForNewView({ view: Views.LOGGED_IN });
         // If a specific screen is set to be shown after login, show that above
         // all else, as it probably means the user clicked on something already.
         if (this.screenAfterLogin?.screen) {
+            logger.info(`showNextPostLoginView: showing screen ${this.screenAfterLogin.screen}`);
             this.showScreen(this.screenAfterLogin.screen, this.screenAfterLogin.params);
             this.screenAfterLogin = undefined;
         } else if (MatrixClientPeg.currentUserIsJustRegistered()) {
@@ -1436,6 +1433,7 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
             if (ThreepidInviteStore.instance.pickBestInvite()) {
                 // The user has a 3pid invite pending - show them that
                 const threepidInvite = ThreepidInviteStore.instance.pickBestInvite();
+                logger.info(`showNextPostLoginView: showing room ${threepidInvite.roomId} after registration`);
 
                 // HACK: This is a pretty brutal way of threading the invite back through
                 // our systems, but it's the safest we have for now.
@@ -1444,9 +1442,11 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
             } else {
                 // The user has just logged in after registering,
                 // so show the homepage.
+                logger.info("showNextPostLoginView: Showing home page after registration");
                 dis.dispatch<ViewHomePagePayload>({ action: Action.ViewHomePage, justRegistered: true });
             }
         } else {
+            logger.info("showNextPostLoginView: showScreenAfterLogin");
             this.showScreenAfterLogin();
         }
 
@@ -1510,15 +1510,19 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
         // If screenAfterLogin is set, use that, then null it so that a second login will
         // result in view_home_page, _user_settings or _room_directory
         if (this.screenAfterLogin && this.screenAfterLogin.screen) {
+            logger.info(`showScreenAfterLogin: showing screen ${this.screenAfterLogin.screen}`);
             this.showScreen(this.screenAfterLogin.screen, this.screenAfterLogin.params);
             this.screenAfterLogin = undefined;
         } else if (localStorage && localStorage.getItem("mx_last_room_id")) {
             // Before defaulting to directory, show the last viewed room
+            logger.info(`showScreenAfterLogin: showing last room`);
             this.viewLastRoom();
         } else {
             if (MatrixClientPeg.safeGet().isGuest()) {
+                logger.info(`showScreenAfterLogin: showing guest welcome page`);
                 dis.dispatch({ action: "view_welcome_page" });
             } else {
+                logger.info(`showScreenAfterLogin: showing home page`);
                 dis.dispatch({ action: Action.ViewHomePage });
             }
         }
@@ -1759,18 +1763,6 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
      */
     private async onClientStarted(): Promise<void> {
         const cli = MatrixClientPeg.safeGet();
-
-        const shouldForceVerification = await this.shouldForceVerification();
-        // XXX: Don't replace the screen if it's already one of these: postLoginSetup
-        // changes to these screens in certain circumstances so we shouldn't clobber it.
-        // We should probably have one place where we decide what the next screen is after
-        // login.
-        if (![Views.COMPLETE_SECURITY, Views.E2E_SETUP].includes(this.state.view)) {
-            if (shouldForceVerification) {
-                this.setStateForNewView({ view: Views.COMPLETE_SECURITY });
-            }
-        }
-
         const crypto = cli.getCrypto();
         if (crypto) {
             const blacklistEnabled = SettingsStore.getValueAt(SettingLevel.DEVICE, "blacklistUnverifiedDevices");
@@ -1786,6 +1778,8 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
         this.setState({
             ready: true,
         });
+
+        await this.showNextPostLoginView();
     }
 
     public showScreen(screen: string, params?: { [key: string]: any }): void {
@@ -1796,6 +1790,7 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
             dis.dispatch({ action: Action.ViewHomePage });
             return;
         }
+        logger.info(`showScreen ${screen}`);
 
         if (screen === "register") {
             dis.dispatch({
@@ -2088,20 +2083,11 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
     };
 
     /** Called when {@link Views.E2E_SETUP} or {@link Views.COMPLETE_SECURITY} have completed. */
-    private onCompleteSecurityE2eSetupFinished = async (): Promise<void> => {
-        const forceVerify = await this.shouldForceVerification();
-        if (forceVerify) {
-            const isVerified = await MatrixClientPeg.safeGet().getCrypto()?.isCrossSigningReady();
-            if (!isVerified) {
-                // We must verify but we haven't yet verified - don't continue logging in
-                return;
-            }
-        }
-
-        await this.onShowPostLoginScreen().catch((e) => {
-            logger.error("Exception showing post-login screen", e);
+    private onCompleteSecurityE2eSetupFinished(): void {
+        this.showNextPostLoginView().catch((e) => {
+            logErrorAndShowErrorDialog("Exception showing post-login screen", e);
         });
-    };
+    }
 
     private getFragmentAfterLogin(): string {
         let fragmentAfterLogin = "";

src/dispatcher/dispatcher.ts

@@ -8,8 +8,9 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Com
 Please see LICENSE files in the repository root for full details.
 */
 
-import { type Action } from "./actions";
+import { Action } from "./actions";
 import { type ActionPayload, AsyncActionPayload } from "./payloads";
+import { logger } from "matrix-js-sdk/src/logger";
 
 type DispatchToken = string;
 
@@ -82,6 +83,12 @@ export class MatrixDispatcher {
      */
     // eslint-disable-next-line @typescript-eslint/naming-convention
     private _dispatch = (payload: ActionPayload): void => {
+        // Log all actions, except a few spammy ones
+        if (payload.action !== Action.UserActivity) {
+            // XXX fixme too much data
+            logger.info(`Dispatch action ${payload.action}`, payload);
+        }
+
         invariant(!this.isDispatching(), "Dispatch.dispatch(...): Cannot dispatch in the middle of a dispatch.");
         this.startDispatching(payload);
         try {