[Cases] Delete custom field #167167

js-jankisalvi · 2023-09-25T15:44:43Z

Summary

This PR allows users to delete custom fields in settings page.

Screen.Recording.2023-09-25.at.17.41.24.mov

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
Unit or functional tests were updated or added to match the most common scenarios

…te --fix'

…anch' into edit-custom-field

…anch' into delete-custom-field

elasticmachine · 2023-09-25T15:44:46Z

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

js-jankisalvi · 2023-09-25T15:50:49Z

x-pack/plugins/cases/public/components/create/form_context.tsx


        if (configCustomField) {
+          const fieldValue =
+            configCustomField.type === CustomFieldTypes.TEXT && isEmpty(value) ? null : [value];


There was a bug where you switch the toggle field as on during create case and it still remained off in case view page.
Because it was set to null here.

Instead of checking specifically for a custom field type we can do isEmpty(value) && value !== false ? null : [value]

This check still have issue when toggle field value is true when creating a case, I updated it to isEmpty(value) && typeof value !== 'boolean' ? null : [value];

When we have more custom fields in future, we can create some util function to handle different types.

Oh, you are right. Ok!

js-jankisalvi · 2023-09-25T15:52:48Z

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

+            font-weight: ${euiTheme.font.weight.bold};
+          `}
+        >
+          {i18n.ADDITIONAL_FIELDS}


Missed this header from the designs.

What about using an h3 or h4 and playing with the size instead of using CSS?

…-ref HEAD~1..HEAD --fix'

…i/kibana into delete-custom-field

…-fix'

cnasikas · 2023-09-26T06:42:12Z

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

@@ -41,6 +45,17 @@ const CustomFieldsComponent: React.FC<Props> = ({ isLoading, customFieldsConfigu

  return (
    <EuiFlexGroup direction="column" gutterSize="s">
+      {customFieldsComponents.length ? (


It seems to me that the whole component should not be returned if the are no custom fields configured. Maybe we can either return null for the whole component ({customFieldsComponents.length ? ( <EuiFlexGroup direction="column" gutterSize="s">....) or in x-pack/plugins/cases/public/components/create/form.tsx check if customFieldsConfiguration and not render CustomFields if they are empty.

cnasikas · 2023-09-26T06:46:37Z

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

+
+    userEvent.click(screen.getByText('Cancel'));
+    await waitFor(() => {
+      expect(onDeleteCustomField).not.toHaveBeenCalledWith();


I think is better to wait here so that the confirm-delete-custom-field-modal is not shown anymore. This way we can be sure that expect(onDeleteCustomField).not.toHaveBeenCalledWith(); is not true because it has not been called yet.

cnasikas · 2023-09-26T07:02:27Z

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

-  const { customFields } = props;
+  const { customFields, onDeleteCustomField } = props;
+  const { euiTheme } = useEuiTheme();
+  const [showDeletionModal, setShowDeletionModal] = useState<{


nit: if you want to simplify a bit the code you can do const [selectedItem, setSelectedItem] = useState<CustomFieldsConfiguration[number] | null>(null). Then you can do const showModal = Boolean(selectedItem). Also,

onClick={() => setSelectedItem(customFields) }

cnasikas · 2023-09-26T07:17:15Z

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

I noticed that above we have customFields.length === 5. Let's use MAX_CUSTOM_FIELDS_PER_CASE.

cnasikas

LGTM! I left some comments.

cnasikas · 2023-09-26T08:57:02Z

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

-          {i18n.ADDITIONAL_FIELDS}
-        </EuiText>
-      ) : null}
+      <h3


Sorry, what I meant was

<EuiText size="m"> <h3>{i18n.ADDITIONAL_FIELDS}</h3> </EuiText>

By size I mean the size of the EuiText.

oh okay 😄

kibana-ci · 2023-09-26T09:31:33Z

💔 Build Failed

Failed CI Steps

Test Failures

[job] [logs] FTR Configs #43 / Cases Configure Closure options change closure option successfully
[job] [logs] FTR Configs #43 / Cases Configure Closure options change closure option successfully
[job] [logs] Cases Cypress Tests on Security Solution / Cases connector incident fields Correct incident fields show when connector is changed Correct incident fields show when connector is changed
[job] [logs] Cases Cypress Tests on Security Solution / Cases connector incident fields Correct incident fields show when connector is changed Correct incident fields show when connector is changed
[job] [logs] Serverless Security Explore Cypress Tests #1 / Cases connectors Configures a new connector Configures a new connector
[job] [logs] Cases Cypress Tests on Security Solution / Cases connectors Configures a new connector Configures a new connector
[job] [logs] Serverless Security Explore Cypress Tests #1 / Cases connectors Configures a new connector Configures a new connector
[job] [logs] Cases Cypress Tests on Security Solution / Cases connectors Configures a new connector Configures a new connector
[job] [logs] FTR Configs #3 / cases security and spaces enabled: basic Common patch_cases happy path should patch a case with customFields
[job] [logs] FTR Configs #3 / cases security and spaces enabled: basic Common patch_cases happy path should patch a case with customFields
[job] [logs] FTR Configs #12 / cases security and spaces enabled: trial Common patch_cases happy path should patch a case with customFields
[job] [logs] FTR Configs #12 / cases security and spaces enabled: trial Common patch_cases happy path should patch a case with customFields
[job] [logs] Jest Integration Tests #5 / checking migration metadata changes on all registered SO types detecting migration related changes in registered types
[job] [logs] FTR Configs #18 / serverless common UI Index Management Index Templates "before all" hook for "renders the index templates tab"
[job] [logs] FTR Configs #23 / Serverless observability API Cases get_case should return a case
[job] [logs] FTR Configs #23 / Serverless observability API Cases get_case should return a case
[job] [logs] FTR Configs #58 / Serverless security API Cases get_case should return a case
[job] [logs] FTR Configs #58 / Serverless security API Cases get_case should return a case
[job] [logs] FTR Configs #15 / uptime uptime REST endpoints with real-world data UptimeIntegrationDeprecation should return hasIntegrationMonitors true when there are zip url policies
[job] [logs] FTR Configs #15 / uptime uptime REST endpoints with real-world data UptimeIntegrationDeprecation should return hasIntegrationMonitors true when there are zip url policies

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`cases`	698	699	+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`	441.7KB	443.5KB	+1.8KB

History

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

cc @js-jankisalvi

## 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 needs 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: - #165671 - #166353 - #166439 - #166483 - #166815 - #166940 - #166962 - #166969 - #166975 - #167029 - #167047 - #167105 - #167131 - #167144 - #167166 - #167167 - #167310 - #167386 - #167481 - #167495 - #167398 - #167472 ### 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] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [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) ## Release notes Allow users to configure custom fields in Cases. Supported field types: Text. Coming soon: Multi-text, List, Number, Toggle, Date, IP, Email, etc. --------- Co-authored-by: adcoelho <[email protected]> Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Christos Nasikas <[email protected]> Co-authored-by: Julian Gernun <[email protected]>

kibanamachine and others added 7 commits August 21, 2023 13:48

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

de7fdd1

…te --fix'

Merge remote-tracking branch 'upstream/cases-custom-fields-feature-br…

49f83df

…anch' into edit-custom-field

Merge remote-tracking branch 'upstream/cases-custom-fields-feature-br…

f97a383

…anch' into delete-custom-field

delete custom fields

69f0e41

Merge remote-tracking branch 'upstream/cases-custom-fields-feature-br…

8f8829b

…anch' into delete-custom-field

resolve conflict

5b71acc

clean up

65c2bcd

js-jankisalvi added release_note:skip Skip the PR/issue when compiling release notes Team:Endpoint Response Endpoint Response Team Feature:Cases Cases feature v8.11.0 labels Sep 25, 2023

js-jankisalvi self-assigned this Sep 25, 2023

js-jankisalvi requested a review from a team as a code owner September 25, 2023 15:44

js-jankisalvi commented Sep 25, 2023

View reviewed changes

js-jankisalvi and others added 5 commits September 25, 2023 17:59

set error to false when custom field is deleted

b31832f

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

80a5eb2

…-ref HEAD~1..HEAD --fix'

delete description updated

c54bb61

Merge branch 'delete-custom-field' of https://github.com/js-jankisalv…

927d4b8

…i/kibana into delete-custom-field

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

d35b8ae

…-fix'

cnasikas reviewed Sep 26, 2023

View reviewed changes

cnasikas approved these changes Sep 26, 2023

View reviewed changes

PR feedback

4e4bdab

cnasikas reviewed Sep 26, 2023

View reviewed changes

update header correctly

e605af4

js-jankisalvi merged commit 608038d into elastic:cases-custom-fields-feature-branch Sep 26, 2023
1 check passed

This was referenced Sep 28, 2023

[Cases] Custom fields in Cases #160236

Closed

[Cases] Custom fields MVP #167016

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cases] Delete custom field #167167

[Cases] Delete custom field #167167

js-jankisalvi commented Sep 25, 2023

elasticmachine commented Sep 25, 2023

js-jankisalvi Sep 25, 2023 •

edited

Loading

cnasikas Sep 26, 2023 •

edited

Loading

js-jankisalvi Sep 26, 2023 •

edited

Loading

cnasikas Sep 26, 2023

js-jankisalvi Sep 25, 2023 •

edited by cnasikas

Loading

cnasikas Sep 26, 2023

cnasikas Sep 26, 2023

cnasikas Sep 26, 2023

cnasikas Sep 26, 2023

cnasikas Sep 26, 2023 •

edited

Loading

cnasikas left a comment

cnasikas Sep 26, 2023

cnasikas Sep 26, 2023

js-jankisalvi Sep 26, 2023

kibana-ci commented Sep 26, 2023 •

edited

Loading

[Cases] Delete custom field #167167

[Cases] Delete custom field #167167

Conversation

js-jankisalvi commented Sep 25, 2023

Summary

Checklist

elasticmachine commented Sep 25, 2023

js-jankisalvi Sep 25, 2023 • edited Loading

Choose a reason for hiding this comment

cnasikas Sep 26, 2023 • edited Loading

Choose a reason for hiding this comment

js-jankisalvi Sep 26, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

js-jankisalvi Sep 25, 2023 • edited by cnasikas 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

cnasikas Sep 26, 2023 • edited Loading

Choose a reason for hiding this comment

cnasikas 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

kibana-ci commented Sep 26, 2023 • edited Loading

💔 Build Failed

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

History

js-jankisalvi Sep 25, 2023 •

edited

Loading

cnasikas Sep 26, 2023 •

edited

Loading

js-jankisalvi Sep 26, 2023 •

edited

Loading

js-jankisalvi Sep 25, 2023 •

edited by cnasikas

Loading

cnasikas Sep 26, 2023 •

edited

Loading

kibana-ci commented Sep 26, 2023 •

edited

Loading