* improved the UX on admin settings page * added check for value containing only spaces * implemented suggestions from PR * implemented suggestion on the PR * changed logic for checking mandatory fields is not empty * removed unused import * updated documentation links for google & github * using css variables * added a fix for checking mandatory fields
261 lines
7.4 KiB
TypeScript
261 lines
7.4 KiB
TypeScript
import React, { useCallback, useEffect } from "react";
|
|
import { saveSettings } from "actions/settingsAction";
|
|
import { SETTINGS_FORM_NAME } from "constants/forms";
|
|
import { ReduxActionTypes } from "constants/ReduxActionConstants";
|
|
import _ from "lodash";
|
|
import ProductUpdatesModal from "pages/Applications/ProductUpdatesModal";
|
|
import { connect, useDispatch } from "react-redux";
|
|
import { RouteComponentProps, useParams, withRouter } from "react-router";
|
|
import { AppState } from "reducers";
|
|
import { formValueSelector, InjectedFormProps, reduxForm } from "redux-form";
|
|
import {
|
|
getSettings,
|
|
getSettingsSavingState,
|
|
getShowReleaseNotes,
|
|
} from "selectors/settingsSelectors";
|
|
import styled from "styled-components";
|
|
import Group from "./FormGroup/group";
|
|
import RestartBanner from "./RestartBanner";
|
|
import AdminConfig from "./config";
|
|
import SaveAdminSettings from "./SaveSettings";
|
|
import {
|
|
SettingTypes,
|
|
Setting,
|
|
} from "@appsmith/pages/AdminSettings/config/types";
|
|
import { DisconnectService } from "./DisconnectService";
|
|
import {
|
|
createMessage,
|
|
DISCONNECT_SERVICE_SUBHEADER,
|
|
DISCONNECT_SERVICE_WARNING,
|
|
} from "@appsmith/constants/messages";
|
|
import { Toaster, Variant } from "components/ads";
|
|
import {
|
|
connectedMethods,
|
|
saveAllowed,
|
|
} from "@appsmith/utils/adminSettingsHelpers";
|
|
|
|
const Wrapper = styled.div`
|
|
flex-basis: calc(100% - ${(props) => props.theme.homePage.leftPane.width}px);
|
|
margin-left: ${(props) => props.theme.homePage.main.marginLeft}px;
|
|
padding-top: 40px;
|
|
height: calc(100vh - ${(props) => props.theme.homePage.header}px);
|
|
overflow: auto;
|
|
`;
|
|
|
|
const SettingsFormWrapper = styled.div`
|
|
max-width: 40rem;
|
|
`;
|
|
|
|
export const BottomSpace = styled.div`
|
|
height: ${(props) => props.theme.settings.footerHeight + 20}px;
|
|
`;
|
|
|
|
export const HeaderWrapper = styled.div`
|
|
margin-bottom: 16px;
|
|
`;
|
|
|
|
export const SettingsHeader = styled.h2`
|
|
font-size: 24px;
|
|
font-weight: 500;
|
|
text-transform: capitalize;
|
|
margin-bottom: 0px;
|
|
`;
|
|
|
|
export const SettingsSubHeader = styled.div`
|
|
font-size: 12px;
|
|
`;
|
|
|
|
type FormProps = {
|
|
settings: Record<string, string>;
|
|
settingsConfig: Record<string, string | boolean>;
|
|
isSaving: boolean;
|
|
showReleaseNotes: boolean;
|
|
};
|
|
|
|
function getSettingLabel(name = "") {
|
|
return name.replace(/-/g, "");
|
|
}
|
|
|
|
function getSettingDetail(category: string, subCategory: string) {
|
|
return AdminConfig.getCategoryDetails(category, subCategory);
|
|
}
|
|
|
|
function useSettings(category: string, subCategory?: string) {
|
|
return AdminConfig.get(subCategory ?? category);
|
|
}
|
|
|
|
export function SettingsForm(
|
|
props: InjectedFormProps & RouteComponentProps & FormProps,
|
|
) {
|
|
const params = useParams() as any;
|
|
const { category, subCategory } = params;
|
|
const settingsDetails = useSettings(category, subCategory);
|
|
const { settings, settingsConfig } = props;
|
|
const details = getSettingDetail(category, subCategory);
|
|
const dispatch = useDispatch();
|
|
const isSavable = AdminConfig.savableCategories.includes(
|
|
subCategory ?? category,
|
|
);
|
|
const pageTitle = getSettingLabel(
|
|
details?.title || (subCategory ?? category),
|
|
);
|
|
|
|
const onSave = () => {
|
|
if (checkMandatoryFileds()) {
|
|
if (saveAllowed(props.settings)) {
|
|
dispatch(saveSettings(props.settings));
|
|
} else {
|
|
saveBlocked();
|
|
}
|
|
} else {
|
|
Toaster.show({
|
|
text: "Mandatory fields cannot be empty",
|
|
variant: Variant.danger,
|
|
});
|
|
}
|
|
};
|
|
|
|
const checkMandatoryFileds = () => {
|
|
const requiredFields = settingsDetails.filter((eachSetting) => {
|
|
const isInitialSettingBlank =
|
|
settingsConfig[eachSetting.id]?.toString().trim() === "" ||
|
|
settingsConfig[eachSetting.id] === undefined;
|
|
const isInitialSettingNotBlank = settingsConfig[eachSetting.id];
|
|
const isNewSettingBlank =
|
|
settings[eachSetting.id]?.toString()?.trim() === "";
|
|
const isNewSettingNotBlank = !settings[eachSetting.id];
|
|
|
|
if (
|
|
eachSetting.isRequired &&
|
|
!eachSetting.isHidden &&
|
|
((isInitialSettingBlank && isNewSettingNotBlank) ||
|
|
(isInitialSettingNotBlank && isNewSettingBlank))
|
|
) {
|
|
return eachSetting.id;
|
|
}
|
|
});
|
|
|
|
return !(requiredFields.length > 0);
|
|
};
|
|
|
|
const onClear = () => {
|
|
_.forEach(props.settingsConfig, (value, settingName) => {
|
|
const setting = AdminConfig.settingsMap[settingName];
|
|
if (setting && setting.controlType == SettingTypes.TOGGLE) {
|
|
props.settingsConfig[settingName] =
|
|
props.settingsConfig[settingName].toString() == "true";
|
|
}
|
|
});
|
|
props.initialize(props.settingsConfig);
|
|
};
|
|
|
|
useEffect(onClear, []);
|
|
|
|
const onReleaseNotesClose = useCallback(() => {
|
|
dispatch({
|
|
type: ReduxActionTypes.TOGGLE_RELEASE_NOTES,
|
|
payload: false,
|
|
});
|
|
}, []);
|
|
|
|
const saveBlocked = () => {
|
|
Toaster.show({
|
|
text: "Cannot disconnect the only connected authentication method.",
|
|
variant: Variant.danger,
|
|
});
|
|
};
|
|
|
|
const disconnect = (currentSettings: AdminConfig) => {
|
|
const updatedSettings: any = {};
|
|
if (connectedMethods.length >= 2) {
|
|
_.forEach(currentSettings, (setting: Setting) => {
|
|
if (!setting.isHidden && setting.controlType !== SettingTypes.LINK) {
|
|
updatedSettings[setting.id] = "";
|
|
}
|
|
});
|
|
dispatch(saveSettings(updatedSettings));
|
|
} else {
|
|
saveBlocked();
|
|
}
|
|
};
|
|
|
|
return (
|
|
<Wrapper>
|
|
<SettingsFormWrapper>
|
|
<HeaderWrapper>
|
|
<SettingsHeader>{pageTitle}</SettingsHeader>
|
|
{details?.subText && (
|
|
<SettingsSubHeader>{details.subText}</SettingsSubHeader>
|
|
)}
|
|
</HeaderWrapper>
|
|
<Group
|
|
category={category}
|
|
settings={settingsDetails}
|
|
subCategory={subCategory}
|
|
/>
|
|
{isSavable && (
|
|
<SaveAdminSettings
|
|
isSaving={props.isSaving}
|
|
onClear={onClear}
|
|
onSave={onSave}
|
|
settings={props.settings}
|
|
valid={props.valid}
|
|
/>
|
|
)}
|
|
{details?.isConnected && (
|
|
<DisconnectService
|
|
disconnect={() => disconnect(settingsDetails)}
|
|
subHeader={createMessage(DISCONNECT_SERVICE_SUBHEADER)}
|
|
warning={`${pageTitle} ${createMessage(
|
|
DISCONNECT_SERVICE_WARNING,
|
|
)}`}
|
|
/>
|
|
)}
|
|
<BottomSpace />
|
|
</SettingsFormWrapper>
|
|
{props.showReleaseNotes && (
|
|
<ProductUpdatesModal hideTrigger isOpen onClose={onReleaseNotesClose} />
|
|
)}
|
|
<RestartBanner />
|
|
</Wrapper>
|
|
);
|
|
}
|
|
|
|
const validate = (values: Record<string, any>) => {
|
|
const errors: any = {};
|
|
_.filter(values, (value, name) => {
|
|
const err_message = AdminConfig.validate(name, value);
|
|
if (err_message) {
|
|
errors[name] = err_message;
|
|
}
|
|
});
|
|
return errors;
|
|
};
|
|
|
|
const selector = formValueSelector(SETTINGS_FORM_NAME);
|
|
export default withRouter(
|
|
connect((state: AppState) => {
|
|
const settingsConfig = getSettings(state);
|
|
const newProps: any = {
|
|
settings: {},
|
|
settingsConfig,
|
|
isSaving: getSettingsSavingState(state),
|
|
showReleaseNotes: getShowReleaseNotes(state),
|
|
};
|
|
_.forEach(AdminConfig.settingsMap, (setting, name) => {
|
|
const fieldValue = selector(state, name);
|
|
|
|
if (fieldValue !== settingsConfig[name]) {
|
|
newProps.settings[name] = fieldValue;
|
|
}
|
|
});
|
|
return newProps;
|
|
}, null)(
|
|
reduxForm<any, any>({
|
|
validate,
|
|
form: SETTINGS_FORM_NAME,
|
|
touchOnBlur: true,
|
|
})(SettingsForm),
|
|
),
|
|
);
|