From 53e49641ffe4c194b2d901b7436d222244acd208 Mon Sep 17 00:00:00 2001 From: Nestor Zepeda Date: Wed, 14 Aug 2024 10:41:34 -0400 Subject: [PATCH] Use an empty folder test resource and a generator function to create the ui folder to be used for tests --- .../__test_resources__/emptyLegacyUIFolder.ts | 214 ++++++++++++++++++ src/4.3_to_5.0/addLegacyBookmarkToUIFolder.ts | 61 +++++ src/migrateContentServer.test.ts | 24 +- 3 files changed, 297 insertions(+), 2 deletions(-) create mode 100644 src/4.3_to_5.0/__test_resources__/emptyLegacyUIFolder.ts create mode 100644 src/4.3_to_5.0/addLegacyBookmarkToUIFolder.ts diff --git a/src/4.3_to_5.0/__test_resources__/emptyLegacyUIFolder.ts b/src/4.3_to_5.0/__test_resources__/emptyLegacyUIFolder.ts new file mode 100644 index 0000000..5243ecd --- /dev/null +++ b/src/4.3_to_5.0/__test_resources__/emptyLegacyUIFolder.ts @@ -0,0 +1,214 @@ +/** + * Contains an empty /ui folder of a Content Server, useful for injecting content to be used in unit tests. + */ +export const emptyLegacyUIFolder = { + entry: { + isDirectory: true, + owners: ["admin"], + readers: ["admin"], + timestamp: 1607879725132, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + children: { + bookmarks: { + entry: { + isDirectory: true, + owners: ["ROLE_CS_ROOT"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + children: { + content: { + entry: { + isDirectory: true, + owners: ["ROLE_USER"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + children: {}, + }, + i18n: { + entry: { + isDirectory: true, + owners: ["ROLE_CS_ROOT"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + children: { + "en-US": { + entry: { + isDirectory: true, + owners: ["ROLE_CS_ROOT"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + }, + "fr-FR": { + entry: { + isDirectory: true, + owners: ["ROLE_CS_ROOT"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + }, + }, + }, + structure: { + entry: { + isDirectory: true, + owners: ["ROLE_USER"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + children: {}, + }, + }, + }, + settings: { + entry: { + isDirectory: true, + owners: ["ROLE_CS_ROOT"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + children: { + default: { + entry: { + isDirectory: true, + owners: ["ROLE_CS_ROOT"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + children: { + preferences: { + entry: { + content: '{\n "allow": [],\n "deny": [],\n "map": {}\n}', + isDirectory: false, + owners: ["ROLE_CS_ROOT"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + }, + }, + }, + roles: { + entry: { + isDirectory: true, + owners: ["ROLE_CS_ROOT"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + }, + users: { + entry: { + isDirectory: true, + owners: ["ROLE_USER"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + children: { + user1: { + entry: { + isDirectory: true, + owners: ["user1"], + readers: ["user1"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + children: { + preferences: { + entry: { + content: + '{\n "map": {\n "defaultPermissions": {\n "owners": [\n "user2"\n ],\n "readers": [\n "user2"\n ]\n }\n }\n}', + isDirectory: false, + owners: ["user1"], + readers: ["user1"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + }, + }, + }, + admin: { + entry: { + isDirectory: true, + owners: ["admin"], + readers: ["admin"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + children: { + preferences: { + entry: { + content: + '{\n "map": {\n "tree.search.maxResults": 10,\n "global.theme": "dark-activeviam",\n "userFilters.enabled": true,\n "showLegacyCharts": true,\n "showLegacyMaps": true,\n "widgets.Tabular.drillthrough.selectedColumns": {\n "https://activepivot-ranch.activeviam.com:5900": {\n "EquityDerivativesCube": [\n {\n "functionName": "MemberValue",\n "columnName": "delta"\n },\n {\n "functionName": "Caption",\n "columnName": "delta"\n },\n {\n "functionName": "MemberValue",\n "columnName": "gamma"\n },\n {\n "functionName": "Caption",\n "columnName": "gamma"\n },\n {\n "functionName": "MemberValue",\n "columnName": "pnlVega"\n },\n {\n "functionName": "Caption",\n "columnName": "pnlVega"\n },\n {\n "functionName": "MemberValue",\n "columnName": "Desk"\n },\n {\n "functionName": "Caption",\n "columnName": "Desk"\n },\n {\n "functionName": "MemberValue",\n "columnName": "Currency"\n },\n {\n "functionName": "Caption",\n "columnName": "Currency"\n },\n {\n "functionName": "MemberValue",\n "columnName": "Date"\n },\n {\n "functionName": "Caption",\n "columnName": "Date"\n },\n {\n "columnName": "HostName",\n "functionName": "MemberValue"\n },\n {\n "columnName": "HostName",\n "functionName": "Caption"\n }\n ],\n "EquityDerivativesCubeDist": [\n {\n "functionName": "MemberValue",\n "columnName": "BumpedMtmDown"\n },\n {\n "functionName": "Caption",\n "columnName": "BumpedMtmDown"\n },\n {\n "functionName": "MemberValue",\n "columnName": "ProductQtyMultiplier"\n },\n {\n "functionName": "Caption",\n "columnName": "ProductQtyMultiplier"\n },\n {\n "functionName": "MemberValue",\n "columnName": "ProductQtyMultiplier"\n },\n {\n "functionName": "Caption",\n "columnName": "ProductQtyMultiplier"\n },\n {\n "functionName": "MemberValue",\n "columnName": "vega"\n },\n {\n "functionName": "Caption",\n "columnName": "vega"\n },\n {\n "functionName": "MemberValue",\n "columnName": "rho"\n },\n {\n "functionName": "Caption",\n "columnName": "rho"\n },\n {\n "functionName": "MemberValue",\n "columnName": "productId"\n },\n {\n "functionName": "Caption",\n "columnName": "productId"\n },\n {\n "functionName": "MemberValue",\n "columnName": "pnlVega"\n },\n {\n "functionName": "Caption",\n "columnName": "pnlVega"\n },\n {\n "functionName": "MemberValue",\n "columnName": "pnlDelta"\n },\n {\n "functionName": "Caption",\n "columnName": "pnlDelta"\n },\n {\n "functionName": "MemberValue",\n "columnName": "pnl"\n },\n {\n "functionName": "Caption",\n "columnName": "pnl"\n },\n {\n "functionName": "MemberValue",\n "columnName": "gamma"\n },\n {\n "functionName": "Caption",\n "columnName": "gamma"\n },\n {\n "functionName": "MemberValue",\n "columnName": "delta"\n },\n {\n "functionName": "Caption",\n "columnName": "delta"\n },\n {\n "functionName": "MemberValue",\n "columnName": "TradeId"\n },\n {\n "functionName": "Caption",\n "columnName": "TradeId"\n },\n {\n "functionName": "MemberValue",\n "columnName": "ProductQtyMultiplier"\n },\n {\n "functionName": "Caption",\n "columnName": "ProductQtyMultiplier"\n },\n {\n "functionName": "MemberValue",\n "columnName": "ProductQtyMultiplier"\n },\n {\n "functionName": "Caption",\n "columnName": "ProductQtyMultiplier"\n },\n {\n "functionName": "MemberValue",\n "columnName": "ProductBaseMtm"\n },\n {\n "functionName": "Caption",\n "columnName": "ProductBaseMtm"\n },\n {\n "columnName": "ProductQtyMultiplier",\n "functionName": "MemberValue"\n },\n {\n "columnName": "ProductQtyMultiplier",\n "functionName": "Caption"\n }\n ]\n }\n },\n "defaultPermissions": {\n "owners": [\n "admin"\n ],\n "readers": [\n "admin"\n ]\n },\n "project.content-editor.configuration": {\n "autoSwitchToFieldsOnEmptyWidget": true,\n "advancedModeDropdownHidden": false,\n "hideFieldsControls": false,\n "mdx-common": {\n "regularModeTab": "filters",\n "advancedModeEnabled": false,\n "advancedModeTab": "mdx"\n }\n },\n "user.contextValues": {\n "EquityDerivativesCube": {},\n "EquityDerivativesCubeDist": {}\n },\n "user.filters": {\n "EquityDerivativesCube": ["[Geography].[City].[ALL].[AllMember].[Berlin]"],\n "EquityDerivativesCubeDist": []\n },\n "filtering.hierarchyToFilterType.[Geography].[City]": "explicit",\n "filtering.hierarchyToFilterType.[Currency].[Currency]": "explicit",\n "filtering.hierarchyToFilterType.[Trades].[Trades]": "topcount",\n "servers.alias": {\n "https://activepivot-ranch.activeviam.com:5900": "http://localhost:8080"\n }\n }\n}', + isDirectory: false, + owners: ["admin"], + readers: ["admin"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + }, + }, + }, + }, + }, + }, + }, + version: { + entry: { + content: '{"package":"4.3.8","contentServerApi":"0.1.0"}', + isDirectory: false, + owners: ["ROLE_CS_ROOT"], + readers: ["ROLE_USER"], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + }, + }, +}; diff --git a/src/4.3_to_5.0/addLegacyBookmarkToUIFolder.ts b/src/4.3_to_5.0/addLegacyBookmarkToUIFolder.ts new file mode 100644 index 0000000..42d0909 --- /dev/null +++ b/src/4.3_to_5.0/addLegacyBookmarkToUIFolder.ts @@ -0,0 +1,61 @@ +import { ContentRecord } from "@activeviam/activeui-sdk-5.1"; +import { produce } from "immer"; + +/** + * Returns a new `legacyUIFolder` with the given `legacyBookmarksToAdd` added. + * Useful for creating legacyUIFolders for tests. + * Does not mutate `legacyUIFolder`. + */ +export function addLegacyBookmarkToUIFolder( + legacyUIFolder: ContentRecord, + legacyBookmarksToAdd: { [id: string]: any }, +): ContentRecord { + const content = legacyUIFolder.children?.bookmarks.children?.content; + const structure = legacyUIFolder.children?.bookmarks.children?.structure; + + if (!content || !structure) { + throw new Error( + "Expected `legacyUIFolder` to contain the `content` and `structure` properties. Please ensure these properties exist", + ); + } + + return produce(legacyUIFolder, (draftFolder) => { + const existingBookmarks = + draftFolder.children!.bookmarks.children!.content!.children || {}; + + // Add the bookmark content + draftFolder.children!.bookmarks.children!.content!.children = { + ...existingBookmarks, + ...legacyBookmarksToAdd, + }; + + const keysOfBookmarksToAdd = Object.keys(legacyBookmarksToAdd); + + const bookmarkStructureToAdd = keysOfBookmarksToAdd.reduce( + (acc: { [key: string]: ContentRecord }, key: string) => { + acc[key] = { + entry: { + isDirectory: true, + owners: [], + readers: [], + timestamp: 1607879735685, + lastEditor: "admin", + canRead: true, + canWrite: true, + }, + }; + return acc; + }, + {}, + ); + + const existingStructure = + draftFolder.children!.bookmarks.children!.structure!.children || {}; + + // Add the bookmark structure + draftFolder.children!.bookmarks.children!.structure!.children = { + ...existingStructure, + ...bookmarkStructureToAdd, + }; + }); +} diff --git a/src/migrateContentServer.test.ts b/src/migrateContentServer.test.ts index 9a22649..45f0921 100644 --- a/src/migrateContentServer.test.ts +++ b/src/migrateContentServer.test.ts @@ -4,8 +4,9 @@ import { smallLegacyPivotFolder } from "./4.3_to_5.0/__test_resources__/smallLeg import { smallLegacyUIFolder } from "./4.3_to_5.0/__test_resources__/smallLegacyUIFolder"; import { migrateContentServer } from "./migrateContentServer"; import _cloneDeep from "lodash/cloneDeep"; -import { smallLegacyUIFolderWithInvalidKpiTitle } from "./4.3_to_5.0/__test_resources__/smallLegacyUIFolderWithInvalidKpiTitle"; import { smallLegacyUIFolderWithInvalidWidget } from "./4.3_to_5.0/__test_resources__/smallLegacyUIFolderWithInvalidWidget"; +import { addLegacyBookmarkToUIFolder } from "./4.3_to_5.0/addLegacyBookmarkToUIFolder"; +import { emptyLegacyUIFolder } from "./4.3_to_5.0/__test_resources__/emptyLegacyUIFolder"; jest.mock(`./4.3_to_5.0/generateId`, () => { let counter = 0; @@ -339,9 +340,28 @@ describe("migrateContentServer", () => { }); it("migrates the KPI custom titles while dropping custom titles that could not be successfully migrated", async () => { + const legacyUIFolderWithInvalidKpiTitle = addLegacyBookmarkToUIFolder( + emptyLegacyUIFolder, + { + kpi: { + entry: { + content: + '{"description": "A KPI containing a custom title with an empty tupleKey","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 tupleKey"},"[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, + }, + }, + }, + ); + const contentServer: ContentRecord = { children: { - ui: smallLegacyUIFolderWithInvalidKpiTitle, + ui: legacyUIFolderWithInvalidKpiTitle, pivot: smallLegacyPivotFolder, }, entry: {