Add png output to reports 65 (elastic#24759)

* Changes for new PNG image output for reports

Change PNG button name from Download to Generate

Changes for new PNG image output for reports

Change PNG button name from Download to Generate

Remove compatabilityShim from PNG and move to PDF folders

Changed API parameters to contain only required parameters

Added test cases for PNG reporting and added title back into the PNG API call

Merge of security changes for PNG reporting

Fixed issues with test cases for both PDF and PNG

Updated test snapshots for PNG and PDF test changes

* Adding new security changes made for PDF into new PNG code

* Removed commented out lines that were not needed

x-pack/plugins/reporting/common/constants.ts

@@ -11,7 +11,12 @@ export const JOB_COMPLETION_NOTIFICATIONS_SESSION_KEY =
 
 export const API_BASE_URL = '/api/reporting';
 
-export const WHITELISTED_JOB_CONTENT_TYPES = ['application/json', 'application/pdf', 'text/csv'];
+export const WHITELISTED_JOB_CONTENT_TYPES = [
+  'application/json',
+  'application/pdf',
+  'text/csv',
+  'image/png',
+];
 
 export const UI_SETTINGS_CUSTOM_PDF_LOGO = 'xpackReporting:customPdfLogo';
 

x-pack/plugins/reporting/export_types/printable_pdf/server/execute_job/get_absolute_url.js → x-pack/plugins/reporting/export_types/common/execute_job/get_absolute_url.js

@@ -5,7 +5,7 @@
  */
 
 import url from 'url';
-import { oncePerServer } from '../../../../server/lib/once_per_server';
+import { oncePerServer } from '../../../server/lib/once_per_server';
 
 function getAbsoluteUrlFn(server) {
   const config = server.config();

x-pack/plugins/reporting/export_types/printable_pdf/server/lib/layouts/create_layout.ts → x-pack/plugins/reporting/export_types/common/layouts/create_layout.ts

@@ -3,8 +3,8 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-import { KbnServer, Size } from '../../../../../types';
-import { LayoutTypes } from '../../../common/constants';
+import { KbnServer, Size } from '../../../types';
+import { LayoutTypes } from '../constants';
 import { Layout } from './layout';
 import { PreserveLayout } from './preserve_layout';
 import { PrintLayout } from './print_layout';

x-pack/plugins/reporting/export_types/printable_pdf/server/lib/layouts/layout.ts → x-pack/plugins/reporting/export_types/common/layouts/layout.ts

@@ -3,7 +3,7 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-import { Size, ViewZoomWidthHeight } from '../../../../../types';
+import { Size, ViewZoomWidthHeight } from '../../../types';
 
 export interface PageSizeParams {
   pageMarginTop: number;

x-pack/plugins/reporting/export_types/printable_pdf/server/lib/layouts/preserve_layout.ts → x-pack/plugins/reporting/export_types/common/layouts/preserve_layout.ts

@@ -4,8 +4,8 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 import path from 'path';
-import { Size } from '../../../../../types';
-import { LayoutTypes } from '../../../common/constants';
+import { Size } from '../../../types';
+import { LayoutTypes } from '../constants';
 import { Layout, PageSizeParams } from './layout';
 
 // We use a zoom of two to bump up the resolution of the screenshot a bit.

x-pack/plugins/reporting/export_types/printable_pdf/server/lib/layouts/print_layout.ts → x-pack/plugins/reporting/export_types/common/layouts/print_layout.ts

@@ -4,8 +4,8 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 import path from 'path';
-import { EvaluateOptions, KbnServer, Size } from '../../../../../types';
-import { LayoutTypes } from '../../../common/constants';
+import { EvaluateOptions, KbnServer, Size } from '../../../types';
+import { LayoutTypes } from '../constants';
 import { Layout } from './layout';
 import { CaptureConfig } from './types';
 

x-pack/plugins/reporting/export_types/printable_pdf/server/lib/layouts/types.d.ts → x-pack/plugins/reporting/export_types/common/layouts/types.d.ts

@@ -3,7 +3,7 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-import { Size } from '../../../../../types';
+import { Size } from '../../../types';
 
 export interface CaptureConfig {
   zoom: number;

x-pack/plugins/reporting/export_types/printable_pdf/server/lib/screenshots.js → x-pack/plugins/reporting/export_types/common/lib/screenshots.js

@@ -9,7 +9,7 @@ import { first, tap, mergeMap } from 'rxjs/operators';
 import fs from 'fs';
 import getPort from 'get-port';
 import { promisify } from 'bluebird';
-import { LevelLogger } from '../../../../server/lib/level_logger';
+import { LevelLogger } from '../../../server/lib/level_logger';
 
 const fsp = {
   readFile: promisify(fs.readFile, fs)

x-pack/plugins/reporting/export_types/png/metadata.js

@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export const metadata = {
+  id: 'png',
+  name: 'PNG'
+};

x-pack/plugins/reporting/export_types/png/server/create_job/index.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { cryptoFactory } from '../../../../server/lib/crypto';
+import { oncePerServer } from '../../../../server/lib/once_per_server';
+
+function createJobFn(server) {
+  const crypto = cryptoFactory(server);
+
+  return async function createJob({
+    objectType,
+    title,
+    relativeUrl,
+    browserTimezone,
+    layout
+  }, headers, request) {
+    const serializedEncryptedHeaders = await crypto.encrypt(headers);
+
+    return {
+      type: objectType,
+      title: title,
+      relativeUrl,
+      headers: serializedEncryptedHeaders,
+      browserTimezone,
+      layout,
+      basePath: request.getBasePath(),
+      forceNow: new Date().toISOString(),
+    };
+  };
+}
+
+export const createJobFactory = oncePerServer(createJobFn);

x-pack/plugins/reporting/export_types/png/server/execute_job/index.js

@@ -0,0 +1,118 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import url from 'url';
+import * as Rx from 'rxjs';
+import { mergeMap, catchError, map, takeUntil } from 'rxjs/operators';
+import { oncePerServer } from '../../../../server/lib/once_per_server';
+import { generatePngObservableFactory } from '../lib/generate_png';
+import { cryptoFactory } from '../../../../server/lib/crypto';
+import { getAbsoluteUrlFactory } from '../../../common/execute_job/get_absolute_url';
+import { omit } from 'lodash';
+
+const KBN_SCREENSHOT_HEADER_BLACKLIST = [
+  'accept-encoding',
+  'content-length',
+  'content-type',
+  'host',
+  'referer',
+  // `Transfer-Encoding` is hop-by-hop header that is meaningful
+  // only for a single transport-level connection, and shouldn't
+  // be stored by caches or forwarded by proxies.
+  'transfer-encoding',
+];
+
+function executeJobFn(server) {
+  const generatePngObservable = generatePngObservableFactory(server);
+  const crypto = cryptoFactory(server);
+  const getAbsoluteUrl = getAbsoluteUrlFactory(server);
+  const config = server.config();
+
+  const decryptJobHeaders = async (job) => {
+    const decryptedHeaders = await crypto.decrypt(job.headers);
+    return { job, decryptedHeaders };
+  };
+
+  const omitBlacklistedHeaders = ({ job, decryptedHeaders }) => {
+    const filteredHeaders = omit(decryptedHeaders, KBN_SCREENSHOT_HEADER_BLACKLIST);
+    return { job, filteredHeaders };
+  };
+
+  const getSavedObjectAbsoluteUrl = (job, relativeUrl) => {
+    if (relativeUrl) {
+      const { pathname: path, hash, search } = url.parse(relativeUrl);
+      return getAbsoluteUrl({ basePath: job.basePath, path, hash, search });
+    }
+
+    throw new Error(`Unable to generate report. Url is not defined.`);
+  };
+
+  const getConditionalHeaders = ({ job, filteredHeaders }) => {
+    const conditionalHeaders = {
+      headers: filteredHeaders,
+      conditions: {
+        hostname: config.get('xpack.reporting.kibanaServer.hostname') || config.get('server.host'),
+        port: config.get('xpack.reporting.kibanaServer.port') || config.get('server.port'),
+        basePath: config.get('server.basePath'),
+        protocol: config.get('xpack.reporting.kibanaServer.protocol') || server.info.protocol,
+      }
+    };
+
+    return { job, conditionalHeaders };
+  };
+
+  const addForceNowQuerystring = async ({ job, conditionalHeaders }) => {
+
+    const jobUrl = getSavedObjectAbsoluteUrl(job, job.relativeUrl);
+
+    if (!job.forceNow) {
+      return { job, conditionalHeaders, hashUrl: jobUrl };
+    }
+
+    const parsed = url.parse(jobUrl, true);
+    const hash = url.parse(parsed.hash.replace(/^#/, ''), true);
+
+    const transformedHash = url.format({
+      pathname: hash.pathname,
+      query: {
+        ...hash.query,
+        forceNow: job.forceNow
+      }
+    });
+
+    const hashUrl = url.format({
+      ...parsed,
+      hash: transformedHash
+    });
+
+    return { job, conditionalHeaders, hashUrl };
+  };
+
+  return function executeJob(jobToExecute, cancellationToken) {
+    const process$ = Rx.of(jobToExecute).pipe(
+      mergeMap(decryptJobHeaders),
+      catchError(() => Rx.throwError('Failed to decrypt report job data. Please re-generate this report.')),
+      map(omitBlacklistedHeaders),
+      map(getConditionalHeaders),
+      mergeMap(addForceNowQuerystring),
+      mergeMap(({ job, conditionalHeaders, hashUrl }) => {
+        return generatePngObservable(hashUrl, job.browserTimezone, conditionalHeaders, job.layout);
+      }),
+      map(buffer => ({
+        content_type: 'image/png',
+        content: buffer.toString('base64')
+      }))
+    );
+
+    const stop$ = Rx.fromEventPattern(cancellationToken.on);
+
+    return process$.pipe(
+      takeUntil(stop$)
+    ).toPromise();
+  };
+}
+
+export const executeJobFactory = oncePerServer(executeJobFn);