Remove legacy applications and legacy mode #75987

pgayvallet · 2020-08-26T14:51:29Z

Summary

Remove the legacy mode from the application service, delete the (client-side) legacy service, and adapt surrounding code.

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

…legacy-mode

elasticmachine · 2020-08-27T19:21:24Z

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

pgayvallet · 2020-08-27T19:27:03Z

src/core/public/application/types.ts

-/** @public */
-export interface AppBase {
+/**


Diff can be a little hard to read, but I mostly merged AppBase into App, as we no longer need this supertype due to the LegacyApp removal.

pgayvallet · 2020-08-27T19:31:45Z

src/core/public/application/ui/app_router.tsx

-            // Find the mounter including legacy mounters with subapps:
-            const [id, mounter] = mounters.has(appId)
-              ? [appId, mounters.get(appId)]
-              : [...mounters].filter(([key]) => key.split(':')[0] === appId)[0] ?? [];
-
+            const [id, mounter] = mounters.has(appId) ? [appId, mounters.get(appId)] : [];


I initially totally removed the id retrieval logic from the catch-all handler, and was just passing an undefined mounter and a 'not-found' id to AppContainer, however this catch-all is still used to properly dispaly the uptime app, due to the way they declare their base path:

kibana/x-pack/plugins/uptime/public/apps/plugin.ts

Lines 86 to 89 in 532f2d7

core.application.register({

appRoute: '/app/uptime#/',

id: PLUGIN.ID,

euiIconType: 'uptimeApp',

Not sure how or why, but the hashbang in the appRoute make their specific route not matching, the previous routes definition, but the appId is properly identified by the catch-all.

keeping these 3 lines do not have a significant impact anyway, so I did not spend much time trying to fix an issue around hashbang routing, that we officially are not supporting anyway.

Can we open an issue for the Uptime team to migrate away from hashbang routing and leave a note that we can remove these lines once that is done?

Created #76348 and will add comment.

pgayvallet · 2020-08-27T19:35:24Z

src/legacy/ui/public/chrome/api/injected_vars.ts

-  chrome.getInjected = (name?: string, defaultValue?: any) =>
-    cloneDeep(
-      name
-        ? newPlatformInjectedVars.getInjectedVar(name, defaultValue)
-        : newPlatformInjectedVars.getInjectedVars()
-    );
+  chrome.getInjected = (name: string, defaultValue?: any) =>
+    cloneDeep(newPlatformInjectedVars.getInjectedVar(name, defaultValue));


Deleted the LegacyCore types, replaced with CoreStart/Setup were needed in the legacy code, so getInjectedVars is no longer present on the type. Had to adapt that and remove some legacy tests.

This is dead code anyway, and is going to be deleted in #76085

…legacy-mode

lizozom

Code owner changes LGTM

joshdover

A few things that still need to be adjusted:

Remove the getLegacyMode() API from InjectedMetadataService (it's also used in a couple places that will need to be updated, eg. chrome_service.tsx). Also remove the LegacyNavLink type and associated methods.
src/core/public/application/types.ts:654 - NavigateToAppOptions.replace can remove the remark regarding legacy applications
Many of the UI components in src/core/public/chrome/ui/header have a legacyMode prop. Can we remove those?
src/core/public/chrome/ui/header/collapsible_nav.test.tsx:43,65 two lines reference legacy flags that were removed

joshdover · 2020-08-31T18:37:48Z

src/core/public/application/types.ts

@@ -826,9 +767,3 @@ export interface InternalApplicationStart extends Omit<ApplicationStart, 'regist
   */
  history: History<unknown> | undefined;


Can this still be undefined? Shouldn't it always be present now since we no longer have a legacy mode?

joshdover · 2020-08-31T18:40:59Z

src/core/public/application/ui/app_router.tsx

-            // Find the mounter including legacy mounters with subapps:
-            const [id, mounter] = mounters.has(appId)
-              ? [appId, mounters.get(appId)]
-              : [...mounters].filter(([key]) => key.split(':')[0] === appId)[0] ?? [];
-
+            const [id, mounter] = mounters.has(appId) ? [appId, mounters.get(appId)] : [];


Can we open an issue for the Uptime team to migrate away from hashbang routing and leave a note that we can remove these lines once that is done?

joshdover · 2020-08-31T18:44:22Z

src/core/public/application/integration_tests/router.test.tsx

-      onAppLeave: expect.any(Function),
-      history: expect.any(ScopedHistory),
-    });
-  });


Should we remove the last test too: displays error page if legacy app is inaccessible ?

joshdover · 2020-08-31T18:44:44Z

src/core/public/application/ui/app_container.test.tsx

@@ -54,7 +54,6 @@ describe('AppContainer', () => {
    appBasePath: '/base-path',
    appRoute: '/some-route',
    unmountBeforeMounting: false,
-    legacy: false,


there's one more below on line 145

joshdover · 2020-08-31T18:45:32Z

src/core/public/application/types.ts

-   * @internal
-   */
-  legacy?: boolean;
-
  /**
   * Hide the UI chrome when the application is mounted. Defaults to `false`.
   * Takes precedence over chrome service visibility settings.
   */
  chromeless?: boolean;


nit: add a new line before the TSDoc below

joshdover · 2020-08-31T18:45:57Z

src/core/public/chrome/ui/header/nav_link.tsx

@@ -71,7 +66,6 @@ export function createEuiListItem({
      if (
        !externalLink && // ignore external links
        !legacyMode && // ignore when in legacy mode


joshdover · 2020-08-31T18:51:24Z

src/core/public/core_system.test.ts

-    coreSystem.stop();
-    expect(MockLegacyPlatformService.stop).toHaveBeenCalled();
-  });
-


Below on line 388 we are still returning a legacyTargetDomElement unnecessarily

joshdover · 2020-08-31T18:51:51Z

src/core/public/core_system.ts

@@ -86,7 +82,6 @@ export interface InternalCoreStart extends Omit<CoreStart, 'application'> {
 export class CoreSystem {


TSDoc above should remove all references to LegacyPlatform

joshdover · 2020-08-31T18:55:01Z

src/core/public/chrome/nav_links/nav_link.ts

@@ -142,12 +142,6 @@ export interface ChromeNavLink {
   * register an Application if needed.
   */
  readonly hidden?: boolean;
-


Above, on the href property, can we now make that required?

Can we remove these properties: subUrlBase, disableSubUrlTracking, linkToLastSubUrl?

…legacy-mode

pgayvallet · 2020-09-01T10:26:18Z

@joshdover I think I addressed all your comments. Do you see anything else?

kindsun

Maps changes lgtm!

code review

kertal

KibanaApp owned code LGTM, did a checkout in Firefox, no regressions detected. thx for the cleanup!

mshustov · 2020-09-02T13:42:50Z

src/core/public/rendering/rendering_service.tsx

    const chromeUi = chrome.getHeaderComponent();
    const appUi = application.getComponent();
    const bannerUi = overlays.banners.getComponent();

-    const legacyMode = injectedMetadata.getLegacyMode();


could you remove legacyMode leftovers?

kibana/src/core/server/rendering/rendering_service.tsx

Line 85 in 4c810be

legacyMode: false,

kibana/src/core/public/chrome/ui/header/header.test.tsx

Line 53 in 8598db5

legacyMode: false,

kibana/src/core/server/rendering/types.ts

Line 48 in 53b1875

legacyMode: boolean;

There are still a few functional tests referencing the legacy apps

https://github.com/elastic/kibana/blob/4c810be33595d478c6eb802170d0644b32e62898/test/plugin_functional/test_suites/core_plugins/rendering.ts

and

kibana/test/plugin_functional/test_suites/core_plugins/applications.ts

Lines 150 to 158 in 384213f

it.skip('can navigate from NP apps to legacy apps', async () => {

await appsMenu.clickLink('Stack Management');

await testSubjects.existOrFail('managementNav');

});

it('can navigate from legacy apps to NP apps', async () => {

await appsMenu.clickLink('Foo');

await testSubjects.existOrFail('fooAppHome');

});

mshustov · 2020-09-02T13:52:52Z

src/core/public/chrome/nav_links/nav_link.ts

@@ -122,37 +102,11 @@ export interface ChromeNavLink {
   * @deprecated
   */
  readonly active?: boolean;


it's deprecated as well. can be removed now?

…legacy-mode

kibanamachine · 2020-09-03T09:52:18Z

💚 Build Succeeded

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

Build metrics

@kbn/optimizer bundle module count

id	value	diff	baseline
core	559	-2	561

async chunks size

id	value	diff	baseline
maps	3.3MB	-31.0B	3.3MB
timelion	598.5KB	-17.0B	598.5KB
total		-48.0B

page load bundle size

id	value	diff	baseline
core	1.2MB	-10.6KB	1.2MB
dashboard	708.2KB	-16.0B	708.2KB
discover	229.3KB	-16.0B	229.3KB
globalSearchProviders	9.9KB	-22.0B	9.9KB
kibanaLegacy	247.3KB	-402.0B	247.7KB
savedObjects	236.7KB	-340.0B	237.0KB
visualizations	406.9KB	-16.0B	406.9KB
total		-11.4KB

oss distributable file count

id	value	diff	baseline
total	27299	-1	27300

distributable file count

id	value	diff	baseline
total	45458	-1	45459

History

💔 Build #72162 failed 68de7ea
💚 Build #71512 succeeded 82a3a54
💚 Build #71165 succeeded bb64a7f
💚 Build #70962 succeeded 8c812f7
💔 Build #70887 failed eff622a

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

* remove legacy mode and legacy service * fix tests * remove txt file * fix xpack code * fix types * remove legacy test * fix integration tests * remove legacy reference * yet another legacy reference * handle uptime app special case * update generated doc * address review comments * remove legacy fields from ChromeNavLink * few fixes * remove legacy API from docTitle service * ChromeNavLink.href is now mandatory * update generated doc * remove legacyMode leftovers * remove ChromeNavLink.active * update generated doc # Conflicts: # src/core/public/chrome/nav_links/to_nav_link.ts # src/core/public/chrome/ui/header/nav_link.tsx # src/core/public/legacy/legacy_service.ts

…nes/processors-forms-k-s * 'master' of github.com:elastic/kibana: (216 commits) [Ingest Manager] Split Registry errors into Connection & Response (elastic#76558) [Security Solution] add an excess validation instead of the exact match (elastic#76472) Introduce TS incremental builds & move src/test_utils to TS project (elastic#76082) fix bad merge (elastic#76629) [Newsfeed] Ensure the version format when calling the API (elastic#76381) remove server_extensions mixin (elastic#76606) Remove legacy applications and legacy mode (elastic#75987) [Discover] Fix sidebar element focus behavior when adding / removing columns (elastic#75749) Replace FetchOptions with ISearchOptions (elastic#76538) Move streams utils to the core (elastic#76397) [Ingest Manager] Wording & linking improvements (elastic#76284) remove legacy kibana plugin (elastic#76064) [Form lib] Fix regression on field not being validated after reset to its default value. (elastic#76379) Legacy SO import: Fix bug causing multiple overrides to only show the last confirm modal (elastic#76482) [APM] Service maps layout enhancements (elastic#76481) [Security Solution][Detection Engine] Remove RuleTypeSchema in favor of Type for TypeScript (elastic#76586) [Security Solution][Exceptions] - Updates enum schema and tests (elastic#76544) Index Pattern class - remove toJSON and toString (elastic#76246) skip failing suite (elastic#76581) Split up and clarify Enterprise Search codeowners (elastic#76580) ... # Conflicts: # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processor_settings_fields.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/foreach.tsx

…oleysens/kibana into ingest-pipelines/processors-forms-k-s * 'ingest-pipelines/processors-forms-k-s' of github.com:jloleysens/kibana: (216 commits) [Ingest Manager] Split Registry errors into Connection & Response (elastic#76558) [Security Solution] add an excess validation instead of the exact match (elastic#76472) Introduce TS incremental builds & move src/test_utils to TS project (elastic#76082) fix bad merge (elastic#76629) [Newsfeed] Ensure the version format when calling the API (elastic#76381) remove server_extensions mixin (elastic#76606) Remove legacy applications and legacy mode (elastic#75987) [Discover] Fix sidebar element focus behavior when adding / removing columns (elastic#75749) Replace FetchOptions with ISearchOptions (elastic#76538) Move streams utils to the core (elastic#76397) [Ingest Manager] Wording & linking improvements (elastic#76284) remove legacy kibana plugin (elastic#76064) [Form lib] Fix regression on field not being validated after reset to its default value. (elastic#76379) Legacy SO import: Fix bug causing multiple overrides to only show the last confirm modal (elastic#76482) [APM] Service maps layout enhancements (elastic#76481) [Security Solution][Detection Engine] Remove RuleTypeSchema in favor of Type for TypeScript (elastic#76586) [Security Solution][Exceptions] - Updates enum schema and tests (elastic#76544) Index Pattern class - remove toJSON and toString (elastic#76246) skip failing suite (elastic#76581) Split up and clarify Enterprise Search codeowners (elastic#76580) ...

* master: (340 commits) [data.search.SearchSource] Remove legacy ES client APIs. (elastic#75943) [release notes] automatically retry on Github API 5xx errors (elastic#76447) [es_ui_shared] Fix eslint exhaustive deps rule (elastic#76392) [i18n] Integrate 7.9.1 Translations (elastic#76391) [APM] Update aggregations to support script sources (elastic#76429) [Security Solution] Refactor Network Top Countries to use Search Strategy (elastic#76244) Document security settings available on ESS (elastic#76513) [Ingest Manager] Add input revision to the config send to the agent (elastic#76327) [DOCS] Identifies cloud settings for Monitoring (elastic#76579) [DOCS] Identifies Cloud settings in Dev Tools (elastic#76583) [Ingest Manager] Better default value for fleet long polling timeout (elastic#76393) [data.indexPatterns] Fix broken rollup index pattern creation (elastic#76593) [Ingest Manager] Split Registry errors into Connection & Response (elastic#76558) [Security Solution] add an excess validation instead of the exact match (elastic#76472) Introduce TS incremental builds & move src/test_utils to TS project (elastic#76082) fix bad merge (elastic#76629) [Newsfeed] Ensure the version format when calling the API (elastic#76381) remove server_extensions mixin (elastic#76606) Remove legacy applications and legacy mode (elastic#75987) [Discover] Fix sidebar element focus behavior when adding / removing columns (elastic#75749) ...

pgayvallet added 13 commits August 26, 2020 16:24

remove legacy mode and legacy service

12c0367

fix tests

1c1be95

remove txt file

3480de2

fix xpack code

b6fe9fb

fix types

99e095f

remove legacy test

17948fd

fix integration tests

89678d6

remove legacy reference

302ee95

yet another legacy reference

306dc44

Merge remote-tracking branch 'upstream/master' into kbn-74911-remove-…

df3502b

…legacy-mode

handle uptime app special case

a4a2bed

update generated doc

eff622a

Merge remote-tracking branch 'upstream/master' into kbn-74911-remove-…

8c812f7

…legacy-mode

pgayvallet added Feature:Legacy Removal Issues related to removing legacy Kibana 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.10.0 labels Aug 27, 2020

pgayvallet added this to Pending Review in kibana-core [DEPRECATED] via automation Aug 27, 2020

pgayvallet marked this pull request as ready for review August 27, 2020 19:21

pgayvallet requested a review from a team August 27, 2020 19:21

pgayvallet requested review from a team as code owners August 27, 2020 19:21

pgayvallet commented Aug 27, 2020

View reviewed changes

botelastic bot added the Feature:Embedding Embedding content via iFrame label Aug 27, 2020

pgayvallet removed the Feature:Embedding Embedding content via iFrame label Aug 27, 2020

Merge remote-tracking branch 'upstream/master' into kbn-74911-remove-…

bb64a7f

…legacy-mode

lizozom approved these changes Aug 31, 2020

View reviewed changes

botelastic bot added the Feature:Embedding Embedding content via iFrame label Aug 31, 2020

joshdover requested changes Aug 31, 2020

View reviewed changes

pgayvallet added 8 commits September 1, 2020 08:02

Merge remote-tracking branch 'upstream/master' into kbn-74911-remove-…

2318387

…legacy-mode

address review comments

a00ff62

remove legacy fields from ChromeNavLink

a7e869b

Merge remote-tracking branch 'upstream/master' into kbn-74911-remove-…

3e9f9e2

…legacy-mode

few fixes

8ccb989

remove legacy API from docTitle service

3ee90ba

ChromeNavLink.href is now mandatory

8598db5

update generated doc

9fcb097

pgayvallet requested a review from a team as a code owner September 1, 2020 08:54

Merge remote-tracking branch 'upstream/master' into kbn-74911-remove-…

82a3a54

…legacy-mode

kindsun approved these changes Sep 1, 2020

View reviewed changes

pgayvallet requested a review from joshdover September 1, 2020 20:33

kertal approved these changes Sep 2, 2020

View reviewed changes

mshustov reviewed Sep 2, 2020

View reviewed changes

mshustov approved these changes Sep 2, 2020

View reviewed changes

pgayvallet added 4 commits September 3, 2020 08:58

Merge remote-tracking branch 'upstream/master' into kbn-74911-remove-…

484dea4

…legacy-mode

remove legacyMode leftovers

68de7ea

remove ChromeNavLink.active

916c73a

update generated doc

b091a75

pgayvallet merged commit e976bdd into elastic:master Sep 3, 2020

kibana-core [DEPRECATED] automation moved this from Pending Review to Done (7.10) Sep 3, 2020

pgayvallet mentioned this pull request Sep 3, 2020

[7.x] Remove legacy applications and legacy mode (#75987) #76618

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove legacy applications and legacy mode #75987

Remove legacy applications and legacy mode #75987

pgayvallet commented Aug 26, 2020 •

edited

elasticmachine commented Aug 27, 2020

pgayvallet Aug 27, 2020

pgayvallet Aug 27, 2020

joshdover Aug 31, 2020

pgayvallet Sep 1, 2020

pgayvallet Aug 27, 2020

lizozom left a comment

joshdover left a comment

joshdover Aug 31, 2020

joshdover Aug 31, 2020

joshdover Aug 31, 2020

joshdover Aug 31, 2020

joshdover Aug 31, 2020

joshdover Aug 31, 2020

joshdover Aug 31, 2020

joshdover Aug 31, 2020

joshdover Aug 31, 2020

pgayvallet commented Sep 1, 2020

kindsun left a comment

kertal left a comment

mshustov Sep 2, 2020 •

edited

mshustov Sep 2, 2020

kibanamachine commented Sep 3, 2020

	core.application.register({
	appRoute: '/app/uptime#/',
	id: PLUGIN.ID,
	euiIconType: 'uptimeApp',

		@@ -826,9 +767,3 @@ export interface InternalApplicationStart extends Omit<ApplicationStart, 'regist
		*/
		history: History<unknown> \| undefined;

		@@ -86,7 +82,6 @@ export interface InternalCoreStart extends Omit<CoreStart, 'application'> {
		export class CoreSystem {

	it.skip('can navigate from NP apps to legacy apps', async () => {
	await appsMenu.clickLink('Stack Management');
	await testSubjects.existOrFail('managementNav');
	});

	it('can navigate from legacy apps to NP apps', async () => {
	await appsMenu.clickLink('Foo');
	await testSubjects.existOrFail('fooAppHome');
	});

Remove legacy applications and legacy mode #75987

Remove legacy applications and legacy mode #75987

Conversation

pgayvallet commented Aug 26, 2020 • edited

Summary

Checklist

elasticmachine commented Aug 27, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lizozom left a comment

Choose a reason for hiding this comment

joshdover left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pgayvallet commented Sep 1, 2020

kindsun left a comment

Choose a reason for hiding this comment

kertal left a comment

Choose a reason for hiding this comment

mshustov Sep 2, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibanamachine commented Sep 3, 2020

💚 Build Succeeded

Build metrics

@kbn/optimizer bundle module count

async chunks size

page load bundle size

oss distributable file count

distributable file count

History

pgayvallet commented Aug 26, 2020 •

edited

mshustov Sep 2, 2020 •

edited