[ReponseOps][Reporting] Add search functionality to scheduled reports list by umbopepato · Pull Request #243841 · elastic/kibana

umbopepato · 2025-11-21T15:15:12Z

📄 Summary

Add a search query parameter to the list scheduled reports endpoint
Forward the search string to the SO find call, searching on fields title and createdBy
Add a search field and search button to the scheduled reports page

🧪 Verification steps

Create multiple scheduled reports with different titles and authors
Verify that searching by title and author filters the table accordingly

📷 Screenshots

⏪ Backport rationale

Not backporting since this is a new functionality

🔗 References

Closes https://github.com/elastic/kibana-team/issues/2235
Closes https://github.com/elastic/kibana-team/issues/2234

Release Notes

Added the possibility to search scheduled reports by title and creator.

☑️ 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
~~If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list~~
~~This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.~~
Flaky Test Runner was used on any tests changed
The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines
Review the backport guidelines and apply applicable backport:* labels.

elasticmachine · 2025-11-21T15:15:18Z

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

joana-cps

Can we drop the search button for consistency with other pages?

I see that we use the refresh button in some pages 🤔 but we don't use this search button.

adcoelho · 2025-11-24T11:03:59Z

...orm/plugins/private/reporting/server/services/scheduled_reports/scheduled_reports_service.ts

        type: SCHEDULED_REPORT_SAVED_OBJECT_TYPE,
        page,
        perPage: size,
+        search,


Could you please update the unit tests accordingly? 👀

Wait, I did update the tests with the search 🤔
https://github.com/elastic/kibana/pull/243841/files#diff-bebab728abf3edd65367cfc64a2e8a609bf2555e28ba538667f033fdcd1ea804

adcoelho · 2025-11-24T11:07:12Z

...k/platform/plugins/private/reporting/public/management/components/report_schedules_table.tsx

+  search: string;
 }

-export const ReportSchedulesTable = (props: { apiClient: ReportingAPIClient }) => {


I am confused by this, how was apiClient here without a warning? I don't see it used anywhere else.

I was surprised too! But it seems like the apiClient wasn't used anymore

adcoelho · 2025-11-24T12:27:17Z

I found a small bug when clicking the "clear text" icon on the search bar.

This button deletes the search, but does not update the table immediately; it still requires an enter keypress.

adcoelho · 2025-11-24T12:31:48Z

...k/platform/plugins/private/reporting/public/management/components/report_schedules_table.tsx

-        onChange={tableOnChangeCallback}
-        rowProps={() => ({ 'data-test-subj': 'scheduledReportRow' })}
-      />
+      <EuiFlexItem grow={false}>


NBD but you could also update 'renders table correctly' in report_schedules_table.test.tsx to expect the search bar.

Maybe also asserting search gets called with text on button press in a different unit test.

+1, let's put some unit tests.

Added tests! ✅

adcoelho

Overall LGTM. I found a small bug and think 2 unit tests could be added 🙌

cnasikas

Code review only. I will test and review again after @joana-cps feedback is addressed.

cnasikas · 2025-11-28T11:27:59Z

...k/platform/plugins/private/reporting/public/management/components/report_schedules_table.tsx

+              placeholder={i18n.translate(
+                'xpack.reporting.schedules.table.searchPlaceholderTitle',
+                {
+                  defaultMessage: 'Search scheduled reports by title or creator',


Suggested change

defaultMessage: 'Search scheduled reports by title or creator',

defaultMessage: 'Search scheduled reports',

cnasikas · 2025-11-28T11:30:02Z

...k/platform/plugins/private/reporting/public/management/components/report_schedules_table.tsx

    useState<boolean>(false);
  const [isDeleteModalConfirmationOpen, setIsDeleteModalConfirmationOpen] =
    useState<boolean>(false);
+  const [searchText, setSearchText] = useState('');


Instead of having a new variable for the search, could we use the queryParams? The onChange can call the setQueryParams.

I though I needed an intermediate state to save the text and update the query params on all relevant events, but turns out it works perfectly with onSearch, thanks for the suggestion! 😊

cnasikas · 2025-11-28T11:30:17Z

...k/platform/plugins/private/reporting/public/management/components/report_schedules_table.tsx

+                }
+              )}
+              value={searchText}
+              onChange={(event) => {


nit: Let's use a useCallback.

Removed in favor of updating query params directly

kibanamachine · 2025-11-28T14:10:22Z

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#9945

[✅] x-pack/platform/test/reporting_api_integration/reporting_and_security.config.ts: 200/200 tests passed.

see run history

…reports-list-filters

umbopepato · 2025-12-02T15:39:08Z

Can we drop the search button for consistency with other pages?

I see that we use the refresh button in some pages 🤔 but we don't use this search button.

This Search button resulted from a reasoning about invalidating/refetching differences between this and the other pages but I agree it doesn't make too much sense to compromise consistency. So I made sure to replicate a very similar behavior and switched to using the same button ✅

umbopepato · 2025-12-02T15:41:37Z

I found a small bug when clicking the "clear text" icon on the search bar.
This button deletes the search, but does not update the table immediately; it still requires an enter keypress.

Yeah I was trying to rely solely on onSearch as a trigger, but I quickly realized that doesn't make too much sense (see here also) so I added blur as an additional trigger, and switched to a more consistent Refresh button that actually refetches the query

umbopepato · 2025-12-02T15:51:19Z

...k/platform/plugins/private/reporting/server/saved_objects/scheduled_report/model_versions.ts

+      },
+    ],
+    schemas: {
+      forwardCompatibility: rawScheduledReportSchemaV5.extends({}, { unknowns: 'ignore' }),


I’ve never found myself having to introduce a new SO version that only changes the mappings, but not the schema. SO docs showed an example without schemas at all, but CI errored because of missing forwardCompatibility, so I added it. But using the schema v4 in model version 5 didn't feel right, so I advanced the schema version to 5, just re-exporting all from schema 4. I don't know if this is the best way to do it, so any suggestion is appreciated

I think what you did here is fine.

umbopepato · 2025-12-02T15:53:12Z

...tform/plugins/private/reporting/public/management/components/report_schedules_table.test.tsx

    },
  },
 });
+const mockValidateEmailAddresses = jest.fn().mockReturnValue([]);


Like in other tests, this was mocked incorrectly as async, but the original method is sync

…reports-list-filters

cnasikas · 2025-12-03T11:08:10Z

...k/platform/plugins/private/reporting/server/saved_objects/scheduled_report/model_versions.ts

+      },
+    ],
+    schemas: {
+      forwardCompatibility: rawScheduledReportSchemaV5.extends({}, { unknowns: 'ignore' }),


I think what you did here is fine.

cnasikas · 2025-12-03T11:16:37Z

...k/platform/plugins/private/reporting/public/management/components/report_schedules_table.tsx

+                }
+              )}
+              onSearch={updateSearch}
+              onBlur={onSearchFieldBlur}


It's great to see the search functionality coming together! Regarding the API call trigger: using onBlur for the final search results is likely to create a slightly confusing experience. We generally follow the pattern where the user explicitly signals their intent (e.g., pressing Enter) before firing the main search API call. I suggest we remove it. This will reduce unnecessary API calls and improve UX clarity. Wdyt?

To be honest, this came from trying - and failing - to be consistent with other similar pages. Take Maintenance Windows for example, where we trigger searches only onSearch and when the user clears the input. This has some confusing implications too imo, for example if you trigger a search, then change the text without pressing enter, then press 🔄 Refresh, perhaps expecting that it would trigger a search with the changed text 👉 the list is refetched but with the old search text, leading to an inconsistent UI state...

To be even more honest, I think the cleanest experience is what the KQL bar offers: after editing the text, the 🔄 Refresh button changes to ➡️ Update to signal that the last run query doesn't correspond to the current search text and suggests to the user that pressing it not only will trigger a new query, but it will use the new search terms:

To get the best of both worlds, I could re-introduce an intermediate state to save the search text, then trigger searches only onSearch and when pressing 🔄 Refresh, making sure to update the search text in the query instead of only refetch()ing it, let me know what you prefer. Otherwise we can always stick to the onSearch + clear behavior of other pages.

(I could also implement the 🔄 Refresh vs ➡️ Update semantics, but we don't use it in other pages so that would lead to inconsistencies)

Thanks for sharing the UX issues we have with the other pages. I was not aware of the UX nuances. I would suggest removing the onBlur handler, merging the PR, and opening an issue to address these UX issues on all of our pages. Wdyt?

Sure! Let's do that then 🙂

…reports-list-filters

…pepato/kibana into 2235-scheduled-reports-list-filters

elasticmachine · 2025-12-03T15:46:05Z

⏳ Build in-progress, with failures

Buildkite Build
Commit: 3ae2ace

Failed CI Steps

Test Failures

[job] [logs] Jest Tests #21 / ReportSchedulesTable should search schedules with the provided search text on blur
[job] [logs] Jest Tests #21 / ReportSchedulesTable should search schedules with the provided search text on blur

History

…reports-list-filters

… list (elastic#243841) ## 📄 Summary - Add a `search` query parameter to the list scheduled reports endpoint - Forward the search string to the SO find call, searching on fields `title` and `createdBy` - Add a search field and search button to the scheduled reports page <details> <summary> ## 🧪 Verification steps </summary> 1. Create multiple scheduled reports with different titles and authors 2. Verify that searching by title and author filters the table accordingly </details> <details> <summary> ## 📷 Screenshots </summary> <img width="1236" height="544" alt="image" src="https://github.com/user-attachments/assets/882e5c72-c684-4b16-8ee9-d5ca85d7a095" /> </details> ## ⏪ Backport rationale Not backporting since this is a new functionality ## 🔗 References Closes elastic/kibana-team#2235 Closes elastic/kibana-team#2234 ## Release Notes Added the possibility to search scheduled reports by title and creator. ## ☑️ Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] ~~If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)~~ - [ ] ~~This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations.~~ - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [x] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

Add search functionality to scheduled reports list

186fa76

umbopepato requested a review from a team as a code owner November 21, 2025 15:15

umbopepato added backport:skip This PR does not require backporting Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// release_note:feature Makes this part of the condensed release notes v9.3.0 labels Nov 21, 2025

Changes from node scripts/check_mappings_update --fix

b0df5ce

elastic-vault-github-plugin-prod bot requested a review from a team as a code owner November 21, 2025 15:30

joana-cps reviewed Nov 24, 2025

View reviewed changes

adcoelho reviewed Nov 24, 2025

View reviewed changes

adcoelho approved these changes Nov 24, 2025

View reviewed changes

jloleysens approved these changes Nov 25, 2025

View reviewed changes

cnasikas reviewed Nov 28, 2025

View reviewed changes

umbopepato added 2 commits December 2, 2025 14:13

Merge branch 'main' of github.com:elastic/kibana into 2235-scheduled-…

365b937

…reports-list-filters

Implement suggested changes

8ef978a

umbopepato force-pushed the 2235-scheduled-reports-list-filters branch from 7287089 to 8ef978a Compare December 2, 2025 13:47

umbopepato added 3 commits December 2, 2025 15:09

Add missing search fields

a14dce4

Add more table search unit tests

f2253ff

Merge branch 'main' of github.com:elastic/kibana into 2235-scheduled-…

3037139

…reports-list-filters

Fix SO model version missing forwardCompatibility

291bc1b

umbopepato commented Dec 2, 2025

View reviewed changes

Merge branch 'main' of github.com:elastic/kibana into 2235-scheduled-…

87583e7

…reports-list-filters

Merge branch 'main' into 2235-scheduled-reports-list-filters

bde4fa6

cnasikas approved these changes Dec 3, 2025

View reviewed changes

umbopepato added 3 commits December 3, 2025 15:30

Merge branch 'main' of github.com:elastic/kibana into 2235-scheduled-…

5de8bab

…reports-list-filters

Remove search on blur

2940c77

Merge branch '2235-scheduled-reports-list-filters' of github.com:umbo…

3ae2ace

…pepato/kibana into 2235-scheduled-reports-list-filters

cnasikas enabled auto-merge (squash) December 3, 2025 14:40

umbopepato added 2 commits December 3, 2025 16:57

Remove unnecessary test

239ac45

Merge branch 'main' of github.com:elastic/kibana into 2235-scheduled-…

664ef39

…reports-list-filters

cnasikas merged commit 1710de6 into elastic:main Dec 3, 2025
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ReponseOps][Reporting] Add search functionality to scheduled reports list#243841

[ReponseOps][Reporting] Add search functionality to scheduled reports list#243841
cnasikas merged 15 commits intoelastic:mainfrom
umbopepato:2235-scheduled-reports-list-filters

umbopepato commented Nov 21, 2025

elasticmachine commented Nov 21, 2025

joana-cps left a comment

adcoelho Nov 24, 2025

cnasikas Nov 28, 2025

umbopepato Dec 2, 2025

adcoelho Nov 24, 2025

umbopepato Dec 2, 2025

adcoelho commented Nov 24, 2025

adcoelho Nov 24, 2025 •

edited

Loading

cnasikas Nov 28, 2025 •

edited

Loading

umbopepato Dec 2, 2025

adcoelho left a comment

cnasikas left a comment •

edited

Loading

cnasikas Nov 28, 2025

cnasikas Nov 28, 2025

umbopepato Dec 2, 2025

cnasikas Nov 28, 2025

umbopepato Dec 2, 2025

kibanamachine commented Nov 28, 2025

umbopepato commented Dec 2, 2025

umbopepato commented Dec 2, 2025 •

edited

Loading

umbopepato Dec 2, 2025 •

edited

Loading

cnasikas Dec 3, 2025

umbopepato Dec 2, 2025

cnasikas Dec 3, 2025

cnasikas Dec 3, 2025 •

edited

Loading

umbopepato Dec 3, 2025

cnasikas Dec 3, 2025

umbopepato Dec 3, 2025

elasticmachine commented Dec 3, 2025

Uh oh!

Labels

7 participants

	defaultMessage: 'Search scheduled reports by title or creator',
	defaultMessage: 'Search scheduled reports',

Conversation

umbopepato commented Nov 21, 2025

📄 Summary

🧪 Verification steps

📷 Screenshots

⏪ Backport rationale

🔗 References

Release Notes

☑️ Checklist

elasticmachine commented Nov 21, 2025

joana-cps left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adcoelho commented Nov 24, 2025

adcoelho Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

cnasikas Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adcoelho left a comment

Choose a reason for hiding this comment

cnasikas left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibanamachine commented Nov 28, 2025

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#9945

umbopepato commented Dec 2, 2025

umbopepato commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

umbopepato Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cnasikas Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Dec 3, 2025

⏳ Build in-progress, with failures

Failed CI Steps

Test Failures

History

Uh oh!

Labels

7 participants

adcoelho Nov 24, 2025 •

edited

Loading

cnasikas Nov 28, 2025 •

edited

Loading

cnasikas left a comment •

edited

Loading

umbopepato commented Dec 2, 2025 •

edited

Loading

umbopepato Dec 2, 2025 •

edited

Loading

cnasikas Dec 3, 2025 •

edited

Loading