[Discover] Add Analytics No Data Page #131965

majagrubic · 2022-05-10T18:39:34Z

Summary

This PR adds Analytics No Data Page component to Discover (see #131686), to handle scenarios when there is no data in ES or no data views.
Some notable changes in this PR:

Replaces the existing redirect to kibana_overview and renders the page within Discover
Utilizes the new hasData service to check for existence (or absence) of data (and data views)
Allows creation of data view within Discover

There is one small shared-ux change in this:

Fixing navLinks type declaration in CoreStart of shared-ux-services

No Data Flow

No Data Views Flow

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

For maintainers

This was checked for breaking API changes and was labeled appropriately

majagrubic · 2022-05-10T18:47:07Z

@elasticmachine merge upstream

… into no-data-discover

spalger · 2022-05-10T19:01:52Z

Sorry, had a bad deploy of ci-stats but it should be fixed now and I've restarted your build in buildkite

majagrubic · 2022-05-11T08:57:19Z

@elasticmachine merge upstream

… into no-data-discover

majagrubic · 2022-05-11T12:38:44Z

@elasticmachine merge upstream

majagrubic · 2022-05-12T12:09:30Z

x-pack/test/functional_with_es_ssl/config.ts

      resolve(__dirname, './apps/triggers_actions_ui'),
+      resolve(__dirname, './apps/discover'),


Needed to change the order of the tests here. If the Discover test runs first, it will clean up its data & indices. Before my change, in case of no data, Discover would redirect to kibana_overview app. With this change, in case of no data, it stays within Discover. So the triggers_actions_ui test starts from Discover, and the user for the test doesn't have Discover permissions, so it was throwing an error.
Changing the order of the test seemed like a cleaner solution than adding Discover-specific privileges to the user, since they are not really needed.

majagrubic · 2022-05-12T12:10:57Z

test/functional/apps/discover/index.ts

@@ -25,6 +25,7 @@ export default function ({ getService, loadTestFile }: FtrProviderContext) {
      loadTestFile(require.resolve('./_data_view_editor'));
      loadTestFile(require.resolve('./_saved_queries'));
    } else {
+      loadTestFile(require.resolve('./_no_data'));


This needs to go first, as it's the only way to ensure there is indeed no data in the cluster yet (some tests don't unload their fixtures 😱)

this is fine 👍

elasticmachine · 2022-05-16T17:02:13Z

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

majagrubic · 2022-05-16T18:44:09Z

@elasticmachine merge upstream

kertal

Having a first look with some questions, only small nits, looking pretty good, great to have the option to create a data view now ... will do some manual testing later on

src/plugins/discover/public/application/main/discover_main_route.tsx

kertal · 2022-05-17T08:55:24Z

src/plugins/discover/public/application/main/discover_main_route.tsx

+    async (dataView: unknown) => {
+      const dataViewId = (dataView as DataView).id;
+      if (dataViewId) {
+        setShowNoDataPage(false);
+        setError(undefined);
+        await loadSavedSearch();
+      }


I wonder if there's a way there could be a dataView returned without an id? For my understanding, currently there's no way the shared-ux pages components can use the DataView type right?

yes, the typecast is here because the method will be called with an "unknown" parameter. as for the id, I am not sure. My understanding was that as soon as the data view is created, it will have an id.

Removed the dataViewId as we don't really need it.

Great, note that now unknown of async (dataView: unknown) is redundant

test/functional/apps/discover/_no_data.ts

kibana-ci · 2022-05-17T10:16:31Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`discover`	444	538	+94

Async chunks

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

id	before	after	diff
`discover`	405.5KB	524.5KB	+119.0KB

Page load bundle

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

id	before	after	diff
`discover`	40.5KB	40.5KB	+4.0B

Unknown metric groups

async chunk count

id	before	after	diff
`discover`	9	16	+7

miscellaneous assets size

id	before	after	diff
`discover`	0.0B	161.8KB	+161.8KB

History

💚 Build #45099 succeeded e099301
💚 Build #45055 succeeded 2c3b3ae
💔 Build #45015 failed 72582ba
💚 Build #44337 succeeded cd11ce5
💚 Build #44299 succeeded 5d9b93a
💔 Build #44152 failed 0e3ee01

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

jughosta · 2022-05-17T11:01:45Z

src/plugins/discover/public/application/main/discover_main_route.tsx

  } = services;
  const [error, setError] = useState<Error>();
  const [savedSearch, setSavedSearch] = useState<SavedSearch>();
  const indexPattern = savedSearch?.searchSource?.getField('index');
  const [indexPatternList, setIndexPatternList] = useState<Array<SavedObject<DataViewAttributes>>>(
    []
  );
+  const [showNoDataPage, setShowNoDataPage] = useState<boolean>(false);


Small suggestion: would be great to avoid jumping from "Welcome to Analytics" to No data view components and show a loading instead.

Yes, that's already being tackled in the component itself: #132272

kertal

Code LGTM, tested in Chrome, Firefox, Edge, Safari. Works as expected. Great that now there's a quick way to add a data view when there are none available. I've some comments about the Welcome to Analytics page, these are unrelated to this PR, just observations:

majagrubic · 2022-05-17T13:05:04Z

packages/shared-ux/page/analytics_no_data/src/services.tsx

-        navLinks: {
-          integrations: boolean;
-        };
+        navLinks: Record<string, boolean>;


https://github.com/elastic/kibana/blob/main/src/core/types/capabilities.ts#L18

clintandrewhall

🚢

* [Discover] Add Analytics No Data Page * Make showEmptyPrompt parameter optional * Remove unused import * Remove unnecessary test * Fix test * Update failing test? * Update failing test * Changing the order of functional tests * Fix error handling * Addressing PR comments Co-authored-by: Kibana Machine <[email protected]>

* wip I * add alert table state in case * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * add new API to get FeatureID form registrationContext and update UI to use this new API * rm dead code * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * remove unnecessary memo * adds tests for case view helpers * Move http call to API and add tests for getFeatureIds * fix type + unit test * add unit tests + cleanup * add new api integration test for _feature_ids * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Fix small type creating typescript slowness * remove console log * use import type for validfeatureId * force any to improve typescript performance * Update APM (#132270) Co-authored-by: Renovate Bot <[email protected]> * [ResponseOps][Docs] Updating ServiceNow docs with OAuth setup instructions (#131344) * Updating ServiceNow docs. Need screenshots * Adding screenshots * Fix nested screenshots and lists * Tweaks and screenshots * Updates * blergh * Apply suggestions from code review Co-authored-by: Lisa Cawley <[email protected]> * Apply suggestions from code review Co-authored-by: Mike Côté <[email protected]> Co-authored-by: lcawl <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Mike Côté <[email protected]> * Show polling options when 'Data streams' option is selected in the Console Settings modal. (#132277) * [Osquery] Make Osquery All with All base privillege (#130523) * [XY] Add normalizeTable function to correct works with esdocs (#131917) * Add normalizeTable function to correct works with esdocs * Fix types * Fix types * Fix CI * Fix CI * Some fixes * Remove fallback with min/max value for domain * Added tests * Some refactoring Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Yaroslav Kuznietsov <[email protected]> * [Osquery] Add default osquery_saved_query objects (#129461) * [Unified Search] Show error message for invalid date filter value (#131290) * feat: added show error message for invalid date * refact: move logic in HOC * feat: refactoring code and added translation * refact show error * refact: show error message * refact: remove translation * refactor: changed menu for show FilterEdit * fix: open/close popover * feat: field.type => KBN_FIELD_TYPES * feat: remove extra code with with input check and refactored filter item * feat: added tests and refactoring code * refact: getFieldValidityAndErrorMessage * feat: return isInvalid checking in valur input type for string, ip * Update navigation landing pages to use appLinks config (#132027) * Update navigation landing pages to use appLinks config * Please code review * align app links changes * Update links descriptions * Rollback title changes * Fix wrong links descriptions * Fix unit tests * Fix description Co-authored-by: semd <[email protected]> * [Cloud Posture] add resource findings page flyout (#132243) * [Discover] Add a tour for Document Explorer (#131125) * [Discover] Add "Take a tour" button to the Document Explorer callout * [Discover] Tmp * [Discover] Add a first Document Explorer tour step * [Discover] Add other Document Explorer tour steps * [Discover] Update tour steps positioning * [Discover] Add gifs to tour steps * [Discover] Refactor how tour steps are registered * [Discover] Add new step to the tour. Update tour steps text. * [Discover] Improve steps positioning * [Discover] Fix positioning for Add field step * [Discover] Add icons to tour steps * [Discover] Reorganize components * [Discover] Skip Columns step when it's not available * [Discover] Rename components * [Discover] Add some tests * [Discover] Fix positioning * [Discover] Fix props * [Discover] Render steps only if the tour is active * [Discover] Update gifs * [Discover] Add image alt text for gifs * [Discover] Tag the Take tour button * [Discover] Update text and tests * [Discover] Add more tests * [Discover] Rename assets directory * [Discover] Fix tour in mobile view. Improve steps positioning and animation. * [Discover] Update text in tour steps * [Discover] Update sort.gif * [Discover] Update image width * Update src/plugins/discover/public/components/discover_tour/discover_tour_provider.tsx Co-authored-by: gchaps <[email protected]> * Update src/plugins/discover/public/components/discover_tour/discover_tour_provider.tsx Co-authored-by: gchaps <[email protected]> * [Discover] Update sort.gif * [Discover] Fix code style Co-authored-by: gchaps <[email protected]> Co-authored-by: Kibana Machine <[email protected]> * [XY] Add `minTimeBarInterval` arg (#128726) * Added `xAxisInterval` arg * Add validation * Add tests * Rename xAxisInterval to minTimeBarInterval and add validation * Fix imports * Add tests to validation * Fix conflicts * [CI] Auto-commit changed files from 'node scripts/precommit_hook.js --ref HEAD~1..HEAD --fix' * Fix tests Co-authored-by: Kibana Machine <[email protected]> * do not use barrel imports * do not use barrel import * do not use barrel import * do not use barrel imports * do not use barrel import * import types * Add tests * Fix cases bundle size * Add more tests * [Fleet] Add new API to get current upgrades (#132276) * Add support of Data View switching for Agg-Based visualizations (#132184) * Add support of Data View switching for Agg-Based visualizations * fix CI * add use_date_view_updates * implement sync with state * cleanup * cleanup * cleanup * Update index.ts * fix PR comments * Update use_data_view_updates.ts * Update use_data_view_updates.ts Co-authored-by: Kibana Machine <[email protected]> * [Security Solution] Responsive styling fixes (#131951) * [Discover] Add Analytics No Data Page (#131965) * [Discover] Add Analytics No Data Page * Make showEmptyPrompt parameter optional * Remove unused import * Remove unnecessary test * Fix test * Update failing test? * Update failing test * Changing the order of functional tests * Fix error handling * Addressing PR comments Co-authored-by: Kibana Machine <[email protected]> * Remove barrel export from public index file * remove barrel export * Re-export missing exports * Turn off feature flag Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Esteban Beltran <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Renovate Bot <[email protected]> Co-authored-by: Ying Mao <[email protected]> Co-authored-by: lcawl <[email protected]> Co-authored-by: Mike Côté <[email protected]> Co-authored-by: CJ Cenizal <[email protected]> Co-authored-by: Tomasz Ciecierski <[email protected]> Co-authored-by: Uladzislau Lasitsa <[email protected]> Co-authored-by: Yaroslav Kuznietsov <[email protected]> Co-authored-by: Nodir Latipov <[email protected]> Co-authored-by: Pablo Machado <[email protected]> Co-authored-by: semd <[email protected]> Co-authored-by: Or Ouziel <[email protected]> Co-authored-by: Julia Rechkunova <[email protected]> Co-authored-by: gchaps <[email protected]> Co-authored-by: Christos Nasikas <[email protected]> Co-authored-by: Nicolas Chaulet <[email protected]> Co-authored-by: Alexey Antonov <[email protected]> Co-authored-by: Steph Milovic <[email protected]> Co-authored-by: Maja Grubic <[email protected]>

[Discover] Add Analytics No Data Page

42a9da7

Merge branch 'main' into no-data-discover

9706e5e

majagrubic added v8.3.0 Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. release_note:enhancement labels May 10, 2022

Maja Grubic added 2 commits May 10, 2022 20:53

Make showEmptyPrompt parameter optional

e9a2219

Merge branch 'no-data-discover' of https://github.com/majagrubic/kibana…

2a9eb17

… into no-data-discover

Maja Grubic added 3 commits May 11, 2022 08:23

Remove unused import

8fd71ba

Remove unnecessary test

a29c53e

Fix test

d2a3323

kibanamachine and others added 3 commits May 11, 2022 03:57

Merge branch 'main' into no-data-discover

2baee7f

Update failing test?

a96580c

Merge branch 'no-data-discover' of https://github.com/majagrubic/kibana…

bd55a86

… into no-data-discover

kibanamachine and others added 4 commits May 11, 2022 07:38

Merge branch 'main' into no-data-discover

fc7b28f

Update failing test

0e3ee01

Changing the order of functional tests

5d9b93a

Merge branch 'main' into no-data-discover

cd11ce5

majagrubic commented May 12, 2022

View reviewed changes

majagrubic added the ci:deploy-cloud label May 12, 2022

Merge branch 'main' into no-data-discover

72582ba

majagrubic marked this pull request as ready for review May 16, 2022 17:02

majagrubic requested a review from a team May 16, 2022 17:02

majagrubic requested a review from a team as a code owner May 16, 2022 17:02

kibanamachine and others added 2 commits May 16, 2022 13:44

Merge branch 'main' into no-data-discover

2c3b3ae

Fix error handling

e099301

kertal reviewed May 17, 2022

View reviewed changes

Addressing PR comments

c05cd5c

jughosta reviewed May 17, 2022

View reviewed changes

kertal approved these changes May 17, 2022

View reviewed changes

majagrubic requested a review from sebelga May 17, 2022 12:22

rayafratkina mentioned this pull request May 17, 2022

[META] [Kibana Analytics] Show consistent empty state when no data #111184

Open

12 tasks

majagrubic commented May 17, 2022

View reviewed changes

majagrubic mentioned this pull request May 17, 2022

[SharedUX] NoDataPage: open docs link in a new tab #132324

Merged

1 task

clintandrewhall approved these changes May 17, 2022

View reviewed changes

majagrubic merged commit 9dd38c4 into elastic:main May 17, 2022

kibanamachine added the backport:skip This commit does not require backporting label May 17, 2022

majagrubic deleted the no-data-discover branch May 17, 2022 13:51

tylersmalley added ci:cloud-deploy Create or update a Cloud deployment and removed ci:deploy-cloud labels Aug 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Discover] Add Analytics No Data Page #131965

[Discover] Add Analytics No Data Page #131965

majagrubic commented May 10, 2022 •

edited

Loading

majagrubic commented May 10, 2022

spalger commented May 10, 2022

majagrubic commented May 11, 2022

majagrubic commented May 11, 2022

majagrubic May 12, 2022 •

edited

Loading

majagrubic May 12, 2022 •

edited

Loading

kertal May 17, 2022

elasticmachine commented May 16, 2022

majagrubic commented May 16, 2022

kertal left a comment

kertal May 17, 2022

majagrubic May 17, 2022 •

edited

Loading

majagrubic May 17, 2022

kertal May 17, 2022 •

edited

Loading

kibana-ci commented May 17, 2022

async chunk count

miscellaneous assets size

jughosta May 17, 2022

majagrubic May 17, 2022

kertal left a comment

majagrubic May 17, 2022

clintandrewhall left a comment

		resolve(__dirname, './apps/triggers_actions_ui'),
		resolve(__dirname, './apps/discover'),

[Discover] Add Analytics No Data Page #131965

[Discover] Add Analytics No Data Page #131965

Conversation

majagrubic commented May 10, 2022 • edited Loading

Summary

No Data Flow

No Data Views Flow

Checklist

For maintainers

majagrubic commented May 10, 2022

spalger commented May 10, 2022

majagrubic commented May 11, 2022

majagrubic commented May 11, 2022

majagrubic May 12, 2022 • edited Loading

Choose a reason for hiding this comment

majagrubic May 12, 2022 • edited Loading

Choose a reason for hiding this comment

kertal May 17, 2022

Choose a reason for hiding this comment

elasticmachine commented May 16, 2022

majagrubic commented May 16, 2022

kertal left a comment

Choose a reason for hiding this comment

kertal May 17, 2022

Choose a reason for hiding this comment

majagrubic May 17, 2022 • edited Loading

Choose a reason for hiding this comment

majagrubic May 17, 2022

Choose a reason for hiding this comment

kertal May 17, 2022 • edited Loading

Choose a reason for hiding this comment

kibana-ci commented May 17, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

async chunk count

miscellaneous assets size

History

jughosta May 17, 2022

Choose a reason for hiding this comment

majagrubic May 17, 2022

Choose a reason for hiding this comment

kertal left a comment

Choose a reason for hiding this comment

majagrubic May 17, 2022

Choose a reason for hiding this comment

clintandrewhall left a comment

Choose a reason for hiding this comment

majagrubic commented May 10, 2022 •

edited

Loading

majagrubic May 12, 2022 •

edited

Loading

majagrubic May 12, 2022 •

edited

Loading

majagrubic May 17, 2022 •

edited

Loading

kertal May 17, 2022 •

edited

Loading