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

[Canvas] Use data views service #139610

Merged
merged 5 commits into from
Oct 24, 2022
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@
* 2.0.
*/

import { lastValueFrom } from 'rxjs';

import {
ExpressionFunctionDefinition,
ExpressionValueFilter,
} from '@kbn/expressions-plugin/common';

// @ts-expect-error untyped local
import { buildESRequest } from '../../../common/lib/request/build_es_request';

import { searchService } from '../../../public/services';

import { getFunctionHelp } from '../../../i18n';
import { searchService } from '../../../public/services';

interface Arguments {
index: string | null;
Expand Down Expand Up @@ -46,6 +46,7 @@ export function escount(): ExpressionFunctionDefinition<
},
index: {
types: ['string'],
aliases: ['dataView'],
default: '_all',
help: argHelp.index,
},
Expand Down Expand Up @@ -83,12 +84,9 @@ export function escount(): ExpressionFunctionDefinition<
},
};

return search
.search(req)
.toPromise()
.then((resp: any) => {
return resp.rawResponse.hits.total;
});
return lastValueFrom(search.search(req)).then((resp: any) => {
return resp.rawResponse.hits.total;
});
},
};
}
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ export function esdocs(): ExpressionFunctionDefinition<
},
index: {
types: ['string'],
aliases: ['dataView'],
default: '_all',
help: argHelp.index,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
import { getSimpleArg, setSimpleArg } from '../../../public/lib/arg_helpers';
import { ESFieldsSelect } from '../../../public/components/es_fields_select';
import { ESFieldSelect } from '../../../public/components/es_field_select';
import { ESIndexSelect } from '../../../public/components/es_index_select';
import { ESDataViewSelect } from '../../../public/components/es_data_view_select';
import { templateFromReactComponent } from '../../../public/lib/template_from_react_component';
import { DataSourceStrings, LUCENE_QUERY_URL } from '../../../i18n';

Expand All @@ -29,6 +29,7 @@ const { ESDocs: strings } = DataSourceStrings;
const EsdocsDatasource = ({ args, updateArgs, defaultIndex }) => {
const setArg = useCallback(
(name, value) => {
console.log({ name, value });
updateArgs &&
updateArgs({
...args,
Expand Down Expand Up @@ -94,7 +95,7 @@ const EsdocsDatasource = ({ args, updateArgs, defaultIndex }) => {
helpText={strings.getIndexLabel()}
display="rowCompressed"
>
<ESIndexSelect value={index} onChange={(index) => setArg('index', index)} />
<ESDataViewSelect value={index} onChange={(index) => setArg('index', index)} />
</EuiFormRow>

<EuiFormRow
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/canvas/i18n/ui.ts
Original file line number Diff line number Diff line change
Expand Up @@ -461,11 +461,11 @@ export const DataSourceStrings = {
}),
getIndexTitle: () =>
i18n.translate('xpack.canvas.uis.dataSources.esdocs.indexTitle', {
defaultMessage: 'Index',
defaultMessage: 'Data view',
}),
getIndexLabel: () =>
i18n.translate('xpack.canvas.uis.dataSources.esdocs.indexLabel', {
defaultMessage: 'Enter an index name or select a data view',
defaultMessage: 'Select a data view or enter an index name.',
}),
getQueryTitle: () =>
i18n.translate('xpack.canvas.uis.dataSources.esdocs.queryTitle', {
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/canvas/kibana.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"bfetch",
"charts",
"data",
"dataViews",
"embeddable",
"expressionError",
"expressionImage",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
import { isEqual } from 'lodash';
import { i18n } from '@kbn/i18n';

import { getDefaultIndex } from '../../lib/es_service';
import { pluginServices } from '../../services';
import { DatasourceSelector } from './datasource_selector';
import { DatasourcePreview } from './datasource_preview';

Expand Down Expand Up @@ -67,7 +67,12 @@ export class DatasourceComponent extends PureComponent {
state = { defaultIndex: '' };

componentDidMount() {
getDefaultIndex().then((defaultIndex) => this.setState({ defaultIndex }));
pluginServices
.getServices()
.dataViews.getDefaultDataView()
.then((defaultDataView) => {
this.setState({ defaultIndex: defaultDataView.title });
});
}

componentDidUpdate(prevProps) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,37 +7,47 @@

import React, { FocusEventHandler } from 'react';
import { EuiComboBox } from '@elastic/eui';
import { DataView } from '@kbn/data-views-plugin/common';

export interface ESIndexSelectProps {
type DataViewOption = Pick<DataView, 'id' | 'name' | 'title'>;

export interface ESDataViewSelectProps {
loading: boolean;
value: string;
indices: string[];
onChange: (index: string) => void;
dataViews: DataViewOption[];
onChange: (string: string) => void;
onBlur: FocusEventHandler<HTMLDivElement> | undefined;
onFocus: FocusEventHandler<HTMLDivElement> | undefined;
}

const defaultIndex = '_all';
const defaultOption = { value: defaultIndex, label: defaultIndex };

export const ESIndexSelect: React.FunctionComponent<ESIndexSelectProps> = ({
export const ESDataViewSelect: React.FunctionComponent<ESDataViewSelectProps> = ({
value = defaultIndex,
loading,
indices,
dataViews,
onChange,
onFocus,
onBlur,
}) => {
const selectedOption = value !== defaultIndex ? [{ label: value }] : [];
const options = indices.map((index) => ({ label: index }));
const selectedDataView = dataViews.find((view) => value === view.title) as DataView;

const selectedOption = selectedDataView
? { value: selectedDataView.title, label: selectedDataView.name }
: { value, label: value };
const options = dataViews.map(({ name, title }) => ({ value: title, label: name }));

return (
<EuiComboBox
selectedOptions={selectedOption}
onChange={([index]) => onChange(index?.label ?? defaultIndex)}
selectedOptions={[selectedOption]}
onChange={([view]) => {
onChange(view.value || defaultOption.value);
}}
onSearchChange={(searchValue) => {
// resets input when user starts typing
if (searchValue) {
onChange(defaultIndex);
onChange(defaultOption.value);
}
}}
onBlur={onBlur}
Expand All @@ -46,7 +56,7 @@ export const ESIndexSelect: React.FunctionComponent<ESIndexSelectProps> = ({
options={options}
singleSelection={{ asPlainText: true }}
isClearable={false}
onCreateOption={(input) => onChange(input || defaultIndex)}
onCreateOption={(input) => onChange(input || defaultOption.value)}
compressed
/>
);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import { DataView } from '@kbn/data-views-plugin/common';
import { sortBy } from 'lodash';
import React, { FC, useRef, useState } from 'react';
import useEffectOnce from 'react-use/lib/useEffectOnce';
import { useDataViewsService } from '../../services';
import {
ESDataViewSelect as Component,
ESDataViewSelectProps as Props,
} from './es_data_view_select.component';

type ESDataViewSelectProps = Omit<Props, 'indices' | 'loading'>;

export const ESDataViewSelect: FC<ESDataViewSelectProps> = (props) => {
const { value, onChange } = props;

const [dataViews, setDataViews] = useState<Array<Pick<DataView, 'id' | 'name' | 'title'>>>([]);
const [loading, setLoading] = useState<boolean>(true);
const mounted = useRef(true);
const { getDataViews } = useDataViewsService();

useEffectOnce(() => {
getDataViews().then((newDataViews) => {
if (!mounted.current) {
return;
}

if (!newDataViews) {
newDataViews = [];
}

setLoading(false);
setDataViews(sortBy(newDataViews, 'name'));
if (!value && newDataViews.length) {
onChange(newDataViews[0].title);
}
});

return () => {
mounted.current = false;
};
});

return <Component {...props} dataViews={dataViews} loading={loading} />;
};
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
* 2.0.
*/

export { ESIndexSelect } from './es_index_select';
export { ESIndexSelect as ESIndexSelectComponent } from './es_index_select.component';
export { ESDataViewSelect } from './es_data_view_select';
export { ESDataViewSelect as ESDataViewSelectComponent } from './es_data_view_select.component';
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

import React, { useState, useEffect, useRef } from 'react';
import { getFields } from '../../lib/es_service';
import { useDataViewsService } from '../../services';
import { ESFieldSelect as Component, ESFieldSelectProps as Props } from './es_field_select';

type ESFieldSelectProps = Omit<Props, 'fields'>;
Expand All @@ -15,15 +15,17 @@ export const ESFieldSelect: React.FunctionComponent<ESFieldSelectProps> = (props
const { index, value, onChange } = props;
const [fields, setFields] = useState<string[]>([]);
const loadingFields = useRef(false);
const { getFields } = useDataViewsService();

useEffect(() => {
loadingFields.current = true;

getFields(index)
.then((newFields) => setFields(newFields || []))
.finally(() => {
loadingFields.current = false;
});
}, [index]);
}, [index, getFields]);

useEffect(() => {
if (!loadingFields.current && value && !fields.includes(value)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import React, { useState, useEffect, useRef } from 'react';
import { isEqual } from 'lodash';
import usePrevious from 'react-use/lib/usePrevious';
import { getFields } from '../../lib/es_service';
import { useDataViewsService } from '../../services';
import {
ESFieldsSelect as Component,
ESFieldsSelectProps as Props,
Expand All @@ -21,6 +21,7 @@ export const ESFieldsSelect: React.FunctionComponent<ESFieldsSelectProps> = (pro
const [fields, setFields] = useState<string[]>([]);
const prevIndex = usePrevious(index);
const mounted = useRef(true);
const { getFields } = useDataViewsService();

useEffect(() => {
if (prevIndex !== index) {
Expand All @@ -36,7 +37,7 @@ export const ESFieldsSelect: React.FunctionComponent<ESFieldsSelectProps> = (pro
}
});
}
}, [fields, index, onChange, prevIndex, selected]);
}, [fields, index, onChange, prevIndex, selected, getFields]);

useEffect(
() => () => {
Expand Down

This file was deleted.

Loading