github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 11:05:39 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Enterprise Search] Add required flag to connector configurable fields (#155043)

Browse source 
## Summary

Adds a required flag to configurable fields. If the configuration field
has `required: true` then the input will be required as well.
This is not applicable to radios and switches, which can't be null.
This commit is contained in:
Navarone Feekery 2023-04-17 21:57:15 +02:00 • committed by GitHub
parent efc7ca6a07
commit 8d9777b94f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 59 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

14
x-pack/plugins/enterprise_search/common/connectors/native_connectors.ts
View file

@ -22,6 +22,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 1, order: 1,
required: true,
sensitive: false, sensitive: false,
value: '', value: '',
}, },
@ -35,6 +36,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 2, order: 2,
required: true,
sensitive: false, sensitive: false,
value: '', value: '',
}, },
@ -48,6 +50,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 3, order: 3,
required: true,
sensitive: true, sensitive: true,
value: '', value: '',
}, },
@ -61,6 +64,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 4, order: 4,
required: true,
sensitive: false, sensitive: false,
value: '', value: '',
}, },
@ -74,6 +78,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 5, order: 5,
required: true,
sensitive: false, sensitive: false,
value: '', value: '',
}, },
@ -87,6 +92,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 6, order: 6,
required: true,
sensitive: false, sensitive: false,
value: true, value: true,
}, },
@ -116,6 +122,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 1, order: 1,
required: true,
sensitive: false, sensitive: false,
value: '', value: '',
}, },
@ -129,6 +136,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 2, order: 2,
required: true,
sensitive: false, sensitive: false,
value: '', value: '',
}, },
@ -142,6 +150,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 3, order: 3,
required: false,
sensitive: false, sensitive: false,
value: '', value: '',
}, },
@ -155,6 +164,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 4, order: 4,
required: false,
sensitive: true, sensitive: true,
value: '', value: '',
}, },
@ -168,6 +178,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 5, order: 5,
required: true,
sensitive: false, sensitive: false,
value: '', value: '',
}, },
@ -181,6 +192,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 6, order: 6,
required: true,
sensitive: false, sensitive: false,
value: '', value: '',
}, },
@ -194,6 +206,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 7, order: 7,
required: true,
sensitive: false, sensitive: false,
value: false, value: false,
}, },
@ -207,6 +220,7 @@ export const NATIVE_CONNECTOR_DEFINITIONS: Record<string, NativeConnector | unde
), ),
options: [], options: [],
order: 8, order: 8,
required: true,
sensitive: false, sensitive: false,
value: '', value: '',
}, },

1
x-pack/plugins/enterprise_search/common/types/connectors.ts
View file

@ -15,6 +15,7 @@ export interface ConnectorConfigProperties {
label: string; label: string;
options: SelectOptions[]; options: SelectOptions[];
order?: number | null; order?: number | null;
required: boolean;
sensitive: boolean; sensitive: boolean;
value: string | number | boolean | null; value: string | number | boolean | null;
} }

2
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/__mocks__/search_indices.mock.ts
View file

@ -39,6 +39,7 @@ export const indices: ElasticsearchIndexWithIngestion[] = [
label: 'bar', label: 'bar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'barbar', value: 'barbar',
}, },
@ -145,6 +146,7 @@ export const indices: ElasticsearchIndexWithIngestion[] = [
label: 'bar', label: 'bar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'barbar', value: 'barbar',
}, },

2
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/__mocks__/view_index.mock.ts
View file

@ -49,6 +49,7 @@ export const connectorIndex: ConnectorViewIndex = {
label: 'bar', label: 'bar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'barbar', value: 'barbar',
}, },
@ -159,6 +160,7 @@ export const crawlerIndex: CrawlerViewIndex = {
label: 'bar', label: 'bar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'barbar', value: 'barbar',
}, },

21
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/connector/connector_configuration_field.tsx
View file

@ -42,13 +42,15 @@ export const ConnectorConfigurationField: React.FC<ConnectorConfigurationFieldPr
const { status } = useValues(ConnectorConfigurationApiLogic); const { status } = useValues(ConnectorConfigurationApiLogic);
const { setLocalConfigEntry } = useActions(ConnectorConfigurationLogic); const { setLocalConfigEntry } = useActions(ConnectorConfigurationLogic);
const { key, display, label, options, sensitive, value } = configEntry; const { key, display, label, options, required, sensitive, value } = configEntry;
switch (display) { switch (display) {
case 'dropdown': case 'dropdown':
return options.length > 3 ? ( return options.length > 3 ? (
<EuiSelect <EuiSelect
disabled={status === Status.LOADING}
options={options.map((option) => ({ text: option.label, value: option.value }))} options={options.map((option) => ({ text: option.label, value: option.value }))}
required={required}
value={ensureStringType(value)} value={ensureStringType(value)}
onChange={(event) => { onChange={(event) => {
setLocalConfigEntry({ ...configEntry, value: event.target.value }); setLocalConfigEntry({ ...configEntry, value: event.target.value });
@ -56,20 +58,22 @@ export const ConnectorConfigurationField: React.FC<ConnectorConfigurationFieldPr
/> />
) : ( ) : (
<EuiRadioGroup <EuiRadioGroup
options={options.map((option) => ({ id: option.value, label: option.label }))} disabled={status === Status.LOADING}
idSelected={ensureStringType(value)} idSelected={ensureStringType(value)}
name="radio group"
options={options.map((option) => ({ id: option.value, label: option.label }))}
onChange={(id) => { onChange={(id) => {
setLocalConfigEntry({ ...configEntry, value: id }); setLocalConfigEntry({ ...configEntry, value: id });
}} }}
name="radio group"
/> />
); );
case 'numeric': case 'numeric':
return ( return (
<EuiFieldNumber <EuiFieldNumber
value={ensureNumberType(value)}
disabled={status === Status.LOADING} disabled={status === Status.LOADING}
required={required}
value={ensureNumberType(value)}
onChange={(event) => { onChange={(event) => {
setLocalConfigEntry({ ...configEntry, value: event.target.value }); setLocalConfigEntry({ ...configEntry, value: event.target.value });
}} }}
@ -79,8 +83,9 @@ export const ConnectorConfigurationField: React.FC<ConnectorConfigurationFieldPr
case 'textarea': case 'textarea':
const textarea = ( const textarea = (
<EuiTextArea <EuiTextArea
value={ensureStringType(value)}
disabled={status === Status.LOADING} disabled={status === Status.LOADING}
required={required}
value={ensureStringType(value)}
onChange={(event) => { onChange={(event) => {
setLocalConfigEntry({ ...configEntry, value: event.target.value }); setLocalConfigEntry({ ...configEntry, value: event.target.value });
}} }}
@ -110,17 +115,19 @@ export const ConnectorConfigurationField: React.FC<ConnectorConfigurationFieldPr
default: default:
return sensitive ? ( return sensitive ? (
<EuiFieldPassword <EuiFieldPassword
value={ensureStringType(value)}
disabled={status === Status.LOADING} disabled={status === Status.LOADING}
required={required}
type="dual" type="dual"
value={ensureStringType(value)}
onChange={(event) => { onChange={(event) => {
setLocalConfigEntry({ ...configEntry, value: event.target.value }); setLocalConfigEntry({ ...configEntry, value: event.target.value });
}} }}
/> />
) : ( ) : (
<EuiFieldText <EuiFieldText
value={ensureStringType(value)}
disabled={status === Status.LOADING} disabled={status === Status.LOADING}
required={required}
value={ensureStringType(value)}
onChange={(event) => { onChange={(event) => {
setLocalConfigEntry({ ...configEntry, value: event.target.value }); setLocalConfigEntry({ ...configEntry, value: event.target.value });
}} }}

23
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/connector/connector_configuration_logic.test.ts
View file

@ -56,6 +56,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'newBar', label: 'newBar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'oldBar', value: 'oldBar',
}, },
@ -70,6 +71,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'newBar', label: 'newBar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'oldBar', value: 'oldBar',
}, },
@ -81,6 +83,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'newBar', label: 'newBar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'oldBar', value: 'oldBar',
}, },
@ -94,6 +97,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'thirdBar', label: 'thirdBar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'fourthBar', value: 'fourthBar',
}, },
@ -106,6 +110,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'thirdBar', label: 'thirdBar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'fourthBar', value: 'fourthBar',
}, },
@ -117,6 +122,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'thirdBar', label: 'thirdBar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'fourthBar', value: 'fourthBar',
}, },
@ -131,6 +137,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'foo', label: 'foo',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'foofoo', value: 'foofoo',
}, },
@ -139,6 +146,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'thirdBar', label: 'thirdBar',
options: [], options: [],
order: 2, order: 2,
required: false,
sensitive: true, sensitive: true,
value: 'fourthBar', value: 'fourthBar',
}, },
@ -149,6 +157,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'foo', label: 'foo',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'foofoo', value: 'foofoo',
}, },
@ -157,6 +166,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'thirdBar', label: 'thirdBar',
options: [], options: [],
order: 2, order: 2,
required: false,
sensitive: true, sensitive: true,
value: 'fourthBar', value: 'fourthBar',
}, },
@ -167,6 +177,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'foo', label: 'foo',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'fafa', value: 'fafa',
}); });
@ -178,6 +189,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'foo', label: 'foo',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'foofoo', value: 'foofoo',
}, },
@ -186,6 +198,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'thirdBar', label: 'thirdBar',
options: [], options: [],
order: 2, order: 2,
required: false,
sensitive: true, sensitive: true,
value: 'fourthBar', value: 'fourthBar',
}, },
@ -197,6 +210,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'foo', label: 'foo',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'foofoo', value: 'foofoo',
}, },
@ -206,6 +220,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'thirdBar', label: 'thirdBar',
options: [], options: [],
order: 2, order: 2,
required: false,
sensitive: true, sensitive: true,
value: 'fourthBar', value: 'fourthBar',
}, },
@ -216,6 +231,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'foo', label: 'foo',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'fafa', value: 'fafa',
}, },
@ -224,6 +240,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'thirdBar', label: 'thirdBar',
options: [], options: [],
order: 2, order: 2,
required: false,
sensitive: true, sensitive: true,
value: 'fourthBar', value: 'fourthBar',
}, },
@ -235,6 +252,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'foo', label: 'foo',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'fafa', value: 'fafa',
}, },
@ -244,6 +262,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'thirdBar', label: 'thirdBar',
options: [], options: [],
order: 2, order: 2,
required: false,
sensitive: true, sensitive: true,
value: 'fourthBar', value: 'fourthBar',
}, },
@ -264,6 +283,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'bar', label: 'bar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'barbar', value: 'barbar',
}, },
@ -296,6 +316,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'bar', label: 'bar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'barbar', value: 'barbar',
}, },
@ -313,6 +334,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'bar', label: 'bar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: false, sensitive: false,
value: 'barbar', value: 'barbar',
}, },
@ -331,6 +353,7 @@ describe('ConnectorConfigurationLogic', () => {
label: 'bar', label: 'bar',
options: [], options: [],
order: 1, order: 1,
required: false,
sensitive: true, sensitive: true,
value: 'Barbara', value: 'Barbara',
}, },

5
x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/connector/connector_configuration_logic.ts
View file

@ -59,6 +59,7 @@ export interface ConfigEntry {
label: string; label: string;
options: SelectOptions[]; options: SelectOptions[];
order?: number; order?: number;
required: boolean;
sensitive: boolean; sensitive: boolean;
value: string | number | boolean | null; value: string | number | boolean | null;
} }
@ -213,10 +214,10 @@ export const ConnectorConfigurationLogic = kea<
{ {
setLocalConfigEntry: ( setLocalConfigEntry: (
configState, configState,
{ key, display, label, options, order, sensitive, value } { key, display, label, options, order, required, sensitive, value }
) => ({ ) => ({
...configState, ...configState,
[key]: { display, label, options, order, sensitive, value }, [key]: { display, label, options, order, required, sensitive, value },
}), }),
setLocalConfigState: (_, { configState }) => configState, setLocalConfigState: (_, { configState }) => configState,
}, },