UI-8857 - Fix unexpected filter MDX update during 4.3 to 5.0 migration

src/4.3_to_5.0/_migrateQuery.test.ts

@@ -14,6 +14,7 @@ describe("_migrateQuery", () => {
     const [migratedQuery, isUsingUnsupportedUpdateMode] = _migrateQuery({
       legacyQuery,
       cube,
+      shouldUpdateFiltersMdx: true,
     });
     expect(migratedQuery).toMatchInlineSnapshot(`
       {
@@ -42,6 +43,7 @@ describe("_migrateQuery", () => {
     const [migratedQuery, isUsingUnsupportedUpdateMode] = _migrateQuery({
       legacyQuery: { mdx: "" },
       cube,
+      shouldUpdateFiltersMdx: false,
     });
     expect(migratedQuery).toEqual({
       query: { updateMode: "once" },
@@ -55,8 +57,15 @@ describe("_migrateQuery", () => {
     const legacyQuery = {
       mdx: "SELECT FROM [EquityDerivativesCube] WHERE [Currency].[Currency].[AllMember].[EUR]",
     };
-    const [{ query, filters }] = _migrateQuery({ legacyQuery, cube })!;
+    const [{ query, filters }] = _migrateQuery({
+      legacyQuery,
+      cube,
+      shouldUpdateFiltersMdx: true,
+    })!;
+
+    // Filters are unchanged in the query.
     expect(stringify(query.mdx!)).toBe("SELECT FROM [EquityDerivativesCube]");
+
     expect(filters.length).toBe(1);
     expect(stringify(filters[0])).toBe(
       "[Currency].[Currency].[AllMember].[EUR]",
@@ -99,7 +108,7 @@ describe("_migrateQuery", () => {
       {
         query: { mdx },
       },
-    ] = _migrateQuery({ legacyQuery, cube })!;
+    ] = _migrateQuery({ legacyQuery, cube, shouldUpdateFiltersMdx: true })!;
 
     expect(stringify(mdx!, { indent: true })).toMatchInlineSnapshot(`
       "SELECT

src/4.3_to_5.0/_migrateQuery.ts

@@ -40,9 +40,11 @@ export interface LegacyQuery {
 export const _migrateQuery = <T extends MdxSelect | MdxDrillthrough>({
   legacyQuery,
   cube,
+  shouldUpdateFiltersMdx,
 }: {
   legacyQuery: LegacyQuery;
   cube: Cube;
+  shouldUpdateFiltersMdx: boolean;
 }): [
   {
     query: { mdx?: T; updateMode: UpdateMode };
@@ -91,13 +93,18 @@ export const _migrateQuery = <T extends MdxSelect | MdxDrillthrough>({
   const filters = getFilters(improvedMdx, { cube }).map(
     ({ mdx: filterMdx }) => filterMdx,
   );
-  const mdxWithoutFilters = setFilters(improvedMdx, { filters: [], cube });
+
+  const finalMdx = shouldUpdateFiltersMdx
+    ? // The filters part of the MDX is removed from the query and stored in state.filters.
+      setFilters(improvedMdx, { filters: [], cube })
+    : // The filters part of the MDX remains stored as is, in state.query.
+      improvedMdx;
 
   // TODO UI-5036 Migrate query ranges.
   return [
     {
       // Migrating the query preserves its type.
-      query: { mdx: mdxWithoutFilters as T, updateMode: migratedUpdateMode },
+      query: { mdx: finalMdx as T, updateMode: migratedUpdateMode },
       filters,
       queryContext,
     },

src/4.3_to_5.0/migrateChart.test.ts

@@ -12,7 +12,8 @@ import { servers } from "./__test_resources__/servers";
 
 describe("migrateChart", () => {
   it("returns the ActiveUI5 chart widget state corresponding to the given ActiveUI4 chart widget state", () => {
-    expect(migrateChart(legacyChart, servers)).toMatchInlineSnapshot(`
+    expect(migrateChart(legacyChart, { servers, shouldUpdateFiltersMdx: true }))
+      .toMatchInlineSnapshot(`
       {
         "filters": [],
         "mapping": {
@@ -81,7 +82,9 @@ describe("migrateChart", () => {
   });
 
   it("migrates a legacy line chart to a Plotly line chart", () => {
-    expect(migrateChart(legacyLineChart, servers)).toMatchInlineSnapshot(`
+    expect(
+      migrateChart(legacyLineChart, { servers, shouldUpdateFiltersMdx: true }),
+    ).toMatchInlineSnapshot(`
       {
         "filters": [],
         "mapping": {
@@ -111,7 +114,9 @@ describe("migrateChart", () => {
   });
 
   it("migrates a legacy area chart to a Plotly area chart", () => {
-    expect(migrateChart(legacyAreaChart, servers)).toMatchInlineSnapshot(`
+    expect(
+      migrateChart(legacyAreaChart, { servers, shouldUpdateFiltersMdx: true }),
+    ).toMatchInlineSnapshot(`
       {
         "filters": [],
         "mapping": {
@@ -141,7 +146,12 @@ describe("migrateChart", () => {
   });
 
   it("migrates a legacy column chart to a Plotly column chart", () => {
-    expect(migrateChart(legacyColumnChart, servers)).toMatchInlineSnapshot(`
+    expect(
+      migrateChart(legacyColumnChart, {
+        servers,
+        shouldUpdateFiltersMdx: true,
+      }),
+    ).toMatchInlineSnapshot(`
       {
         "filters": [],
         "mapping": {
@@ -170,7 +180,9 @@ describe("migrateChart", () => {
   });
 
   it("migrates a legacy bar chart to a Plotly bar chart", () => {
-    expect(migrateChart(legacyBarChart, servers)).toMatchInlineSnapshot(`
+    expect(
+      migrateChart(legacyBarChart, { servers, shouldUpdateFiltersMdx: true }),
+    ).toMatchInlineSnapshot(`
       {
         "filters": [],
         "mapping": {
@@ -199,7 +211,9 @@ describe("migrateChart", () => {
   });
 
   it("migrates a legacy pie chart to a Plotly pie chart", () => {
-    expect(migrateChart(legacyPieChart, servers)).toMatchInlineSnapshot(`
+    expect(
+      migrateChart(legacyPieChart, { servers, shouldUpdateFiltersMdx: true }),
+    ).toMatchInlineSnapshot(`
       {
         "filters": [],
         "mapping": {
@@ -225,7 +239,12 @@ describe("migrateChart", () => {
   });
 
   it("migrates a legacy scatter plot to a Plotly scatter plot", () => {
-    expect(migrateChart(legacyScatterPlot, servers)).toMatchInlineSnapshot(`
+    expect(
+      migrateChart(legacyScatterPlot, {
+        servers,
+        shouldUpdateFiltersMdx: true,
+      }),
+    ).toMatchInlineSnapshot(`
       {
         "filters": [],
         "mapping": {
@@ -260,7 +279,9 @@ describe("migrateChart", () => {
   });
 
   it("migrates an empty chart widget to a plotly-line-chart", () => {
-    expect(migrateChart(emptyLegacyChart, servers)).toMatchInlineSnapshot(`
+    expect(
+      migrateChart(emptyLegacyChart, { servers, shouldUpdateFiltersMdx: true }),
+    ).toMatchInlineSnapshot(`
       {
         "filters": [],
         "mapping": {
@@ -298,7 +319,10 @@ describe("migrateChart", () => {
       },
     );
 
-    const chartState = migrateChart(partialLegacyChartState, servers);
+    const chartState = migrateChart(partialLegacyChartState, {
+      servers,
+      shouldUpdateFiltersMdx: true,
+    });
 
     // Notice that `splitBy`, `horizontalSubplots` and `verticalSubplots` are present in the migrated chart state,
     // even though they are missing in the input legacy chart state.
@@ -330,7 +354,10 @@ describe("migrateChart", () => {
     // ActiveUI 4 charts did not have this capability: "all measures" could never be moved.
     // For this ActiveUI 5 feature to work, charts supporting measures redirection in ActiveUI 5 should see the "ALL_MEASURES" tile added to their mapping during the migration.
 
-    const migratedChartState = migrateChart(legacyChart, servers);
+    const migratedChartState = migrateChart(legacyChart, {
+      servers,
+      shouldUpdateFiltersMdx: true,
+    });
 
     // Even though the ALL_MEASURES tile is missing in the legacy chart state, the migrated state does contain it.
     expect(migratedChartState.mapping.splitBy).toContain("ALL_MEASURES");

src/4.3_to_5.0/migrateChart.ts

@@ -231,7 +231,13 @@ export function migrateChart(
   // Legacy widget states are not typed.
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   legacyChartState: any,
-  servers: { [serverKey: string]: { dataModel: DataModel; url: string } },
+  {
+    servers,
+    shouldUpdateFiltersMdx,
+  }: {
+    servers: { [serverKey: string]: { dataModel: DataModel; url: string } };
+    shouldUpdateFiltersMdx: boolean;
+  },
 ): PlotlyWidgetState<"serialized"> {
   const widgetName = legacyChartState?.name;
   const {
@@ -267,7 +273,7 @@ export function migrateChart(
   const [
     { query: migratedQuery, filters: extractedFilters, queryContext },
     isUsingUnsupportedUpdateMode,
-  ] = _migrateQuery<MdxSelect>({ legacyQuery, cube });
+  ] = _migrateQuery<MdxSelect>({ legacyQuery, cube, shouldUpdateFiltersMdx });
 
   //  If there is no MDX in the query, the type does not matter: it can be considered a stringified query.
   const query = (
@@ -299,6 +305,9 @@ export function migrateChart(
     serverKey,
     name: widgetName,
     widgetKey: migratedWidgetKey,
+    ...(!shouldUpdateFiltersMdx && {
+      areFiltersDrivenByMdx: true,
+    }),
   };
 
   if (isUsingUnsupportedUpdateMode) {

src/4.3_to_5.0/migrateDashboard.test.ts

@@ -11,6 +11,7 @@ describe("migrateDashboard", () => {
   it("turns the pages content from arrays into maps", () => {
     const [dashboard] = migrateDashboard(legacyDashboard, {
       servers,
+      shouldUpdateFiltersMdx: true,
     });
 
     expect(dashboard.pages["p-0"].content).toMatchInlineSnapshot(`
@@ -143,6 +144,7 @@ describe("migrateDashboard", () => {
   it("flattens the page layouts", () => {
     const [dashboard] = migrateDashboard(legacyDashboard, {
       servers,
+      shouldUpdateFiltersMdx: true,
     });
     expect(dashboard.pages["p-0"].layout).toMatchInlineSnapshot(`
       {
@@ -179,6 +181,7 @@ describe("migrateDashboard", () => {
     // Due to the flattening, the context values from the first cube that are also defined in the second cube are overriden.
     const [dashboard] = migrateDashboard(legacyDashboard, {
       servers,
+      shouldUpdateFiltersMdx: true,
     });
     expect(dashboard.queryContext).toMatchInlineSnapshot(`
       [
@@ -201,6 +204,7 @@ describe("migrateDashboard", () => {
   it("migrates page context values", () => {
     const [dashboard] = migrateDashboard(legacyDashboard, {
       servers,
+      shouldUpdateFiltersMdx: true,
     });
     expect(_mapValues(dashboard.pages, ({ queryContext }) => queryContext))
       .toMatchInlineSnapshot(`
@@ -240,6 +244,7 @@ describe("migrateDashboard", () => {
     } as unknown as LegacyDashboardState;
     const [emptyDashboard] = migrateDashboard(legacyEmptyDashboard, {
       servers,
+      shouldUpdateFiltersMdx: true,
     });
     expect(emptyDashboard).toMatchInlineSnapshot(`
       {
@@ -283,6 +288,7 @@ describe("migrateDashboard", () => {
     const [dashboard] = migrateDashboard(legacyDashboard, {
       servers,
       keysOfWidgetPluginsToRemove,
+      shouldUpdateFiltersMdx: true,
     });
 
     const { content, layout } = dashboard.pages["p-0"];
@@ -334,6 +340,7 @@ describe("migrateDashboard", () => {
       legacyDashboardWithDisconnectedWidget,
       {
         servers,
+        shouldUpdateFiltersMdx: true,
       },
     );
 

src/4.3_to_5.0/migrateDashboard.ts

@@ -47,11 +47,13 @@ export function migrateDashboard(
     servers,
     keysOfWidgetPluginsToRemove,
     doesReportIncludeStacks,
+    shouldUpdateFiltersMdx,
     treeTableColumnWidth,
   }: {
     servers: { [serverKey: string]: { dataModel: DataModel; url: string } };
     keysOfWidgetPluginsToRemove?: string[];
     doesReportIncludeStacks?: boolean;
+    shouldUpdateFiltersMdx: boolean;
     treeTableColumnWidth?: [number, number];
   },
 ): [DashboardState<"serialized">, PartialDashboardErrorReport?] {
@@ -93,11 +95,11 @@ export function migrateDashboard(
       } else {
         let migratedWidget: AWidgetState<"serialized"> | undefined = undefined;
         try {
-          migratedWidget = migrateWidget(
-            widget.bookmark,
+          migratedWidget = migrateWidget(widget.bookmark, {
             servers,
             treeTableColumnWidth,
-          );
+            shouldUpdateFiltersMdx,
+          });
           if (isDisconnectedWidget(widget.bookmark)) {
             keysOfPageDisconnectedWidgets.add(leafKey);
           }

src/4.3_to_5.0/migrateDrillthrough.test.ts

@@ -5,8 +5,12 @@ import { servers } from "./__test_resources__/servers";
 
 describe("migrateDrillthrough", () => {
   it("returns the ActiveUI5 drillthrough-table widget state corresponding to the given ActiveUI4 drillthrough widget state", () => {
-    expect(migrateDrillthrough(legacyDrillthrough, servers))
-      .toMatchInlineSnapshot(`
+    expect(
+      migrateDrillthrough(legacyDrillthrough, {
+        servers,
+        shouldUpdateFiltersMdx: true,
+      }),
+    ).toMatchInlineSnapshot(`
       {
         "columnWidths": {},
         "filters": [
@@ -25,8 +29,12 @@ describe("migrateDrillthrough", () => {
   });
 
   it("migrates an empty drillthrough widget", () => {
-    expect(migrateDrillthrough(emptyLegacyDrillthrough, servers))
-      .toMatchInlineSnapshot(`
+    expect(
+      migrateDrillthrough(emptyLegacyDrillthrough, {
+        servers,
+        shouldUpdateFiltersMdx: true,
+      }),
+    ).toMatchInlineSnapshot(`
       {
         "columnWidths": {},
         "filters": [],

src/4.3_to_5.0/migrateDrillthrough.ts

@@ -17,7 +17,13 @@ export function migrateDrillthrough(
   // Legacy widget states are not typed.
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   legacyDrillthroughState: any,
-  servers: { [serverKey: string]: { dataModel: DataModel; url: string } },
+  {
+    servers,
+    shouldUpdateFiltersMdx,
+  }: {
+    servers: { [serverKey: string]: { dataModel: DataModel; url: string } };
+    shouldUpdateFiltersMdx: boolean;
+  },
 ): AWidgetState<"serialized"> {
   const legacyQuery = _getQueryInLegacyWidgetState(legacyDrillthroughState);
   const legacyMdx = legacyQuery.mdx
@@ -36,6 +42,7 @@ export function migrateDrillthrough(
     _migrateQuery<MdxDrillthrough>({
       legacyQuery,
       cube,
+      shouldUpdateFiltersMdx,
     });
 
   const legacyColumns =
@@ -62,6 +69,9 @@ export function migrateDrillthrough(
     serverKey,
     widgetKey: "drillthrough-table",
     columnWidths,
+    ...(!shouldUpdateFiltersMdx && {
+      areFiltersDrivenByMdx: true,
+    }),
   };
 
   const serializedWidgetState = serializeWidgetState(migratedWidgetState);