Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Conversation

cnasikas
Copy link
Member

@cnasikas cnasikas commented Sep 24, 2023

This PR adds the experimental badge in the custom fields on the "Settings" page. It also renames the header of the configuration page to "Settings".

Screenshot 2023-09-24 at 2 24 54 PM Screenshot 2023-09-24 at 2 30 21 PM

Connected to #160236

Checklist

Delete any items that are not applicable to this PR.

For maintainers

@cnasikas cnasikas 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.11.0 labels Sep 24, 2023
@cnasikas cnasikas self-assigned this Sep 24, 2023
@cnasikas cnasikas requested a review from a team as a code owner September 24, 2023 11:27
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@kibana-ci
Copy link
Collaborator

kibana-ci commented Sep 24, 2023

💔 Build Failed

Failed CI Steps

Test Failures

  • [job] [logs] x-pack/test/alerting_api_integration/security_and_spaces/group2/config_non_dedicated_task_runner.ts / alerting api integration security and spaces enabled - Group 2 Alerts alerts getActionErrorLog no_kibana_privileges at space1 gets action error logs for rules with action errors with appropriate authorization
  • [job] [logs] x-pack/test/alerting_api_integration/security_and_spaces/group2/config.ts / alerting api integration security and spaces enabled - Group 2 Alerts alerts getActionErrorLog no_kibana_privileges at space1 gets action error logs for rules with action errors with appropriate authorization
  • [job] [logs] x-pack/test/alerting_api_integration/security_and_spaces/group2/config.ts / alerting api integration security and spaces enabled - Group 2 Alerts alerts getActionErrorLog no_kibana_privileges at space1 gets action error logs for rules with action errors with appropriate authorization
  • [job] [logs] x-pack/test/alerting_api_integration/security_and_spaces/group2/config_non_dedicated_task_runner.ts / alerting api integration security and spaces enabled - Group 2 Alerts alerts getActionErrorLog no_kibana_privileges at space1 gets action error logs for rules with action errors with appropriate authorization
  • [job] [logs] FTR Configs #28 / Cases Configure Closure options change closure option successfully
  • [job] [logs] FTR Configs #28 / 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] Jest Integration Tests #3 / checking migration metadata changes on all registered SO types detecting migration related changes in registered types
  • [job] [logs] FTR Configs #43 / Serverless observability API Cases get_case should return a case
  • [job] [logs] FTR Configs #43 / Serverless observability API Cases get_case should return a case
  • [job] [logs] FTR Configs #61 / Serverless security API Cases get_case should return a case
  • [job] [logs] FTR Configs #61 / Serverless security API Cases get_case should return a case

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
cases 693 694 +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 439.2KB 439.3KB +122.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 154.0KB 154.5KB +511.0B

History

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

cc @cnasikas

Copy link
Contributor

@js-jankisalvi js-jankisalvi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

verified locally, looks good 👍

Copy link
Contributor

@adcoelho adcoelho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested too, works fine 👌

(Nice that you also renamed the button that leads to the settings page)

@cnasikas cnasikas merged commit e5cd8ed into elastic:cases-custom-fields-feature-branch Sep 25, 2023
6 checks passed
@cnasikas cnasikas deleted the custom_fields_exp_badge branch September 25, 2023 10:00
js-jankisalvi added a commit that referenced this pull request Oct 2, 2023
## 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Cases Cases feature release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.11.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants