Skip to content

Commit 99b0a6f

Browse files
lizozomelasticmachine
authored andcommitted
[Search] Error notification alignment (#77788)
* OSS error alignemnt * Adjust error messages in xpack * Add getErrorMessage * Use showError in vizualize Add original error to expression exception * Cleanup * ts, doc and i18n fixes * Fix jest tests * Fix functional test * functional test * ts * Update functional tests * Add unit tests to interceptor and timeout error * expose toasts test function * doc * typos * review 1 * Code review * doc * doc fix * visualization type fix * fix jest * Fix xpack functional test * fix xpack test * code review * delete debubg flag * Update texts by @gchaps * docs and ts Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
1 parent d8502a6 commit 99b0a6f

File tree

50 files changed

+849
-465
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+849
-465
lines changed

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.isearchstart.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,5 @@ export interface ISearchStart
1919
| [aggs](./kibana-plugin-plugins-data-public.isearchstart.aggs.md) | <code>AggsStart</code> | agg config sub service [AggsStart](./kibana-plugin-plugins-data-public.aggsstart.md) |
2020
| [search](./kibana-plugin-plugins-data-public.isearchstart.search.md) | <code>ISearchGeneric</code> | low level search [ISearchGeneric](./kibana-plugin-plugins-data-public.isearchgeneric.md) |
2121
| [searchSource](./kibana-plugin-plugins-data-public.isearchstart.searchsource.md) | <code>ISearchStartSearchSource</code> | high level search [ISearchStartSearchSource](./kibana-plugin-plugins-data-public.isearchstartsearchsource.md) |
22+
| [showError](./kibana-plugin-plugins-data-public.isearchstart.showerror.md) | <code>(e: Error) =&gt; void</code> | |
2223

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [ISearchStart](./kibana-plugin-plugins-data-public.isearchstart.md) &gt; [showError](./kibana-plugin-plugins-data-public.isearchstart.showerror.md)
4+
5+
## ISearchStart.showError property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
showError: (e: Error) => void;
11+
```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@
1919
| [IndexPatternSelect](./kibana-plugin-plugins-data-public.indexpatternselect.md) | |
2020
| [IndexPatternsService](./kibana-plugin-plugins-data-public.indexpatternsservice.md) | |
2121
| [OptionedParamType](./kibana-plugin-plugins-data-public.optionedparamtype.md) | |
22+
| [PainlessError](./kibana-plugin-plugins-data-public.painlesserror.md) | |
2223
| [Plugin](./kibana-plugin-plugins-data-public.plugin.md) | |
23-
| [RequestTimeoutError](./kibana-plugin-plugins-data-public.requesttimeouterror.md) | Class used to signify that a request timed out. Useful for applications to conditionally handle this type of error differently than other errors. |
2424
| [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) | |
2525
| [SearchSource](./kibana-plugin-plugins-data-public.searchsource.md) | \* |
26+
| [SearchTimeoutError](./kibana-plugin-plugins-data-public.searchtimeouterror.md) | Request Failure - When an entire multi request fails |
2627
| [TimeHistory](./kibana-plugin-plugins-data-public.timehistory.md) | |
2728

2829
## Enumerations
@@ -35,6 +36,7 @@
3536
| [METRIC\_TYPES](./kibana-plugin-plugins-data-public.metric_types.md) | |
3637
| [QuerySuggestionTypes](./kibana-plugin-plugins-data-public.querysuggestiontypes.md) | |
3738
| [SortDirection](./kibana-plugin-plugins-data-public.sortdirection.md) | |
39+
| [TimeoutErrorMode](./kibana-plugin-plugins-data-public.timeouterrormode.md) | |
3840

3941
## Functions
4042

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [PainlessError](./kibana-plugin-plugins-data-public.painlesserror.md) &gt; [(constructor)](./kibana-plugin-plugins-data-public.painlesserror._constructor_.md)
4+
5+
## PainlessError.(constructor)
6+
7+
Constructs a new instance of the `PainlessError` class
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
constructor(err: EsError, request: IKibanaSearchRequest);
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| err | <code>EsError</code> | |
20+
| request | <code>IKibanaSearchRequest</code> | |
21+
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [PainlessError](./kibana-plugin-plugins-data-public.painlesserror.md) &gt; [getErrorMessage](./kibana-plugin-plugins-data-public.painlesserror.geterrormessage.md)
4+
5+
## PainlessError.getErrorMessage() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
getErrorMessage(application: ApplicationStart): JSX.Element;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| application | <code>ApplicationStart</code> | |
18+
19+
<b>Returns:</b>
20+
21+
`JSX.Element`
22+
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [PainlessError](./kibana-plugin-plugins-data-public.painlesserror.md)
4+
5+
## PainlessError class
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare class PainlessError extends KbnError
11+
```
12+
13+
## Constructors
14+
15+
| Constructor | Modifiers | Description |
16+
| --- | --- | --- |
17+
| [(constructor)(err, request)](./kibana-plugin-plugins-data-public.painlesserror._constructor_.md) | | Constructs a new instance of the <code>PainlessError</code> class |
18+
19+
## Properties
20+
21+
| Property | Modifiers | Type | Description |
22+
| --- | --- | --- | --- |
23+
| [painlessStack](./kibana-plugin-plugins-data-public.painlesserror.painlessstack.md) | | <code>string</code> | |
24+
25+
## Methods
26+
27+
| Method | Modifiers | Description |
28+
| --- | --- | --- |
29+
| [getErrorMessage(application)](./kibana-plugin-plugins-data-public.painlesserror.geterrormessage.md) | | |
30+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [PainlessError](./kibana-plugin-plugins-data-public.painlesserror.md) &gt; [painlessStack](./kibana-plugin-plugins-data-public.painlesserror.painlessstack.md)
4+
5+
## PainlessError.painlessStack property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
painlessStack?: string;
11+
```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.requesttimeouterror._constructor_.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.requesttimeouterror.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [SearchInterceptor](./kibana-plugin-plugins-data-public.searchinterceptor.md) &gt; [getTimeoutMode](./kibana-plugin-plugins-data-public.searchinterceptor.gettimeoutmode.md)
4+
5+
## SearchInterceptor.getTimeoutMode() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
protected getTimeoutMode(): TimeoutErrorMode;
11+
```
12+
<b>Returns:</b>
13+
14+
`TimeoutErrorMode`
15+

0 commit comments

Comments
 (0)