Skip to content

Added oauth and cookie fields for data sources #1048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions client/packages/lowcoder-sdk/dataSource.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,18 @@ export interface DataSourcePluginMeta extends DataSourcePluginBasicInfo {
DataSourceConfig,
{
extra?: DynamicConfigObject;
authConfig?: {
type: AuthType;
authId?: string;
} & (
| {
username: string; // basic auth
password: string;
}
| OAuthConfig
);

sslConfig?: SSLConfig;
}
>;
queryConfig: DynamicConfigObject | QueryConfig;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import { useHostCheck } from "./useHostCheck";
import { useSelector } from "react-redux";
import { getUser } from "redux/selectors/usersSelectors";

const AuthTypeOptions = [
export const AuthTypeOptions = [
{ label: "None", value: "NO_AUTH" },
{ label: "Basic", value: "BASIC_AUTH" },
{ label: "Digest", value: "DIGEST_AUTH" },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import {
TacoMarkDown,
} from "lowcoder-design";
import { DatasourceFormProps } from "./datasourceFormRegistry";
import { DatasourceNameFormInputItem, GeneralSettingFormSectionLabel } from "../form";
import { AdvancedSettingFormSectionLabel, CertValidationFormItem, DatasourceNameFormInputItem, ForwardCookiesFormItem, GeneralSettingFormSectionLabel, encryptedPlaceholder } from "../form";
import {
DataSourceParamConfig,
ParamOption,
Expand All @@ -38,6 +38,9 @@ import { FieldData } from "rc-field-form/es/interface";
import { default as Alert } from "antd/es/alert";
import { default as Form } from "antd/es/form";
import { default as Input } from "antd/es/input";
import { AuthType, AuthTypeOptions } from "./httpDatasourceForm";
import { useSelector } from "react-redux";
import { getUser } from "@lowcoder-ee/redux/selectors/usersSelectors";

const TooltipWrapper = styled.div`
.markdown-body {
Expand Down Expand Up @@ -130,14 +133,24 @@ export const PluginDataSourceForm = (props: DatasourceFormProps) => {
const [extraParamConfigs, setExtraParamConfigs] = useState<DataSourceParamConfig[]>([]);
const [isExtraParamsRefreshing, setExtraParamRefreshing] = useState(false);
const [isExtraParamsRefreshError, setExtraParamRefreshError] = useState(false);

const pluginDef = dataSourceTypeInfo?.definition || datasource.pluginDefinition;
const pluginName = dataSourceTypeInfo?.id || datasource.pluginDefinition?.id;
const isEditing = !!datasource;
const hasDynamicConfig = !!pluginDef?.dataSourceConfig?.extra;

const [authType, setAuthType] = useState(pluginDef?.dataSourceConfig?.authConfig?.type);
const [authId, setAuthId] = useState(pluginDef?.dataSourceConfig?.authConfig?.authId);

const readyStatusCallbackRef = useRef(onFormReadyStatusChange);
readyStatusCallbackRef.current = onFormReadyStatusChange;

const userAuthSources = useSelector(getUser).connections?.filter(authSource => authSource.source !== "EMAIL");;
const userAuthSourcesOptions = userAuthSources?.map(item => ({
label: item.source,
value: item.authId
})) || [];

const handleRefreshExtraParams = useCallback(() => {
if (!pluginName) {
return;
Expand Down Expand Up @@ -205,6 +218,65 @@ export const PluginDataSourceForm = (props: DatasourceFormProps) => {
const initialValues = getDefaultValues(pluginDef, datasource);
const hasGeneralSettings = dataSourceConfig.params?.[0]?.type !== "groupTitle";

const UsernameFormItem = (
<FormInputItem
name={"username"}
label="Username"
initialValue={(dataSourceConfig?.authConfig as any)?.username}
required={true}
rules={[{ required: true, message: trans("query.userNameRequiredMessage") }]}
labelWidth={142}
/>
);

const PasswordFormItem = (
<FormInputItem
name={"password"}
label="Password"
initialValue={(dataSourceConfig?.authConfig as any)?.password}
required={true}
rules={[{ required: !dataSourceConfig, message: trans("query.passwordRequiredMessage") }]}
labelWidth={142}
// eslint-disable-next-line only-ascii/only-ascii
placeholder={props.datasource ? encryptedPlaceholder : "••••••••••••"}
/>
);

const showAuthItem = (type: AuthType) => {
switch (type) {
case "BASIC_AUTH":
return (
<>
{UsernameFormItem}
{PasswordFormItem}
</>
);
case "DIGEST_AUTH":
return (
<>
{UsernameFormItem}
{PasswordFormItem}
</>
);
}
};

const showUserAuthSourceSelector = () => {
if (authType === "OAUTH2_INHERIT_FROM_LOGIN") {
return (
<FormSelectItem
name={"authId"}
label="User Authentication Source"
options={userAuthSourcesOptions}
initialValue={dataSourceConfig?.authConfig ? authId : null}
afterChange={(value) => setAuthId(value) }
labelWidth={142}
/>
);
}
return null;
};

return (
<DatasourceForm form={form} initialValues={initialValues} onFieldsChange={handleFieldsChange}>
<Form.Item noStyle name="extra">
Expand Down Expand Up @@ -237,6 +309,25 @@ export const PluginDataSourceForm = (props: DatasourceFormProps) => {
);
})}
</FormSection>
<FormSection $size={props.size}>
<FormSectionLabel>{trans("query.authentication")}</FormSectionLabel>
<FormSelectItem
name={"authConfigType"}
label={trans("query.authenticationType")}
options={AuthTypeOptions}
initialValue={dataSourceConfig?.authConfig?.type ?? "NO_AUTH"}
afterChange={(value) => setAuthType(value)}
labelWidth={142}
/>
{showUserAuthSourceSelector()}
{showAuthItem(authType)}
</FormSection>

<FormSection $size={props.size}>
<AdvancedSettingFormSectionLabel />
<CertValidationFormItem datasource={props.datasource} />
<ForwardCookiesFormItem datasource={props.datasource} />
</FormSection>
{isExtraParamsRefreshing && (
<Alert showIcon type="info" message={trans("query.dynamicDataSourceConfigLoadingText")} />
)}
Expand Down
Loading