forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Dashboard] Fix blank panel save and display issue. (elastic#120815)
* Added special case to panel comparison. * Fixed panel title behaviour when linking/unlinking to/from the library. * Added panel title test suite. * Made the injection of the 'savedSearchId' key conditional on if it is defined when unlinking. * Adjusted use of 'setValue()' based on feedback from @dmlemeshko * Refractor test suite. * Improved code for removal of title on library link.
- Loading branch information
Showing
9 changed files
with
247 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import expect from '@kbn/expect'; | ||
| import { FtrProviderContext } from '../../ftr_provider_context'; | ||
|
|
||
| export default function ({ getService, getPageObjects }: FtrProviderContext) { | ||
| const esArchiver = getService('esArchiver'); | ||
| const kibanaServer = getService('kibanaServer'); | ||
| const testSubjects = getService('testSubjects'); | ||
| const retry = getService('retry'); | ||
| const dashboardPanelActions = getService('dashboardPanelActions'); | ||
| const PageObjects = getPageObjects([ | ||
| 'common', | ||
| 'dashboard', | ||
| 'visualize', | ||
| 'visEditor', | ||
| 'timePicker', | ||
| 'lens', | ||
| ]); | ||
|
|
||
| const DASHBOARD_NAME = 'Panel Title Test'; | ||
| const CUSTOM_TITLE = 'Test Custom Title'; | ||
| const EMPTY_TITLE = '[No Title]'; | ||
| const LIBRARY_TITLE_FOR_CUSTOM_TESTS = 'Library Title for Custom Title Tests'; | ||
| const LIBRARY_TITLE_FOR_EMPTY_TESTS = 'Library Title for Empty Title Tests'; | ||
|
|
||
| describe('panel titles', () => { | ||
| before(async () => { | ||
| await esArchiver.load('test/functional/fixtures/es_archiver/dashboard/current/kibana'); | ||
| await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/logstash_functional'); | ||
| await kibanaServer.importExport.load( | ||
| 'x-pack/test/functional/fixtures/kbn_archiver/lens/lens_basic.json' | ||
| ); | ||
| await PageObjects.common.navigateToApp('dashboard'); | ||
| await PageObjects.dashboard.preserveCrossAppState(); | ||
| await PageObjects.dashboard.clickNewDashboard(); | ||
| await PageObjects.dashboard.saveDashboard(DASHBOARD_NAME); | ||
| }); | ||
|
|
||
| describe('panel titles - by value', () => { | ||
| const clearUnsavedChanges = async () => { | ||
| await retry.try(async () => { | ||
| // avoid flaky test by surrounding in retry | ||
| await testSubjects.existOrFail('dashboardUnsavedChangesBadge'); | ||
| await PageObjects.dashboard.clickQuickSave(); | ||
| await testSubjects.missingOrFail('dashboardUnsavedChangesBadge'); | ||
| }); | ||
| }; | ||
|
|
||
| it('new panel by value has empty title', async () => { | ||
| await PageObjects.lens.createAndAddLensFromDashboard({}); | ||
| const newPanelTitle = (await PageObjects.dashboard.getPanelTitles())[0]; | ||
| expect(newPanelTitle).to.equal(EMPTY_TITLE); | ||
| }); | ||
|
|
||
| it('saving new panel with blank title clears "unsaved changes" badge', async () => { | ||
| await dashboardPanelActions.setCustomPanelTitle(''); | ||
| await clearUnsavedChanges(); | ||
| }); | ||
|
|
||
| it('custom title causes unsaved changes and saving clears it', async () => { | ||
| await dashboardPanelActions.setCustomPanelTitle(CUSTOM_TITLE); | ||
| const panelTitle = (await PageObjects.dashboard.getPanelTitles())[0]; | ||
| expect(panelTitle).to.equal(CUSTOM_TITLE); | ||
| await clearUnsavedChanges(); | ||
| }); | ||
|
|
||
| it('resetting title on a by value panel sets it to the empty string', async () => { | ||
| const BY_VALUE_TITLE = 'Reset Title - By Value'; | ||
| await dashboardPanelActions.setCustomPanelTitle(BY_VALUE_TITLE); | ||
|
|
||
| await dashboardPanelActions.resetCustomPanelTitle(); | ||
| const panelTitle = (await PageObjects.dashboard.getPanelTitles())[0]; | ||
| expect(panelTitle).to.equal(EMPTY_TITLE); | ||
| await clearUnsavedChanges(); | ||
| }); | ||
|
|
||
| it('blank titles are hidden in view mode', async () => { | ||
| await PageObjects.dashboard.clickCancelOutOfEditMode(); | ||
|
|
||
| const titleVisibility = (await PageObjects.dashboard.getVisibilityOfPanelTitles())[0]; | ||
| expect(titleVisibility).to.be(false); | ||
| }); | ||
|
|
||
| it('custom titles are visible in view mode', async () => { | ||
| await PageObjects.dashboard.switchToEditMode(); | ||
| await dashboardPanelActions.setCustomPanelTitle(CUSTOM_TITLE); | ||
| await PageObjects.dashboard.clickQuickSave(); | ||
| await PageObjects.dashboard.clickCancelOutOfEditMode(); | ||
|
|
||
| const titleVisibility = (await PageObjects.dashboard.getVisibilityOfPanelTitles())[0]; | ||
| expect(titleVisibility).to.be(true); | ||
| }); | ||
|
|
||
| it('hiding an individual panel title hides it in view mode', async () => { | ||
| await PageObjects.dashboard.switchToEditMode(); | ||
| await dashboardPanelActions.toggleHidePanelTitle(); | ||
| await PageObjects.dashboard.clickQuickSave(); | ||
| await PageObjects.dashboard.clickCancelOutOfEditMode(); | ||
|
|
||
| const titleVisibility = (await PageObjects.dashboard.getVisibilityOfPanelTitles())[0]; | ||
| expect(titleVisibility).to.be(false); | ||
|
|
||
| // undo the previous hide panel toggle (i.e. make the panel visible) to keep state consistent | ||
| await PageObjects.dashboard.switchToEditMode(); | ||
| await dashboardPanelActions.toggleHidePanelTitle(); | ||
| await PageObjects.dashboard.clickQuickSave(); | ||
| }); | ||
| }); | ||
|
|
||
| describe('panel titles - by reference', () => { | ||
| it('linking a by value panel with a custom title to the library will overwrite the custom title with the library title', async () => { | ||
| await dashboardPanelActions.setCustomPanelTitle(CUSTOM_TITLE); | ||
| await dashboardPanelActions.saveToLibrary(LIBRARY_TITLE_FOR_CUSTOM_TESTS); | ||
| await retry.try(async () => { | ||
| // need to surround in 'retry' due to delays in HTML updates causing the title read to be behind | ||
| const newPanelTitle = (await PageObjects.dashboard.getPanelTitles())[0]; | ||
| expect(newPanelTitle).to.equal(LIBRARY_TITLE_FOR_CUSTOM_TESTS); | ||
| }); | ||
| }); | ||
|
|
||
| it('resetting title on a by reference panel sets it to the library title', async () => { | ||
| await dashboardPanelActions.setCustomPanelTitle('This should go away'); | ||
| await dashboardPanelActions.resetCustomPanelTitle(); | ||
| const resetPanelTitle = (await PageObjects.dashboard.getPanelTitles())[0]; | ||
| expect(resetPanelTitle).to.equal(LIBRARY_TITLE_FOR_CUSTOM_TESTS); | ||
| }); | ||
|
|
||
| it('unlinking a by reference panel with a custom title will keep the current title', async () => { | ||
| await dashboardPanelActions.setCustomPanelTitle(CUSTOM_TITLE); | ||
| await dashboardPanelActions.unlinkFromLibary(); | ||
| const newPanelTitle = (await PageObjects.dashboard.getPanelTitles())[0]; | ||
| expect(newPanelTitle).to.equal(CUSTOM_TITLE); | ||
| }); | ||
|
|
||
| it("linking a by value panel with a blank title to the library will set the panel's title to the library title", async () => { | ||
| await dashboardPanelActions.setCustomPanelTitle(''); | ||
| await dashboardPanelActions.saveToLibrary(LIBRARY_TITLE_FOR_EMPTY_TESTS); | ||
| await retry.try(async () => { | ||
| // need to surround in 'retry' due to delays in HTML updates causing the title read to be behind | ||
| const newPanelTitle = (await PageObjects.dashboard.getPanelTitles())[0]; | ||
| expect(newPanelTitle).to.equal(LIBRARY_TITLE_FOR_EMPTY_TESTS); | ||
| }); | ||
| }); | ||
|
|
||
| it('unlinking a by reference panel without a custom title will keep the library title', async () => { | ||
| await dashboardPanelActions.unlinkFromLibary(); | ||
| const newPanelTitle = (await PageObjects.dashboard.getPanelTitles())[0]; | ||
| expect(newPanelTitle).to.equal(LIBRARY_TITLE_FOR_EMPTY_TESTS); | ||
| }); | ||
| }); | ||
| }); | ||
| } |