Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[application_deep_links] Unify / improve navigation between apps #170228

Merged
merged 1 commit into from
Nov 2, 2023
Merged

[application_deep_links] Unify / improve navigation between apps #170228

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 27 additions & 24 deletions test/plugin_functional/test_suites/core_plugins/application_deep_links.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,24 @@

import url from 'url';
import expect from '@kbn/expect';
import { PluginFunctionalProviderContext } from '../../services';
import type { PluginFunctionalProviderContext } from '../../services';

export default function ({ getService, getPageObjects }: PluginFunctionalProviderContext) {
const PageObjects = getPageObjects(['common']);

const browser = getService('browser');
const appsMenu = getService('appsMenu');
const testSubjects = getService('testSubjects');
const retry = getService('retry');
const esArchiver = getService('esArchiver');
const log = getService('log');

const loadingScreenNotShown = async () =>
expect(await testSubjects.exists('kbnLoadingMessage')).to.be(false);
const clickAppLink = async (app: string) => {
const appLink = `dlNav${app}`;
if (!(await testSubjects.exists(appLink))) {
log.debug(`App ${app} not found on side nav`);
}
await testSubjects.click(appLink);
};
Comment on lines +22 to +28
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super cool! I'd be great to have this in the helpers.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is custom to the deep links apps (note the dlNav), but perhaps we can generalise it somehow.
In fact, I have a few more improvements in the pipes for other tests in the test_suites/core_plugins. Stay tunned!


const getKibanaUrl = (pathname?: string, search?: string) =>
url.format({
Expand All @@ -42,65 +46,64 @@ export default function ({ getService, getPageObjects }: PluginFunctionalProvide
});
};

const navigateToAppLinks = async (subject: string) => {
if (!(await testSubjects.exists(subject))) {
log.debug(`side nav in app not in DOM`);
}
await testSubjects.click(subject);
const loadingScreenNotShown = async () =>
expect(await testSubjects.exists('kbnLoadingMessage')).to.be(false);

const checkAppVisible = async (app: string) => {
const appContainer = `dlApp${app}`;
await testSubjects.existOrFail(appContainer);
};

// FLAKY: https://github.com/elastic/kibana/issues/166893
describe.skip('application deep links navigation', function describeDeepLinksTests() {
describe('application deep links navigation', function describeDeepLinksTests() {
before(async () => {
await esArchiver.emptyKibanaIndex();
await PageObjects.common.navigateToApp('dl');
});

it('should start on home page', async () => {
await testSubjects.existOrFail('dlAppHome');
await checkAppVisible('Home');
});

it('should navigate to page A when navlink is clicked', async () => {
await navigateToAppLinks('dlNavPageA');
await clickAppLink('PageA');
await waitForUrlToBe('/app/dl/page-a');
await loadingScreenNotShown();
await testSubjects.existOrFail('dlNavPageA');
await checkAppVisible('PageA');
});

it('should be able to use the back button to navigate back to previous deep link', async () => {
await browser.goBack();
await waitForUrlToBe('/app/dl/home');
await loadingScreenNotShown();
await testSubjects.existOrFail('dlNavHome');
await checkAppVisible('Home');
});

it('should navigate to nested page B when navlink is clicked', async () => {
await navigateToAppLinks('dlNavDeepPageB');
await clickAppLink('DeepPageB');
await waitForUrlToBe('/app/dl/page-b');
await loadingScreenNotShown();
await testSubjects.existOrFail('dlNavDeepPageB');
await checkAppVisible('PageB');
});

it('should navigate to Home when navlink is clicked inside the defined category group', async () => {
await appsMenu.clickLink('DL Home', { category: 'securitySolution' });
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the previous/old navigation logic that should have been removed.
I believe this is the source of the new / reoccurring flakiness.

await navigateToAppLinks('dlAppHome');
await clickAppLink('Home');
await waitForUrlToBe('/app/dl/home');
await loadingScreenNotShown();
await testSubjects.existOrFail('dlAppHome');
await checkAppVisible('Home');
});

it('should navigate to nested page B using navigateToApp path', async () => {
await testSubjects.click('dlNavDeepPageB');
await clickAppLink('DeepPageB');
await waitForUrlToBe('/app/dl/page-b');
await loadingScreenNotShown();
await testSubjects.existOrFail('dlNavDeepPageB');
await checkAppVisible('PageB');
});

it('should navigate to nested page A using navigateToApp deepLinkId', async () => {
await testSubjects.click('dlNavDeepPageAById');
await clickAppLink('DeepPageAById');
await waitForUrlToBe('/app/dl/page-a');
await loadingScreenNotShown();
await testSubjects.existOrFail('dlNavPageA');
await checkAppVisible('PageA');
});

it('should not display hidden deep links', async () => {
Expand Down
Loading