[Response Ops][Reporting] Scheduled Reports - Schedule API (#219771)

Towards #216313

> [!Note]
> This PR will be merged into a feature branch -
`elastic:scheduled-reports`
> Once this is merged, I will open a draft PR from the feature branch
into `main`

## Summary

### Schedule API

- Added internal API `/internal/reporting/schedule/{exportTypeId}`

```
POST /internal/reporting/schedule/{exportTypeId}
{
  "jobParams": <same jobParams format as existing generate single report API>,
  "schedule": {
    "rrule": <modified Task Manager rRule schema from #217728>
  }
  "notification": {
    "email": {
      "to": <optional list of email addresses>,
      "cc": <optional list of email addresses>,
      "bcc": <optional list of email addresses>
    }
}
```

- Scheduling a report creates a new `scheduled_report` type saved object
in the `.kibana-alerting-cases` index.
- Uses the same role privileges as the current generate report API, so
user must have the reporting subfeature privilege for one of the
Analytics feature privileges (Discover/Dashboard/Visualize)

## Verify

1. Run ES and Kibana with examples and install the sample web logs data
set.
2. In the DEV console, call the schedule API using

```
POST kbn:/internal/reporting/schedule/printablePdfV2
{
    "schedule": {
        "rrule": {
            "freq": 3,
            "interval": 3,
            "byhour": [12],
            "byminute": [0]
        }
    },
    "jobParams": "(browserTimezone:America/New_York,layout:(dimensions:(height:2220,width:1364),id:preserve_layout),locatorParams:!((id:DASHBOARD_APP_LOCATOR,params:(dashboardId:edf84fe0-e1a0-11e7-b6d5-4dc382ef7f5b,preserveSavedFilters:!t,timeRange:(from:now-7d/d,to:now),useHash:!f,viewMode:view))),objectType:dashboard,title:'[Logs] Web Traffic',version:'9.1.0')"
}
```

3. Verify a saved object has been created using `GET
.kibana_alerting_cases/_search?q=type:scheduled_report`
4. Try different requests with different schedules and notifications. It
should respect the email domain allowlist if configured and reject
invalid rrule schedules and email addresses.

---------

Co-authored-by: Ersin Erdal <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Ersin Erdal <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>

Author: 4 people

packages/kbn-check-mappings-update-cli/current_fields.json

@@ -918,6 +918,9 @@
     "installCount",
     "unInstallCount"
   ],
+  "scheduled_report": [
+    "createdBy"
+  ],
   "search": [
     "description",
     "title"

packages/kbn-check-mappings-update-cli/current_mappings.json

@@ -3045,6 +3045,14 @@
       }
     }
   },
+  "scheduled_report": {
+    "dynamic": false,
+    "properties": {
+      "createdBy": {
+        "type": "keyword"
+      }
+    }
+  },
   "search": {
     "dynamic": false,
     "properties": {

src/core/server/integration_tests/saved_objects/registration/type_registrations.test.ts

@@ -122,6 +122,7 @@ const previouslyRegisteredTypes = [
   'query',
   'rules-settings',
   'sample-data-telemetry',
+  'scheduled_report',
   'search',
   'search-session',
   'search-telemetry',

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

@@ -26,6 +26,7 @@ export const INTERNAL_ROUTES = {
   },
   HEALTH: prefixInternalPath + '/_health',
   GENERATE_PREFIX: prefixInternalPath + '/generate', // exportTypeId is added to the final path
+  SCHEDULE_PREFIX: prefixInternalPath + '/schedule', // exportTypeId is added to the final path
 };
 
 const prefixPublicPath = '/api/reporting';

x-pack/platform/plugins/private/canvas/server/feature.test.ts

@@ -107,7 +107,9 @@ it('Provides a feature declaration ', () => {
                   "minimumLicense": "gold",
                   "name": "Generate PDF reports",
                   "savedObject": Object {
-                    "all": Array [],
+                    "all": Array [
+                      "scheduled_report",
+                    ],
                     "read": Array [],
                   },
                   "ui": Array [
@@ -216,7 +218,9 @@ it(`Calls on Reporting whether to include Generate PDF as a sub-feature`, () =>
                   "minimumLicense": "gold",
                   "name": "Generate PDF reports",
                   "savedObject": Object {
-                    "all": Array [],
+                    "all": Array [
+                      "scheduled_report",
+                    ],
                     "read": Array [],
                   },
                   "ui": Array [

x-pack/platform/plugins/private/canvas/server/feature.ts

@@ -68,7 +68,7 @@ export function getCanvasFeature(plugins: { reporting?: ReportingStart }): Kiban
                       includeIn: 'all',
                       management: { insightsAndAlerting: ['reporting'] },
                       minimumLicense: 'gold',
-                      savedObject: { all: [], read: [] },
+                      savedObject: { all: ['scheduled_report'], read: [] },
                       api: ['generateReport'],
                       ui: ['generatePdf'],
                     },

x-pack/platform/plugins/private/reporting/kibana.jsonc

@@ -16,6 +16,7 @@
       "reporting"
     ],
     "requiredPlugins": [
+      "actions",
       "data",
       "discover",
       "encryptedSavedObjects",

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

@@ -23,6 +23,8 @@ import type {
   StatusServiceSetup,
   UiSettingsServiceStart,
 } from '@kbn/core/server';
+import { SECURITY_EXTENSION_ID } from '@kbn/core-saved-objects-server';
+import type { PluginSetupContract as ActionsPluginSetupContract } from '@kbn/actions-plugin/server';
 import type { PluginStart as DataPluginStart } from '@kbn/data-plugin/server';
 import type { DiscoverServerPluginStart } from '@kbn/discover-plugin/server';
 import type { FeaturesPluginSetup } from '@kbn/features-plugin/server';
@@ -55,8 +57,10 @@ import type { IReport, ReportingStore } from './lib/store';
 import { ExecuteReportTask, ReportTaskParams } from './lib/tasks';
 import type { ReportingPluginRouter } from './types';
 import { EventTracker } from './usage';
+import { SCHEDULED_REPORT_SAVED_OBJECT_TYPE } from './saved_objects';
 
 export interface ReportingInternalSetup {
+  actions: ActionsPluginSetupContract;
   basePath: Pick<IBasePath, 'set'>;
   docLinks: DocLinksServiceSetup;
   encryptedSavedObjects: EncryptedSavedObjectsPluginSetup;
@@ -354,6 +358,13 @@ export class ReportingCore {
     );
   }
 
+  public validateNotificationEmails(emails: string[]): string | undefined {
+    const pluginSetupDeps = this.getPluginSetupDeps();
+    return pluginSetupDeps.actions
+      .getActionsConfigurationUtilities()
+      .validateEmailAddresses(emails);
+  }
+
   /*
    * Gives synchronous access to the setupDeps
    */
@@ -374,6 +385,15 @@ export class ReportingCore {
     return dataViews;
   }
 
+  public async getSoClient(request: KibanaRequest) {
+    const { savedObjects } = await this.getPluginStartDeps();
+    const savedObjectsClient = savedObjects.getScopedClient(request, {
+      excludedExtensions: [SECURITY_EXTENSION_ID],
+      includedHiddenTypes: [SCHEDULED_REPORT_SAVED_OBJECT_TYPE],
+    });
+    return savedObjectsClient;
+  }
+
   public async getDataService() {
     const startDeps = await this.getPluginStartDeps();
     return startDeps.data;

x-pack/platform/plugins/private/reporting/server/plugin.test.ts

@@ -76,6 +76,21 @@ describe('Reporting Plugin', () => {
     );
   });
 
+  it('registers a saved object for scheduled reports', async () => {
+    plugin.setup(coreSetup, pluginSetup);
+    expect(coreSetup.savedObjects.registerType).toHaveBeenCalledWith(
+      expect.objectContaining({
+        name: 'scheduled_report',
+        namespaceType: 'multiple',
+        hidden: true,
+        indexPattern: '.kibana_alerting_cases',
+        management: {
+          importableAndExportable: false,
+        },
+      })
+    );
+  });
+
   it('logs start issues', async () => {
     // wait for the setup phase background work
     plugin.setup(coreSetup, pluginSetup);

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

@@ -27,6 +27,7 @@ import type {
 import { ReportingRequestHandlerContext } from './types';
 import { registerReportingEventTypes, registerReportingUsageCollector } from './usage';
 import { registerFeatures } from './features';
+import { setupSavedObjects } from './saved_objects';
 
 /*
  * @internal
@@ -75,6 +76,9 @@ export class ReportingPlugin
     registerReportingUsageCollector(reportingCore, plugins.usageCollection);
     registerReportingEventTypes(core);
 
+    // Saved objects
+    setupSavedObjects(core.savedObjects);
+
     // Routes
     registerRoutes(reportingCore, this.logger);