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

[7.15] [Reporting/Discover/Search Sessions] Only use relative time filter when generating share data (#112588) #112737

Merged
merged 4 commits into from
Sep 22, 2021
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 @@ -112,7 +112,7 @@ export const getTopNavLinks = ({
const sharingData = await getSharingData(
searchSource,
state.appStateContainer.getState(),
services.uiSettings
services
);

services.share.toggleShareContextMenu({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,37 @@
*/

import { Capabilities, IUiSettingsClient } from 'kibana/public';
import { IndexPattern } from 'src/plugins/data/public';
import type { IndexPattern } from 'src/plugins/data/public';
import type { DiscoverServices } from '../../../../build_services';
import { dataPluginMock } from '../../../../../../data/public/mocks';
import { createSearchSourceMock } from '../../../../../../data/common/search/search_source/mocks';
import { DOC_HIDE_TIME_COLUMN_SETTING, SORT_DEFAULT_ORDER_SETTING } from '../../../../../common';
import { indexPatternMock } from '../../../../__mocks__/index_pattern';
import { getSharingData, showPublicUrlSwitch } from './get_sharing_data';

describe('getSharingData', () => {
let mockConfig: IUiSettingsClient;
let services: DiscoverServices;

beforeEach(() => {
mockConfig = ({
get: (key: string) => {
if (key === SORT_DEFAULT_ORDER_SETTING) {
return 'desc';
}
if (key === DOC_HIDE_TIME_COLUMN_SETTING) {
services = {
data: dataPluginMock.createStartContract(),
uiSettings: {
get: (key: string) => {
if (key === SORT_DEFAULT_ORDER_SETTING) {
return 'desc';
}
if (key === DOC_HIDE_TIME_COLUMN_SETTING) {
return false;
}
return false;
}
return false;
},
},
} as unknown) as IUiSettingsClient;
} as DiscoverServices;
});

test('returns valid data for sharing', async () => {
const searchSourceMock = createSearchSourceMock({ index: indexPatternMock });
const result = await getSharingData(searchSourceMock, { columns: [] }, mockConfig);
const result = await getSharingData(searchSourceMock, { columns: [] }, services);
expect(result).toMatchInlineSnapshot(`
Object {
"columns": Array [],
Expand All @@ -53,7 +58,7 @@ describe('getSharingData', () => {
const result = await getSharingData(
searchSourceMock,
{ columns: ['column_a', 'column_b'] },
mockConfig
services
);
expect(result).toMatchInlineSnapshot(`
Object {
Expand Down Expand Up @@ -90,7 +95,7 @@ describe('getSharingData', () => {
'cool-field-6',
],
},
mockConfig
services
);
expect(result).toMatchInlineSnapshot(`
Object {
Expand All @@ -116,7 +121,7 @@ describe('getSharingData', () => {
});

test('fields conditionally do not have prepended timeField', async () => {
mockConfig = ({
services.uiSettings = ({
get: (key: string) => {
if (key === DOC_HIDE_TIME_COLUMN_SETTING) {
return true;
Expand All @@ -141,7 +146,7 @@ describe('getSharingData', () => {
'cool-field-6',
],
},
mockConfig
services
);
expect(result).toMatchInlineSnapshot(`
Object {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@
* Side Public License, v 1.
*/

import type { Capabilities, IUiSettingsClient } from 'kibana/public';
import { ISearchSource } from '../../../../../../data/common';
import type { Capabilities } from 'kibana/public';
import type { IUiSettingsClient } from 'src/core/public';
import type { DataPublicPluginStart } from 'src/plugins/data/public';
import type { ISearchSource } from 'src/plugins/data/common';
import { DOC_HIDE_TIME_COLUMN_SETTING, SORT_DEFAULT_ORDER_SETTING } from '../../../../../common';
import type { SavedSearch, SortOrder } from '../../../../saved_searches/types';
import { getSortForSearchSource } from '../components/doc_table';
Expand All @@ -19,15 +21,18 @@ import { AppState } from '../services/discover_state';
export async function getSharingData(
currentSearchSource: ISearchSource,
state: AppState | SavedSearch,
config: IUiSettingsClient
services: { uiSettings: IUiSettingsClient; data: DataPublicPluginStart }
) {
const { uiSettings: config, data } = services;
const searchSource = currentSearchSource.createCopy();
const index = searchSource.getField('index')!;

searchSource.setField(
'sort',
getSortForSearchSource(state.sort as SortOrder[], index, config.get(SORT_DEFAULT_ORDER_SETTING))
);
// When sharing externally we preserve relative time values
searchSource.setField('filter', data.query.timefilter.timefilter.createRelativeFilter(index));
searchSource.removeField('highlight');
searchSource.removeField('highlightAll');
searchSource.removeField('aggs');
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,8 @@ export function updateSearchSource(

// this is not the default index pattern, it determines that it's not of type rollup
if (indexPatternsUtils.isDefault(indexPattern)) {
searchSource.setField(
'filter',
data.query.timefilter.timefilter.createRelativeFilter(indexPattern)
);
// Set the date range filter fields from timeFilter using the absolute format. Search sessions requires that it be converted from a relative range
searchSource.setField('filter', data.query.timefilter.timefilter.createFilter(indexPattern));
}

if (useNewFieldsApi) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@ import * as Rx from 'rxjs';
import { first } from 'rxjs/operators';
import { CoreStart } from 'src/core/public';
import { coreMock } from '../../../../../src/core/public/mocks';
import { LicensingPluginSetup } from '../../../licensing/public';
import { dataPluginMock } from '../../../../../src/plugins/data/public/mocks';
import type { LicensingPluginSetup } from '../../../licensing/public';
import { ReportingAPIClient } from '../lib/reporting_api_client';
import type { ReportingPublicPluginStartDendencies } from '../plugin';
import { ReportingCsvPanelAction } from './get_csv_panel_action';

type LicenseResults = 'valid' | 'invalid' | 'unavailable' | 'expired';
Expand All @@ -22,8 +24,8 @@ describe('GetCsvReportPanelAction', () => {
let context: any;
let mockLicense$: any;
let mockSearchSource: any;
let mockStartServicesPayload: [CoreStart, object, unknown];
let mockStartServices$: Rx.Subject<typeof mockStartServicesPayload>;
let mockStartServicesPayload: [CoreStart, ReportingPublicPluginStartDendencies, unknown];
let mockStartServices$: Rx.Observable<typeof mockStartServicesPayload>;

beforeAll(() => {
if (typeof window.URL.revokeObjectURL === 'undefined') {
Expand All @@ -45,14 +47,17 @@ describe('GetCsvReportPanelAction', () => {
}) as unknown) as LicensingPluginSetup['license$'];
};

mockStartServices$ = new Rx.Subject<[CoreStart, object, unknown]>();
mockStartServicesPayload = [
({
...core,
application: { capabilities: { dashboard: { downloadCsv: true } } },
} as unknown) as CoreStart,
{},
{
data: dataPluginMock.createStartContract(),
} as ReportingPublicPluginStartDendencies,
null,
];
mockStartServices$ = Rx.from(Promise.resolve(mockStartServicesPayload));

mockSearchSource = {
createCopy: () => mockSearchSource,
Expand Down Expand Up @@ -90,7 +95,7 @@ describe('GetCsvReportPanelAction', () => {
usesUiCapabilities: true,
});

mockStartServices$.next(mockStartServicesPayload);
await mockStartServices$.pipe(first()).toPromise();

await panel.execute(context);

Expand Down Expand Up @@ -127,7 +132,7 @@ describe('GetCsvReportPanelAction', () => {
usesUiCapabilities: true,
});

mockStartServices$.next(mockStartServicesPayload);
await mockStartServices$.pipe(first()).toPromise();

await panel.execute(context);

Expand All @@ -150,7 +155,7 @@ describe('GetCsvReportPanelAction', () => {
usesUiCapabilities: true,
});

mockStartServices$.next(mockStartServicesPayload);
await mockStartServices$.pipe(first()).toPromise();

await panel.execute(context);

Expand All @@ -166,7 +171,7 @@ describe('GetCsvReportPanelAction', () => {
usesUiCapabilities: true,
});

mockStartServices$.next(mockStartServicesPayload);
await mockStartServices$.pipe(first()).toPromise();

await panel.execute(context);

Expand All @@ -184,7 +189,7 @@ describe('GetCsvReportPanelAction', () => {
usesUiCapabilities: true,
});

mockStartServices$.next(mockStartServicesPayload);
await mockStartServices$.pipe(first()).toPromise();

await panel.execute(context);

Expand All @@ -201,14 +206,14 @@ describe('GetCsvReportPanelAction', () => {
usesUiCapabilities: true,
});

mockStartServices$.next(mockStartServicesPayload);
await mockStartServices$.pipe(first()).toPromise();

await licenseMock$.pipe(first()).toPromise();

expect(await plugin.isCompatible(context)).toEqual(false);
});

it('sets a display and icon type', () => {
it('sets a display and icon type', async () => {
const panel = new ReportingCsvPanelAction({
core,
apiClient,
Expand All @@ -217,33 +222,36 @@ describe('GetCsvReportPanelAction', () => {
usesUiCapabilities: true,
});

mockStartServices$.next(mockStartServicesPayload);
await mockStartServices$.pipe(first()).toPromise();

expect(panel.getIconType()).toMatchInlineSnapshot(`"document"`);
expect(panel.getDisplayName()).toMatchInlineSnapshot(`"Download CSV"`);
});

describe('Application UI Capabilities', () => {
it(`doesn't allow downloads when UI capability is not enabled`, async () => {
mockStartServicesPayload = [
({ application: { capabilities: {} } } as unknown) as CoreStart,
{
data: dataPluginMock.createStartContract(),
} as ReportingPublicPluginStartDendencies,
null,
];
const startServices$ = Rx.from(Promise.resolve(mockStartServicesPayload));
const plugin = new ReportingCsvPanelAction({
core,
apiClient,
license$: mockLicense$(),
startServices$: mockStartServices$,
startServices$,
usesUiCapabilities: true,
});

mockStartServices$.next([
({ application: { capabilities: {} } } as unknown) as CoreStart,
{},
null,
]);
await startServices$.pipe(first()).toPromise();

expect(await plugin.isCompatible(context)).toEqual(false);
});

it(`allows downloads when license is valid and UI capability is enabled`, async () => {
mockStartServices$ = new Rx.Subject();
const plugin = new ReportingCsvPanelAction({
core,
apiClient,
Expand All @@ -252,7 +260,7 @@ describe('GetCsvReportPanelAction', () => {
usesUiCapabilities: true,
});

mockStartServices$.next(mockStartServicesPayload);
await mockStartServices$.pipe(first()).toPromise();

expect(await plugin.isCompatible(context)).toEqual(true);
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

import { i18n } from '@kbn/i18n';
import * as Rx from 'rxjs';
import type { CoreSetup, IUiSettingsClient, NotificationsSetup } from 'src/core/public';
import { first } from 'rxjs/operators';
import type { CoreSetup, NotificationsSetup } from 'src/core/public';
import { CoreStart } from 'src/core/public';
import type { ISearchEmbeddable, SavedSearch } from '../../../../../src/plugins/discover/public';
import {
Expand All @@ -22,6 +23,7 @@ import type { LicensingPluginSetup } from '../../../licensing/public';
import { CSV_REPORTING_ACTION } from '../../common/constants';
import { checkLicense } from '../lib/license_check';
import { ReportingAPIClient } from '../lib/reporting_api_client';
import type { ReportingPublicPluginStartDendencies } from '../plugin';

function isSavedSearchEmbeddable(
embeddable: IEmbeddable | ISearchEmbeddable
Expand All @@ -36,7 +38,7 @@ interface ActionContext {
interface Params {
apiClient: ReportingAPIClient;
core: CoreSetup;
startServices$: Rx.Observable<[CoreStart, object, unknown]>;
startServices$: Rx.Observable<[CoreStart, ReportingPublicPluginStartDendencies, unknown]>;
license$: LicensingPluginSetup['license$'];
usesUiCapabilities: boolean;
}
Expand All @@ -47,16 +49,16 @@ export class ReportingCsvPanelAction implements ActionDefinition<ActionContext>
public readonly id = CSV_REPORTING_ACTION;
private licenseHasDownloadCsv: boolean = false;
private capabilityHasDownloadCsv: boolean = false;
private uiSettings: IUiSettingsClient;
private notifications: NotificationsSetup;
private apiClient: ReportingAPIClient;
private startServices$: Params['startServices$'];

constructor({ core, startServices$, license$, usesUiCapabilities, apiClient }: Params) {
this.isDownloading = false;

this.uiSettings = core.uiSettings;
this.notifications = core.notifications;
this.apiClient = apiClient;
this.startServices$ = startServices$;

license$.subscribe((license) => {
const results = license.check('reporting', 'basic');
Expand All @@ -65,7 +67,7 @@ export class ReportingCsvPanelAction implements ActionDefinition<ActionContext>
});

if (usesUiCapabilities) {
startServices$.subscribe(([{ application }]) => {
this.startServices$.subscribe(([{ application }]) => {
this.capabilityHasDownloadCsv = application.capabilities.dashboard?.downloadCsv === true;
});
} else {
Expand All @@ -84,11 +86,12 @@ export class ReportingCsvPanelAction implements ActionDefinition<ActionContext>
}

public async getSearchSource(savedSearch: SavedSearch, embeddable: ISearchEmbeddable) {
const [{ uiSettings }, { data }] = await this.startServices$.pipe(first()).toPromise();
const { getSharingData } = await loadSharingDataHelpers();
return await getSharingData(
savedSearch.searchSource,
savedSearch, // TODO: get unsaved state (using embeddale.searchScope): https://github.com/elastic/kibana/issues/43977
this.uiSettings
savedSearch, // TODO: get unsaved state (using embeddable.searchScope): https://github.com/elastic/kibana/issues/43977
{ uiSettings, data }
);
}

Expand Down
7 changes: 6 additions & 1 deletion x-pack/plugins/reporting/public/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import { i18n } from '@kbn/i18n';
import * as Rx from 'rxjs';
import { catchError, filter, map, mergeMap, takeUntil } from 'rxjs/operators';
import type { DataPublicPluginStart } from 'src/plugins/data/public';
import {
CoreSetup,
CoreStart,
Expand Down Expand Up @@ -77,6 +78,7 @@ export interface ReportingPublicPluginSetupDendencies {

export interface ReportingPublicPluginStartDendencies {
home: HomePublicPluginStart;
data: DataPublicPluginStart;
management: ManagementStart;
licensing: LicensingPluginStart;
uiActions: UiActionsStart;
Expand Down Expand Up @@ -134,7 +136,10 @@ export class ReportingPublicPlugin
return this.contract;
}

public setup(core: CoreSetup, setupDeps: ReportingPublicPluginSetupDendencies) {
public setup(
core: CoreSetup<ReportingPublicPluginStartDendencies>,
setupDeps: ReportingPublicPluginSetupDendencies
) {
const { getStartServices, uiSettings } = core;
const {
home,
Expand Down
Loading