Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 2.x] Move DatasetSelector from data plugin queryString comp to DataExplorer #8639

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/plugins/data/public/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ import {
} from '../common';

import { FilterLabel } from './ui';
export { createEditor, DefaultInput, DQLBody, SingleLineInput } from './ui';
export { createEditor, DefaultInput, DQLBody, SingleLineInput, DatasetSelector } from './ui';

import {
generateFilters,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,15 @@ export const DatasetSelector = ({
return (
<EuiPopover
button={
<EuiToolTip content={`${selectedDataset?.title ?? 'Select data'}`}>
<EuiToolTip
display="block"
content={`${
selectedDataset?.title ??
i18n.translate('data.dataSelector.defaultTitle', {
defaultMessage: 'Select data',
})
}`}
>
<EuiSmallButtonEmpty
className="datasetSelector__button"
iconType="arrowDown"
Expand Down
23 changes: 21 additions & 2 deletions src/plugins/data/public/ui/dataset_selector/index.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import React from 'react';
import { mount } from 'enzyme';
import { act } from 'react-dom/test-utils';
import { DatasetSelector as ConnectedDatasetSelector } from './index';
import { DatasetSelector } from './dataset_selector';
import { useOpenSearchDashboards } from '../../../../opensearch_dashboards_react/public';
Expand All @@ -19,6 +20,8 @@ jest.mock('./dataset_selector', () => ({
}));

describe('ConnectedDatasetSelector', () => {
const mockSubscribe = jest.fn();
const mockUnsubscribe = jest.fn();
const mockQueryString = {
getQuery: jest.fn().mockReturnValue({}),
getDefaultQuery: jest.fn().mockReturnValue({}),
Expand All @@ -27,19 +30,22 @@ describe('ConnectedDatasetSelector', () => {
getDatasetService: jest.fn().mockReturnValue({
addRecentDataset: jest.fn(),
}),
getUpdates$: jest.fn().mockReturnValue({
subscribe: mockSubscribe.mockReturnValue({ unsubscribe: mockUnsubscribe }),
}),
};
const mockOnSubmit = jest.fn();
const mockServices = {
data: {
query: {
// @ts-ignore
queryString: mockQueryString,
},
},
};

beforeEach(() => {
(useOpenSearchDashboards as jest.Mock).mockReturnValue({ services: mockServices });
jest.clearAllMocks();
});

it('should render DatasetSelector with correct props', () => {
Expand All @@ -66,10 +72,23 @@ describe('ConnectedDatasetSelector', () => {
) => void;

const newDataset: Dataset = { id: 'test', title: 'Test Dataset', type: 'test' };
setSelectedDataset(newDataset);
act(() => {
setSelectedDataset(newDataset);
});

expect(mockQueryString.getInitialQueryByDataset).toHaveBeenCalledTimes(1);
expect(mockQueryString.setQuery).toHaveBeenCalledTimes(1);
expect(mockOnSubmit).toHaveBeenCalledTimes(1);
});

it('should subscribe to queryString.getUpdates$ and unsubscribe on unmount', () => {
const wrapper = mount(<ConnectedDatasetSelector onSubmit={mockOnSubmit} />);

expect(mockQueryString.getUpdates$).toHaveBeenCalledTimes(1);
expect(mockSubscribe).toHaveBeenCalledTimes(1);

wrapper.unmount();

expect(mockUnsubscribe).toHaveBeenCalledTimes(1);
});
});
12 changes: 11 additions & 1 deletion src/plugins/data/public/ui/dataset_selector/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* SPDX-License-Identifier: Apache-2.0
*/

import { useCallback, useState } from 'react';
import { useCallback, useState, useEffect } from 'react';
import React from 'react';
import { Dataset, Query, TimeRange } from '../../../common';
import { DatasetSelector } from './dataset_selector';
Expand All @@ -21,6 +21,16 @@
() => queryString.getQuery().dataset || queryString.getDefaultQuery().dataset
);

useEffect(() => {
const subscription = queryString.getUpdates$().subscribe((query) => {
setSelectedDataset(query.dataset);

Check warning on line 26 in src/plugins/data/public/ui/dataset_selector/index.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/data/public/ui/dataset_selector/index.tsx#L26

Added line #L26 was not covered by tests
});

return () => {
subscription.unsubscribe();
};
}, [queryString]);

const handleDatasetChange = useCallback(
(dataset?: Dataset) => {
setSelectedDataset(dataset);
Expand Down
1 change: 1 addition & 0 deletions src/plugins/data/public/ui/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,4 @@ export {
useQueryStringManager,
} from './search_bar';
export { SuggestionsComponent } from './typeahead';
export { DatasetSelector } from './dataset_selector';
5 changes: 2 additions & 3 deletions src/plugins/data/public/ui/query_editor/_query_editor.scss
Original file line number Diff line number Diff line change
Expand Up @@ -143,16 +143,15 @@
.osdQueryEditor__topBar {
display: flex;
align-items: center;
padding: $euiSizeS;
gap: $euiSizeXS;

> * {
flex: 0 1 auto;
min-width: 0;
}

.osdQueryEditor__querycontrols {
float: right;
margin: $euiSizeS $euiSizeS;

.osdQueryEditor__extensionQueryControls {
display: flex;
padding: 0 $euiSizeS 0 $euiSizeXS;
Expand Down
2 changes: 0 additions & 2 deletions src/plugins/data/public/ui/query_editor/query_editor.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ import { SuggestionsListSize } from '../typeahead/suggestions_component';
import { QueryLanguageSelector } from './language_selector';
import { QueryEditorExtensions } from './query_editor_extensions';
import { getQueryService, getIndexPatterns } from '../../services';
import { DatasetSelector } from '../dataset_selector';
import { DefaultInputProps } from './editors';
import { MonacoCompatibleQuerySuggestion } from '../../autocomplete/providers/query_suggestion_provider';

Expand Down Expand Up @@ -446,7 +445,6 @@ export default class QueryEditorUI extends Component<Props, State> {
className={classNames('osdQueryEditor__banner', this.props.bannerClassName)}
/>
<div className="osdQueryEditor__topBar">
<DatasetSelector onSubmit={this.props.onSubmit} />
<div className="osdQueryEditor__input">
{this.state.isCollapsed
? languageEditor.TopBar.Collapsed()
Expand Down
10 changes: 2 additions & 8 deletions src/plugins/data_explorer/public/components/app_container.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* SPDX-License-Identifier: Apache-2.0
*/

import React, { memo, useEffect, useRef } from 'react';
import React, { memo, useRef } from 'react';
import {
EuiFlexGroup,
EuiFlexItem,
Expand All @@ -23,13 +23,7 @@ import './app_container.scss';
import { useOpenSearchDashboards } from '../../../opensearch_dashboards_react/public';
import { IDataPluginServices } from '../../../data/public';
import { QUERY_ENHANCEMENT_ENABLED_SETTING } from './constants';
import {
DISCOVER_LOAD_EVENT,
NEW_DISCOVER_LOAD_EVENT,
NEW_DISCOVER_OPT_IN,
NEW_DISCOVER_OPT_OUT,
trackUiMetric,
} from '../ui_metric';
import { DISCOVER_LOAD_EVENT, NEW_DISCOVER_LOAD_EVENT, trackUiMetric } from '../ui_metric';

export const AppContainer = React.memo(
({ view, params }: { view?: View; params: AppMountParameters }) => {
Expand Down
32 changes: 22 additions & 10 deletions src/plugins/data_explorer/public/components/sidebar/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
DataSourceSelectable,
UI_SETTINGS,
} from '../../../../data/public';
import { DataSourceOption } from '../../../../data/public/';
import { DataSourceOption, DatasetSelector } from '../../../../data/public/';
import { useOpenSearchDashboards } from '../../../../opensearch_dashboards_react/public';
import { DataExplorerServices } from '../../types';
import { setIndexPattern, useTypedDispatch, useTypedSelector } from '../../utils/state_management';
Expand All @@ -34,6 +34,16 @@
},
} = useOpenSearchDashboards<DataExplorerServices>();

const handleDatasetSubmit = useCallback(
(query: any) => {
// Update the index pattern
if (query.dataset) {
dispatch(setIndexPattern(query.dataset.id));

Check warning on line 41 in src/plugins/data_explorer/public/components/sidebar/index.tsx

View check run for this annotation

Codecov / codecov/patch

src/plugins/data_explorer/public/components/sidebar/index.tsx#L41

Added line #L41 was not covered by tests
}
},
[dispatch]
);

const [isEnhancementEnabled, setIsEnhancementEnabled] = useState<boolean>(false);

useEffect(() => {
Expand Down Expand Up @@ -122,13 +132,15 @@
borderRadius="none"
color="transparent"
>
{!isEnhancementEnabled && (
<EuiSplitPanel.Inner
paddingSize="s"
grow={false}
color="transparent"
className="deSidebar_dataSource"
>
<EuiSplitPanel.Inner
paddingSize="s"
grow={false}
color="transparent"
className="deSidebar_dataSource"
>
{isEnhancementEnabled ? (
<DatasetSelector onSubmit={handleDatasetSubmit} />
) : (
<DataSourceSelectable
dataSources={activeDataSources}
dataSourceOptionList={dataSourceOptionList}
Expand All @@ -139,8 +151,8 @@
onRefresh={memorizedReload}
fullWidth
/>
</EuiSplitPanel.Inner>
)}
)}
</EuiSplitPanel.Inner>
<EuiSplitPanel.Inner paddingSize="none" color="transparent" className="eui-yScroll">
{children}
</EuiSplitPanel.Inner>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@
* under the License.
*/

import { difference } from 'lodash';
import { IndexPattern, IndexPatternField } from 'src/plugins/data/public';
import { IndexPattern } from 'src/plugins/data/public';

export function getIndexPatternFieldList(
indexPattern?: IndexPattern,
Expand Down
Loading