Ovel/apply filters logic #5985

ondrejvelisek · 2025-02-27T12:15:22Z

feat(sdk-ui-filters): add onSelect callback prop to attribute filter

the callback is called when filter working selection is changed

feat(sdk-ui-filters): create new state for working filters

update the state on attribute filters change

feat(sdk-ui-dashboard): add apply button to dashboard filter bar

add command to apply staged working filters

fix(sdk-ui-dashboard): reloading insights after filter select

dispatch setAttributeFilterDisplayForm cmd into working state
dispatch FilterContextChanged event after apply all

feat(sdk-ui-dashboard): make apply all button disable if no change

fix wrong working negative selection

feat(sdk-ui-dashboard): make date filter change working filter state

feat(sdk-ui-dashboard): make child filters use working parent filters

only when filters apply mode all_at_once

feat(sdk-ui-dashboard): make child filters use working parent date filters

only when filters apply mode all_at_once

feat(sdk-ui-dashboard): translate filters all at once apply button

feat(sdk-ui-dashboard): store only changes in working filter state

this way we do not need to synchronize other fields
which makes it easier to maintain

Important

Please, don't forget to run rush change for the commits that introduce new features or significant changes 🙏 This information is used to generate the change log.

Run extended test by pull request comment

Commands can be triggered by posting a comment with specific text on the pull request. It is possible to trigger multiple commands simultaneously.

extended-test --backstop | --integrated | --isolated | --record [--filter <file1>,<file2>,...,<fileN>]

Explanation

--backstop The command to run screen tests.
--integrated The command to run integrated tests against the live backend.
--isolated The command to run isolated tests against recordings.
--record The command to create new recordings for isolated tests.
--filter (Optional) A comma-separated list of test files to run. This parameter is valid only for the --integrated, --isolated, and --record commands.

Examples

extended-test --backstop
extended-test --integrated
extended-test --integrated --filter test1.spec.ts,test2.spec.ts
extended-test --isolated
extended-test --isolated --filter test1.spec.ts,test2.spec.ts
extended-test --record
extended-test --record --filter test1.spec.ts,test2.spec.ts

- the callback is called when filter working selection is changed risk: low JIRA: GDP-2938

- update the state on attribute filters change risk: low JIRA: GDP-2938

- add command to apply staged working filters risk: low JIRA: GDP-2938

- dispatch setAttributeFilterDisplayForm cmd into working state - dispatch FilterContextChanged event after apply all JIRA: GDP-2938 risk: low

- fix wrong working negative selection JIRA: GDP-2938 risk: low

JIRA: GDP-2938 risk: low

- only when filters apply mode all_at_once JIRA: GDP-2938 risk: low

…lters - only when filters apply mode all_at_once JIRA: GDP-2938 risk: low

JIRA: GDP-2938 risk: low

- this way we do not need to synchronize other fields - which makes it easier to maintain.his JIRA: GDP-2938 risk: low

kandl · 2025-02-27T16:06:23Z

libs/sdk-model/src/dashboard/filterContext.ts

+ */
+export function applyFilterContext(
+    filterContext: IFilterContextDefinition,
+    workingFilterContext: IWorkingFilterContextDefinition | undefined,


Why is new IWorkingFilterContextDefinition type required, why not use IFilterContextDefinition for both definitions? I'm also thinking whether it belongs to sdk-model, as this is strictly dashboard runtime implementation detail.

kandl · 2025-02-27T16:10:19Z

libs/sdk-ui-dashboard/api/sdk-ui-dashboard.api.md

@@ -706,12 +710,13 @@ export interface ChangeAttributeFilterSelection extends IDashboardCommand {
 }

 // @public
-export function changeAttributeFilterSelection(filterLocalId: string, elements: IAttributeElements, selectionType: AttributeFilterSelectionType, correlationId?: string): ChangeAttributeFilterSelection;
+export function changeAttributeFilterSelection(filterLocalId: string, elements: IAttributeElements, selectionType: AttributeFilterSelectionType, correlationId?: string, isWorkingSelectionChange?: boolean): ChangeAttributeFilterSelection;


What about adding new changeWorkingAttributeFilterSelection function? (having isWorkingSelectionChange after correlationId is not very nice). It can dispatch exactly the same action, just with isWorkingSelectionChange flag set to true.

kandl · 2025-02-27T16:13:55Z

libs/sdk-ui-dashboard/src/model/store/filterContext/filterContextSelectors.ts

+ *
+ * @alpha
+ */
+export const selectAreAllFiltersApplied: DashboardSelector<boolean | undefined> = createSelector(


I would rather name it selectIsWorkingFilterContextChanged or something like that

kandl · 2025-02-27T16:18:17Z

libs/sdk-ui-dashboard/src/_staging/dashboard/dashboardFilterConverter.ts

@@ -15,6 +15,9 @@ import {
    IDashboardAttributeFilter,
    IDashboardDateFilter,
    ObjRef,
+    type IAttributeElement,


Nitpick: use type in type imports is not required - it's required only when re-exporting types in barel or main index files. (because esbuild and other tools have issue with removing types from re-exports, but it's not issue anywhere else).

kandl · 2025-02-27T16:23:16Z

libs/sdk-ui-dashboard/src/model/commandHandlers/index.ts

@@ -136,6 +137,7 @@ export const DefaultCommandHandlers: {
    "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.ADD": addDateFilterHandler,
    "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.REMOVE": removeDateFiltersHandler,
    "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.MOVE": moveDateFilterHandler,
+    "GDC.DASH/CMD.FILTER_CONTEXT.APPLY_ALL": applyAllFilterContextHandler,


Should it be called APPLY_SELECTION or APPLY_WORKING_SELECTION (so it's aligned with CHANGE_SELECTION)?

kandl · 2025-02-27T16:25:49Z

libs/sdk-ui-dashboard/src/model/store/filterContext/filterContextState.ts

+     *
+     * @alpha
+     */
+    workingFilterContextDefinition?: IWorkingFilterContextDefinition;


Here should be mention about filter mode setting.

ondrejvelisek added 10 commits February 21, 2025 09:49

feat(sdk-ui-filters): add onSelect callback prop to attribute filter

1d996a5

- the callback is called when filter working selection is changed risk: low JIRA: GDP-2938

feat(sdk-ui-filters): create new state for working filters

463895e

- update the state on attribute filters change risk: low JIRA: GDP-2938

feat(sdk-ui-dashboard): add apply button to dashboard filter bar

683b5aa

- add command to apply staged working filters risk: low JIRA: GDP-2938

fix(sdk-ui-dashboard): reloading insights after filter select

3c4ae31

- dispatch setAttributeFilterDisplayForm cmd into working state - dispatch FilterContextChanged event after apply all JIRA: GDP-2938 risk: low

feat(sdk-ui-dashboard): make apply all button disable if no change

0dea4d9

- fix wrong working negative selection JIRA: GDP-2938 risk: low

feat(sdk-ui-dashboard): make date filter change working filter state

26bacfe

JIRA: GDP-2938 risk: low

feat(sdk-ui-dashboard): make child filters use working parent filters

912aa5d

- only when filters apply mode all_at_once JIRA: GDP-2938 risk: low

feat(sdk-ui-dashboard): make child filters use working parent date fi…

a2615df

…lters - only when filters apply mode all_at_once JIRA: GDP-2938 risk: low

feat(sdk-ui-dashboard): translate filters all at once apply button

a28e3b8

JIRA: GDP-2938 risk: low

feat(sdk-ui-dashboard): store only changes in working filter state

f298776

- this way we do not need to synchronize other fields - which makes it easier to maintain.his JIRA: GDP-2938 risk: low

kandl reviewed Feb 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ovel/apply filters logic #5985

Ovel/apply filters logic #5985

ondrejvelisek commented Feb 27, 2025 •

edited

Loading

kandl Feb 27, 2025

kandl Feb 27, 2025

kandl Feb 27, 2025

kandl Feb 27, 2025

kandl Feb 27, 2025

kandl Feb 27, 2025

Ovel/apply filters logic #5985

Are you sure you want to change the base?

Ovel/apply filters logic #5985

Conversation

ondrejvelisek commented Feb 27, 2025 • edited Loading

Run extended test by pull request comment

Explanation

Examples

kandl Feb 27, 2025

Choose a reason for hiding this comment

kandl Feb 27, 2025

Choose a reason for hiding this comment

kandl Feb 27, 2025

Choose a reason for hiding this comment

kandl Feb 27, 2025

Choose a reason for hiding this comment

kandl Feb 27, 2025

Choose a reason for hiding this comment

kandl Feb 27, 2025

Choose a reason for hiding this comment

ondrejvelisek commented Feb 27, 2025 •

edited

Loading