Files
mattermost-mobile/app/screens/apps_form/apps_form_component.tsx
2022-05-31 07:42:34 +02:00

442 lines
15 KiB
TypeScript

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import React, {useCallback, useEffect, useMemo, useReducer, useRef, useState} from 'react';
import {useIntl} from 'react-intl';
import {Keyboard, ScrollView, Text, View} from 'react-native';
import Button from 'react-native-button';
import {ImageResource, Navigation} from 'react-native-navigation';
import {SafeAreaView} from 'react-native-safe-area-context';
import {handleGotoLocation} from '@actions/remote/command';
import CompassIcon from '@components/compass_icon';
import Markdown from '@components/markdown';
import {AppCallResponseTypes} from '@constants/apps';
import {useServerUrl} from '@context/server';
import {useTheme} from '@context/theme';
import useDidUpdate from '@hooks/did_update';
import {filterEmptyOptions} from '@utils/apps';
import {buttonBackgroundStyle, buttonTextStyle} from '@utils/buttonStyles';
import {checkDialogElementForError, checkIfErrorsMatchElements} from '@utils/integrations';
import {getMarkdownBlockStyles, getMarkdownTextStyles} from '@utils/markdown';
import {changeOpacity, makeStyleSheetFromTheme} from '@utils/theme';
import DialogIntroductionText from '../interactive_dialog/dialog_introduction_text';
import {buildNavigationButton, dismissModal, setButtons} from '../navigation';
import AppsFormField from './apps_form_field';
const getStyleFromTheme = makeStyleSheetFromTheme((theme: Theme) => {
return {
container: {
backgroundColor: changeOpacity(theme.centerChannelColor, 0.03),
height: '100%',
},
errorContainer: {
marginTop: 15,
marginLeft: 15,
fontSize: 14,
fontWeight: 'bold',
},
scrollView: {
marginBottom: 20,
marginTop: 10,
},
errorLabel: {
fontSize: 12,
textAlign: 'left',
color: (theme.errorTextColor || '#DA4A4A'),
},
button: buttonBackgroundStyle(theme, 'lg', 'primary', 'default'),
buttonText: buttonTextStyle(theme, 'lg', 'primary', 'default'),
};
});
function fieldsAsElements(fields?: AppField[]): DialogElement[] {
return fields?.map((f) => ({
name: f.name,
type: f.type,
subtype: f.subtype,
optional: !f.is_required,
} as DialogElement)) || [];
}
const close = () => {
Keyboard.dismiss();
dismissModal();
};
const makeCloseButton = (icon: ImageResource) => {
return buildNavigationButton(CLOSE_BUTTON_ID, 'close.more_direct_messages.button', icon);
};
export type Props = {
form: AppForm;
componentId: string;
refreshOnSelect: (field: AppField, values: AppFormValues, value: AppFormValue) => Promise<DoAppCallResult<FormResponseData>>;
submit: (submission: {values: AppFormValues}) => Promise<DoAppCallResult<FormResponseData>>;
performLookupCall: (field: AppField, values: AppFormValues, value: AppFormValue) => Promise<DoAppCallResult<AppLookupResponse>>;
}
type Errors = {[name: string]: string}
const emptyErrorsState: Errors = {};
type ValuesAction = {name: string; value: AppFormValue} | {elements?: AppField[]}
function valuesReducer(state: AppFormValues, action: ValuesAction) {
if (!('name' in action)) {
return initValues(action.elements);
}
if (state[action.name] === action.value) {
return state;
}
return {...state, [action.name]: action.value};
}
function initValues(elements?: AppField[]) {
const values: AppFormValues = {};
elements?.forEach((e) => {
if (e.type === 'bool') {
values[e.name] = (e.value === true || String(e.value).toLowerCase() === 'true');
} else if (e.value) {
values[e.name] = e.value;
}
});
return values;
}
const CLOSE_BUTTON_ID = 'close-app-form';
const SUBMIT_BUTTON_ID = 'submit-app-form';
function AppsFormComponent({
form,
componentId,
refreshOnSelect,
submit,
performLookupCall,
}: Props) {
const scrollView = useRef<ScrollView>(null);
const [submitting, setSubmitting] = useState(false);
const intl = useIntl();
const serverUrl = useServerUrl();
const [error, setError] = useState('');
const [errors, setErrors] = useState(emptyErrorsState);
const [values, dispatchValues] = useReducer(valuesReducer, form.fields, initValues);
const theme = useTheme();
const style = getStyleFromTheme(theme);
useEffect(() => {
const unsubscribe = Navigation.events().registerComponentListener({
navigationButtonPressed: ({buttonId}: { buttonId: string }) => {
switch (buttonId) {
case CLOSE_BUTTON_ID:
close();
break;
case SUBMIT_BUTTON_ID: {
if (!submitting) {
handleSubmit();
}
break;
}
}
},
}, componentId);
return () => {
unsubscribe.remove();
};
}, [serverUrl, componentId, submitting]);
useDidUpdate(() => {
dispatchValues({elements: form.fields});
}, [form]);
const submitButtons = useMemo(() => {
return form.fields && form.fields.find((f) => f.name === form.submit_buttons);
}, [form]);
const rightButton = useMemo(() => {
if (submitButtons) {
return undefined;
}
const base = buildNavigationButton(
SUBMIT_BUTTON_ID,
'interactive_dialog.submit.button',
undefined,
intl.formatMessage({id: 'interactive_dialog.submit', defaultMessage: 'Submit'}),
);
base.enabled = submitting;
base.showAsAction = 'always';
base.color = theme.sidebarHeaderTextColor;
return base;
}, [theme.sidebarHeaderTextColor, intl, Boolean(submitButtons)]);
useEffect(() => {
setButtons(componentId, {
rightButtons: rightButton ? [rightButton] : [],
});
}, [rightButton, componentId]);
useEffect(() => {
const icon = CompassIcon.getImageSourceSync('close', 24, theme.sidebarHeaderTextColor);
setButtons(componentId, {
leftButtons: [makeCloseButton(icon)],
});
}, [theme]);
const onChange = useCallback((name: string, value: any) => {
const field = form.fields?.find((f) => f.name === name);
if (!field) {
return;
}
const newValues = {...values, [name]: value};
if (field.refresh) {
refreshOnSelect(field, newValues, value).then((res) => {
if (res.error) {
const errorResponse = res.error;
const errorMsg = errorResponse.text;
const newErrors = errorResponse.data?.errors;
const elements = fieldsAsElements(form.fields);
updateErrors(elements, newErrors, errorMsg);
return;
}
const callResponse = res.data!;
switch (callResponse.type) {
case AppCallResponseTypes.FORM:
return;
case AppCallResponseTypes.OK:
case AppCallResponseTypes.NAVIGATE:
updateErrors([], undefined, intl.formatMessage({
id: 'apps.error.responses.unexpected_type',
defaultMessage: 'App response type was not expected. Response type: {type}.',
}, {
type: callResponse.type,
}));
return;
default:
updateErrors([], undefined, intl.formatMessage({
id: 'apps.error.responses.unknown_type',
defaultMessage: 'App response type not supported. Response type: {type}.',
}, {
type: callResponse.type,
}));
}
});
}
dispatchValues({name, value});
}, []);
const updateErrors = (elements: DialogElement[], fieldErrors?: {[x: string]: string}, formError?: string): boolean => {
let hasErrors = false;
let hasHeaderError = false;
if (formError) {
hasErrors = true;
hasHeaderError = true;
setError(formError);
}
if (fieldErrors && Object.keys(fieldErrors).length > 0) {
hasErrors = true;
if (checkIfErrorsMatchElements(fieldErrors, elements)) {
setErrors(fieldErrors);
} else if (!hasHeaderError) {
hasHeaderError = true;
const field = Object.keys(fieldErrors)[0];
setError(intl.formatMessage({
id: 'apps.error.responses.unknown_field_error',
defaultMessage: 'Received an error for an unknown field. Field name: `{field}`. Error: `{error}`.',
}, {
field,
error: fieldErrors[field],
}));
}
}
if (hasErrors) {
if (hasHeaderError && scrollView.current) {
scrollView.current.scrollTo({x: 0, y: 0});
}
}
return hasErrors;
};
const handleSubmit = useCallback(async (button?: string) => {
const {fields} = form;
const fieldErrors: {[name: string]: string} = {};
const elements = fieldsAsElements(fields);
let hasErrors = false;
elements?.forEach((element) => {
const newError = checkDialogElementForError(
element,
element.name === form.submit_buttons ? button : values[element.name],
);
if (newError) {
hasErrors = true;
fieldErrors[element.name] = intl.formatMessage({id: newError.id, defaultMessage: newError.defaultMessage}, newError.values);
}
});
setErrors(hasErrors ? fieldErrors : emptyErrorsState);
if (hasErrors) {
return;
}
const submission = {
values,
};
if (button && form.submit_buttons) {
submission.values[form.submit_buttons] = button;
}
setSubmitting(true);
const res = await submit(submission);
if (res.error) {
const errorResponse = res.error;
const errorMessage = errorResponse.text;
hasErrors = updateErrors(elements, errorResponse.data?.errors, errorMessage);
if (!hasErrors) {
close();
return;
}
setSubmitting(false);
return;
}
const callResponse = res.data!;
switch (callResponse.type) {
case AppCallResponseTypes.OK:
close();
return;
case AppCallResponseTypes.NAVIGATE:
close();
handleGotoLocation(serverUrl, intl, callResponse.navigate_to_url!);
return;
case AppCallResponseTypes.FORM:
setSubmitting(false);
return;
default:
updateErrors([], undefined, intl.formatMessage({
id: 'apps.error.responses.unknown_type',
defaultMessage: 'App response type not supported. Response type: {type}.',
}, {
type: callResponse.type,
}));
setSubmitting(false);
}
}, []);
const performLookup = useCallback(async (name: string, userInput: string): Promise<AppSelectOption[]> => {
const field = form.fields?.find((f) => f.name === name);
if (!field) {
return [];
}
const res = await performLookupCall(field, values, userInput);
if (res.error) {
const errorResponse = res.error;
const errMsg = errorResponse.text || intl.formatMessage({
id: 'apps.error.unknown',
defaultMessage: 'Unknown error.',
});
setErrors({[field.name]: errMsg});
return [];
}
const callResp = res.data!;
switch (callResp.type) {
case AppCallResponseTypes.OK: {
let items = callResp.data?.items || [];
items = items.filter(filterEmptyOptions);
return items;
}
case AppCallResponseTypes.FORM:
case AppCallResponseTypes.NAVIGATE: {
const errMsg = intl.formatMessage({
id: 'apps.error.responses.unexpected_type',
defaultMessage: 'App response type was not expected. Response type: {type}.',
}, {
type: callResp.type,
},
);
setErrors({[field.name]: errMsg});
return [];
}
default: {
const errMsg = intl.formatMessage({
id: 'apps.error.responses.unknown_type',
defaultMessage: 'App response type not supported. Response type: {type}.',
}, {
type: callResp.type,
},
);
setErrors({[field.name]: errMsg});
return [];
}
}
}, []);
return (
<SafeAreaView
testID='interactive_dialog.screen'
style={style.container}
>
<ScrollView
ref={scrollView}
style={style.scrollView}
>
{error && (
<View style={style.errorContainer} >
<Markdown
baseTextStyle={style.errorLabel}
textStyles={getMarkdownTextStyles(theme)}
blockStyles={getMarkdownBlockStyles(theme)}
value={error}
theme={theme}
/>
</View>
)}
{form.header &&
<DialogIntroductionText
value={form.header}
/>
}
{form.fields && form.fields.filter((f) => f.name !== form.submit_buttons).map((field) => {
return (
<AppsFormField
field={field}
key={field.name}
name={field.name}
errorText={errors[field.name]}
value={values[field.name]}
performLookup={performLookup}
onChange={onChange}
/>
);
})}
<View
style={{marginHorizontal: 5}}
>
{submitButtons?.options?.map((o) => (
<Button
key={o.value}
onPress={() => handleSubmit(o.value)}
containerStyle={style.button}
>
<Text style={style.buttonText}>{o.label}</Text>
</Button>
))}
</View>
</ScrollView>
</SafeAreaView>
);
}
export default AppsFormComponent;