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

[Discover-Next] conditionally render selector #7059

Merged
merged 4 commits into from
Jun 22, 2024
Merged
Changes from 1 commit
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
Next Next commit
[Discover-Next] conditionally render selector
When selecting a specific language, the data source selector disappears and relies completely on the
query editor when enhancements are enabled.

If toggled on and then off, everything is working properly.

#7046

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
kavilla committed Jun 20, 2024

Verified

This commit was created on github.com and signed with GitHub’s verified signature.
commit 7d4432f6a7b6b616c666b212c8a44ad595e35deb
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -65,6 +65,7 @@
"start": "scripts/use_node scripts/opensearch_dashboards --dev",
"start:docker": "scripts/use_node scripts/opensearch_dashboards --dev --opensearch.hosts=$OPENSEARCH_HOSTS --opensearch.ignoreVersionMismatch=true --server.host=$SERVER_HOST",
"start:security": "scripts/use_node scripts/opensearch_dashboards --dev --security",
"start:enhancements": "scripts/use_node scripts/opensearch_dashboards --dev --data.enhancements.enabled=true --uiSettings.overrides['query:enhancements:enabled']=true --uiSettings.overrides['query:dataSource:readOnly']=false",
"debug": "scripts/use_node --nolazy --inspect scripts/opensearch_dashboards --dev",
"debug-break": "scripts/use_node --nolazy --inspect-brk scripts/opensearch_dashboards --dev",
"lint": "yarn run lint:es && yarn run lint:style",
2 changes: 1 addition & 1 deletion src/plugins/data/common/data_frames/types.ts
Original file line number Diff line number Diff line change
@@ -98,6 +98,6 @@ export interface IDataFrameResponse extends SearchResponse<any> {
took: number;
}

export interface IDataFrameError {
export interface IDataFrameError extends IDataFrameResponse {
error: Error;
}
Original file line number Diff line number Diff line change
@@ -123,7 +123,7 @@ export const searchSourceRequiredUiSettings = [
UI_SETTINGS.QUERY_STRING_OPTIONS,
UI_SETTINGS.SEARCH_INCLUDE_FROZEN,
UI_SETTINGS.SORT_OPTIONS,
UI_SETTINGS.DATAFRAME_HYDRATION_STRATEGY,
UI_SETTINGS.QUERY_DATAFRAME_HYDRATION_STRATEGY,
];

export interface SearchSourceDependencies extends FetchHandlers {
Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ interface IDataSelectorRefresherProps {
export const DataSelectorRefresher: React.FC<IDataSelectorRefresherProps> = React.memo(
({ tooltipText, onRefresh, buttonProps, toolTipProps }) => {
return (
<EuiText size="s">
<EuiText size="s" className="sourceRefreshText">
<EuiToolTip
position="right"
content={i18n.translate('data.datasource.selector.refreshDataSources', {
@@ -34,10 +34,10 @@ export const DataSelectorRefresher: React.FC<IDataSelectorRefresherProps> = Reac
{...toolTipProps}
>
<EuiButtonIcon
size="s"
onClick={onRefresh}
iconType="refresh"
aria-label="sourceRefresh"
className="sourceRefreshButton"
data-test-subj="sourceRefreshButton"
{...buttonProps}
/>
Original file line number Diff line number Diff line change
@@ -162,6 +162,7 @@ export const DataSourceSelectable = ({
return (
<EuiComboBox
{...comboBoxProps}
className="dataExplorerDSSelect"
data-test-subj="dataExplorerDSSelect"
placeholder={i18n.translate('data.datasource.selectADatasource', {
defaultMessage: DATA_SELECTOR_DEFAULT_PLACEHOLDER,
Original file line number Diff line number Diff line change
@@ -3,12 +3,6 @@
* SPDX-License-Identifier: Apache-2.0
*/
.languageSelector {
max-width: 140px;
height: 100%;

&:first-child {
div:first-child {
height: 100%;
}
}
min-width: 140px;
border-bottom: $euiBorderThin !important;
}
22 changes: 22 additions & 0 deletions src/plugins/data/public/ui/query_editor/_query_editor.scss
Original file line number Diff line number Diff line change
@@ -15,6 +15,28 @@
// overflow: auto;
}

.osdQueryEditor__languageWrapper {
:first-child {
box-shadow: none !important;
height: 100%;
border-radius: 0;
}
}

.osdQueryEditor__dataSourceWrapper {
.dataExplorerDSSelect {
border-bottom: $euiBorderThin !important;

div:is([class$="--group"]) {
padding: 0 !important;
}

.sourceRefreshText {
max-height: 40px;
}
}
}

@include euiBreakpoint("xs", "s") {
.osdQueryEditor--withDatePicker {
> :first-child {
Original file line number Diff line number Diff line change
@@ -74,6 +74,7 @@ export const QueryLanguageSelector = (props: Props) => {

return (
<EuiComboBox
fullWidth
className="languageSelector"
data-test-subj="languageSelector"
options={languageOptions}
52 changes: 31 additions & 21 deletions src/plugins/data/public/ui/query_editor/query_editor.tsx
Original file line number Diff line number Diff line change
@@ -16,7 +16,7 @@ import {
import { QuerySuggestion } from '../../autocomplete';
import { fromUser, getQueryLog, PersistedLog, toUser } from '../../query';
import { SuggestionsListSize } from '../typeahead/suggestions_component';
import { DataSettings, QueryEnhancement } from '../types';
import { DataSettings } from '../types';
import { fetchIndexPatterns } from './fetch_index_patterns';
import { QueryLanguageSelector } from './language_selector';

@@ -52,7 +52,7 @@ interface Props extends QueryEditorProps {
}

interface State {
queryEnhancements: Map<string, QueryEnhancement>;
isDataSourcesVisible: boolean;
isSuggestionsVisible: boolean;
index: number | null;
suggestions: QuerySuggestion[];
@@ -77,7 +77,7 @@ const KEY_CODES = {
// eslint-disable-next-line import/no-default-export
export default class QueryEditorUI extends Component<Props, State> {
public state: State = {
queryEnhancements: new Map(),
isDataSourcesVisible: true,
isSuggestionsVisible: false,
index: null,
suggestions: [],
@@ -169,16 +169,16 @@ export default class QueryEditorUI extends Component<Props, State> {
language,
};

const fields = this.props.settings.getQueryEnhancements(newQuery.language)?.fields;
const enhancement = this.props.settings.getQueryEnhancements(newQuery.language);
const fields = enhancement?.fields;
const newSettings: DataSettings = {
userQueryLanguage: newQuery.language,
userQueryString: newQuery.query,
...(fields && { uiOverrides: { fields } }),
};
this.props.settings?.updateSettings(newSettings);

const dateRangeEnhancement = this.props.settings.getQueryEnhancements(language)?.searchBar
?.dateRange;
const dateRangeEnhancement = enhancement?.searchBar?.dateRange;
const dateRange = dateRangeEnhancement
? {
from: dateRangeEnhancement.initialFrom!,
@@ -187,6 +187,7 @@ export default class QueryEditorUI extends Component<Props, State> {
: undefined;
this.onChange(newQuery, dateRange);
this.onSubmit(newQuery, dateRange);
this.setState({ isDataSourcesVisible: enhancement?.searchBar?.showDataSourceSelector ?? true });
};

private initPersistedLog = () => {
@@ -196,6 +197,15 @@ export default class QueryEditorUI extends Component<Props, State> {
: getQueryLog(uiSettings, storage, appName, this.props.query.language);
};

private initDataSourcesVisibility = () => {
if (this.componentIsUnmounting) return;

const isDataSourcesVisible =
this.props.settings.getQueryEnhancements(this.props.query.language)?.searchBar
?.showDataSourceSelector ?? true;
this.setState({ isDataSourcesVisible });
};

public onMouseEnterSuggestion = (index: number) => {
this.setState({ index });
};
@@ -210,6 +220,7 @@ export default class QueryEditorUI extends Component<Props, State> {

this.initPersistedLog();
// this.fetchIndexPatterns().then(this.updateSuggestions);
this.initDataSourcesVisibility();
this.handleListUpdate();

window.addEventListener('scroll', this.handleListUpdate, {
@@ -265,23 +276,21 @@ export default class QueryEditorUI extends Component<Props, State> {
<div ref={this.props.queryEditorBannerRef} className={queryEditorBannerClassName} />
<EuiFlexGroup gutterSize="xs" direction="column">
<EuiFlexItem grow={false}>
<EuiFlexGroup gutterSize="xs">
<EuiFlexGroup gutterSize="xs" alignItems="center" className={`${className}__wrapper`}>
<EuiFlexItem grow={false}>{this.props.prepend}</EuiFlexItem>
<EuiFlexItem>
<EuiFlexGroup gutterSize="xs">
<EuiFlexItem grow={false}>
<div ref={this.props.containerRef} />
</EuiFlexItem>
<EuiFlexItem grow={true}>
<QueryLanguageSelector
language={this.props.query.language}
anchorPosition={this.props.languageSwitcherPopoverAnchorPosition}
onSelectLanguage={this.onSelectLanguage}
appName={this.services.appName}
/>
</EuiFlexItem>
</EuiFlexGroup>
<EuiFlexItem grow={false} className={`${className}__languageWrapper`}>
<QueryLanguageSelector
language={this.props.query.language}
anchorPosition={this.props.languageSwitcherPopoverAnchorPosition}
onSelectLanguage={this.onSelectLanguage}
appName={this.services.appName}
/>
</EuiFlexItem>
{this.state.isDataSourcesVisible && (
<EuiFlexItem grow={false} className={`${className}__dataSourceWrapper`}>
<div ref={this.props.containerRef} />
</EuiFlexItem>
)}
</EuiFlexGroup>
</EuiFlexItem>
<EuiFlexItem onClick={this.onClickInput} grow={true}>
@@ -302,6 +311,7 @@ export default class QueryEditorUI extends Component<Props, State> {
scrollBeyondLastLine: false,
wordWrap: 'on',
wrappingIndent: 'indent',
selectionHighlight: false,
}}
/>
</EuiFlexItem>
Original file line number Diff line number Diff line change
@@ -245,6 +245,7 @@ export default function QueryEditorTopRow(props: QueryEditorTopRowProps) {
onSubmit={onInputSubmit}
getQueryStringInitialValue={getQueryStringInitialValue}
persistedLog={persistedLog}
className="osdQueryEditor"
dataTestSubj={props.dataTestSubj}
queryEditorHeaderRef={queryEditorHeaderRef}
queryEditorBannerRef={queryEditorBannerRef}
1 change: 1 addition & 0 deletions src/plugins/data/public/ui/types.ts
Original file line number Diff line number Diff line change
@@ -21,6 +21,7 @@ export interface QueryEnhancement {
// Leave blank to support all data sources
// supportedDataSourceTypes?: Record<string, GenericDataSource>;
searchBar?: {
showDataSourceSelector?: boolean;
showQueryInput?: boolean;
showFilterBar?: boolean;
showDatePicker?: boolean;