[Cases] Custom fields schema changes #167310
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cnasikas
added
release_note:skip
cnasikas
changed the base branch from
main
to
cases-custom-fields-feature-branch
|
Pinging @elastic/response-ops (Team:ResponseOps) |
|
Pinging @elastic/response-ops-cases (Feature:Cases) |
💔 Build FailedFailed CI Steps
Test Failures
Metrics [docs]Async chunks
Page load bundle
History
To update your PR or re-run it, just comment with: cc @cnasikas |
11 tasks
adcoelho
reviewed
Sep 28, 2023
| key: limitedStringSchema({ fieldName: 'key', min: 1, max: MAX_CUSTOM_FIELD_KEY_LENGTH }), | ||
| key: regexStringRt({ | ||
| codec: limitedStringSchema({ fieldName: 'key', min: 1, max: MAX_CUSTOM_FIELD_KEY_LENGTH }), | ||
| pattern: '^[a-z0-9_-]+$', |
There was a problem hiding this comment.
We could also have ^[a-z0-9_-]{1,MAX_CUSTOM_FIELD_KEY_LENGTH}$.
We don't do it so we can have more specific error messages?
There was a problem hiding this comment.
I was not aware of that! Let me try that.
There was a problem hiding this comment.
Probably have to escape the $ at the end though
adcoelho
reviewed
Sep 28, 2023
| [CustomFieldTypes.TEXT]: configureTextCustomFieldFactory, | ||
| [CustomFieldTypes.TOGGLE]: configureToggleCustomFieldFactory, | ||
| } as const); | ||
| } as const) as CustomFieldBuilderMap; |
There was a problem hiding this comment.
I made the types to accept template literals so we do not have to cast inside the View/Configure/Edit components. Without this cast, TS complains. I fought a lot of hours without success. I preferred to have this cast here and not have to cast in the components each time we add a new custom field type.
adcoelho
reviewed
Sep 28, 2023
| @@ -153,3 +153,26 @@ export const limitedNumberSchema = ({ fieldName, min, max }: LimitedSchemaType) | |||
| }), | |||
| rt.identity | |||
| ); | |||
|
|
|||
| export interface RegexStringSchemaType { | |||
There was a problem hiding this comment.
nit: does this need to be exported? ctrl + f doesn't show other occurrences.
adcoelho
reviewed
Sep 28, 2023
| }), | ||
| fieldName: 'value', | ||
| min: 0, | ||
| max: MAX_CUSTOM_FIELD_TEXT_VALUE_ITEMS, |
There was a problem hiding this comment.
Could you please add a test for this?
adcoelho
reviewed
Sep 28, 2023
adcoelho
reviewed
Sep 28, 2023
| }); | ||
|
|
||
| it('returns missing keys', () => { | ||
| it('returns all custom fields if they are more than the configuration', () => { |
There was a problem hiding this comment.
At the point in which this function is called the validation is already done so this should never happen. Shouldn't we throw an error?
There was a problem hiding this comment.
Yes, but the tests are for fillMissingCustomFields which is tested in isolation. There is no connection without validation in these tests. We need to test that the fillMissingCustomFields is working as expected in all scenarios because it may be used in a different context in the future.
adcoelho
approved these changes
Sep 28, 2023
| /** | ||
| * Returns a list of required custom fields missing from the request | ||
| */ | ||
| export const validateRequiredCustomFields = ({ |
There was a problem hiding this comment.
Wasn't this one already in my PR?
There was a problem hiding this comment.
No, I removed it because the requirements were different at that time. We changed our minds though and added again in this PR 🙂.
There was a problem hiding this comment.
ok, I was really confused and went to check my old commits to see if I dreamt of this code 😆
There was a problem hiding this comment.
😆 Check my latest commit in your PR.
| }, | ||
| ], | ||
| }), | ||
| 400 | ||
| ); | ||
| }); | ||
|
|
||
| it('400s when trying to create case with a missing custom field', async () => { | ||
| it('400s when trying to create case with a required custom field', async () => { |
There was a problem hiding this comment.
nit: with a missing required custom field?
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR:
fieldattribute from the schema of Casesvalue: boolean[]tovalue: booleannullvalues when creating or updating a casekeyto contain only lowercase letters (a-z), numbers (0-9), '_', and '-'Because the schema of the SO changed you need to start with a clean ES state.
Connected to #160236
Checklist
Delete any items that are not applicable to this PR.
For maintainers