[Controls] Re-add filtering settings #172857

Heenawter · 2023-12-07T17:28:17Z

Summary

This PR re-adds UI for the filtering settings that allow authors to determine whether or not they want the unified search bar / time picker to sync with the control group.

To provide some context, we used to have these settings, but they were deemed over complicated and the UI to control them was removed back in v8.3. Here's a screenshot of what they used to look like:

Note

These settings still existed in the code, even after v8.3 - all we did was remove the UI to control them.

After customer feedback, we decided to re-add the UI to control these settings, with some simplification - specifically, after investigating how other apps (Maps, Lens, etc.) handle unified search bar settings, I noticed that the control group was the only place that considered the query bar to be different than / seperate from filter pills. Therefore, rather than having three toggles like we did previously (filter pills, query bar, and time picker), I combined the filter pills + query bar settings into a single "Apply global filters" toggle. So now, our unified search bar settings have only two toggles, like so:

This is not only simpler than it was in versions less than v8.3.0, it is also more consistent with how other apps do it.

Important

After some design feedback, I moved the old descriptions for the "Validate user selections" and "Chain controls" settings into tooltips + switched to a compressed EuiSwitch for all the settings.

All of the screenshots in this PR description have been updated to reflect this change, but some screenshots in the comments below may be out of date.

Summary of Control Group Settings by Version

Version	Screenshot
Version <= `v8.2.0`
`v8.3.0` <= version <= `v8.12.0`
This branch (`v8.13.0`)

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
Flaky Test Runner was used on any tests changed (Link)
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

Heenawter · 2023-12-08T21:49:31Z

/ci

Heenawter · 2023-12-18T18:51:29Z

/ci

Heenawter · 2023-12-19T15:04:45Z

src/plugins/controls/public/control_group/control_group_strings.ts

+      getUseGlobalFiltersTitle: () =>
+        i18n.translate('controls.controlGroup.management.filtering.useGlobalFilters', {
+          defaultMessage: 'Apply global filters to controls',
+        }),
+      getUseGlobalTimeRangeTitle: () =>
+        i18n.translate('controls.controlGroup.management.filtering.useGlobalTimeRange', {
+          defaultMessage: 'Apply global time range to controls',


Unfortunately, there is very little consistency in the copy different apps use for their "unified search bar" setting toggles:

App Screenshot

Maps

Lens

TSVB

So, since there didn't seem to be universal phrasing, I decided that the Maps copy is the best match in this case and went with that - open to suggestions, though 🤔

cc @amyjtechwriter for the copy here 👀

elasticmachine · 2023-12-19T15:06:40Z

Pinging @elastic/kibana-presentation (Team:Presentation)

Heenawter · 2023-12-19T15:38:20Z

As part of this, I did a small redesign of the control group settings menu. Could you take a quick look @andreadelrio? Just want to make sure the new form group labels I added make sense - thank you!! 🙇

UPDATE
Made the following changes based on offline feedback:

amyjtechwriter

LGTM - copy wise. I really appreciate that you took the time to provide context (I would have been lost without it) and look at the other copy used in other apps!

…-12-06

nreese

LGTM
code review only

…-12-06

kibana-ci · 2023-12-19T23:21:51Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 6c1e628

Failed CI Steps

FTR Configs #14

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`controls`	157	158	+1

Async chunks

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

id	before	after	diff
`controls`	200.2KB	199.7KB	-524.0B

Page load bundle

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

id	before	after	diff
`controls`	39.8KB	39.9KB	+109.0B

History

💔 Build #184378 failed cb95249
💔 Build #184375 failed 914b94d
💔 Build #184343 failed 9dc7d69
💚 Build #184057 succeeded 5ad6a15
💔 Build #182824 failed 120535b

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @Heenawter

VVKWork · 2023-12-20T05:09:24Z

Thanks. We will adopt as early as possible. Sometimes, it takes time to adopt/ usual cycles; organisational processes.

Heenawter added release_note:enhancement Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas loe:small Small Level of Effort impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Project:Controls labels Dec 7, 2023

Heenawter self-assigned this Dec 7, 2023

Heenawter force-pushed the controls-ignore-global-filters-settings_2023-12-06 branch from 7681953 to 733e7bd Compare December 8, 2023 16:04

Heenawter force-pushed the controls-ignore-global-filters-settings_2023-12-06 branch from 120535b to 04b2358 Compare December 8, 2023 23:23

Heenawter force-pushed the controls-ignore-global-filters-settings_2023-12-06 branch from 04b2358 to 5ad6a15 Compare December 18, 2023 17:37

Heenawter force-pushed the controls-ignore-global-filters-settings_2023-12-06 branch from c546135 to 0cb4bd1 Compare December 18, 2023 20:04

Heenawter added 4 commits December 18, 2023 14:25

Add filtering settings

f783e1b

Clean up + add i18n

6fde045

Add tests

2fb86ba

Remove unused translations

2128b09

Heenawter force-pushed the controls-ignore-global-filters-settings_2023-12-06 branch 5 times, most recently from 0c50e8b to 974f2ea Compare December 19, 2023 15:02

Make new test less flaky

9dc7d69

Heenawter force-pushed the controls-ignore-global-filters-settings_2023-12-06 branch from 974f2ea to 9dc7d69 Compare December 19, 2023 15:03

Heenawter commented Dec 19, 2023

View reviewed changes

Heenawter marked this pull request as ready for review December 19, 2023 15:06

Heenawter requested a review from a team as a code owner December 19, 2023 15:06

Heenawter requested review from andreadelrio and amyjtechwriter December 19, 2023 15:38

amyjtechwriter approved these changes Dec 19, 2023

View reviewed changes

Heenawter and others added 3 commits December 19, 2023 10:48

Merge branch 'main' into controls-ignore-global-filters-settings_2023…

875c261

…-12-06

Implement design feedback

914b94d

Fix imports

cb95249

nreese self-requested a review December 19, 2023 20:39

nreese approved these changes Dec 19, 2023

View reviewed changes

Merge branch 'main' into controls-ignore-global-filters-settings_2023…

6c1e628

…-12-06

Heenawter merged commit 2486ed5 into elastic:main Dec 19, 2023
37 checks passed

Heenawter deleted the controls-ignore-global-filters-settings_2023-12-06 branch December 19, 2023 23:24

Heenawter added backport:skip This commit does not require backporting and removed impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. labels Dec 19, 2023

kibanamachine added the v8.13.0 label Dec 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Controls] Re-add filtering settings #172857

[Controls] Re-add filtering settings #172857

Heenawter commented Dec 7, 2023 •

edited

Heenawter commented Dec 8, 2023

Heenawter commented Dec 18, 2023

Heenawter Dec 19, 2023

Heenawter Dec 19, 2023

elasticmachine commented Dec 19, 2023

Heenawter commented Dec 19, 2023 •

edited

amyjtechwriter left a comment

nreese left a comment

kibana-ci commented Dec 19, 2023

VVKWork commented Dec 20, 2023 •

edited

[Controls] Re-add filtering settings #172857

[Controls] Re-add filtering settings #172857

Conversation

Heenawter commented Dec 7, 2023 • edited

Summary

Summary of Control Group Settings by Version

Checklist

For maintainers

Heenawter commented Dec 8, 2023

Heenawter commented Dec 18, 2023

Heenawter Dec 19, 2023

Choose a reason for hiding this comment

Heenawter Dec 19, 2023

Choose a reason for hiding this comment

elasticmachine commented Dec 19, 2023

Heenawter commented Dec 19, 2023 • edited

amyjtechwriter left a comment

Choose a reason for hiding this comment

nreese left a comment

Choose a reason for hiding this comment

kibana-ci commented Dec 19, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

VVKWork commented Dec 20, 2023 • edited

Heenawter commented Dec 7, 2023 •

edited

Heenawter commented Dec 19, 2023 •

edited

VVKWork commented Dec 20, 2023 •

edited