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

Adding in browser info to the report-info drawer #26307

Merged
merged 3 commits into from
Dec 4, 2018
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
5 changes: 5 additions & 0 deletions x-pack/plugins/reporting/common/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,8 @@ export const UI_SETTINGS_CUSTOM_PDF_LOGO = 'xpackReporting:customPdfLogo';
* @type {string}
*/
export const KIBANA_REPORTING_TYPE = 'reporting';

export const PDF_JOB_TYPE = 'printable_pdf';
export const PNG_JOB_TYPE = 'PNG';
export const CSV_JOB_TYPE = 'csv';
export const USES_HEADLESS_JOB_TYPES = [PDF_JOB_TYPE, PNG_JOB_TYPE];
3 changes: 2 additions & 1 deletion x-pack/plugins/reporting/export_types/csv/server/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@
import { createJobFactory } from './create_job';
import { executeJobFactory } from './execute_job';
import { metadata } from '../metadata';
import { CSV_JOB_TYPE as jobType } from '../../../common/constants';

export function register(registry) {
registry.register({
...metadata,
jobType: 'csv',
jobType,
jobContentExtension: 'csv',
createJobFactory,
executeJobFactory,
Expand Down
3 changes: 2 additions & 1 deletion x-pack/plugins/reporting/export_types/png/server/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@
import { createJobFactory } from './create_job';
import { executeJobFactory } from './execute_job';
import { metadata } from '../metadata';
import { PNG_JOB_TYPE as jobType } from '../../../common/constants';

export function register(registry) {
registry.register({
...metadata,
jobType: 'PNG',
jobType,
jobContentEncoding: 'base64',
jobContentExtension: 'PNG',
createJobFactory,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@
import { createJobFactory } from './create_job';
import { executeJobFactory } from './execute_job';
import { metadata } from '../metadata';
import { PDF_JOB_TYPE as jobType } from '../../../common/constants';

export function register(registry) {
registry.register({
...metadata,
jobType: 'printable_pdf',
jobType,
jobContentEncoding: 'base64',
jobContentExtension: 'pdf',
createJobFactory,
Expand Down
13 changes: 11 additions & 2 deletions x-pack/plugins/reporting/public/components/report_info_button.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
} from '@elastic/eui';
import { get } from 'lodash';
import React, { Component, Fragment } from 'react';
import { USES_HEADLESS_JOB_TYPES } from '../../common/constants';
import { JobInfo, jobQueueClient } from '../lib/job_queue_client';

interface Props {
Expand All @@ -32,6 +33,7 @@ interface State {
}

const NA = 'n/a';
const UNKNOWN = 'unknown';

const getDimensions = (info: JobInfo) => {
const defaultDimensions = { width: null, height: null };
Expand Down Expand Up @@ -73,7 +75,8 @@ export class ReportInfoButton extends Component<Props, State> {
return null;
}

// TODO browser type
const jobType = get(info, 'jobtype', NA);

// TODO queue method (clicked UI, watcher, etc)
const jobInfoParts = {
datetimes: [
Expand Down Expand Up @@ -117,7 +120,7 @@ export class ReportInfoButton extends Component<Props, State> {
},
{
title: 'Job Type',
description: get(info, 'jobtype', NA),
description: jobType,
},
{
title: 'Content Type',
Expand Down Expand Up @@ -145,6 +148,12 @@ export class ReportInfoButton extends Component<Props, State> {
title: 'Status',
description: get(info, 'status', NA),
},
{
title: 'Browser Type',
description: USES_HEADLESS_JOB_TYPES.includes(jobType)
? get(info, 'browser_type', UNKNOWN)
: NA,
},
],
};

Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/reporting/public/lib/job_queue_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export interface JobContent {
}

export interface JobInfo {
browser_type: string;
created_at: string;
priority: number;
jobtype: string;
Expand Down
5 changes: 4 additions & 1 deletion x-pack/plugins/reporting/server/lib/enqueue_job.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ import { oncePerServer } from './once_per_server';

function enqueueJobFn(server) {
const jobQueue = server.plugins.reporting.queue;
const queueConfig = server.config().get('xpack.reporting.queue');
const config = server.config();
const queueConfig = config.get('xpack.reporting.queue');
const browserType = config.get('xpack.reporting.capture.browser.type');
const exportTypesRegistry = server.plugins.reporting.exportTypesRegistry;

return async function enqueueJob(exportTypeId, jobParams, user, headers, request) {
Expand All @@ -21,6 +23,7 @@ function enqueueJobFn(server) {
const options = {
timeout: queueConfig.timeout,
created_by: get(user, 'username', false),
browser_type: browserType,
};

return new Promise((resolve, reject) => {
Expand Down
8 changes: 8 additions & 0 deletions x-pack/plugins/reporting/server/lib/esqueue/__tests__/job.js
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,14 @@ describe('Job Class', function () {
expect(indexArgs.body).to.have.property('priority', defaultPriority);
});
});

it('should set a browser type', function () {
const job = new Job(mockQueue, index, type, payload);
return job.ready.then(() => {
const indexArgs = validateDoc(client.index);
expect(indexArgs.body).to.have.property('browser_type');
});
});
});

describe('option passing', function () {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ const schema = {
},
}
},
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if this makes much a difference since we're likely updating an existing index in current installations. Is there more here that I need to follow up with?

Copy link
Member

Choose a reason for hiding this comment

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

Additions to the data model should be fine as long as it is released in a minor version (not a patch). It'll be worthwhile to test an upgrade scenario: create some reports in 6.5.x and then upgrade to 6.6.x, and check out the browser_type behavior.

browser_type: { type: 'keyword' },
jobtype: { type: 'keyword' },
payload: { type: 'object', enabled: false },
priority: { type: 'byte' },
Expand Down
5 changes: 4 additions & 1 deletion x-pack/plugins/reporting/server/lib/esqueue/job.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export class Job extends events.EventEmitter {
this.priority = Math.max(Math.min(options.priority || 10, 20), -20);
this.doctype = options.doctype || constants.DEFAULT_SETTING_DOCTYPE;
this.indexSettings = options.indexSettings || {};
this.browser_type = options.browser_type;

this.debug = (msg, err) => {
const logger = options.logger || function () {};
Expand Down Expand Up @@ -66,6 +67,7 @@ export class Job extends events.EventEmitter {
attempts: 0,
max_attempts: this.maxAttempts,
status: constants.JOB_STATUS_PENDING,
browser_type: this.browser_type,
}
};

Expand Down Expand Up @@ -131,7 +133,8 @@ export class Job extends events.EventEmitter {
payload: this.payload,
timeout: this.timeout,
max_attempts: this.maxAttempts,
priority: this.priority
priority: this.priority,
browser_type: this.browser_type,
};
}
}