feat: allow to disable local saving and reset filter

Query params to handle - Disable cross filtering - Disable reset button - Disable save filters risk: low JIRA: F1-427
gooddata · Jun 24, 2024 · df2cf0e · df2cf0e
1 parent 842bda0
commit df2cf0e
Show file tree

Hide file tree

Showing 8 changed files with 80 additions and 5 deletions.
diff --git a/libs/sdk-ui-dashboard/api/sdk-ui-dashboard.api.md b/libs/sdk-ui-dashboard/api/sdk-ui-dashboard.api.md
@@ -1424,7 +1424,9 @@ export interface DashboardConfig {
     allowUnfinishedFeatures?: boolean;
     colorPalette?: IColorPalette;
     dateFilterConfig?: IDateFilterConfig;
+    disableCrossFiltering?: boolean;
     disableDefaultDrills?: boolean;
+    disableUserFilterReset?: boolean;
     enableFilterValuesResolutionInDrillEvents?: boolean;
     // @internal
     exportId?: string;
@@ -6993,6 +6995,12 @@ export const selectIsDeleteDialogOpen: DashboardSelector<boolean>;
 // @internal
 export const selectIsDeleteFilterButtonEnabled: DashboardSelector<boolean>;
 
+// @internal
+export const selectIsDisabledCrossFiltering: DashboardSelector<boolean>;
+
+// @internal
+export const selectIsDisableUserFilterReset: DashboardSelector<boolean>;
+
 // @internal (undocumented)
 export const selectIsDraggingWidget: DashboardSelector<boolean>;
 

diff --git a/.../src/model/commandHandlers/dashboard/initializeDashboardHandler/resolveDashboardConfig.ts b/.../src/model/commandHandlers/dashboard/initializeDashboardHandler/resolveDashboardConfig.ts
@@ -1,4 +1,4 @@
-// (C) 2021-2023 GoodData Corporation
+// (C) 2021-2024 GoodData Corporation
 import { SagaIterator } from "redux-saga";
 import { all, call, put } from "redux-saga/effects";
 import { IDateFilterConfigsQueryResult, IUserWorkspaceSettings } from "@gooddata/sdk-backend-spi";
@@ -187,6 +187,8 @@ function applyConfigDefaults<T extends DashboardConfig>(config: T) {
         initialRenderMode: config.initialRenderMode ?? "view",
         hideSaveAsNewButton: config.hideSaveAsNewButton ?? false,
         hideShareButton: config.hideShareButton ?? false,
+        disableCrossFiltering: config.disableCrossFiltering ?? false,
+        disableUserFilterReset: config.disableUserFilterReset ?? false,
         widgetsOverlay: config.widgetsOverlay ?? {},
     };
 }
diff --git a/...andHandlers/dashboard/initializeDashboardHandler/tests/__snapshots__/handler.test.ts.snap b/...andHandlers/dashboard/initializeDashboardHandler/tests/__snapshots__/handler.test.ts.snap
@@ -178,7 +178,9 @@ exports[`initialize dashboard handler > for any dashboard > should resolve confi
     ],
     "selectedOption": "THIS_MONTH",
   },
+  "disableCrossFiltering": false,
   "disableDefaultDrills": false,
+  "disableUserFilterReset": false,
   "enableFilterValuesResolutionInDrillEvents": false,
   "hideSaveAsNewButton": false,
   "hideShareButton": false,

diff --git a/libs/sdk-ui-dashboard/src/model/store/config/configSelectors.ts b/libs/sdk-ui-dashboard/src/model/store/config/configSelectors.ts
@@ -554,6 +554,30 @@ export const selectIsShareButtonHidden: DashboardSelector<boolean> = createSelec
     return state.hideShareButton ?? false;
 });
 
+/**
+ * Returns whether cross filtering is disabled by config
+ *
+ * @internal
+ */
+export const selectIsDisabledCrossFiltering: DashboardSelector<boolean> = createSelector(
+    selectConfig,
+    (state) => {
+        return state.disableCrossFiltering ?? false;
+    },
+);
+
+/**
+ * Returns whether user filter reset is disabled by config
+ *
+ * @internal
+ */
+export const selectIsDisableUserFilterReset: DashboardSelector<boolean> = createSelector(
+    selectConfig,
+    (state) => {
+        return state.disableUserFilterReset ?? false;
+    },
+);
+
 /**
  * Returns whether drill down is enabled.
  *

diff --git a/libs/sdk-ui-dashboard/src/model/store/index.ts b/libs/sdk-ui-dashboard/src/model/store/index.ts
@@ -80,6 +80,8 @@ export {
     selectEnableKDAttributeFilterDatesValidation,
     selectEnableDuplicatedLabelValuesInAttributeFilter,
     selectEnableRichTextDescriptions,
+    selectIsDisabledCrossFiltering,
+    selectIsDisableUserFilterReset,
 } from "./config/configSelectors.js";
 export { EntitlementsState } from "./entitlements/entitlementsState.js";
 export { selectEntitlementExportPdf } from "./entitlements/entitlementsSelectors.js";

diff --git a/libs/sdk-ui-dashboard/src/model/store/widgetDrills/widgetDrillSelectors.ts b/libs/sdk-ui-dashboard/src/model/store/widgetDrills/widgetDrillSelectors.ts
@@ -56,6 +56,7 @@ import {
     selectHideKpiDrillInEmbedded,
     selectIsEmbedded,
     selectEnableKDCrossFiltering,
+    selectIsDisabledCrossFiltering,
 } from "../config/configSelectors.js";
 import flatMap from "lodash/flatMap.js";
 import { selectAccessibleDashboardsMap } from "../accessibleDashboards/accessibleDashboardsSelectors.js";
@@ -345,18 +346,21 @@ const selectCrossFilteringByWidgetRef: (
         selectSupportsCrossFiltering,
         selectDrillTargetsByWidgetRef(ref),
         selectDisableDashboardCrossFiltering,
+        selectIsDisabledCrossFiltering,
         selectDrillableItems,
         (
             isCrossFilteringEnabled,
             isCrossFilteringSupported,
             availableDrillTargets,
             disableCrossFiltering,
+            disableCrossFilteringByConfig,
             drillableItems,
         ) => {
             if (
                 !isCrossFilteringEnabled ||
                 !isCrossFilteringSupported ||
                 disableCrossFiltering ||
+                disableCrossFilteringByConfig ||
                 // When some drillable items are present, we need to disable
                 // cross filtering so that drill events are still possible to do.
                 drillableItems.length > 0
@@ -474,6 +478,7 @@ export const selectConfiguredDrillsByWidgetRef: (
         selectHideKpiDrillInEmbedded,
         selectIsEmbedded,
         selectDisableDashboardCrossFiltering,
+        selectIsDisabledCrossFiltering,
         (
             drills = [],
             disableDefaultDrills,
@@ -485,6 +490,7 @@ export const selectConfiguredDrillsByWidgetRef: (
             hideKpiDrillInEmbedded,
             isEmbedded,
             disableCrossFiltering,
+            disableCrossFilteringByConfig,
         ) => {
             if (disableDefaultDrills) {
                 return [];
@@ -509,7 +515,9 @@ export const selectConfiguredDrillsByWidgetRef: (
                         return !(isEmbedded && hideKpiDrillInEmbedded);
                     }
                     case "crossFiltering": {
-                        return enableKDCrossFiltering && !disableCrossFiltering;
+                        return (
+                            enableKDCrossFiltering && !disableCrossFiltering && !disableCrossFilteringByConfig
+                        );
                     }
                     default: {
                         const unhandledType: never = drillType;

diff --git a/libs/sdk-ui-dashboard/src/model/types/commonTypes.ts b/libs/sdk-ui-dashboard/src/model/types/commonTypes.ts
@@ -1,4 +1,4 @@
-// (C) 2021-2023 GoodData Corporation
+// (C) 2021-2024 GoodData Corporation
 import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
 import {
     IColorPalette,
@@ -212,6 +212,24 @@ export interface DashboardConfig {
      * priority over other stored or supplied filter context.
      */
     exportId?: string;
+
+    /**
+     * Disable cross filtering
+     *
+     * @remarks
+     * If set to true, cross filtering will be forced disabled even if the dashboard is configured to support it.
+     * If set to false or not set, cross filtering will be enabled if the dashboard is configured to support it.
+     */
+    disableCrossFiltering?: boolean;
+
+    /**
+     * Disable user filter reset
+     *
+     * @remarks
+     * If set to true, user filter reset will be disabled even if the dashboard is configured to support it.
+     * If set to false or not set, user filter reset will be enabled if the dashboard is configured to support it.
+     */
+    disableUserFilterReset?: boolean;
 }
 
 /**

diff --git a/libs/sdk-ui-dashboard/src/presentation/filterBar/filterBar/hooks/useResetFiltersButton.ts b/libs/sdk-ui-dashboard/src/presentation/filterBar/filterBar/hooks/useResetFiltersButton.ts
@@ -25,6 +25,8 @@ import {
     useDashboardUserInteraction,
     selectDisableDashboardCrossFiltering,
     selectDisableDashboardUserFilterReset,
+    selectIsDisabledCrossFiltering,
+    selectIsDisableUserFilterReset,
 } from "../../../../model/index.js";
 
 /**
@@ -44,7 +46,9 @@ export const useResetFiltersButton = (): {
     const currentFilters = useDashboardSelector(selectFilterContextFilters);
     const enableKDCrossFiltering = useDashboardSelector(selectEnableKDCrossFiltering);
     const supportsCrossFiltering = useDashboardSelector(selectSupportsCrossFiltering);
+    const disableCrossFilteringByConfig = useDashboardSelector(selectIsDisabledCrossFiltering);
     const disableCrossFiltering = useDashboardSelector(selectDisableDashboardCrossFiltering);
+    const disableUserFilterResetByConfig = useDashboardSelector(selectIsDisableUserFilterReset);
     const disableUserFilterReset = useDashboardSelector(selectDisableDashboardUserFilterReset);
 
     const dispatch = useDashboardDispatch();
@@ -65,13 +69,15 @@ export const useResetFiltersButton = (): {
             !isEditMode &&
             !isEqual(currentFilters, originalFilters) &&
             // If the cross filter add some filters, we should allow the reset
-            (!disableUserFilterReset || newlyAddedFiltersLocalIds.length > 0)
+            ((!disableUserFilterReset && !disableUserFilterResetByConfig) ||
+                newlyAddedFiltersLocalIds.length > 0)
         );
     }, [
         isEditMode,
         currentFilters,
         originalFilters,
         disableUserFilterReset,
+        disableUserFilterResetByConfig,
         newlyAddedFiltersLocalIds.length,
     ]);
 
@@ -98,7 +104,12 @@ export const useResetFiltersButton = (): {
         }
 
         // If cross filtering is enabled, we need to remove all attribute filters that were added by cross filtering
-        if (enableKDCrossFiltering && supportsCrossFiltering && !disableCrossFiltering) {
+        if (
+            enableKDCrossFiltering &&
+            supportsCrossFiltering &&
+            !disableCrossFiltering &&
+            !disableCrossFilteringByConfig
+        ) {
             dispatch(removeAttributeFilters(newlyAddedFiltersLocalIds));
             dispatch(drillActions.resetCrossFiltering());
         }