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] Handle different type of errors returned by the SO client #178307

Merged
merged 8 commits into from
Mar 11, 2024

Conversation

cnasikas
Copy link
Member

@cnasikas cnasikas commented Mar 8, 2024

Summary

The SO client does not return the same structure for different errors. This PR, handles the DecoratedError (a Boom error) that may retuned by the SO client in the bulk operations.

Related: #178266

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.14.0 labels Mar 8, 2024
@cnasikas cnasikas self-assigned this Mar 8, 2024
@cnasikas cnasikas requested a review from a team as a code owner March 8, 2024 12:47
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

x-pack/plugins/cases/server/client/cases/bulk_get.ts Outdated Show resolved Hide resolved
x-pack/plugins/cases/server/client/cases/bulk_get.ts Outdated Show resolved Hide resolved
@@ -330,37 +328,28 @@ export class CasesService {

public async getCases({
caseIds,
}: GetCasesArgs): Promise<SavedObjectsBulkResponse<CaseTransformedAttributes>> {
}: GetCasesArgs): Promise<SavedObjectsBulkResponseWithErrors<CaseTransformedAttributes>> {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this here in the context of this PR?

Copy link
Member Author

@cnasikas cnasikas Mar 8, 2024

Choose a reason for hiding this comment

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

Because the SavedObjectsBulkResponse type did not handle the errors returned by the SO client. I wanted the cases client that uses the getCases method to use the correct types so it can understand that the response contains errors.

x-pack/plugins/cases/server/client/attachments/bulk_get.ts Outdated Show resolved Hide resolved
x-pack/plugins/cases/server/client/cases/bulk_create.ts Outdated Show resolved Hide resolved
@cnasikas cnasikas enabled auto-merge (squash) March 10, 2024 15:25
@cnasikas
Copy link
Member Author

@elasticmachine merge upstream

@cnasikas
Copy link
Member Author

@elasticmachine merge upstream

@cnasikas
Copy link
Member Author

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

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

cc @cnasikas

@cnasikas cnasikas merged commit 24808a9 into elastic:main Mar 11, 2024
19 checks passed
@cnasikas cnasikas deleted the fix_so_errors branch March 11, 2024 08:17
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Mar 11, 2024
cnasikas added a commit that referenced this pull request Mar 19, 2024
## Summary

In this PR I started adding integration tests for the case action. This
process revealed a couple of bugs which I fixed. Specifically this PR:
- Handles decorated errors thrown by the SO client
- Skip executing if there are no alerts
- Pass an unsecured (security is disabled) version of the SO client
- Create one attachment with all alerts instead of one attachment per
alert
- Registers the required kibana privileges the case action needs to run
- Add integration tests

Blocked by: #178307
Flaky test runner:
https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/5488


### Checklist

Delete any items that are not applicable to this PR.

- [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
- [x] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed

### 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)

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
eokoneyo pushed a commit to eokoneyo/kibana that referenced this pull request Mar 19, 2024
…astic#178307)

## Summary

The SO client does not return the same structure for different errors.
This PR, handles the `DecoratedError` (a `Boom` error) that may retuned
by the SO client in the bulk operations.

Related: elastic#178266

### Checklist

Delete any items that are not applicable to this PR.

- [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)
cnasikas added a commit that referenced this pull request Apr 12, 2024
## Summary

Depends on: #166267,
#170326,
#169484,
#173740,
#173763,
#178068,
#178307,
#178600,
#180437

PRs:
- #168370
- #169229
- #171754
- #172709
- #173012
- #175107
- #175452
- #175505
- #177033
- #178277
- #177139
- #179796

Fixes: #153837

## Testing

Run Kibana with `--run-examples` if you want to use the "Always firing"
rule.

Create a rule with a case action in observability and the stack. The
security solution is not supported. You should not be able to assign a
case action in a security solution rule.

1. Test the "Reopen closed cases" configuration.
2. Test the "Grouping by" configuration. Only one field is allowed. Not
all fields are persisted in alerts. If you select a field not part of
the alert the case action will create a case where the grouping value is
set to `unknow`.
3. Test the "Time window" feature. You can comment out the validation to
test for shorter times.
4. Verify that the case action is experimental.
5. Verify that based on the rule type the case is created in the correct
solution.
6. Verify that you cannot create a rule with the case action on the
basic license.
7. Verify that the execution of the case action fails if you do not have
permission for cases. Pending work on the system actions framework level
to not allow users to create rules with system actions where they do not
have permission.
8. Stress test the case action by creating multiple rules.

### Checklist

Delete any items that are not applicable to this PR.

- [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

Automatically create cases when an alert is triggered.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: adcoelho <antonio.coelho@elastic.co>
Co-authored-by: Janki Salvi <117571355+js-jankisalvi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting 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.14.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants