[Reporting/Config] allow string representations of duration settings

docs/settings/reporting-settings.asciidoc

@@ -104,15 +104,15 @@ security is enabled, `xpack.security.encryptionKey`.
 [cols="2*<"]
 |===
 | `xpack.reporting.queue.pollInterval`
- | Specifies the number of milliseconds that the reporting poller waits between polling the
- index for any pending Reporting jobs. Defaults to `3000` (3 seconds).
+ | (time value) Specifies the time that the reporting poller waits between polling the
+ index for any pending Reporting jobs. Defaults to `3s`.
 
 | [[xpack-reporting-q-timeout]] `xpack.reporting.queue.timeout`
- | How long each worker has to produce a report. If your machine is slow or under
- heavy load, you might need to increase this timeout. Specified in milliseconds.
+ | (time value) How long each worker has to produce a report. If your machine is slow or under
+ heavy load, you might need to increase this timeout.
  If a Reporting job execution time goes over this time limit, the job will be
  marked as a failure and there will not be a download available.
- Defaults to `120000` (two minutes).
+ Defaults to `2m`.
 
 |===
 
@@ -126,22 +126,21 @@ control the capturing process.
 [cols="2*<"]
 |===
 | `xpack.reporting.capture.timeouts.openUrl`
- | Specify how long to allow the Reporting browser to wait for the "Loading..." screen
+ | (time value) Specify how long to allow the Reporting browser to wait for the "Loading..." screen
  to dismiss and find the initial data for the Kibana page. If the time is
  exceeded, a page screenshot is captured showing the current state, and the download link shows a warning message.
- Defaults to `60000` (1 minute).
+ Defaults to `1m`.
 
 | `xpack.reporting.capture.timeouts.waitForElements`
  | Specify how long to allow the Reporting browser to wait for all visualization
  panels to load on the Kibana page. If the time is exceeded, a page screenshot
- is captured showing the current state, and the download link shows a warning message. Defaults to `30000` (30
- seconds).
+ is captured showing the current state, and the download link shows a warning message. Defaults to `30s`.
 
 | `xpack.reporting.capture.timeouts.renderComplete`
  | Specify how long to allow the Reporting browser to wait for all visualizations to
  fetch and render the data. If the time is exceeded, a
  page screenshot is captured showing the current state, and the download link shows a warning message. Defaults to
- `30000` (30 seconds).
+ `30s`.
 
 |===
 
@@ -160,11 +159,11 @@ available, but there will likely be errors in the visualizations in the report.
  job, as many times as this setting. Defaults to `3`.
 
 | `xpack.reporting.capture.loadDelay`
- | When visualizations are not evented, this is the amount of time before
+ | (time value) When visualizations are not evented, this is the amount of time before
  taking a screenshot. All visualizations that ship with {kib} are evented, so this
  setting should not have much effect. If you are seeing empty images instead of
  visualizations, try increasing this value.
- Defaults to `3000` (3 seconds).
+ Defaults to `3s`.
 
 | [[xpack-reporting-browser]] `xpack.reporting.capture.browser.type`
  | Specifies the browser to use to capture screenshots. This setting exists for
@@ -216,7 +215,7 @@ When `xpack.reporting.capture.browser.type` is set to `chromium` (default) you c
  Defaults to `500`.
 
 | `xpack.reporting.csv.scroll.duration`
- | Amount of time allowed before {kib} cleans the scroll context during a CSV export.
+ | (time value) Amount of time allowed before {kib} cleans the scroll context during a CSV export.
  Defaults to `30s`.
 
 | `xpack.reporting.csv.checkForFormulas`

x-pack/plugins/reporting/public/components/report_listing.test.tsx

@@ -4,6 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import moment from 'moment';
 import React from 'react';
 import { Observable } from 'rxjs';
 import { mountWithIntl } from 'test_utils/enzyme_helpers';
@@ -53,11 +54,11 @@ const toasts = {
 
 const mockPollConfig = {
  jobCompletionNotifier: {
- interval: 5000,
+ interval: moment.duration(5, 's'),
  intervalErrorMultiplier: 3,
  },
  jobsRefresh: {
- interval: 5000,
+ interval: moment.duration(5, 's'),
  intervalErrorMultiplier: 3,
  },
 };

x-pack/plugins/reporting/public/components/report_listing.tsx

@@ -165,17 +165,23 @@ class ReportListingUi extends Component<Props, State> {
 
  public componentDidMount() {
  this.mounted = true;
+ const { pollConfig, license$ } = this.props;
+
+ const pollFrequencyInMillis =
+ typeof pollConfig.jobsRefresh.interval === 'number'
+ ? pollConfig.jobsRefresh.interval
+ : pollConfig.jobsRefresh.interval.asMilliseconds();
  this.poller = new Poller({
  functionToPoll: () => {
  return this.fetchJobs();
  },
- pollFrequencyInMillis: this.props.pollConfig.jobsRefresh.interval,
+ pollFrequencyInMillis,
  trailing: false,
  continuePollingOnError: true,
- pollFrequencyErrorMultiplier: this.props.pollConfig.jobsRefresh.intervalErrorMultiplier,
+ pollFrequencyErrorMultiplier: pollConfig.jobsRefresh.intervalErrorMultiplier,
  });
  this.poller.start();
- this.licenseSubscription = this.props.license$.subscribe(this.licenseHandler);
+ this.licenseSubscription = license$.subscribe(this.licenseHandler);
  }
 
  private licenseHandler = (license: ILicense) => {

x-pack/plugins/reporting/public/plugin.tsx

@@ -158,8 +158,8 @@ export class ReportingPublicPlugin implements Plugin<void, void> {
  const { http, notifications } = core;
  const apiClient = new ReportingAPIClient(http);
  const streamHandler = new StreamHandler(notifications, apiClient);
- const { interval } = this.config.poll.jobsRefresh;
-
+ const { interval: intervalRaw } = this.config.poll.jobsRefresh;
+ const interval = typeof intervalRaw === 'number' ? intervalRaw : intervalRaw.asMilliseconds();
  Rx.timer(0, interval)
  .pipe(
  takeUntil(this.stop$), // stop the interval when stop method is called

x-pack/plugins/reporting/server/browsers/chromium/driver_factory/index.ts

@@ -112,7 +112,9 @@ export class HeadlessChromiumDriverFactory {
 
  // Set the default timeout for all navigation methods to the openUrl timeout (30 seconds)
  // All waitFor methods have their own timeout config passed in to them
- page.setDefaultTimeout(this.captureConfig.timeouts.openUrl);
+ const timeoutRaw = this.captureConfig.timeouts.openUrl;
+ const timeout = typeof timeoutRaw === 'number' ? timeoutRaw : timeoutRaw.asMilliseconds();
+ page.setDefaultTimeout(timeout);
 
  logger.debug(`Browser page driver created`);
  } catch (err) {

x-pack/plugins/reporting/server/config/schema.test.ts

@@ -105,6 +105,37 @@ describe('Reporting Config Schema', () => {
  });
  });
 
+ it('allows Duration values for certain keys', () => {
+ expect(ConfigSchema.validate({ queue: { timeout: '2m' } }).queue.timeout).toMatchInlineSnapshot(
+ `"PT2M"`
+ );
+
+ expect(
+ ConfigSchema.validate({ capture: { loadDelay: '3s' } }).capture.loadDelay
+ ).toMatchInlineSnapshot(`"PT3S"`);
+
+ expect(
+ ConfigSchema.validate({
+ capture: { timeouts: { openUrl: '1m', waitForElements: '30s', renderComplete: '10s' } },
+ }).capture.timeouts
+ ).toMatchInlineSnapshot(`
+ Object {
+ "openUrl": "PT1M",
+ "renderComplete": "PT10S",
+ "waitForElements": "PT30S",
+ }
+ `);
+ });
+
+ it('allows ByteSizeValue values for certain keys', () => {
+ expect(ConfigSchema.validate({ csv: { maxSizeBytes: '12mb' } }).csv.maxSizeBytes)
+ .toMatchInlineSnapshot(`
+ ByteSizeValue {
+ "valueInBytes": 12582912,
+ }
+ `);
+ });
+
  it(`allows optional settings`, () => {
  // encryption key
  expect(

x-pack/plugins/reporting/server/config/schema.ts

@@ -5,7 +5,6 @@
  */
 
 import { schema, TypeOf } from '@kbn/config-schema';
-import moment from 'moment';
 
 const KibanaServerSchema = schema.object({
  hostname: schema.maybe(
@@ -35,7 +34,7 @@ const QueueSchema = schema.object({
  pollEnabled: schema.boolean({ defaultValue: true }),
  pollInterval: schema.number({ defaultValue: 3000 }),
  pollIntervalErrorMultiplier: schema.number({ defaultValue: 10 }),
- timeout: schema.number({ defaultValue: moment.duration(2, 'm').asMilliseconds() }),
+ timeout: schema.oneOf([schema.number(), schema.duration()], { defaultValue: 120000 }),
 });
 
 const RulesSchema = schema.object({
@@ -46,9 +45,9 @@ const RulesSchema = schema.object({
 
 const CaptureSchema = schema.object({
  timeouts: schema.object({
- openUrl: schema.number({ defaultValue: 60000 }),
- waitForElements: schema.number({ defaultValue: 30000 }),
- renderComplete: schema.number({ defaultValue: 30000 }),
+ openUrl: schema.oneOf([schema.number(), schema.duration()], { defaultValue: 30000 }),
+ waitForElements: schema.oneOf([schema.number(), schema.duration()], { defaultValue: 30000 }),
+ renderComplete: schema.oneOf([schema.number(), schema.duration()], { defaultValue: 30000 }),
  }),
  networkPolicy: schema.object({
  enabled: schema.boolean({ defaultValue: true }),
@@ -68,9 +67,7 @@ const CaptureSchema = schema.object({
  width: schema.number({ defaultValue: 1950 }),
  height: schema.number({ defaultValue: 1200 }),
  }),
- loadDelay: schema.number({
- defaultValue: moment.duration(3, 's').asMilliseconds(),
- }), // TODO: use schema.duration
+ loadDelay: schema.oneOf([schema.number(), schema.duration()], { defaultValue: 3000 }),
  browser: schema.object({
  autoDownload: schema.conditional(
  schema.contextRef('dist'),
@@ -116,9 +113,9 @@ const CsvSchema = schema.object({
  checkForFormulas: schema.boolean({ defaultValue: true }),
  escapeFormulaValues: schema.boolean({ defaultValue: false }),
  enablePanelActionDownload: schema.boolean({ defaultValue: true }),
- maxSizeBytes: schema.number({
- defaultValue: 1024 * 1024 * 10, // 10MB
- }), // TODO: use schema.byteSize
+ maxSizeBytes: schema.oneOf([schema.number(), schema.byteSize()], {
+ defaultValue: 1024 * 1024 * 10,
+ }),
  useByteOrderMarkEncoding: schema.boolean({ defaultValue: false }),
  scroll: schema.object({
  duration: schema.string({
@@ -148,15 +145,11 @@ const IndexSchema = schema.string({ defaultValue: '.reporting' });
 
 const PollSchema = schema.object({
  jobCompletionNotifier: schema.object({
- interval: schema.number({
- defaultValue: moment.duration(10, 's').asMilliseconds(),
- }), // TODO: use schema.duration
+ interval: schema.oneOf([schema.number(), schema.duration()], { defaultValue: 10000 }),
  intervalErrorMultiplier: schema.number({ defaultValue: 5 }),
  }),
  jobsRefresh: schema.object({
- interval: schema.number({
- defaultValue: moment.duration(5, 's').asMilliseconds(),
- }), // TODO: use schema.duration
+ interval: schema.oneOf([schema.number(), schema.duration()], { defaultValue: 5000 }),
  intervalErrorMultiplier: schema.number({ defaultValue: 5 }),
  }),
 });

x-pack/plugins/reporting/server/export_types/common/get_conditional_headers.test.ts

@@ -4,28 +4,24 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import sinon from 'sinon';
 import { ReportingConfig } from '../../';
 import { ReportingCore } from '../../core';
-import { createMockReportingCore } from '../../test_helpers';
+import {
+ createMockConfig,
+ createMockConfigSchema,
+ createMockReportingCore,
+} from '../../test_helpers';
 import { ScheduledTaskParams } from '../../types';
 import { ScheduledTaskParamsPDF } from '../printable_pdf/types';
 import { getConditionalHeaders, getCustomLogo } from './';
 
 let mockConfig: ReportingConfig;
 let mockReportingPlugin: ReportingCore;
 
-const getMockConfig = (mockConfigGet: sinon.SinonStub) => ({
- get: mockConfigGet,
- kbnConfig: { get: mockConfigGet },
-});
-
 beforeEach(async () => {
- const mockConfigGet = sinon
- .stub()
- .withArgs('kibanaServer', 'hostname')
- .returns('custom-hostname');
- mockConfig = getMockConfig(mockConfigGet);
+ const reportingConfig = { kibanaServer: { hostname: 'custom-hostname' } };
+ const mockSchema = createMockConfigSchema(reportingConfig);
+ mockConfig = createMockConfig(mockSchema);
  mockReportingPlugin = await createMockReportingCore(mockConfig);
 });
 
@@ -36,7 +32,7 @@ describe('conditions', () => {
  baz: 'quix',
  };
 
- const conditionalHeaders = await getConditionalHeaders({
+ const conditionalHeaders = getConditionalHeaders({
  job: {} as ScheduledTaskParams<any>,
  filteredHeaders: permittedHeaders,
  config: mockConfig,
@@ -63,7 +59,7 @@ test('uses basePath from job when creating saved object service', async () => {
  foo: 'bar',
  baz: 'quix',
  };
- const conditionalHeaders = await getConditionalHeaders({
+ const conditionalHeaders = getConditionalHeaders({
  job: {} as ScheduledTaskParams<any>,
  filteredHeaders: permittedHeaders,
  config: mockConfig,
@@ -84,16 +80,15 @@ test(`uses basePath from server if job doesn't have a basePath when creating sav
  const mockGetSavedObjectsClient = jest.fn();
  mockReportingPlugin.getSavedObjectsClient = mockGetSavedObjectsClient;
 
- const mockConfigGet = sinon.stub();
- mockConfigGet.withArgs('kibanaServer', 'hostname').returns('localhost');
- mockConfigGet.withArgs('server', 'basePath').returns('/sbp');
- mockConfig = getMockConfig(mockConfigGet);
+ const reportingConfig = { kibanaServer: { hostname: 'localhost' }, server: { basePath: '/sbp' } };
+ const mockSchema = createMockConfigSchema(reportingConfig);
+ mockConfig = createMockConfig(mockSchema);
 
  const permittedHeaders = {
  foo: 'bar',
  baz: 'quix',
  };
- const conditionalHeaders = await getConditionalHeaders({
+ const conditionalHeaders = getConditionalHeaders({
  job: {} as ScheduledTaskParams<any>,
  filteredHeaders: permittedHeaders,
  config: mockConfig,
@@ -134,25 +129,12 @@ test(`uses basePath from server if job doesn't have a basePath when creating sav
 });
 
 describe('config formatting', () => {
- test(`lowercases server.host`, async () => {
- const mockConfigGet = sinon.stub().withArgs('server', 'host').returns('COOL-HOSTNAME');
- mockConfig = getMockConfig(mockConfigGet);
-
- const conditionalHeaders = await getConditionalHeaders({
- job: {} as ScheduledTaskParams<any>,
- filteredHeaders: {},
- config: mockConfig,
- });
- expect(conditionalHeaders.conditions.hostname).toEqual('cool-hostname');
- });
-
  test(`lowercases kibanaServer.hostname`, async () => {
- const mockConfigGet = sinon
- .stub()
- .withArgs('kibanaServer', 'hostname')
- .returns('GREAT-HOSTNAME');
- mockConfig = getMockConfig(mockConfigGet);
- const conditionalHeaders = await getConditionalHeaders({
+ const reportingConfig = { kibanaServer: { hostname: 'GREAT-HOSTNAME' } };
+ const mockSchema = createMockConfigSchema(reportingConfig);
+ mockConfig = createMockConfig(mockSchema);
+
+ const conditionalHeaders = getConditionalHeaders({
  job: {
  title: 'cool-job-bro',
  type: 'csv',

x-pack/plugins/reporting/server/export_types/common/get_custom_logo.test.ts

@@ -4,18 +4,20 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { ReportingCore } from '../../core';
-import { createMockReportingCore } from '../../test_helpers';
+import { ReportingConfig, ReportingCore } from '../../';
+import {
+ createMockConfig,
+ createMockConfigSchema,
+ createMockReportingCore,
+} from '../../test_helpers';
 import { ScheduledTaskParamsPDF } from '../printable_pdf/types';
 import { getConditionalHeaders, getCustomLogo } from './';
 
-const mockConfigGet = jest.fn().mockImplementation((key: string) => {
- return 'localhost';
-});
-const mockConfig = { get: mockConfigGet, kbnConfig: { get: mockConfigGet } };
-
+let mockConfig: ReportingConfig;
 let mockReportingPlugin: ReportingCore;
+
 beforeEach(async () => {
+ mockConfig = createMockConfig(createMockConfigSchema());
  mockReportingPlugin = await createMockReportingCore(mockConfig);
 });