[GS] Allows apps to register searchable keywords for Global Search

[TinaHeiligers]

Resolves #76778

Summary

Allows applications to register keywords as search terms for Global Search.
Since keywords are not data, they are have been added to the App type as a meta property. This PR moves searchDeepLinks into the new meta property for the same reason (they are not data).

core.application.register({
  id: 'myApp',
  title: 'Translated title,
  mount,
  meta: {
     keywords: ['translated keyword1', 'translated keyword2']
	 searchDeepLinks: [
     	{ id: 'sub1', title: 'Sub1', path: '/sub1', meta: { keywords: ['subpath1'] } },
   	 ],
  }
})

Scoring by keywords implements the same algorithm as searching for applications by title and weights the scores in favor of matching by title (keywords score * 0.8). The weighting factor is an arbitrary constant.

This PR makes no assumptions on what keywords to assign to apps, rather leaving it up to application developers and solutions to choose their own.

How to test this

The unit tests for get_app_info, e.g. https://github.com/elastic/kibana/pull/85686/files#diff-5d4a779847b1ac5095589e30e25778e35a3350c09b4c6d9bdfcca0b22bc820fbR122 show how the keywords are added to an app and the unit tests for get_app_results, e.g. https://github.com/elastic/kibana/pull/85686/files#diff-3656691fb1cb333c33264ea83656f59878c49b13d7c3cdda8399ddbcc4e7d03eR113 show how scoring by keywords works.

To test this 'live', you'll need to add keywords or add a new plugin that has keywords and, optionally, deep links (see https://github.com/elastic/kibana/pull/85686/files#diff-efac386db0738f497e14a9772c5da15dde935e474ee2dc3b62fe5fca2e0e92d8R247 as an example), after pulling the code.

Example

Plugin: Uptime
Modified registration:

    core.application.register({
      id: PLUGIN.ID,
      euiIconType: 'logoObservability',
      order: 8400,
      title: PLUGIN.TITLE,
      category: DEFAULT_APP_CATEGORIES.observability,
      meta: {
        keywords: ['awake'], // --> add your keyword(s)
      },
      mount: async (params: AppMountParameters) => {
        const [coreStart, corePlugins] = await core.getStartServices();

        const { renderApp } = await import('./render_app');

        return renderApp(coreStart, plugins, corePlugins, params);
      },
    });

Run the code and search for 'awake'. This should show a direct link to 'Uptime'

Plugin: APM
Modified registration:

core.application.register({
      id: 'apm',
      title: 'APM',
      order: 8300,
      euiIconType: 'logoObservability',
      appRoute: '/app/apm',
      icon: 'plugins/apm/public/icon.svg',
      category: DEFAULT_APP_CATEGORIES.observability,
      meta: {
        keywords: ['application monitoring', 'performance'], // --> add your keyword(s)
      },

      async mount(params: AppMountParameters<unknown>) {
        ...
      },
    });

Searching for 'performance' or 'application monitoring' or any shorter version of these keywords will show a direct link to the 'APM' app:

Keywords in deep links work similarly.

Release Notes

Kibana's navigation search now implements keyword registration for applications, allowing you to search for applications by keywords as well as by title.

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

For maintainers

• This was checked for breaking API changes and was labeled appropriately

[TinaHeiligers]

@joshdover @pgayvallet This is still very much work in progress. I wanted to open a draft early so that we can discuss what we still need for this feature and what we decide to strip out (e.g. removing keywords from application deep links)

[joshdover]

This looks fantastic. I do think we should move the searchDeepLinks property into the meta object so that these two concepts are closer to one another in the API. We don't have to do that in this PR though if you'd prefer a follow up for that.

[pgayvallet]

Looking great for now!

+1 for josh's proposal to move searchDeepLinks into the new meta property

[elasticmachine]

Pinging @elastic/kibana-core (Team:Core)

[pgayvallet]

A few nits, but overall the implementation is great.

LGTM

[pgayvallet]

NIT: was already present before this PR, but the link to AppSubLink is broken. I guess it should point to PublicAppSearchDeepLinkInfo?

[TinaHeiligers]

I'll fix it while waiting for the @elastic/kibana-app team's review.

[pgayvallet]

optional: we could break/return earlier if a keyword's score is 100.

[TinaHeiligers]

We can add that as an optional optimization strategy if/when plugin owners start adding their keywords. Right now, I don't think it's needed.

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: 8f1dcc2

Metrics [docs]

Distributable file count

id	before	after	diff
default	47285	48045	+760

Page load bundle

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

id	before	after	diff
core	554.6KB	555.2KB	+605.0B
globalSearchProviders	8.8KB	9.9KB	+1.1KB
management	22.2KB	23.3KB	+1.0KB
total			+2.7KB

History

• 💚 Build #95146 succeeded ca7923e
• 💚 Build #95062 succeeded 5d8fb0e
• 💔 Build #95048 failed e33f299
• 💚 Build #94758 succeeded bcd753d
• 💚 Build #93745 succeeded 1ed504c

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

[flash1293]

KibanaApp code changes LGTM, didn't test locally