Skip to content

[Reporting] Use ES plugin from NP #56209

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

Merged
merged 16 commits into from
Jan 31, 2020
Merged

[Reporting] Use ES plugin from NP #56209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
7b8cdb2
[Reporting] Use ES plugin from NP
tsullivan Jan 28, 2020
a1f95bc
fix elasticsearchErrors reference
tsullivan Jan 28, 2020
7c529b5
Merge branch 'master' into reporting/np-server-upgrade-elasticsearch-dep
tsullivan Jan 28, 2020
a5eef5b
fix mocha test
tsullivan Jan 28, 2020
5cd44fd
convert to jest
tsullivan Jan 28, 2020
b7f4ad6
Merge branch 'master' into reporting/np-server-upgrade-elasticsearch-dep
elasticmachine Jan 29, 2020
c1ef352
Merge branch 'master' into reporting/np-server-upgrade-elasticsearch-dep
tsullivan Jan 29, 2020
83e6dd1
fix the code and tests
tsullivan Jan 29, 2020
f68ffa6
cosmetics
tsullivan Jan 29, 2020
e60cebe
fix mocha tests
tsullivan Jan 29, 2020
1d7fc29
fix imports
tsullivan Jan 29, 2020
bf5ebbc
Merge branch 'master' into reporting/np-server-upgrade-elasticsearch-dep
tsullivan Jan 29, 2020
d2dc904
fix mocha tests
tsullivan Jan 29, 2020
9398e43
fix jest
tsullivan Jan 29, 2020
9e8bb6f
simplify
tsullivan Jan 30, 2020
f4baa0c
Merge branch 'master' into reporting/np-server-upgrade-elasticsearch-dep
elasticmachine Jan 30, 2020
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
272 changes: 136 additions & 136 deletions x-pack/legacy/plugins/reporting/export_types/csv/server/execute_job.test.js
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 11 additions & 4 deletions x-pack/legacy/plugins/reporting/export_types/csv/server/execute_job.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
* you may not use this file except in compliance with the Elastic License.
*/

import Hapi from 'hapi';
import { i18n } from '@kbn/i18n';
import { KibanaRequest } from '../../../../../../../src/core/server';
import { ElasticsearchServiceSetup, KibanaRequest } from '../../../../../../../src/core/server';
import { CSV_JOB_TYPE } from '../../../common/constants';
import { cryptoFactory } from '../../../server/lib';
import { ESQueueWorkerExecuteFn, ExecuteJobFactory, Logger, ServerFacade } from '../../../types';
Expand All @@ -15,8 +16,11 @@ import { createGenerateCsv } from './lib/generate_csv';

export const executeJobFactory: ExecuteJobFactory<ESQueueWorkerExecuteFn<
JobDocPayloadDiscoverCsv
>> = function executeJobFactoryFn(server: ServerFacade, parentLogger: Logger) {
const { callWithRequest } = server.plugins.elasticsearch.getCluster('data');
>> = function executeJobFactoryFn(
server: ServerFacade,
elasticsearch: ElasticsearchServiceSetup,
parentLogger: Logger
) {
const crypto = cryptoFactory(server);
const config = server.config();
const logger = parentLogger.clone([CSV_JOB_TYPE, 'execute-job']);
Expand Down Expand Up @@ -74,8 +78,11 @@ export const executeJobFactory: ExecuteJobFactory<ESQueueWorkerExecuteFn<
},
};

const { callAsCurrentUser } = elasticsearch.dataClient.asScoped(
KibanaRequest.from(fakeRequest as Hapi.Request)
);
const callEndpoint = (endpoint: string, clientParams = {}, options = {}) => {
return callWithRequest(fakeRequest, endpoint, clientParams, options);
return callAsCurrentUser(endpoint, clientParams, options);
};
const savedObjects = server.savedObjects;
const savedObjectsClient = savedObjects.getScopedSavedObjectsClient(
Expand Down
15 changes: 10 additions & 5 deletions ...egacy/plugins/reporting/export_types/csv_from_savedobject/server/create_job/create_job.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,25 @@

import { notFound, notImplemented } from 'boom';
import { get } from 'lodash';
import { ElasticsearchServiceSetup } from 'kibana/server';
import { CSV_FROM_SAVEDOBJECT_JOB_TYPE } from '../../../../common/constants';
import { cryptoFactory } from '../../../../server/lib';
import {
CreateJobFactory,
ImmediateCreateJobFn,
ServerFacade,
RequestFacade,
Logger,
RequestFacade,
ServerFacade,
} from '../../../../types';
import {
JobDocPayloadPanelCsv,
JobParamsPanelCsv,
SavedObject,
SavedObjectServiceError,
SavedSearchObjectAttributesJSON,
SearchPanel,
TimeRangeParams,
VisObjectAttributesJSON,
JobDocPayloadPanelCsv,
JobParamsPanelCsv,
} from '../../types';
import { createJobSearch } from './create_job_search';

Expand All @@ -35,7 +36,11 @@ interface VisData {

export const createJobFactory: CreateJobFactory<ImmediateCreateJobFn<
JobParamsPanelCsv
>> = function createJobFactoryFn(server: ServerFacade, parentLogger: Logger) {
>> = function createJobFactoryFn(
server: ServerFacade,
elasticsearch: ElasticsearchServiceSetup,
parentLogger: Logger
) {
const crypto = cryptoFactory(server);
const logger = parentLogger.clone([CSV_FROM_SAVEDOBJECT_JOB_TYPE, 'create-job']);

Expand Down
8 changes: 7 additions & 1 deletion x-pack/legacy/plugins/reporting/export_types/csv_from_savedobject/server/execute_job.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/

import { i18n } from '@kbn/i18n';
import { ElasticsearchServiceSetup } from 'kibana/server';
import { CONTENT_TYPE_CSV, CSV_FROM_SAVEDOBJECT_JOB_TYPE } from '../../../common/constants';
import { cryptoFactory } from '../../../server/lib';
import {
Expand All @@ -21,7 +22,11 @@ import { createGenerateCsv } from './lib';

export const executeJobFactory: ExecuteJobFactory<ImmediateExecuteFn<
JobParamsPanelCsv
>> = function executeJobFactoryFn(server: ServerFacade, parentLogger: Logger) {
>> = function executeJobFactoryFn(
server: ServerFacade,
elasticsearch: ElasticsearchServiceSetup,
parentLogger: Logger
) {
const crypto = cryptoFactory(server);
const logger = parentLogger.clone([CSV_FROM_SAVEDOBJECT_JOB_TYPE, 'execute-job']);

Expand Down Expand Up @@ -85,6 +90,7 @@ export const executeJobFactory: ExecuteJobFactory<ImmediateExecuteFn<
const generateResults: CsvResultFromSearch = await generateCsv(
requestObject,
server,
elasticsearch,
visType as string,
panel,
jobParams
Expand Down
3 changes: 3 additions & 0 deletions x-pack/legacy/plugins/reporting/export_types/csv_from_savedobject/server/lib/generate_csv.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/

import { badRequest } from 'boom';
import { ElasticsearchServiceSetup } from 'kibana/server';
import { ServerFacade, RequestFacade, Logger } from '../../../../types';
import { SearchPanel, VisPanel, JobParamsPanelCsv, FakeRequest } from '../../types';
import { generateCsvSearch } from './generate_csv_search';
Expand All @@ -13,6 +14,7 @@ export function createGenerateCsv(logger: Logger) {
return async function generateCsv(
request: RequestFacade | FakeRequest,
server: ServerFacade,
elasticsearch: ElasticsearchServiceSetup,
visType: string,
panel: VisPanel | SearchPanel,
jobParams: JobParamsPanelCsv
Expand All @@ -27,6 +29,7 @@ export function createGenerateCsv(logger: Logger) {
return await generateCsvSearch(
request as RequestFacade,
server,
elasticsearch,
logger,
panel as SearchPanel,
jobParams
Expand Down
11 changes: 7 additions & 4 deletions ...acy/plugins/reporting/export_types/csv_from_savedobject/server/lib/generate_csv_search.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
* you may not use this file except in compliance with the Elastic License.
*/

// eslint-disable-next-line @kbn/eslint/no-restricted-paths
import { KibanaRequest } from '../../../../../../../../src/core/server';
import { ElasticsearchServiceSetup, KibanaRequest } from '../../../../../../../../src/core/server';
import { createGenerateCsv } from '../../../csv/server/lib/generate_csv';
import { CancellationToken } from '../../../../common/cancellation_token';
import { ServerFacade, RequestFacade, Logger } from '../../../../types';
Expand Down Expand Up @@ -58,6 +57,7 @@ const getUiSettings = async (config: any) => {
export async function generateCsvSearch(
req: RequestFacade,
server: ServerFacade,
elasticsearch: ElasticsearchServiceSetup,
logger: Logger,
searchPanel: SearchPanel,
jobParams: JobParamsDiscoverCsv
Expand Down Expand Up @@ -152,8 +152,11 @@ export async function generateCsvSearch(
sort: sortConfig,
},
};
const { callWithRequest } = server.plugins.elasticsearch.getCluster('data');
const callCluster = (...params: [string, object]) => callWithRequest(req, ...params);

const { callAsCurrentUser } = elasticsearch.dataClient.asScoped(
KibanaRequest.from(req.getRawRequest())
);
const callCluster = (...params: [string, object]) => callAsCurrentUser(...params);
const config = server.config();
const uiSettings = await getUiSettings(uiConfig);

Expand Down
27 changes: 15 additions & 12 deletions x-pack/legacy/plugins/reporting/export_types/png/server/execute_job/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,6 @@ beforeEach(() => {
info: {
protocol: 'http',
},
plugins: {
elasticsearch: {
getCluster: memoize(() => {
return {
callWithRequest: jest.fn(),
};
}),
},
},
savedObjects: {
getScopedSavedObjectsClient: jest.fn(),
},
Expand All @@ -57,6 +48,12 @@ beforeEach(() => {

afterEach(() => generatePngObservableFactory.mockReset());

const mockElasticsearch = {
dataClient: {
asScoped: () => ({ callAsCurrentUser: jest.fn() }),
},
};

Comment on lines +51 to +56
Copy link
Contributor

@pgayvallet pgayvallet Jan 31, 2020

Choose a reason for hiding this comment

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

It's recommended to use the provided mocks when mocking core services. (multiple occurences, will comment only once)

import { elasticsearchServiceMock } from '[..]/src/core/server/mocks';

const mockElasticsearch = elasticsearchServiceMock.createSetupContractMock()

const getMockLogger = () => new LevelLogger();

const encryptHeaders = async headers => {
Expand All @@ -70,7 +67,9 @@ test(`passes browserTimezone to generatePng`, async () => {
const generatePngObservable = generatePngObservableFactory();
generatePngObservable.mockReturnValue(Rx.of(Buffer.from('')));

const executeJob = executeJobFactory(mockServer, getMockLogger(), { browserDriverFactory: {} });
const executeJob = executeJobFactory(mockServer, mockElasticsearch, getMockLogger(), {
browserDriverFactory: {},
});
const browserTimezone = 'UTC';
await executeJob(
'pngJobId',
Expand All @@ -88,7 +87,9 @@ test(`passes browserTimezone to generatePng`, async () => {
});

test(`returns content_type of application/png`, async () => {
const executeJob = executeJobFactory(mockServer, getMockLogger(), { browserDriverFactory: {} });
const executeJob = executeJobFactory(mockServer, mockElasticsearch, getMockLogger(), {
browserDriverFactory: {},
});
const encryptedHeaders = await encryptHeaders({});

const generatePngObservable = generatePngObservableFactory();
Expand All @@ -108,7 +109,9 @@ test(`returns content of generatePng getBuffer base64 encoded`, async () => {
const generatePngObservable = generatePngObservableFactory();
generatePngObservable.mockReturnValue(Rx.of(Buffer.from(testContent)));

const executeJob = executeJobFactory(mockServer, getMockLogger(), { browserDriverFactory: {} });
const executeJob = executeJobFactory(mockServer, mockElasticsearch, getMockLogger(), {
browserDriverFactory: {},
});
const encryptedHeaders = await encryptHeaders({});
const { content } = await executeJob(
'pngJobId',
Expand Down
2 changes: 2 additions & 0 deletions x-pack/legacy/plugins/reporting/export_types/png/server/execute_job/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/

import * as Rx from 'rxjs';
import { ElasticsearchServiceSetup } from 'kibana/server';
import { catchError, map, mergeMap, takeUntil } from 'rxjs/operators';
import { PNG_JOB_TYPE } from '../../../../common/constants';
import {
Expand All @@ -27,6 +28,7 @@ type QueuedPngExecutorFactory = ExecuteJobFactory<ESQueueWorkerExecuteFn<JobDocP

export const executeJobFactory: QueuedPngExecutorFactory = function executeJobFactoryFn(
server: ServerFacade,
elasticsearch: ElasticsearchServiceSetup,
parentLogger: Logger,
{ browserDriverFactory }: { browserDriverFactory: HeadlessChromiumDriverFactory }
) {
Expand Down
26 changes: 14 additions & 12 deletions x-pack/legacy/plugins/reporting/export_types/printable_pdf/server/execute_job/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,6 @@ beforeEach(() => {
info: {
protocol: 'http',
},
plugins: {
elasticsearch: {
getCluster: memoize(() => {
return {
callWithRequest: jest.fn(),
};
}),
},
},
savedObjects: {
getScopedSavedObjectsClient: jest.fn(),
},
Expand All @@ -58,6 +49,11 @@ beforeEach(() => {
afterEach(() => generatePdfObservableFactory.mockReset());

const getMockLogger = () => new LevelLogger();
const mockElasticsearch = {
dataClient: {
asScoped: () => ({ callAsCurrentUser: jest.fn() }),
},
};

const encryptHeaders = async headers => {
const crypto = cryptoFactory(mockServer);
Expand All @@ -70,7 +66,9 @@ test(`passes browserTimezone to generatePdf`, async () => {
const generatePdfObservable = generatePdfObservableFactory();
generatePdfObservable.mockReturnValue(Rx.of(Buffer.from('')));

const executeJob = executeJobFactory(mockServer, getMockLogger(), { browserDriverFactory: {} });
const executeJob = executeJobFactory(mockServer, mockElasticsearch, getMockLogger(), {
browserDriverFactory: {},
});
const browserTimezone = 'UTC';
await executeJob(
'pdfJobId',
Expand All @@ -91,7 +89,9 @@ test(`passes browserTimezone to generatePdf`, async () => {
});

test(`returns content_type of application/pdf`, async () => {
const executeJob = executeJobFactory(mockServer, getMockLogger(), { browserDriverFactory: {} });
const executeJob = executeJobFactory(mockServer, mockElasticsearch, getMockLogger(), {
browserDriverFactory: {},
});
const encryptedHeaders = await encryptHeaders({});

const generatePdfObservable = generatePdfObservableFactory();
Expand All @@ -111,7 +111,9 @@ test(`returns content of generatePdf getBuffer base64 encoded`, async () => {
const generatePdfObservable = generatePdfObservableFactory();
generatePdfObservable.mockReturnValue(Rx.of(Buffer.from(testContent)));

const executeJob = executeJobFactory(mockServer, getMockLogger(), { browserDriverFactory: {} });
const executeJob = executeJobFactory(mockServer, mockElasticsearch, getMockLogger(), {
browserDriverFactory: {},
});
const encryptedHeaders = await encryptHeaders({});
const { content } = await executeJob(
'pdfJobId',
Expand Down
2 changes: 2 additions & 0 deletions x-pack/legacy/plugins/reporting/export_types/printable_pdf/server/execute_job/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/

import * as Rx from 'rxjs';
import { ElasticsearchServiceSetup } from 'kibana/server';
import { catchError, map, mergeMap, takeUntil } from 'rxjs/operators';
Comment on lines 7 to 9
Copy link
Contributor

@pgayvallet pgayvallet Jan 31, 2020

Choose a reason for hiding this comment

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

NIT: kibana/server import should probably be after node modules imports

import {
ServerFacade,
Expand All @@ -28,6 +29,7 @@ type QueuedPdfExecutorFactory = ExecuteJobFactory<ESQueueWorkerExecuteFn<JobDocP

export const executeJobFactory: QueuedPdfExecutorFactory = function executeJobFactoryFn(
server: ServerFacade,
elasticsearch: ElasticsearchServiceSetup,
parentLogger: Logger,
{ browserDriverFactory }: { browserDriverFactory: HeadlessChromiumDriverFactory }
) {
Expand Down
29 changes: 12 additions & 17 deletions x-pack/legacy/plugins/reporting/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,7 @@ import { PluginStart as DataPluginStart } from '../../../../src/plugins/data/ser
import { PluginSetupContract as SecurityPluginSetup } from '../../../plugins/security/server';
import { PLUGIN_ID, UI_SETTINGS_CUSTOM_PDF_LOGO } from './common/constants';
import { config as reportingConfig } from './config';
import {
LegacySetup,
ReportingPlugin,
reportingPluginFactory,
ReportingSetupDeps,
} from './server/plugin';
import { LegacySetup, ReportingPlugin, reportingPluginFactory } from './server/plugin';
import { ReportingConfigOptions, ReportingPluginSpecOptions } from './types.d';

const kbToBase64Length = (kb: number) => {
Expand Down Expand Up @@ -74,10 +69,6 @@ export const reporting = (kibana: any) => {

async init(server: Legacy.Server) {
const coreSetup = server.newPlatform.setup.core;
const pluginsSetup: ReportingSetupDeps = {
security: server.newPlatform.setup.plugins.security as SecurityPluginSetup,
usageCollection: server.newPlatform.setup.plugins.usageCollection,
};

const fieldFormatServiceFactory = async (uiSettings: IUiSettingsClient) => {
const [, plugins] = await coreSetup.getStartServices();
Expand All @@ -90,18 +81,22 @@ export const reporting = (kibana: any) => {
config: server.config,
info: server.info,
route: server.route.bind(server),
plugins: {
elasticsearch: server.plugins.elasticsearch,
xpack_main: server.plugins.xpack_main,
},
plugins: { xpack_main: server.plugins.xpack_main },
savedObjects: server.savedObjects,
fieldFormatServiceFactory,
uiSettingsServiceFactory: server.uiSettingsServiceFactory,
};

const initializerContext = server.newPlatform.coreContext;
const plugin: ReportingPlugin = reportingPluginFactory(initializerContext, __LEGACY, this);
await plugin.setup(coreSetup, pluginsSetup);
const plugin: ReportingPlugin = reportingPluginFactory(
server.newPlatform.coreContext,
__LEGACY,
this
);
await plugin.setup(coreSetup, {
elasticsearch: coreSetup.elasticsearch,
security: server.newPlatform.setup.plugins.security as SecurityPluginSetup,
usageCollection: server.newPlatform.setup.plugins.usageCollection,
});
Comment on lines +95 to +99
Copy link
Contributor

@pgayvallet pgayvallet Jan 31, 2020

Choose a reason for hiding this comment

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

Redundant parameters: elasticsearch is already provided by coreSetup, elasticsearch: coreSetup.elasticsearch, seems unnecessary.

Copy link
Member Author

@tsullivan tsullivan Jan 31, 2020

Choose a reason for hiding this comment

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

The params are forced to fit the ReportingStartDeps interface, which is used all over the place to pull the ES service. Unfortunately it seems to make better sense to keep it this way, but I could see it changing later on.

},

deprecations({ unused }: any) {
Expand Down
Loading