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.

Sign up for GitHub

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

[Logs UI][Metrics UI] Replace usage of deprecated IndexPattern types #114448

Merged
merged 4 commits into from
Oct 12, 2021
Merged

[Logs UI][Metrics UI] Replace usage of deprecated IndexPattern types #114448

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84f8c95
[Logs UI][Metrics UI] Replace usage of deprecated IndexPattern types …
miltonhultgren Oct 11, 2021
af705e7
Use @ts-expect-error instead of any cast
miltonhultgren Oct 11, 2021
2014c2b
Prefer public -> public and common -> common imports
miltonhultgren Oct 11, 2021
4167cc9
Merge branch 'master' into 107887-replace-index-pattern-types
kibanamachine Oct 11, 2021
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
13 changes: 6 additions & 7 deletions x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,13 @@ import { delay } from 'rxjs/operators';
import {
fieldList,
FieldSpec,
IIndexPattern,
IndexPattern,
IndexPatternsContract,
DataView,
DataViewsContract,
RuntimeField,
} from 'src/plugins/data/common';

type IndexPatternMock = Pick<
IndexPattern,
DataView,
| 'fields'
| 'getComputedFields'
| 'getFieldByName'
Expand All @@ -27,7 +26,7 @@ type IndexPatternMock = Pick<
| 'title'
| 'type'
>;
type IndexPatternMockSpec = Pick<IIndexPattern, 'id' | 'title' | 'type' | 'timeFieldName'> & {
type IndexPatternMockSpec = Pick<DataView, 'id' | 'title' | 'type' | 'timeFieldName'> & {
fields: FieldSpec[];
};

Expand Down Expand Up @@ -71,8 +70,8 @@ export const createIndexPatternsMock = (
asyncDelay: number,
indexPatterns: IndexPatternMock[]
): {
getIdsWithTitle: IndexPatternsContract['getIdsWithTitle'];
get: (...args: Parameters<IndexPatternsContract['get']>) => Promise<IndexPatternMock>;
getIdsWithTitle: DataViewsContract['getIdsWithTitle'];
get: (...args: Parameters<DataViewsContract['get']>) => Promise<IndexPatternMock>;
} => {
return {
async getIdsWithTitle(_refresh?: boolean) {
Expand Down
12 changes: 6 additions & 6 deletions x-pack/plugins/infra/common/log_sources/resolved_log_source_configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

import { estypes } from '@elastic/elasticsearch';
import { IndexPattern, IndexPatternsContract } from '../../../../../src/plugins/data/common';
import { DataView, DataViewsContract } from '../../../../../src/plugins/data/common';
import { ObjectEntries } from '../utility_types';
import { ResolveLogSourceConfigurationError } from './errors';
import {
Expand All @@ -21,14 +21,14 @@ export interface ResolvedLogSourceConfiguration {
timestampField: string;
tiebreakerField: string;
messageField: string[];
fields: IndexPattern['fields'];
fields: DataView['fields'];
runtimeMappings: estypes.MappingRuntimeFields;
columns: LogSourceColumnConfiguration[];
}

export const resolveLogSourceConfiguration = async (
sourceConfiguration: LogSourceConfigurationProperties,
indexPatternsService: IndexPatternsContract
indexPatternsService: DataViewsContract
): Promise<ResolvedLogSourceConfiguration> => {
if (sourceConfiguration.logIndices.type === 'index_name') {
return await resolveLegacyReference(sourceConfiguration, indexPatternsService);
Expand All @@ -39,7 +39,7 @@ export const resolveLogSourceConfiguration = async (

const resolveLegacyReference = async (
sourceConfiguration: LogSourceConfigurationProperties,
indexPatternsService: IndexPatternsContract
indexPatternsService: DataViewsContract
): Promise<ResolvedLogSourceConfiguration> => {
if (sourceConfiguration.logIndices.type !== 'index_name') {
throw new Error('This function can only resolve legacy references');
Expand Down Expand Up @@ -74,7 +74,7 @@ const resolveLegacyReference = async (

const resolveKibanaIndexPatternReference = async (
sourceConfiguration: LogSourceConfigurationProperties,
indexPatternsService: IndexPatternsContract
indexPatternsService: DataViewsContract
): Promise<ResolvedLogSourceConfiguration> => {
if (sourceConfiguration.logIndices.type !== 'index_pattern') {
throw new Error('This function can only resolve Kibana Index Pattern references');
Expand Down Expand Up @@ -103,7 +103,7 @@ const resolveKibanaIndexPatternReference = async (
};

// this might take other sources of runtime fields into account in the future
const resolveRuntimeMappings = (indexPattern: IndexPattern): estypes.MappingRuntimeFields => {
const resolveRuntimeMappings = (indexPattern: DataView): estypes.MappingRuntimeFields => {
const { runtimeFields } = indexPattern.getComputedFields();

const runtimeMappingsFromIndexPattern = (
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { mountWithIntl, nextTick } from '@kbn/test/jest';
// We are using this inside a `jest.mock` call. Jest requires dynamic dependencies to be prefixed with `mock`
import { coreMock as mockCoreMock } from 'src/core/public/mocks';
import { MetricExpression } from '../types';
import { IIndexPattern } from 'src/plugins/data/public';
import { DataViewBase } from '@kbn/es-query';
import { MetricsSourceConfiguration } from '../../../../common/metrics_sources';
import React from 'react';
import { ExpressionChart } from './expression_chart';
Expand Down Expand Up @@ -40,7 +40,7 @@ jest.mock('../hooks/use_metrics_explorer_chart_data', () => ({

describe('ExpressionChart', () => {
async function setup(expression: MetricExpression, filterQuery?: string, groupBy?: string) {
const derivedIndexPattern: IIndexPattern = {
const derivedIndexPattern: DataViewBase = {
title: 'metricbeat-*',
fields: [],
};
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Axis, Chart, niceTimeFormatter, Position, Settings } from '@elastic/cha
import { first, last } from 'lodash';
import { EuiText } from '@elastic/eui';
import { FormattedMessage } from '@kbn/i18n/react';
import { IIndexPattern } from 'src/plugins/data/public';
import { DataViewBase } from '@kbn/es-query';
import { MetricsSourceConfiguration } from '../../../../common/metrics_sources';
import { Color } from '../../../../common/color_palette';
import { MetricsExplorerRow, MetricsExplorerAggregation } from '../../../../common/http_api';
Expand All @@ -34,7 +34,7 @@ import { ThresholdAnnotations } from '../../common/criterion_preview_chart/thres

interface Props {
expression: MetricExpression;
derivedIndexPattern: IIndexPattern;
derivedIndexPattern: DataViewBase;
source: MetricsSourceConfiguration | null;
filterQuery?: string;
groupBy?: string | string[];
Expand Down
4 changes: 2 additions & 2 deletions ...k/plugins/infra/public/alerting/metric_threshold/hooks/use_metrics_explorer_chart_data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* 2.0.
*/

import { IIndexPattern } from 'src/plugins/data/public';
import { DataViewBase } from '@kbn/es-query';
import { useMemo } from 'react';
import { MetricsSourceConfiguration } from '../../../../common/metrics_sources';
import { MetricExpression } from '../types';
Expand All @@ -14,7 +14,7 @@ import { useMetricsExplorerData } from '../../../pages/metrics/metrics_explorer/

export const useMetricsExplorerChartData = (
expression: MetricExpression,
derivedIndexPattern: IIndexPattern,
derivedIndexPattern: DataViewBase,
source: MetricsSourceConfiguration | null,
filterQuery?: string,
groupBy?: string | string[]
Expand Down
5 changes: 3 additions & 2 deletions x-pack/plugins/infra/public/containers/logs/log_filter/log_filter_state.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
import createContainer from 'constate';
import { useCallback, useState } from 'react';
import useDebounce from 'react-use/lib/useDebounce';
import { esQuery, IIndexPattern, Query } from '../../../../../../../src/plugins/data/public';
import { DataViewBase } from '@kbn/es-query';
import { esQuery, Query } from '../../../../../../../src/plugins/data/public';

type ParsedQuery = ReturnType<typeof esQuery.buildEsQuery>;

Expand All @@ -33,7 +34,7 @@ const initialLogFilterState: ILogFilterState = {

const validationDebounceTimeout = 1000; // milliseconds

export const useLogFilterState = ({ indexPattern }: { indexPattern: IIndexPattern }) => {
export const useLogFilterState = ({ indexPattern }: { indexPattern: DataViewBase }) => {
const [logFilterState, setLogFilterState] = useState<ILogFilterState>(initialLogFilterState);

const parseQuery = useCallback(
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/infra/public/containers/logs/log_source/log_source.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import createContainer from 'constate';
import { useCallback, useMemo, useState } from 'react';
import type { HttpHandler } from 'src/core/public';
import { IndexPatternsContract } from '../../../../../../../src/plugins/data/common';
import { DataViewsContract } from '../../../../../../../src/plugins/data/common';
import {
LogIndexField,
LogSourceConfigurationPropertiesPatch,
Expand Down Expand Up @@ -42,7 +42,7 @@ export const useLogSource = ({
}: {
sourceId: string;
fetch: HttpHandler;
indexPatternsService: IndexPatternsContract;
indexPatternsService: DataViewsContract;
}) => {
const [sourceConfiguration, setSourceConfiguration] = useState<
LogSourceConfiguration | undefined
Expand Down
7 changes: 4 additions & 3 deletions x-pack/plugins/infra/public/containers/with_kuery_autocompletion.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
*/

import React from 'react';
import { QuerySuggestion, IIndexPattern, DataPublicPluginStart } from 'src/plugins/data/public';
import { DataViewBase } from '@kbn/es-query';
import { QuerySuggestion, DataPublicPluginStart } from 'src/plugins/data/public';
import {
withKibana,
KibanaReactContextValue,
Expand All @@ -21,7 +22,7 @@ interface WithKueryAutocompletionLifecycleProps {
loadSuggestions: (expression: string, cursorPosition: number, maxSuggestions?: number) => void;
suggestions: QuerySuggestion[];
}>;
indexPattern: IIndexPattern;
indexPattern: DataViewBase;
}

interface WithKueryAutocompletionLifecycleState {
Expand Down Expand Up @@ -82,7 +83,7 @@ class WithKueryAutocompletionComponent extends React.Component<
query: expression,
selectionStart: cursorPosition,
selectionEnd: cursorPosition,
indexPatterns: [indexPattern],
indexPatterns: [indexPattern as any], // How to fix this without changing the dependency?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of casting to any, how about we use a // @ts-expect-error? That could increase the likelihood that the person updating the getQuerySuggestions signature will be prompted by CI to remove the workaround.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better, thanks!

boolFilter: [],
})) || [];

Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/infra/public/containers/with_source/with_source.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import React, { useContext } from 'react';

import { IIndexPattern } from 'src/plugins/data/public';
import { DataViewBase } from '@kbn/es-query';
import {
MetricsSourceConfigurationProperties,
PartialMetricsSourceConfigurationProperties,
Expand All @@ -21,7 +21,7 @@ interface WithSourceProps {
create: (
sourceProperties: PartialMetricsSourceConfigurationProperties
) => Promise<any> | undefined;
createDerivedIndexPattern: (type: 'metrics') => IIndexPattern;
createDerivedIndexPattern: (type: 'metrics') => DataViewBase;
exists?: boolean;
hasFailed: boolean;
isLoading: boolean;
Expand Down
20 changes: 6 additions & 14 deletions x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.mock.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,15 @@ import { from, of } from 'rxjs';
import { delay } from 'rxjs/operators';
import { CoreStart } from '../../../../../src/core/public';
import { FieldSpec } from '../../../../../src/plugins/data/common';
import {
IIndexPattern,
IndexPattern,
IndexPatternField,
IndexPatternsContract,
} from '../../../../../src/plugins/data/public';
import { DataView, DataViewField, DataViewsContract } from '../../../../../src/plugins/data/common';
import { KibanaContextProvider } from '../../../../../src/plugins/kibana_react/public';
import { Pick2 } from '../../common/utility_types';

type MockIndexPattern = Pick<
IndexPattern,
DataView,
'id' | 'title' | 'type' | 'getTimeField' | 'isTimeBased' | 'getFieldByName' | 'getComputedFields'
>;
export type MockIndexPatternSpec = Pick<
IIndexPattern,
'id' | 'title' | 'type' | 'timeFieldName'
> & {
export type MockIndexPatternSpec = Pick<DataView, 'id' | 'title' | 'type' | 'timeFieldName'> & {
fields: FieldSpec[];
};

Expand Down Expand Up @@ -59,8 +51,8 @@ export const createIndexPatternsMock = (
asyncDelay: number,
indexPatterns: MockIndexPattern[]
): {
getIdsWithTitle: IndexPatternsContract['getIdsWithTitle'];
get: (...args: Parameters<IndexPatternsContract['get']>) => Promise<MockIndexPattern>;
getIdsWithTitle: DataViewsContract['getIdsWithTitle'];
get: (...args: Parameters<DataViewsContract['get']>) => Promise<MockIndexPattern>;
} => {
return {
async getIdsWithTitle(_refresh?: boolean) {
Expand All @@ -85,7 +77,7 @@ export const createIndexPatternMock = ({
fields,
timeFieldName,
}: MockIndexPatternSpec): MockIndexPattern => {
const indexPatternFields = fields.map((fieldSpec) => new IndexPatternField(fieldSpec));
const indexPatternFields = fields.map((fieldSpec) => new DataViewField(fieldSpec));

return {
id,
Expand Down
3 changes: 3 additions & 0 deletions x-pack/plugins/infra/public/pages/logs/settings/indices_configuration_panel.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ const defaultArgs: IndicesConfigurationPanelStoryArgs = {
id: 'INDEX_PATTERN_A',
title: 'pattern-a-*',
timeFieldName: '@timestamp',
type: undefined,
fields: [
{
name: '@timestamp',
Expand All @@ -149,6 +150,8 @@ const defaultArgs: IndicesConfigurationPanelStoryArgs = {
{
id: 'INDEX_PATTERN_B',
title: 'pattern-b-*',
timeFieldName: '@timestamp',
type: undefined,
fields: [],
},
],
Expand Down
13 changes: 6 additions & 7 deletions x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
* 2.0.
*/

import { IndexPattern, KBN_FIELD_TYPES } from '../../../../../../../src/plugins/data/public';
import { DataView } from '../../../../../../../src/plugins/data/common';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not keep importing from public? I'm not sure cross-plugin imports from common into public are officially supported. In this case it seems easy to avoid them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, that was sloppy of me!
It's because the data plugin doesn't export DataView from public, but in fact that type lives within the data_view plugin and there it is exported from public.
The data plugin only re-exports parts of the data_views types (like IndexPattern).

I'll fix that :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at the other files, they seem to pull mostly form /common, is that something I should look to change as well?

import { KBN_FIELD_TYPES } from '../../../../../../../src/plugins/data/public';

export interface GenericValidationError {
type: 'generic';
Expand Down Expand Up @@ -67,17 +68,15 @@ export const validateStringNotEmpty = (fieldName: string, value: string): FormVa
export const validateColumnListNotEmpty = (columns: unknown[]): FormValidationError[] =>
columns.length <= 0 ? [{ type: 'empty_column_list' }] : [];

export const validateIndexPattern = (indexPattern: IndexPattern): FormValidationError[] => {
export const validateIndexPattern = (indexPattern: DataView): FormValidationError[] => {
return [
...validateIndexPatternIsTimeBased(indexPattern),
...validateIndexPatternHasStringMessageField(indexPattern),
...validateIndexPatternIsntRollup(indexPattern),
];
};

export const validateIndexPatternIsTimeBased = (
indexPattern: IndexPattern
): FormValidationError[] =>
export const validateIndexPatternIsTimeBased = (indexPattern: DataView): FormValidationError[] =>
indexPattern.isTimeBased()
? []
: [
Expand All @@ -88,7 +87,7 @@ export const validateIndexPatternIsTimeBased = (
];

export const validateIndexPatternHasStringMessageField = (
indexPattern: IndexPattern
indexPattern: DataView
): FormValidationError[] => {
const messageField = indexPattern.getFieldByName('message');

Expand All @@ -111,7 +110,7 @@ export const validateIndexPatternHasStringMessageField = (
}
};

export const validateIndexPatternIsntRollup = (indexPattern: IndexPattern): FormValidationError[] =>
export const validateIndexPatternIsntRollup = (indexPattern: DataView): FormValidationError[] =>
indexPattern.type != null
? [
{
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/infra/public/pages/metrics/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import React, { useContext } from 'react';
import { Route, RouteComponentProps, Switch } from 'react-router-dom';

import { EuiErrorBoundary, EuiHeaderLinks, EuiHeaderLink } from '@elastic/eui';
import { IIndexPattern } from 'src/plugins/data/common';
import { DataViewBase } from '@kbn/es-query';
import { MetricsSourceConfigurationProperties } from '../../../common/metrics_sources';
import { DocumentTitle } from '../../components/document_title';
import { HelpCenterContent } from '../../components/help_center_content';
Expand Down Expand Up @@ -141,7 +141,7 @@ export const InfrastructurePage = ({ match }: RouteComponentProps) => {

const PageContent = (props: {
configuration: MetricsSourceConfigurationProperties;
createDerivedIndexPattern: (type: 'metrics') => IIndexPattern;
createDerivedIndexPattern: (type: 'metrics') => DataViewBase;
}) => {
const { createDerivedIndexPattern, configuration } = props;
const { options } = useContext(MetricsExplorerOptionsContainer.Context);
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/infra/public/pages/metrics/inventory_view/components/toolbars/toolbar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import React, { FunctionComponent } from 'react';
import { EuiFlexItem } from '@elastic/eui';
import { DataViewBase } from '@kbn/es-query';
import { useSourceContext } from '../../../../../containers/metrics_source';
import {
SnapshotMetricInput,
Expand All @@ -18,13 +19,12 @@ import { findToolbar } from '../../../../../../common/inventory_models/toolbars'
import { ToolbarWrapper } from './toolbar_wrapper';

import { InfraGroupByOptions } from '../../../../../lib/lib';
import { IIndexPattern } from '../../../../../../../../../src/plugins/data/public';
import { InventoryItemType } from '../../../../../../common/inventory_models/types';
import { WaffleOptionsState, WaffleSortOption } from '../../hooks/use_waffle_options';
import { useInventoryMeta } from '../../hooks/use_inventory_meta';

export interface ToolbarProps extends Omit<WaffleOptionsState, 'boundsOverride' | 'autoBounds'> {
createDerivedIndexPattern: (type: 'metrics') => IIndexPattern;
createDerivedIndexPattern: (type: 'metrics') => DataViewBase;
changeMetric: (payload: SnapshotMetricInput) => void;
changeGroupBy: (payload: SnapshotGroupBy) => void;
changeCustomOptions: (payload: InfraGroupByOptions[]) => void;
Expand Down
Loading