[Search Sessions] Search session example app #89583

Dosant · 2021-01-28T15:42:15Z

Summary

Adds a search session developer example plugin.
Following the demo application you will:

Step 1. Configure the Query
Step 2. Start a search
Step 3. Save a session (you can do this while the search is still running or when it is finished)
Step 4. Restore a session
Step 5-6. Navigate to management and then navigate back from there to restore a session

demo-search-sessions.mov

I have a functional test separately #92133 it needs some infra/ops changes to make it work (we can't run example tests with x-pack yet)

…arch-session-example

Dosant · 2021-02-18T14:14:25Z

examples/search_examples/kibana.json

@@ -4,7 +4,7 @@
  "kibanaVersion": "kibana",
  "server": true,
  "ui": true,
-  "requiredPlugins": ["navigation", "data", "developerExamples", "kibanaUtils"],
+  "requiredPlugins": ["navigation", "data", "developerExamples", "kibanaUtils", "share"],


share is needed for URL generator to get back to search session

Dosant · 2021-02-18T14:14:49Z

examples/search_examples/public/application.tsx

+import { SearchSessionsExampleApp } from './search_sessions/app';
+import { RedirectAppLinks } from '../../../src/plugins/kibana_react/public';
+
+const LINKS: ExampleLink[] = [


Needed to introduce some kind of sub-routes for more examples

Dosant · 2021-02-18T14:15:23Z

examples/search_examples/public/plugin.ts

@@ -51,9 +53,28 @@ export class SearchExamplesPlugin
    developerExamples.register({
      appId: 'searchExamples',
      title: 'Search Examples',
-      description: `Search Examples`,
+      description: `Examples on searching elasticsearch using data plugin: low-level search client (data.search.search), high-level search client (SearchSource), search sessions (data.search.sessions)`,


Just improving with nicer description, image, and readme.

Dosant · 2021-02-18T14:16:09Z

examples/search_examples/public/search/app.tsx

@@ -0,0 +1,433 @@
+/*


MOVED THIS.
Didn't change the older example

Dosant · 2021-02-18T14:17:24Z

src/plugins/data/public/query/query_service.ts

@@ -80,8 +80,8 @@ export class QueryService {
      savedQueries: createSavedQueryService(savedObjectsClient),
      state$: this.state$,
      timefilter: this.timefilter,
-      getEsQuery: (indexPattern: IndexPattern) => {
-        const timeFilter = this.timefilter.timefilter.createFilter(indexPattern);
+      getEsQuery: (indexPattern: IndexPattern, timeRange?: TimeRange) => {


Added additional parameter (createFilter already had 2nd optional argument).
It was convenient to use this in an example

Dosant · 2021-02-18T14:18:56Z

src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts

-): Record<string, unknown> {
-  const query = parseUrlHash(url)?.query;
+  keys?: Array<keyof State>,
+  { getFromHashQuery = true }: { getFromHashQuery: boolean } = { getFromHashQuery: true }


Needed to extend the functionality of this helper because the example plugin doesn't use hash routing and stores state not inside the hash part of the URL but inside of the location.search instead

setStateToKbnURL already had this param in place

Dosant · 2021-02-18T14:19:52Z

...d/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx

 }: SearchSessionIndicatorDeps): React.FC => {
+  const searchSessionsManagementUrl = basePath.prepend('/app/management/kibana/search_sessions');


Noticed a bug that wasn't visible in discover/dashboard.

elasticmachine · 2021-02-18T14:20:59Z

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

jpg is not supported in dev env. didn’t want to change configs

…arch-session-example

Dosant · 2021-02-22T08:35:43Z

@elasticmachine merge upstream

kibanamachine · 2021-02-22T10:45:46Z

💚 Build Succeeded

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`	914.3KB	914.3KB	+22.0B
`dataEnhanced`	40.4KB	40.6KB	+190.0B
`kibanaUtils`	154.5KB	154.7KB	+203.0B
total			+415.0B

History

💚 Build #108222 succeeded 828a90b
💔 Build #107998 failed fef8f2f4341bac2b4527ee1f6a5ddb2aa70d248b
💛 Build #107752 was flaky 46525a7
💔 Build #107731 failed a8d6e90
💔 Build #107675 failed 6a9a5d6

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

lizozom

Tested and I love the way the example works.
One UX nit: I'm not a huge fan of the list items appearing as you interact with them.
Maybe instead they should be disabled as long as previous steps were not completed?

Dosant · 2021-02-22T12:32:35Z

@lizozom, I agree that having new steps appearing out of nowhere is not the best UX, but I also think that having all steps out there and just disabling buttons wouldn't be enough. I am thinking of some content-overlays on top of "disabled" states which would help to focus attention on the current step. But not sure it worth spending more time on this. I think currently it is pretty good.

Dosant added 10 commits January 28, 2021 09:59

wip

46afcdb

Merge branch 'master' of github.com:elastic/kibana into dev/search/se…

e96da54

…arch-session-example

wip

56bce8c

merge

c272319

lint

6872451

wip

255c964

Merge branch 'master' of github.com:elastic/kibana into dev/search/se…

680a43e

…arch-session-example

wip

607d321

wip

4a254d5

wip

6a9a5d6

Dosant commented Feb 18, 2021

View reviewed changes

Dosant added docs Feature:Search Querying infrastructure in Kibana release_note:skip Skip the PR/issue when compiling release notes Team:AppServices v7.13.0 v8.0.0 labels Feb 18, 2021

Dosant marked this pull request as ready for review February 18, 2021 14:20

Dosant requested a review from a team as a code owner February 18, 2021 14:20

Dosant changed the title ~~[wip][Search Sessions] Basic search sessions example~~ [Search Sessions] Search session example app Feb 18, 2021

Dosant requested review from lizozom, lukasolson and tsullivan February 18, 2021 14:21

Dosant added 4 commits February 18, 2021 17:36

change jpg to png

a8d6e90

jpg is not supported in dev env. didn’t want to change configs

fix ts

46525a7

Merge branch 'master' of github.com:elastic/kibana into dev/search/se…

172578f

…arch-session-example

Merge branch 'master' of github.com:elastic/kibana into dev/search/se…

828a90b

…arch-session-example

Dosant force-pushed the dev/search/search-session-example branch from fef8f2f to 828a90b Compare February 20, 2021 07:15

Merge branch 'master' into dev/search/search-session-example

e28d650

Dosant mentioned this pull request Feb 22, 2021

[Search Sessions] Search session example app functional test #92133

Merged

2 tasks

lizozom approved these changes Feb 22, 2021

View reviewed changes

Dosant merged commit a82fe33 into elastic:master Feb 22, 2021

Dosant mentioned this pull request Feb 22, 2021

[7.x] [Search Sessions] Search session example app (#89583) #92157

Merged

Dosant added a commit to Dosant/kibana that referenced this pull request Feb 22, 2021

[Search Sessions] Search session example app (elastic#89583)

f09539a

Dosant added a commit that referenced this pull request Feb 22, 2021

[Search Sessions] Search session example app (#89583) (#92157)

6eb2636

Dosant mentioned this pull request Feb 23, 2021

[Search Sessions] Example plugin and dev docs #89278

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Search Sessions] Search session example app #89583

[Search Sessions] Search session example app #89583

Dosant commented Jan 28, 2021 •

edited

Loading

Dosant Feb 18, 2021

Dosant Feb 18, 2021

Dosant Feb 18, 2021

Dosant Feb 18, 2021

Dosant Feb 18, 2021

Dosant Feb 18, 2021

Dosant Feb 18, 2021

elasticmachine commented Feb 18, 2021

Dosant commented Feb 22, 2021

kibanamachine commented Feb 22, 2021

lizozom left a comment

Dosant commented Feb 22, 2021

		}: SearchSessionIndicatorDeps): React.FC => {
		const searchSessionsManagementUrl = basePath.prepend('/app/management/kibana/search_sessions');

[Search Sessions] Search session example app #89583

[Search Sessions] Search session example app #89583

Conversation

Dosant commented Jan 28, 2021 • edited Loading

Summary

Dosant Feb 18, 2021

Choose a reason for hiding this comment

Dosant Feb 18, 2021

Choose a reason for hiding this comment

Dosant Feb 18, 2021

Choose a reason for hiding this comment

Dosant Feb 18, 2021

Choose a reason for hiding this comment

Dosant Feb 18, 2021

Choose a reason for hiding this comment

Dosant Feb 18, 2021

Choose a reason for hiding this comment

Dosant Feb 18, 2021

Choose a reason for hiding this comment

elasticmachine commented Feb 18, 2021

Dosant commented Feb 22, 2021

kibanamachine commented Feb 22, 2021

💚 Build Succeeded

Metrics [docs]

Page load bundle

History

lizozom left a comment

Choose a reason for hiding this comment

Dosant commented Feb 22, 2021

Dosant commented Jan 28, 2021 •

edited

Loading