[ReponseOps][Reporting] Allow users to schedule reports and view schedules list

src/platform/packages/private/kbn-reporting/common/constants.ts

@@ -13,6 +13,7 @@ import {
   LENS_APP_LOCATOR,
   VISUALIZE_APP_LOCATOR,
 } from '@kbn/deeplinks-analytics';
+import { LicenseType } from '@kbn/licensing-plugin/common/types';
 
 export const ALLOWED_JOB_CONTENT_TYPES = [
   'application/json',
@@ -40,6 +41,13 @@ export const LICENSE_TYPE_CLOUD_STANDARD = 'standard' as const;
 export const LICENSE_TYPE_GOLD = 'gold' as const;
 export const LICENSE_TYPE_PLATINUM = 'platinum' as const;
 export const LICENSE_TYPE_ENTERPRISE = 'enterprise' as const;
+export const SCHEDULED_REPORT_VALID_LICENSES: LicenseType[] = [
+  LICENSE_TYPE_TRIAL,
+  LICENSE_TYPE_CLOUD_STANDARD,
+  LICENSE_TYPE_GOLD,
+  LICENSE_TYPE_PLATINUM,
+  LICENSE_TYPE_ENTERPRISE,
+];
 
 /*
  * Notifications
@@ -66,6 +74,8 @@ export const REPORTING_REDIRECT_LOCATOR_STORE_KEY = '__REPORTING_REDIRECT_LOCATO
 
 // Management UI route
 export const REPORTING_MANAGEMENT_HOME = '/app/management/insightsAndAlerting/reporting';
+export const REPORTING_MANAGEMENT_SCHEDULES =
+  '/app/management/insightsAndAlerting/reporting/schedules';
 
 /*
  * ILM

src/platform/packages/private/kbn-reporting/common/tsconfig.json

@@ -21,5 +21,6 @@
     "@kbn/i18n",
     "@kbn/task-manager-plugin",
     "@kbn/deeplinks-analytics",
+    "@kbn/licensing-plugin",
   ]
 }

src/platform/packages/private/kbn-reporting/common/types.ts

@@ -11,7 +11,7 @@ import type {
   LayoutParams,
   PerformanceMetrics as ScreenshotMetrics,
 } from '@kbn/screenshotting-plugin/common';
-import type { ConcreteTaskInstance } from '@kbn/task-manager-plugin/server';
+import type { ConcreteTaskInstance, RruleSchedule } from '@kbn/task-manager-plugin/server';
 import { JOB_STATUS } from './constants';
 import type { LocatorParams } from './url';
 
@@ -211,3 +211,24 @@ export interface LicenseCheckResults {
   showLinks: boolean;
   message: string;
 }
+
+export interface ScheduledReportApiJSON {
+  id: string;
+  created_at: string;
+  created_by: string;
+  enabled: boolean;
+  jobtype: string;
+  last_run: string | undefined;
+  next_run: string | undefined;
+  notification?: {
+    email?: {
+      to?: string[];
+      cc?: string[];
+      bcc?: string[];
+    };
+  };
+  payload?: ReportApiJSON['payload'];
+  schedule: RruleSchedule;
+  space_id: string;
+  title: string;
+}

src/platform/packages/private/kbn-reporting/public/index.ts

@@ -7,6 +7,8 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
+import type { ActionsPublicPluginSetup } from '@kbn/actions-plugin/public';
+
 export type { ClientConfigType } from './types';
 export { Job } from './job';
 export * from './job_completion_notifications';
@@ -15,7 +17,7 @@ export { useCheckIlmPolicyStatus } from './hooks';
 export { ReportingAPIClient } from './reporting_api_client';
 export { checkLicense } from './license_check';
 
-import type { CoreSetup, CoreStart } from '@kbn/core/public';
+import type { CoreSetup, CoreStart, NotificationsStart } from '@kbn/core/public';
 import type { DataPublicPluginStart } from '@kbn/data-plugin/public';
 import { useKibana as _useKibana } from '@kbn/kibana-react-plugin/public';
 import type { SharePluginStart } from '@kbn/share-plugin/public';
@@ -26,10 +28,13 @@ import type { SharePluginStart } from '@kbn/share-plugin/public';
 export interface KibanaContext {
   http: CoreSetup['http'];
   application: CoreStart['application'];
+  settings: CoreStart['settings'];
   uiSettings: CoreStart['uiSettings'];
   docLinks: CoreStart['docLinks'];
   data: DataPublicPluginStart;
   share: SharePluginStart;
+  actions: ActionsPublicPluginSetup;
+  notifications: NotificationsStart;
 }
 
 export const useKibana = () => _useKibana<KibanaContext>();

src/platform/packages/private/kbn-reporting/public/job.tsx

@@ -79,6 +79,7 @@ export class Job {
 
   public readonly queue_time_ms?: Required<ReportFields>['queue_time_ms'][number];
   public readonly execution_time_ms?: Required<ReportFields>['execution_time_ms'][number];
+  public readonly scheduled_report_id?: ReportSource['scheduled_report_id'];
 
   constructor(report: ReportApiJSON) {
     this.id = report.id;
@@ -117,6 +118,7 @@ export class Job {
     this.metrics = report.metrics;
     this.queue_time_ms = report.queue_time_ms;
     this.execution_time_ms = report.execution_time_ms;
+    this.scheduled_report_id = report.scheduled_report_id;
   }
 
   public isSearch() {

src/platform/packages/private/kbn-reporting/public/reporting_api_client.test.ts

@@ -118,6 +118,27 @@ describe('ReportingAPIClient', () => {
     });
   });
 
+  describe('getScheduledReportInfo', () => {
+    beforeEach(() => {
+      httpClient.get.mockResolvedValueOnce({ data: [{ id: '123', title: 'Scheduled Report 1' }] });
+    });
+
+    it('should send a get request', async () => {
+      await apiClient.getScheduledReportInfo('123');
+
+      expect(httpClient.get).toHaveBeenCalledWith(
+        expect.stringContaining('/internal/reporting/scheduled/list')
+      );
+    });
+
+    it('should return a report', async () => {
+      await expect(apiClient.getScheduledReportInfo('123')).resolves.toEqual({
+        id: '123',
+        title: 'Scheduled Report 1',
+      });
+    });
+  });
+
   describe('getError', () => {
     it('should get an error message', async () => {
       httpClient.get.mockResolvedValueOnce({

src/platform/packages/private/kbn-reporting/public/reporting_api_client.ts

@@ -18,7 +18,13 @@ import {
   buildKibanaPath,
   REPORTING_REDIRECT_APP,
 } from '@kbn/reporting-common';
-import { BaseParams, JobId, ManagementLinkFn, ReportApiJSON } from '@kbn/reporting-common/types';
+import {
+  BaseParams,
+  JobId,
+  ManagementLinkFn,
+  ReportApiJSON,
+  ScheduledReportApiJSON,
+} from '@kbn/reporting-common/types';
 import rison from '@kbn/rison';
 import moment from 'moment';
 import { stringify } from 'query-string';
@@ -83,7 +89,10 @@ export class ReportingAPIClient implements IReportingAPI {
   }
 
   public getKibanaAppHref(job: Job): string {
-    const searchParams = stringify({ jobId: job.id });
+    const searchParams = stringify({
+      jobId: job.id,
+      ...(job.scheduled_report_id ? { scheduledReportId: job.scheduled_report_id } : {}),
+    });
 
     const path = buildKibanaPath({
       basePath: this.http.basePath.serverBasePath,
@@ -158,6 +167,15 @@ export class ReportingAPIClient implements IReportingAPI {
     return new Job(report);
   }
 
+  public async getScheduledReportInfo(id: string) {
+    const { data: reportList = [] }: { data: ScheduledReportApiJSON[] } = await this.http.get(
+      `${INTERNAL_ROUTES.SCHEDULED.LIST}`
+    );
+
+    const report = reportList.find((item) => item.id === id);
+    return report;
+  }
+
   public async findForJobIds(jobIds: JobId[]) {
     const reports: ReportApiJSON[] = await this.http.fetch(INTERNAL_ROUTES.JOBS.LIST, {
       query: { page: 0, ids: jobIds.join(',') },

src/platform/packages/private/kbn-reporting/public/share/share_context_menu/register_csv_modal_reporting.tsx

@@ -15,10 +15,42 @@ import type { SerializedSearchSourceFields } from '@kbn/data-plugin/common';
 import { FormattedMessage, InjectedIntl } from '@kbn/i18n-react';
 import { ShareContext, type ExportShare } from '@kbn/share-plugin/public';
 import { LocatorParams } from '@kbn/reporting-common/types';
+import { ReportParamsGetter, ReportParamsGetterOptions } from '../../types';
 import { getSearchCsvJobParams, CsvSearchModeParams } from '../shared/get_search_csv_job_params';
 import type { ExportModalShareOpts } from '.';
 import { checkLicense } from '../..';
 
+export const getCsvReportParams: ReportParamsGetter<
+  ReportParamsGetterOptions & { forShareUrl?: boolean },
+  CsvSearchModeParams
+> = ({ sharingData, forShareUrl = false }) => {
+  const getSearchSource = sharingData.getSearchSource as ({
+    addGlobalTimeFilter,
+    absoluteTime,
+  }: {
+    addGlobalTimeFilter?: boolean;
+    absoluteTime?: boolean;
+  }) => SerializedSearchSourceFields;
+
+  if (sharingData.isTextBased) {
+    // csv v2 uses locator params
+    return {
+      isEsqlMode: true,
+      locatorParams: sharingData.locatorParams as LocatorParams[],
+    };
+  }
+
+  // csv v1 uses search source and columns
+  return {
+    isEsqlMode: false,
+    columns: sharingData.columns as string[] | undefined,
+    searchSource: getSearchSource({
+      addGlobalTimeFilter: true,
+      absoluteTime: !forShareUrl,
+    }),
+  };
+};
+
 export const reportingCsvExportProvider = ({
   apiClient,
   startServices$,
@@ -27,33 +59,8 @@ export const reportingCsvExportProvider = ({
     objectType,
     sharingData,
   }: ShareContext): ReturnType<ExportShare['config']> => {
-    const getSearchSource = sharingData.getSearchSource as ({
-      addGlobalTimeFilter,
-      absoluteTime,
-    }: {
-      addGlobalTimeFilter?: boolean;
-      absoluteTime?: boolean;
-    }) => SerializedSearchSourceFields;
-
-    const getSearchModeParams = (forShareUrl?: boolean): CsvSearchModeParams => {
-      if (sharingData.isTextBased) {
-        // csv v2 uses locator params
-        return {
-          isEsqlMode: true,
-          locatorParams: sharingData.locatorParams as LocatorParams[],
-        };
-      }
-
-      // csv v1 uses search source and columns
-      return {
-        isEsqlMode: false,
-        columns: sharingData.columns as string[] | undefined,
-        searchSource: getSearchSource({
-          addGlobalTimeFilter: true,
-          absoluteTime: !forShareUrl,
-        }),
-      };
-    };
+    const getSearchModeParams = (forShareUrl?: boolean): CsvSearchModeParams =>
+      getCsvReportParams({ sharingData, forShareUrl });
 
     const generateReportingJobCSV = ({ intl }: { intl: InjectedIntl }) => {
       const { reportType, decoratedJobParams } = getSearchCsvJobParams({

src/platform/packages/private/kbn-reporting/public/share/share_context_menu/register_pdf_png_modal_reporting.tsx

@@ -14,29 +14,69 @@ import { ShareContext } from '@kbn/share-plugin/public';
 import React from 'react';
 import { firstValueFrom } from 'rxjs';
 import { ExportGenerationOpts, ExportShare } from '@kbn/share-plugin/public/types';
+import { ReportParamsGetter, ReportParamsGetterOptions } from '../../types';
 import { ExportModalShareOpts, JobParamsProviderOptions, ReportingSharingData } from '.';
 import { checkLicense } from '../../license_check';
 
-const getJobParams = (opts: JobParamsProviderOptions, type: 'pngV2' | 'printablePdfV2') => () => {
-  const {
-    objectType,
-    sharingData: { title, locatorParams },
-    optimizedForPrinting,
-  } = opts;
-
+const getBaseParams = (objectType: string) => {
   const el = document.querySelector('[data-shared-items-container]');
   const { height, width } = el ? el.getBoundingClientRect() : { height: 768, width: 1024 };
   const dimensions = { height, width };
-  const layoutId = optimizedForPrinting ? ('print' as const) : ('preserve_layout' as const);
-  const layout = { id: layoutId, dimensions };
-  const baseParams = { objectType, layout, title };
+  return {
+    objectType,
+    layout: {
+      id: 'preserve_layout' as 'preserve_layout' | 'print',
+      dimensions,
+    },
+  };
+};
+
+interface PngPdfReportBaseParams {
+  layout: { dimensions: { height: number; width: number }; id: 'preserve_layout' | 'print' };
+  objectType: string;
+  locatorParams: any;
+}
+
+export const getPngReportParams: ReportParamsGetter<
+  ReportParamsGetterOptions,
+  PngPdfReportBaseParams
+> = ({ sharingData }): PngPdfReportBaseParams => {
+  return {
+    ...getBaseParams('pngV2'),
+    locatorParams: sharingData.locatorParams,
+  };
+};
 
-  if (type === 'printablePdfV2') {
-    // multi locator for PDF V2
-    return { ...baseParams, locatorParams: [locatorParams] };
+export const getPdfReportParams: ReportParamsGetter<
+  ReportParamsGetterOptions & { optimizedForPrinting?: boolean },
+  PngPdfReportBaseParams
+> = ({ sharingData, optimizedForPrinting = false }) => {
+  const params = {
+    ...getBaseParams('printablePdfV2'),
+    locatorParams: [sharingData.locatorParams],
+  };
+  if (optimizedForPrinting) {
+    params.layout.id = 'print';
   }
-  // single locator for PNG V2
-  return { ...baseParams, locatorParams };
+  return params;
+};
+
+const getJobParams = (opts: JobParamsProviderOptions, type: 'pngV2' | 'printablePdfV2') => () => {
+  const { objectType, sharingData, optimizedForPrinting } = opts;
+  let baseParams: PngPdfReportBaseParams;
+  if (type === 'pngV2') {
+    baseParams = getPngReportParams({ sharingData });
+  } else {
+    baseParams = getPdfReportParams({
+      sharingData,
+      optimizedForPrinting,
+    });
+  }
+  return {
+    ...baseParams,
+    objectType,
+    title: sharingData.title,
+  };
 };
 
 export const reportingPDFExportProvider = ({

src/platform/packages/private/kbn-reporting/public/tsconfig.json

@@ -27,5 +27,6 @@
     "@kbn/home-plugin",
     "@kbn/management-plugin",
     "@kbn/ui-actions-plugin",
+    "@kbn/actions-plugin",
   ]
 }

src/platform/packages/private/kbn-reporting/public/types.ts

@@ -43,3 +43,13 @@ export interface ClientConfigType {
   };
   statefulSettings: { enabled: boolean };
 }
+
+export interface ReportParamsGetterOptions {
+  objectType?: string;
+  sharingData: any;
+}
+
+export type ReportParamsGetter<
+  O extends ReportParamsGetterOptions = ReportParamsGetterOptions,
+  T = unknown
+> = (options: O) => T;