[data.search] Handle warnings inside of headers

[lukasolson]

Summary

Closes #98764.

This PR adds support to the data.search services to surface warning properties that are returned in headers from Elasticsearch responses. It also adds developer examples and adds support to SearchSource for handling these types of warnings directly.

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
• Documentation was added for features that require explanation or tutorials
• Unit or functional tests 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)
• Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
• If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
• This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
• This was checked for cross-browser compatibility

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

For maintainers

• This was checked for breaking API changes and was labeled appropriately

Plugin API changes

The data.search service now returns a warning property that includes any warnings returned from Elasticsearch in the headers.

[elasticmachine]

Pinging @elastic/kibana-app-services (Team:AppServices)

[lukasolson]

@elasticmachine merge upstream

[spalger]

jenkins, test this

(had to abort for Jenkins upgrade)

[lizozom]

Following up on our call - I think it would be better if the search API exposed two fields:

• status
• message

In this PR we could use it only for warnings, but I would make a follow up PR to get rid of isPartial and isRunning as well..

[lukasolson]

@elasticmachine merge upstream

[lukasolson]

Following up on our call - I think it would be better if the search API exposed two fields:

• status
• message

I was giving this some more thought today and I'm not sure this will work, as a search can complete and still have warnings. So I'm not sure what the enum of statuses would look like. Maybe we can chat a little bit more about this approach or possibly move it to a follow-up PR.

[lizozom]

@lukasolson

Then what about aiming for -

// Response format
{
   body: ...,
   status: OK \NOT_OK
   messages: [{
     test: 'This is a warning',
     level: ' warning',
   }, {
     test: 'This is an error',
     level: ' error',
   }]
}

A successful response will have an OK status, but may or may not have a warning(s?).
A failed response will have a NOT_OK status with an one or more errors or warnings.

[lukasolson]

@lizozom I removed the isWarningResponse helper, as it isn't super helpful (since it just checked if the warning property exists). I would like to chat more about your proposed changes to have messages, but ultimately I think it would make sense to move it to a separate PR so we can make sure to handle errors properly.

[lukasolson]

@elasticmachine merge upstream

[lukasolson]

@elasticmachine merge upstream

[lizozom]

@elasticmachine merge upstream

[lizozom]

Ok, lets merge as is and wait for feedback 👍🏻

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: 675e584
• Storybooks Preview

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
data	791.0KB	791.2KB	+232.0B

Unknown metric groups

API count

id	before	after	diff
data	3480	3482	+2

History

• 💚 Build #144663 succeeded 774373c
• 💚 Build #143931 succeeded 20dd68a
• 💚 Build #143158 succeeded 033a84d
• 💚 Build #142509 succeeded 2d6ab50
• 💚 Build #140876 succeeded 73e0eb0

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

cc @lukasolson

[Dosant]

It is interesting that one of our sample dashboards shows a real warning now:

Seems like the warning is a deprecation message which shouldn't concern our users, but should be addressed by us instead.
With this as an example, looks like we can't move forward with the change as is? Because this might produce false warnings for real users? 😞

Seems like we need a way to separate real or actionable by-user warnings from such deprecation warnings which should be handled by us? Maybe there are other types of warnings that we have to mute :(

[lukasolson]

@Dosant great find! IMHO, we want to expose these errors in a noticeable way in the UX so that this exact sort of issue doesn't happen in the future. I've opened an issue to track this: #108813

[lukasolson]

Also opened a fix: #108825

[Dosant]

@Dosant great find! IMHO, we want to expose these errors in a noticeable way in the UX so that this exact sort of issue doesn't happen in the future. I've opened an issue to track this: #108813

Awesome!

[kibanamachine]

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 103744 or prevent reminders by adding the backport:skip label.

[kibanamachine]

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.