Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Dashboard] Fix "Unlink from library" panel title bug (#156589)
Closes #156539 Closes #156544 ## Summary As part of investigating the attached flaky test suite, I realized that the flakiness was because we weren't waiting long enough for a panel to be added and/or removed from the library - so, I added a check to ensure the library notification appears in `saveToLibrary`, and similarly I added a check to ensure that the library notification **disappears** in `unlinkFromLibary`. However, after adding these extra checks, the following test started to fail: https://github.com/elastic/kibana/blob/23a45bde21b36be49a1174b9bde1fc340de67534/x-pack/test/functional/apps/dashboard/group2/panel_titles.ts#L148-L155 Way, way, way back in `8.1`, one of my [first PRs](#120815) was meant to fix some problems with dashboard panel titles - as part of this, I was **supposed** to make sure that, if a by-reference panel is given a custom panel title, the title should remain the same after unlinking (i.e. it should remain as the custom title rather than resetting to the by-reference title). So, I added the above test to verify this behaviour. Turns out, though, that this test had a flaw - because we weren't waiting long enough for the panel to actually be disconnected from the library, this test was only passing because it was grabbing and comparing titles **before** the unlink was complete - so, even though the title actually **was** being reset back to the original library title, this test did not catch this bug. This has been the case since `8.1` when this test was introduced - not sure how it was missed, but we never actually fixed the bug where dashboard panel titles are getting reset when unlinking from the library. So, this PR actually accomplishes two things: 1) It fixes the flakiness of the attached tests by adding the extra library notification checks: <a href="https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/2217"><img src="https://user-images.githubusercontent.com/8698078/236044233-8a07aadc-8a55-40f2-9ed2-798a91501f68.png"/></a> 2) It ensures that, if a by-reference panel has a custom title, unlinking it from the library will not impact that title. ### Before https://user-images.githubusercontent.com/8698078/236062484-b1cedc47-cb19-4273-aec7-17d24b55953b.mov ### After https://user-images.githubusercontent.com/8698078/236062862-aace4f09-d007-401a-ba57-b9b74fda0b33.mov ### Checklist - [x] [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 - [x] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### 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)
- Loading branch information