[Cases] Add custom fields: List type #194236

Zacqary · 2024-09-26T22:37:06Z

Summary

Adds the List custom field type to Cases. Also makes some changes to the custom field configuration type system to handle the new features added in this field type.

The List field type creates a <select> dropdown with a set of options determined by the custom field's configuration. Options are defined as { key: UUID, label: String }.

When the user selects a value, it is saved to the case with the schema { key: ${Field UUID}.{Option UUID}, label: Option Label }. When fetching the case, this key is transformed into a {key: Field UUID, value: Option UUID} pair so that the UI can fetch current option label from the field configuration schema. Therefore, option labels can be renamed and display their correct label in the UI, but updating the label in the case SavedObject will still require a followup issue. Fortunately the only thing this affects is sorting, which is not yet implemented at the UI level for any custom field type.

This PR also allows List fields to be filtered. This required a change from using static filterOptions in custom field configurations to a dynamic getFilterOptions function. The Toggle field was updated to use this new dynamic function.

Known Issues

~~Due to elastic/eui#8027 drag-and-drop on the new <OptionsField> doesn't correctly render the current draggable element inside the flyout. EUI is aiming to fix this before 8.16.~~ UPDATE: This should be fixed

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios

obltmachine · 2024-09-26T22:37:19Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

…ustom-field

adcoelho

Could you please also update the tests in x-pack/test/cases_api_integration/security_and_spaces/tests/common/cases to include examples of list custom fields?

adcoelho · 2024-12-04T14:51:12Z

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

+const CaseCustomFieldListWithValidationRt = rt.strict({
+  key: rt.string,
+  type: CustomFieldListTypeRt,
+  value: rt.union([CaseCustomFieldListWithValidationValueRt('value'), rt.null]),


I am not sure this is the right approach. Why not just save the key?

Testing this with the API led me to some weird scenarios.

Try the following:

Create a list custom field with a few different options.

Send a case POST request where the custom field value has:(1) a correct key, and(2) a wrong value/label.

The case detail page renders the correct label but the case GET API returns the wrong label that does not exist in the configuration.

Some screenshots illustrating this scenario:

My configuration

The POST request

The case detail page

I am not sure this is the right approach. Why not just save the key?

Already decided on in #168378

Text of the custom field labels need to be searchable and queryable

Send a case POST request where the custom field value has:(1) a correct key, and(2) a wrong value/label.

Let me take a look and see if I can get the POST to only contain the key and derive the label from it on the server side. That's probably the safest.

For type system simplicity it looks like the easiest solution is to validate both that the correct key exists and that the label matches the key.

x-pack/plugins/cases/common/types/api/configure/v1.ts

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

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

js-jankisalvi · 2024-12-05T13:07:35Z

Found an issue in continuation to what @adcoelho found while deleting an option. Once the option which was selected as defaultValue is deleted, the next option is set as default in custom field. However it is not visible when case is created.
Fixed in 3166029 and also added validation for this on the server

works fine 👍

Required list custom fields do not seem to work properly with the case action and templates.

++
Some weird behaviour with custom fields with value in the template as well (both required and optional). It seems to take wrong list value while creating a case with the template.

custom_field_with_template.mov

js-jankisalvi

Code changes LGTM except some minor comments.
Agree with @adcoelho's concern about saving the option key instead of value for case's custom field.

x-pack/plugins/cases/common/types/api/custom_field/v1.ts

x-pack/plugins/cases/common/types/domain/configure/v1.ts

x-pack/plugins/cases/common/types/domain/custom_field/v1.ts

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

js-jankisalvi · 2024-12-09T16:52:54Z

x-pack/plugins/cases/public/components/configure_cases/index.test.tsx

-                    type: customFieldsConfigurationMock[5].type,
-                    value: null,
-                  },
+                  ...customFieldsConfigurationMock.map(({ key, type, defaultValue, required }) => ({


Thanks for doing this! 😄

js-jankisalvi · 2024-12-09T17:18:02Z

x-pack/plugins/cases/public/components/custom_fields/list/edit.tsx

+  // When updating the field, store the selected value while waiting for the response
+  // Display the selected value in the view component while waiting, and only switch it back to the
+  // previous value if the response fails
+  const [optimisticDisplayField, setOptimisticDisplayField] = useState<CaseCustomFieldList | null>(


Nice name 😄 Does it take lot of time to get response here?

It takes a couple seconds, not long but long enough to bother me personally 🤣

Zacqary · 2024-12-12T16:51:38Z

@adcoelho @js-jankisalvi I also had concerns about saving the option key and the label instead of just saving the option key. As per @cnasikas's comment here this is the schema we have to use on this feature.

…ustom-field

…ustom-field # Conflicts: # x-pack/platform/plugins/shared/cases/common/types/api/configure/v1.ts # x-pack/platform/plugins/shared/cases/common/types/domain/configure/v1.ts # x-pack/platform/plugins/shared/cases/public/components/custom_fields/toggle/configure_text_field.test.ts # x-pack/platform/plugins/shared/cases/public/components/custom_fields/toggle/configure_toggle_field.test.ts # x-pack/platform/plugins/shared/cases/server/custom_fields/list.ts # x-pack/platform/plugins/shared/cases/server/services/cases/transform.ts # x-pack/plugins/cases/public/components/custom_fields/toggle/configure_text_field.test.ts

elasticmachine · 2024-12-26T19:54:28Z

💔 Build Failed

Buildkite Build
Commit: 4d3ab53

Failed CI Steps

Build Kibana Distribution

History

💔 Build #263043 failed ec0709a
💛 Build #261105 was flaky 3ba29b6
💚 Build #260502 succeeded 453bde6
💔 Build #260138 failed 9bf7202
💔 Build #260121 failed 2612dc2

Zacqary added 8 commits September 24, 2024 13:12

WIP

8a5af8c

Get creatie and view components working

facfa12

Fix creating with default value

cbe96ac

Fix edit component

79c47bc

Commit missing helpers

6986bc9

Move to pure key/val SO system and implement in frontend

6363db9

Add filtering for list fields

48bba35

Add configure test

9609732

Zacqary added release_note:enhancement Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v9.0.0 Feature:Cases Cases feature v8.16.0 backport:version Backport to applied version labels labels Sep 26, 2024

Zacqary added 15 commits September 26, 2024 17:38

Fix server default value for list

35caf9d

Fix user action display

d254d33

Update custom field user action tests

8c56aa2

Add create test

8750918

Add create test

9f365ab

Add edit test

7ef1d32

Add getEuiTableColumn test

8f445ee

Add view test

c0c5816

Add options field validation

8595ac4

Add configure test

90b9e92

Type fix in index test

66be662

Merge remote-tracking branch 'upstream/main' into 176491-cases-list-c…

cd00f54

…ustom-field

Fix cases index jest test

4e60410

Fix api jest

df2bded

Fix flyout jest

1d807aa

adcoelho reviewed Dec 4, 2024

View reviewed changes

x-pack/plugins/cases/common/types/api/configure/v1.ts Outdated Show resolved Hide resolved

adcoelho reviewed Dec 4, 2024

View reviewed changes

x-pack/plugins/cases/common/types/api/case/v1.ts Outdated Show resolved Hide resolved

adcoelho reviewed Dec 4, 2024

View reviewed changes

x-pack/plugins/cases/public/api/utils.ts Outdated Show resolved Hide resolved

js-jankisalvi reviewed Dec 9, 2024

View reviewed changes

Zacqary added 15 commits December 12, 2024 11:08

Remove nits and UUID regex check

86715cc

Handle edge cases of . in custom field key

5c07feb

Limit custom field option length to 50

bbe8113

Merge remote-tracking branch 'upstream/main' into 176491-cases-list-c…

7a765d9

…ustom-field

Validate custom field keys and values in request

68efe46

Add custom field transform tests

8df11bb

Add List RT type tests

30288e7

Update case api tests

aeaad56

Add tests for custom field and single key/val validation

adb98a3

Remove commented code

45d3d47

Add api schema tests

0d222e8

Add api tests and fix types

2612dc2

Fix typecheck

9bf7202

Fix customFieldListValue chaining

453bde6

Handle default list values for case actions

ba3bb28

Zacqary requested a review from adcoelho December 16, 2024 20:41

Merge remote-tracking branch 'upstream/main' into 176491-cases-list-c…

3ba29b6

…ustom-field

Zacqary requested a review from js-jankisalvi December 16, 2024 20:41

Zacqary added 3 commits December 16, 2024 16:28

Fix [object Object] in user action comment

258af32

Fix bad merge

4d3ab53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] Add custom fields: List type #194236

[Cases] Add custom fields: List type #194236

Zacqary commented Sep 26, 2024 •

edited

Loading

obltmachine commented Sep 26, 2024

adcoelho left a comment

adcoelho Dec 4, 2024

Zacqary Dec 12, 2024

Zacqary Dec 12, 2024

Zacqary Dec 12, 2024

js-jankisalvi commented Dec 5, 2024

js-jankisalvi left a comment

js-jankisalvi Dec 9, 2024

js-jankisalvi Dec 9, 2024

Zacqary Dec 12, 2024

Zacqary commented Dec 12, 2024

elasticmachine commented Dec 26, 2024 •

edited

Loading

[Cases] Add custom fields: List type #194236

Are you sure you want to change the base?

[Cases] Add custom fields: List type #194236

Conversation

Zacqary commented Sep 26, 2024 • edited Loading

Summary

Known Issues

Checklist

obltmachine commented Sep 26, 2024

🤖 GitHub comments

adcoelho left a comment

Choose a reason for hiding this comment

adcoelho Dec 4, 2024

Choose a reason for hiding this comment

My configuration

The POST request

The case detail page

Zacqary Dec 12, 2024

Choose a reason for hiding this comment

Zacqary Dec 12, 2024

Choose a reason for hiding this comment

Zacqary Dec 12, 2024

Choose a reason for hiding this comment

js-jankisalvi commented Dec 5, 2024

js-jankisalvi left a comment

Choose a reason for hiding this comment

js-jankisalvi Dec 9, 2024

Choose a reason for hiding this comment

js-jankisalvi Dec 9, 2024

Choose a reason for hiding this comment

Zacqary Dec 12, 2024

Choose a reason for hiding this comment

Zacqary commented Dec 12, 2024

elasticmachine commented Dec 26, 2024 • edited Loading

💔 Build Failed

Failed CI Steps

History

Zacqary commented Sep 26, 2024 •

edited

Loading

elasticmachine commented Dec 26, 2024 •

edited

Loading