[Cases] Custom field default values in configuration forms #174628

adcoelho · 2024-01-10T14:54:08Z

See #171747 for more info

Summary

Merging into a feature branch.

This PR handles only the cases configuration page.

With these changes, users can now configure default values for custom fields in the UI.

Text custom field

Toggle custom field

When clicking required the default value for a toggle custom field is false.

When clicking required the default value for a text custom field is an empty string.

Trying to save an empty `string` as the default value of a `text` custom field should display an error message on the form.

Viewing previously created custom fields should display their default values correctly.

Viewing previously created custom fields in a version where default values did not exist should display the forms correctly.

Other Notes

I changed the property name from default_value to defaultValue
I fixed some instances of expect(screen.getById... where I found them.
I addressed most comments left from the previous PR. The last one will be a separate PR(moving some types around).

…m-fields-pr

…into forms-default-custom-fields

elasticmachine · 2024-01-12T13:05:07Z

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

elasticmachine · 2024-01-12T13:05:09Z

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

…into forms-default-custom-fields

cnasikas

Great work! I tested the code and I found the following:

On certain configurations, I can stuck on an "infinitive loop" where I cannot edit any custom field nor add a new one. This could happen if I have two custom fields with required fields created before the PR. If I try to set the default value in any of them add a new custom field or edit any of the others I get an error regarding missing default values. The reason is because on the request we put all the custom fields but I can edit only one per time in the UI. One easy solution would be to put our default (using the serializer) if a) the field is required and b) the default value is not set. Any other ideas?
For another PR, should we change the IDs in the toaster to the labels to make it easier to understand which field needs fixing?
The default value for the toggle feels a bit off. What about a select dropdown or putting labels next to the checkbox?

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

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

x-pack/plugins/cases/public/components/custom_fields/text/configure.test.tsx

x-pack/plugins/cases/public/components/custom_fields/text/configure.tsx

x-pack/plugins/cases/public/components/custom_fields/toggle/configure.test.tsx

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

x-pack/plugins/cases/public/components/custom_fields/flyout.test.tsx

x-pack/plugins/cases/public/components/custom_fields/form.test.tsx

x-pack/plugins/cases/public/components/custom_fields/translations.ts

adcoelho · 2024-01-16T13:01:39Z

The reason is because on the request we put all the custom fields but I can edit only one per time in the UI. One easy solution would be to put our default (using the serializer) if a) the field is required and b) the default value is not set.

I like this idea, it is kind of what we will be doing in the update case iirc. I'll handle it 👍

For another PR, should we change the IDs in the toaster to the labels to make it easier to understand which field needs fixing?

Definitely, I found and fixed a similar error some time ago but I think it might have been in the update case page.

EDIT: We discussed this offline and I will address them in different PRs

cnasikas

LGTM! About the bug I found in my previous review, we discussed offline and it will be addressed on another PR. What do you think about this (can be done on another PR):

The default value for the toggle feels a bit off. What about a select dropdown or putting labels next to the checkbox?

x-pack/plugins/cases/public/components/create/custom_fields.test.tsx

x-pack/plugins/cases/public/components/custom_fields/flyout.test.tsx

x-pack/plugins/cases/public/components/custom_fields/form.test.tsx

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

x-pack/plugins/cases/public/components/custom_fields/schema.tsx

adcoelho · 2024-01-17T10:40:14Z

@cnasikas

The default value for the toggle feels a bit off. What about a select dropdown or putting labels next to the checkbox?

Forgot to comment on this, how about writing false/true next to the checkbox? I also think it looks weird right now but didn't have a better idea.

cnasikas · 2024-01-17T10:51:07Z

@adcoelho I rethink about it and I believe the EUI component we use for the defaultValue should be the same as the one we use for the value. So for the defaultValue we should use the EuiSwitch. This will avoid confusion. Wdyt?

adcoelho · 2024-01-17T13:14:03Z

@cnasikas

@adcoelho I rethink about it and I believe the EUI component we use for the defaultValue should be the same as the one we use for the value. So for the defaultValue we should use the EuiSwitch. This will avoid confusion. Wdyt?

Just made the change in the last commit 👍

kibana-ci · 2024-01-17T16:35:03Z

💔 Build Failed

Failed CI Steps

Post-Build

Metrics [docs]

‼️ ERROR: no builds found for mergeBase sha [683fad8]

History

💔 Build #187901 failed 55922cc
💔 Build #187654 failed 789e93a
💔 Build #187622 failed 39d4088
💔 Build #187483 failed 3530cc8
💔 Build #187447 failed f132003
💔 Build #187416 failed 663e23f

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

cc @adcoelho

## Summary **Merging into a feature branch.** Custom field error messages in the case configuration page now list the custom field `label`s instead of `key`s. The message was updated for the following errors: 1. Custom field type error (trying to change a custom field type) 2. Missing default value from required custom field 3. Trying to define a default value for an optional custom field Additionally, the error message for custom field type errors in the cases API was also updated. This PR fixes a bug discussed [in a previous comment](#174628 (review)). > For another PR, should we change the IDs in the toaster to the labels to make it easier to understand which field needs fixing? <details><summary>Screenshot</summary> <img width="1955" alt="Screenshot 2024-01-22 at 12 03 30" src="https://github.com/elastic/kibana/assets/1533137/c4a2b83e-b40f-420d-9b74-575f3f92d819"></details>

Closes #171747 Fixes #174285 Fixes #174286 Fixes #174287 Fixes #174288 Fixes #174289 ## Summary This feature branch introduces default values to the custom fields in Cases. Changes: - The case configuration API now supports defining default values **for required custom fields**. - The default value field is optional. - The default value field must have the same type as the custom field. - Default values for required custom fields can be configured in the cases settings page. - The Create and Update Case pages now prefill required custom fields with their default value(if it exists). - Create and Update case API - required custom field missing from the request: - if the default value exists -> set the custom field to the default value - if the default value is missing from the configuration -> throws an error - creating required custom fields with `value: null` -> always throws an error ### Previous PRs #174043 #174845 #174628 #175197 #175978 #175795 ## Testing I'll leave here a couple of important use cases to test: - Migration scenario 1. Create **multiple** required custom fields in 8.12. 2. Migrate to the feature branch (future 8.13). 3. Defining default values in the settings page should work as expected. - Update case UI 1. Create an optional custom field 2. Create a case and leave the custom field empty 3. Edit the custom field to now be required 4. Go to the case detail page and edit the custom field 5. Is the form populated automatically with the default value? ## Release notes Required custom fields now support default values. These default values will be used to populate automatically the custom fields if they are not defined when creating and updating cases. --------- Co-authored-by: Kibana Machine <[email protected]>

Closes elastic#171747 Fixes elastic#174285 Fixes elastic#174286 Fixes elastic#174287 Fixes elastic#174288 Fixes elastic#174289 ## Summary This feature branch introduces default values to the custom fields in Cases. Changes: - The case configuration API now supports defining default values **for required custom fields**. - The default value field is optional. - The default value field must have the same type as the custom field. - Default values for required custom fields can be configured in the cases settings page. - The Create and Update Case pages now prefill required custom fields with their default value(if it exists). - Create and Update case API - required custom field missing from the request: - if the default value exists -> set the custom field to the default value - if the default value is missing from the configuration -> throws an error - creating required custom fields with `value: null` -> always throws an error ### Previous PRs elastic#174043 elastic#174845 elastic#174628 elastic#175197 elastic#175978 elastic#175795 ## Testing I'll leave here a couple of important use cases to test: - Migration scenario 1. Create **multiple** required custom fields in 8.12. 2. Migrate to the feature branch (future 8.13). 3. Defining default values in the settings page should work as expected. - Update case UI 1. Create an optional custom field 2. Create a case and leave the custom field empty 3. Edit the custom field to now be required 4. Go to the case detail page and edit the custom field 5. Is the form populated automatically with the default value? ## Release notes Required custom fields now support default values. These default values will be used to populate automatically the custom fields if they are not defined when creating and updating cases. --------- Co-authored-by: Kibana Machine <[email protected]>

adcoelho added 5 commits December 28, 2023 19:18

Initial commit.

bf2fef8

Merge remote-tracking branch 'upstream/main' into first-default-custo…

faf1a77

…m-fields-pr

Fixed failing tests

7c09d91

Fixed failing tests 2

ad0c1b8

Initial commit.

425a002

adcoelho added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Cases Cases feature v8.13.0 labels Jan 10, 2024

adcoelho self-assigned this Jan 10, 2024

adcoelho added 3 commits January 11, 2024 15:16

Merge remote-tracking branch 'upstream/custom-fields-default-values' …

14e0df0

…into forms-default-custom-fields

Tests.

38c5c73

Addressing old PR comments

4af0fab

adcoelho marked this pull request as ready for review January 12, 2024 13:05

adcoelho requested a review from a team as a code owner January 12, 2024 13:05

adcoelho added 3 commits January 15, 2024 11:02

Merge remote-tracking branch 'upstream/custom-fields-default-values' …

663e23f

…into forms-default-custom-fields

additional tests

f132003

fix failing tests after merging the FB

3530cc8

This was referenced Jan 15, 2024

[Cases] Create custom_field api types folder #174845

Merged

[Cases] Create and Update cases with custom fields default values #174852

Merged

cnasikas reviewed Jan 15, 2024

View reviewed changes

Addressing PR comments.

39d4088

Addressing PR comments 2.

789e93a

cnasikas reviewed Jan 16, 2024

View reviewed changes

Final pr comments.

55922cc

adcoelho added 3 commits January 17, 2024 15:39

Move text default value validation.

b057f57

change label

66d62c0

field label

b2878bb

cnasikas approved these changes Jan 18, 2024

View reviewed changes

adcoelho merged commit 8dc8647 into elastic:custom-fields-default-values Jan 18, 2024
20 of 21 checks passed

adcoelho mentioned this pull request Jan 22, 2024

[Cases] Update custom field error toast message #175197

Merged

This was referenced Jan 29, 2024

[Cases ] Fill missing default values in configuration requests #175825

Closed

[Cases] Custom fields default values #175961

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] Custom field default values in configuration forms #174628

[Cases] Custom field default values in configuration forms #174628

adcoelho commented Jan 10, 2024 •

edited

Loading

elasticmachine commented Jan 12, 2024

elasticmachine commented Jan 12, 2024

cnasikas left a comment •

edited

Loading

adcoelho commented Jan 16, 2024 •

edited

Loading

cnasikas left a comment •

edited

Loading

adcoelho commented Jan 17, 2024

cnasikas commented Jan 17, 2024

adcoelho commented Jan 17, 2024

kibana-ci commented Jan 17, 2024

[Cases] Custom field default values in configuration forms #174628

[Cases] Custom field default values in configuration forms #174628

Conversation

adcoelho commented Jan 10, 2024 • edited Loading

Summary

Other Notes

elasticmachine commented Jan 12, 2024

elasticmachine commented Jan 12, 2024

cnasikas left a comment • edited Loading

Choose a reason for hiding this comment

adcoelho commented Jan 16, 2024 • edited Loading

cnasikas left a comment • edited Loading

Choose a reason for hiding this comment

adcoelho commented Jan 17, 2024

cnasikas commented Jan 17, 2024

adcoelho commented Jan 17, 2024

kibana-ci commented Jan 17, 2024

💔 Build Failed

Failed CI Steps

Metrics [docs]

History

adcoelho commented Jan 10, 2024 •

edited

Loading

cnasikas left a comment •

edited

Loading

adcoelho commented Jan 16, 2024 •

edited

Loading

cnasikas left a comment •

edited

Loading