github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Canvas] Fix flaky test failures when navigating to Canvas app (#164376)

Browse source 
## Summary

Closes https://github.com/elastic/kibana/issues/163303.
Closes https://github.com/elastic/kibana/issues/163368.
Closes #163903.

This fixes a rarely occurring flaky test failure while navigating to the
Canvas app where the `currentURL` check fails. The cause is
`navigateToApp` goes to `app/canvas#/` which includes a hash get
redirected by the Canvas app to `app/canvas/`, and fails when
`app/canvas/` doesn't match `app/canvas#/`. I've chosen to disable this
check when navigating to Canvas to avoid this flakiness because I
couldn't remove the hash from the URL while using `navigateToApp` or
`navigateToURL`.

Instead of checking the URLs match, I opted to check that the workpad
listing page loaded correctly.

### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
This commit is contained in:
Catherine Liu 2023-09-19 13:10:36 -07:00 • committed by GitHub
parent dc34810aff
commit 94587c9a13
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 87 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

8
test/functional/page_objects/common_page.ts
View file

@ -243,6 +243,14 @@ export class CommonPageObject extends FtrService {
} = {}
) {
let appUrl: string;
// See https://github.com/elastic/kibana/pull/164376
if (appName === 'canvas' && !path) {
throw new Error(
'This causes flaky test failures. Use Canvas page object goToListingPage instead'
);
}
if (this.config.has(['apps', appName])) {
// Legacy applications
const appConfig = this.config.get(['apps', appName]);

1
x-pack/plugins/canvas/public/components/home/home.component.tsx
View file

@ -35,6 +35,7 @@ export const Home = ({ activeTab = 'workpads' }: Props) => {
{
label: strings.getMyWorkpadsTabLabel(),
id: 'myWorkpads',
'data-test-subj': 'workpadListing',
isSelected: tab === 'workpads',
onClick: () => setTab('workpads'),
},

4
x-pack/test/accessibility/apps/canvas.ts
View file

@ -12,12 +12,12 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
const testSubjects = getService('testSubjects');
const esArchiver = getService('esArchiver');
const retry = getService('retry');
const { common } = getPageObjects(['common']);
const { canvas } = getPageObjects(['canvas']);
describe('Canvas Accessibility', () => {
before(async () => {
await esArchiver.load('x-pack/test/functional/es_archives/canvas/default');
await common.navigateToApp('canvas');
await canvas.goToListingPage();
});
it('loads workpads', async function () {

9
x-pack/test/functional/apps/canvas/custom_elements.ts
View file

@ -16,7 +16,7 @@ export default function canvasCustomElementTest({
const testSubjects = getService('testSubjects');
const browser = getService('browser');
const retry = getService('retry');
const PageObjects = getPageObjects(['canvas', 'common']);
const PageObjects = getPageObjects(['canvas']);
const find = getService('find');
const kibanaServer = getService('kibanaServer');
const archive = 'x-pack/test/functional/fixtures/kbn_archiver/canvas/default';
@ -26,12 +26,9 @@ export default function canvasCustomElementTest({
before(async () => {
await kibanaServer.importExport.load(archive);
// open canvas home
await PageObjects.common.navigateToApp('canvas');
// load test workpad
await PageObjects.common.navigateToApp('canvas', {
hash: '/workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31/page/1',
});
await PageObjects.canvas.goToListingPage();
await PageObjects.canvas.loadFirstWorkpad('Test Workpad');
});
after(async () => {

4
x-pack/test/functional/apps/canvas/datasource.ts
View file

@ -11,7 +11,7 @@ import { FtrProviderContext } from '../../ftr_provider_context';
export default function canvasExpressionTest({ getService, getPageObjects }: FtrProviderContext) {
const testSubjects = getService('testSubjects');
const PageObjects = getPageObjects(['canvas', 'common']);
const PageObjects = getPageObjects(['canvas']);
const esArchiver = getService('esArchiver');
const kibanaServer = getService('kibanaServer');
const monacoEditor = getService('monacoEditor');
@ -35,7 +35,7 @@ export default function canvasExpressionTest({ getService, getPageObjects }: Ftr
});
// create new test workpad
await PageObjects.common.navigateToApp('canvas');
await PageObjects.canvas.goToListingPage();
await PageObjects.canvas.createNewWorkpad();
});

9
x-pack/test/functional/apps/canvas/embeddables/lens.ts
View file

@ -8,7 +8,7 @@
import { FtrProviderContext } from '../../../ftr_provider_context';
export default function canvasLensTest({ getService, getPageObjects }: FtrProviderContext) {
const PageObjects = getPageObjects(['canvas', 'common', 'header', 'lens']);
const PageObjects = getPageObjects(['canvas', 'header', 'lens']);
const esArchiver = getService('esArchiver');
const dashboardAddPanel = getService('dashboardAddPanel');
const dashboardPanelActions = getService('dashboardPanelActions');
@ -25,7 +25,7 @@ export default function canvasLensTest({ getService, getPageObjects }: FtrProvid
await kibanaServer.savedObjects.cleanStandardList();
await kibanaServer.importExport.load(archives.kbn);
await kibanaServer.uiSettings.replace({ defaultIndex: 'logstash-lens' });
await PageObjects.common.navigateToApp('canvas');
await PageObjects.canvas.goToListingPage();
await PageObjects.canvas.createNewWorkpad();
});
@ -49,9 +49,8 @@ export default function canvasLensTest({ getService, getPageObjects }: FtrProvid
it('renders lens visualization using savedLens expression', async () => {
// load test workpad
await PageObjects.common.navigateToApp('canvas', {
hash: '/workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31/page/1',
});
await PageObjects.canvas.goToListingPage();
await PageObjects.canvas.loadFirstWorkpad('Test Workpad');
await PageObjects.header.waitUntilLoadingHasFinished();
await PageObjects.lens.assertLegacyMetric('Maximum of bytes', '16,788');

4
x-pack/test/functional/apps/canvas/embeddables/maps.ts
View file

@ -9,7 +9,7 @@ import expect from '@kbn/expect';
import { FtrProviderContext } from '../../../ftr_provider_context';
export default function ({ getService, getPageObjects }: FtrProviderContext) {
const PageObjects = getPageObjects(['canvas', 'common', 'header', 'maps']);
const PageObjects = getPageObjects(['canvas', 'header', 'maps']);
const dashboardPanelActions = getService('dashboardPanelActions');
const dashboardAddPanel = getService('dashboardAddPanel');
const testSubjects = getService('testSubjects');
@ -19,7 +19,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
before(async () => {
await kibanaServer.savedObjects.cleanStandardList();
// open canvas home
await PageObjects.common.navigateToApp('canvas');
await PageObjects.canvas.goToListingPage();
// create new workpad
await PageObjects.canvas.createNewWorkpad();
await PageObjects.canvas.setWorkpadName('maps tests');

6
x-pack/test/functional/apps/canvas/embeddables/saved_search.ts
View file

@ -8,7 +8,7 @@
import { FtrProviderContext } from '../../../ftr_provider_context';
export default function ({ getService, getPageObjects }: FtrProviderContext) {
const PageObjects = getPageObjects(['canvas', 'common', 'header', 'discover']);
const PageObjects = getPageObjects(['canvas', 'header', 'discover']);
const testSubjects = getService('testSubjects');
const kibanaServer = getService('kibanaServer');
const dashboardAddPanel = getService('dashboardAddPanel');
@ -21,7 +21,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
'test/functional/fixtures/kbn_archiver/dashboard/current/kibana'
);
// open canvas home
await PageObjects.common.navigateToApp('canvas');
await PageObjects.canvas.goToListingPage();
// create new workpad
await PageObjects.canvas.createNewWorkpad();
await PageObjects.canvas.setWorkpadName('saved search tests');
@ -41,7 +41,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
it('edits saved search by-reference embeddable', async () => {
await dashboardPanelActions.editPanelByTitle('Rendering Test: saved search');
await PageObjects.discover.saveSearch('Rendering Test: saved search v2');
await PageObjects.common.navigateToApp('canvas');
await PageObjects.canvas.goToListingPage();
await PageObjects.canvas.loadFirstWorkpad('saved search tests');
await testSubjects.existOrFail('embeddablePanelHeading-RenderingTest:savedsearchv2');
});

4
x-pack/test/functional/apps/canvas/embeddables/visualization.ts
View file

@ -10,7 +10,7 @@ import { FtrProviderContext } from '../../../ftr_provider_context';
export default function ({ getService, getPageObjects }: FtrProviderContext) {
const retry = getService('retry');
const PageObjects = getPageObjects(['canvas', 'common', 'header', 'visualize']);
const PageObjects = getPageObjects(['canvas', 'header', 'visualize']);
const kibanaServer = getService('kibanaServer');
const testSubjects = getService('testSubjects');
const dashboardAddPanel = getService('dashboardAddPanel');
@ -30,7 +30,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
);
// open canvas home
await PageObjects.common.navigateToApp('canvas');
await PageObjects.canvas.goToListingPage();
// create new workpad
await PageObjects.canvas.createNewWorkpad();
await PageObjects.canvas.setWorkpadName('visualization tests');

7
x-pack/test/functional/apps/canvas/expression.ts
View file

@ -15,7 +15,7 @@ export default function canvasExpressionTest({ getService, getPageObjects }: Ftr
const find = getService('find');
const kibanaServer = getService('kibanaServer');
const monacoEditor = getService('monacoEditor');
const PageObjects = getPageObjects(['canvas', 'common']);
const PageObjects = getPageObjects(['canvas']);
const retry = getService('retry');
const testSubjects = getService('testSubjects');
@ -27,9 +27,8 @@ export default function canvasExpressionTest({ getService, getPageObjects }: Ftr
await kibanaServer.importExport.load(archive);
// load test workpad
await PageObjects.common.navigateToApp('canvas', {
hash: '/workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31/page/1',
});
await PageObjects.canvas.goToListingPage();
await PageObjects.canvas.loadFirstWorkpad('Test Workpad');
});
after(async () => {

7
x-pack/test/functional/apps/canvas/filters.ts
View file

@ -12,7 +12,7 @@ import { FtrProviderContext } from '../../ftr_provider_context';
export default function canvasFiltersTest({ getService, getPageObjects }: FtrProviderContext) {
const testSubjects = getService('testSubjects');
const retry = getService('retry');
const PageObjects = getPageObjects(['canvas', 'common']);
const PageObjects = getPageObjects(['canvas']);
const find = getService('find');
const kibanaServer = getService('kibanaServer');
const archive = 'x-pack/test/functional/fixtures/kbn_archiver/canvas/filter';
@ -24,9 +24,8 @@ export default function canvasFiltersTest({ getService, getPageObjects }: FtrPro
before(async () => {
await kibanaServer.importExport.load(archive);
// load test workpad
await PageObjects.common.navigateToApp('canvas', {
hash: '/workpad/workpad-b5618217-56d2-47fa-b756-1be2306cda68/page/1',
});
await PageObjects.canvas.goToListingPage();
await PageObjects.canvas.loadFirstWorkpad('Filter Debug Workpad');
});
after(async () => {

2
x-pack/test/functional/apps/canvas/migrations_smoke_test.ts
View file

@ -9,7 +9,7 @@ import path from 'path';
import { FtrProviderContext } from '../../ftr_provider_context';
export default function ({ getPageObjects, getService }: FtrProviderContext) {
const PageObjects = getPageObjects(['common', 'settings', 'savedObjects']);
const PageObjects = getPageObjects(['settings', 'savedObjects']);
describe('migration smoke test', function () {
it('imports an 8.2 workpad', async function () {

4
x-pack/test/functional/apps/canvas/reports.ts
View file

@ -15,7 +15,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
const browser = getService('browser');
const log = getService('log');
const security = getService('security');
const PageObjects = getPageObjects(['reporting', 'common', 'canvas']);
const PageObjects = getPageObjects(['reporting', 'canvas']);
const archive = 'x-pack/test/functional/fixtures/kbn_archiver/canvas/reports';
describe('Canvas PDF Report Generation', () => {
@ -52,7 +52,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
// Generating and then comparing reports can take longer than the default 60s timeout
this.timeout(180000);
await PageObjects.common.navigateToApp('canvas');
await PageObjects.canvas.goToListingPage();
await PageObjects.canvas.loadFirstWorkpad('The Very Cool Workpad for PDF Tests');
await PageObjects.reporting.openPdfReportingPanel();

24
x-pack/test/functional/apps/canvas/saved_object_resolve.ts
View file

@ -82,10 +82,14 @@ export default function canvasFiltersTest({ getService, getPageObjects }: FtrPro
});
it('redirects an alias match', async () => {
await PageObjects.common.navigateToApp('canvas', {
basePath: '/s/custom_space',
hash: '/workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31-old-id/page/1',
});
await PageObjects.common.navigateToUrl(
'canvas',
'workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31-old-id/page/1',
{
basePath: '/s/custom_space',
shouldUseHashForSubUrl: false,
}
);
// Wait for the redirect toast
await retry.try(async () => {
@ -111,10 +115,14 @@ export default function canvasFiltersTest({ getService, getPageObjects }: FtrPro
});
it('handles a conflict match', async () => {
await PageObjects.common.navigateToApp('canvas', {
basePath: '/s/custom_space',
hash: '/workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31-conflict-old/page/1',
});
await PageObjects.common.navigateToUrl(
'canvas',
'workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31-conflict-old/page/1',
{
basePath: '/s/custom_space',
shouldUseHashForSubUrl: false,
}
);
await testSubjects.click('legacy-url-conflict-go-to-other-button');

4
x-pack/test/functional/apps/canvas/smoke_test.js
View file

@ -11,7 +11,7 @@ export default function canvasSmokeTest({ getService, getPageObjects }) {
const testSubjects = getService('testSubjects');
const browser = getService('browser');
const retry = getService('retry');
const PageObjects = getPageObjects(['common']);
const PageObjects = getPageObjects(['canvas']);
const kibanaServer = getService('kibanaServer');
const config = getService('config');
const archive = {
@ -31,7 +31,7 @@ export default function canvasSmokeTest({ getService, getPageObjects }) {
await kibanaServer.importExport.load(archive.local);
}
await PageObjects.common.navigateToApp('canvas');
await PageObjects.canvas.goToListingPage();
});
after(async () => {

5
x-pack/test/functional/apps/maps/group2/embeddable/canvas.ts
View file

@ -14,9 +14,8 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
describe('Map embeddable in canvas', () => {
before(async () => {
await PageObjects.common.navigateToApp('canvas', {
hash: '/workpad/workpad-c74f9c27-a142-4664-bf8a-69bf782fc268/page/1',
});
await PageObjects.canvas.goToListingPage();
await PageObjects.canvas.loadFirstWorkpad('Canvas with map');
});
it('should render map embeddable', async () => {

33
x-pack/test/functional/page_objects/canvas_page.ts
View file

@ -17,20 +17,36 @@ export function CanvasPageProvider({ getService, getPageObjects }: FtrProviderCo
const PageObjects = getPageObjects(['common']);
return {
async goToListingPage() {
log.debug('CanvasPage.goToListingPage');
// disabling the current url check because canvas moved away from
// hash router and redirects from /app/canvas#/ to /app/canvas/
// but navigateToUrl includes hash in the url which causes test flakiness
await PageObjects.common.navigateToUrl('canvas', '', {
ensureCurrentUrl: false,
shouldUseHashForSubUrl: false,
});
await testSubjects.existOrFail('workpadListing');
},
async enterFullscreen() {
log.debug('CanvasPage.enterFullscreen');
const elem = await find.byCssSelector('[aria-label="View fullscreen"]', 20000);
await elem.click();
},
async exitFullscreen() {
log.debug('CanvasPage.exitFullscreen');
await browser.pressKeys(browser.keys.ESCAPE);
},
async openExpressionEditor() {
log.debug('CanvasPage.openExpressionEditor');
await testSubjects.click('canvasExpressionEditorButton');
},
async waitForWorkpadElements() {
log.debug('CanvasPage.waitForWorkpadElements');
await testSubjects.findAll('canvasWorkpadPage > canvasWorkpadPageElementContent');
},
@ -40,6 +56,8 @@ export function CanvasPageProvider({ getService, getPageObjects }: FtrProviderCo
* to load the workpad. Resolves once the workpad is in the DOM
*/
async loadFirstWorkpad(workpadName: string) {
log.debug('CanvasPage.loadFirstWorkpad', workpadName);
await testSubjects.setValue('tableListSearchBox', workpadName);
const elem = await testSubjects.find('canvasWorkpadTableWorkpad');
const text = await elem.getVisibleText();
expect(text).to.be(workpadName);
@ -53,6 +71,7 @@ export function CanvasPageProvider({ getService, getPageObjects }: FtrProviderCo
},
async fillOutCustomElementForm(name: string, description: string) {
log.debug('CanvasPage.fillOutCustomElementForm', name);
// Fill out the custom element form and submit it
await testSubjects.setValue('canvasCustomElementForm-name', name, {
clearWithKeyboard: true,
@ -65,35 +84,38 @@ export function CanvasPageProvider({ getService, getPageObjects }: FtrProviderCo
},
async expectCreateWorkpadButtonEnabled() {
log.debug('CanvasPage.expectCreateWorkpadButtonEnabled');
const button = await testSubjects.find('create-workpad-button', 20000);
const disabledAttr = await button.getAttribute('disabled');
expect(disabledAttr).to.be(null);
},
async expectCreateWorkpadButtonDisabled() {
log.debug('CanvasPage.expectCreateWorkpadButtonDisabled');
const button = await testSubjects.find('create-workpad-button', 20000);
const disabledAttr = await button.getAttribute('disabled');
expect(disabledAttr).to.be('true');
},
async openAddElementMenu() {
log.debug('openAddElementsMenu');
log.debug('CanvasPage.openAddElementsMenu');
await testSubjects.click('add-element-button');
},
async openAddChartMenu() {
log.debug('openAddChartMenu');
log.debug('CanvasPage.openAddChartMenu');
await this.openAddElementMenu();
await testSubjects.click('canvasAddElementMenu__Chart');
},
async createNewDatatableElement() {
log.debug('createNewDatatableElement');
log.debug('CanvasPage.createNewDatatableElement');
await this.openAddChartMenu();
await testSubjects.click('canvasAddElementMenu__table');
},
async openSavedElementsModal() {
log.debug('CanvasPage.openSavedElementsModal');
await testSubjects.click('add-element-button');
await testSubjects.click('saved-elements-menu-option');
@ -101,14 +123,17 @@ export function CanvasPageProvider({ getService, getPageObjects }: FtrProviderCo
},
async closeSavedElementsModal() {
log.debug('CanvasPage.closeSavedElementsModal');
await testSubjects.click('saved-elements-modal-close-button');
},
async expectAddElementButton() {
log.debug('CanvasPage.expectAddElementButton');
await testSubjects.existOrFail('add-element-button');
},
async expectNoAddElementButton() {
log.debug('CanvasPage.expectNoAddElementButton');
// Ensure page is fully loaded first by waiting for the refresh button
const refreshPopoverExists = await testSubjects.exists('canvas-refresh-control', {
timeout: 20000,
@ -119,6 +144,7 @@ export function CanvasPageProvider({ getService, getPageObjects }: FtrProviderCo
},
async getTimeFiltersFromDebug() {
log.debug('CanvasPage.getTimeFiltersFromDebug');
await testSubjects.existOrFail('canvasDebug__content');
const contentElem = await testSubjects.find('canvasDebug__content');
@ -130,6 +156,7 @@ export function CanvasPageProvider({ getService, getPageObjects }: FtrProviderCo
},
async getMatchFiltersFromDebug() {
log.debug('CanvasPage.getMatchFiltersFromDebug');
await testSubjects.existOrFail('canvasDebug__content');
const contentElem = await testSubjects.find('canvasDebug__content');

2
x-pack/test/reporting_functional/services/scenarios.ts
View file

@ -70,7 +70,7 @@ export function createScenarios(
const openCanvasWorkpad = async (title: string) => {
log.debug(`Opening saved canvas workpad: ${title}`);
await PageObjects.common.navigateToApp('canvas');
await PageObjects.canvas.goToListingPage();
await PageObjects.canvas.loadFirstWorkpad(title);
};