[Cases] Custom fields MVP #167016

js-jankisalvi · 2023-09-22T09:45:33Z

Summary

This PR implements an MPV for custom fields in Cases. Specifically:

Users can add, delete, or edit custom fields from the configuration page
Users can set custom fields when creating a case
Users can set custom fields when editing a case
Only the Text custom field type is supported. The Toggle is implemented to test the framework.
Users with a basic license can enter the configuration page and set custom fields
The configuration page header changed to "Settings"
The "Edit external connection" button changed to "Settings"
APIs:
- Users cannot post custom fields with duplicate keys
- Users cannot change the type of the custom field
- Users cannot add custom fields that are not configured
- Required fields should be present
- If some of the custom fields are omitted from the request the backend will fill them with null values
Limits:
- Maximum 10 custom fields configured
- Maximum 50 chars in custom field labels
- Maximum 160 chars for the value of the Text custom field type
- Users cannot change the type of a custom field
- The key of the custom fields should contain only lowercase letters (a-z), numbers (0-9), '_', and '-'
- Required fields need a value

Testing

Cases created before custom fields are working as expected (create some on main before switching to the feature branch)
Environments without configuration are working as expected (clear ES data)
Environments with existing configurations are working as expected
Try to create cases with custom fields (required & optional) and delete some of them
Try to create cases with custom fields (required & optional) and then configure new custom fields. Existing cases with old custom fields should work as expected
User actions are working as expected especially with the combinations described in the previous two bullets
Users with a basic license can configure custom fields but cannot configure connectors
Users with a gold+ license can configure custom fields and connectors
Users with read access cannot configure or edit custom fields

Resolves: #160236

PRs:

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
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

Allow users to configure custom fields in Cases. Supported field types: Text and Toggle. Coming soon: List, Number, Date, IP, Email, etc.

…-feature-branch

…te --fix'

…-feature-branch

Connected with #160236 **Merging into a Feature Branch** ## Summary This PR defines the `customField` in the Cases API and Domain types. For now, we only allow the custom fields `string`, `boolean`, and `list`. This PR does not include the case configuration types. The default value for the field is `[]`.

## Summary This was missing in my previous PR #165671

@js-jankisalvi

Following up on @js-jankisalvi work I changed the `customFields` property in `CasesConfigure` to be the most basic possible. Changes: - We only accept `TextCustomField` and `ToggleCustomField` in the cases configuration api. - The custom field type used in the Cases domain and API types now comes from the enum in `configure/v1`. - Cases configuration POST requests now require the `customFields` property

…toggle field) (#166483) ## Summary Connected to #160236 ### 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 - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) ### 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) --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Christos Nasikas <[email protected]>

…ic/kibana into cases-custom-fields-feature-branch

Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Janki Salvi <[email protected]>

## Summary This PR implements the following validation: - **Custom field keys should be unique** - Where: - `CaseConfigureService` - x-pack/plugins/cases/server/services/configure/index.ts - `post` - `patch` - Tests: - x-pack/plugins/cases/server/services/configure/index.test.ts - **Limit custom fields to 5** - Where: - `ConfigurationRequestRt` (POST) - `ConfigurationPatchRequestRt` - `CasePostRequestRt` - done in a previous PR - `CasePatchRequestRt` - done in a previous PR - Tests: - x-pack/plugins/cases/server/client/configure/client.test.ts - x-pack/plugins/cases/common/types/api/configure/v1.test.ts - x-pack/plugins/cases/server/client/cases/create.test.ts - x-pack/plugins/cases/server/client/cases/update.test.ts

## Summary This PR limits the length of the property value for `text` custom fields.

## Summary This PR implements the following validation: - **Custom Field Keys need to exist in configuration when creating or updating cases** - Where: - Cases Client - `create` - `update` - Tests: - x-pack/test/cases_api_integration/security_and_spaces/tests/common/cases/patch_cases.ts - x-pack/test/cases_api_integration/security_and_spaces/tests/common/cases/post_case.ts --------- Co-authored-by: kibanamachine <[email protected]>

## Summary This PR adds the ability to add custom fields in the create case form. **Testing** Verify that you all custom fields from configuration are visible in create case form Verify that you can set your custom fields Verify that it throws an error based on the configuration (required: true | false) Connected to #160236 **Create case** https://github.com/elastic/kibana/assets/117571355/8b560804-ea1f-4313-a382-34a17c0750b7 ### Checklist - [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 --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Christos Nasikas <[email protected]>

## Summary Connected to #160236 This PR adds validation in UI to limit maximum number of custom fields to 5 in configuration cases page ![image](https://github.com/elastic/kibana/assets/117571355/7cbb2dfb-bf13-498c-a4a1-1fddeefa4d46) ### 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 --------- Co-authored-by: kibanamachine <[email protected]>

## Summary This PR checks for missing required custom fields in the create case API. (In my next PR I am thinking of moving `casesClient.configure.get({ owner: casePostRequest.owner });` outside of the validation functions.)

cnasikas · 2023-09-29T17:48:19Z

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

+      ).toThrowErrorMatchingInlineSnapshot(`"Missing required custom fields: first_key"`);
+    });
+
+    it('throws if request sends a custom field that is not part of the configuration', () => {


I am wondering if this check exceeds the responsibility of the validation function which is to validate if required fields are present. The validateCustomFieldKeysAgainstConfiguration validates for fields that are not part of the configuration. Though they are not connected in this context and are tested in isolation (test in the create/update routes should ensure that both the validation functions are being called). Wdyt?

you are right, I'll remove it from the validateRequiredCustomFields fn

cnasikas · 2023-09-30T13:11:15Z

@elasticmachine merge upstream

cnasikas · 2023-10-01T09:17:14Z

@elasticmachine merge upstream

cnasikas · 2023-10-02T06:01:39Z

@elasticmachine merge upstream

…ic/kibana into cases-custom-fields-feature-branch

cnasikas · 2023-10-02T09:02:00Z

buildkite test this

cnasikas · 2023-10-02T10:12:07Z

@elasticmachine merge upstream

cnasikas · 2023-10-02T11:16:47Z

Blocked by #167745

cnasikas · 2023-10-02T11:57:37Z

@elasticmachine merge upstream

kibana-ci · 2023-10-02T12:27:21Z

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

[job] [logs] FTR Configs #8 / core plugins rendering service exposes plugin config settings to authenticated users
[job] [logs] FTR Configs #8 / core plugins rendering service exposes plugin config settings to authenticated users

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`cases`	671	700	+29

Async chunks

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

id	before	after	diff
`cases`	423.2KB	441.7KB	+18.5KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`cases`	27	28	+1

Page load bundle

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

id	before	after	diff
`cases`	152.1KB	155.1KB	+3.0KB

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`cases`	58	56	-2

Total ESLint disabled count

id	before	after	diff
`cases`	74	72	-2

History

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

cc @adcoelho @cnasikas @js-jankisalvi

cnasikas

@js-jankisalvi @adcoelho @jcger Great work 🚀

adcoelho and others added 14 commits August 21, 2023 14:26

Cases mapping changes.

2d2cf07

Merge remote-tracking branch 'upstream/main' into cases-custom-fields…

6cd8969

…-feature-branch

[CI] Auto-commit changed files from 'node scripts/check_mappings_upda…

a410657

…te --fix'

Merge remote-tracking branch 'upstream/main' into cases-custom-fields…

e792a0f

…-feature-branch

[Cases] Custom Fields API documentation (#166353)

f204d72

## Summary This was missing in my previous PR #165671

Merge branch 'main' into cases-custom-fields-feature-branch

2d06aee

Merge branch 'cases-custom-fields-feature-branch' of github.com:elast…

7d6d1a2

…ic/kibana into cases-custom-fields-feature-branch

[Cases] Model version the Cases SO for custom fields (#166940)

92e9406

Merge branch 'main' into cases-custom-fields-feature-branch

62d71d4

[Cases] Edit custom fields in the case view page (#166815)

2e1d3e3

Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Janki Salvi <[email protected]>

js-jankisalvi added 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.11.0 labels Sep 22, 2023

Merge branch 'main' into cases-custom-fields-feature-branch

04fc134

cnasikas changed the title ~~[Cases] Allow users to configure, add and update custom fields~~ [Cases] Custom fields MVP Sep 22, 2023

cnasikas assigned adcoelho, cnasikas and js-jankisalvi Sep 22, 2023

adcoelho and others added 7 commits September 22, 2023 15:07

[Cases] Validate length of text custom fields. (#167029)

661a856

## Summary This PR limits the length of the property value for `text` custom fields.

[Cases] Adds the experimental badge to custom fields (#167105)

e5cd8ed

Merge branch 'main' into cases-custom-fields-feature-branch

71b177f

Merge branch 'main' into cases-custom-fields-feature-branch

99fe2a1

cnasikas reviewed Sep 29, 2023

View reviewed changes

Merge branch 'main' into cases-custom-fields-feature-branch

26e1984

cnasikas added the ci:skip-cypress-osquery Skips osquery cypress checks label Oct 1, 2023

Merge branch 'main' into cases-custom-fields-feature-branch

e0ed5fb

kibanamachine and others added 4 commits October 2, 2023 02:01

Merge branch 'main' into cases-custom-fields-feature-branch

af0df9e

remove notRegisteredCustomFields - duplicated

d1c8bb8

Fix cypress cases connectors tests

0447625

Merge branch 'cases-custom-fields-feature-branch' of github.com:elast…

4f164aa

…ic/kibana into cases-custom-fields-feature-branch

Merge branch 'main' into cases-custom-fields-feature-branch

c56cc31

cnasikas mentioned this pull request Oct 2, 2023

[Security Solution][Detection Engine] fixes type errors, adds category for new ES|QL rule type #167745

Merged

Merge branch 'main' into cases-custom-fields-feature-branch

4122735

cnasikas approved these changes Oct 2, 2023

View reviewed changes

js-jankisalvi merged commit 8da8c47 into main Oct 2, 2023

js-jankisalvi deleted the cases-custom-fields-feature-branch branch October 2, 2023 13:47

kibanamachine added the backport:skip This commit does not require backporting label Oct 2, 2023

cnasikas mentioned this pull request Oct 2, 2023

[Cases] Custom fields MVP leftovers #167793

Closed

jcger mentioned this pull request Oct 9, 2023

[Cases] Custom Fields: List Type Design #168378

Open

js-jankisalvi mentioned this pull request Oct 24, 2023

[Cases] Rename URL from cases/configure to cases/settings #169636

Open

This was referenced Nov 23, 2023

[Cases] Add the ability to define custom fields #153836

Closed

[Cases] Users can navigate to the configuration page without a platinum license #159773

Closed

cnasikas mentioned this pull request Jan 8, 2024

[Cases] Handle cases table overflow when having a lot of columns #174437

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] Custom fields MVP #167016

[Cases] Custom fields MVP #167016

js-jankisalvi commented Sep 22, 2023 •

edited by cnasikas

Loading

cnasikas Sep 29, 2023

jcger Oct 2, 2023

cnasikas commented Sep 30, 2023

cnasikas commented Oct 1, 2023

cnasikas commented Oct 2, 2023

cnasikas commented Oct 2, 2023

cnasikas commented Oct 2, 2023

cnasikas commented Oct 2, 2023

cnasikas commented Oct 2, 2023

kibana-ci commented Oct 2, 2023 •

edited

Loading

ESLint disabled line counts

Total ESLint disabled count

cnasikas left a comment

[Cases] Custom fields MVP #167016

[Cases] Custom fields MVP #167016

Conversation

js-jankisalvi commented Sep 22, 2023 • edited by cnasikas Loading

Summary

Testing

Checklist

For maintainers

Release notes

cnasikas Sep 29, 2023

Choose a reason for hiding this comment

jcger Oct 2, 2023

Choose a reason for hiding this comment

cnasikas commented Sep 30, 2023

cnasikas commented Oct 1, 2023

cnasikas commented Oct 2, 2023

cnasikas commented Oct 2, 2023

cnasikas commented Oct 2, 2023

cnasikas commented Oct 2, 2023

cnasikas commented Oct 2, 2023

kibana-ci commented Oct 2, 2023 • edited Loading

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

Public APIs missing exports

Page load bundle

ESLint disabled line counts

Total ESLint disabled count

History

cnasikas left a comment

Choose a reason for hiding this comment

js-jankisalvi commented Sep 22, 2023 •

edited by cnasikas

Loading

kibana-ci commented Oct 2, 2023 •

edited

Loading