UI-9566 - Ensure a best effort migration of the KPI titles even when some titles could not be successfully migrated.

src/4.3_to_5.0/__snapshots__/migrate_43_to_50.test.ts.snap

@@ -2497,7 +2497,24 @@ exports[`migrate_43_to_50 returns a valid ActiveUI5 /ui folder on a small input
     "widgets": {
       "children": {
         "content": {
-          "children": {},
+          "children": {
+            "kpi": {
+              "entry": {
+                "canRead": true,
+                "canWrite": true,
+                "content": "{"query":{"mdx":"SELECT NON EMPTY Hierarchize(AddCalculatedMembers(Descendants({[Geography].[City].[ALL].[AllMember]}, 1, SELF_AND_BEFORE))) ON ROWS, NON EMPTY {[Measures].[contributors.COUNT]} ON COLUMNS FROM [EquityDerivativesCube]","updateMode":"once"},"filters":["[Geography].[City].[ALL].[AllMember].[New York]"],"queryContext":[],"mapping":{"rows":["[Geography].[City].[City]"],"columns":[],"measures":["[Measures].[contributors.COUNT]"]},"serverKey":"my-server","titles":{"[Measures].[contributors.COUNT]":"Custom title for contributors.COUNT"}}",
+                "isDirectory": false,
+                "lastEditor": "admin",
+                "owners": [
+                  "admin",
+                ],
+                "readers": [
+                  "admin",
+                ],
+                "timestamp": 1607879735685,
+              },
+            },
+          },
           "entry": {
             "isDirectory": true,
             "owners": [
@@ -2509,7 +2526,41 @@ exports[`migrate_43_to_50 returns a valid ActiveUI5 /ui folder on a small input
           },
         },
         "structure": {
-          "children": {},
+          "children": {
+            "kpi": {
+              "children": {
+                "kpi_metadata": {
+                  "entry": {
+                    "canRead": true,
+                    "canWrite": true,
+                    "content": "{"name":"KPI","widgetKey":"kpi"}",
+                    "isDirectory": true,
+                    "lastEditor": "admin",
+                    "owners": [
+                      "admin",
+                    ],
+                    "readers": [
+                      "admin",
+                    ],
+                    "timestamp": 1607879735685,
+                  },
+                },
+              },
+              "entry": {
+                "canRead": true,
+                "canWrite": true,
+                "isDirectory": true,
+                "lastEditor": "admin",
+                "owners": [
+                  "admin",
+                ],
+                "readers": [
+                  "admin",
+                ],
+                "timestamp": 1607879735685,
+              },
+            },
+          },
           "entry": {
             "isDirectory": true,
             "owners": [
@@ -2568,7 +2619,7 @@ exports[`migrate_43_to_50 returns a valid ActiveUI5 /ui folder on a small input
     "failed": 0,
     "partial": 0,
     "removed": 0,
-    "success": 0,
+    "success": 1,
   },
 }
 `;

src/4.3_to_5.0/__test_resources__/legacyKpi.ts

@@ -31,6 +31,9 @@ export const legacyKpi: LegacyWidgetState = {
       configuration: {
         featuredValues: {
           locations: {
+            "": {
+              title: "Empty measure title",
+            },
             // "EUR, USD" is not a member of the sandbox, but it is used here to check that the script supports member names including ",".
             "[Currency].[Currency].[AllMember].[EUR, USD],[Measures].[contributors.COUNT]":
               {

src/4.3_to_5.0/__test_resources__/smallLegacyUIFolder.ts

@@ -47,6 +47,19 @@ export const smallLegacyUIFolder = {
                 canWrite: true,
               },
             },
+            kpi: {
+              entry: {
+                content:
+                  '{"description": "A KPI","name":"KPI","type":"container","value": {"style": {},"showTitleBar": true,"body": {"serverUrl": "","mdx": "SELECT NON EMPTY Hierarchize(AddCalculatedMembers(Descendants({[Geography].[City].[ALL].[AllMember]},1,SELF_AND_BEFORE))) ON ROWS,NON EMPTY {[Measures].[contributors.COUNT]} ON COLUMNS FROM (SELECT[Geography].[City].[ALL].[AllMember].[New York] ON COLUMNS FROM [EquityDerivativesCube])","contextValues": {},"updateMode": "once","ranges": {"row": {},"column": {}},"configuration": {"featuredValues": {"locations":{"":{"title": "Title with empty location"},"[Measures].[contributors.COUNT]": {"title": "Custom title for contributors.COUNT"}}}}},"containerKey":"featured-values"},"writable": true}',
+                isDirectory: false,
+                owners: ["admin"],
+                readers: ["admin"],
+                timestamp: 1607879735685,
+                lastEditor: "admin",
+                canRead: true,
+                canWrite: true,
+              },
+            },
           },
         },
         i18n: {
@@ -106,6 +119,17 @@ export const smallLegacyUIFolder = {
                 canWrite: true,
               },
             },
+            kpi: {
+              entry: {
+                isDirectory: true,
+                owners: ["admin"],
+                readers: ["admin"],
+                timestamp: 1607879735685,
+                lastEditor: "admin",
+                canRead: true,
+                canWrite: true,
+              },
+            },
           },
         },
       },

src/4.3_to_5.0/getMigratedKpiTitles.ts

@@ -12,6 +12,7 @@ import {
   getMeasuresPositionOnAxis,
   MdxSelect,
 } from "@activeviam/mdx-5.0";
+import _isEmpty from "lodash/isEmpty";
 
 interface LegacyKpiTitle {
   title: string;
@@ -43,6 +44,9 @@ function _getLegacyKpiTitles(
     } = {};
     const memberUniqueNames = tupleKey.split(/,(?![^\[]*\])/);
     for (const memberUniqueName of memberUniqueNames) {
+      if (!memberUniqueName) {
+        continue;
+      }
       const compoundIdentifier =
         parse<MdxUnknownCompoundIdentifier>(memberUniqueName);
       const specificCompoundIdentifier = getSpecificCompoundIdentifier(
@@ -61,7 +65,10 @@ function _getLegacyKpiTitles(
         tuple[hierarchyUniqueName] = specificCompoundIdentifier.path;
       }
     }
-    legacyTitles.push({ title, tuple });
+
+    if (!_isEmpty(tuple)) {
+      legacyTitles.push({ title, tuple });
+    }
   }
 
   return legacyTitles;

src/migrateContentServer.test.ts

@@ -232,4 +232,42 @@ describe("migrateContentServer", () => {
       undefined,
     );
   });
+
+  it("migrates the kpi custom titles when the original version contains a custom title with a tupleKey that is empty.", async () => {
+    const contentServer: ContentRecord = {
+      children: { ui: smallLegacyUIFolder, pivot: smallLegacyPivotFolder },
+      entry: {
+        owners: [],
+        readers: [],
+        isDirectory: true,
+        canRead: true,
+        canWrite: false,
+        lastEditor: "Freddie Mercury",
+        timestamp: 0xbeef,
+      },
+    };
+
+    await migrateContentServer({
+      contentServer,
+      servers,
+      fromVersion: "4.3",
+      toVersion: "5.1",
+      keysOfWidgetPluginsToRemove: [],
+      doesReportIncludeStacks: false,
+      shouldUpdateFiltersMdx: true,
+      behaviorOnError: "keep-original",
+    });
+
+    const migratedKpiContent = JSON.parse(
+      contentServer.children?.ui.children?.widgets.children?.content.children?.[
+        "kpi"
+      ].entry.content,
+    );
+
+    expect(migratedKpiContent?.titles).toMatchInlineSnapshot(`
+      {
+        "[Measures].[contributors.COUNT]": "Custom title for contributors.COUNT",
+      }
+    `);
+  });
 });