[GS] add savedObjects result provider #68619

pgayvallet · 2020-06-09T06:24:44Z

Summary

Fix #65222

Checklist

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

joshdover · 2020-06-18T19:27:27Z

Are we blocked on anything for this one?

…rovider

pgayvallet · 2020-06-23T09:52:01Z

Are we blocked on anything for this one?

I was waiting on #68620 and #68894 to finalize the PR.

pgayvallet · 2020-06-23T10:02:49Z

@ryankeairns The PR should be ready soon.

In the meantime, a status regarding the current 'searchable' saved objects. For the record, the rules to be searchable by the GS API are the same that from the savedObject management section:

The type must not be hidden
The type declaration must specify the management.defaultSearchField property
The type declaration must specify the management.getInAppUrl property

Currently, these types match these criteria and are findable by the GS API:

[ 
  'index-pattern',
  'query',
  'search',
  'visualization',
  'canvas-workpad',
  'map',
  'dashboard',
  'lens' 
]

If some searchable types should be removed, please tell me so that I introduce a white/black list mechanism
If some types required for V1 are not in the list (see 2nd list below), could you please list them? Note that I can't adapt the types myself and will have to open issues for the owning teams to add the required management metadatas to their SO types.

For the record, a quick list of all our registered SO types:

[ 'config',
  'task',
  'telemetry',
  'ui-metric',
  'application_usage_totals',
  'application_usage_transactional',
  'timelion-sheet',
  'url',
  'index-pattern',
  'query',
  'kql-telemetry',
  'search',
  'sample-data-telemetry',
  'upgrade-assistant-reindex-operation',
  'upgrade-assistant-telemetry',
  'file-upload-telemetry',
  'visualization',
  'tsvb-validation-telemetry',
  'canvas-element',
  'canvas-workpad',
  'maps-telemetry',
  'map',
  'graph-workspace',
  'dashboard',
  'lens',
  'lens-ui-telemetry',
  'space',
  'action',
  'action_task_params',
  'cases',
  'cases-comments',
  'cases-configure',
  'cases-user-actions',
  'alert',
  'infrastructure-ui-source',
  'metrics-explorer-view',
  'inventory-view',
  'uptime-dynamic-settings',
  'ml-telemetry',
  'apm-indices',
  'apm-telemetry' 
]

elasticmachine · 2020-06-23T11:50:12Z

Pinging @elastic/kibana-platform (Team:Platform)

mshustov

some optional nits, LGTM overall

x-pack/plugins/global_search_providers/server/providers/saved_objects/provider.ts

mshustov · 2020-06-26T08:33:37Z

x-pack/plugins/global_search_providers/server/providers/saved_objects/provider.ts

+import { GlobalSearchResultProvider } from '../../../../global_search/server';
+import { mapToResults } from './map_object_to_result';
+
+export const createSavedObjectsResultProvider = (): GlobalSearchResultProvider => {


Why we need the factory pattern here?

x-pack/plugins/global_search_providers/server/providers/saved_objects/provider.ts

x-pack/plugins/global_search_providers/server/providers/saved_objects/map_object_to_result.ts

mshustov · 2020-06-26T08:58:03Z

x-pack/test/plugin_functional/plugins/global_search_test/public/plugin.ts

+          .pipe(
+            map((batch) => batch.results),
+            // remove test types
+            map((results) => results.filter((r) => !r.type.startsWith('test_'))),


map + reduce combination can be substituted by flatMap?

flatMap would emit an individual event for each result. Could be replace with flatMap + toArray, but map + reduce is probably more explicit.

x-pack/test/plugin_functional/test_suites/global_search/global_search_providers.ts

…rovider

kibanamachine · 2020-07-06T10:36:44Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: eb48376

Build metrics

✅ unchanged

History

💔 Build #58806 failed 9dc6f87
💚 Build #58211 succeeded 63e7c2d
💛 Build #58184 was flaky 4b86f07
💚 Build #55545 succeeded b3f62e3
💔 Build #55492 failed 929eb89

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

* create server-side skeleton * add base implementation & tests * add unit test for provider * remove useless contracts * add preference search option * implement score from find results * fix types * add FTR test * fix test plugin types * address ome review comments * add multi results test * use `getVisibleTypes`

* master: [APM] Fix flaky e2e’s (elastic#70790) [Discover] Migrate server side saved object from data to discover plugin (elastic#70342) [APM] Update docs on running API tests (elastic#70765) test: 💍 delete a flaky test (elastic#70785) [Security Solution] Refactor GlobalTime to useGlobalTime hook and cle… (elastic#69345) Remove IE11 mention from PR template [skip ci] (elastic#70486) [GS] add savedObjects result provider (elastic#68619) remove snapshot from disabled test suite. (elastic#70769)

ryankeairns · 2020-07-06T15:32:45Z

@pgayvallet apologies for the delayed response, I've been out of the office for the past two weeks.

The list for V1 looks great and there are no other objects that I, personally, expected to appear from the second list. That said, there are some interesting items in that second list (e.g. cases) that I'm sure other teams would like to have included. As part of demoing and promoting this new feature, @alexfrancoeur and I can communicate to other teams how they can get their content registered.

Out of curiosity, is there a way to test the search API and see what sort of results are returned?

Thank you for all of your hard work, we are beyond excited to get this into Kibana and start trying it out!

alexfrancoeur · 2020-07-06T16:04:41Z

Thanks for the tag @ryankeairns. I have some comments and a few follow up questions listed below.

Generally, this list looks good to me but I see a few saved objects that we'll probably want to return eventually. I would think graph-workspace is something we'll want to add the list of returned SO's. As time goes on and the alerting framework GA's, we'll probably want to provide quick access to alert configurations as well. Maybe we can open up some issues to track? Happy to do so if needed.

query is an interesting saved object to return. Just out of curiosity, where would the URL route you to?

One last question, are the saved objects returned filtered through feature control and sub-feature control settings for the role that is searching?

ryankeairns · 2020-07-06T16:33:37Z

+1 to creating issues for those we know we want to include sooner rather than later.

* actions/feature: improved copy [APM] Fix flaky e2e’s (elastic#70790) [Discover] Migrate server side saved object from data to discover plugin (elastic#70342) [APM] Update docs on running API tests (elastic#70765) test: 💍 delete a flaky test (elastic#70785) [Security Solution] Refactor GlobalTime to useGlobalTime hook and cle… (elastic#69345) Remove IE11 mention from PR template [skip ci] (elastic#70486) [GS] add savedObjects result provider (elastic#68619) remove snapshot from disabled test suite. (elastic#70769)

pgayvallet · 2020-07-08T07:09:17Z

Out of curiosity, is there a way to test the search API and see what sort of results are returned?

Unfortunately as it's not 'plugged' anywhere yet, the only solution I see to test the returned results would be to directly query the endpoint, with curl, postman or any other tool.

POST http://kibana_instance/internal/global_search/find
payload: { term: 'my search term' }

not that the application results would not be listed, as this would only return the server-side results. But all searchable SO results would be returned.

pgayvallet added 3 commits June 9, 2020 08:22

create server-side skeleton

d182756

add base implementation & tests

ec51f7f

add unit test for provider

9417744

pgayvallet mentioned this pull request Jun 11, 2020

[GS] add the provider field to GlobalSearchResult #68878

Closed

2 tasks

pgayvallet added release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v7.9.0 v8.0.0 labels Jun 16, 2020

pgayvallet added 4 commits June 23, 2020 11:12

Merge remote-tracking branch 'upstream/master' into kbn-65222-gs-so-p…

c60922f

…rovider

remove useless contracts

a2aecbe

add preference search option

872e8ab

implement score from find results

adb832c

pgayvallet added 2 commits June 23, 2020 12:06

fix types

eb7916f

add FTR test

929eb89

pgayvallet marked this pull request as ready for review June 23, 2020 11:50

pgayvallet requested a review from a team as a code owner June 23, 2020 11:50

fix test plugin types

b3f62e3

mshustov approved these changes Jun 26, 2020

View reviewed changes

pgayvallet added 5 commits July 2, 2020 10:26

Merge remote-tracking branch 'upstream/master' into kbn-65222-gs-so-p…

2a76b1c

…rovider

address ome review comments

4b86f07

add multi results test

11caf68

Merge remote-tracking branch 'upstream/master' into kbn-65222-gs-so-p…

3ba6e89

…rovider

use getVisibleTypes

63e7c2d

pgayvallet added 2 commits July 6, 2020 08:33

Merge remote-tracking branch 'upstream/master' into kbn-65222-gs-so-p…

9dc6f87

…rovider

Merge remote-tracking branch 'upstream/master' into kbn-65222-gs-so-p…

eb48376

…rovider

pgayvallet merged commit 04aaba8 into elastic:master Jul 6, 2020

pgayvallet mentioned this pull request Jul 6, 2020

[7.x] [GS] add savedObjects result provider (#68619) #70787

Merged

myasonik mentioned this pull request Sep 1, 2020

Stacked headers and navigational search #72331

Merged

12 tasks

ruflin mentioned this pull request Sep 15, 2020

[Ingest Manager] Use navigational search to show Ingest Manager objects #77436

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GS] add savedObjects result provider #68619

[GS] add savedObjects result provider #68619

pgayvallet commented Jun 9, 2020 •

edited

Loading

joshdover commented Jun 18, 2020

pgayvallet commented Jun 23, 2020

pgayvallet commented Jun 23, 2020

elasticmachine commented Jun 23, 2020

mshustov left a comment

mshustov Jun 26, 2020

mshustov Jun 26, 2020

pgayvallet Jul 2, 2020

kibanamachine commented Jul 6, 2020

ryankeairns commented Jul 6, 2020

alexfrancoeur commented Jul 6, 2020

ryankeairns commented Jul 6, 2020

pgayvallet commented Jul 8, 2020

[GS] add savedObjects result provider #68619

[GS] add savedObjects result provider #68619

Conversation

pgayvallet commented Jun 9, 2020 • edited Loading

Summary

Checklist

joshdover commented Jun 18, 2020

pgayvallet commented Jun 23, 2020

pgayvallet commented Jun 23, 2020

elasticmachine commented Jun 23, 2020

mshustov left a comment

Choose a reason for hiding this comment

mshustov Jun 26, 2020

Choose a reason for hiding this comment

mshustov Jun 26, 2020

Choose a reason for hiding this comment

pgayvallet Jul 2, 2020

Choose a reason for hiding this comment

kibanamachine commented Jul 6, 2020

💚 Build Succeeded

Build metrics

History

ryankeairns commented Jul 6, 2020

alexfrancoeur commented Jul 6, 2020

ryankeairns commented Jul 6, 2020

pgayvallet commented Jul 8, 2020

pgayvallet commented Jun 9, 2020 •

edited

Loading