signal-desktop/ts/state/smart/InstallScreen.tsx

287 lines
8.1 KiB
TypeScript
Raw Normal View History

2023-01-03 19:55:46 +00:00
// Copyright 2021 Signal Messenger, LLC
2021-12-16 15:02:22 +00:00
// SPDX-License-Identifier: AGPL-3.0-only
import type { ComponentProps, ReactElement } from 'react';
import React, { useCallback, useEffect, useRef, useState } from 'react';
import { useSelector } from 'react-redux';
import { getIntl } from '../selectors/user';
2023-03-20 20:42:00 +00:00
import { getUpdatesState } from '../selectors/updates';
import { useUpdatesActions } from '../ducks/updates';
import { hasExpired as hasExpiredSelector } from '../selectors/expiration';
2021-12-16 15:02:22 +00:00
import * as log from '../../logging/log';
import type { Loadable } from '../../util/loadable';
import { LoadingState } from '../../util/loadable';
import { assertDev } from '../../util/assert';
2021-12-16 15:02:22 +00:00
import { explodePromise } from '../../util/explodePromise';
import { missingCaseError } from '../../util/missingCaseError';
import {
InstallScreen,
InstallScreenStep,
} from '../../components/InstallScreen';
import { InstallError } from '../../components/installScreen/InstallScreenErrorStep';
import { MAX_DEVICE_NAME_LENGTH } from '../../components/installScreen/InstallScreenChoosingDeviceNameStep';
import { HTTPError } from '../../textsecure/Errors';
import { isRecord } from '../../util/isRecord';
2022-03-01 23:01:21 +00:00
import * as Errors from '../../types/errors';
2021-12-16 15:02:22 +00:00
import { normalizeDeviceName } from '../../util/normalizeDeviceName';
2023-03-20 20:42:00 +00:00
import { getName as getOSName } from '../../OS';
2021-12-16 15:02:22 +00:00
type PropsType = ComponentProps<typeof InstallScreen>;
type StateType =
| {
step: InstallScreenStep.Error;
error: InstallError;
}
| {
step: InstallScreenStep.QrCodeNotScanned;
provisioningUrl: Loadable<string>;
}
| {
step: InstallScreenStep.ChoosingDeviceName;
deviceName: string;
}
| {
step: InstallScreenStep.LinkInProgress;
};
const INITIAL_STATE: StateType = {
step: InstallScreenStep.QrCodeNotScanned,
provisioningUrl: { loadingState: LoadingState.Loading },
};
function getInstallError(err: unknown): InstallError {
if (err instanceof HTTPError) {
switch (err.code) {
case -1:
return InstallError.ConnectionFailed;
case 409:
return InstallError.TooOld;
case 411:
return InstallError.TooManyDevices;
default:
return InstallError.UnknownError;
}
}
// AccountManager.registerSecondDevice uses this specific "websocket closed" error
// message.
if (isRecord(err) && err.message === 'websocket closed') {
return InstallError.ConnectionFailed;
}
return InstallError.UnknownError;
}
export function SmartInstallScreen(): ReactElement {
const i18n = useSelector(getIntl);
2023-03-20 20:42:00 +00:00
const updates = useSelector(getUpdatesState);
const { startUpdate } = useUpdatesActions();
const hasExpired = useSelector(hasExpiredSelector);
2021-12-16 15:02:22 +00:00
const chooseDeviceNamePromiseWrapperRef = useRef(explodePromise<string>());
const [state, setState] = useState<StateType>(INITIAL_STATE);
const setProvisioningUrl = useCallback(
(value: string) => {
setState(currentState => {
if (currentState.step !== InstallScreenStep.QrCodeNotScanned) {
return currentState;
}
return {
...currentState,
provisioningUrl: {
loadingState: LoadingState.Loaded,
value,
},
};
});
},
[setState]
);
const onQrCodeScanned = useCallback(() => {
setState(currentState => {
if (currentState.step !== InstallScreenStep.QrCodeNotScanned) {
return currentState;
}
return {
step: InstallScreenStep.ChoosingDeviceName,
deviceName: normalizeDeviceName(
window.textsecure.storage.user.getDeviceName() ||
window.getHostName() ||
''
).slice(0, MAX_DEVICE_NAME_LENGTH),
};
});
}, [setState]);
const setDeviceName = useCallback(
(deviceName: string) => {
setState(currentState => {
if (currentState.step !== InstallScreenStep.ChoosingDeviceName) {
return currentState;
}
return {
...currentState,
deviceName,
};
});
},
[setState]
);
const onSubmitDeviceName = useCallback(() => {
if (state.step !== InstallScreenStep.ChoosingDeviceName) {
return;
}
let deviceName: string = normalizeDeviceName(state.deviceName);
if (!deviceName.length) {
// This should be impossible, but we have it here just in case.
assertDev(
2021-12-16 15:02:22 +00:00
false,
'Unexpected empty device name. Falling back to placeholder value'
);
2023-03-30 00:03:25 +00:00
deviceName = i18n('icu:Install__choose-device-name__placeholder');
2021-12-16 15:02:22 +00:00
}
chooseDeviceNamePromiseWrapperRef.current.resolve(deviceName);
setState({ step: InstallScreenStep.LinkInProgress });
}, [state, i18n]);
useEffect(() => {
let hasCleanedUp = false;
const accountManager = window.getAccountManager();
assertDev(accountManager, 'Expected an account manager');
2021-12-16 15:02:22 +00:00
const updateProvisioningUrl = (value: string): void => {
if (hasCleanedUp) {
return;
}
setProvisioningUrl(value);
};
const confirmNumber = async (): Promise<string> => {
if (hasCleanedUp) {
throw new Error('Cannot confirm number; the component was unmounted');
}
onQrCodeScanned();
if (window.SignalCI) {
2023-01-13 00:24:59 +00:00
chooseDeviceNamePromiseWrapperRef.current.resolve(
window.SignalCI.deviceName
2023-01-13 00:24:59 +00:00
);
2021-12-16 15:02:22 +00:00
}
const result = await chooseDeviceNamePromiseWrapperRef.current.promise;
if (hasCleanedUp) {
throw new Error('Cannot confirm number; the component was unmounted');
}
// Delete all data from the database unless we're in the middle of a re-link.
// Without this, the app restarts at certain times and can cause weird things to
// happen, like data from a previous light import showing up after a new install.
const shouldRetainData = window.Signal.Util.Registration.everDone();
if (!shouldRetainData) {
try {
await window.textsecure.storage.protocol.removeAllData();
} catch (error) {
log.error(
'confirmNumber: error clearing database',
2022-03-01 23:01:21 +00:00
Errors.toLogFormat(error)
2021-12-16 15:02:22 +00:00
);
}
}
if (hasCleanedUp) {
throw new Error('Cannot confirm number; the component was unmounted');
}
return result;
};
void (async () => {
2021-12-16 15:02:22 +00:00
try {
await accountManager.registerSecondDevice(
updateProvisioningUrl,
confirmNumber
);
2023-01-13 00:24:59 +00:00
window.IPC.removeSetupMenuItems();
2022-03-01 23:01:21 +00:00
} catch (error) {
log.error(
'account.registerSecondDevice: got an error',
Errors.toLogFormat(error)
);
2021-12-16 15:02:22 +00:00
if (hasCleanedUp) {
return;
}
setState({
step: InstallScreenStep.Error,
2022-03-01 23:01:21 +00:00
error: getInstallError(error),
2021-12-16 15:02:22 +00:00
});
}
})();
return () => {
hasCleanedUp = true;
};
}, [setProvisioningUrl, onQrCodeScanned]);
let props: PropsType;
switch (state.step) {
case InstallScreenStep.Error:
props = {
step: InstallScreenStep.Error,
screenSpecificProps: {
i18n,
error: state.error,
2023-01-13 00:24:59 +00:00
quit: () => window.IPC.shutdown(),
2021-12-16 15:02:22 +00:00
tryAgain: () => setState(INITIAL_STATE),
},
};
break;
case InstallScreenStep.QrCodeNotScanned:
props = {
step: InstallScreenStep.QrCodeNotScanned,
screenSpecificProps: {
i18n,
provisioningUrl: state.provisioningUrl,
2023-03-20 20:42:00 +00:00
hasExpired,
updates,
currentVersion: window.getVersion(),
startUpdate,
OS: getOSName(),
2021-12-16 15:02:22 +00:00
},
};
break;
case InstallScreenStep.ChoosingDeviceName:
props = {
step: InstallScreenStep.ChoosingDeviceName,
screenSpecificProps: {
i18n,
deviceName: state.deviceName,
setDeviceName,
onSubmit: onSubmitDeviceName,
},
};
break;
case InstallScreenStep.LinkInProgress:
props = {
step: InstallScreenStep.LinkInProgress,
screenSpecificProps: { i18n },
};
break;
default:
throw missingCaseError(state);
}
return <InstallScreen {...props} />;
}