[Response Ops][Reporting] Scheduled Reports - Task (merging into feature branch)

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

@@ -72,6 +72,13 @@ export class AuthenticationExpiredError extends ReportingError {
   }
 }
 
+export class MissingAuthenticationError extends ReportingError {
+  static code = 'missing_authentication_header_error' as const;
+  public get code(): string {
+    return MissingAuthenticationError.code;
+  }
+}
+
 export class QueueTimeoutError extends ReportingError {
   static code = 'queue_timeout_error' as const;
   public get code(): string {

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

@@ -66,6 +66,7 @@ export interface BaseParams {
   objectType: string;
   title: string;
   version: string; // to handle any state migrations
+  forceNow?: string;
   layout?: LayoutParams; // png & pdf only
   pagingStrategy?: CsvPagingStrategy; // csv only
 }
@@ -152,6 +153,7 @@ export interface ReportSource {
   created_at: string; // timestamp in UTC
   '@timestamp'?: string; // creation timestamp, only used for data streams compatibility
   status: JOB_STATUS;
+  scheduled_report_id?: string;
 
   /*
    * `output` is only populated if the report job is completed or failed.

x-pack/platform/plugins/private/reporting/server/core.ts

@@ -54,7 +54,12 @@ import type { ReportingSetup } from '.';
 import { createConfig } from './config';
 import { reportingEventLoggerFactory } from './lib/event_logger/logger';
 import type { IReport, ReportingStore } from './lib/store';
-import { ExecuteReportTask, ReportTaskParams } from './lib/tasks';
+import {
+  RunSingleReportTask,
+  ReportTaskParams,
+  RunScheduledReportTask,
+  ScheduledReportTaskParamsWithoutSpaceId,
+} from './lib/tasks';
 import type { ReportingPluginRouter } from './types';
 import { EventTracker } from './usage';
 import { SCHEDULED_REPORT_SAVED_OBJECT_TYPE } from './saved_objects';
@@ -100,7 +105,8 @@ export class ReportingCore {
   private pluginStartDeps?: ReportingInternalStart;
   private readonly pluginSetup$ = new Rx.ReplaySubject<boolean>(); // observe async background setupDeps each are done
   private readonly pluginStart$ = new Rx.ReplaySubject<ReportingInternalStart>(); // observe async background startDeps
-  private executeTask: ExecuteReportTask;
+  private runSingleReportTask: RunSingleReportTask;
+  private runScheduledReportTask: RunScheduledReportTask;
   private config: ReportingConfigType;
   private executing: Set<string>;
   private exportTypesRegistry = new ExportTypesRegistry();
@@ -121,7 +127,16 @@ export class ReportingCore {
     this.getExportTypes().forEach((et) => {
       this.exportTypesRegistry.register(et);
     });
-    this.executeTask = new ExecuteReportTask(this, config, this.logger);
+    this.runSingleReportTask = new RunSingleReportTask({
+      reporting: this,
+      config,
+      logger: this.logger,
+    });
+    this.runScheduledReportTask = new RunScheduledReportTask({
+      reporting: this,
+      config,
+      logger: this.logger,
+    });
 
     this.getContract = () => ({
       registerExportTypes: (id) => id,
@@ -146,9 +161,10 @@ export class ReportingCore {
       et.setup(setupDeps);
     });
 
-    const { executeTask } = this;
+    const { runSingleReportTask, runScheduledReportTask } = this;
     setupDeps.taskManager.registerTaskDefinitions({
-      [executeTask.TYPE]: executeTask.getTaskDefinition(),
+      [runSingleReportTask.TYPE]: runSingleReportTask.getTaskDefinition(),
+      [runScheduledReportTask.TYPE]: runScheduledReportTask.getTaskDefinition(),
     });
   }
 
@@ -164,9 +180,12 @@ export class ReportingCore {
     });
 
     const { taskManager } = startDeps;
-    const { executeTask } = this;
+    const { runSingleReportTask, runScheduledReportTask } = this;
     // enable this instance to generate reports
-    await Promise.all([executeTask.init(taskManager)]);
+    await Promise.all([
+      runSingleReportTask.init(taskManager),
+      runScheduledReportTask.init(taskManager),
+    ]);
   }
 
   public pluginStop() {
@@ -326,7 +345,14 @@ export class ReportingCore {
   }
 
   public async scheduleTask(request: KibanaRequest, report: ReportTaskParams) {
-    return await this.executeTask.scheduleTask(request, report);
+    return await this.runSingleReportTask.scheduleTask(request, report);
+  }
+
+  public async scheduleRecurringTask(
+    request: KibanaRequest,
+    report: ScheduledReportTaskParamsWithoutSpaceId
+  ) {
+    return await this.runScheduledReportTask.scheduleTask(request, report);
   }
 
   public async getStore() {
@@ -385,13 +411,17 @@ export class ReportingCore {
     return dataViews;
   }
 
-  public async getSoClient(request: KibanaRequest) {
+  public async getScopedSoClient(request: KibanaRequest) {
     const { savedObjects } = await this.getPluginStartDeps();
-    const savedObjectsClient = savedObjects.getScopedClient(request, {
+    return savedObjects.getScopedClient(request, {
       excludedExtensions: [SECURITY_EXTENSION_ID],
       includedHiddenTypes: [SCHEDULED_REPORT_SAVED_OBJECT_TYPE],
     });
-    return savedObjectsClient;
+  }
+
+  public async getInternalSoClient() {
+    const { savedObjects } = await this.getPluginStartDeps();
+    return savedObjects.createInternalRepository([SCHEDULED_REPORT_SAVED_OBJECT_TYPE]);
   }
 
   public async getDataService() {

x-pack/platform/plugins/private/reporting/server/lib/store/index.ts

@@ -7,6 +7,7 @@
 
 export { Report } from './report';
 export { SavedReport } from './saved_report';
+export { ScheduledReport } from './scheduled_report';
 export { ReportingStore } from './store';
 export { IlmPolicyManager } from './ilm_policy_manager';
 

x-pack/platform/plugins/private/reporting/server/lib/store/report.test.ts

@@ -60,6 +60,61 @@ describe('Class Report', () => {
     expect(report._id).toBeDefined();
   });
 
+  it('constructs Report instance when scheduled_task_id is defined', () => {
+    const report = new Report({
+      _index: '.reporting-test-index-12345',
+      jobtype: 'test-report',
+      created_by: 'created_by_test_string',
+      max_attempts: 50,
+      payload: {
+        headers: 'payload_test_field',
+        objectType: 'testOt',
+        title: 'cool report',
+        version: '7.14.0',
+        browserTimezone: 'UTC',
+      },
+      meta: { objectType: 'test' },
+      timeout: 30000,
+      scheduled_report_id: 'foobar',
+    });
+
+    expect(report.toReportSource()).toMatchObject({
+      attempts: 0,
+      completed_at: undefined,
+      created_by: 'created_by_test_string',
+      jobtype: 'test-report',
+      max_attempts: 50,
+      meta: { objectType: 'test' },
+      payload: { headers: 'payload_test_field', objectType: 'testOt' },
+      started_at: undefined,
+      status: 'pending',
+      timeout: 30000,
+      scheduled_report_id: 'foobar',
+    });
+    expect(report.toReportTaskJSON()).toMatchObject({
+      attempts: 0,
+      created_by: 'created_by_test_string',
+      index: '.reporting-test-index-12345',
+      jobtype: 'test-report',
+      meta: { objectType: 'test' },
+      payload: { headers: 'payload_test_field', objectType: 'testOt' },
+    });
+    expect(report.toApiJSON()).toMatchObject({
+      attempts: 0,
+      created_by: 'created_by_test_string',
+      index: '.reporting-test-index-12345',
+      jobtype: 'test-report',
+      max_attempts: 50,
+      payload: { objectType: 'testOt' },
+      meta: { objectType: 'test' },
+      status: 'pending',
+      timeout: 30000,
+      scheduled_report_id: 'foobar',
+    });
+
+    expect(report._id).toBeDefined();
+  });
+
   it('updateWithEsDoc method syncs fields to sync ES metadata', () => {
     const report = new Report({
       _index: '.reporting-test-index-12345',

x-pack/platform/plugins/private/reporting/server/lib/store/report.ts

@@ -40,6 +40,7 @@ export class Report implements Partial<ReportSource & ReportDocumentHead> {
 
   public readonly status: ReportSource['status'];
   public readonly attempts: ReportSource['attempts'];
+  public readonly scheduled_report_id: ReportSource['scheduled_report_id'];
 
   // fields with undefined values exist in report jobs that have not been claimed
   public readonly kibana_name: ReportSource['kibana_name'];
@@ -97,6 +98,7 @@ export class Report implements Partial<ReportSource & ReportDocumentHead> {
     this.status = opts.status || JOB_STATUS.PENDING;
     this.output = opts.output || null;
     this.error = opts.error;
+    this.scheduled_report_id = opts.scheduled_report_id;
 
     this.queue_time_ms = fields?.queue_time_ms;
     this.execution_time_ms = fields?.execution_time_ms;
@@ -139,6 +141,7 @@ export class Report implements Partial<ReportSource & ReportDocumentHead> {
       process_expiration: this.process_expiration,
       output: this.output || null,
       metrics: this.metrics,
+      scheduled_report_id: this.scheduled_report_id,
     };
   }
 
@@ -187,6 +190,7 @@ export class Report implements Partial<ReportSource & ReportDocumentHead> {
       payload: omit(this.payload, 'headers'),
       output: omit(this.output, 'content'),
       metrics: this.metrics,
+      scheduled_report_id: this.scheduled_report_id,
     };
   }
 }