[Discover] Suppress "Missing index" toasts #149625

jughosta · 2023-01-26T18:52:10Z

kertal · 2023-01-27T13:27:30Z

Just tested in by deleting the e-commerce data while keeping the data view. Works as expected 🥳

elasticmachine · 2023-01-30T13:00:59Z

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

stratoula · 2023-01-30T13:59:33Z

Maybe we could also hide the toast here to be consistent with Discover. I also like the error that is being displayed in Discover. Wdyt?

stratoula

Unified search changes LGTM!

drewdaemon · 2023-01-30T14:06:27Z

@stratoula totally.

kertal · 2023-01-30T14:29:14Z

@stratoula @drewdaemon @stratoula unified_error_message, btw @drewdaemon about the one comment in your RFC I've added, the error message @stratoula is referring to, might also go away when

kibana/x-pack/plugins/lens/public/data_views_service/loader.ts

Line 179 in 5535dd1

Object.values(adHocDataViews || {}).map((spec) => dataViews.create(spec))

is changed to dataViews.create(spec, false, false) ... the 3rd param is setting displayError to false

stratoula · 2023-01-30T14:32:53Z

Created an issue here and I will add this to our 8.8 backlog #149836

mattkime

Overall the changes are very good - and very helpful! While you spotted some necessary changes for the data_views service, I have questions regarding a couple.

mattkime · 2023-01-30T21:32:00Z

src/plugins/data_views/common/data_views/data_views.ts

@@ -261,7 +265,10 @@ export interface DataViewsServicePublicMethods {
   * @params savedObject - Data view saved object
   * @params displayErrors - If set false, API consumer is responsible for displaying and handling errors.
   */
-  savedObjectToSpec: (savedObject: SavedObject<DataViewAttributes>) => DataViewSpec;
+  savedObjectToSpec: (


I'm not sure why this is needed as savedObjectToSpec doesn't display toasts.

@mattkime Right, I cleaned that up.

mattkime · 2023-01-30T21:35:19Z

src/plugins/data_views/common/data_views/data_views.ts

-        this.onNotification(
-          { title: err.message, color: 'danger', iconType: 'alert' },
-          `refreshFields:${dataView.getIndexPattern()}`
+      if (displayErrors) {


I'm confused about the work this change is doing. As best I can tell it swallows errors since the error is caught but not re-thrown which isn't desired.

@mattkime The previous code was causing an unhandled promise error which was not allowing to switch from SQL to regular mode in UI (for a data view with missing index)

if (!displayErrors) { return this.refreshFieldsFn(dataView); }

Can you handle the exception in the api consumer instead of changing the api?

@mattkime Thanks for your suggestion! The thing is that the consumer is the data views service itself

kibana/src/plugins/data_views/common/data_views/data_views.ts

Line 894 in 4c386d9

await this.refreshFields(dataView, displayErrors);

Would you suggest to add try-catch there depending on displayErrors?

No, at least in theory the error will propagate up to the api consumer's call.

No, at least in theory the error will propagate up to the api consumer's call.

@mattkime dataView.get() could still return a data view object for its consumer if we suppress exceptions for refreshField. If we change as you suggest then the consumer code would not be able to proceed which conflicts with the purpose of this PR.

We can't both prevent unhandled errors AND pass errors to API consumers.

Agree with that. I'm not happy with the PR changes either. I can close it if that's our conclusion.

Agree, there should be one way to handle it: to suppress the errors or to pass errors to the API consumers. This should also be clearly communicated to consumers, currently it seems it's a mixed handling of those cases?

If we change as you suggest then the consumer code would not be able to proceed

@jughosta Perhaps we should set up some time to discuss this. There's something I'm not understanding here.

@kertal

Agree, there should be one way to handle it: to suppress the errors or to pass errors to the API consumers. This should also be clearly communicated to consumers, currently it seems it's a mixed handling of those cases?

I think our language might be conflating things. Currently, the api either displays errors or throws errors - and thrown errors need to be caught by api consumer code. 'Suppressing errors' could ambiguously mean either of those.

First we need to remove the possibility of errors from our communication regarding errors to successfully deal with errors. 🥲

I created https://github.com/mattkime/kibana/pull/new/129020-inline-missing-index-error-mk to illustrate what I see as the path forward, particularly https://github.com/elastic/kibana/pull/150246/files#diff-eeffc98614da75c1f8e6ce9b07802c11dce0ae41f80b9540784f0f44c2e86133R307 - Now I think I did this before understanding what @jughosta was saying.

@jughosta - It took me a second reading to understand what you were looking to do -

[@mattkime] dataView.get() could still return a data view object for its consumer if we suppress exceptions for refreshField. If we change as you suggest then the consumer code would not be able to proceed which conflicts with the purpose of this PR.

Basically you're saying you want to be able to get a data view even if you can't get the field list. This isn't something thats currently supported by the API. A data view without a field list is of very limited use in most circumstances. Its an interesting idea. Current API consumers always assume the full field list is there - they don't have a notion of a data view with an unloaded field list. This is something I'd like to see changed but it would be a significant effort on the part of API consumers. Its actually something requested by solutions which deal with very large numbers of fields - that way they can choose when the field list is loaded.

mattkime · 2023-01-30T21:51:12Z

...lication/main/components/no_results/no_results_suggestions/no_results_suggestion_default.tsx

+        {dataViewPattern ? (
+          <FormattedMessage
+            id="discover.noResults.noDocumentsOrCheckIndicesAndPermissionsDescription"
+            defaultMessage="Make sure the indices matching {dataViewPattern} exist, that you have permission to view them and that they contain documents."


My suggestion - although it should probably get 👀 from @gchaps - Make sure data view {dataViewName} with index pattern {dataViewPattern} has matching indices and documents and that you have permission to view them.

Does this work properly for text based languages?

@mattkime Thanks, updated!

For SQL mode we show an error in this case rather than the message:

My suggestion is to add the 2 words in bold:

Make sure that the data view {dataViewName} with index pattern {dataViewPattern} has matching indices and documents and that you have permission to view them.

Also, can we update the error message:

Instead of

We encountered an error retrieving search results

how about

Unable to retrieve search results

Thanks @gchaps !

mattkime · 2023-02-01T20:17:01Z

src/plugins/discover/public/application/main/hooks/use_discover_state.ts

@@ -218,7 +218,7 @@ export function useDiscoverState({
   */
  const onChangeDataView = useCallback(
    async (id: string) => {
-      const nextDataView = await dataViews.get(id);
+      const nextDataView = await dataViews.get(id, false);


Anyplace where we're suppressing errors potentially needs a try/catch

@mattkime Updated by wrapping with try/catch.

…r' into 129020-inline-missing-index-error

mattkime · 2023-02-09T15:06:19Z

.../application/main/components/no_results/no_results_suggestions/use_fetch_occurances_range.ts

-        });
-      } catch (error) {
-        //
+      if (dataView?.isTimeBased() && dataView?.timeFieldName && query && mountedRef.current) {


dataView?.isTimeBased() includes checking dataView?.timeFieldName

@mattkime Thanks!

mattkime

One minor note, otherwise the code looks good and works well

…r' into 129020-inline-missing-index-error

…ng-index-error # Conflicts: # src/plugins/discover/public/application/main/hooks/use_discover_state.ts

kibana-ci · 2023-02-14T11:54:41Z

💚 Build Succeeded

Buildkite Build
Commit: 1aceefa

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`data`	2578	2584	+6
`dataViews`	231	243	+12
total			+18

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`discover`	391.7KB	392.3KB	+608.0B
`unifiedSearch`	264.7KB	264.7KB	+42.0B
total			+650.0B

Page load bundle

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

id	before	after	diff
`dataViews`	44.0KB	44.0KB	+83.0B
`unifiedFieldList`	38.9KB	39.0KB	+109.0B
total			+192.0B

Unknown metric groups

API count

id	before	after	diff
`data`	3276	3280	+4
`dataViews`	1020	1028	+8
total			+12

ESLint disabled line counts

id	before	after	diff
`unifiedFieldList`	18	17	-1

References to deprecated APIs

id	before	after	diff
`discover`	41	36	-5

Total ESLint disabled count

id	before	after	diff
`unifiedFieldList`	18	17	-1

History

💚 Build #107561 succeeded c35a269
💚 Build #107258 succeeded c472b93
💔 Build #107241 failed fa996e8
💔 Build #107236 failed 5df9cf1
💔 Build #107193 failed afb6834
💚 Build #106982 succeeded 3b866c7

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

cc @jughosta

[Discover] Suppress "Missing index" toasts

e4b39fe

jughosta added release_note:enhancement Feature:Discover Discover Application backport:skip This commit does not require backporting Team:DataDiscovery Discover App Team (Document Explorer, Saved Search, Surrounding documents, Data, DataViews) labels Jan 26, 2023

jughosta self-assigned this Jan 26, 2023

jughosta added 11 commits January 27, 2023 15:13

Merge branch 'main' into 129020-inline-missing-index-error

5460f94

[Discover] Update the default message

fa3e071

[Discover] Handle switching data views too

dd6ccc3

[Discover] Rename param

eafced6

[Discover] Fix another case

4cc1910

[Discover] Fix checks

6dc15f5

[Discover] Fix tests

dd1a27c

Merge branch 'main' into 129020-inline-missing-index-error

0a98ad9

Merge branch 'main' into 129020-inline-missing-index-error

d92cce3

[Discover] Add a test

a1b4780

Merge branch 'main' into 129020-inline-missing-index-error

2b05940

jughosta marked this pull request as ready for review January 30, 2023 13:00

jughosta requested review from a team as code owners January 30, 2023 13:00

stratoula approved these changes Jan 30, 2023

View reviewed changes

stratoula mentioned this pull request Jan 30, 2023

[Lens] Suppress missing index toast #149836

Closed

Merge branch 'main' into 129020-inline-missing-index-error

8f1e30e

mattkime requested changes Jan 30, 2023

View reviewed changes

mattkime reviewed Feb 1, 2023

View reviewed changes

jughosta added 5 commits February 6, 2023 16:41

Merge branch 'main' into 129020-inline-missing-index-error

f6c09e0

[Discover] Wrap with try/catch

2ec2293

Merge branch 'main' into 129020-inline-missing-index-error

9b051f4

[Discover] Fix for tests

dc46db3

Merge remote-tracking branch 'origin/129020-inline-missing-index-erro…

e317a65

…r' into 129020-inline-missing-index-error

kertal requested a review from mattkime February 8, 2023 18:47

Merge branch 'main' into 129020-inline-missing-index-error

eeff695

mattkime requested a review from a team as a code owner February 9, 2023 05:13

Merge branch 'main' into 129020-inline-missing-index-error

bce9870

pgayvallet approved these changes Feb 9, 2023

View reviewed changes

Merge branch 'main' into 129020-inline-missing-index-error

10e3d8a

jughosta added the v8.8.0 label Feb 9, 2023

mattkime reviewed Feb 9, 2023

View reviewed changes

mattkime approved these changes Feb 9, 2023

View reviewed changes

jughosta added 12 commits February 9, 2023 17:19

Merge branch 'main' into 129020-inline-missing-index-error

d58a97c

[Data View] Update data view API usage

3b866c7

Merge branch 'main' into 129020-inline-missing-index-error

afb6834

[Data View] Update function signature

1b05045

Merge remote-tracking branch 'origin/129020-inline-missing-index-erro…

2a60fb9

…r' into 129020-inline-missing-index-error

Merge branch 'main' into 129020-inline-missing-index-error

5df9cf1

[Data View] Update tests

cf76c87

Merge remote-tracking branch 'origin/129020-inline-missing-index-erro…

fa996e8

…r' into 129020-inline-missing-index-error

Merge branch 'main' into 129020-inline-missing-index-error

c472b93

Merge branch 'main' into 129020-inline-missing-index-error

c35a269

Merge remote-tracking branch 'upstream/main' into 129020-inline-missi…

aee44c4

…ng-index-error # Conflicts: # src/plugins/discover/public/application/main/hooks/use_discover_state.ts

Merge branch 'main' into 129020-inline-missing-index-error

1aceefa

jughosta enabled auto-merge (squash) February 14, 2023 10:15

jughosta merged commit 668fe89 into elastic:main Feb 14, 2023

[Discover] Suppress "Missing index" toasts #149625

[Discover] Suppress "Missing index" toasts #149625

Conversation

jughosta commented Jan 26, 2023 • edited Loading

kertal commented Jan 27, 2023

elasticmachine commented Jan 30, 2023

stratoula commented Jan 30, 2023

stratoula left a comment

Choose a reason for hiding this comment

drewdaemon commented Jan 30, 2023

kertal commented Jan 30, 2023 • edited Loading

stratoula commented Jan 30, 2023

mattkime left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jughosta Feb 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattkime Feb 3, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattkime Feb 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattkime left a comment

Choose a reason for hiding this comment

kibana-ci commented Feb 14, 2023

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

ESLint disabled line counts

References to deprecated APIs

Total ESLint disabled count

History

jughosta commented Jan 26, 2023 •

edited

Loading

kertal commented Jan 30, 2023 •

edited

Loading

jughosta Feb 1, 2023 •

edited

Loading

mattkime Feb 3, 2023 •

edited

Loading

mattkime Feb 1, 2023 •

edited

Loading