Add ApplicationService app status management

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

@@ -309,7 +309,7 @@ class HeaderUI extends Component<Props, State> {
       .filter(navLink => !navLink.hidden)
       .map(navLink => ({
         key: navLink.id,
-        label: navLink.title,
+        label: navLink.tooltip ?? navLink.title,
 
         // Use href and onClick to support "open in new tab" and SPA navigation in the same link
         href: navLink.href,

test/functional/services/apps_menu.ts

@@ -25,7 +25,7 @@ export function AppsMenuProvider({ getService }: FtrProviderContext) {
 
   return new (class AppsMenu {
     /**
-     * Get the text and href from each of the links in the apps menu
+     * Get the attributes from each of the links in the apps menu
      */
     public async readLinks() {
       const appMenu = await testSubjects.find('navDrawer');
@@ -37,12 +37,21 @@ export function AppsMenuProvider({ getService }: FtrProviderContext) {
           return {
             text: $(link).text(),
             href: $(link).attr('href'),
+            disabled: $(link).attr('disabled') != null,
           };
         });
 
       return links;
     }
 
+    /**
+     * Get the attributes from the link with the given name.
+     * @param name
+     */
+    public async getLink(name: string) {
+      return (await this.readLinks()).find(nl => nl.text === name);
+    }
+
     /**
      * Determine if an app link with the given name exists
      * @param name

test/plugin_functional/plugins/core_app_status/kibana.json

@@ -0,0 +1,8 @@
+{
+  "id": "core_app_status",
+  "version": "0.0.1",
+  "kibanaVersion": "kibana",
+  "configPath": ["core_app_status"],
+  "server": false,
+  "ui": true
+}

test/plugin_functional/plugins/core_app_status/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "core_app_status",
+  "version": "1.0.0",
+  "main": "target/test/plugin_functional/plugins/core_app_status",
+  "kibana": {
+    "version": "kibana",
+    "templateVersion": "1.0.0"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "kbn": "node ../../../../scripts/kbn.js",
+    "build": "rm -rf './target' && tsc"
+  },
+  "devDependencies": {
+    "typescript": "3.5.3"
+  }
+}

test/plugin_functional/plugins/core_app_status/public/application.tsx

@@ -0,0 +1,64 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import React from 'react';
+import { render, unmountComponentAtNode } from 'react-dom';
+import {
+  EuiPage,
+  EuiPageBody,
+  EuiPageContent,
+  EuiPageContentBody,
+  EuiPageContentHeader,
+  EuiPageContentHeaderSection,
+  EuiPageHeader,
+  EuiPageHeaderSection,
+  EuiTitle,
+} from '@elastic/eui';
+
+import { AppMountContext, AppMountParameters } from 'kibana/public';
+
+const AppStatusApp = () => (
+  <EuiPage>
+    <EuiPageBody data-test-subj="appStatusApp">
+      <EuiPageHeader>
+        <EuiPageHeaderSection>
+          <EuiTitle size="l">
+            <h1>Welcome to App Status Test App!</h1>
+          </EuiTitle>
+        </EuiPageHeaderSection>
+      </EuiPageHeader>
+      <EuiPageContent>
+        <EuiPageContentHeader>
+          <EuiPageContentHeaderSection>
+            <EuiTitle>
+              <h2>App Status Test App home page section title</h2>
+            </EuiTitle>
+          </EuiPageContentHeaderSection>
+        </EuiPageContentHeader>
+        <EuiPageContentBody>App Status Test App content</EuiPageContentBody>
+      </EuiPageContent>
+    </EuiPageBody>
+  </EuiPage>
+);
+
+export const renderApp = (context: AppMountContext, { element }: AppMountParameters) => {
+  render(<AppStatusApp />, element);
+
+  return () => unmountComponentAtNode(element);
+};

test/plugin_functional/plugins/core_app_status/public/index.ts

@@ -0,0 +1,24 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { PluginInitializer } from 'kibana/public';
+import { CoreAppStatusPlugin, CoreAppStatusPluginSetup, CoreAppStatusPluginStart } from './plugin';
+
+export const plugin: PluginInitializer<CoreAppStatusPluginSetup, CoreAppStatusPluginStart> = () =>
+  new CoreAppStatusPlugin();

test/plugin_functional/plugins/core_app_status/public/plugin.tsx

@@ -0,0 +1,56 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Plugin, CoreSetup, AppUpdater, AppUpdatableFields, CoreStart } from 'kibana/public';
+import { BehaviorSubject } from 'rxjs';
+
+export class CoreAppStatusPlugin
+  implements Plugin<CoreAppStatusPluginSetup, CoreAppStatusPluginStart> {
+  private appUpdater = new BehaviorSubject<AppUpdater>(() => ({}));
+
+  public setup(core: CoreSetup, deps: {}) {
+    core.application.register({
+      id: 'app_status',
+      title: 'App Status',
+      euiIconType: 'snowflake',
+      updater$: this.appUpdater,
+      async mount(context, params) {
+        const { renderApp } = await import('./application');
+        return renderApp(context, params);
+      },
+    });
+
+    return {};
+  }
+
+  public start(core: CoreStart) {
+    return {
+      setAppStatus: (status: Partial<AppUpdatableFields>) => {
+        this.appUpdater.next(() => status);
+      },
+      navigateToApp: async (appId: string) => {
+        return core.application.navigateToApp(appId);
+      },
+    };
+  }
+  public stop() {}
+}
+
+export type CoreAppStatusPluginSetup = ReturnType<CoreAppStatusPlugin['setup']>;
+export type CoreAppStatusPluginStart = ReturnType<CoreAppStatusPlugin['start']>;

test/plugin_functional/plugins/core_app_status/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./target",
+    "skipLibCheck": true
+  },
+  "include": [
+    "index.ts",
+    "public/**/*.ts",
+    "public/**/*.tsx",
+    "../../../../typings/**/*",
+  ],
+  "exclude": []
+}

test/plugin_functional/test_suites/core_plugins/application_status.ts

@@ -0,0 +1,112 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import expect from '@kbn/expect';
+import {
+  AppNavLinkStatus,
+  AppStatus,
+  AppUpdatableFields,
+} from '../../../../src/core/public/application/types';
+import { PluginFunctionalProviderContext } from '../../services';
+import { CoreAppStatusPluginStart } from '../../plugins/core_app_status/public/plugin';
+import '../../plugins/core_provider_plugin/types';
+
+// eslint-disable-next-line import/no-default-export
+export default function({ getService, getPageObjects }: PluginFunctionalProviderContext) {
+  const PageObjects = getPageObjects(['common']);
+  const browser = getService('browser');
+  const appsMenu = getService('appsMenu');
+
+  const setAppStatus = async (s: Partial<AppUpdatableFields>) => {
+    await browser.executeAsync(async (status: Partial<AppUpdatableFields>, cb: Function) => {
+      const plugin = window.__coreProvider.start.plugins
+        .core_app_status as CoreAppStatusPluginStart;
+      plugin.setAppStatus(status);
+      cb();
+    }, s);
+  };
+
+  const navigateToApp = async (i: string) => {
+    return await browser.executeAsync(async (appId, cb: Function) => {
+      // navigating in legacy mode performs a page refresh
+      // and webdriver seems to re-execute the script after the reload
+      // as it considers it didn't end on the previous session.
+      // however when testing navigation to NP app, __coreProvider is not accessible
+      // so we need to check for existence.
+      if (!window.__coreProvider) {
+        cb();
+      }
+      const plugin = window.__coreProvider.start.plugins
+        .core_app_status as CoreAppStatusPluginStart;
+      try {
+        await plugin.navigateToApp(appId);
+        cb();
+      } catch (e) {
+        cb(e.message);
+      }
+    }, i);
+  };
+
+  describe('application status management', () => {
+    beforeEach(async () => {
+      await PageObjects.common.navigateToApp('settings');
+    });
+
+    it('can change the navLink status at runtime', async () => {
+      await setAppStatus({
+        navLinkStatus: AppNavLinkStatus.disabled,
+      });
+      let link = await appsMenu.getLink('App Status');
+      expect(link).not.to.eql(undefined);
+      expect(link!.disabled).to.eql(true);
+
+      await setAppStatus({
+        navLinkStatus: AppNavLinkStatus.hidden,
+      });
+      link = await appsMenu.getLink('App Status');
+      expect(link).to.eql(undefined);
+
+      await setAppStatus({
+        navLinkStatus: AppNavLinkStatus.visible,
+        tooltip: 'Some tooltip',
+      });
+      link = await appsMenu.getLink('Some tooltip'); // the tooltip replaces the name in the selector we use.
+      expect(link).not.to.eql(undefined);
+      expect(link!.disabled).to.eql(false);
+    });
+
+    it('shows an error when navigating to an inaccessible app', async () => {
+      await setAppStatus({
+        status: AppStatus.inaccessible,
+      });
+
+      const error = await navigateToApp('app_status');
+      expect(error).to.contain('Trying to navigate to an inaccessible application: app_status');
+    });
+
+    it('allows to navigate to an accessible app', async () => {
+      await setAppStatus({
+        status: AppStatus.accessible,
+      });
+
+      const error = await navigateToApp('app_status');
+      expect(error).to.eql(null);
+    });
+  });
+}

test/plugin_functional/test_suites/core_plugins/index.ts

@@ -27,5 +27,6 @@ export default function({ loadTestFile }: PluginFunctionalProviderContext) {
     loadTestFile(require.resolve('./ui_plugins'));
     loadTestFile(require.resolve('./ui_settings'));
     loadTestFile(require.resolve('./top_nav'));
+    loadTestFile(require.resolve('./application_status'));
   });
 }