[Cases] Add the ability to filter for cases without assignees #143390

cnasikas · 2022-10-14T15:59:29Z

Summary

This PR adds the ability to filter for cases without assignees. The backend accepts an array of strings to filter assignees. Each string is expected to be a valid user profile ID. We introduce the none keyword to filter cases without assignees. The api/cases/_find?assignees=none API call brings all cases without assignees. The api/cases/_find?assignees=none&assignees=123 will bring all cases without assignees OR all cases where the user with profile ID 123 is assigned to. We considered null as an option to filter unassigned cases but JS converts null query parameters to a string "null" which makes it unintuitive. The frontend uses the null value to indicate the "No assignees" filter option but before making the call to the backend it converts it to the "none" value.

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

Filter cases without assignees

elasticmachine · 2022-10-17T10:22:27Z

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

elasticmachine · 2022-10-17T10:22:28Z

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

jonathan-buttner

Looking good, tested it too. Couple questions and changes.

jonathan-buttner · 2022-10-17T16:57:55Z

x-pack/plugins/cases/common/api/cases/case.ts

@@ -352,3 +353,10 @@ export type AllReportersFindRequest = AllTagsFindRequest;

 export type GetCaseIdsByAlertIdAggs = rt.TypeOf<typeof GetCaseIdsByAlertIdAggsRt>;
 export type CasesByAlertId = rt.TypeOf<typeof CasesByAlertIdRt>;
+
+export type CasesFindQueryParams = Partial<


This is more of an internal type to the backend do we need to expose it?

I wanted to use it in the UI but in the end, I did not and I forgot to remove it. Thanks!

jonathan-buttner · 2022-10-17T17:00:50Z

x-pack/plugins/cases/public/components/all_cases/assignees_filter.test.tsx

+    `);
+  });
+
+  it('hides non assignee filtering when searching', async () => {


non -> no

jonathan-buttner · 2022-10-17T17:07:35Z

x-pack/plugins/cases/public/components/all_cases/assignees_filter.tsx

+    (users: AssigneesFilteringSelection[]) => {
+      const usersWithNoAssigneeSelection = removeNoAssigneesSelection(users);
+      const sortedUsers =
+        bringCurrentUserToFrontAndSort(currentUserProfile, usersWithNoAssigneeSelection) ?? [];


Would it make the code easier if we modified bringCurrentUserToFrontAndSort and related functions to handle null? Maybe they could put the nulls at the front and we could just rename it to orderAssignees or something like that.

The bringCurrentUserToFrontAndSort is used in other places where the concept of "no assignees" is not used. I created a helper function called orderAssigneesIncludingNone and put the logic of the onChange hook in it. Let me know if you want me to do something different.

jonathan-buttner · 2022-10-17T17:11:16Z

x-pack/plugins/cases/public/components/all_cases/table_filters.tsx

      if (!isEqual(newAssignees, selectedAssignees)) {
        setSelectedAssignees(newAssignees);
-        onFilterChanged({ assignees: newAssignees.map((assignee) => assignee.uid) });
+        onFilterChanged({
+          assignees: newAssignees.map((assignee) => (assignee != null ? assignee.uid : null)),


Would this work?

onFilterChanged({ assignees: newAssignees.map((assignee) => assignee?.uid ?? null) })

jonathan-buttner · 2022-10-17T17:18:22Z

x-pack/plugins/cases/public/containers/api.test.tsx

+      });
+    });
+
+    test('should not send the assignees field if it an empty array', async () => {


Just to clarify, the fetchMock will be called with an empty assignees array right? If so then maybe we change the test text to say should send an empty assignees field when it is an empty array for the filters options or something like that.

The fetchMock should not be called with an empty assignees array. If you pass an empty array the URL will contain unnecessary &. For example api/cases/_find?&&sortOrder='desc'. Do you want me to rephrase the text to make it clearer?

ah I misread the expect. Sounds good!

jonathan-buttner · 2022-10-17T17:23:18Z

x-pack/plugins/cases/public/containers/api.ts

+            ) ?? NO_ASSIGNEES_FILTERING_KEYWORD,
+        }
+      : {}),
+    ...(filterOptions.reporters.length > 0


Let's move the entire logic for reporters inside of the constructReportersFilter so it returns an object that can be spread.

jonathan-buttner · 2022-10-17T17:26:57Z

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

+    (assignee) => assignee !== NO_ASSIGNEES_FILTERING_KEYWORD
+  );
+  const hasNoneAssignee =
+    assigneesAsArray.find((assignee) => assignee === NO_ASSIGNEES_FILTERING_KEYWORD) !== undefined


Could this be written with assigneesAsArray.some() to avoid the ? true : false?

jonathan-buttner · 2022-10-17T17:31:27Z

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

+    return nodeBuilder.or(assigneesFilter);
+  }
+
+  const filterCasesWithoutAssigneesKueryNode = stringToKueryNode(


I think we can use fromKueryExpression directly and avoid the if block below.

jonathan-buttner · 2022-10-17T17:32:40Z

x-pack/test/cases_api_integration/security_and_spaces/tests/trial/cases/assignees.ts

+          auth: { user: superUser, space: 'space1' },
+        });
+
+        const caseWithNoAssignees = await createCase(supertest, postCaseReq);


Could these be created using a Promise.all or do we need them in a certain order?

jonathan-buttner · 2022-10-17T17:36:12Z

x-pack/test/functional_with_es_ssl/apps/cases/list_view.ts

+          expect(await secondCaseTitle.getVisibleText()).be('matchme');
+        });
+
+        it('filters cases without assignees', async () => {


This test name is the same as above. Is it testing that one of the cases is returned because it matches an assignee? Maybe update it to filters cases with and without assignees.

kibana-ci · 2022-10-18T10:55:06Z

💚 Build Succeeded

Buildkite Build
Commit: 4f83b10

Metrics [docs]

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.9KB	+652.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.8KB	126.1KB	+297.0B

History

💚 Build #80688 succeeded f7652503c3d18d7c555cdf64690ac86006e9e0f0
💔 Build #80504 failed 5f9d2ff

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

cc @cnasikas

jonathan-buttner

Nice work!

…c#143390) * Return unsigneed cases * Fix filter * Change to none * Add and fix testing * PR feedback

EricDavisX · 2022-10-19T18:38:38Z

tested from local cluster - with 2001 cases and confirmed the functional use case works as well as performance concern; there was no performance concern, approximately 2000 cases returned from the 'no assignees' selection near instantaneously.

## Summary With the introduction of the "No assignees" filtering in #143390 we no longer have assignees for filtering. Having the text say "1 assignee selected" when selecting the "No assignees" filtering is misleading. This PR fixes this issue with the label. <img width="536" alt="Screenshot 2022-11-14 at 3 52 28 PM" src="https://user-images.githubusercontent.com/7871006/201680341-e007931f-e9d2-4e5f-96d9-0909f4478bc8.png"> <img width="536" alt="Screenshot 2022-11-14 at 3 52 20 PM" src="https://user-images.githubusercontent.com/7871006/201680344-76b8bf04-8d0e-48ee-97ab-0d860f076f3f.png"> <img width="551" alt="Screenshot 2022-11-14 at 3 51 48 PM" src="https://user-images.githubusercontent.com/7871006/201680346-a3525a41-cef2-43a9-aa89-7d9238bb3944.png"> ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

cnasikas added 3 commits October 14, 2022 18:57

Return unsigneed cases

5b11789

Fix filter

80e9b52

Change to none

5f9d2ff

cnasikas added release_note:enhancement 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 v8.6.0 labels Oct 14, 2022

cnasikas self-assigned this Oct 14, 2022

cnasikas mentioned this pull request Oct 16, 2022

[Cases] User assignment enhancements #141057

Open

25 tasks

cnasikas added 2 commits October 17, 2022 10:37

Merge branch 'main' into no_assignees_filtering

cfc0e06

Add and fix testing

320679a

cnasikas marked this pull request as ready for review October 17, 2022 10:22

cnasikas requested a review from a team as a code owner October 17, 2022 10:22

Merge branch 'main' into no_assignees_filtering

9ac6060

jonathan-buttner reviewed Oct 17, 2022

View reviewed changes

cnasikas added 2 commits October 18, 2022 10:55

Merge branch 'main' into no_assignees_filtering

327667e

PR feedback

4f83b10

cnasikas requested a review from jonathan-buttner October 18, 2022 09:32

cnasikas force-pushed the no_assignees_filtering branch from f765250 to 4f83b10 Compare October 18, 2022 09:32

jonathan-buttner approved these changes Oct 18, 2022

View reviewed changes

cnasikas merged commit 6324008 into elastic:main Oct 18, 2022

cnasikas deleted the no_assignees_filtering branch October 18, 2022 13:59

kc13greiner pushed a commit to kc13greiner/kibana that referenced this pull request Oct 18, 2022

[Cases] Add the ability to filter for cases without assignees (elasti…

3c7a0b5

…c#143390) * Return unsigneed cases * Fix filter * Change to none * Add and fix testing * PR feedback

cnasikas mentioned this pull request Nov 14, 2022

[Cases] Fix selected label in the assignees filtering #145113

Merged

3 tasks

lcawl mentioned this pull request Nov 23, 2022

[DOCS] Add assignees query parameter to find cases API #146087

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] Add the ability to filter for cases without assignees #143390

[Cases] Add the ability to filter for cases without assignees #143390

cnasikas commented Oct 14, 2022 •

edited

Loading

elasticmachine commented Oct 17, 2022

elasticmachine commented Oct 17, 2022

jonathan-buttner left a comment

jonathan-buttner Oct 17, 2022

cnasikas Oct 18, 2022

jonathan-buttner Oct 17, 2022

jonathan-buttner Oct 17, 2022

cnasikas Oct 18, 2022 •

edited

Loading

jonathan-buttner Oct 17, 2022

jonathan-buttner Oct 17, 2022

cnasikas Oct 18, 2022

jonathan-buttner Oct 18, 2022

jonathan-buttner Oct 17, 2022

jonathan-buttner Oct 17, 2022

jonathan-buttner Oct 17, 2022

jonathan-buttner Oct 17, 2022

jonathan-buttner Oct 17, 2022

kibana-ci commented Oct 18, 2022

jonathan-buttner left a comment

EricDavisX commented Oct 19, 2022

[Cases] Add the ability to filter for cases without assignees #143390

[Cases] Add the ability to filter for cases without assignees #143390

Conversation

cnasikas commented Oct 14, 2022 • edited Loading

Summary

Checklist

For maintainers

Release notes

elasticmachine commented Oct 17, 2022

elasticmachine commented Oct 17, 2022

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

cnasikas Oct 18, 2022 • edited Loading

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

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 18, 2022

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

jonathan-buttner left a comment

Choose a reason for hiding this comment

EricDavisX commented Oct 19, 2022

cnasikas commented Oct 14, 2022 •

edited

Loading

cnasikas Oct 18, 2022 •

edited

Loading