[Lens][Embeddable] Reset removable error list on search/context update (#152489)

## Summary

Fixes #152405 

This PR tracks search/context updates and resets the "removable" error
list generated on first evaluation.
While fixing the bug I've noticed that Discover (via unified histogram)
and Dashboard update the search context with two different approaches.
The fix acts at two distinct level and I've added functional tests to
verify it is working in both scenarios.


![embeddable_error_bug](https://user-images.githubusercontent.com/924948/222221617-e12ee59b-a85f-408c-8a9d-46ad263affec.gif)


### 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:
Marco Liberati 2023-03-02 18:39:19 +01:00 committed by GitHub
parent de482cbc9e
commit 7c71786ff9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 58 additions and 10 deletions

View file

@ -270,5 +270,27 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
expect(canvasExists).to.be(false);
});
});
it('should recover from broken query search when clearing the query bar', async () => {
await PageObjects.common.navigateToApp('discover');
await PageObjects.discover.waitUntilSearchingHasFinished();
await PageObjects.timePicker.setDefaultAbsoluteRange();
// Make sure the chart is visible
await testSubjects.click('unifiedHistogramChartOptionsToggle');
await testSubjects.click('unifiedHistogramChartToggle');
await PageObjects.discover.waitUntilSearchingHasFinished();
// type an invalid search query, hit refresh
await queryBar.setQuery('this is > not valid');
await queryBar.submitQuery();
// check the error state
expect(await testSubjects.exists('embeddable-lens-failure')).to.be(true);
// now remove the query
await queryBar.clearQuery();
await queryBar.submitQuery();
await PageObjects.discover.waitUntilSearchingHasFinished();
// check no error state
expect(await PageObjects.discover.isChartVisible()).to.be(true);
});
});
}

View file

@ -504,6 +504,9 @@ export class Embeddable
this.inputReloadSubscriptions.push(
shouldFetch$<LensEmbeddableInput>(this.getUpdated$(), () => this.getInput()).subscribe(
(input) => {
// reset removable messages
// Dashboard search/context changes are detected here
this.additionalUserMessages = {};
this.onContainerStateChanged(input);
}
)
@ -588,11 +591,10 @@ export class Embeddable
})
);
const mergedSearchContext = this.getMergedSearchContext();
if (!this.savedVis) {
return userMessages;
}
const mergedSearchContext = this.getMergedSearchContext();
const frameDatasourceAPI: FrameDatasourceAPI = {
dataViews: {
@ -644,13 +646,9 @@ export class Embeddable
}
return () => {
const withMessagesRemoved = {
...this.additionalUserMessages,
};
messages.map(({ uniqueId }) => uniqueId).forEach((id) => delete withMessagesRemoved[id]);
this.additionalUserMessages = withMessagesRemoved;
messages.forEach(({ uniqueId }) => {
delete this.additionalUserMessages[uniqueId];
});
};
};
@ -1174,7 +1172,11 @@ export class Embeddable
if (!this.savedVis || !this.isInitialized || this.isDestroyed) {
return;
}
this.handleContainerStateChanged(this.input);
if (this.handleContainerStateChanged(this.input)) {
// reset removable messages
// Unified histogram search/context changes are detected here
this.additionalUserMessages = {};
}
if (this.domNode) {
this.render(this.domNode);
}

View file

@ -28,6 +28,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
const security = getService('security');
const panelActions = getService('dashboardPanelActions');
const inspector = getService('inspector');
const queryBar = getService('queryBar');
async function clickInChart(x: number, y: number) {
const el = await elasticChart.getCanvas();
@ -294,5 +295,28 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
await PageObjects.lens.removeDimension('lnsXY_xDimensionPanel');
await PageObjects.lens.expectSaveAndReturnButtonDisabled();
});
it('should recover lens panel in an error state when fixing search query', async () => {
await PageObjects.common.navigateToApp('dashboard');
await PageObjects.dashboard.clickNewDashboard();
await dashboardAddPanel.clickOpenAddPanel();
await dashboardAddPanel.filterEmbeddableNames('lnsXYvis');
await find.clickByButtonText('lnsXYvis');
await dashboardAddPanel.closeAddPanel();
await PageObjects.lens.goToTimeRange();
// type an invalid search query, hit refresh
await queryBar.setQuery('this is > not valid');
await queryBar.submitQuery();
// check the error state
await PageObjects.header.waitUntilLoadingHasFinished();
const errors = await testSubjects.findAll('embeddableStackError');
expect(errors.length).to.be(1);
// now remove the query
await queryBar.setQuery('');
await queryBar.submitQuery();
await PageObjects.header.waitUntilLoadingHasFinished();
// check the success state
await PageObjects.dashboard.verifyNoRenderErrors();
});
});
}