[Cases] Backlink to cases in external services #143174

cnasikas · 2022-10-12T10:43:24Z

Summary

This PR adds a backlink to cases in the description of the case when pushing to an external service. It also removes unnecessary code.

Fixes: #141059, #141061

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

Release notes

Adds a backlink to cases when pushing in external services.

elasticmachine · 2022-10-12T10:43:27Z

Pinging @elastic/response-ops (Team:ResponseOps)

elasticmachine · 2022-10-12T10:43:27Z

Pinging @elastic/response-ops-cases (Feature:Cases)

cnasikas · 2022-10-12T10:45:33Z

x-pack/plugins/cases/public/common/navigation/paths.ts

@@ -19,14 +26,6 @@ export type CaseViewPathParams = {
  commentId?: string;
 } & CaseViewPathSearchParams;

-export const CASES_CREATE_PATH = '/create' as const;


moved to common folder

cnasikas · 2022-10-12T10:45:43Z

x-pack/plugins/cases/public/common/use_cases_toast.tsx

@@ -96,9 +97,6 @@ function getToastContent({
  return undefined;
 }

-const isValidOwner = (owner: string): owner is keyof typeof OWNER_INFO =>


moved to common folder

cnasikas · 2022-10-12T10:45:55Z

x-pack/plugins/cases/public/components/case_view/types.ts

@@ -39,8 +39,3 @@ export interface OnUpdateFields {
  onSuccess?: () => void;
  onError?: () => void;
 }
-
-export enum CASE_VIEW_PAGE_TABS {


moved to common folder

cnasikas · 2022-10-12T10:47:27Z

x-pack/plugins/cases/server/client/cases/push.ts

    const alerts = await getAlerts(alertsInfo, clientArgs);
-
-    const getMappingsResponse = await casesClientInternal.configuration.getMappings({


Mapping is hard coded for the moment. I removed unnecessary calls and code. I believe there is no need to maintain and support code that is not used by users.

cnasikas · 2022-10-12T10:48:27Z

x-pack/plugins/cases/server/client/cases/push.ts

-      connector: theCase.connector,
-    });
-
-    const mappings =


cnasikas · 2022-10-12T10:50:23Z

x-pack/plugins/cases/server/client/cases/utils.ts


  const externalServiceFields =
    casesConnectors.get(connector.actionTypeId)?.format(theCase, alerts) ?? {};

-  let incident: Partial<PushToServiceApiParams['incident']> = { ...externalServiceFields };
+  const connectorMappings = casesConnectors.get(connector.actionTypeId)?.getMapping() ?? [];


As the mappings are hard-coded, we get them from the connector's map.

cnasikas · 2022-10-12T10:51:40Z

x-pack/plugins/cases/server/client/cases/utils.ts


-  if (externalId) {


There is no need to do a call to an external service. This was needed in case we need to append the case description to the description of the external service. We never supported this feature so I removed the unnecessary call.

cnasikas · 2022-10-12T10:53:50Z

x-pack/plugins/cases/server/client/cases/utils.ts

-  const fields = prepareFieldsForTransformation({
-    defaultPipes,
-    mappings,
-    params,
-  });
+  const mappedIncident = mapCaseFieldsToExternalSystemFields(
+    { title: theCase.title, description: descriptionWithKibanaInformation },
+    connectorMappings
+  );

-  const transformedFields = transformFields<BasicParams, ExternalServiceParams, Incident>({
-    params,
-    fields,
-    currentIncident,
-    userProfiles,
-  });


I removed the unnecessary transformation of fields. We always overwrite the content with our values. If we want to support different actions in the feature we can code it better (I coded this hahahaha. I don't like it 😄 ).

peteharverson · 2022-10-12T16:56:22Z

x-pack/plugins/cases/server/client/cases/utils.ts

+
+  const caseUrl = getCaseViewPath({ publicBaseUrl, caseId: theCase.id, owner: theCase.owner });
+
+  return `${descriptionWithKibanaInformation}\nFor more details view this case in Kibana.\nCase URL: ${caseUrl}`;


This would read better with a , after details

For more details, view this case in Kibana.

or consider making the link part of the message

For more details, <<view this case in Kibana>>.

And can that message be message be internationalized?

Also testing on IBM Security QRadar SOAR, the text isn't rendered as a link (whereas it is in e.g. Jira)

Each external service renders the content differently. All external services escape the content before showing it for security reasons. Some of them support the markdown format and some of them have their own syntax (Jira for example). For this reason, we decided with @shanisagiv1 to send only the URL as text and leave the interpretation of the link to the external services. Btw, I added the comma to the text and I translated the message.

@peteharverson @lcawl I added the following text in the total alerts comments. What do you think?

Thanks for the clarification @cnasikas - I see we are limited on formatting the link here as it will be the external service that displays the content. So the change to the text, and internationalization, LGTM.

peteharverson

Tested latest changes and functionally LGTM

jonathan-buttner

I tested with Jira, looks good. Left a few nit comments.

jonathan-buttner · 2022-10-13T13:41:54Z

x-pack/plugins/cases/server/client/cases/utils.test.ts

@@ -1011,32 +877,26 @@ describe('utils', () => {
    it('returns an empty string with neither updatedBy or createdBy are defined', () => {
      expect(
        getEntity({
-          createdAt: '',
-          // @ts-expect-error createdBy should be defined but for testing purposes we want to make sure the function handles null
+          // @ts-expect-error


Can we change the test names to say returns Unknown...? There are a few tests below this one that would need to be changed too.

x-pack/plugins/cases/server/client/cases/utils.ts

jonathan-buttner · 2022-10-13T13:56:39Z

x-pack/plugins/cases/server/client/cases/utils.ts

  userProfiles?: Map<string, UserProfile>
 ): string => {
  return (
    getDisplayName(entity.updatedBy, userProfiles) ??
    getDisplayName(entity.createdBy, userProfiles) ??
-    ''
+    'Unknown'


Should we translate the string Unknown?

jonathan-buttner · 2022-10-13T14:03:27Z

x-pack/plugins/cases/server/common/utils.ts

+  commentId?: string;
+  tabId?: CASE_VIEW_PAGE_TABS;
+}): string => {
+  const normalizePath = (path: string): string => path.replaceAll('//', '/');


If we used the URL class would we be able to avoid removing trailing slashing and the normalizing?

Unfortunately, the URL class keeps the double slashes. For example:

node > new URL('https://e.com//api//cases') URL { href: 'https://e.com//api//cases', origin: 'https://e.com', protocol: 'https:', username: '', password: '', host: 'e.com', hostname: 'e.com', port: '', pathname: '//api//cases', search: '', searchParams: URLSearchParams {}, hash: '' }

kibana-ci · 2022-10-14T08:24:03Z

💚 Build Succeeded

Buildkite Build
Commit: 7e33bd0

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`cases`	500	501	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`cases`	372.3KB	372.3KB	-14.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`cases`	125.5KB	125.8KB	+338.0B

History

💚 Build #80048 succeeded 6448163
💔 Build #80027 failed eace87b
💔 Build #79716 failed 675d3cb

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @cnasikas

cnasikas added 3 commits October 6, 2022 18:47

Add backlink to cases

a701b27

Merge branch 'main' into backlink_to_cases

fa5ba42

Improve code

675d3cb

cnasikas added backport:skip This commit does not require backporting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Cases Cases feature release_note:feature Makes this part of the condensed release notes v8.6.0 labels Oct 12, 2022

cnasikas self-assigned this Oct 12, 2022

cnasikas requested a review from a team as a code owner October 12, 2022 10:43

cnasikas commented Oct 12, 2022

View reviewed changes

x-pack/plugins/cases/server/client/cases/push.ts

connector: theCase.connector,

});

const mappings =

Copy link

Member Author

cnasikas Oct 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

cnasikas commented Oct 12, 2022

View reviewed changes

Merge branch 'main' into backlink_to_cases

d81e272

peteharverson reviewed Oct 12, 2022

View reviewed changes

Improve tests and add i18n

eace87b

cnasikas requested a review from a team as a code owner October 13, 2022 08:35

cnasikas added 2 commits October 13, 2022 12:40

Add alerts url

0a5f47a

Fix i18n

6448163

cnasikas linked an issue Oct 13, 2022 that may be closed by this pull request

[Cases] Add a backlink to the case alert table when pushing to an external service #141061

Closed

peteharverson approved these changes Oct 13, 2022

View reviewed changes

jbudz approved these changes Oct 13, 2022

View reviewed changes

jonathan-buttner approved these changes Oct 13, 2022

View reviewed changes

cnasikas added 2 commits October 14, 2022 10:07

Merge branch 'main' into backlink_to_cases

3069dca

PR feedback

7e33bd0

cnasikas enabled auto-merge (squash) October 14, 2022 07:32

cnasikas merged commit c5f6670 into elastic:main Oct 14, 2022

cnasikas deleted the backlink_to_cases branch October 14, 2022 08:24

cnasikas mentioned this pull request Nov 7, 2022

[Cases] Add spaceId to cases backlink #144616

Merged

2 tasks

cnasikas added release_note:enhancement and removed release_note:feature Makes this part of the condensed release notes labels Nov 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] Backlink to cases in external services #143174

[Cases] Backlink to cases in external services #143174

cnasikas commented Oct 12, 2022 •

edited

elasticmachine commented Oct 12, 2022

elasticmachine commented Oct 12, 2022

cnasikas Oct 12, 2022

cnasikas Oct 12, 2022

cnasikas Oct 12, 2022

cnasikas Oct 12, 2022

cnasikas Oct 12, 2022

cnasikas Oct 12, 2022

cnasikas Oct 12, 2022 •

edited

cnasikas Oct 12, 2022

peteharverson Oct 12, 2022

peteharverson Oct 12, 2022

cnasikas Oct 13, 2022

cnasikas Oct 13, 2022

peteharverson Oct 13, 2022

peteharverson left a comment

jonathan-buttner left a comment

jonathan-buttner Oct 13, 2022

jonathan-buttner Oct 13, 2022

jonathan-buttner Oct 13, 2022

cnasikas Oct 14, 2022

kibana-ci commented Oct 14, 2022

		const alerts = await getAlerts(alertsInfo, clientArgs);

		const getMappingsResponse = await casesClientInternal.configuration.getMappings({


		const caseUrl = getCaseViewPath({ publicBaseUrl, caseId: theCase.id, owner: theCase.owner });

		return `${descriptionWithKibanaInformation}\nFor more details view this case in Kibana.\nCase URL: ${caseUrl}`;

[Cases] Backlink to cases in external services #143174

[Cases] Backlink to cases in external services #143174

Conversation

cnasikas commented Oct 12, 2022 • edited

Summary

Checklist

For maintainers

Release notes

elasticmachine commented Oct 12, 2022

elasticmachine commented Oct 12, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cnasikas Oct 12, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peteharverson left a comment

Choose a reason for hiding this comment

jonathan-buttner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Oct 14, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

cnasikas commented Oct 12, 2022 •

edited

cnasikas Oct 12, 2022 •

edited