Richard van der Hoff
b679693702
* Documentation in MatrixChat and Lifecycle * State transition diagram for `View`
118 lines
8.7 KiB
TypeScript
118 lines
8.7 KiB
TypeScript
/*
|
|
Copyright 2024 New Vector Ltd.
|
|
Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
/**
|
|
* Constants for MatrixChat.state.view.
|
|
*
|
|
* The `View` is the primary state machine of the application: it has different states for the various setup flows
|
|
* that the user may find themselves in. Once we have a functioning client, we can transition to the `LOGGED_IN` state
|
|
* which is the "normal" state of the application.
|
|
*
|
|
* An incomplete state transition diagram follows.
|
|
*
|
|
* (initial state)
|
|
* ┌─────────────────┐ Lock held by other instance ┌─────────────────┐
|
|
* │ LOADING │─────────────────────────────►│ CONFIRM_LOCK_ │
|
|
* │ │◄─────────────────────────────│ THEFT │
|
|
* └─────────────────┘ Lock theft confirmed └─────────────────┘
|
|
* Session recovered │ │ │
|
|
* ┌──────────────┘ │ └────────────────┐
|
|
* │ ┌─────────────┘ │ No previous session
|
|
* │ │ Token/OIDC login succeeded │
|
|
* │ │ ▼
|
|
* │ │ ┌─────────────────┐
|
|
* │ │ │ WELCOME │ (from all other states
|
|
* │ │ │ │ except LOCK_STOLEN)
|
|
* │ │ └─────────────────┘ │
|
|
* │ │ "Create Account" │ │ "Sign in" │ Client logged out
|
|
* │ │ ┌────────────────────────┘ │ │
|
|
* │ │ │ │ ┌────────────────────┘
|
|
* │ │ │ │ │
|
|
* │ │ ▼ "Create an ▼ ▼ "Forgot
|
|
* │ │ ┌─────────────────┐ account" ┌─────────────────┐ password" ┌─────────────────┐
|
|
* │ │ │ REGISTER │◄───────────────│ LOGIN │───────────────►│ FORGOT_PASSWORD │
|
|
* │ │ │ │───────────────►│ │◄───────────────│ │
|
|
* │ │ └─────────────────┘ "Sign in here" └─────────────────┘ Complete / └─────────────────┘
|
|
* │ │ │ │ "Sign in instead" ▲
|
|
* │ │ └────────────────────────────────┐ │ │
|
|
* │ └────────────────────────────────────────┐ │ │ │
|
|
* │ ▼ ▼ ▼ │
|
|
* │ ┌──────────────────┐ │
|
|
* │ │ (postLoginSetup) │ │
|
|
* │ └──────────────────┘ │
|
|
* │ ┌────────────────────────────────────┘ │ │ │
|
|
* │ │ E2EE not enabled ┌─────────────┘ └──────┐ │
|
|
* │ │ │ Account has │ Account lacks │
|
|
* │ │ │ cross-signing │ cross-signing │
|
|
* │ │ │ keys │ keys │
|
|
* │ │ Client started and ▼ ▼ │
|
|
* │ │ force_verification ┌─────────────────┐ ┌─────────────────┐ │
|
|
* │ │ pending │ COMPLETE_ │ │ E2E_SETUP │ │
|
|
* │ │ ┌─────────────────►│ SECURITY │ │ │ │
|
|
* │ │ │ └─────────────────┘ └─────────────────┘ │ "Forgotten
|
|
* │ │ │ ┌───────────────────────┘ │ │ your
|
|
* │ │ │ │ ┌───────────────────────────────────────────────┘ │ password?"
|
|
* │ │ │ │ │ │
|
|
* │ │ │ │ │ (from all other states │
|
|
* │ │ │ │ │ except LOCK_STOLEN) │
|
|
* │ │ │ │ │ └──────────────┐ │
|
|
* ▼ ▼ │ ▼ ▼ Soft logout error ▼ │
|
|
* ┌─────────────────┐ ┌─────────────────┐
|
|
* │ LOGGED_IN │ Re-authentication succeeded │ SOFT_LOGOUT │
|
|
* │ │◄────────────────────────────────────────────────────────│ │
|
|
* └─────────────────┘ └─────────────────┘
|
|
*
|
|
* (from all other states)
|
|
* │
|
|
* │ Session lock stolen
|
|
* ▼
|
|
* ┌─────────────────┐
|
|
* │ LOCK_STOLEN │
|
|
* │ │
|
|
* └─────────────────┘
|
|
*/
|
|
enum Views {
|
|
// a special initial state which is only used at startup, while we are
|
|
// trying to re-animate a matrix client or register as a guest.
|
|
LOADING,
|
|
|
|
// Another tab holds the lock.
|
|
CONFIRM_LOCK_THEFT,
|
|
|
|
// we are showing the welcome view
|
|
WELCOME,
|
|
|
|
// we are showing the login view
|
|
LOGIN,
|
|
|
|
// we are showing the registration view
|
|
REGISTER,
|
|
|
|
// showing the 'forgot password' view
|
|
FORGOT_PASSWORD,
|
|
|
|
// showing flow to trust this new device with cross-signing
|
|
COMPLETE_SECURITY,
|
|
|
|
// flow to setup SSSS / cross-signing on this account
|
|
E2E_SETUP,
|
|
|
|
// we are logged in with an active matrix client. The logged_in state also
|
|
// includes guests users as they too are logged in at the client level.
|
|
LOGGED_IN,
|
|
|
|
// We are logged out (invalid token) but have our local state again. The user
|
|
// should log back in to rehydrate the client.
|
|
SOFT_LOGOUT,
|
|
|
|
// Another instance of the application has started up. We just show an error page.
|
|
LOCK_STOLEN,
|
|
}
|
|
|
|
export default Views;
|