kibana/examples
Nathan Reese b5bcf69022
[search source] remove is_partial check (#164506)
Closes https://github.com/elastic/kibana/issues/164893

### Background

"is partial" has 2 meanings
1) Results are incomplete because search is still running
2) Search is finished. Results are incomplete because there are shard
failures (either in local or remote clusters)

[async
search](https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html)
defines 2 flags.
1) `is_running`: Whether the search is still being executed or it has
completed
2) `is_partial`: When the query is no longer running, indicates whether
the search failed or was successfully completed on all shards. While the
query is being executed, is_partial is always set to true
**note**: there is a bug in async search where requests to only local
clusters return `is_partial:false` when there are shard errors on the
local cluster. See
https://github.com/elastic/elasticsearch/issues/98725. This should be
resolved in 8.11

Kibana's existing search implementation does not align with
Elasticsearch's `is_running` and `is_partial` flags. Kibana defines "is
partial" as definition "1)". Elasticsearch async search defines "is
partial" as definition "2)".

This PR aligns Kibana's usage of "is partial" with Elasticsearch's
definition. This required the following changes
1) `isErrorResponse` renamed to `isAbortedResponse`. Method no longer
returns true when `!response.isRunning && !!response.isPartial`. Kibana
handles results with incomplete data. **Note** removed export of
`isErrorResponse` from data plugin since its use outside of data plugin
does not make sense.
2) Replace `isPartialResponse` with `isRunningResponse`. This aligns
Kibana's definition with Elasticsearch async search flags.
3) Remove `isCompleteResponse`. The word "complete" is ambiguous. Does
it mean the search is finished (no longer running)? Or does it mean the
search has all results and there are no shard failures?

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Jatin Kathuria <jatin.kathuria@elastic.co>
Co-authored-by: Patryk Kopyciński <contact@patrykkopycinski.com>
2023-10-02 13:25:08 -06:00
..
bfetch_explorer Upgrade EUI to v87.1.0 (#163961) 2023-08-21 15:16:39 -07:00
content_management_examples Make SavedObjectFinder backward compatible (#162904) 2023-08-08 13:10:29 +02:00
controls_example [Tech Debt] Remove deprecated EuiLoadingContent (#156316) 2023-05-03 08:01:37 -06:00
data_view_field_editor_example Assign functional tests and example plugins code ownership to Data Discovery (#162740) 2023-08-04 17:21:13 -03:00
developer_examples Update EUI layout components in dev examples (#163494) 2023-08-10 11:19:06 +02:00
discover_customization_examples [Logs+] Add Filter Control Customization Point (#162013) 2023-08-02 10:35:27 +01:00
embeddable_examples [Embeddable] Clientside migration system (#162986) 2023-08-22 15:08:27 -04:00
embeddable_explorer Clean up saved object based embeddable examples (#162987) 2023-08-03 03:14:36 -07:00
expressions_explorer remove deprecated components, improve spacing and title (#163378) 2023-08-08 09:46:40 -07:00
feature_control_examples Developer documentation for designing feature privileges (#166716) 2023-09-27 13:43:55 +02:00
field_formats_example [Discover] Replace deprecated page components (#162836) 2023-08-02 20:08:17 +02:00
files_example Upgraded EUI to v76.0.0 (#152506) 2023-03-14 14:27:40 -05:00
guided_onboarding_example [Guided onboarding] Migrate all usages of EuiPage*_Deprecated (#161457) 2023-07-10 16:00:27 +01:00
hello_world [packages] migrate all plugins to packages (#148130) 2023-02-08 21:06:50 -06:00
locator_examples Updates deprecated EUI components in locators example plugins (#163405) 2023-08-08 07:55:38 -07:00
locator_explorer Updates deprecated EUI components in locators example plugins (#163405) 2023-08-08 07:55:38 -07:00
partial_results_example [Discover] Replace deprecated page components (#162836) 2023-08-02 20:08:17 +02:00
portable_dashboards_example [shared-ux-router] Add Router and Routes components (#159834) 2023-06-23 10:02:06 -05:00
preboot_example Migrate from deprecated EUI components (#161548) 2023-07-13 03:22:02 -07:00
resizable_layout_examples [Discover] Add resize support to the Discover field list sidebar (#167066) 2023-09-27 21:52:25 -03:00
response_stream [ML] Response Stream developer example: Migrate deprecated EUI components. (#162454) 2023-07-28 15:42:34 +02:00
routing_example Migrate from deprecated EUI components (#161548) 2023-07-13 03:22:02 -07:00
screenshot_mode_example Update EUI deprecated components in sample screenshot plugin (#163409) 2023-08-08 07:45:45 -07:00
search_examples [search source] remove is_partial check (#164506) 2023-10-02 13:25:08 -06:00
share_examples [packages] migrate all plugins to packages (#148130) 2023-02-08 21:06:50 -06:00
state_containers_examples [Kibana] New "Saved Query Management" privilege to allow saving queries across Kibana (#166937) 2023-09-29 11:52:39 +02:00
ui_action_examples [packages] migrate all plugins to packages (#148130) 2023-02-08 21:06:50 -06:00
ui_actions_explorer Update usage of deprecated EUI components in SharedUx plugins (#163560) 2023-08-14 06:36:38 -07:00
unified_doc_viewer [UnifiedDocViewer] Move Discover doc viewer into plugin/package (#162847) 2023-08-31 11:46:59 -07:00
unified_field_list_examples [Discover] Redesign for the grid, panels and sidebar v1 (#165866) 2023-09-12 08:51:34 +02:00
user_profile_examples [packages] migrate all plugins to packages (#148130) 2023-02-08 21:06:50 -06:00
v8_profiler_examples [examples] add routes to access v8 profiling (#155956) 2023-06-30 08:42:38 -04:00
README.asciidoc Add a few asciidoc readmes (#72082) 2020-07-17 11:08:57 -04:00

[[example-plugins]]
== Example plugins

This folder contains example plugins.  To run the plugins in this folder, use the `--run-examples` flag, via

[source,bash]
----
yarn start --run-examples
----