[Reporting] add version to all export types job params (#106137)

* add version to csv params

* fix ts

* fix api tests

* use kibana version from packageInfo

* use kibana version from packageInfo

* clean up ide warnings

* utility to log and set a default params version

* fix baseparams ts

* update snapshot

* check version in enqueue job

* add temporary ts-ignore for canvas

* clarify comment

* fix hardcoded version in png_pdf_panel

* clarify the UNVERSIONED_VERSION variable with a comment

* fix canvas jest test

* fix ts in example app

* fix types

* send version param to canvas util for job params

* update jest snapshot

* Update utils.test.ts

* fix snapshot

* remove browserTimezone and version from integration boilerplate

* wip ensure version is always populated in job params inside of the service

* wip2

* wip3

* wip4

* wip5

* wip6

* update note

* update example plugin

* wip7

* improve tests

* fix dynamic job params

* better testing

* improve enqueue_job test

* more tests

* fix types

* fix types

* fix example ts

* simplify props

* fix test

* --wip-- [skip ci]

* consolidate baseparams back into one interface

* fix rison encoding of apiClient param

* clean up

* reorganize imports

* back out functional change

* fix 400 error in download csv

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

x-pack/examples/reporting_example/public/application.tsx

@@ -8,13 +8,13 @@
 import React from 'react';
 import ReactDOM from 'react-dom';
 import { AppMountParameters, CoreStart } from '../../../../src/core/public';
-import { SetupDeps, StartDeps } from './types';
 import { ReportingExampleApp } from './components/app';
+import { SetupDeps, StartDeps } from './types';
 
 export const renderApp = (
   coreStart: CoreStart,
   deps: Omit<StartDeps & SetupDeps, 'developerExamples'>,
-  { appBasePath, element }: AppMountParameters
+  { appBasePath, element }: AppMountParameters // FIXME: appBasePath is deprecated
 ) => {
   ReactDOM.render(<ReportingExampleApp basename={appBasePath} {...coreStart} {...deps} />, element);
 

x-pack/examples/reporting_example/public/components/app.tsx

@@ -28,16 +28,10 @@ import { BrowserRouter as Router } from 'react-router-dom';
 import * as Rx from 'rxjs';
 import { takeWhile } from 'rxjs/operators';
 import { ScreenshotModePluginSetup } from 'src/plugins/screenshot_mode/public';
-import { CoreStart } from '../../../../../src/core/public';
-import { NavigationPublicPluginStart } from '../../../../../src/plugins/navigation/public';
 import { constants, ReportingStart } from '../../../../../x-pack/plugins/reporting/public';
-import { JobParamsPDF } from '../../../../plugins/reporting/server/export_types/printable_pdf/types';
 
-interface ReportingExampleAppDeps {
+interface ReportingExampleAppProps {
   basename: string;
-  notifications: CoreStart['notifications'];
-  http: CoreStart['http'];
-  navigation: NavigationPublicPluginStart;
   reporting: ReportingStart;
   screenshotMode: ScreenshotModePluginSetup;
 }
@@ -46,11 +40,9 @@ const sourceLogos = ['Beats', 'Cloud', 'Logging', 'Kibana'];
 
 export const ReportingExampleApp = ({
   basename,
-  notifications,
-  http,
   reporting,
   screenshotMode,
-}: ReportingExampleAppDeps) => {
+}: ReportingExampleAppProps) => {
   const { getDefaultLayoutSelectors } = reporting;
 
   // Context Menu
@@ -74,7 +66,7 @@ export const ReportingExampleApp = ({
       });
   });
 
-  const getPDFJobParamsDefault = (): JobParamsPDF => {
+  const getPDFJobParamsDefault = () => {
     return {
       layout: {
         id: constants.LAYOUT_TYPES.PRESERVE_LAYOUT,

x-pack/plugins/canvas/public/components/workpad_header/share_menu/utils.test.ts

@@ -22,7 +22,6 @@ test('getPdfJobParams returns the correct job params for canvas layout', () => {
   const jobParams = getPdfJobParams(workpadSharingData, basePath);
   expect(jobParams).toMatchInlineSnapshot(`
     Object {
-      "browserTimezone": "America/New_York",
       "layout": Object {
         "dimensions": Object {
           "height": 0,

x-pack/plugins/canvas/public/components/workpad_header/share_menu/utils.ts

@@ -6,23 +6,18 @@
  */
 
 import { IBasePath } from 'kibana/public';
-import moment from 'moment-timezone';
 import rison from 'rison-node';
-import { BaseParams } from '../../../../../reporting/common/types';
 import { CanvasWorkpad } from '../../../../types';
 
 export interface CanvasWorkpadSharingData {
   workpad: Pick<CanvasWorkpad, 'id' | 'name' | 'height' | 'width'>;
   pageCount: number;
 }
 
-// TODO: get the correct type from Reporting plugin
-type JobParamsPDF = BaseParams & { relativeUrls: string[] };
-
 export function getPdfJobParams(
   { workpad: { id, name: title, width, height }, pageCount }: CanvasWorkpadSharingData,
   basePath: IBasePath
-): JobParamsPDF {
+) {
   const urlPrefix = basePath.get().replace(basePath.serverBasePath, ''); // for Spaces prefix, which is included in basePath.get()
   const canvasEntry = `${urlPrefix}/app/canvas#`;
 
@@ -43,7 +38,6 @@ export function getPdfJobParams(
   }
 
   return {
-    browserTimezone: moment.tz.guess(),
     layout: {
       dimensions: { width, height },
       id: 'canvas',

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

@@ -111,6 +111,11 @@ export enum JOB_STATUSES {
 export const REPORT_TABLE_ID = 'reportJobListing';
 export const REPORT_TABLE_ROW_ID = 'reportJobRow';
 
+// Job params require a `version` field as of 7.15.0. For older jobs set with
+// automation that have no version value in the job params, we assume the
+// intended version is 7.14.0
+export const UNVERSIONED_VERSION = '7.14.0';
+
 // hacky endpoint: download CSV without queueing a report
 // FIXME: find a way to make these endpoints "generic" instead of hardcoded, as are the queued report export types
 export const API_GENERATE_IMMEDIATE = `${API_BASE_URL_V1}/generate/immediate/csv_searchsource`;

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

@@ -97,10 +97,11 @@ export interface ReportDocument extends ReportDocumentHead {
 }
 
 export interface BaseParams {
-  browserTimezone?: string; // browserTimezone is optional: it is not in old POST URLs that were generated prior to being added to this interface
   layout?: LayoutParams;
   objectType: string;
   title: string;
+  browserTimezone: string; // to format dates in the user's time zone
+  version: string; // to handle any state migrations
 }
 
 export type JobId = string;

x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts

@@ -6,34 +6,45 @@
  */
 
 import { i18n } from '@kbn/i18n';
+import moment from 'moment';
 import { stringify } from 'query-string';
-import rison from 'rison-node';
-import { HttpSetup } from 'src/core/public';
+import rison, { RisonObject } from 'rison-node';
+import { HttpSetup, IUiSettingsClient } from 'src/core/public';
 import {
   API_BASE_GENERATE,
   API_BASE_URL,
+  API_GENERATE_IMMEDIATE,
   API_LIST_URL,
   API_MIGRATE_ILM_POLICY_URL,
   REPORTING_MANAGEMENT_HOME,
 } from '../../../common/constants';
-import { DownloadReportFn, JobId, ManagementLinkFn, ReportApiJSON } from '../../../common/types';
+import {
+  BaseParams,
+  DownloadReportFn,
+  JobId,
+  ManagementLinkFn,
+  ReportApiJSON,
+} from '../../../common/types';
 import { add } from '../../notifier/job_completion_notifications';
 import { Job } from '../job';
 
+/*
+ * For convenience, apps do not have to provide the browserTimezone and Kibana version.
+ * Those fields are added in this client as part of the service.
+ * TODO: export a type like this to other plugins: https://github.com/elastic/kibana/issues/107085
+ */
+type AppParams = Omit<BaseParams, 'browserTimezone' | 'version'>;
+
 export interface DiagnoseResponse {
   help: string[];
   success: boolean;
   logs: string;
 }
 
-interface JobParams {
-  [paramName: string]: any;
-}
-
 interface IReportingAPI {
   // Helpers
   getReportURL(jobId: string): string;
-  getReportingJobPath(exportType: string, jobParams: JobParams): string; // Return a URL to queue a job, with the job params encoded in the query string of the URL. Used for copying POST URL
+  getReportingJobPath<T>(exportType: string, jobParams: BaseParams & T): string; // Return a URL to queue a job, with the job params encoded in the query string of the URL. Used for copying POST URL
   createReportingJob(exportType: string, jobParams: any): Promise<Job>; // Sends a request to queue a job, with the job params in the POST body
   getServerBasePath(): string; // Provides the raw server basePath to allow it to be stripped out from relativeUrls in job params
 
@@ -57,11 +68,11 @@ interface IReportingAPI {
 }
 
 export class ReportingAPIClient implements IReportingAPI {
-  private http: HttpSetup;
-
-  constructor(http: HttpSetup) {
-    this.http = http;
-  }
+  constructor(
+    private http: HttpSetup,
+    private uiSettings: IUiSettingsClient,
+    private kibanaVersion: string
+  ) {}
 
   public getReportURL(jobId: string) {
     const apiBaseUrl = this.http.basePath.prepend(API_LIST_URL);
@@ -132,13 +143,15 @@ export class ReportingAPIClient implements IReportingAPI {
     return reports.map((report) => new Job(report));
   }
 
-  public getReportingJobPath(exportType: string, jobParams: JobParams) {
-    const params = stringify({ jobParams: rison.encode(jobParams) });
+  public getReportingJobPath(exportType: string, jobParams: BaseParams) {
+    const risonObject: RisonObject = jobParams as Record<string, any>;
+    const params = stringify({ jobParams: rison.encode(risonObject) });
     return `${this.http.basePath.prepend(API_BASE_GENERATE)}/${exportType}?${params}`;
   }
 
-  public async createReportingJob(exportType: string, jobParams: any) {
-    const jobParamsRison = rison.encode(jobParams);
+  public async createReportingJob(exportType: string, jobParams: BaseParams) {
+    const risonObject: RisonObject = jobParams as Record<string, any>;
+    const jobParamsRison = rison.encode(risonObject);
     const resp: { job: ReportApiJSON } = await this.http.post(
       `${API_BASE_GENERATE}/${exportType}`,
       {
@@ -154,6 +167,27 @@ export class ReportingAPIClient implements IReportingAPI {
     return new Job(resp.job);
   }
 
+  public async createImmediateReport(baseParams: BaseParams) {
+    const { objectType: _objectType, ...params } = baseParams; // objectType is not needed for immediate download api
+    return this.http.post(`${API_GENERATE_IMMEDIATE}`, { body: JSON.stringify(params) });
+  }
+
+  public getDecoratedJobParams<T extends AppParams>(baseParams: T): BaseParams {
+    // If the TZ is set to the default "Browser", it will not be useful for
+    // server-side export. We need to derive the timezone and pass it as a param
+    // to the export API.
+    const browserTimezone: string =
+      this.uiSettings.get('dateFormat:tz') === 'Browser'
+        ? moment.tz.guess()
+        : this.uiSettings.get('dateFormat:tz');
+
+    return {
+      browserTimezone,
+      version: this.kibanaVersion,
+      ...baseParams,
+    };
+  }
+
   public getManagementLink: ManagementLinkFn = () =>
     this.http.basePath.prepend(REPORTING_MANAGEMENT_HOME);
 

x-pack/plugins/reporting/public/lib/stream_handler.test.ts

@@ -26,7 +26,8 @@ const mockJobsFound: Job[] = [
   { id: 'job-source-mock3', status: 'pending', output: { csv_contains_formulas: false, max_size_reached: false }, payload: { title: 'specimen' } },
 ].map((j) => new Job(j as ReportApiJSON)); // prettier-ignore
 
-const jobQueueClientMock = new ReportingAPIClient(coreMock.createSetup().http);
+const coreSetup = coreMock.createSetup();
+const jobQueueClientMock = new ReportingAPIClient(coreSetup.http, coreSetup.uiSettings, '7.15.0');
 jobQueueClientMock.findForJobIds = async () => mockJobsFound;
 jobQueueClientMock.getInfo = () =>
   Promise.resolve(({ content: 'this is the completed report data' } as unknown) as Job);

x-pack/plugins/reporting/public/management/report_info_button.test.tsx

@@ -7,15 +7,17 @@
 
 import React from 'react';
 import { mountWithIntl } from '@kbn/test/jest';
+import { coreMock } from '../../../../../src/core/public/mocks';
 import { Job } from '../lib/job';
 import { ReportInfoButton } from './report_info_button';
 
 jest.mock('../lib/reporting_api_client');
 
 import { ReportingAPIClient } from '../lib/reporting_api_client';
 
-const httpSetup = {} as any;
-const apiClient = new ReportingAPIClient(httpSetup);
+const coreSetup = coreMock.createSetup();
+const apiClient = new ReportingAPIClient(coreSetup.http, coreSetup.uiSettings, '7.15.0');
+
 const job = new Job({
   id: 'abc-123',
   index: '.reporting-2020.04.12',
@@ -29,6 +31,7 @@ const job = new Job({
   meta: { layout: 'preserve_layout', objectType: 'canvas workpad' },
   payload: {
     browserTimezone: 'America/Phoenix',
+    version: '7.15.0-test',
     layout: { dimensions: { height: 720, width: 1080 }, id: 'preserve_layout' },
     objectType: 'canvas workpad',
     title: 'My Canvas Workpad',