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

[umbopepato]

Summary

• Implements the flyout to schedule reports
• Adds a Schedules table to the Stack Management > Reporting page to view schedules
• Updates the Reports table to show information about scheduled reports

Verification steps

🐞 Happy Path

• Add the following configuration to your Kibana config file

  notifications.connectors.default.email: gmail
  xpack.actions.preconfigured:
    gmail:
      name: 'email: my gmail'
      actionTypeId: '.email'
  

• Log in as an admin user or user with Reporting privileges and a license != basic
• If you don't have data in Kibana, navigate to Home > Try sample data and activate a sample data set
• Create a Dashboard or Discover session
• Open the ⬇️ (Export) menu in the toolbar
• Click Schedule export
• Schedule reports with different combinations of file name, export type, recurrence schedule and email notification settings
• Navigate to Stack Management > Reporting
• Check that the scheduled reports match the displayed items in the Reports and Schedules tabs (⚠️ some jobs might not have started because of the recurrence rule so you might not find the reports immediately)

⚡️ Edge Cases

Missing default notifications email connector

• Start Kibana without the default email connector from point n.1 of the happy path
• When trying to schedule a report, the flyout should show a callout informing the user about the missing email connector

Unmet prerequisites

• Start ES with any of the following flags: -E xpack.security.enabled=false or -E xpack.security.authc.api_key.enabled=false
• The Schedule export button should not appear in the Export menu

Unsupported license

• Log in as a user with a basic license or without capabilities to generate reports
• The Schedule export button should not appear in the Export menu

Users without Manage Scheduled Reports privilege

• Create a role with sufficient privileges to access and export any object type (Dashboards, Discover, ...), do not grant the Manage Scheduled Reports privilege (under Stack Management)
• Create a user with this role, without an email address
• Open the Schedule export flyout
• Check that the Send by email field is disabled, showing a hint about the user profile missing an email address
• Add an email address to the user (for the changes to take effect you might have to renew the session, logging back in)
• Check that the Send by email toggle is now enabled
• Check that when toggling email notifications on, the To field is disabled and precompiled with the user's email address

Flyout form validation

• File name should be required
• To should not allow to insert invalid email addresses
• To should not allow to insert unallowed email addresses (not in allowlist)
• Recurrence subform should show presets based on the current datetime

❌ Failure Cases

Known issues

• PDF print option is not displayed in readOnly mode
• Console error due to compressed attribute wrongly forwarded by form-hook-lib to DOM element (this is likely a form lib issue):
  
• Email validation errors accumulate instead of replacing the previous one (again looks like a fom lib issue):
  https://github.com/user-attachments/assets/f2dc7a46-a3a9-465d-b8a1-3187b200f9b9

Screenshots

Health API error:

Health API loading state:

Health API success with some missing prerequisites:

Form validation:

Success toast:

Failure toast:

Print format toggle:

Missing notifications email connector callout:

User without Manage Scheduled Reports privilege and without email address in profile

User without Manage Scheduled Reports privilege with email address in profile

Release Notes

Added the ability to schedule reports with a recurring schedule and view previously scheduled reports

References

Closes #216321
Closes #216322

Checklist

• Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
• Documentation was added for features that require explanation or tutorials
• Unit or functional tests were updated or added to match the most common scenarios
• The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

[elasticmachine]

Pinging @elastic/response-ops (Team:ResponseOps)

[jughosta]

Shouldn't it be await exports.closeExportFlyout();?
Same in other modified tests.

[umbopepato]

Hey @jughosta! I know, it's a bit unintuitive. The reporting.openExportPopover() doesn't open the export flyout, but the export popover. Some tests were failing because that popover might remain open/reopen after generating an export from the flyout, resulting in some elements below it being unclickable. Since we don't have a close button, I used the same strategy as in other fn tests in Kibana which is clicking again on the button that opens the popover to close it 🙂

[jughosta]

Okay, thanks for explaining! Probably could be renamed into toggleExportPopover if there is no "close" action.

[jughosta]

Data Discovery changes LGTM

[eokoneyo]

Shared UX changes LGTM

[umbopepato]

I had to do this imperatively since the form defaultValue doesn't seem to be reactive

[cnasikas]

You need a different pattern to avoid this useEffect. Not suggesting to do it now but it could be like this:

const FormWrapper = ({ initialState, hasManageReportingPrivilege, email }) => {
  const form = useForm({ defaultValue: initialState });
  <Form form={form}> .... </Form>
}

const ScheduledReportFlyoutContent = () => {

if (isUserProfileLoading || isLoadingSomethingElse) {
 return null;
}

// all data are available. we can construct the initial state
const initialState = {....}

return <FormWrapper {...someProps} initialState={initialState}/>
}

[cnasikas]

I am a bit confused by !hasManageReportingPrivilege. Why is that? What happens when I have reporting privileges?

[umbopepato]

If you're a reporting manager, then the choice of email recipients is totally free. Non-managers can only email to themselves

[tsullivan]

should space_id be optional?

[tsullivan]

It should be possible to useKibana to acquire the http setup service

[tsullivan]

const { userProfile } = useKibana().services;

[tsullivan]

const { http } = useKibana().services

[tsullivan]

Nit: you can use the "concise body arrow function" to return an object literal, and leave out the return:

export const createScheduledReportShareIntegration = ({
  apiClient,
  services,
}: CreateScheduledReportProviderOptions): ExportShareDerivatives => ({
  id: 'scheduledReports',
  ...
});

[tsullivan]

Based on some of my comments about leveraging the useKibana hook, you might want to add toasts and userProfile to this set of services.

[tsullivan]

Not important for this PR, but we have a new stateful service that provides context to internal components, which replaces KibanaRenderContextProvider.

  ReactDOM.render(
    coreStart.rendering.addContext(
      <KibanaContextProvider services={services}>
      ...
      </KibanaContextProvider>
    ),
    element
  );

[tsullivan]

Left some comments from reading the code. I'm very excited to see this coming through!

[cnasikas]

Great work! So nice to see this feature live. I really appreciate the hard work you both put on this feature and I know a lot of my comments would be done if you had more time. I tested with different roles and licenses and used the domain_allowlist configuration. Everything works as expected. I found the following small issues that can be addressed on a different PR:

• If I configured the Visualization feature privilege to not have the reporting privilege I can see the schedule button. Then when I open the flyout the file type selection is empty.
• For some reason, I get an error (403) from the ILM API. I am logged in as a super user. The error I get is related to index access, but I went to discover, and I can see the docs in the index. There was a bug where when I opened the flyout to view the config, I was getting a loading spinner. It was fixed with the latest commit.

• I get some errors in the console with the report generation. It is not related to this PR but I wanted to mention it.

2025-06-23T15:34:05.944+03:00][WARN ][plugins.security.routes] API keys are intended for programmatic access. Do not use API keys to authenticate access via a web browser.
[2025-06-23T15:34:05.950+03:00][WARN ][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting] Chromium received a non-OK response (404) for request https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings
[2025-06-23T15:34:05.950+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Failed to load resource: the server responded with a status of 404 ()", url: "https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings" }
[2025-06-23T15:34:05.996+03:00][INFO ][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting] handled 237 page requests
[2025-06-23T15:34:05.998+03:00][WARN ][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting] Chromium received a non-OK response (404) for request https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings
[2025-06-23T15:34:05.998+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Failed to load resource: the server responded with a status of 404 ()", url: "https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings" }
[2025-06-23T15:34:06.059+03:00][WARN ][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting] Chromium received a non-OK response (404) for request https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings
[2025-06-23T15:34:06.060+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Failed to load resource: the server responded with a status of 404 ()", url: "https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings" }
[2025-06-23T15:34:06.102+03:00][WARN ][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting] Chromium received a non-OK response (404) for request https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings
[2025-06-23T15:34:06.102+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Using kebab-case for css properties in objects is not supported. Did you mean pageBreakInside?", url: "https://localhost:5602/XXXXXXXXXXXX/bundles/core/core.entry.js" }
[2025-06-23T15:34:06.102+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Failed to load resource: the server responded with a status of 404 ()", url: "https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings" }
[2025-06-23T15:34:06.124+03:00][WARN ][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting] Chromium received a non-OK response (404) for request https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings
[2025-06-23T15:34:06.125+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Failed to load resource: the server responded with a status of 404 ()", url: "https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings" }
[2025-06-23T15:34:06.224+03:00][WARN ][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting] Chromium received a non-OK response (404) for request https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings
[2025-06-23T15:34:06.225+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Using kebab-case for css properties in objects is not supported. Did you mean backgroundImage?", url: "https://localhost:5602/XXXXXXXXXXXX/bundles/core/core.entry.js" }
[2025-06-23T15:34:06.283+03:00][WARN ][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting] Chromium received a non-OK response (404) for request https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings
[2025-06-23T15:34:06.283+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Using kebab-case for css properties in objects is not supported. Did you mean borderRadius?", url: "https://localhost:5602/XXXXXXXXXXXX/bundles/core/core.entry.js" }
[2025-06-23T15:34:06.284+03:00][WARN ][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting] Chromium received a non-OK response (404) for request https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings
[2025-06-23T15:34:06.289+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Favorites service is not available for current user", url: "https://localhost:5602/XXXXXXXXXXXX/bundles/core/core.entry.js" }
[2025-06-23T15:34:06.289+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Failed to load resource: the server responded with a status of 404 ()", url: "https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings" }
[2025-06-23T15:34:06.289+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Failed to load resource: the server responded with a status of 404 ()", url: "https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings" }
[2025-06-23T15:34:06.289+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Failed to load resource: the server responded with a status of 404 ()", url: "https://localhost:5602/internal/security/user_profile?dataPath=avatar%2CuserSettings" }
[2025-06-23T15:34:06.430+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Warning: render(...): Replacing React-rendered children with a new root component. If you intended to update the children of this node, you should instead have the existing children update their state and render the new components instead of calling ReactDOM.render.", url: "https://localhost:5602/XXXXXXXXXXXX/bundles/core/core.entry.js" }
[2025-06-23T15:34:07.406+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Warning: render(...): Replacing React-rendered children with a new root component. If you intended to update the children of this node, you should instead have the existing children update their state and render the new components instead of calling ReactDOM.render.", url: "https://localhost:5602/XXXXXXXXXXXX/bundles/core/core.entry.js" }
[2025-06-23T15:34:07.454+03:00][ERROR][plugins.reporting.pdf-export-v2.execute-job:e199009d-d156-45c1-9764-9dc0d2b401fe.screenshotting.browser-driver.headless-browser-console] Error in browser console: { message: "Warning: render(...): Replacing React-rendered children with a new root component. If you intended to update the children of this node, you should instead have the existing children update their state and render the new components instead of calling ReactDOM.render.", url: "https://localhost:5602/XXXXXXXXXXXX/bundles/core/core.entry.js" }

• The "Go to Kibana" link in the email footer links to Kibana and not to the scheduling page
• The reporting document has the @timestamp set in the 1970 year.

• The tooltip over the app icon does not show a human friendly text

Regarding my comments in the code we can address most of them in a different PR. Some thoughts which can also be addressed in a different PR:

• We changed the recurring form handles the startDate being undefined. This lead to a lot checks for undefined values. Could we just pass the startDate as now and then remove it before sending it to the backend?
• A lot of code missing unit tests
• No basic e2e tests
• In a lot of places in the code we could export the logic in smaller functions to make it more readable and avoid using useMemo when calculating primitive values.

[cnasikas]

Don't we have a get by ID API?

[js-jankisalvi]

No we don't, right @ymao1 ?

[cnasikas]

Note: Because we filter out the reports that do not match the ID, let's add another item here.

[cnasikas]

Shouldn't this be part of x-pack/platform/plugins/private/reporting/public/management/mutation_keys.ts?

[umbopepato]

It should! I was going to move this yesterday but waited to have a full CI cycle. I'll keep this in mind for the improvements after merge 🙂

[cnasikas]

Suggested change

	it('does allow user with reporting privileges o navigate to the Schedules tab', async () => {
	it('does allow user with reporting privileges to navigate to the Schedules tab', async () => {

[cnasikas]

Could we use Weekday enum exported from src/platform/packages/shared/kbn-rrule/types.ts?

[cnasikas]

I think submit also validates, and it passed the isValid on the onSubmit method.

[umbopepato]

I didn't know about this one, it looked like the lib just didn't validate it (see point n.6 of Ying's review)

[cnasikas]

Should we put a limit on the number of characters a title should have?

[cnasikas]

I think it would be better if we invalidated all queries like ['reporting', 'scheduledList'].

[cnasikas]

I am skeptical about this pattern. Could we async load inside one of the createScheduledReportShareIntegration methods? Also, does the sharing export support registering on the start method?

[cnasikas]

Based on the description of the above test, we should add another valid email.

[joana-cps]

@js-jankisalvi default number of rows in both tables should be 50

[kibanamachine]

Starting backport for target branches: 8.19

https://github.com/elastic/kibana/actions/runs/15854866850

[elasticmachine]

💛 Build succeeded, but was flaky

• Buildkite Build
• Commit: 7d281d5

Failed CI Steps

• FTR Configs #61
• FTR Configs #134

Test Failures

• [job] [logs] FTR Configs #134 / Reporting Functional Tests with Security enabled Access to Management > Reporting Schedules does not allow user to access schedules that does not have reporting privileges
• [job] [logs] FTR Configs #61 / Unified Tabs Examples Managing Unified Tabs can edit tab label with keyboard events

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
reporting	163	214	+51

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
@kbn/reporting-common	97	99	+2
@kbn/reporting-public	103	109	+6
share	87	90	+3
total			+11

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
alerting	92.0KB	93.7KB	+1.6KB
fleet	2.1MB	2.1MB	+452.0B
reporting	110.7KB	158.3KB	+47.6KB
total			+49.7KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
@kbn/reporting-common	13	14	+1
share	15	21	+6
total			+7

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
reporting	50.8KB	53.9KB	+3.1KB
share	52.1KB	52.1KB	+26.0B
total			+3.1KB

Unknown metric groups

API count

id	before	after	diff
@kbn/reporting-common	107	109	+2
@kbn/reporting-public	110	116	+6
share	153	156	+3
total			+11

async chunk count

id	before	after	diff
reporting	4	7	+3

ESLint disabled in files

id	before	after	diff
reporting	0	1	+1

ESLint disabled line counts

id	before	after	diff
reporting	5	9	+4

Total ESLint disabled count

id	before	after	diff
reporting	5	10	+5

History

• 💔 Build #311592 failed 505aeb0

[kibanamachine]

💔 All backports failed

Status	Branch	Result
❌	8.19	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 224849

Questions ?

Please refer to the Backport tool documentation

[umbopepato]

💚 All backports created successfully

Status	Branch	Result
✅	8.19

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation