[SharedUxChromeNavigation] Use deeplink id instead of href

[sebelga]

In this PR I removed the use of href for the serverless side navigation definition and replace them with link which points to either the root of an app or a deeplink id.

Autocomplete

Now that all the deeplinks types are exposed, TS autocomplete is available when building a side navigation.

 href support

It is still possible to pass an href to a navigation node definition but only for external links. For internal link a deeplink id must be used. If an external href is added in the navigation tree, it is marked as external in the UI

Packages created

Instead of creating a separate package for each of the app and its deeplinks I've decided to group the deeplink by domain, the same way we group them in the navigation. It is thus expected that there will be multiple team owning those packages. As we don't plan to add frequently new deeplinks I think that the trade off of fewer packages with a bit more "noise" on PR ownership should be OK.

### Deeplinks

• @kbn/deeplinks-devtools
• @kbn/deeplinks-analytics
• @kbn/deeplinks-ml
• @kbn/deeplinks-management
• @kbn/deeplinks-search
• @kbn/deeplinks-observability

Navigations "presets"

It is possible to add default navigation for certain domain in the navigation tree by simply loading a "preset".

// by config
{
  type: 'navGroup',
  preset: 'analytics',
},

// or using React component
<Navigation.Group preset="analytics" defaultIsCollapsed={false} />

Those "default" are now owned by the teams owning those domain. If we don't feel the need to expose a "default" navigation for a certain domain we can remove the preset and its corresponding package.

• @kbn/default-nav-analytics
• @kbn/default-nav-ml
• @kbn/default-nav-devtools
• @kbn/default-nav-management

Fixes #158658
Fixes #158376

[kpatticha]

@gbamparop I looked into it and the Observability links you mentioned are marked as hidden from navigation that's why they don't appear.

If it is an easy fix I can change that boolean where you tell me, otherwise I think the best is that the observability team takes it from here (once the PR is merged) and make sure all the deeplink they require have their app mounted and the deeplink is not marked as hidden.

Regarding the "Logs" link, in main it currently points to "discover" app which is obviously wrong. Now it does not appear probably because of this condition https://github.com/elastic/kibana/blob/main/x-pack/plugins/infra/public/plugin.ts#L194

For the Machine learning sublinks, the "ml" team is responsible of the default navigation and will probably update it once this PR is merged (cc @jgowdyelastic)

so it seems we need to update

kibana/x-pack/plugins/apm/public/plugin.ts

Line 323 in ad2593b

deepLinks: [

but wondering why on serverless it works differently from the classic Kibana?

[sebelga]

wondering why on serverless it works different from the classic Kibana

Yeah it is strange. From the file you point it seems that deeplink are active. Something else is disabling them but not seeing any updater$ being registered to update deeplinks

[elasticmachine]

Pinging @elastic/apm-ui (Team:APM)

[sebelga]

@kpatticha

So it seems that by default deeplinks are hidden (https://github.com/elastic/kibana/blob/main/packages/core/application/core-application-browser-internal/src/utils/get_app_info.ts#L47) and you need to manually set it to visible.

I've done it for the "Apm" services (7686eb2)

For the logs, it is probably something like this (https://github.com/elastic/kibana/blob/main/x-pack/plugins/infra/public/plugin.ts#L178) that hides the link in the side nav. You will have to see with the infra team how to enable them in serverless for Observability.

[sebelga]

@gbamparop I had to revert my change to mark the deeplink as visible as it was failing a test "APM specs feature controls security global apm all privileges shows apm navlink".

I think it is better that you mark the link(s) as visible in a following PR if they are meant to be seen in the navigation.

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: a35f4ce
• Storybooks Preview

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
devTools	25	27	+2
serverlessObservability	40	45	+5
serverlessSearch	84	89	+5
total			+12

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
@kbn/core-chrome-browser	55	58	+3
@kbn/deeplinks-analytics	-	5	+5
@kbn/deeplinks-devtools	-	5	+5
@kbn/deeplinks-management	-	4	+4
@kbn/deeplinks-ml	-	3	+3
@kbn/deeplinks-observability	-	3	+3
@kbn/deeplinks-search	-	3	+3
@kbn/default-nav-analytics	-	7	+7
@kbn/default-nav-devtools	-	7	+7
@kbn/default-nav-management	-	7	+7
@kbn/default-nav-ml	-	7	+7
@kbn/shared-ux-chrome-navigation	46	44	-2
total			+52

Any counts in public APIs

Total count of every any typed public API. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats any for more detailed information.

id	before	after	diff
@kbn/default-nav-analytics	-	1	+1
@kbn/default-nav-devtools	-	1	+1
@kbn/default-nav-management	-	1	+1
@kbn/default-nav-ml	-	1	+1
total			+4

Async chunks

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

id	before	after	diff
ml	3.4MB	3.4MB	+604.0B

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
@kbn/deeplinks-management	-	2	+2
@kbn/shared-ux-chrome-navigation	7	5	-2
total			-0

Page load bundle

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

id	before	after	diff
devTools	10.7KB	10.9KB	+169.0B
ml	73.9KB	73.9KB	+14.0B
serverlessObservability	26.1KB	25.2KB	-912.0B
serverlessSearch	30.1KB	28.5KB	-1.6KB
total			-2.3KB

Unknown metric groups

API count

id	before	after	diff
@kbn/core-chrome-browser	141	150	+9
@kbn/deeplinks-analytics	-	5	+5
@kbn/deeplinks-devtools	-	5	+5
@kbn/deeplinks-management	-	4	+4
@kbn/deeplinks-ml	-	3	+3
@kbn/deeplinks-observability	-	3	+3
@kbn/deeplinks-search	-	3	+3
@kbn/default-nav-analytics	-	7	+7
@kbn/default-nav-devtools	-	7	+7
@kbn/default-nav-management	-	7	+7
@kbn/default-nav-ml	-	7	+7
@kbn/shared-ux-chrome-navigation	76	68	-8
total			+52

ESLint disabled line counts

id	before	after	diff
@kbn/shared-ux-chrome-navigation	0	4	+4
enterpriseSearch	13	15	+2
securitySolution	409	413	+4
total			+10

Total ESLint disabled count

id	before	after	diff
@kbn/shared-ux-chrome-navigation	0	4	+4
enterpriseSearch	14	16	+2
securitySolution	492	496	+4
total			+10

History

• 💔 Build #134810 failed 7686eb2
• 💚 Build #134768 succeeded 151cf15
• 💚 Build #134717 succeeded dc87c6a
• 💚 Build #134524 succeeded 08c1eef
• 💚 Build #134452 succeeded 4bd600f

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

cc @sebelga

[gbamparop]

@gbamparop I had to revert my change to mark the deeplink as visible as it was failing a test "APM specs feature controls security global apm all privileges shows apm navlink".

I think it is better that you mark the link(s) as visible in a following PR if they are meant to be seen in the navigation.

Thanks for looking into this, we'll create a follow-up.