[Create detector] Update data source selection label and help text (#…

…1100) (#1101) * update data source selection label and help text * updated snapshots --------- (cherry picked from commit 62ab170) Signed-off-by: Amardeepsingh Siglani <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Jul 30, 2024 · dac6504 · dac6504
1 parent 85d1c2d
commit dac6504
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 8 deletions.
diff --git a/cypress/integration/1_detectors.spec.js b/cypress/integration/1_detectors.spec.js
@@ -36,7 +36,7 @@ const validateAlertPanel = (alertName) =>
     .eq(2)
     .within(() => cy.getElementByText('button', alertName));
 
-const dataSourceLabel = 'Select or input source indexes or index patterns';
+const dataSourceLabel = 'Select indexes/aliases';
 
 const getDataSourceField = () => cy.getFieldByLabel(dataSourceLabel);
 

diff --git a/public/pages/Alerts/containers/Alerts/__snapshots__/Alerts.test.tsx.snap b/public/pages/Alerts/containers/Alerts/__snapshots__/Alerts.test.tsx.snap
@@ -290,6 +290,7 @@ exports[`<Alerts /> spec renders the component 1`] = `
                           },
                         ]
                       }
+                      compressed={false}
                       dateFormat="MMM D, YYYY @ HH:mm:ss.SSS"
                       end="now"
                       isAutoRefreshOnly={false}
@@ -330,6 +331,7 @@ exports[`<Alerts /> spec renders the component 1`] = `
                             >
                               <EuiFormControlLayout
                                 className="euiSuperDatePicker"
+                                compressed={false}
                                 isDisabled={false}
                                 prepend={
                                   <EuiQuickSelectPopover
@@ -595,7 +597,9 @@ exports[`<Alerts /> spec renders the component 1`] = `
                                         </button>
                                       </div>
                                     </EuiDatePickerRange>
-                                    <EuiFormControlLayoutIcons />
+                                    <EuiFormControlLayoutIcons
+                                      compressed={false}
+                                    />
                                   </div>
                                 </div>
                               </EuiFormControlLayout>
@@ -608,6 +612,7 @@ exports[`<Alerts /> spec renders the component 1`] = `
                               className="euiFlexItem euiFlexItem--flexGrowZero"
                             >
                               <EuiSuperUpdateButton
+                                compressed={false}
                                 data-test-subj="superDatePickerApplyTimeButton"
                                 fill={false}
                                 isDisabled={false}
@@ -637,6 +642,7 @@ exports[`<Alerts /> spec renders the component 1`] = `
                                       onBlur={[Function]}
                                       onClick={[Function]}
                                       onFocus={[Function]}
+                                      size="m"
                                       textProps={
                                         Object {
                                           "className": "euiSuperUpdateButton__text",
@@ -657,6 +663,7 @@ exports[`<Alerts /> spec renders the component 1`] = `
                                         onBlur={[Function]}
                                         onClick={[Function]}
                                         onFocus={[Function]}
+                                        size="m"
                                         textProps={
                                           Object {
                                             "className": "euiSuperUpdateButton__text",

diff --git a/...teDetector/components/DefineDetector/components/DetectorDataSource/DetectorDataSource.tsx b/...teDetector/components/DefineDetector/components/DetectorDataSource/DetectorDataSource.tsx
@@ -12,6 +12,7 @@ import {
   EuiCallOut,
   EuiTextColor,
   EuiTitle,
+  EuiLink,
 } from '@elastic/eui';
 import { FormFieldHeader } from '../../../../../../components/FormFieldHeader/FormFieldHeader';
 import { IndexOption } from '../../../../../Detectors/models/interfaces';
@@ -155,11 +156,17 @@ export default class DetectorDataSource extends Component<
         </EuiTitle>
         <EuiSpacer size={'m'} />
         <EuiFormRow
-          label={
-            <FormFieldHeader headerTitle={'Select or input source indexes or index patterns'} />
-          }
+          label={<FormFieldHeader headerTitle={'Select indexes/aliases'} />}
           isInvalid={isInvalid}
           error={isInvalid && (errorMessage || 'Select an input source.')}
+          helpText={
+            <span>
+              <a href="https://opensearch.org/docs/latest/im-plugin/index-alias" target="_blank">
+                Aliases
+              </a>{' '}
+              are recommended for optimal functioning of detectors.
+            </span>
+          }
         >
           <EuiComboBox
             placeholder={'Select an input source for the detector.'}

diff --git a/...tors/components/UpdateBasicDetails/__snapshots__/UpdateDetectorBasicDetails.test.tsx.snap b/...tors/components/UpdateBasicDetails/__snapshots__/UpdateDetectorBasicDetails.test.tsx.snap
@@ -710,10 +710,22 @@ exports[`<UpdateDetectorBasicDetails /> spec renders the component 1`] = `
           fullWidth={false}
           hasChildLabel={true}
           hasEmptyLabelSpace={false}
+          helpText={
+            <span>
+              <a
+                href="https://opensearch.org/docs/latest/im-plugin/index-alias"
+                target="_blank"
+              >
+                Aliases
+              </a>
+               
+              are recommended for optimal functioning of detectors.
+            </span>
+          }
           isInvalid={false}
           label={
             <FormFieldHeader
-              headerTitle="Select or input source indexes or index patterns"
+              headerTitle="Select indexes/aliases"
             />
           }
           labelType="label"
@@ -739,7 +751,7 @@ exports[`<UpdateDetectorBasicDetails /> spec renders the component 1`] = `
                   htmlFor="some_html_id"
                 >
                   <FormFieldHeader
-                    headerTitle="Select or input source indexes or index patterns"
+                    headerTitle="Select indexes/aliases"
                   >
                     <EuiText
                       size="s"
@@ -748,7 +760,7 @@ exports[`<UpdateDetectorBasicDetails /> spec renders the component 1`] = `
                         className="euiText euiText--small"
                       >
                         <strong>
-                          Select or input source indexes or index patterns
+                          Select indexes/aliases
                         </strong>
                       </div>
                     </EuiText>
@@ -760,6 +772,7 @@ exports[`<UpdateDetectorBasicDetails /> spec renders the component 1`] = `
               className="euiFormRow__fieldWrapper"
             >
               <EuiComboBox
+                aria-describedby="some_html_id-help-0"
                 async={false}
                 compressed={false}
                 data-test-subj="define-detector-select-data-source"
@@ -797,6 +810,7 @@ exports[`<UpdateDetectorBasicDetails /> spec renders the component 1`] = `
                 sortMatchesBy="none"
               >
                 <div
+                  aria-describedby="some_html_id-help-0"
                   aria-expanded={false}
                   aria-haspopup="listbox"
                   className="euiComboBox"
@@ -1083,6 +1097,27 @@ exports[`<UpdateDetectorBasicDetails /> spec renders the component 1`] = `
                   </EuiComboBoxInput>
                 </div>
               </EuiComboBox>
+              <EuiFormHelpText
+                className="euiFormRow__text"
+                id="some_html_id-help-0"
+                key="0"
+              >
+                <div
+                  className="euiFormHelpText euiFormRow__text"
+                  id="some_html_id-help-0"
+                >
+                  <span>
+                    <a
+                      href="https://opensearch.org/docs/latest/im-plugin/index-alias"
+                      target="_blank"
+                    >
+                      Aliases
+                    </a>
+                     
+                    are recommended for optimal functioning of detectors.
+                  </span>
+                </div>
+              </EuiFormHelpText>
             </div>
           </div>
         </EuiFormRow>