[Actions] adds a Test Connector tab in the Connectors list (#77365)

Adds a tab in the _Edit Alert_ flyout which allows the user to _test_ their connector by executing it using an example action. The execution relies on the connector being updated, so is only enabled when there are no saved changes in the Connector form itself.

Author: gmmorris

x-pack/plugins/actions/common/types.ts

@@ -24,3 +24,13 @@ export interface ActionResult {
   config: Record<string, any>;
   isPreconfigured: boolean;
 }
+
+// the result returned from an action type executor function
+export interface ActionTypeExecutorResult<Data> {
+  actionId: string;
+  status: 'ok' | 'error';
+  message?: string;
+  serviceMessage?: string;
+  data?: Data;
+  retry?: null | boolean | Date;
+}

x-pack/plugins/actions/server/builtin_action_types/es_index.test.ts

@@ -284,4 +284,47 @@ describe('execute()', () => {
           ]
     `);
   });
+
+  test('resolves with an error when an error occurs in the indexing operation', async () => {
+    const secrets = {};
+    // minimal params
+    const config = { index: 'index-value', refresh: false, executionTimeField: null };
+    const params = {
+      documents: [{ '': 'bob' }],
+    };
+
+    const actionId = 'some-id';
+
+    services.callCluster.mockResolvedValue({
+      took: 0,
+      errors: true,
+      items: [
+        {
+          index: {
+            _index: 'indexme',
+            _id: '7buTjHQB0SuNSiS9Hayt',
+            status: 400,
+            error: {
+              type: 'mapper_parsing_exception',
+              reason: 'failed to parse',
+              caused_by: {
+                type: 'illegal_argument_exception',
+                reason: 'field name cannot be an empty string',
+              },
+            },
+          },
+        },
+      ],
+    });
+
+    expect(await actionType.executor({ actionId, config, secrets, params, services }))
+      .toMatchInlineSnapshot(`
+      Object {
+        "actionId": "some-id",
+        "message": "error indexing documents",
+        "serviceMessage": "failed to parse (field name cannot be an empty string)",
+        "status": "error",
+      }
+    `);
+  });
 });

x-pack/plugins/actions/server/builtin_action_types/es_index.ts

@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { curry } from 'lodash';
+import { curry, find } from 'lodash';
 import { i18n } from '@kbn/i18n';
 import { schema, TypeOf } from '@kbn/config-schema';
 
@@ -85,21 +85,39 @@ async function executor(
     refresh: config.refresh,
   };
 
-  let result;
   try {
-    result = await services.callCluster('bulk', bulkParams);
+    const result = await services.callCluster('bulk', bulkParams);
+
+    const err = find(result.items, 'index.error.reason');
+    if (err) {
+      return wrapErr(
+        `${err.index.error!.reason}${
+          err.index.error?.caused_by ? ` (${err.index.error?.caused_by?.reason})` : ''
+        }`,
+        actionId,
+        logger
+      );
+    }
+
+    return { status: 'ok', data: result, actionId };
   } catch (err) {
-    const message = i18n.translate('xpack.actions.builtin.esIndex.errorIndexingErrorMessage', {
-      defaultMessage: 'error indexing documents',
-    });
-    logger.error(`error indexing documents: ${err.message}`);
-    return {
-      status: 'error',
-      actionId,
-      message,
-      serviceMessage: err.message,
-    };
+    return wrapErr(err.message, actionId, logger);
   }
+}
 
-  return { status: 'ok', data: result, actionId };
+function wrapErr(
+  errMessage: string,
+  actionId: string,
+  logger: Logger
+): ActionTypeExecutorResult<unknown> {
+  const message = i18n.translate('xpack.actions.builtin.esIndex.errorIndexingErrorMessage', {
+    defaultMessage: 'error indexing documents',
+  });
+  logger.error(`error indexing documents: ${errMessage}`);
+  return {
+    status: 'error',
+    actionId,
+    message,
+    serviceMessage: errMessage,
+  };
 }

x-pack/plugins/actions/server/types.ts

@@ -15,6 +15,8 @@ import {
   SavedObjectsClientContract,
   SavedObjectAttributes,
 } from '../../../../src/core/server';
+import { ActionTypeExecutorResult } from '../common';
+export { ActionTypeExecutorResult } from '../common';
 
 export type WithoutQueryAndParams<T> = Pick<T, Exclude<keyof T, 'query' | 'params'>>;
 export type GetServicesFunction = (request: KibanaRequest) => Services;
@@ -80,16 +82,6 @@ export interface FindActionResult extends ActionResult {
   referencedByCount: number;
 }
 
-// the result returned from an action type executor function
-export interface ActionTypeExecutorResult<Data> {
-  actionId: string;
-  status: 'ok' | 'error';
-  message?: string;
-  serviceMessage?: string;
-  data?: Data;
-  retry?: null | boolean | Date;
-}
-
 // signature of the action type executor function
 export type ExecutorType<Config, Secrets, Params, ResultData> = (
   options: ActionTypeExecutorOptions<Config, Secrets, Params>

x-pack/plugins/triggers_actions_ui/public/application/components/add_message_variables.tsx

@@ -61,6 +61,7 @@ export const AddMessageVariables: React.FunctionComponent<Props> = ({
         <EuiButtonIcon
           id={`${paramsProperty}AddVariableButton`}
           data-test-subj={`${paramsProperty}AddVariableButton`}
+          isDisabled={(messageVariables?.length ?? 0) === 0}
           title={addVariableButtonTitle}
           onClick={() => setIsVariablesPopoverOpen(true)}
           iconType="indexOpen"

x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/es_index/es_index_params.tsx

@@ -32,48 +32,47 @@ export const IndexParamsFields = ({
   };
 
   return (
-    <>
-      <JsonEditorWithMessageVariables
-        messageVariables={messageVariables}
-        paramsProperty={'documents'}
-        inputTargetValue={
-          documents && documents.length > 0 ? ((documents[0] as unknown) as string) : undefined
+    <JsonEditorWithMessageVariables
+      messageVariables={messageVariables}
+      paramsProperty={'documents'}
+      data-test-subj="documentToIndex"
+      inputTargetValue={
+        documents && documents.length > 0 ? ((documents[0] as unknown) as string) : undefined
+      }
+      label={i18n.translate(
+        'xpack.triggersActionsUI.components.builtinActionTypes.indexAction.documentsFieldLabel',
+        {
+          defaultMessage: 'Document to index',
         }
-        label={i18n.translate(
-          'xpack.triggersActionsUI.components.builtinActionTypes.indexAction.documentsFieldLabel',
-          {
-            defaultMessage: 'Document to index',
-          }
-        )}
-        aria-label={i18n.translate(
-          'xpack.triggersActionsUI.components.builtinActionTypes.indexAction.jsonDocAriaLabel',
-          {
-            defaultMessage: 'Code editor',
-          }
-        )}
-        errors={errors.documents as string[]}
-        onDocumentsChange={onDocumentsChange}
-        helpText={
-          <EuiLink
-            href={`${docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${docLinks.DOC_LINK_VERSION}/index-action-type.html#index-action-configuration`}
-            target="_blank"
-          >
-            <FormattedMessage
-              id="xpack.triggersActionsUI.components.builtinActionTypes.indexAction.indexDocumentHelpLabel"
-              defaultMessage="Index document example."
-            />
-          </EuiLink>
+      )}
+      aria-label={i18n.translate(
+        'xpack.triggersActionsUI.components.builtinActionTypes.indexAction.jsonDocAriaLabel',
+        {
+          defaultMessage: 'Code editor',
         }
-        onBlur={() => {
-          if (
-            !(documents && documents.length > 0 ? ((documents[0] as unknown) as string) : undefined)
-          ) {
-            // set document as empty to turn on the validation for non empty valid JSON object
-            onDocumentsChange('{}');
-          }
-        }}
-      />
-    </>
+      )}
+      errors={errors.documents as string[]}
+      onDocumentsChange={onDocumentsChange}
+      helpText={
+        <EuiLink
+          href={`${docLinks.ELASTIC_WEBSITE_URL}guide/en/kibana/${docLinks.DOC_LINK_VERSION}/index-action-type.html#index-action-configuration`}
+          target="_blank"
+        >
+          <FormattedMessage
+            id="xpack.triggersActionsUI.components.builtinActionTypes.indexAction.indexDocumentHelpLabel"
+            defaultMessage="Index document example."
+          />
+        </EuiLink>
+      }
+      onBlur={() => {
+        if (
+          !(documents && documents.length > 0 ? ((documents[0] as unknown) as string) : undefined)
+        ) {
+          // set document as empty to turn on the validation for non empty valid JSON object
+          onDocumentsChange('{}');
+        }
+      }}
+    />
   );
 };
 

x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api.test.ts

@@ -12,6 +12,7 @@ import {
   loadActionTypes,
   loadAllActions,
   updateActionConnector,
+  executeAction,
 } from './action_connector_api';
 
 const http = httpServiceMock.createStartContract();
@@ -128,3 +129,32 @@ describe('deleteActions', () => {
     `);
   });
 });
+
+describe('executeAction', () => {
+  test('should call execute API', async () => {
+    const id = '123';
+    const params = {
+      stringParams: 'someString',
+      numericParams: 123,
+    };
+
+    http.post.mockResolvedValueOnce({
+      actionId: id,
+      status: 'ok',
+    });
+
+    const result = await executeAction({ id, http, params });
+    expect(result).toEqual({
+      actionId: id,
+      status: 'ok',
+    });
+    expect(http.post.mock.calls[0]).toMatchInlineSnapshot(`
+      Array [
+        "/api/actions/action/123/_execute",
+        Object {
+          "body": "{\\"params\\":{\\"stringParams\\":\\"someString\\",\\"numericParams\\":123}}",
+        },
+      ]
+    `);
+  });
+});

x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api.ts

@@ -7,6 +7,7 @@
 import { HttpSetup } from 'kibana/public';
 import { BASE_ACTION_API_PATH } from '../constants';
 import { ActionConnector, ActionConnectorWithoutId, ActionType } from '../../types';
+import { ActionTypeExecutorResult } from '../../../../../plugins/actions/common';
 
 export async function loadActionTypes({ http }: { http: HttpSetup }): Promise<ActionType[]> {
   return await http.get(`${BASE_ACTION_API_PATH}/list_action_types`);
@@ -65,3 +66,17 @@ export async function deleteActions({
   );
   return { successes, errors };
 }
+
+export async function executeAction({
+  id,
+  params,
+  http,
+}: {
+  id: string;
+  http: HttpSetup;
+  params: Record<string, unknown>;
+}): Promise<ActionTypeExecutorResult<unknown>> {
+  return await http.post(`${BASE_ACTION_API_PATH}/action/${id}/_execute`, {
+    body: JSON.stringify({ params }),
+  });
+}

x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/connector_edit_flyout.scss

@@ -0,0 +1,3 @@
+.connectorEditFlyoutTabs {
+  margin-bottom: '-25px';
+}

x-pack/plugins/triggers_actions_ui/public/application/sections/action_connector_form/connector_edit_flyout.test.tsx

@@ -152,6 +152,6 @@ describe('connector_edit_flyout', () => {
 
     const preconfiguredBadge = wrapper.find('[data-test-subj="preconfiguredBadge"]');
     expect(preconfiguredBadge.exists()).toBeTruthy();
-    expect(wrapper.find('[data-test-subj="saveEditedActionButton"]').exists()).toBeFalsy();
+    expect(wrapper.find('[data-test-subj="saveAndCloseEditedActionButton"]').exists()).toBeFalsy();
   });
 });