Repository navigation
[Search] Fix isErrorResponse when cluster details are provided - #166667
Conversation
…ic#166544) ## Summary Fixes elastic#166528. ### Checklist Delete any items that are not applicable to this PR. - [ ] 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) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [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 - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] 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: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
|
Pinging @elastic/kibana-data-discovery (Team:DataDiscovery) |
💚 Build Succeeded
Metrics [docs]Public APIs missing comments
Page load bundle
To update your PR or re-run it, just comment with: cc @lukasolson |
| // will have information about those failures. This will also likely be the behavior of CCS with | ||
| // ccs_minimize_roundtrips=false and non-CCS after https://github.com/elastic/elasticsearch/issues/98913 is | ||
| // resolved. | ||
| !response.rawResponse?._clusters?.details) |
There was a problem hiding this comment.
I left the same comment here, sorry for the duplicate comment.
I am not sure that checking _clusters.details is enough. I think we must check _clusters.details.clusterAlias.failures
The new response for CCS is now including _clusters.details both for error and non error responses.
An example of non error details section is:
"details": {
"(local)": {
"status": "successful",
"indices": foo",
"took": 123,
"timed_out": false,
"_shards": {
...
}
},
"remote": {
"status": "successful",
"indices": "foo",
"took": 234,
"timed_out": false,
"_shards": {
...
}
}
}
And an example of error details section:
"details": {
"remote": {
"status": "partial",
"indices": "foo",
"took": 123,
"timed_out": false,
"_shards": {
"total": 6,
"successful": 5,
"skipped": 0,
"failed": 1
},
"failures": [
{
"shard": 1,
"index": "remote:foo",
"node": ...,
"reason": {
"type": "query_shard_exception",
"reason": "failed to create query: exception message here",
...
}
}
]
}
}
There was a problem hiding this comment.
Thanks for weighing in here @piergm.
To give some context, this check (isErrorResponse) will soon be removed entirely (see #164506). Right now, if isErrorResponse returns true, then we throw an error from the Kibana server and clients will receive a 500 error. This behavior is not ideal, but it has been this way for years now and we were hoping to limit the scope as much as possible to speed up a potential patch release.
The change in this PR is less about identifying when a response from ES is/is not an actual error, but instead opening an escape hatch to not throw an error if we encounter the new response format. In other words, the check !response.rawResponse?._clusters?.details is not actually for identifying whether or not the response contains errors, but rather for identifying that the response format is the new format.
There was a problem hiding this comment.
Thank you for clarifying this @lukasolson. Than this LGTM!
davismcphee
left a comment
There was a problem hiding this comment.
Confirmed the issue exists in main, and confirmed this still fixes it 👍 LGTM, thanks!
Summary
Cherry picks #166544 into main.