[7.x] [Actions][Jira] Set parent issue for Sub-task issue type (#78772) (#79059)

Author: cnasikas

docs/user/alerting/action-types/jira.asciidoc

@@ -69,6 +69,8 @@ Priority::              The priority of the incident.
 Labels::              The labels of the incident.
 Title::    A title for the issue, used for searching the contents of the knowledge base. 
 Description::          The details about the incident.
+Parent::              The parent issue id or key. Only for `Sub-task` issue types.
+Priority::              The priority of the incident.
 Additional comments::  Additional information for the client, such as how to troubleshoot the issue.
 
 [[configuring-jira]]

x-pack/plugins/actions/README.md

@@ -274,12 +274,12 @@ Running the action by scheduling a task means that we will no longer have a user
 
 The following table describes the properties of the `options` object.
 
-| Property | Description                                                                                            | Type   |
-| -------- | ------------------------------------------------------------------------------------------------------ | ------ |
-| id       | The id of the action you want to execute.                                                              | string |
-| params   | The `params` value to give the action type executor.                                                   | object |
-| spaceId  | The space id the action is within.                                                                     | string |
-| apiKey   | The Elasticsearch API key to use for context. (Note: only required and used when security is enabled). | string |
+| Property | Description                                                                                            | Type             |
+| -------- | ------------------------------------------------------------------------------------------------------ | ---------------- |
+| id       | The id of the action you want to execute.                                                              | string           |
+| params   | The `params` value to give the action type executor.                                                   | object           |
+| spaceId  | The space id the action is within.                                                                     | string           |
+| apiKey   | The Elasticsearch API key to use for context. (Note: only required and used when security is enabled). | string           |
 | source   | The source of the execution, either an HTTP request or a reference to a Saved Object.                  | object, optional |
 
 ## Example
@@ -308,11 +308,11 @@ This api runs the action and asynchronously returns the result of running the ac
 
 The following table describes the properties of the `options` object.
 
-| Property | Description                                                                          | Type   |
-| -------- | ------------------------------------------------------------------------------------ | ------ |
-| id       | The id of the action you want to execute.                                            | string |
-| params   | The `params` value to give the action type executor.                                 | object |
-| source   | The source of the execution, either an HTTP request or a reference to a Saved Object.| object, optional |
+| Property | Description                                                                           | Type             |
+| -------- | ------------------------------------------------------------------------------------- | ---------------- |
+| id       | The id of the action you want to execute.                                             | string           |
+| params   | The `params` value to give the action type executor.                                  | object           |
+| source   | The source of the execution, either an HTTP request or a reference to a Saved Object. | object, optional |
 
 ## Example
 
@@ -330,7 +330,7 @@ const result = await actionsClient.execute({
   },
   source: asSavedObjectExecutionSource({
     id: '573891ae-8c48-49cb-a197-0cd5ec34a88b',
-    type: 'alert'
+    type: 'alert',
   }),
 });
 ```
@@ -620,6 +620,7 @@ The Jira action uses the [V2 API](https://developer.atlassian.com/cloud/jira/pla
 | issueType     | The id of the issue type in Jira.                                                                                | string _(optional)_   |
 | priority      | The name of the priority in Jira. Example: `Medium`.                                                             | string _(optional)_   |
 | labels        | An array of labels.                                                                                              | string[] _(optional)_ |
+| parent        | The parent issue id or key. Only for `Sub-task` issue types.                                                     | string _(optional)_   |
 | comments      | The comments of the case. A comment is of the form `{ commentId: string, version: string, comment: string }`     | object[] _(optional)_ |
 
 #### `subActionParams (issueTypes)`

x-pack/plugins/actions/server/builtin_action_types/jira/api.test.ts

@@ -93,6 +93,7 @@ describe('api', () => {
             issueType: '10006',
             labels: ['kibana', 'elastic'],
             priority: 'High',
+            parent: null,
           },
         });
         expect(externalService.updateIncident).not.toHaveBeenCalled();
@@ -252,6 +253,7 @@ describe('api', () => {
             issueType: '10006',
             labels: ['kibana', 'elastic'],
             priority: 'High',
+            parent: null,
           },
         });
         expect(externalService.createIncident).not.toHaveBeenCalled();
@@ -380,6 +382,36 @@ describe('api', () => {
       });
     });
 
+    describe('getIssues', () => {
+      test('it returns the issues correctly', async () => {
+        const res = await api.issues({
+          externalService,
+          params: { title: 'Title test' },
+        });
+        expect(res).toEqual([
+          {
+            id: '10267',
+            key: 'RJ-107',
+            title: 'Test title',
+          },
+        ]);
+      });
+    });
+
+    describe('getIssue', () => {
+      test('it returns the issue correctly', async () => {
+        const res = await api.issue({
+          externalService,
+          params: { id: 'RJ-107' },
+        });
+        expect(res).toEqual({
+          id: '10267',
+          key: 'RJ-107',
+          title: 'Test title',
+        });
+      });
+    });
+
     describe('mapping variations', () => {
       test('overwrite & append', async () => {
         mapping.set('title', {

x-pack/plugins/actions/server/builtin_action_types/jira/api.ts

@@ -13,8 +13,10 @@ import {
   Incident,
   GetFieldsByIssueTypeHandlerArgs,
   GetIssueTypesHandlerArgs,
+  GetIssuesHandlerArgs,
   PushToServiceApiParams,
   PushToServiceResponse,
+  GetIssueHandlerArgs,
 } from './types';
 
 // TODO: to remove, need to support Case
@@ -46,6 +48,18 @@ const getFieldsByIssueTypeHandler = async ({
   return res;
 };
 
+const getIssuesHandler = async ({ externalService, params }: GetIssuesHandlerArgs) => {
+  const { title } = params;
+  const res = await externalService.getIssues(title);
+  return res;
+};
+
+const getIssueHandler = async ({ externalService, params }: GetIssueHandlerArgs) => {
+  const { id } = params;
+  const res = await externalService.getIssue(id);
+  return res;
+};
+
 const pushToServiceHandler = async ({
   externalService,
   mapping,
@@ -83,8 +97,8 @@ const pushToServiceHandler = async ({
       currentIncident,
     });
   } else {
-    const { title, description, priority, labels, issueType } = params;
-    incident = { summary: title, description, priority, labels, issueType };
+    const { title, description, priority, labels, issueType, parent } = params;
+    incident = { summary: title, description, priority, labels, issueType, parent };
   }
 
   if (externalId != null) {
@@ -134,4 +148,6 @@ export const api: ExternalServiceApi = {
   getIncident: getIncidentHandler,
   issueTypes: getIssueTypesHandler,
   fieldsByIssueType: getFieldsByIssueTypeHandler,
+  issues: getIssuesHandler,
+  issue: getIssueHandler,
 };

x-pack/plugins/actions/server/builtin_action_types/jira/index.ts

@@ -25,6 +25,8 @@ import {
   JiraExecutorResultData,
   ExecutorSubActionGetFieldsByIssueTypeParams,
   ExecutorSubActionGetIssueTypesParams,
+  ExecutorSubActionGetIssuesParams,
+  ExecutorSubActionGetIssueParams,
 } from './types';
 import * as i18n from './translations';
 import { Logger } from '../../../../../../src/core/server';
@@ -37,7 +39,13 @@ interface GetActionTypeParams {
   configurationUtilities: ActionsConfigurationUtilities;
 }
 
-const supportedSubActions: string[] = ['pushToService', 'issueTypes', 'fieldsByIssueType'];
+const supportedSubActions: string[] = [
+  'pushToService',
+  'issueTypes',
+  'fieldsByIssueType',
+  'issues',
+  'issue',
+];
 
 // action type definition
 export function getActionType(
@@ -137,5 +145,21 @@ async function executor(
     });
   }
 
+  if (subAction === 'issues') {
+    const getIssuesParams = subActionParams as ExecutorSubActionGetIssuesParams;
+    data = await api.issues({
+      externalService,
+      params: getIssuesParams,
+    });
+  }
+
+  if (subAction === 'issue') {
+    const getIssueParams = subActionParams as ExecutorSubActionGetIssueParams;
+    data = await api.issue({
+      externalService,
+      params: getIssueParams,
+    });
+  }
+
   return { status: 'ok', data: data ?? {}, actionId };
 }

x-pack/plugins/actions/server/builtin_action_types/jira/mocks.ts

@@ -61,6 +61,18 @@ const createMock = (): jest.Mocked<ExternalService> => {
         defaultValue: { name: 'Medium', id: '3' },
       },
     })),
+    getIssues: jest.fn().mockImplementation(() => [
+      {
+        id: '10267',
+        key: 'RJ-107',
+        title: 'Test title',
+      },
+    ]),
+    getIssue: jest.fn().mockImplementation(() => ({
+      id: '10267',
+      key: 'RJ-107',
+      title: 'Test title',
+    })),
   };
 
   service.createComment.mockImplementationOnce(() =>
@@ -120,6 +132,7 @@ const executorParams: ExecutorSubActionPushParams = {
   labels: ['kibana', 'elastic'],
   priority: 'High',
   issueType: '10006',
+  parent: null,
   comments: [
     {
       commentId: 'case-comment-1',

x-pack/plugins/actions/server/builtin_action_types/jira/schema.ts

@@ -44,6 +44,7 @@ export const ExecutorSubActionPushParamsSchema = schema.object({
   issueType: schema.nullable(schema.string()),
   priority: schema.nullable(schema.string()),
   labels: schema.nullable(schema.arrayOf(schema.string())),
+  parent: schema.nullable(schema.string()),
   // TODO: modify later to string[] - need for support Case schema
   comments: schema.nullable(schema.arrayOf(CommentSchema)),
   ...EntityInformation,
@@ -60,6 +61,8 @@ export const ExecutorSubActionGetIssueTypesParamsSchema = schema.object({});
 export const ExecutorSubActionGetFieldsByIssueTypeParamsSchema = schema.object({
   id: schema.string(),
 });
+export const ExecutorSubActionGetIssuesParamsSchema = schema.object({ title: schema.string() });
+export const ExecutorSubActionGetIssueParamsSchema = schema.object({ id: schema.string() });
 
 export const ExecutorParamsSchema = schema.oneOf([
   schema.object({
@@ -82,4 +85,12 @@ export const ExecutorParamsSchema = schema.oneOf([
     subAction: schema.literal('fieldsByIssueType'),
     subActionParams: ExecutorSubActionGetFieldsByIssueTypeParamsSchema,
   }),
+  schema.object({
+    subAction: schema.literal('issues'),
+    subActionParams: ExecutorSubActionGetIssuesParamsSchema,
+  }),
+  schema.object({
+    subAction: schema.literal('issue'),
+    subActionParams: ExecutorSubActionGetIssueParamsSchema,
+  }),
 ]);