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

[Reporting] Remove any types and references to Hapi #49250

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
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 @@ -21,7 +21,7 @@ export interface JobDocPayloadPNG extends JobDocPayload {
basePath?: string;
browserTimezone: string;
forceNow?: string;
layout: any;
layout: LayoutInstance;
relativeUrl: string;
objects: undefined;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { resolve as resolvePath } from 'path';
import { existsSync } from 'fs';

import { chromium } from '../index';
import { BrowserType } from '../types';
import { BrowserDownload, BrowserType } from '../types';

import { md5 } from './checksum';
import { asyncMap } from './util';
Expand Down Expand Up @@ -40,15 +40,7 @@ export async function ensureAllBrowsersDownloaded() {
* @param {BrowserSpec} browsers
* @return {Promise<undefined>}
*/
async function ensureDownloaded(
browsers: Array<{
paths: {
archivesPath: string;
baseUrl: string;
packages: Array<{ archiveFilename: string; archiveChecksum: string }>;
};
}>
) {
async function ensureDownloaded(browsers: BrowserDownload[]) {
await asyncMap(browsers, async browser => {
const { archivesPath } = browser.paths;

Expand Down
3 changes: 2 additions & 1 deletion x-pack/legacy/plugins/reporting/server/browsers/install.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { LevelLogger as Logger } from '../lib/level_logger';
import { extract } from './extract';
// @ts-ignore
import { md5 } from './download/checksum';
import { BrowserDownload } from './types';

const chmod = promisify(fs.chmod);

Expand All @@ -28,7 +29,7 @@ interface PathResponse {
*/
export async function installBrowser(
logger: Logger,
browser: any,
browser: BrowserDownload,
installsPath: string
): Promise<PathResponse> {
const pkg = browser.paths.packages.find((p: Package) => p.platforms.includes(process.platform));
Expand Down
14 changes: 14 additions & 0 deletions x-pack/legacy/plugins/reporting/server/browsers/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@
*/

export type BrowserType = 'chromium';

export interface BrowserDownload {
paths: {
archivesPath: string;
baseUrl: string;
packages: Array<{
archiveChecksum: string;
archiveFilename: string;
binaryChecksum: string;
binaryRelativePath: string;
platforms: string[];
}>;
};
}
14 changes: 11 additions & 3 deletions x-pack/legacy/plugins/reporting/server/lib/create_worker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/

import { PLUGIN_ID } from '../../common/constants';
import { CancellationToken } from '../../common/cancellation_token';
import {
ESQueueInstance,
QueueConfig,
Expand All @@ -14,6 +15,7 @@ import {
JobDoc,
JobDocPayload,
JobSource,
RequestFacade,
ServerFacade,
} from '../../types';
// @ts-ignore untyped dependency
Expand All @@ -39,17 +41,23 @@ function createWorkerFn(server: ServerFacade) {
jobExecutors.set(exportType.jobType, executeJobFactory);
}

const workerFn = (job: JobSource, jobdoc: JobDocPayload | JobDoc, cancellationToken?: any) => {
const workerFn = (
job: JobSource,
arg1: JobDocPayload | JobDoc,
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe:

arg1 => job
arg2 => cancelToken?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is not a great part of the code - without Typescript, some bad design problems were hidden.

The idea is "worker functions" can come from different export types, but one export type changes the idea about what a worker function could be, that's the "immediate" execute type, which is in CSV export from Panel Action and doesn't go through job queuing. It registers a worker function that has a different signature. It'll be great to figure this out better when ESQueue goes away :)

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm going to leave this as-is because the arguments don't have a single semantic meaning

arg2: CancellationToken | RequestFacade | undefined
) => {
// pass the work to the jobExecutor
if (!jobExecutors.get(job._source.jobtype)) {
throw new Error(`Unable to find a job executor for the claimed job: [${job._id}]`);
}
// job executor function signature is different depending on whether it
// is ESQueueWorkerExecuteFn or ImmediateExecuteFn
if (job._id) {
const jobExecutor = jobExecutors.get(job._source.jobtype) as ESQueueWorkerExecuteFn;
return jobExecutor(job._id, jobdoc as JobDoc, cancellationToken);
return jobExecutor(job._id, arg1 as JobDoc, arg2 as CancellationToken);
} else {
const jobExecutor = jobExecutors.get(job._source.jobtype) as ImmediateExecuteFn;
return jobExecutor(null, jobdoc as JobDocPayload, cancellationToken);
return jobExecutor(null, arg1 as JobDocPayload, arg2 as RequestFacade);
}
};
const workerOptions = {
Expand Down
10 changes: 7 additions & 3 deletions x-pack/legacy/plugins/reporting/server/lib/validate/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,20 @@
*/

import { ServerFacade, Logger } from '../../../types';
import { HeadlessChromiumDriverFactory } from '../../browsers/chromium/driver_factory';
import { validateBrowser } from './validate_browser';
import { validateConfig } from './validate_config';
import { validateMaxContentLength } from './validate_max_content_length';

export async function runValidations(server: ServerFacade, logger: Logger, browserFactory: any) {
export async function runValidations(
server: ServerFacade,
logger: Logger,
browserFactory: HeadlessChromiumDriverFactory
) {
try {
const config = server.config();
await Promise.all([
validateBrowser(server, browserFactory, logger),
validateConfig(config, logger),
validateConfig(server, logger),
validateMaxContentLength(server, logger),
]);
logger.debug(`Reporting plugin self-check ok!`);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,19 @@
*/

import crypto from 'crypto';
import { Logger } from '../../../types';
import { ServerFacade, Logger } from '../../../types';

Copy link
Contributor

Choose a reason for hiding this comment

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

This is a tough one since it's setting and defaulting a config... I wonder if we can push this in our joi schema somehow?

EDIT: This was said with the thought that we should insulate ourselves from the server object as much as possible.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree, it is tough because we could do more here to protect the environment from bad things happening. But giving them a made-up encryptionKey on the fly does help the first-time user experience.

export function validateConfig(serverFacade: ServerFacade, logger: Logger) {
const config = serverFacade.config();

export function validateConfig(config: any, logger: Logger) {
const encryptionKey = config.get('xpack.reporting.encryptionKey');
if (encryptionKey == null) {
logger.warning(
`Generating a random key for xpack.reporting.encryptionKey. To prevent pending reports from failing on restart, please set ` +
`xpack.reporting.encryptionKey in kibana.yml`
);
config.set('xpack.reporting.encryptionKey', crypto.randomBytes(16).toString('hex'));

// @ts-ignore: No set() method on KibanaConfig, just get() and has()
config.set('xpack.reporting.encryptionKey', crypto.randomBytes(16).toString('hex')); // update config in memory to contain a usable encryption key
Copy link
Member Author

Choose a reason for hiding this comment

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

Hm, this part in particular might need a followup, if .set is not in the type because it is going away...

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
*/
import numeral from '@elastic/numeral';
import { defaults, get } from 'lodash';
import { Logger } from '../../../types';
import { Logger, ServerFacade } from '../../../types';

const KIBANA_MAX_SIZE_BYTES_PATH = 'xpack.reporting.csv.maxSizeBytes';
const ES_MAX_SIZE_BYTES_PATH = 'http.max_content_length';

export async function validateMaxContentLength(server: any, logger: Logger) {
export async function validateMaxContentLength(server: ServerFacade, logger: Logger) {
const config = server.config();
const { callWithInternalUser } = server.plugins.elasticsearch.getCluster('data');

Expand All @@ -22,7 +22,7 @@ export async function validateMaxContentLength(server: any, logger: Logger) {

const elasticSearchMaxContent = get(elasticClusterSettings, 'http.max_content_length', '100mb');
const elasticSearchMaxContentBytes = numeral().unformat(elasticSearchMaxContent.toUpperCase());
const kibanaMaxContentBytes = config.get(KIBANA_MAX_SIZE_BYTES_PATH);
const kibanaMaxContentBytes: number = config.get(KIBANA_MAX_SIZE_BYTES_PATH);

if (kibanaMaxContentBytes > elasticSearchMaxContentBytes) {
logger.warning(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,10 @@ export function registerGenerateFromJobParams(
const { exportType } = request.params;
let response;
try {
const jobParams = rison.decode(jobParamsRison);
const jobParams = rison.decode(jobParamsRison) as object | null;
if (!jobParams) {
throw new Error('missing jobParams!');
}
response = await handler(exportType, jobParams, request, h);
} catch (err) {
throw boom.badRequest(`invalid rison: ${jobParamsRison}`);
Expand Down
2 changes: 1 addition & 1 deletion x-pack/legacy/plugins/reporting/server/routes/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export function registerRoutes(server: ServerFacade, logger: Logger) {
*/
async function handler(
exportTypeId: string,
jobParams: any,
jobParams: object,
request: RequestFacade,
h: ReportingResponseToolkit
) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@

// @ts-ignore
import contentDisposition from 'content-disposition';
import * as _ from 'lodash';
import {
ServerFacade,
ExportTypeDefinition,
JobDocExecuted,
JobDocOutputExecuted,
} from '../../../types';
import { oncePerServer } from '../../lib/once_per_server';
import { CSV_JOB_TYPE } from '../../../common/constants';

Expand All @@ -16,10 +21,10 @@ interface ICustomHeaders {

const DEFAULT_TITLE = 'report';

const getTitle = (exportType: any, title?: string): string =>
const getTitle = (exportType: ExportTypeDefinition, title?: string): string =>
`${title || DEFAULT_TITLE}.${exportType.jobContentExtension}`;

const getReportingHeaders = (output: any, exportType: any) => {
const getReportingHeaders = (output: JobDocOutputExecuted, exportType: ExportTypeDefinition) => {
const metaDataHeaders: ICustomHeaders = {};

if (exportType.jobType === CSV_JOB_TYPE) {
Expand All @@ -33,20 +38,22 @@ const getReportingHeaders = (output: any, exportType: any) => {
return metaDataHeaders;
};

function getDocumentPayloadFn(server: any) {
const exportTypesRegistry = server.plugins.reporting.exportTypesRegistry;
function getDocumentPayloadFn(server: ServerFacade) {
const exportTypesRegistry = server.plugins.reporting!.exportTypesRegistry;

function encodeContent(content: string, exportType: any) {
function encodeContent(content: string | null, exportType: ExportTypeDefinition) {
switch (exportType.jobContentEncoding) {
case 'base64':
return Buffer.from(content, 'base64');
return content ? Buffer.from(content, 'base64') : content;
Copy link
Contributor

Choose a reason for hiding this comment

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

This is an interesting change, could you explain why we only do Buffer.from when it's defined (assuming the truthy check is for that)

Copy link
Member Author

Choose a reason for hiding this comment

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

It is because Buffer.from complains about null, so this may have been a bug hiding here.

default:
return content;
}
}

function getCompleted(output: any, jobType: string, title: any) {
const exportType = exportTypesRegistry.get((item: any) => item.jobType === jobType);
function getCompleted(output: JobDocOutputExecuted, jobType: string, title: string) {
const exportType = exportTypesRegistry.get(
(item: ExportTypeDefinition) => item.jobType === jobType
);
const filename = getTitle(exportType, title);
const headers = getReportingHeaders(output, exportType);

Expand All @@ -61,7 +68,7 @@ function getDocumentPayloadFn(server: any) {
};
}

function getFailure(output: any) {
function getFailure(output: JobDocOutputExecuted) {
return {
statusCode: 500,
content: {
Expand All @@ -72,19 +79,18 @@ function getDocumentPayloadFn(server: any) {
};
}

function getIncomplete(status: any) {
function getIncomplete(status: string) {
return {
statusCode: 503,
content: status,
contentType: 'application/json',
headers: {
'retry-after': 30,
},
headers: { 'retry-after': 30 },
};
}

return function getDocumentPayload(doc: any) {
const { status, output, jobtype: jobType, payload: { title } = { title: '' } } = doc._source;
return function getDocumentPayload(doc: { _source: JobDocExecuted }) {
const { status, jobtype: jobType, payload: { title } = { title: '' } } = doc._source;
const { output } = doc._source as { output: JobDocOutputExecuted };

if (status === 'completed') {
return getCompleted(output, jobType, title);
Expand Down
6 changes: 3 additions & 3 deletions x-pack/legacy/plugins/reporting/server/routes/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
import { RequestFacade, ReportingResponseToolkit, JobDocPayload } from '../../types';

export type HandlerFunction = (
exportType: any,
jobParams: any,
exportType: string,
jobParams: object,
request: RequestFacade,
h: ReportingResponseToolkit
) => any;

export type HandlerErrorFunction = (exportType: any, err: Error) => any;
export type HandlerErrorFunction = (exportType: string, err: Error) => any;

export interface QueuedJobPayload {
error?: boolean;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

import { uniq } from 'lodash';
import { CSV_JOB_TYPE, PDF_JOB_TYPE, PNG_JOB_TYPE } from '../../common/constants';
import { AvailableTotal, FeatureAvailabilityMap, RangeStats, ExportType } from './';
import { AvailableTotal, FeatureAvailabilityMap, RangeStats, ExportType } from './types';

function getForFeature(
range: Partial<RangeStats>,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/

import { get } from 'lodash';
import { ServerFacade, ESCallCluster } from '../../types';
import {
AggregationBuckets,
AggregationResults,
Expand All @@ -13,8 +14,7 @@ import {
KeyCountBucket,
RangeAggregationResults,
RangeStats,
UsageObject,
} from './';
} from './types';
import { decorateRangeStats } from './decorate_range_stats';
// @ts-ignore untyped module
import { getExportTypesHandler } from './get_export_type_handler';
Expand Down Expand Up @@ -77,7 +77,10 @@ type RangeStatSets = Partial<
last7Days: RangeStats;
}
>;
async function handleResponse(server: any, response: AggregationResults): Promise<RangeStatSets> {
async function handleResponse(
server: ServerFacade,
response: AggregationResults
): Promise<RangeStatSets> {
const buckets = get(response, 'aggregations.ranges.buckets');
if (!buckets) {
return {};
Expand All @@ -95,7 +98,7 @@ async function handleResponse(server: any, response: AggregationResults): Promis
};
}

export async function getReportingUsage(server: any, callCluster: any) {
export async function getReportingUsage(server: ServerFacade, callCluster: ESCallCluster) {
const config = server.config();
const reportingIndex = config.get('xpack.reporting.index');

Expand Down Expand Up @@ -132,7 +135,7 @@ export async function getReportingUsage(server: any, callCluster: any) {

return callCluster('search', params)
.then((response: AggregationResults) => handleResponse(server, response))
.then(async (usage: UsageObject) => {
.then(async (usage: RangeStatSets) => {
// Allow this to explicitly throw an exception if/when this config is deprecated,
// because we shouldn't collect browserType in that case!
const browserType = config.get('xpack.reporting.capture.browser.type');
Expand Down
Loading