mattermost-mobile/app/screens/edit_server/form.tsx
Felipe Martin af2c35b03b
feat: edit server pre-authentication secret (#9128)
* feat: show potential pre-auth secret error on server create

* chroe: address comments

* chore: updated message

* feat: read response header to check error source

* fix: i18n

* chore: rename pre-auth to just auth

* Add show/hide toggle to authentication secret field

Modified server form to match login form UX with password visibility toggle

* Add preauth secret field to edit server with validation and auto-open options

* chore: added missing 18n

* Increase form padding for better error message spacing

* Fix preauth secret removal when not provided

* Change edit server title from 'Edit server name' to 'Edit server'

* Add custom ping function and improve validation in edit server

* chore: revert en_AU

* chore: improved error message

* feat: animate advanced options

* fix: auth secret label being cropped

* refactor: doPing
2025-11-12 16:07:19 +01:00

322 lines
12 KiB
TypeScript

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import React, {type MutableRefObject, useCallback, useEffect, useMemo, useRef, useState} from 'react';
import {defineMessages, useIntl} from 'react-intl';
import {Keyboard, Platform, Pressable, TouchableOpacity, useWindowDimensions, View} from 'react-native';
import Animated, {useAnimatedStyle, useSharedValue, withTiming} from 'react-native-reanimated';
import Button from '@components/button';
import CompassIcon from '@components/compass_icon';
import FloatingTextInput, {type FloatingTextInputRef} from '@components/floating_input/floating_text_input_label';
import FormattedText from '@components/formatted_text';
import {useIsTablet} from '@hooks/device';
import {changeOpacity, makeStyleSheetFromTheme} from '@utils/theme';
import {typography} from '@utils/typography';
import {removeProtocol, stripTrailingSlashes} from '@utils/url';
import type {KeyboardAwareScrollView} from 'react-native-keyboard-aware-scroll-view';
const ADVANCED_OPTIONS_COLLAPSED = 0;
const ADVANCED_OPTIONS_EXPANDED = 150; // Approximate height for the content
type Props = {
buttonDisabled: boolean;
connecting: boolean;
displayName?: string;
displayNameError?: string;
handleUpdate: () => void;
handleDisplayNameTextChanged: (text: string) => void;
handlePreauthSecretTextChanged: (text: string) => void;
keyboardAwareRef: MutableRefObject<KeyboardAwareScrollView | null>;
preauthSecret?: string;
preauthSecretError?: string;
serverUrl: string;
setShowAdvancedOptions: React.Dispatch<React.SetStateAction<boolean>>;
showAdvancedOptions: boolean;
theme: Theme;
};
const getStyleSheet = makeStyleSheetFromTheme((theme: Theme) => ({
formContainer: {
alignItems: 'center',
maxWidth: 600,
width: '100%',
paddingHorizontal: 24,
},
fullWidth: {
width: '100%',
},
error: {
marginBottom: 18,
},
chooseText: {
alignSelf: 'flex-start',
color: changeOpacity(theme.centerChannelColor, 0.64),
marginTop: 8,
...typography('Body', 75, 'Regular'),
},
buttonContainer: {
width: '100%',
marginTop: 32,
},
advancedOptionsContainer: {
width: '100%',
marginTop: 16,
},
advancedOptionsHeader: {
flexDirection: 'row',
alignItems: 'center',
justifyContent: 'flex-start',
paddingVertical: 12,
paddingHorizontal: 4,
},
advancedOptionsTitle: {
color: theme.linkColor,
...typography('Body', 75, 'SemiBold'),
},
advancedOptionsContent: {
width: '100%',
overflow: 'visible',
},
endAdornment: {
top: 2,
},
}));
const hitSlop = {top: 8, right: 8, bottom: 8, left: 8};
const messages = defineMessages({
save: {
id: 'edit_server.save',
defaultMessage: 'Save',
},
saving: {
id: 'edit_server.saving',
defaultMessage: 'Saving',
},
advancedOptions: {
id: 'mobile.components.select_server_view.advancedOptions',
defaultMessage: 'Advanced Options',
},
preauthSecret: {
id: 'mobile.components.select_server_view.sharedSecret',
defaultMessage: 'Authentication secret',
},
preauthSecretHelp: {
id: 'mobile.components.select_server_view.sharedSecretHelp',
defaultMessage: 'The authentication secret shared by the administrator',
},
});
const EditServerForm = ({
buttonDisabled,
connecting,
displayName = '',
displayNameError,
handleUpdate,
handleDisplayNameTextChanged,
handlePreauthSecretTextChanged,
keyboardAwareRef,
preauthSecret = '',
preauthSecretError,
serverUrl,
setShowAdvancedOptions,
showAdvancedOptions,
theme,
}: Props) => {
const {formatMessage} = useIntl();
const isTablet = useIsTablet();
const dimensions = useWindowDimensions();
const displayNameRef = useRef<FloatingTextInputRef>(null);
const preauthSecretRef = useRef<FloatingTextInputRef>(null);
const styles = getStyleSheet(theme);
const [isPreauthSecretVisible, setIsPreauthSecretVisible] = useState(false);
const togglePreauthSecretVisibility = useCallback(() => {
setIsPreauthSecretVisible((prevState) => !prevState);
}, []);
const preauthSecretEndAdornment = useMemo(() => (
<TouchableOpacity
onPress={togglePreauthSecretVisibility}
hitSlop={hitSlop}
style={styles.endAdornment}
>
<CompassIcon
name={isPreauthSecretVisible ? 'eye-off-outline' : 'eye-outline'}
size={20}
color={changeOpacity(theme.centerChannelColor, 0.64)}
/>
</TouchableOpacity>
), [isPreauthSecretVisible, styles.endAdornment, theme.centerChannelColor, togglePreauthSecretVisibility]);
const onBlur = useCallback(() => {
if (Platform.OS === 'ios') {
const reset = !displayNameRef.current?.isFocused();
if (reset) {
keyboardAwareRef.current?.scrollToPosition(0, 0);
}
}
}, [keyboardAwareRef]);
const onUpdate = useCallback(() => {
Keyboard.dismiss();
handleUpdate();
}, [handleUpdate]);
const onDisplayNameSubmit = useCallback(() => {
if (showAdvancedOptions || preauthSecretError) {
preauthSecretRef.current?.focus();
} else {
onUpdate();
}
}, [showAdvancedOptions, preauthSecretError, onUpdate]);
const toggleAdvancedOptions = useCallback(() => {
setShowAdvancedOptions((prev: boolean) => !prev);
}, [setShowAdvancedOptions]);
const chevronRotation = useSharedValue(showAdvancedOptions ? 180 : 0);
const advancedOptionsStyle = useAnimatedStyle(() => ({
height: withTiming(showAdvancedOptions ? ADVANCED_OPTIONS_EXPANDED : ADVANCED_OPTIONS_COLLAPSED, {duration: 250}),
}));
useEffect(() => {
chevronRotation.value = withTiming(showAdvancedOptions ? 180 : 0, {duration: 250});
// chevronRotation is a Reanimated shared value; its reference is stable and does not need to be in the dependency array.
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [showAdvancedOptions]);
const chevronAnimatedStyle = useAnimatedStyle(() => ({
transform: [{rotate: `${chevronRotation.value}deg`}],
}));
const onFocus = useCallback(() => {
// For iOS we set the position of the input instead of
// having the KeyboardAwareScrollView figure it out by itself
// on Android KeyboardAwareScrollView does nothing as is handled
// by the OS
if (Platform.OS === 'ios') {
let offsetY = 160;
if (isTablet) {
const {width, height} = dimensions;
const isLandscape = width > height;
offsetY = isLandscape ? 230 : 100;
}
requestAnimationFrame(() => {
keyboardAwareRef.current?.scrollToPosition(0, offsetY);
});
}
}, [dimensions, isTablet, keyboardAwareRef]);
useEffect(() => {
if (Platform.OS === 'ios' && isTablet) {
if (displayNameRef.current?.isFocused()) {
onFocus();
} else {
keyboardAwareRef.current?.scrollToPosition(0, 0);
}
}
}, [isTablet, keyboardAwareRef, onFocus]);
const saveButtonTestId = buttonDisabled ? 'edit_server_form.save.button.disabled' : 'edit_server_form.save.button';
return (
<View style={styles.formContainer}>
<View style={[styles.fullWidth, displayNameError?.length ? styles.error : undefined]}>
<FloatingTextInput
rawInput={true}
enablesReturnKeyAutomatically={true}
error={displayNameError}
label={formatMessage({
id: 'mobile.components.select_server_view.displayName',
defaultMessage: 'Display Name',
})}
onBlur={onBlur}
onChangeText={handleDisplayNameTextChanged}
onFocus={onFocus}
onSubmitEditing={onDisplayNameSubmit}
ref={displayNameRef}
returnKeyType={showAdvancedOptions || preauthSecretError ? 'next' : 'done'}
testID='edit_server_form.server_display_name.input'
theme={theme}
value={displayName}
/>
</View>
{!displayNameError &&
<FormattedText
defaultMessage={'Server: {url}'}
id={'edit_server.display_help'}
style={styles.chooseText}
testID={'edit_server_form.display_help'}
values={{url: removeProtocol(stripTrailingSlashes(serverUrl))}}
/>
}
<View style={styles.advancedOptionsContainer}>
<Pressable
onPress={toggleAdvancedOptions}
style={styles.advancedOptionsHeader}
testID='edit_server_form.advanced_options.toggle'
>
<Animated.View style={chevronAnimatedStyle}>
<CompassIcon
name={'chevron-down'}
size={20}
style={styles.advancedOptionsTitle}
/>
</Animated.View>
<FormattedText
defaultMessage='Advanced Options'
id='mobile.components.select_server_view.advancedOptions'
style={styles.advancedOptionsTitle}
/>
</Pressable>
<Animated.View style={[styles.advancedOptionsContent, advancedOptionsStyle]}>
{showAdvancedOptions && (
<>
<FloatingTextInput
rawInput={true}
enablesReturnKeyAutomatically={true}
endAdornment={preauthSecretEndAdornment}
error={preauthSecretError}
keyboardType={isPreauthSecretVisible ? 'visible-password' : 'default'}
label={formatMessage(messages.preauthSecret)}
onChangeText={handlePreauthSecretTextChanged}
onSubmitEditing={onUpdate}
ref={preauthSecretRef}
returnKeyType='done'
secureTextEntry={!isPreauthSecretVisible}
testID='edit_server_form.preauth_secret.input'
theme={theme}
value={preauthSecret}
/>
<FormattedText
{...messages.preauthSecretHelp}
style={styles.chooseText}
testID='edit_server_form.preauth_secret_help'
/>
</>
)}
</Animated.View>
</View>
<View style={styles.buttonContainer}>
<Button
disabled={buttonDisabled || connecting}
onPress={onUpdate}
testID={saveButtonTestId}
size='lg'
theme={theme}
text={formatMessage(connecting ? messages.saving : messages.save)}
showLoader={connecting}
/>
</View>
</View>
);
};
export default EditServerForm;