Skip to content

Commit

Permalink
Rename SearchSourceContract -> ISearchSource.
Browse files Browse the repository at this point in the history
  • Loading branch information
lukeelmers committed Dec 13, 2019
1 parent b7d79ce commit 77dfdff
Show file tree
Hide file tree
Showing 23 changed files with 45 additions and 54 deletions.
7 changes: 1 addition & 6 deletions src/legacy/core_plugins/data/public/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,7 @@ export function plugin() {
export { DataStart };

export { Field, FieldType, IFieldList, IndexPattern } from './index_patterns';
export {
EsQuerySortValue,
FetchOptions,
SearchSourceContract,
SortDirection,
} from './search/types';
export { EsQuerySortValue, FetchOptions, ISearchSource, SortDirection } from './search/types';
export {
SavedQueryAttributes,
SavedQuery,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import {
import { npStart } from 'ui/new_platform';
import {
SearchSource,
SearchSourceContract,
ISearchSource,
getRequestInspectorStats,
getResponseInspectorStats,
} from '../../../../../ui/public/courier';
Expand All @@ -51,7 +51,7 @@ import { PersistedState } from '../../../../../ui/public/persisted_state';
import { Adapters } from '../../../../../../plugins/inspector/public';

export interface RequestHandlerParams {
searchSource: SearchSourceContract;
searchSource: ISearchSource;
aggs: AggConfigs;
timeRange?: TimeRange;
query?: Query;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@
* under the License.
*/

import { SearchSourceContract } from './search_source';
import { ISearchSource } from './search_source';

export const searchSourceMock: MockedKeys<SearchSourceContract> = {
export const searchSourceMock: MockedKeys<ISearchSource> = {
setPreferredSearchStrategyId: jest.fn(),
setFields: jest.fn().mockReturnThis(),
setField: jest.fn().mockReturnThis(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,14 @@ import { FetchOptions, ApiCaller } from '../fetch/types';
const esShardTimeout = npSetup.core.injectedMetadata.getInjectedVar('esShardTimeout') as number;
const config = npSetup.core.uiSettings;

export type SearchSourceContract = Pick<SearchSource, keyof SearchSource>;
export type ISearchSource = Pick<SearchSource, keyof SearchSource>;

export class SearchSource {
private id: string = _.uniqueId('data_source');
private searchStrategyId?: string;
private parent?: SearchSource;
private requestStartHandlers: Array<
(searchSource: SearchSourceContract, options?: FetchOptions) => Promise<unknown>
(searchSource: ISearchSource, options?: FetchOptions) => Promise<unknown>
> = [];
private inheritOptions: SearchSourceOptions = {};
public history: SearchRequest[] = [];
Expand Down Expand Up @@ -172,7 +172,7 @@ export class SearchSource {
* @param {SearchSourceOptions} options - the inherit options
* @return {this} - chainable
*/
setParent(parent?: SearchSourceContract, options: SearchSourceOptions = {}) {
setParent(parent?: ISearchSource, options: SearchSourceOptions = {}) {
this.parent = parent as SearchSource;
this.inheritOptions = options;
return this;
Expand Down Expand Up @@ -222,7 +222,7 @@ export class SearchSource {
* @return {undefined}
*/
onRequestStart(
handler: (searchSource: SearchSourceContract, options?: FetchOptions) => Promise<unknown>
handler: (searchSource: ISearchSource, options?: FetchOptions) => Promise<unknown>
) {
this.requestStartHandlers.push(handler);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export interface SearchSourceOptions {
callParentStartHandlers?: boolean;
}

export { SearchSourceContract } from './search_source';
export { ISearchSource } from './search_source';

export interface SortOptions {
mode?: 'min' | 'max' | 'sum' | 'avg' | 'median';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@

import { i18n } from '@kbn/i18n';
import { SearchResponse } from 'elasticsearch';
import { SearchSourceContract, RequestInspectorStats } from '../types';
import { ISearchSource, RequestInspectorStats } from '../types';

export function getRequestInspectorStats(searchSource: SearchSourceContract) {
export function getRequestInspectorStats(searchSource: ISearchSource) {
const stats: RequestInspectorStats = {};
const index = searchSource.getField('index');

Expand Down Expand Up @@ -58,7 +58,7 @@ export function getRequestInspectorStats(searchSource: SearchSourceContract) {
}

export function getResponseInspectorStats(
searchSource: SearchSourceContract,
searchSource: ISearchSource,
resp: SearchResponse<unknown>
) {
const lastRequest = searchSource.history && searchSource.history[searchSource.history.length - 1];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
*/

import { SavedObject } from 'ui/saved_objects/types';
import { SearchSourceContract } from '../../../../../ui/public/courier';
import { ISearchSource } from '../../../../../ui/public/courier';
import { esFilters, Query, RefreshInterval } from '../../../../../../plugins/data/public';

export interface SavedObjectDashboard extends SavedObject {
Expand All @@ -34,7 +34,7 @@ export interface SavedObjectDashboard extends SavedObject {
// TODO: write a migration to rid of this, it's only around for bwc.
uiStateJSON?: string;
lastSavedTitle: string;
searchSource: SearchSourceContract;
searchSource: ISearchSource;
destroy: () => void;
refreshInterval?: RefreshInterval;
getQuery(): Query;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import {
EsQuerySortValue,
SortDirection,
SearchSourceContract,
ISearchSource,
} from '../../../../../../../../ui/public/courier';
import { convertTimeValueToIso } from './date_conversion';
import { EsHitRecordList } from '../context';
Expand All @@ -40,7 +40,7 @@ interface RangeQuery {
* and filters set.
*/
export async function fetchHitsInInterval(
searchSource: SearchSourceContract,
searchSource: ISearchSource,
timeField: string,
sort: [EsQuerySortValue, EsQuerySortValue],
sortDir: SortDirection,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import * as Rx from 'rxjs';
import { Subscription } from 'rxjs';
import { i18n } from '@kbn/i18n';
import { TExecuteTriggerActions } from 'src/plugins/ui_actions/public';
import { SearchSourceContract } from '../../../../../ui/public/courier';
import { ISearchSource } from '../../../../../ui/public/courier';
import {
esFilters,
TimeRange,
Expand Down Expand Up @@ -89,7 +89,7 @@ export class SearchEmbeddable extends Embeddable<SearchInput, SearchOutput>
private inspectorAdaptors: Adapters;
private searchScope?: SearchScope;
private panelTitle: string = '';
private filtersSearchSource?: SearchSourceContract;
private filtersSearchSource?: ISearchSource;
private searchInstance?: JQLite;
private autoRefreshFetchSubscription?: Subscription;
private subscription?: Subscription;
Expand Down
4 changes: 2 additions & 2 deletions src/legacy/core_plugins/kibana/public/discover/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@
* under the License.
*/

import { SearchSourceContract } from '../../../../ui/public/courier';
import { ISearchSource } from '../../../../ui/public/courier';
import { SortOrder } from './angular/doc_table/components/table_header/helpers';
export { SortOrder } from './angular/doc_table/components/table_header/helpers';

export interface SavedSearch {
readonly id: string;
title: string;
searchSource: SearchSourceContract;
searchSource: ISearchSource;
description?: string;
columns: string[];
sort: SortOrder[];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import { getTableAggs } from 'ui/visualize/loader/pipeline_helpers/utilities';
import { AppState } from 'ui/state_management/app_state';
import { npStart } from 'ui/new_platform';
import { IExpressionLoaderParams } from 'src/plugins/expressions/public';
import { SearchSourceContract } from '../../../../../ui/public/courier';
import { ISearchSource } from '../../../../../ui/public/courier';
import { VISUALIZE_EMBEDDABLE_TYPE } from './constants';
import {
IIndexPattern,
Expand All @@ -53,7 +53,7 @@ const getKeys = <T extends {}>(o: T): Array<keyof T> => Object.keys(o) as Array<
export interface VisSavedObject extends SavedObject {
vis: Vis;
description?: string;
searchSource: SearchSourceContract;
searchSource: ISearchSource;
title: string;
uiStateJSON?: string;
destroy: () => void;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import {
createFormat,
} from '../../../legacy_imports';
// eslint-disable-next-line
import { SearchSourceContract } from '../../../../../../ui/public/courier/search_source/search_source';
import { ISearchSource } from '../../../../../../ui/public/courier/search_source/search_source';
import { Vis, VisParams, VisState } from '..';

interface SchemaConfigParams {
Expand Down Expand Up @@ -466,7 +466,7 @@ export const buildVislibDimensions = async (
// take a Vis object and decorate it with the necessary params (dimensions, bucket, metric, etc)
export const getVisParams = async (
vis: Vis,
params: { searchSource: SearchSourceContract; timeRange?: any; abortSignal?: AbortSignal }
params: { searchSource: ISearchSource; timeRange?: any; abortSignal?: AbortSignal }
) => {
const schemas = getSchemas(vis, params.timeRange);
let visConfig = cloneDeep(vis.params);
Expand All @@ -484,7 +484,7 @@ export const getVisParams = async (
export const buildPipeline = async (
vis: Vis,
params: {
searchSource: SearchSourceContract;
searchSource: ISearchSource;
timeRange?: any;
}
) => {
Expand Down
4 changes: 2 additions & 2 deletions src/legacy/ui/public/agg_types/agg_config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import _ from 'lodash';
import { i18n } from '@kbn/i18n';
import { npStart } from 'ui/new_platform';
import { SearchSourceContract, FetchOptions } from '../courier/types';
import { ISearchSource, FetchOptions } from '../courier/types';
import { AggType } from './agg_type';
import { AggGroupNames } from '../vis/editors/default/agg_groups';
import { writeParams } from './agg_params';
Expand Down Expand Up @@ -236,7 +236,7 @@ export class AggConfig {
* @param {Courier.FetchOptions} options
* @return {Promise<undefined>}
*/
onSearchRequestStart(searchSource: SearchSourceContract, options?: FetchOptions) {
onSearchRequestStart(searchSource: ISearchSource, options?: FetchOptions) {
if (!this.type) {
return Promise.resolve();
}
Expand Down
4 changes: 2 additions & 2 deletions src/legacy/ui/public/agg_types/agg_configs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import { Schema } from '../vis/editors/default/schemas';
import { AggConfig, AggConfigOptions } from './agg_config';
import { AggGroupNames } from '../vis/editors/default/agg_groups';
import { IndexPattern } from '../../../core_plugins/data/public';
import { SearchSourceContract, FetchOptions } from '../courier/types';
import { ISearchSource, FetchOptions } from '../courier/types';

type Schemas = Record<string, any>;

Expand Down Expand Up @@ -306,7 +306,7 @@ export class AggConfigs {
return _.find(reqAgg.getResponseAggs(), { id });
}

onSearchRequestStart(searchSource: SearchSourceContract, options?: FetchOptions) {
onSearchRequestStart(searchSource: ISearchSource, options?: FetchOptions) {
return Promise.all(
// @ts-ignore
this.getRequestAggs().map((agg: AggConfig) => agg.onSearchRequestStart(searchSource, options))
Expand Down
6 changes: 3 additions & 3 deletions src/legacy/ui/public/agg_types/agg_type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import { initParams } from './agg_params';

import { AggConfig } from '../vis';
import { AggConfigs } from './agg_configs';
import { SearchSourceContract } from '../courier';
import { ISearchSource } from '../courier';
import { Adapters } from '../inspector';
import { BaseParamType } from './param_types/base';
import { AggParamType } from '../agg_types/param_types/agg';
Expand All @@ -51,7 +51,7 @@ export interface AggTypeConfig<
resp: any,
aggConfigs: AggConfigs,
aggConfig: TAggConfig,
searchSource: SearchSourceContract,
searchSource: ISearchSource,
inspectorAdapters: Adapters,
abortSignal?: AbortSignal
) => Promise<any>;
Expand Down Expand Up @@ -180,7 +180,7 @@ export class AggType<
resp: any,
aggConfigs: AggConfigs,
aggConfig: TAggConfig,
searchSource: SearchSourceContract,
searchSource: ISearchSource,
inspectorAdapters: Adapters,
abortSignal?: AbortSignal
) => Promise<any>;
Expand Down
8 changes: 2 additions & 6 deletions src/legacy/ui/public/agg_types/buckets/terms.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,7 @@
import chrome from 'ui/chrome';
import { noop } from 'lodash';
import { i18n } from '@kbn/i18n';
import {
SearchSourceContract,
getRequestInspectorStats,
getResponseInspectorStats,
} from '../../courier';
import { ISearchSource, getRequestInspectorStats, getResponseInspectorStats } from '../../courier';
import { BucketAggType } from './_bucket_agg_type';
import { BUCKET_TYPES } from './bucket_agg_types';
import { IBucketAggConfig } from './_bucket_agg_type';
Expand Down Expand Up @@ -101,7 +97,7 @@ export const termsBucketAgg = new BucketAggType({
resp: any,
aggConfigs: AggConfigs,
aggConfig: IBucketAggConfig,
searchSource: SearchSourceContract,
searchSource: ISearchSource,
inspectorAdapters: Adapters,
abortSignal?: AbortSignal
) => {
Expand Down
4 changes: 2 additions & 2 deletions src/legacy/ui/public/agg_types/param_types/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

import { AggConfigs } from '../agg_configs';
import { AggConfig } from '../../vis';
import { SearchSourceContract, FetchOptions } from '../../courier/types';
import { ISearchSource, FetchOptions } from '../../courier/types';

export class BaseParamType<TAggConfig extends AggConfig = AggConfig> {
name: string;
Expand Down Expand Up @@ -54,7 +54,7 @@ export class BaseParamType<TAggConfig extends AggConfig = AggConfig> {
*/
modifyAggConfigOnSearchRequestStart: (
aggConfig: TAggConfig,
searchSource?: SearchSourceContract,
searchSource?: ISearchSource,
options?: FetchOptions
) => void;

Expand Down
2 changes: 1 addition & 1 deletion src/legacy/ui/public/courier/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export const { defaultSearchStrategy, SearchSource } = dataStart.search;

// types
export {
SearchSourceContract,
ISearchSource,
EsQuerySortValue, // used externally by Discover
FetchOptions, // used externally by AggTypes
SortDirection, // used externally by Discover
Expand Down
2 changes: 1 addition & 1 deletion src/legacy/ui/public/courier/search_source/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
* under the License.
*/

export { SearchSource, SearchSourceContract } from '../index';
export { SearchSource, ISearchSource } from '../index';
4 changes: 2 additions & 2 deletions src/legacy/ui/public/courier/search_source/mocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@

// This mock is here for BWC, but will be left behind and replaced by
// the data service mock in the new platform.
import { SearchSourceContract } from '../index';
import { ISearchSource } from '../index';

export const searchSourceMock: MockedKeys<SearchSourceContract> = {
export const searchSourceMock: MockedKeys<ISearchSource> = {
setPreferredSearchStrategyId: jest.fn(),
setFields: jest.fn().mockReturnThis(),
setField: jest.fn().mockReturnThis(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
* under the License.
*/

export { SearchSource, SearchSourceContract } from '../index';
export { SearchSource, ISearchSource } from '../index';
2 changes: 1 addition & 1 deletion src/legacy/ui/public/courier/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
*/

export {
SearchSourceContract,
ISearchSource,
EsQuerySortValue, // used externally by Discover
FetchOptions, // used externally by AggTypes
SortDirection, // used externally by Discover
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ import { toastNotifications } from 'ui/notify';
import { AggConfig } from 'ui/vis';
import { timefilter } from 'ui/timefilter';
import { Vis } from '../../../vis';
import { SearchSource, SearchSourceContract } from '../../../courier';
import { SearchSource, ISearchSource } from '../../../courier';
import { esFilters, Query } from '../../../../../../plugins/data/public';

interface QueryGeohashBoundsParams {
filters?: esFilters.Filter[];
query?: Query;
searchSource?: SearchSourceContract;
searchSource?: ISearchSource;
}

/**
Expand Down

0 comments on commit 77dfdff

Please sign in to comment.