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

[Log Explorer] Fix broken data grid on columns update (#165679)

Browse source 
## 📓  Summary

Closes #165558 

The issue was caused by a particular condition caused by the overridden
`data` service that the plugin injects in the Discover App.
Reverse engineering from the blank screen when updating the columns:
1. The `DiscoverHistogramLayout` is rendered conditionally only [when a
`searchSessionId`
exists](https://github.com/elastic/kibana/blob/main/src/plugins/discover/public/application/main/components/layout/discover_histogram_layout.tsx#L47).
2. The `searchSessionId` is initialized with a default value and exists
until [the `data.search.session.clear()` function is
invoked](https://github.com/elastic/kibana/blob/main/src/plugins/discover/public/application/main/discover_main_app.tsx#L82).
3. Being this effect cleanup callback is invoked when
`data.search.session` changes in its reference, the issue is caused by
the [injected
service](https://github.com/elastic/kibana/blob/main/x-pack/plugins/log_explorer/public/components/log_explorer/log_explorer.tsx#L52-L62).
4. The root cause is that each time a property is read from the proxied
`data` service, new nested Proxies are created, triggering the useEffect
cleanup function since the new Proxy has a new reference.

The implemented solution adds an enhanced version of
`createPropertyGetProxy` that keeps the created proxy as a singleton,
storing the original value in a cache by a passed key.

---------

Co-authored-by: Marco Antonio Ghiani <marcoantonio.ghiani@elastic.co>
This commit is contained in:
Marco Antonio Ghiani 2023-09-06 10:46:13 +02:00 • committed by GitHub
parent 1b0c095ad3
commit 55936a83a1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

20
x-pack/plugins/log_explorer/public/components/log_explorer/log_explorer.tsx
View file

@ -6,7 +6,7 @@
*/
import { ScopedHistory } from '@kbn/core-application-browser';
import { DataPublicPluginStart, ISearchStart, ISessionService } from '@kbn/data-plugin/public';
import { DataPublicPluginStart } from '@kbn/data-plugin/public';
import { DiscoverStart } from '@kbn/discover-plugin/public';
import React from 'react';
import {
@ -50,13 +50,17 @@ export const createLogExplorer = ({
* are no-ops.
*/
const createDataServiceProxy = (data: DataPublicPluginStart) => {
const noOpEnableStorage = () => {};
const sessionServiceProxy = createPropertyGetProxy(data.search.session, {
enableStorage: () => noOpEnableStorage,
});
const searchServiceProxy = createPropertyGetProxy(data.search, {
session: () => sessionServiceProxy,
});
return createPropertyGetProxy(data, {
search: (searchService: ISearchStart) =>
createPropertyGetProxy(searchService, {
session: (sessionService: ISessionService) =>
createPropertyGetProxy(sessionService, {
enableStorage: () => () => {},
}),
}),
search: () => searchServiceProxy,
});
};